casacore
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::LCConcatenation Class Reference

More...

#include <LCConcatenation.h>

Public Member Functions

 LCConcatenation ()
 
 LCConcatenation (Bool takeOver, const PtrBlock< const LCRegion * > &regions, Int extendAxis)
 Combine the given regions. More...
 
 LCConcatenation (Bool takeOver, const PtrBlock< const LCRegion * > &regions, Int extendAxis, const LCBox &extendRange)
 
 LCConcatenation (const LCConcatenation &other)
 Copy constructor (copy semantics). More...
 
virtual ~LCConcatenation ()
 
LCConcatenationoperator= (const LCConcatenation &other)
 Assignment (copy semantics). More...
 
virtual Bool operator== (const LCRegion &other) const
 Comparison. More...
 
virtual LCRegioncloneRegion () const
 Make a copy of the derived object. More...
 
Int extendAxis () const
 Get the extend axis. More...
 
const LCBoxextendBox () const
 Get the extend box. 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::LCRegionMulti
 LCRegionMulti ()
 
 LCRegionMulti (const LCRegion &region1, const LCRegion &region2)
 Construct from 2 regions. More...
 
 LCRegionMulti (Bool takeOver, const LCRegion *region1, const LCRegion *region2=0, const LCRegion *region3=0, const LCRegion *region4=0, const LCRegion *region5=0, const LCRegion *region6=0, const LCRegion *region7=0, const LCRegion *region8=0, const LCRegion *region9=0, const LCRegion *region10=0)
 Construct from multiple regions. More...
 
 LCRegionMulti (Bool takeOver, const PtrBlock< const LCRegion * > &regions)
 Construct from multiple regions given as a Block. More...
 
 LCRegionMulti (const LCRegionMulti &other)
 Copy constructor (copy semantics). More...
 
virtual ~LCRegionMulti ()
 
LCRegionMultioperator= (const LCRegionMulti &other)
 Assignment (copy semantics). More...
 
virtual Bool hasMask () const
 Does the region have a mask? More...
 
- Public Member Functions inherited from casacore::LCRegion
 LCRegion ()
 
 LCRegion (const IPosition &latticeShape)
 Construct with the lattice shape only. More...
 
 LCRegion (const LCRegion &other)
 Copy constructor (copy semantics). More...
 
virtual ~LCRegion ()
 
Bool operator!= (const LCRegion &other) const
 Non-equality. More...
 
virtual Lattice< Bool > * clone () const
 Make a copy of the derived object. More...
 
virtual void handleDelete ()
 Handle deletion of the region by deleting possible tables. More...
 
virtual void handleRename (const String &newName, Bool overwrite)
 Handle renaming the region by renaming possible tables. More...
 
const Stringcomment () const
 Get or set the comment. More...
 
void setComment (const String &comment)
 
