casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
casacore::RegionManager Class Reference

#include <RegionManager.h>

Inheritance diagram for casacore::RegionManager:
casa::CasacRegionManager

Public Member Functions

 RegionManager ()
 blank constructor More...
 
 RegionManager (const CoordinateSystem &csys)
 
virtual ~RegionManager ()
 
String absreltype (const Int absrelval=0)
 
void setcoordsys (const CoordinateSystem &csys)
 
const CoordinateSystemgetcoordsys () const
 
Recordbox (const Vector< Double > &blc, const Vector< Double > &trc, const Vector< Double > &inc, const String &absrel, const Bool frac, const String &comment="")
 LCSlicer box. More...
 
Recordwbox (const Vector< Quantity > &blc, const Vector< Quantity > &trc, const Vector< Int > &pixelaxes, const CoordinateSystem &csys, const String &absrel, const String &comment)
 
Recordwbox (const Vector< String > &blc, const Vector< String > &trc, const Vector< Int > &pixelaxes, const CoordinateSystem &csys, const String &absrel, const String &comment)
 
Recordwbox (const Vector< Quantity > &blc, const Vector< Quantity > &trc, const Vector< Int > &pixelaxes, const String &absrel, const String &comment)
 
Recordwbox (const Vector< String > &blc, const Vector< String > &trc, const Vector< Int > &pixelaxes, const String &absrel, const String &comment)
 
ImageRegionwbox (const Vector< Quantity > &blc, const Vector< Quantity > &trc, const Vector< Int > &pixelaxes, const CoordinateSystem &csys, const String &absrel="abs")
 
ImageRegionwpolygon (const Vector< Quantity > &x, const Vector< Quantity > &y, const Vector< Int > &pixelaxes, const CoordinateSystem &csys, const String &absrel)
 Wpolygon with coordsys and if pixelaxes[0] is -1 then its assumed to be 0,1,... More...
 
ImageRegionwpolygon (const Vector< Quantity > &x, const Vector< Quantity > &y, const Vector< Int > &pixelaxes, const String &absrel)
 wpolygon version without csys...throws an exception if setcoordsys is not run More...
 
ImageRegionwellipse (const Quantity &xc, const Quantity &yc, const Quantity &a, const Quantity &b, const Quantity &pa, const uInt pixelAxis0, const uInt pixelAxis1, const String &absrel) const
 wellipse version without csys...throws an exception if setcoordsys is not run More...
 
ImageRegionwsphere (const Vector< Quantity > &center, const Quantity &radius, const Vector< Int > &pixelaxes, const String &absrel) const
 wsphere version without csys...throws an exception if setcoordsys is not run More...
 
ImageRegionwellipsoid (const Vector< Quantity > &center, const Vector< Quantity > &radii, const Vector< Int > &pixelaxes, const String &absrel) const
 
ImageRegionwshell (const Vector< Quantity > &center, const Vector< Quantity > &innerRadii, const Vector< Quantity > &outerRadii, const Vector< Int > &pixelaxes, const String &absrel) const
 
ImageRegiondoComplement (const WCRegion &reg1)
 Various versions of creating a complement region. More...
 
ImageRegiondoComplement (const PtrBlock< const WCRegion * > &reg1)
 
ImageRegiondoComplement (const ImageRegion &reg1)
 
ImageRegiondoConcatenation (const WCRegion &region, const WCBox &box)
 Various versions of concatenating a region onto another. More...
 
ImageRegiondoconcatenation (const PtrBlock< const WCRegion * > &regions, const WCBox &box)
 
ImageRegiondoConcatenation (const PtrBlock< const ImageRegion * > &regions, const TableRecord &box)
 
ImageRegiondoConcatenation (const Record &regions, const TableRecord &box)
 
ImageRegiondoDifference (const WCRegion &reg1, const WCRegion &reg2)
 Various versions of handling the difference of regions. More...
 
ImageRegiondoDifference (const PtrBlock< const WCRegion * > &reg1)
 
ImageRegiondoDifference (const ImageRegion &reg1, const ImageRegion &reg2)
 
