casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Protected Member Functions
casa::WCComplement Class Reference

Make the complement of an image region. More...

#include <WCComplement.h>

Inheritance diagram for casa::WCComplement:
casa::WCCompound casa::WCRegion

List of all members.

Public Member Functions

 WCComplement ()
 WCComplement (const ImageRegion &region1)
 Construct the complement of the given region.
 WCComplement (const WCComplement &other)
 Copy constructor (copy semantics).
virtual ~WCComplement ()
WCComplementoperator= (const WCComplement &other)
 Assignment (copy semantics).
virtual Bool operator== (const WCRegion &other) const
 Comparison.
virtual WCRegioncloneRegion () const
 Make a copy of the derived object.
virtual String type () const
 Get the region type.
virtual TableRecord toRecord (const String &tableName) const
 Convert the (derived) object to a record.
 WCComplement (Bool takeOver, const PtrBlock< const WCRegion * > &regions)
 Construct from multiple regions.

Static Public Member Functions

static String className ()
 Get the class name (to store in the record).
static WCComplementfromRecord (const TableRecord &, const String &tableName)
 Convert correct object from a record.

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.

Detailed Description

Make the complement of an image region.

Intended use:

Public interface

Prerequisite

Synopsis

The WCComplement class is a specialization of class WCCompound . It makes it possible to take the complement of the given region (which can be a simple WCBox, but also a complex compound region). Note that only world coordinate regions can be used in a compound, thus an LCSlicer object is not allowed in an intersection.

Note that a region consists of all its masked-on pixels inside the bounding box of the region. Thus the complement consists of all pixels outside the bounding box and all masked-off pixels inside the bounding box. So the complement of the complement of a region is the region itself.

Example

Definition at line 75 of file WCComplement.h.


Constructor & Destructor Documentation

Construct the complement of the given region.

Copy constructor (copy semantics).

virtual casa::WCComplement::~WCComplement ( ) [virtual]
casa::WCComplement::WCComplement ( Bool  takeOver,
const PtrBlock< const WCRegion * > &  regions 
)

Construct from multiple regions.

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


Member Function Documentation

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

virtual WCRegion* casa::WCComplement::cloneRegion ( ) const [virtual]

Make a copy of the derived object.

cloneRegion needs to return a WCRegion * because the SGI compiler is smart enough to do the right thing.

Implements casa::WCRegion.

virtual LCRegion* casa::WCComplement::doToLCRegion ( const CoordinateSystem cSys,
const IPosition shape,
const IPosition pixelAxesMap,
const IPosition outOrder 
) const [protected, virtual]

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 casa::WCRegion.

static WCComplement* casa::WCComplement::fromRecord ( const TableRecord ,
const String tableName 
) [static]

Convert correct object from a record.

Reimplemented from casa::WCRegion.

WCComplement& casa::WCComplement::operator= ( const WCComplement other)

Assignment (copy semantics).

virtual Bool casa::WCComplement::operator== ( const WCRegion other) const [virtual]

Comparison.

Reimplemented from casa::WCCompound.

virtual TableRecord casa::WCComplement::toRecord ( const String tableName) const [virtual]

Convert the (derived) object to a record.

Implements casa::WCRegion.

virtual String casa::WCComplement::type ( ) const [virtual]

Get the region type.

Returns className()

Implements casa::WCRegion.


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