casacore
|
#include <LCEllipsoid.h>
Public Member Functions | |
LCEllipsoid () | |
LCEllipsoid (const IPosition ¢er, Float radius, const IPosition &latticeShape) | |
Construct an N-dimensional sphere with the given center and radius (in pixels). More... | |
LCEllipsoid (const Vector< Float > ¢er, Float radius, const IPosition &latticeShape) | |
Construct an N-dimensional sphere with the given center and radius (in pixels). More... | |
LCEllipsoid (const Vector< Double > ¢er, Double radius, const IPosition &latticeShape) | |
LCEllipsoid (const Vector< Float > ¢er, const Vector< Float > &radii, const IPosition &latticeShape) | |
Construct an N-dimensional ellipsoid with the given center and radii (in pixels). More... | |
LCEllipsoid (const Vector< Double > ¢er, const Vector< Double > &radii, const IPosition &latticeShape) | |
LCEllipsoid (const Float xcenter, const Float ycenter, const Float majorAxis, const Float minorAxis, const Float theta, const IPosition &latticeShape) | |
Construct a two dimensional ellipse with theta being the angle from the x-axis to the major axis of the ellipse in radians. More... | |
LCEllipsoid (const LCEllipsoid &other) | |
Copy constructor (reference semantics). More... | |
virtual | ~LCEllipsoid () |
LCEllipsoid & | operator= (const LCEllipsoid &other) |
Assignment (copy semantics). More... | |
virtual Bool | operator== (const LCRegion &other) const |
Comparison. More... | |
virtual LCRegion * | cloneRegion () const |
Make a copy of the derived object. More... | |
const Vector< Float > & | center () const |
Get the center. More... | |
const Vector< Float > & | radii () const |
Get the radii. More... | |
const Float & | theta () const |
Get the angle of the major axis of the ellipse relative to the x-axis 2-D only, throws exception if ellipse is not 2-D. 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... | |
![]() | |
LCRegionFixed () | |
LCRegionFixed (const IPosition &latticeShape) | |
Construct with the lattice shape only. More... | |
LCRegionFixed (const LCRegionFixed &other) | |
Copy constructor (copy semantics). More... | |
virtual | ~LCRegionFixed () |
Destructor. More... | |
const ArrayLattice< Bool > & | getMask () const |
Return the mask. More... | |
![]() | |
LCRegionSingle () | |
LCRegionSingle (const IPosition &latticeShape) | |
Construct with the lattice shape only. More... | |
LCRegionSingle (const LCRegionSingle &other) | |
Copy constructor (copy semantics). More... | |
virtual | ~LCRegionSingle () |
virtual Bool | hasMask () const |
Does the region have a mask? More... | |
const Array< Bool > | maskArray () const |
Get the mask (as an array). More... | |
Bool | masksEqual (const LCRegion &other) const |
Is the mask of this region the same as the mask of the other. More... | |
virtual void | set (const Bool &value) |
The following "put" functions are described in detail in class Lattice. 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... | |
![]() | |
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 String & | comment () const |
Get or set the comment. More... | |
void | setComment (const String &comment) |
LCRegion * | translate (const IPosition &translateVector) const |
Construct another LCRegion (for e.g. More... | |
LCRegion * | translate (const IPosition &translateVector, const IPosition &newLatticeShape) const |
LCRegion * | translate (const Vector< Float > &translateVector) const |
LCRegion * | translate (const Vector< Float > &translateVector, const IPosition &newLatticeShape) const |
const IPosition & | latticeShape () const |
Give the full lattice shape. More... | |
const Slicer & | boundingBox () 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 | ~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< Bool > | get (Bool removeDegenerateAxes=False) const |
Bool | getSlice (COWPtr< Array< Bool > > &buffer, const Slicer §ion, 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 §ion, 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< Bool > | getSlice (const Slicer §ion, Bool removeDegenerateAxes=False) const |
Array< Bool > | getSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
Array< Bool > | getSlice (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... | |
Static Public Member Functions | |
static String | className () |
Get the class name (to store in the record). More... | |
static LCEllipsoid * | fromRecord (const TableRecord &, const String &tableName) |
Convert correct object from a record. More... | |
![]() | |
static LCRegion * | fromRecord (const TableRecord &, const String &tableName) |
Convert correct object from a record. More... | |
Protected Member Functions | |
virtual LCRegion * | doTranslate (const Vector< Float > &translateVector, const IPosition &newLatticeShape) const |
Construct another LCBox (for e.g. More... | |
![]() | |
LCRegionFixed & | operator= (const LCRegionFixed &other) |
Assignment (copy semantics) is only useful for derived classes. More... | |
void | setMask (const Array< Bool > &mask) |
Set the mask. More... | |
![]() | |
LCRegionSingle & | operator= (const LCRegionSingle &other) |
Assignment (copy semantics) is only useful for derived classes. More... | |
void | setMaskPtr (Lattice< Bool > &mask) |
Set the pointer to the mask in the derived class. More... | |
virtual Bool | doGetSlice (Array< Bool > &buffer, const Slicer §ion) |
Do the actual getting of the mask. More... | |
virtual void | doPutSlice (const Array< Bool > &sourceBuffer, const IPosition &where, const IPosition &stride) |
Do the actual putting of the mask. More... | |
virtual IPosition | doNiceCursorShape (uInt maxPixels) const |
Get the best cursor shape. More... | |
virtual LatticeIterInterface< Bool > * | makeIter (const LatticeNavigator &navigator, Bool useRef) const |
Make an iterator. More... | |
![]() | |
LCRegion & | operator= (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... | |
![]() | |
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 | fillCenter (const IPosition ¢er) |
Fill the itsCenter vector from an IPosition. More... | |
Slicer | makeBox (const Vector< Float > &radii, const IPosition &latticeShape) |
Make the bounding box from center, radii, and shape. More... | |
void | defineMask () |
Define the mask to indicate which elements are inside the ellipsoid. More... | |
void | _defineMask2D () |
for 2-D ellipse with non-zero theta. More... | |
void | _doOutside () |
set the mask in the case the center lies outside the lattice More... | |
Private Attributes | |
Vector< Float > | itsCenter |
Vector< Float > | itsRadii |
Vector< Float > | _epsilon |
small offset to guard against roundoff error More... | |
Float | _theta |
for 2-D case only More... | |
Bool | _centerIsInside |
is center inside the lattice? More... | |
Define an N-dimensional ellipsoidal region of interest.
Public interface
The LCEllipsoid class is a specialization of class LCRegion. It makes it possible to define an N-dimensional ellipsoidal region of interest, which includes the border. A separate constructor exists to define the special case of an N-dimensional sphere.
The center and the radii of the ellipsoid do not need to be pixel aligned. The center of the ellipsoid may be outside the lattice. The current implementation only supports ellipsoids with axes parallel to the lattice axes except in the case of a 2-D ellipse for which a constructor is provided for specifying the angle between the x-axis and major axis of the ellipse.
It can only be used for a lattice of any dimensionality as long as the dimensionality of the (hyper-)ellipsoid matches the dimensionality of the lattice.
Definition at line 83 of file LCEllipsoid.h.
casacore::LCEllipsoid::LCEllipsoid | ( | ) |
casacore::LCEllipsoid::LCEllipsoid | ( | const IPosition & | center, |
Float | radius, | ||
const IPosition & | latticeShape | ||
) |
Construct an N-dimensional sphere with the given center and radius (in pixels).
The center is pixel-aligned.
casacore::LCEllipsoid::LCEllipsoid | ( | const Vector< Float > & | center, |
Float | radius, | ||
const IPosition & | latticeShape | ||
) |
Construct an N-dimensional sphere with the given center and radius (in pixels).
The center does not need to be pixel-aligned.
casacore::LCEllipsoid::LCEllipsoid | ( | const Vector< Double > & | center, |
Double | radius, | ||
const IPosition & | latticeShape | ||
) |
casacore::LCEllipsoid::LCEllipsoid | ( | const Vector< Float > & | center, |
const Vector< Float > & | radii, | ||
const IPosition & | latticeShape | ||
) |
Construct an N-dimensional ellipsoid with the given center and radii (in pixels).
The center does not need to be pixel-aligned. (the radii are half the length of the axes of the ellipsoid).
casacore::LCEllipsoid::LCEllipsoid | ( | const Vector< Double > & | center, |
const Vector< Double > & | radii, | ||
const IPosition & | latticeShape | ||
) |
casacore::LCEllipsoid::LCEllipsoid | ( | const Float | xcenter, |
const Float | ycenter, | ||
const Float | majorAxis, | ||
const Float | minorAxis, | ||
const Float | theta, | ||
const IPosition & | latticeShape | ||
) |
Construct a two dimensional ellipse with theta being the angle from the x-axis to the major axis of the ellipse in radians.
casacore::LCEllipsoid::LCEllipsoid | ( | const LCEllipsoid & | other | ) |
Copy constructor (reference semantics).
|
virtual |
|
private |
for 2-D ellipse with non-zero theta.
Works for both cases center inside or outside the lattice.
|
private |
set the mask in the case the center lies outside the lattice
|
static |
Get the class name (to store in the record).
|
virtual |
Make a copy of the derived object.
Implements casacore::LCRegion.
|
private |
Define the mask to indicate which elements are inside the ellipsoid.
|
protectedvirtual |
Construct another LCBox (for e.g.
another lattice) by moving this one. It recalculates the bounding box. A positive translation value indicates "to right".
Implements casacore::LCRegion.
|
private |
Fill the itsCenter vector from an IPosition.
|
static |
Convert correct object from a record.
|
private |
Make the bounding box from center, radii, and shape.
LCEllipsoid& casacore::LCEllipsoid::operator= | ( | const LCEllipsoid & | other | ) |
Assignment (copy semantics).
Comparison.
Reimplemented from casacore::LCRegionFixed.
const Float& casacore::LCEllipsoid::theta | ( | ) | const |
Get the angle of the major axis of the ellipse relative to the x-axis 2-D only, throws exception if ellipse is not 2-D.
|
virtual |
Convert the (derived) object to a record.
Implements casacore::LCRegion.
|
virtual |
|
private |
is center inside the lattice?
Definition at line 189 of file LCEllipsoid.h.
small offset to guard against roundoff error
Definition at line 185 of file LCEllipsoid.h.
|
private |
for 2-D case only
Definition at line 187 of file LCEllipsoid.h.
Definition at line 182 of file LCEllipsoid.h.
Referenced by center().
Definition at line 183 of file LCEllipsoid.h.
Referenced by radii().