|
| TempImage () |
| The default constructor creates an empty image. More...
|
|
| TempImage (const TiledShape &mapShape, const CoordinateSystem &coordinateInfo, Int maxMemoryInMB=-1) |
| Construct a temporary Image from shape and coordinate information. More...
|
|
| TempImage (const TiledShape &mapShape, const CoordinateSystem &coordinateInfo, Double maxMemoryInMB) |
|
| TempImage (const TempImage< T > &other) |
| Copy constructor (reference semantics). More...
|
|
| ~TempImage () |
| Destructor. More...
|
|
TempImage< T > & | operator= (const TempImage< T > &other) |
| Assignment operator (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 | isPaged () const |
| Is the TempImage 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 TempImage writable? More...
|
|
virtual void | setDefaultMask (const String &maskName) |
| Set the default pixelmask to the mask with the given name (which has to exist in the "masks" group). More...
|
|
void | removeMask () |
| Delete the pixel mask attached to the TempImage. More...
|
|
virtual void | useMask (MaskSpecifier=MaskSpecifier()) |
| Use the mask as specified. 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 void | attachMask (const Lattice< Bool > &mask) |
| Attach a mask to the TempImage. More...
|
|
virtual Bool | isMasked () const |
| It a mask attached to the image? More...
|
|
virtual Bool | hasPixelMask () const |
| Does the image object use a pixelmask? This is similar to isMasked() . More...
|
|
virtual const Lattice< Bool > & | pixelMask () const |
| Get access to the pixelmask used. More...
|
|
virtual Lattice< Bool > & | pixelMask () |
|
virtual Bool | doGetMaskSlice (Array< Bool > &buffer, const Slicer §ion) |
| Get a section of the mask. More...
|
|
virtual void | flush () |
| Flush the data. More...
|
|
virtual void | tempClose () |
| Close the TempImage temporarily (if it is paged to disk). More...
|
|
virtual void | reopen () |
| If needed, reopen a temporarily closed TempLattice. More...
|
|
virtual void | resize (const TiledShape &newShape) |
| Function which changes the shape of the image (N.B. More...
|
|
virtual String | name (Bool stripPath=False) const |
| Return the name of the current TempImage object. More...
|
|
virtual IPosition | shape () const |
| Return the shape of the image. More...
|
|
virtual void | set (const T &value) |
| Function which sets all of the elements in the Lattice to a 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) |
|
virtual T | getAt (const IPosition &where) const |
| Get or put a single pixel. More...
|
|
virtual void | putAt (const T &value, const IPosition &where) |
|
virtual LatticeIterInterface< T > * | makeIter (const LatticeNavigator &navigator, Bool useRef) const |
| This is the implementations of the letters for the envelope Iterator class
Note: Not for public use
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. 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...
|
|
virtual Bool | ok () const |
| Check for symmetry in data members. 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< 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) |
|
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 Vector< String > | regionNames (RegionHandler::GroupType=RegionHandler::Any) const |
| Get the names of all regions/masks. 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::TempImage< T >
Temporary astronomical images.
Intended use:
Public interface
Review Status
- Test programs:
- tTempImage
Prerequisite
Etymology
The TempImage name comes from its role as the Image class for temporary storage.
Synopsis
The class TempImage
is useful for storing temporary images for which it is not known whether they can be held in memory. It uses class TempLattice to hold the image in memory when it is small enough. Otherwise it is held in a temporary file. Similarly to TempLattice
one can give the maximum memory to use to control when the image can be held in memory.
The other Image information like coordinates, units, and miscinfo is held in member variables and disappears when the TempImage object is destructed.
It is possibly to temporarily close a TempImage, which only takes effect when it is created as a PagedArray. In this way it is possible to reduce the number of open files in case a lot of TempImage objects are used. A temporarily closed TempImage will be reopened automatically when needed. It can also be reopened explicitly.
Example
Motivation
The size of astronomical data can be very large. The ability to fit an entire image into random access memory cannot be guaranteed. Paging from disk pieces of the image appeared to be the way to deal with this problem.
Definition at line 97 of file TempImage.h.