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

Stretch length 1 axes in an LCRegion along straight lines. More...

#include <LCStretch.h>

Public Member Functions

 LCStretch ()
 
 LCStretch (const LCRegion &region, const IPosition &stretchAxes, const LCBox &stretchBox)
 Stretch the given region along axes as given by stretchAxes from the bottom left corner (blc) to the top right corner (trc) as given by stretchBox. More...
 
 LCStretch (Bool takeOver, const LCRegion *region, const IPosition &stretchAxes, const LCBox &stretchBox)
 
 LCStretch (const LCStretch &other)
 Copy constructor (copy semantics). More...
 
virtual ~LCStretch ()
 
LCStretchoperator= (const LCStretch &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...
 
const LCRegionregion () const
 Get the original region. More...
 
const IPositionstretchAxes () const
 Get the stretch axes. More...
 
const LCBoxstretchBox () const
 Get the stretch 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 Lattice< Bool > * clone () const=0
 Make a copy of the derived object (reference semantics). 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...
 

Static Public Member Functions

static String className ()
 Get the class name (to store in the record). More...
 
static LCStretchfromRecord (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 > &)
 

Private Member Functions

void fill (const IPosition &stretchAxes, const LCBox &stretchBox)
 Fill the object. More...
 

Private Attributes

IPosition itsStretchAxes
 
LCBox itsStretchBox
 

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

Stretch length 1 axes in an LCRegion along straight lines.

Intended use:

Public interface

Prerequisite

Synopsis

The LCStretch class is a specialization of class LCRegion. It makes it possible to stretch a LCRegion along straight lines to other dimensions. E.g. a circle in the xy-plane can be stretched to a cylinder in the xyz-space. It can be used for a lattice of any dimensionality as long as the dimensionality of the (hyper-)stretch matches the dimensionality of the lattice.

Example

To Do

Definition at line 72 of file LCStretch.h.

Constructor & Destructor Documentation

◆ LCStretch() [1/4]

casacore::LCStretch::LCStretch ( )

◆ LCStretch() [2/4]

casacore::LCStretch::LCStretch ( const LCRegion region,
const IPosition stretchAxes,
const LCBox stretchBox 
)

Stretch the given region along axes as given by stretchAxes from the bottom left corner (blc) to the top right corner (trc) as given by stretchBox.

The axes to be stretched need to have length 1 in the original region. Every kind of box (absolute, relative, fractional, unspecified) can be used to define the stretch blc and trc. The dimensionality of the LCStretch region is the same as the dimensionality of the original region.
The second version takes over the pointer when the switch is true.

◆ LCStretch() [3/4]

casacore::LCStretch::LCStretch ( Bool  takeOver,
const LCRegion region,
const IPosition stretchAxes,
const LCBox stretchBox 
)

◆ LCStretch() [4/4]

casacore::LCStretch::LCStretch ( const LCStretch other)

Copy constructor (copy semantics).

◆ ~LCStretch()

virtual casacore::LCStretch::~LCStretch ( )
virtual

Member Function Documentation

◆ className()

static String casacore::LCStretch::className ( )
static

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

◆ cloneRegion()

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

Make a copy of the derived object.

Implements casacore::LCRegion.

◆ doNiceCursorShape()

virtual IPosition casacore::LCStretch::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::LCStretch::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.

◆ fill()

void casacore::LCStretch::fill ( const IPosition stretchAxes,
const LCBox stretchBox 
)
private

Fill the object.

◆ fromRecord()

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

Convert correct object from a record.

◆ multiGetSlice()

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

Do the actual getting of the mask.

Implements casacore::LCRegionMulti.

◆ operator=()

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

Assignment (copy semantics).

◆ operator==()

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

Comparison.

Reimplemented from casacore::LCRegionMulti.

◆ region()

const LCRegion & casacore::LCStretch::region ( ) const
inline

Get the original region.

Definition at line 157 of file LCStretch.h.

References casacore::LCRegionMulti::regions().

◆ stretchAxes()

const IPosition & casacore::LCStretch::stretchAxes ( ) const
inline

Get the stretch axes.

Definition at line 161 of file LCStretch.h.

References itsStretchAxes.

◆ stretchBox()

const LCBox & casacore::LCStretch::stretchBox ( ) const
inline

Get the stretch box.

Definition at line 165 of file LCStretch.h.

References itsStretchBox.

◆ toRecord()

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

Convert the (derived) object to a record.

Implements casacore::LCRegion.

◆ type()

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

Get the region type.

Returns the class name.

Implements casacore::LCRegion.

Member Data Documentation

◆ itsStretchAxes

IPosition casacore::LCStretch::itsStretchAxes
private

Definition at line 152 of file LCStretch.h.

Referenced by stretchAxes().

◆ itsStretchBox

LCBox casacore::LCStretch::itsStretchBox
private

Definition at line 153 of file LCStretch.h.

Referenced by stretchBox().


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