casacore
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
casacore::WCDifference Class Reference

More...

#include <WCDifference.h>

Public Member Functions

 WCDifference (const ImageRegion &region1, const ImageRegion &region2)
 Construct the difference of one or more image regions. More...
 
 WCDifference (const PtrBlock< const ImageRegion * > &regions)
 
 WCDifference (Bool takeOver, const PtrBlock< const WCRegion * > &regions)
 Construct from multiple regions given as a Block. More...
 
 WCDifference (const WCDifference &other)
 Copy constructor (copy semantics). More...
 
virtual ~WCDifference ()
 
WCDifferenceoperator= (const WCDifference &other)
 Assignment (copy semantics). More...
 
virtual Bool operator== (const WCRegion &other) const
 Comparison. More...
 
virtual WCRegioncloneRegion () const
 Make a copy of the derived object. More...
 
virtual String type () const
 Get the region type. More...
 
virtual TableRecord toRecord (const String &tableName) const
 Convert the (derived) object to a record. More...
 
- Public Member Functions inherited from casacore::WCCompound
 WCCompound (const ImageRegion &region1, const ImageRegion &region2)
 Construct from one or more image regions. More...
 
 WCCompound (const ImageRegion *region1, const ImageRegion *region2=0, const ImageRegion *region3=0, const ImageRegion *region4=0, const ImageRegion *region5=0, const ImageRegion *region6=0, const ImageRegion *region7=0, const ImageRegion *region8=0, const ImageRegion *region9=0, const ImageRegion *region10=0)
 
 WCCompound (const PtrBlock< const ImageRegion * > &regions)
 
 WCCompound (Bool takeOver, const PtrBlock< const WCRegion * > &regions)
 Construct from multiple regions given as a Block. More...
 
 WCCompound (const WCCompound &other)
 Copy constructor (copy semantics). More...
 
virtual ~WCCompound ()
 
const PtrBlock< const WCRegion * > & regions () const
 Get the contributing regions. More...
 
- Public Member Functions inherited from casacore::WCRegion
 WCRegion ()
 
 WCRegion (const WCRegion &other)
 Copy constructor (copy semantics). More...
 
virtual ~WCRegion ()
 Destructor. More...
 
Bool operator!= (const WCRegion &other) const
 
