|
| SubImage () |
| The default constructor. More...
|
|
| SubImage (const ImageInterface< T > &image, AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False) |
| Create a SubImage from a Image. More...
|
|
| SubImage (ImageInterface< T > &image, Bool writableIfPossible, AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False) |
|
| SubImage (const ImageInterface< T > &image, const LattRegionHolder ®ion, AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False) |
| Create a SubImage from the given Image and region. More...
|
|
| SubImage (ImageInterface< T > &image, const LattRegionHolder ®ion, Bool writableIfPossible, AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False) |
|
| SubImage (const ImageInterface< T > &image, const Slicer &slicer, AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False) |
| Create a SubImage from the given Image and slicer. More...
|
|
| SubImage (ImageInterface< T > &image, const Slicer &slicer, Bool writableIfPossible, AxesSpecifier=AxesSpecifier(), Bool preserveAxesOrder=False) |
|
| SubImage (const SubImage< T > &other) |
| Copy constructor (reference semantics). More...
|
|
virtual | ~SubImage () |
|
SubImage< T > & | operator= (const SubImage< T > &other) |
| Assignment (reference semantics). More...
|
|
virtual ImageInterface< T > * | cloneII () const |
| Make a copy of the object (reference semantics). More...
|
|
virtual String | imageType () const |
| Get the image type (returns name of derived class). More...
|
|
virtual Bool | isMasked () const |
| Is the SubImage masked? It is if its parent image or its region is masked. More...
|
|
virtual Bool | hasPixelMask () const |
| Does the image object have a pixelmask? It does if its parent has a pixelmask. More...
|
|
virtual const Lattice< Bool > & | pixelMask () const |
| Get access to the pixelmask in use (thus to the pixelmask of the parent). More...
|
|
virtual Lattice< Bool > & | pixelMask () |
|
virtual Bool | isPersistent () const |
| A SubImage is persistent if no region is applied to the parent image. More...
|
|
virtual Bool | isPaged () const |
| Is the SubImage 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 SubImage writable? More...
|
|
virtual const LatticeRegion * | getRegionPtr () const |
| Get the region/mask object describing this subImage. More...
|
|
virtual IPosition | shape () const |
| Returns the shape of the SubImage including all degenerate axes (i.e. More...
|
|
virtual uInt | ndim () const |
| Returns the number of axes in this SubImage. More...
|
|
virtual size_t | nelements () const |
| Returns the total number of elements in this SubImage. More...
|
|
virtual Bool | conform (const Lattice< T > &other) const |
| returns a value of "True" if this instance of Lattice and 'other' have the same shape, otherwise returns a value of "False". More...
|
|
virtual uInt | advisedMaxPixels () const |
| This function returns the recommended maximum number of pixels to include in the cursor of an iterator. More...
|
|
virtual ImageAttrHandler & | attrHandler (Bool createHandler=False) |
| Get access to the attribute handler (of the parent image). 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) |
|
virtual void | resize (const TiledShape &newShape) |
| Function which changes the shape of the SubImage. More...
|
|
virtual String | name (Bool stripPath=False) const |
| Return the name of the parent ImageInterface object. More...
|
|
virtual Bool | ok () const |
| Check class invariants. 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 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 IPosition | doNiceCursorShape (uInt maxPixels) const |
| Get the best cursor shape. More...
|
|
virtual Bool | lock (FileLocker::LockType, uInt nattempts) |
| Handle the (un)locking and syncing, etc. More...
|
|
virtual void | unlock () |
|
virtual Bool | hasLock (FileLocker::LockType) const |
|
virtual void | resync () |
|
virtual void | flush () |
|
virtual void | tempClose () |
|
virtual void | reopen () |
|
| ImageInterface () |
|
| ImageInterface (const RegionHandler ®ionHandler) |
| Construct for a specific region handler object. More...
|
|
| ImageInterface (const ImageInterface &other) |
| Copy constructor (copy semantics). More...
|
|
virtual | ~ImageInterface () |
|
virtual MaskedLattice< T > * | cloneML () const |
| Make a copy of the derived object (reference semantics). More...
|
|
virtual Bool | setUnits (const Unit &newUnits) |
| Function which get and set the units associated with the image pixels (i.e. More...
|
|
virtual const Unit & | units () const |
|
virtual Bool | setCoordinateInfo (const CoordinateSystem &coords) |
| Functions to set or replace the coordinate information in the Image Returns False on failure, e.g. More...
|
|
const CoordinateSystem & | coordinates () const |
|
virtual LELCoordinates | lelCoordinates () const |
| Function to get a LELCoordinate object containing the coordinates. More...
|
|
LoggerHolder & | logger () |
| Get access to the LoggerHolder. More...
|
|
const LoggerHolder & | logger () const |
|
LogIO & | logSink () |
| Allow messages to be logged to this ImageInterface. More...
|
|
const LogIO & | logSink () const |
|
void | appendLog (const LoggerHolder &other) |
| Add the messages from the other image logger to this one. More...
|
|
const TableRecord & | miscInfo () const |
| Often we have miscellaneous information we want to attach to an image. More...
|
|
virtual Bool | setMiscInfo (const RecordInterface &newInfo) |
|
const ImageInfo & | imageInfo () const |
| The ImageInfo object contains some miscellaneous information about the image which unlike that stored in MiscInfo, has a standard list of things, such as the restoring beam. More...
|
|
ImageInfo & | rwImageInfo () |
| Get non-const access to the ImageInfo. More...
|
|
virtual Bool | setImageInfo (const ImageInfo &info) |
|
ImageAttrHandler & | roAttrHandler () const |
|
Bool | canDefineRegion () const |
| Can the image handle region definition? More...
|
|
virtual ImageRegion | makeMask (const String &name, Bool defineAsRegion=True, Bool setAsDefaultMask=True, Bool initialize=False, Bool value=True) |
| Make a mask which is suitable for the type of image. More...
|
|
virtual void | defineRegion (const String &name, const ImageRegion ®ion, RegionHandler::GroupType, Bool overwrite=False) |
| Define a region/mask belonging to the image. More...
|
|
virtual Bool | hasRegion (const String ®ionName, RegionHandler::GroupType=RegionHandler::Any) const |
| Does the image have a region with the given name? More...
|
|
virtual ImageRegion * | getImageRegionPtr (const String &name, RegionHandler::GroupType=RegionHandler::Any, Bool throwIfUnknown=True) const |
| Get a region/mask belonging to the image from the given group (which can be Any). More...
|
|
virtual void | renameRegion (const String &newName, const String &oldName, RegionHandler::GroupType=RegionHandler::Any, Bool overwrite=False) |
| Rename a region. More...
|
|
virtual void | removeRegion (const String &name, RegionHandler::GroupType=RegionHandler::Any, Bool throwIfUnknown=True) |
| Remove a region/mask belonging to the image from the given group (which can be Any). More...
|
|
virtual Vector< String > | regionNames (RegionHandler::GroupType=RegionHandler::Any) const |
| Get the names of all regions/masks. More...
|
|
virtual void | useMask (MaskSpecifier=MaskSpecifier()) |
| Use the mask as specified. More...
|
|
virtual void | setDefaultMask (const String ®ionName) |
| Set the default pixelmask to the mask with the given name (which has to exist in the "masks" group). More...
|
|
virtual String | getDefaultMask () const |
| Get the name of the default pixelmask. More...
|
|
ImageRegion | getRegion (const String ®ionName, RegionHandler::GroupType=RegionHandler::Any) const |
| Get a region belonging to the image. More...
|
|
String | makeUniqueRegionName (const String &rootName, uInt startNumber=1) const |
| Make a unique region name from the given root name, thus make it such that the name is not already in use for a region or mask. More...
|
|
Bool | toRecord (String &error, RecordInterface &outRec) |
| Save and restore an ImageInterface object to or from a state Record. More...
|
|
Bool | fromRecord (String &error, const RecordInterface &inRec) |
|
template<class T>
class casacore::SubImage< T >
A (masked) subset of an ImageInterface object.
Intended use:
Public interface
Review Status
- Test programs:
- tSubImage
Prerequisite
Synopsis
Class SubImage has to be used to apply a region or mask to an image. Several functions are inherited from SubLattice and not declared in this class.
Using an AxesSpecifier object it is possible to remove some or all degenerate axes (i.e. axes with length 1) to get an image with a lower dimensionality.
Example
Motivation
Definition at line 86 of file SubImage.h.