ImageRegiondoIntersection (const WCRegion &reg1, const WCRegion &reg2)
 Different versions of intersecting regions. More...
 
ImageRegiondoIntersection (const PtrBlock< const WCRegion * > &reg1)
 
ImageRegiondoIntersection (const ImageRegion &reg1, const ImageRegion &reg2)
 
ImageRegiondoUnion (const WCRegion &reg1, const WCRegion &reg2)
 Different versions of unioning regions. More...
 
ImageRegiondoUnion (const PtrBlock< const WCRegion * > &reg1)
 
ImageRegiondoUnion (const ImageRegion &reg1, const ImageRegion &reg2) const
 
String imageRegionToTable (const String &tabName, const ImageRegion &imreg, const String &regName, Bool asmask=False)
 save region into a table (image, blank table or any other such) More...
 
String recordToTable (const String &tabName, const RecordInterface &rec, const String &regName="", Bool asmask=False)
 
RecordtableToRecord (const String &tabName, const String &regname)
 recover region from table More...
 
Vector< StringnamesInTable (const String &tabName)
 names of regions in table More...
 
Bool removeRegionInTable (const String &tabName, const String &regName)
 Remove a region from table...refuse is regionname is "". More...
 

Static Public Member Functions

static Bool isPixelRegion (const ImageRegion &reg)
 Some little but useful tidbits. More...
 
static Bool isWorldRegion (const ImageRegion &reg)
 
static Recordbox (const Vector< Double > &blc, const Vector< Double > &trc, const Vector< Int > &shape, const String &comment="")
 LCBox box. More...
 
static ImageRegionwellipse (const Quantity &xc, const Quantity &yc, const Quantity &a, const Quantity &b, const Quantity &pa, const uInt pixelAxis0, const uInt pixelAxis1, const CoordinateSystem &csys, const String &absrel)
 
static ImageRegionwsphere (const Vector< Quantity > &center, const Quantity &radius, const Vector< Int > &pixelaxes, const CoordinateSystem &csys, const String &absrel)
 
static ImageRegionwellipsoid (const Vector< Quantity > &center, const Vector< Quantity > &radii, const Vector< Int > &pixelaxes, const CoordinateSystem &csys, const String &absrel)
 
static ImageRegionwshell (const Vector< Quantity > &center, const Vector< Quantity > &innerRadii, const Vector< Quantity > &outerRadii, const Vector< Int > &pixelaxes, const CoordinateSystem &csys, const String &absrel)
 
static ImageRegionwmask (const String &command)
 
static RecordreadImageFile (String filename, String regionname)
 Reading of a file containing an ImageRegion in the AipsIO format dump. More...
 
static Bool writeImageFile (const String &file, const String &regionname, const Record &regionRecord)
 Writing a file of the AipsIO dump of the record representation of the region. More...
 

Protected Member Functions

LogIO_getLog () const
 

Private Member Functions

void toQuantity (Quantity &out, const String &in)
 Convert a string to Quantity. More...
 

Static Private Member Functions

static TablegetTable (void *ptr, Bool writable)
 Function to return the internal Table object to the RegionHandler. More...
 

Private Attributes

LogIOitsLog
 
std::unique_ptr< CoordinateSystemitsCSys
 
Table tab_p
 

Detailed Description

Definition at line 59 of file RegionManager.h.

Constructor & Destructor Documentation

casacore::RegionManager::RegionManager ( )

blank constructor

casacore::RegionManager::RegionManager ( const CoordinateSystem csys)
virtual casacore::RegionManager::~RegionManager ( )
virtual

Member Function Documentation

LogIO* casacore::RegionManager::_getLog ( ) const
inlineprotected

Definition at line 261 of file RegionManager.h.

References itsLog.

String casacore::RegionManager::absreltype ( const Int  absrelval = 0)
Record* casacore::RegionManager::box ( const Vector< Double > &  blc,
const Vector< Double > &  trc,
const Vector< Double > &  inc,
const String absrel,
const Bool  frac,
const String comment = "" 
)

LCSlicer box.

