|
| MIRIADImage (const String &name) |
| Construct a MIRIADImage from the disk MIRIAD dataset name and apply mask. More...
|
|
| MIRIADImage (const String &name, const MaskSpecifier &) |
| Construct a MIRIADImage from the disk MIRIAD file name and apply mask or not. More...
|
|
| MIRIADImage (const MIRIADImage &other) |
| Copy constructor (reference semantics) More...
|
|
| ~MIRIADImage () |
| Destructor does nothing. More...
|
|
MIRIADImage & | operator= (const MIRIADImage &other) |
| Assignment (reference semantics) More...
|
|
virtual ImageInterface< Float > * | cloneII () const |
| Make a copy of the object with new (reference semantics). More...
|
|
virtual String | imageType () const |
| Get the image type (returns MIRIADImage). More...
|
|
virtual void | resize (const TiledShape &newShape) |
| Function which changes the shape of the MIRIADImage. More...
|
|
virtual const RecordInterface & | miscInfo () const |
| Functions which get and set the units associated with the image pixels (i.e. More...
|
|
virtual Bool | setMiscInfo (const RecordInterface &newInfo) |
|
virtual Bool | isMasked () const |
| Has the object really a mask? The MIRIADImage always has a pixel mask and never has a region mask so this should always return True. More...
|
|
virtual Bool | hasPixelMask () const |
| MIRIADimage always has a pixel mask so should return True. More...
|
|
virtual const Lattice< Bool > & | pixelMask () const |
| Get access to the pixelmask. More...
|
|
virtual Lattice< Bool > & | pixelMask () |
|
virtual Bool | doGetMaskSlice (Array< Bool > &buffer, const Slicer §ion) |
| Do the actual get of the mask data. More...
|
|
virtual const LatticeRegion * | getRegionPtr () const |
| Get the region used. More...
|
|
virtual Bool | doGetSlice (Array< Float > &buffer, const Slicer &theSlice) |
| Do the actual get of the data. More...
|
|
virtual void | doPutSlice (const Array< Float > &sourceBuffer, const IPosition &where, const IPosition &stride) |
| The MIRIADImage is not writable, so this throws an exception. More...
|
|
virtual Bool | isPaged () const |
| The lattice is paged to disk. More...
|
|
virtual Bool | isPersistent () const |
| The lattice is persistent. More...
|
|
virtual Bool | isWritable () const |
| The MIRIADImage is not writable. More...
|
|
virtual String | name (Bool stripPath=False) const |
| Returns the name of the disk file. More...
|
|
virtual IPosition | shape () const |
| return the shape of the MIRIADImage More...
|
|
virtual uInt | advisedMaxPixels () const |
| Returns the maximum recommended number of pixels for a cursor. More...
|
|
virtual IPosition | doNiceCursorShape (uInt maxPixels) const |
| Help the user pick a cursor for most efficient access if they only want pixel values and don't care about the order or dimension of the cursor. More...
|
|
virtual void | tempClose () |
| Temporarily close the image. More...
|
|
virtual void | reopen () |
| Reopen a temporarily closed image. More...
|
|
virtual Bool | ok () const |
| Check class invariants. More...
|
|
DataType | dataType () const |
| Return the (internal) data type (TpFloat or TpShort). More...
|
|
virtual uInt | maximumCacheSize () const |
| Maximum size - not necessarily all used. More...
|
|
virtual void | setMaximumCacheSize (uInt howManyPixels) |
| Set the maximum (allowed) cache size as indicated. 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 | setCacheSizeInTiles (uInt howManyTiles) |
| Set the actual cache size for this Array to be be big enough for the indicated number of tiles. 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...
|
|
| 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< Float > * | cloneML () const |
| Make a copy of the derived object (reference semantics). More...
|
|
virtual ImageInterface< Float > * | cloneII () const=0 |
|
virtual String | imageType () const=0 |
| Get the image type (returns name of derived class). 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...
|
|
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) |
|
virtual ImageAttrHandler & | attrHandler (Bool createHandler=False) |
| Get access to the attribute handler. More...
|
|
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...
|
|
virtual Bool | ok () const=0 |
| Check class invariants. 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) |
|
Class providing native access to MIRIAD images.
Intended use:
Public interface
Review Status
- Test programs:
- tMIRIADImage
Prerequisite
Etymology
This class provides native access to MIRIAD images.
Synopsis
A MIRIADImage provides native access to MIRIAD images by accessing them with the TiledFileAccess class. – or – the native miriad I/O routines. The MIRIADImage is read only. – really – ??
Example
ImageStatistics<Float> stats(im,
logger);
Motivation
This provides native access to MIRIAD images.
Definition at line 99 of file MIRIADImage.h.