LCPixelSet.h

Classes

LCPixelSet -- Class to define a rectangular mask as a region (full description)

class LCPixelSet: public LCRegionFixed

Interface

Public Members
LCPixelSet()
LCPixelSet (const Array<Bool>& mask, const LCBox& region)
LCPixelSet (const LCPixelSet& other)
virtual ~LCPixelSet()
LCPixelSet& operator= (const LCPixelSet& other)
virtual Bool operator== (const LCRegion& other) const
virtual LCRegion* cloneRegion() const
static String className()
virtual String type() const
virtual TableRecord toRecord (const String& tableName) const
static LCPixelSet* fromRecord (const TableRecord&, const String& tablename)
Protected Members
virtual LCRegion* doTranslate (const Vector<Float>& translateVector, const IPosition& newLatticeShape) const

Description

Prerequisite

Synopsis

The LCPixelSet class is a specialization of class LCRegion. It makes it possible to define a rectangular region of interest.

Example


 

To Do

Member Description

LCPixelSet()

LCPixelSet (const Array<Bool>& mask, const LCBox& region)

Construct from the box defining the position of the mask. The shape of the region and mask must be the same.

LCPixelSet (const LCPixelSet& other)

Copy constructor (copy semantics).

virtual ~LCPixelSet()

LCPixelSet& operator= (const LCPixelSet& other)

Assignment (copy semantics).

virtual Bool operator== (const LCRegion& other) const

Comparison

virtual LCRegion* cloneRegion() const

Make a copy of the derived object.

static String className()

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

virtual String type() const

Get the region type. Returns className().

virtual TableRecord toRecord (const String& tableName) const

Convert the (derived) object to a record.

static LCPixelSet* fromRecord (const TableRecord&, const String& tablename)

Convert correct object from a record.

virtual LCRegion* doTranslate (const Vector<Float>& translateVector, const IPosition& newLatticeShape) const

Construct another LCPixelSet (for e.g. another lattice) by moving this one. It recalculates the bounding mask. A positive translation value indicates "to right".