static Record* casacore::RegionManager::box ( const Vector< Double > &  blc,
const Vector< Double > &  trc,
const Vector< Int > &  shape,
const String comment = "" 
)
static

LCBox box.

ImageRegion* casacore::RegionManager::doComplement ( const WCRegion reg1)

Various versions of creating a complement region.

ImageRegion* casacore::RegionManager::doComplement ( const PtrBlock< const WCRegion * > &  reg1)
ImageRegion* casacore::RegionManager::doComplement ( const ImageRegion reg1)
ImageRegion* casacore::RegionManager::doConcatenation ( const WCRegion region,
const WCBox box 
)

Various versions of concatenating a region onto another.

ImageRegion* casacore::RegionManager::doconcatenation ( const PtrBlock< const WCRegion * > &  regions,
const WCBox box 
)
ImageRegion* casacore::RegionManager::doConcatenation ( const PtrBlock< const ImageRegion * > &  regions,
const TableRecord box 
)
ImageRegion* casacore::RegionManager::doConcatenation ( const Record regions,
const TableRecord box 
)
ImageRegion* casacore::RegionManager::doDifference ( const WCRegion reg1,
const WCRegion reg2 
)

Various versions of handling the difference of regions.

ImageRegion* casacore::RegionManager::doDifference ( const PtrBlock< const WCRegion * > &  reg1)
ImageRegion* casacore::RegionManager::doDifference ( const ImageRegion reg1,
const ImageRegion reg2 
)
ImageRegion* casacore::RegionManager::doIntersection ( const WCRegion reg1,
const WCRegion reg2 
)

Different versions of intersecting regions.

ImageRegion* casacore::RegionManager::doIntersection ( const PtrBlock< const WCRegion * > &  reg1)
ImageRegion* casacore::RegionManager::doIntersection ( const ImageRegion reg1,
const ImageRegion reg2 
)
ImageRegion* casacore::RegionManager::doUnion ( const WCRegion reg1,
const WCRegion reg2 
)

Different versions of unioning regions.

ImageRegion* casacore::RegionManager::doUnion ( const PtrBlock< const WCRegion * > &  reg1)
ImageRegion* casacore::RegionManager::doUnion ( const ImageRegion reg1,
const ImageRegion reg2 
) const
const CoordinateSystem& casacore::RegionManager::getcoordsys ( ) const
static Table& casacore::RegionManager::getTable ( void *  ptr,
Bool  writable 
)
staticprivate

Function to return the internal Table object to the RegionHandler.

String casacore::RegionManager::imageRegionToTable ( const String tabName,
const ImageRegion imreg,
const String regName,
Bool  asmask = False 
)

save region into a table (image, blank table or any other such)

static Bool casacore::RegionManager::isPixelRegion ( const ImageRegion reg)
static

Some little but useful tidbits.

static Bool casacore::RegionManager::isWorldRegion ( const ImageRegion reg)
static
Vector<String> casacore::RegionManager::namesInTable ( const String tabName)

names of regions in table

static Record* casacore::RegionManager::readImageFile ( String  filename,
String  regionname 
)
static

Reading of a file containing an ImageRegion in the AipsIO format dump.

String casacore::RegionManager::recordToTable ( const String tabName,
const RecordInterface rec,
const String regName = "",
Bool  asmask = False 
)
Bool casacore::RegionManager::removeRegionInTable ( const String tabName,
const String regName 
)

Remove a region from table...refuse is regionname is "".

void casacore::RegionManager::setcoordsys ( const CoordinateSystem csys)
Record* casacore::RegionManager::tableToRecord ( const String tabName,
const String regname 
)

recover region from table

void casacore::RegionManager::toQuantity ( Quantity out,
const String in 
)
private

Convert a string to Quantity.

