#include <ExtendImage.h>
Inheritance diagram for casa::ExtendImage< T >:
Part of API
Class ExtendImage can be used to (virtually) extend an image along axes with length 1 and/or to add new axes. In this way such an image can be made conformant with another image. E.g. it can be used to extend the continuum channel to subtract it from each channel in an image cube.
Used by LEL to handle images with different dimensionalities.
Definition at line 78 of file ExtendImage.h.
Public Member Functions | |
| ExtendImage () | |
| The default constructor. | |
| ExtendImage (const ImageInterface< T > &image, const IPosition &newShape, const CoordinateSystem &newCsys) | |
| Create a ExtendImage from a Image. | |
| ExtendImage (const ExtendImage< T > &other) | |
| Copy constructor (reference semantics). | |
| virtual | ~ExtendImage () |
| ExtendImage< T > & | operator= (const ExtendImage< T > &other) |
| Assignment (reference semantics). | |
| virtual String | imageType () const |
| Get the image type (returns name of derived class). | |
| virtual Bool | isMasked () const |
| Is the ExtendImage masked? It is if its parent image is masked. | |
| virtual Bool | hasPixelMask () const |
| Does the image object have a pixelmask? It does if its parent has a pixelmask. | |
| virtual const LatticeRegion * | getRegionPtr () const |
| Get the region used (always returns 0). | |
| virtual Bool | isPersistent () const |
| A ExtendImage is not persistent. | |
| virtual Bool | isPaged () const |
| Is the ExtendImage paged to disk? | |
| virtual Bool | isWritable () const |
| An ExtendImage is not writable. | |
| virtual IPosition | shape () const |
| Returns the shape of the ExtendImage. | |
| virtual uInt | advisedMaxPixels () const |
| This function returns the recommended maximum number of pixels to include in the cursor of an iterator. | |
| virtual void | resize (const TiledShape &newShape) |
| Function which changes the shape of the ExtendImage. | |
| virtual String | name (Bool stripPath=False) const |
| Return the name of the parent ImageInterface object. | |
| virtual Bool | ok () const |
| Check class invariants. | |
| virtual Bool | doGetSlice (Array< T > &buffer, const Slicer §ion) |
| Do the actual getting of an array of values. | |
| virtual void | doPutSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride) |
| Putting data is not possible. | |
| virtual Bool | doGetMaskSlice (Array< Bool > &buffer, const Slicer §ion) |
| Get a section of the mask. | |
| 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. | |
| virtual IPosition | doNiceCursorShape (uInt maxPixels) const |
| Get the best cursor shape. | |
| virtual ImageInterface< T > * | cloneII () const |
| Make a copy of the object (reference semantics). | |
| virtual const Lattice< Bool > & | pixelMask () const |
| Get access to the pixelmask in use (thus to the pixelmask of the parent). | |
| virtual Lattice< Bool > & | pixelMask () |
| virtual Bool | lock (FileLocker::LockType, uInt nattempts) |
| Handle the (un)locking and syncing, etc. | |
| virtual void | unlock () |
| virtual Bool | hasLock (FileLocker::LockType) const |
| virtual void | resync () |
| Resynchronize the Lattice object with the lattice file. | |
| virtual void | flush () |
| Flush the data (but do not unlock). | |
| virtual void | tempClose () |
| Temporarily close the lattice. | |
| virtual void | reopen () |
| Explicitly reopen the temporarily closed lattice. | |
Private Attributes | |
| ImageInterface< T > * | itsImagePtr |
| ExtendLattice< T > * | itsExtLatPtr |
| casa::ExtendImage< T >::ExtendImage | ( | ) |
The default constructor.
| casa::ExtendImage< T >::ExtendImage | ( | const ImageInterface< T > & | image, | |
| const IPosition & | newShape, | |||
| const CoordinateSystem & | newCsys | |||
| ) |
Create a ExtendImage from a Image.
The coordinate system of the given image should be a subset of the new coordinate system. The same is true for the shape.
| casa::ExtendImage< T >::ExtendImage | ( | const ExtendImage< T > & | other | ) |
Copy constructor (reference semantics).
| virtual casa::ExtendImage< T >::~ExtendImage | ( | ) | [virtual] |
| ExtendImage<T>& casa::ExtendImage< T >::operator= | ( | const ExtendImage< T > & | other | ) |
Assignment (reference semantics).
| virtual ImageInterface<T>* casa::ExtendImage< T >::cloneII | ( | ) | const [virtual] |
| virtual String casa::ExtendImage< T >::imageType | ( | ) | const [virtual] |
| virtual Bool casa::ExtendImage< T >::isMasked | ( | ) | const [virtual] |
Is the ExtendImage masked? It is if its parent image is masked.
Reimplemented from casa::MaskedLattice< T >.
| virtual Bool casa::ExtendImage< T >::hasPixelMask | ( | ) | const [virtual] |
Does the image object have a pixelmask? It does if its parent has a pixelmask.
Reimplemented from casa::MaskedLattice< T >.
| virtual const Lattice<Bool>& casa::ExtendImage< T >::pixelMask | ( | ) | const [virtual] |
Get access to the pixelmask in use (thus to the pixelmask of the parent).
An exception is thrown if the parent does not have a pixelmask.
Reimplemented from casa::MaskedLattice< T >.
| virtual Lattice<Bool>& casa::ExtendImage< T >::pixelMask | ( | ) | [virtual] |
Reimplemented from casa::MaskedLattice< T >.
| virtual const LatticeRegion* casa::ExtendImage< T >::getRegionPtr | ( | ) | const [virtual] |
| virtual Bool casa::ExtendImage< T >::isPersistent | ( | ) | const [virtual] |
| virtual Bool casa::ExtendImage< T >::isPaged | ( | ) | const [virtual] |
| virtual Bool casa::ExtendImage< T >::isWritable | ( | ) | const [virtual] |
| virtual IPosition casa::ExtendImage< T >::shape | ( | ) | const [virtual] |
| virtual uInt casa::ExtendImage< T >::advisedMaxPixels | ( | ) | const [virtual] |
This function returns the recommended maximum number of pixels to include in the cursor of an iterator.
Reimplemented from casa::Lattice< T >.
| virtual void casa::ExtendImage< T >::resize | ( | const TiledShape & | newShape | ) | [virtual] |
Function which changes the shape of the ExtendImage.
Throws an exception as resizing an ExtendImage is not possible.
Implements casa::ImageInterface< T >.
| virtual String casa::ExtendImage< T >::name | ( | Bool | stripPath = False |
) | const [virtual] |
| virtual Bool casa::ExtendImage< T >::ok | ( | ) | const [virtual] |
| virtual Bool casa::ExtendImage< T >::doGetSlice | ( | Array< T > & | buffer, | |
| const Slicer & | section | |||
| ) | [virtual] |
| virtual void casa::ExtendImage< T >::doPutSlice | ( | const Array< T > & | sourceBuffer, | |
| const IPosition & | where, | |||
| const IPosition & | stride | |||
| ) | [virtual] |
| virtual Bool casa::ExtendImage< T >::doGetMaskSlice | ( | Array< Bool > & | buffer, | |
| const Slicer & | section | |||
| ) | [virtual] |
| virtual LatticeIterInterface<T>* casa::ExtendImage< T >::makeIter | ( | const LatticeNavigator & | navigator, | |
| Bool | useRef | |||
| ) | const [virtual] |
This function is used by the LatticeIterator class to generate an iterator of the correct type for this Lattice.
Not recommended for general use.
Reimplemented from casa::Lattice< T >.
| virtual IPosition casa::ExtendImage< T >::doNiceCursorShape | ( | uInt | maxPixels | ) | const [virtual] |
| virtual Bool casa::ExtendImage< T >::lock | ( | FileLocker::LockType | , | |
| uInt | nattempts | |||
| ) | [virtual] |
| virtual void casa::ExtendImage< T >::unlock | ( | ) | [virtual] |
Reimplemented from casa::LatticeBase.
| virtual Bool casa::ExtendImage< T >::hasLock | ( | FileLocker::LockType | ) | const [virtual] |
Reimplemented from casa::LatticeBase.
| virtual void casa::ExtendImage< T >::resync | ( | ) | [virtual] |
Resynchronize the Lattice object with the lattice file.
This function is only useful if no read-locking is used, ie. if the table lock option is UserNoReadLocking or AutoNoReadLocking. In that cases the table system does not acquire a read-lock, thus does not synchronize itself automatically.
By default the function does not do anything at all.
Reimplemented from casa::LatticeBase.
| virtual void casa::ExtendImage< T >::flush | ( | ) | [virtual] |
Flush the data (but do not unlock).
By default the function does not do anything at all.
Reimplemented from casa::LatticeBase.
| virtual void casa::ExtendImage< T >::tempClose | ( | ) | [virtual] |
Temporarily close the lattice.
It will be reopened automatically on the next access.
By default the function does not do anything at all.
Reimplemented from casa::LatticeBase.
| virtual void casa::ExtendImage< T >::reopen | ( | ) | [virtual] |
Explicitly reopen the temporarily closed lattice.
By default the function does not do anything at all.
Reimplemented from casa::LatticeBase.
ImageInterface<T>* casa::ExtendImage< T >::itsImagePtr [private] |
Definition at line 185 of file ExtendImage.h.
ExtendLattice<T>* casa::ExtendImage< T >::itsExtLatPtr [private] |
Definition at line 186 of file ExtendImage.h.
1.5.1