virtual uInt ndim () const
 Get the dimensionality (i.e. More...
 
const RecordgetAxesDesc () const
 Get the description of all axes. More...
 
const RecordgetAxisDesc (uInt axis) const
 Get the description of the given axis. More...
 
Int axisNr (const Record &desc, const Record &axesDesc) const
 Return the axis number of the description of an axis in the full axes description. More...
 
Bool isAxisDescEqual (const Record &desc1, const Record &desc2) const
 Are both axis descriptions equal? More...
 
virtual Bool canExtend () const
 Can the region extend itself? By default it cannot. More...
 
const Stringcomment () const
 Get or set the comment. More...
 
void setComment (const String &comment)
 
virtual LCRegiontoLCRegion (const CoordinateSystem &cSys, const IPosition &shape) const
 Convert to an LCRegion using the given new coordinate system and shape. More...
 
LCRegiontoLCRegionAxes (const CoordinateSystem &cSys, const IPosition &shape, const IPosition &pixelAxesMap, const IPosition &outOrder) const
 Convert to an LCRegion using the given coordinate system and shape. More...
 
void defineRecordFields (RecordInterface &record, const String &className) const
 Define the type and class name in the record. More...
 

Static Public Member Functions

static String className ()
 Get the class name (to store in the record). More...
 
static WCDifferencefromRecord (const TableRecord &, const String &tableName)
 Convert correct object from a record. More...
 
- Static Public Member Functions inherited from casacore::WCRegion
static WCRegionfromRecord (const TableRecord &rec, const String &tableName)
 Convert correct object from a record. More...
 

Protected Member Functions

virtual LCRegiondoToLCRegion (const CoordinateSystem &cSys, const IPosition &shape, const IPosition &pixelAxesMap, const IPosition &outOrder) const
 Convert to an LCRegion using the given coordinate system and shape. More...
 
- Protected Member Functions inherited from casacore::WCCompound
WCCompoundoperator= (const WCCompound &other)
 Assignment (copy semantics) makes only sense for a derived class. More...
 
void multiToLCRegion (PtrBlock< const LCRegion * > &regions, const CoordinateSystem &cSys, const IPosition &shape, const IPosition &pixelAxesMap, const IPosition &extendAxes) const
 Convert each WCRegion to an LCRegion. More...
 
TableRecord makeRecord (const String &tableName) const
 Store the contributing regions in a record. More...
 
- Protected Member Functions inherited from casacore::WCRegion
WCRegionoperator= (const WCRegion &other)
 Assignment (copy semantics) makes only sense for a derived class. More...
 
void addAxisDesc (const Record &axisDesc)
 Add an axis with its description. More...
 
Record makeAxisDesc (const CoordinateSystem &cSys, uInt pixelAxis) const
 Make a description of a pixel axis in the coordinate system. More...
 
Record makeAxesDesc (const CoordinateSystem &cSys) const
 Make a description of all pixel axes in the coordinate system (in pixel axes order). More...
 
void makeWorldAbsolute (Vector< Double > &world, const Vector< Int > &absRel, const CoordinateSystem &cSys, const IPosition &shape) const
 Convert relative to absolute world as needed. More...
 
void checkAxes (const IPosition &pixelAxes, const CoordinateSystem &cSys, const Vector< String > &quantityUnits) const
 

Additional Inherited Members

- Static Protected Member Functions inherited from casacore::WCCompound
static void unmakeRecord (PtrBlock< const WCRegion * > &, const TableRecord &, const String &tableName)
 Retrieve the contributing objects from the record. More...
 
- Static Protected Member Functions inherited from casacore::WCRegion
static void unitInit ()
 
static void convertPixel (Double &pixel, const Double &value, const String &unit, const Int absRel, const Double refPix, const Int shape)
 

Detailed Description

Make the difference of 2 image regions.

Intended use:

Public interface

Prerequisite

Synopsis

The WCDifference class is a specialization of class WCCompound. It makes it possible to take the difference of 2 regions. Note that only world coordinate regions can be used in a compound, thus an LCSlicer object is not allowed in a difference.

The difference consists of all pixels masked-on in the first region and not masked-on in the second region.

The regions in a difference can have different axes and dimensionalities. The axes and dimensionality of a difference are determined by the collection of all different axes in its regions. Each individual region will be auto-extended along the axes not being part of the region. E.g. one can define a WCBox with axis RA and another WCBox with axis DEC. The difference will be 2-dim with axes RA and DEC. The first box will be auto-extended to cover the DEC axis, which results in a 2-dim box with its DEC axis the length of the image's DEC axis. Similarly the second box will be auto-extended to cover the RA axis.

Example

Definition at line 82 of file WCDifference.h.

Constructor & Destructor Documentation

◆ WCDifference() [1/4]

casacore::WCDifference::WCDifference ( const ImageRegion region1,
const ImageRegion region2 
)

Construct the difference of one or more image regions.

The image regions have to contain WCRegion objects, otherwise an exception is thrown.

◆ WCDifference() [2/4]

casacore::WCDifference::WCDifference ( const PtrBlock< const ImageRegion * > &  regions)

◆ WCDifference() [3/4]

casacore::WCDifference::WCDifference ( Bool  takeOver,
const PtrBlock< const WCRegion * > &  regions 
)

Construct from multiple regions given as a Block.

When takeOver is True, the destructor will delete the given regions. Otherwise a copy of the regions is made.

◆ WCDifference() [4/4]

casacore::WCDifference::WCDifference ( const WCDifference other)

Copy constructor (copy semantics).

◆ ~WCDifference()

virtual casacore::WCDifference::~WCDifference ( )
virtual

Member Function Documentation

◆ className()

static String casacore::WCDifference::className ( )
static

Get the class name (to store in the record).

◆ cloneRegion()

virtual WCRegion* casacore::WCDifference::cloneRegion ( ) const
virtual

Make a copy of the derived object.

Implements casacore::WCRegion.

◆ doToLCRegion()

virtual LCRegion* casacore::WCDifference::doToLCRegion ( const CoordinateSystem cSys,
const IPosition shape,
const IPosition pixelAxesMap,
const IPosition outOrder 
) const
protectedvirtual

Convert to an LCRegion using the given coordinate system and shape.

pixelAxesMap(i) gives the pixel axis in cSys of axes i in the axesDesc.

Implements casacore::WCRegion.

◆ fromRecord()

static WCDifference* casacore::WCDifference::fromRecord ( const TableRecord ,
const String tableName 
)
static

Convert correct object from a record.

◆ operator=()

WCDifference& casacore::WCDifference::operator= ( const WCDifference other)

Assignment (copy semantics).

◆ operator==()

virtual Bool casacore::WCDifference::operator== ( const WCRegion other) const
virtual

Comparison.

Reimplemented from casacore::WCCompound.

◆ toRecord()

virtual TableRecord casacore::WCDifference::toRecord ( const String tableName) const
virtual

Convert the (derived) object to a record.

Implements casacore::WCRegion.

◆ type()

virtual String casacore::WCDifference::type ( ) const
virtual

Get the region type.

Returns className()

Implements casacore::WCRegion.


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