Record* casacore::RegionManager::wbox ( const Vector< Quantity > &  blc,
const Vector< Quantity > &  trc,
const Vector< Int > &  pixelaxes,
const CoordinateSystem csys,
const String absrel,
const String comment 
)
Record* casacore::RegionManager::wbox ( const Vector< String > &  blc,
const Vector< String > &  trc,
const Vector< Int > &  pixelaxes,
const CoordinateSystem csys,
const String absrel,
const String comment 
)
Record* casacore::RegionManager::wbox ( const Vector< Quantity > &  blc,
const Vector< Quantity > &  trc,
const Vector< Int > &  pixelaxes,
const String absrel,
const String comment 
)
Record* casacore::RegionManager::wbox ( const Vector< String > &  blc,
const Vector< String > &  trc,
const Vector< Int > &  pixelaxes,
const String absrel,
const String comment 
)
ImageRegion* casacore::RegionManager::wbox ( const Vector< Quantity > &  blc,
const Vector< Quantity > &  trc,
const Vector< Int > &  pixelaxes,
const CoordinateSystem csys,
const String absrel = "abs" 
)
static ImageRegion* casacore::RegionManager::wellipse ( const Quantity xc,
const Quantity yc,
const Quantity a,
const Quantity b,
const Quantity pa,
const uInt  pixelAxis0,
const uInt  pixelAxis1,
const CoordinateSystem csys,
const String absrel 
)
static
ImageRegion* casacore::RegionManager::wellipse ( const Quantity xc,
const Quantity yc,
const Quantity a,
const Quantity b,
const Quantity pa,
const uInt  pixelAxis0,
const uInt  pixelAxis1,
const String absrel 
) const

wellipse version without csys...throws an exception if setcoordsys is not run

static ImageRegion* casacore::RegionManager::wellipsoid ( const Vector< Quantity > &  center,
const Vector< Quantity > &  radii,
const Vector< Int > &  pixelaxes,
const CoordinateSystem csys,
const String absrel 
)
static
ImageRegion* casacore::RegionManager::wellipsoid ( const Vector< Quantity > &  center,
const Vector< Quantity > &  radii,
const Vector< Int > &  pixelaxes,
const String absrel 
) const
static ImageRegion* casacore::RegionManager::wmask ( const String command)
static
ImageRegion* casacore::RegionManager::wpolygon ( const Vector< Quantity > &  x,
const Vector< Quantity > &  y,
const Vector< Int > &  pixelaxes,
const CoordinateSystem csys,
const String absrel 
)

Wpolygon with coordsys and if pixelaxes[0] is -1 then its assumed to be 0,1,...

ImageRegion* casacore::RegionManager::wpolygon ( const Vector< Quantity > &  x,
const Vector< Quantity > &  y,
const Vector< Int > &  pixelaxes,
const String absrel 
)

wpolygon version without csys...throws an exception if setcoordsys is not run

static Bool casacore::RegionManager::writeImageFile ( const String file,
const String regionname,
const Record regionRecord 
)
static

Writing a file of the AipsIO dump of the record representation of the region.

static ImageRegion* casacore::RegionManager::wshell ( const Vector< Quantity > &  center,
const Vector< Quantity > &  innerRadii,
const Vector< Quantity > &  outerRadii,
const Vector< Int > &  pixelaxes,
const CoordinateSystem csys,
const String absrel 
)
static
ImageRegion* casacore::RegionManager::wshell ( const Vector< Quantity > &  center,
const Vector< Quantity > &  innerRadii,
const Vector< Quantity > &  outerRadii,
const Vector< Int > &  pixelaxes,
const String absrel 
) const
static ImageRegion* casacore::RegionManager::wsphere ( const Vector< Quantity > &  center,
const Quantity radius,
const Vector< Int > &  pixelaxes,
const CoordinateSystem csys,
const String absrel 
)
static
ImageRegion* casacore::RegionManager::wsphere ( const Vector< Quantity > &  center,
const Quantity radius,
const Vector< Int > &  pixelaxes,
const String absrel 
) const

wsphere version without csys...throws an exception if setcoordsys is not run

Member Data Documentation

std::unique_ptr<CoordinateSystem> casacore::RegionManager::itsCSys
private

Definition at line 265 of file RegionManager.h.

LogIO* casacore::RegionManager::itsLog
private

Definition at line 264 of file RegionManager.h.

Referenced by _getLog().

Table casacore::RegionManager::tab_p
private

Definition at line 270 of file RegionManager.h.


The documentation for this class was generated from the following file: