|
| SubLattice () |
| The default constructor creates a SubLattice that is useless for just about everything, except that it can be assigned to with the assignment operator. More...
|
|
| SubLattice (const Lattice< T > &lattice, AxesSpecifier=AxesSpecifier()) |
| Create a SubLattice from a Lattice. More...
|
|
| SubLattice (Lattice< T > &lattice, Bool writableIfPossible, AxesSpecifier=AxesSpecifier()) |
|
| SubLattice (const MaskedLattice< T > &lattice, AxesSpecifier=AxesSpecifier()) |
| Create a SubLattice from a MaskedLattice. More...
|
|
| SubLattice (MaskedLattice< T > &lattice, Bool writableIfPossible, AxesSpecifier=AxesSpecifier()) |
|
| SubLattice (const Lattice< T > &lattice, const LatticeRegion ®ion, AxesSpecifier=AxesSpecifier()) |
| Create a SubLattice from the given MaskedLattice and region. More...
|
|
| SubLattice (Lattice< T > &lattice, const LatticeRegion ®ion, Bool writableIfPossible, AxesSpecifier=AxesSpecifier()) |
|
| SubLattice (const MaskedLattice< T > &lattice, const LatticeRegion ®ion, AxesSpecifier=AxesSpecifier()) |
|
| SubLattice (MaskedLattice< T > &lattice, const LatticeRegion ®ion, Bool writableIfPossible, AxesSpecifier=AxesSpecifier()) |
|
| SubLattice (const Lattice< T > &lattice, const Slicer &slicer, AxesSpecifier=AxesSpecifier()) |
| Create a SubLattice from the given (Masked)Lattice and slicer. More...
|
|
| SubLattice (Lattice< T > &lattice, const Slicer &slicer, Bool writableIfPossible, AxesSpecifier=AxesSpecifier()) |
|
| SubLattice (const MaskedLattice< T > &lattice, const Slicer &slicer, AxesSpecifier=AxesSpecifier()) |
|
| SubLattice (MaskedLattice< T > &lattice, const Slicer &slicer, Bool writableIfPossible, AxesSpecifier=AxesSpecifier()) |
|
| SubLattice (const SubLattice< T > &other) |
| Copy constructor (reference semantics). More...
|
|
virtual | ~SubLattice () |
|
SubLattice< T > & | operator= (const SubLattice< T > &other) |
| Assignment (reference semantics). More...
|
|
virtual MaskedLattice< T > * | cloneML () const |
| Make a copy of the object (reference semantics). More...
|
|
virtual Bool | isMasked () const |
| Is the lattice masked? It is if its parent lattice or its region is masked. More...
|
|
virtual Bool | isPersistent () const |
| A SubLattice is persistent if no region is applied to the parent lattice. More...
|
|
virtual Bool | isPaged () const |
| Is the SubLattice paged to disk? More...
|
|
virtual Bool | canReferenceArray () const |
| Can the lattice data be referenced as an array section? More...
|
|
virtual Bool | isWritable () const |
| Is the SubLattice writable? More...
|
|
virtual Bool | lock (FileLocker::LockType, uInt nattempts) |
| Handle locking of the SubLattice which is delegated to its parent. 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. More...
|
|
virtual void | tempClose () |
| Close the Lattice temporarily (if it is paged to disk). More...
|
|
virtual void | reopen () |
| If needed, reopen a temporarily closed Lattice. More...
|
|
virtual Bool | hasPixelMask () const |
| Does the SubLattice have a pixelmask? More...
|
|
virtual const Lattice< Bool > & | pixelMask () const |
| Get access to the pixelmask. More...
|
|
virtual Lattice< Bool > & | pixelMask () |
|
void | setPixelMask (const Lattice< Bool > &pixelMask, Bool mayExist) |
| Use the given mask as the pixelmask. More...
|
|
virtual const LatticeRegion * | getRegionPtr () const |
| Get a pointer the region/mask object describing this sublattice. More...
|
|
virtual IPosition | shape () const |
| Returns the shape of the SubLattice including all degenerate axes (i.e. More...
|
|
virtual String | name (Bool stripPath=False) const |
| Return the name of the parent lattice. More...
|
|
virtual uInt | advisedMaxPixels () const |
| This function returns the recommended maximum number of pixels to include in the cursor of an iterator. More...
|
|
virtual T | getAt (const IPosition &where) const |
| Get or put a single element in the lattice. More...
|
|
virtual void | putAt (const T &value, const IPosition &where) |
| Put the value of a single element. More...
|
|
virtual Bool | ok () const |
| Check class internals - used for debugging. More...
|
|
virtual LatticeIterInterface< T > * | makeIter (const LatticeNavigator &navigator, Bool useRef) const |
| This function is used by the LatticeIterator class to generate an iterator of the correct type for this Lattice. More...
|
|
virtual Bool | doGetSlice (Array< T > &buffer, const Slicer §ion) |
| Do the actual getting of an array of values. More...
|
|
virtual void | doPutSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride) |
| Do the actual getting of an array of values. More...
|
|
virtual Bool | doGetMaskSlice (Array< Bool > &buffer, const Slicer §ion) |
| Get a section of the mask. More...
|
|
virtual IPosition | doNiceCursorShape (uInt maxPixels) const |
| Get the best cursor shape. More...
|
|
const AxesMapping & | getAxesMap () const |
| Set the axes mapping from the specification. More...
|
|
IPosition | positionInParent (const IPosition &subLatticePosition) const |
| Convert the specified position in the sublattice to the corresponding position in the parent lattice. More...
|
|
void | setRegion (const Slicer &slicer) |
| Set the region object using a slicer. More...
|
|
| MaskedLattice () |
| Default constructor. More...
|
|
| MaskedLattice (const MaskedLattice< T > &) |
| Copy constructor. More...
|
|
virtual | ~MaskedLattice () |
| a virtual destructor is needed so that it will use the actual destructor in the derived class More...
|
|
virtual Lattice< T > * | clone () const |
| Make a copy of the derived object (reference semantics). More...
|
|
const LatticeRegion & | region () const |
| Get the region used. More...
|
|
Bool | getMask (COWPtr< Array< Bool > > &buffer, Bool removeDegenerateAxes=False) const |
| Get the mask or a slice from the mask. More...
|
|
Bool | getMaskSlice (COWPtr< Array< Bool > > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) const |
|
Bool | getMaskSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
|
Bool | getMaskSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
|
Bool | getMask (Array< Bool > &buffer, Bool removeDegenerateAxes=False) |
|
Bool | getMaskSlice (Array< Bool > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) |
|
Bool | getMaskSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) |
|
Bool | getMaskSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) |
|
Array< Bool > | getMask (Bool removeDegenerateAxes=False) const |
|
Array< Bool > | getMaskSlice (const Slicer §ion, Bool removeDegenerateAxes=False) const |
|
Array< Bool > | getMaskSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
|
Array< Bool > | getMaskSlice (const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
|
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...
|
|
T | operator() (const IPosition &where) const |
| Return the value of the single element located at the argument IPosition. More...
|
|
Bool | get (COWPtr< Array< T > > &buffer, Bool removeDegenerateAxes=False) const |
| Functions which extract an Array of values from a Lattice. More...
|
|
Bool | getSlice (COWPtr< Array< T > > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) const |
|
Bool | getSlice (COWPtr< Array< T > > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
|
Bool | getSlice (COWPtr< Array< T > > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
|
Bool | get (Array< T > &buffer, Bool removeDegenerateAxes=False) |
|
Bool | getSlice (Array< T > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) |
|
Bool | getSlice (Array< T > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) |
|
Bool | getSlice (Array< T > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) |
|
Array< T > | get (Bool removeDegenerateAxes=False) const |
|
Array< T > | getSlice (const Slicer §ion, Bool removeDegenerateAxes=False) const |
|
Array< T > | getSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
|
Array< T > | getSlice (const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
|
void | putSlice (const Array< T > &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< T > &sourceBuffer, const IPosition &where) |
|
void | put (const Array< T > &sourceBuffer) |
|
virtual void | set (const T &value) |
| Set all elements in the Lattice to the given value. More...
|
|
virtual void | apply (T(*function)(T)) |
| Replace every element, x, of the Lattice with the result of f(x). More...
|
|
virtual void | apply (T(*function)(const T &)) |
|
virtual void | apply (const Functional< T, T > &function) |
|
void | operator+= (const Lattice< T > &other) |
| Add, subtract, multiple, or divide by another Lattice. More...
|
|
void | operator-= (const Lattice< T > &other) |
|
void | operator*= (const Lattice< T > &other) |
|
void | operator/= (const Lattice< T > &other) |
|
virtual void | copyData (const Lattice< T > &from) |
| Copy the data from the given lattice to this one. More...
|
|
virtual void | copyDataTo (Lattice< T > &to) const |
| Copy the data from this lattice to the given lattice. More...
|
|
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 void | save (const String &fileName) const |
| Save the image in an AipsIO file with the given name. More...
|
|
virtual uInt | ndim () const |
| Return the number of axes in this Lattice. 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 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...
|
|
template<class T>
class casacore::SubLattice< T >
A subset of a Lattice or MaskedLattice.
Intended use:
Public interface
Review Status
- Date Reviewed:
- yyyy/mm/dd
Prerequisite
Synopsis
A SubLattice is a lattice referencing a subset of another lattice by means of a Slicer object.
It is useful when only a subset of a lattice needs to be accessed.
When the SubLattice is created from a const Lattice
object, it is not writable, thus it can only be used as an rvalue.
Using an AxesSpecifier object it is possible to remove some or all degenerate axes (i.e. axes with length 1) to get a lattice with a lower dimensionality.
Example
Template Type Argument Requirements (T)
-
Any type that can be used by the Tables System can also be used by this class.
Definition at line 35 of file ClarkCleanImageSkyModel.h.