LCRegiontranslate (const IPosition &translateVector) const
 Construct another LCRegion (for e.g. More...
 
LCRegiontranslate (const IPosition &translateVector, const IPosition &newLatticeShape) const
 
LCRegiontranslate (const Vector< Float > &translateVector) const
 
LCRegiontranslate (const Vector< Float > &translateVector, const IPosition &newLatticeShape) const
 
const IPositionlatticeShape () const
 Give the full lattice shape. More...
 
const SlicerboundingBox () const
 Give the bounding box. More...
 
Slicer expand (const Slicer &slicer) const
 Expand a slicer or position in the region to the full lattice. More...
 
IPosition expand (const IPosition &index) const
 
virtual uInt ndim () const
 Return the dimensionality of the region. More...
 
virtual IPosition shape () const
 Return the shape of the region (i.e. More...
 
virtual Bool isWritable () const
 Usually the lattice (i.e. More...
 
virtual void doPutSlice (const Array< Bool > &sourceBuffer, const IPosition &where, const IPosition &stride)
 Regions can usually not be put; i.e. More...
 
virtual void set (const Bool &value)
 Set all elements in the Lattice to the given value. More...
 
virtual void apply (Bool(*function)(Bool))
 Replace every element, x, of the Lattice with the result of f(x). More...
 
virtual void apply (Bool(*function)(const Bool &))
 
virtual void apply (const Functional< Bool, Bool > &function)
 
virtual void putAt (const Bool &value, const IPosition &where)
 Put the value of a single element. More...
 
virtual void copyData (const Lattice< Bool > &from)
 Copy the data from the given lattice to this one. More...
 
- Public Member Functions inherited from casacore::Lattice< Bool >
virtual ~Lattice ()
 a virtual destructor is needed so that it will use the actual destructor in the derived class More...
 
virtual DataType dataType () const
 Get the data type of the lattice. More...
 
Bool operator() (const IPosition &where) const
 Return the value of the single element located at the argument IPosition. More...
 
virtual Bool getAt (const IPosition &where) const
 
Bool get (COWPtr< Array< Bool > > &buffer, Bool removeDegenerateAxes=False) const
 Functions which extract an Array of values from a Lattice. More...
 
Bool get (Array< Bool > &buffer, Bool removeDegenerateAxes=False)
 
Array< Boolget (Bool removeDegenerateAxes=False) const
 
Bool getSlice (COWPtr< Array< Bool > > &buffer, const Slicer &section, Bool removeDegenerateAxes=False) const
 
Bool getSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const
 
Bool getSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const
 
Bool getSlice (Array< Bool > &buffer, const Slicer &section, Bool removeDegenerateAxes=False)
 
Bool getSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False)
 
Bool getSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False)
 
Array< BoolgetSlice (const Slicer &section, Bool removeDegenerateAxes=False) const
 
Array< BoolgetSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const
 
Array< BoolgetSlice (const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const
 
void putSlice (const Array< Bool > &sourceBuffer, const IPosition &where, const IPosition &stride)
 A function which places an Array of values within this instance of the Lattice at the location specified by the IPosition "where", incrementing by "stride". More...
 
void putSlice (const Array< Bool > &sourceBuffer, const IPosition &where)
 
void put (const Array< Bool > &sourceBuffer)
 
void operator+= (const Lattice< Bool > &other)
 Add, subtract, multiple, or divide by another Lattice. More...
 
void operator-= (const Lattice< Bool > &other)
 
void operator*= (const Lattice< Bool > &other)
 
void operator/= (const Lattice< Bool > &other)
 
virtual void copyDataTo (Lattice< Bool > &to) const
 Copy the data from this lattice to the given lattice. More...
 
virtual uInt advisedMaxPixels () const
 This function returns the advised maximum number of pixels to include in the cursor of an iterator. More...
 
virtual LatticeIterInterface< Bool > * makeIter (const LatticeNavigator &navigator, Bool useRef) const
 These functions are used by the LatticeIterator class to generate an iterator of the correct type for a specified Lattice. More...
 
- Public Member Functions inherited from casacore::LatticeBase
virtual ~LatticeBase ()
 A virtual destructor is needed so that it will use the actual destructor in the derived class. More...
 
virtual String imageType () const
 Get the image type (returns name of derived class). More...
 
virtual Bool isPersistent () const
 Is the lattice persistent and can it be loaded by other processes as well? That is the case for a PagedArray or PagedImage and for an ImageExpr which does not use transient lattices or regions. More...
 
virtual Bool isPaged () const
 Is the lattice paged to disk?
The default implementation returns False. More...
 
virtual Bool canReferenceArray () const
 Can the lattice data be referenced as an array section? That is the case for an ArrayLattice or a Temp/SubLattice using it. More...
 
virtual void save (const String &fileName) const
 Save the image in an AipsIO file with the given name. More...
 
virtual Bool lock (FileLocker::LockType, uInt nattempts)
 It is strongly recommended to use class LatticeLocker to handle lattice locking. More...
 
virtual void unlock ()
 
virtual Bool hasLock (FileLocker::LockType) const
 
virtual void resync ()
 Resynchronize the Lattice object with the lattice file. More...
 
virtual void flush ()
 Flush the data (but do not unlock). More...
 
virtual void tempClose ()
 Temporarily close the lattice. More...
 
virtual void reopen ()
 Explicitly reopen the temporarily closed lattice. More...
 
virtual String name (Bool stripPath=False) const
 Return the name of the current Lattice object. More...
 
virtual size_t nelements () const
 Return the total number of elements in this Lattice. More...
 
size_t size () const
 
Bool conform (const LatticeBase &other) const
 Return a value of "True" if this instance of Lattice and 'other' have the same shape, otherwise returns a value of "False". More...
 
virtual LELCoordinates lelCoordinates () const
 Return the coordinates of the lattice. More...
 
IPosition niceCursorShape (uInt maxPixels) const
 Returns a recommended cursor shape for iterating through all the pixels in the Lattice. More...
 
IPosition niceCursorShape () const
 
virtual Bool ok () const
 Check class internals - used for debugging. More...
 
virtual uInt maximumCacheSize () const
 Maximum cache size - not necessarily all used. More...
 
virtual void setMaximumCacheSize (uInt howManyPixels)
 Set the maximum (allowed) cache size as indicated. More...
 
virtual void setCacheSizeInTiles (uInt howManyTiles)
 Set the actual cache size for this Array to be big enough for the indicated number of tiles. More...
 
virtual void setCacheSizeFromPath (const IPosition &sliceShape, const IPosition &windowStart, const IPosition &windowLength, const IPosition &axisPath)
 Set the cache size as to "fit" the indicated path. More...
 
virtual void clearCache ()
 Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSize was called. More...
 
virtual void showCacheStatistics (ostream &os) const
 Report on cache success. More...
 

Static Public Member Functions

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

Protected Member Functions

virtual LCRegiondoTranslate (const Vector< Float > &translateVector, const IPosition &newLatticeShape) const
 Construct another LCRegion (for e.g. More...
 
virtual void multiGetSlice (Array< Bool > &buffer, const Slicer &section)
 Do the actual getting of the mask. More...
 
virtual IPosition doNiceCursorShape (uInt maxPixels) const
 This function is needed here because the niceCursorShape of the contributing region does not make any sense (other dimensionality). More...
 
- Protected Member Functions inherited from casacore::LCRegionMulti
TableRecord makeRecord (const String &tableName) const
 Store the contributing regions in a record. More...
 
void multiTranslate (PtrBlock< const LCRegion * > &, const Vector< Float > &translateVector, const IPosition &newLatticeShape) const
 Translate all regions. More...
 
void fillHasMask ()
 Determine if all regions have mask (used by LCIntersection). More...
 
Bool findAreas (IPosition &bufStart, IPosition &bufEnd, IPosition &regStart, IPosition &regEnd, const Slicer &section, uInt regNr) const
 Find which area of the section and region are needed. More...
 
const PtrBlock< const LCRegion * > & regions () const
 Get the contributing regions. More...
 
 LCRegionMulti (const LCRegion *region, const IPosition &latticeShape)
 Construct from lattice shape and region pointer, which is taken over. More...
 
virtual Bool doGetSlice (Array< Bool > &buffer, const Slicer &section)
 Do the actual getting of an array of values. More...
 
- Protected Member Functions inherited from casacore::LCRegion
LCRegionoperator= (const LCRegion &other)
 Assignment (copy semantics) is only useful for derived classes. More...
 
void setBoundingBox (const Slicer &boundingBox)
 Sometimes it is inconvenient for a derived class to set the bounding box in the constructor. More...
 
void setShapeAndBoundingBox (const IPosition &latticeShape, const Slicer &boundingBox)
 
void defineRecordFields (RecordInterface &record, const String &className) const
 Define the type and class name in the record. More...
 
- Protected Member Functions inherited from casacore::Lattice< Bool >
 Lattice ()
 Define default constructor to satisfy compiler. More...
 
 Lattice (const Lattice< Bool > &)
 Copy constructor and assignment can only be used by derived classes. More...
 
virtual void handleMath (const Lattice< Bool > &from, int oper)
 Handle the Math operators (+=, -=, *=, /=). More...
 
virtual void handleMathTo (Lattice< Bool > &to, int oper) const
 
void handleMathTo (Lattice< Bool > &, int) const
 
Lattice< Bool > & operator= (const Lattice< Bool > &)
 
- Protected Member Functions inherited from casacore::LatticeBase
 LatticeBase ()
 Define default constructor to be used by derived classes. More...
 
 LatticeBase (const LatticeBase &)
 Copy constructor and assignment can only be used by derived classes. More...
 
LatticeBaseoperator= (const LatticeBase &)
 
void throwBoolMath () const
 Throw an exception for arithmetic on a Bool Lattice. More...
 

Private Member Functions

void fillRegionAxes ()
 Fill the object. More...
 
void fill ()
 

Private Attributes

Int itsExtendAxis
 
IPosition itsRegionAxes
 
LCBox itsExtendBox
 

Additional Inherited Members

- Static Protected Member Functions inherited from casacore::LCRegionMulti
static void unmakeRecord (PtrBlock< const LCRegion * > &, const TableRecord &, const String &tableName)
 Retrieve the contributing objects from the record. More...
 

Detailed Description

Combine multiple LCRegion's into a new dimension.

Intended use:

Public interface

Prerequisite

Synopsis

The LCConcatenation class is a specialization of class LCRegion. It makes it possible to combine multiple LCRegion's and to add a dimension on them. The range (beginning and end) in that new dimension have to be specified using an LCBox object. When the LCBox is complete, it will be checked if the given number of regions matches the length of the given range (so it could only be done after the makeComplete call). Using a fractional box does not make much sense, because it results in a varying length range when used with varying shaped lattices. However, one can use it if wanted.
LCConcatenation can be seen as a mixture of the classes LCUnion and LCExtension. Like LCUnion it combines regions and like LCExtension it increases the dimensionality for the new region (be it with only 1).
E.g. One can define a different polygon in the RA-DEC plane of each channel. LCConcatenation makes it possible to combine the polygons to one 3D region in the RA-DEC-Freq cube.

Example

This example combines n (relative) circles given in the x-z plane along the y-axis. In this example the regions used are circles with the same centers, but it is also possible to combine differently shaped regions. Note that LCConcatenation takes over the pointers to the individual regions, so they do not need to be deleted (the LCConcatenation destructor does it).

IPosition center (2,10,20);
PtrBlock<LCRegion*> cirPtr(n);
for (i=0; i<n; i++) {
// Each circle has a different radius.
cirPtr(i) = new LCEllipsoid cir1 (center, 1 + i%(n/2));
}
// Construct the concatenation for a range (given as a relative box).
// Extend along the y-axis (axis numbers start counting at 0!).
// Take over the region pointers.
LCConcatenation region (True, cirPtr, 1, LCBox(n/2-n, n/2-1));
const Bool True
Definition: aipstype.h:43

Definition at line 102 of file LCConcatenation.h.

Constructor & Destructor Documentation

◆ LCConcatenation() [1/4]

casacore::LCConcatenation::LCConcatenation ( )

◆ LCConcatenation() [2/4]

casacore::LCConcatenation::LCConcatenation ( Bool  takeOver,
const PtrBlock< const LCRegion * > &  regions,
Int  extendAxis 
)

Combine the given regions.

When takeOver is True, the destructor will delete the given regions. Otherwise a copy of the regions is made. The extend range has to be given as a 1-dimensional box. The default range is the entire axis.

◆ LCConcatenation() [3/4]

casacore::LCConcatenation::LCConcatenation ( Bool  takeOver,
const PtrBlock< const LCRegion * > &  regions,
Int  extendAxis,
const LCBox extendRange 
)

◆ LCConcatenation() [4/4]

casacore::LCConcatenation::LCConcatenation ( const LCConcatenation other)

Copy constructor (copy semantics).

◆ ~LCConcatenation()

virtual casacore::LCConcatenation::~LCConcatenation ( )
virtual

Member Function Documentation

◆ className()

static String casacore::LCConcatenation::className ( )
static

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

◆ cloneRegion()

virtual LCRegion* casacore::LCConcatenation::cloneRegion ( ) const
virtual

Make a copy of the derived object.

Implements casacore::LCRegion.

◆ doNiceCursorShape()

virtual IPosition casacore::LCConcatenation::doNiceCursorShape ( uInt  maxPixels) const
protectedvirtual

This function is needed here because the niceCursorShape of the contributing region does not make any sense (other dimensionality).


Reimplemented from casacore::LCRegionMulti.

◆ doTranslate()

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

Construct another LCRegion (for e.g.

another lattice) by moving this one. It recalculates the bounding box and mask. A positive translation value indicates "to right".

Implements casacore::LCRegion.

◆ extendAxis()

Int casacore::LCConcatenation::extendAxis ( ) const
inline

Get the extend axis.

Definition at line 179 of file LCConcatenation.h.

References itsExtendAxis.

◆ extendBox()

const LCBox & casacore::LCConcatenation::extendBox ( ) const
inline

Get the extend box.

Definition at line 183 of file LCConcatenation.h.

References itsExtendBox.

◆ fill()

void casacore::LCConcatenation::fill ( )
private

◆ fillRegionAxes()

void casacore::LCConcatenation::fillRegionAxes ( )
private

Fill the object.

◆ fromRecord()

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

Convert correct object from a record.

◆ multiGetSlice()

virtual void casacore::LCConcatenation::multiGetSlice ( Array< Bool > &  buffer,
const Slicer section 
)
protectedvirtual

Do the actual getting of the mask.

Implements casacore::LCRegionMulti.

◆ operator=()

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

Assignment (copy semantics).

◆ operator==()

virtual Bool casacore::LCConcatenation::operator== ( const LCRegion other) const
virtual

Comparison.

Reimplemented from casacore::LCRegionMulti.

◆ toRecord()

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

Convert the (derived) object to a record.

Implements casacore::LCRegion.

◆ type()

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

Get the region type.

Returns the class name.

Implements casacore::LCRegion.

Member Data Documentation

◆ itsExtendAxis

Int casacore::LCConcatenation::itsExtendAxis
private

Definition at line 173 of file LCConcatenation.h.

Referenced by extendAxis().

◆ itsExtendBox

LCBox casacore::LCConcatenation::itsExtendBox
private

Definition at line 175 of file LCConcatenation.h.

Referenced by extendBox().

◆ itsRegionAxes

IPosition casacore::LCConcatenation::itsRegionAxes
private

Definition at line 174 of file LCConcatenation.h.


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