Temporary astronomical images. More...
#include <TempImage.h>
Public Member Functions | |
| TempImage () | |
| The default constructor creates an empty image. | |
| TempImage (const TiledShape &mapShape, const CoordinateSystem &coordinateInfo, Int maxMemoryInMB=-1) | |
| Construct a temporary Image from shape and coordinate information. | |
| TempImage (const TiledShape &mapShape, const CoordinateSystem &coordinateInfo, Double maxMemoryInMB) | |
| TempImage (const TempImage< T > &other) | |
| Copy constructor (reference semantics). | |
| ~TempImage () | |
| Destructor. | |
| TempImage< T > & | operator= (const TempImage< T > &other) |
| Assignment operator (reference semantics). | |
| virtual ImageInterface< T > * | cloneII () const |
| Make a copy of the object (reference semantics). | |
| virtual String | imageType () const |
| Get the image type (returns name of derived class). | |
| virtual Bool | isPaged () const |
| Is the TempImage paged to disk? | |
| virtual Bool | canReferenceArray () const |
| Can the lattice data be referenced as an array section? | |
| virtual Bool | isWritable () const |
| Is the TempImage writable? | |
| 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). | |
| void | removeMask () |
| Delete the pixel mask attached to the TempImage. | |
| virtual void | useMask (MaskSpecifier=MaskSpecifier()) |
| Use the mask as specified. | |
| 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). | |
| virtual void | attachMask (const Lattice< Bool > &mask) |
| Attach a mask to the TempImage. | |
| virtual Bool | isMasked () const |
| It a mask attached to the image? | |
| virtual Bool | hasPixelMask () const |
Does the image object use a pixelmask? This is similar to isMasked(). | |
| virtual const Lattice< Bool > & | pixelMask () const |
| Get access to the pixelmask used. | |
| virtual Lattice< Bool > & | pixelMask () |
| virtual Bool | doGetMaskSlice (Array< Bool > &buffer, const Slicer §ion) |
| Get a section of the mask. | |
| virtual void | flush () |
| Flush the data. | |
| virtual void | tempClose () |
| Close the TempImage temporarily (if it is paged to disk). | |
| virtual void | reopen () |
| If needed, reopen a temporarily closed TempLattice. | |
| virtual void | resize (const TiledShape &newShape) |
| Function which changes the shape of the image (N.B. | |
| virtual String | name (Bool stripPath=False) const |
| Return the name of the current TempImage object. | |
| virtual IPosition | shape () const |
| Return the shape of the image. | |
| virtual void | set (const T &value) |
| Function which sets all of the elements in the Lattice to a value. | |
| virtual void | apply (T(*function)(T)) |
| Replace every element, x, of the lattice with the result of f(x). | |
| 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. | |
| virtual void | putAt (const T &value, const IPosition &where) |
| Put the value of a single element. | |
| 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 . | |
| virtual uInt | advisedMaxPixels () const |
| Returns the maximum recommended number of pixels for a cursor. | |
| virtual IPosition | doNiceCursorShape (uInt maxPixels) const |
| Help the user pick a cursor for most efficient access. | |
| virtual uInt | maximumCacheSize () const |
| Maximum size - not necessarily all used. | |
| virtual void | setMaximumCacheSize (uInt howManyPixels) |
| Set the maximum (allowed) cache size as indicated. | |
| 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. | |
| virtual void | setCacheSizeInTiles (uInt howManyTiles) |
| Set the actual cache size for this Array to be be big enough for the indicated number of tiles. | |
| virtual void | clearCache () |
| Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSize was called. | |
| virtual void | showCacheStatistics (ostream &os) const |
| Report on cache success. | |
| virtual Bool | ok () const |
| Check for symmetry in data members. | |
Protected Member Functions | |
| virtual const LatticeRegion * | getRegionPtr () const |
| Get the region used (it always returns 0). | |
| virtual Bool | doGetSlice (Array< T > &buffer, const Slicer &theSlice) |
| Function which extracts an array from the map. | |
| virtual void | doPutSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride) |
| Function to replace the values in the map with soureBuffer. | |
Private Member Functions | |
| void | applyMaskSpecifier (const MaskSpecifier &) |
| void | applyMask (const String &maskName) |
Private Attributes | |
| TempLattice< T > * | mapPtr_p |
| Lattice< Bool > * | maskPtr_p |
Temporary astronomical images.
Public interface
The TempImage name comes from its role as the Image class for temporary storage.
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.
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.
| casacore::TempImage< T >::TempImage | ( | ) |
The default constructor creates an empty image.
| casacore::TempImage< T >::TempImage | ( | const TiledShape & | mapShape, | |
| const CoordinateSystem & | coordinateInfo, | |||
| Int | maxMemoryInMB = -1 | |||
| ) |
Construct a temporary Image from shape and coordinate information.
If the image is sufficiently small, it is kept in memory. Otherwise it is kept in a temporary disk table. It can be forced to disk by setting maxMemoryinMB=0. The algorithm is the same as in class TempLattice .
| casacore::TempImage< T >::TempImage | ( | const TiledShape & | mapShape, | |
| const CoordinateSystem & | coordinateInfo, | |||
| Double | maxMemoryInMB | |||
| ) |
| casacore::TempImage< T >::TempImage | ( | const TempImage< T > & | other | ) |
Copy constructor (reference semantics).
| casacore::TempImage< T >::~TempImage | ( | ) |
Destructor.
| virtual uInt casacore::TempImage< T >::advisedMaxPixels | ( | ) | const [virtual] |
Returns the maximum recommended number of pixels for a cursor.
This is the number of pixels in a tile.
Reimplemented from casacore::Lattice< T >.
| virtual void casacore::TempImage< T >::apply | ( | const Functional< T, T > & | function | ) | [virtual] |
Reimplemented from casacore::Lattice< T >.
| virtual void casacore::TempImage< T >::apply | ( | T(*)(const T &) | function | ) | [virtual] |
Reimplemented from casacore::Lattice< T >.
| virtual void casacore::TempImage< T >::apply | ( | T(*)(T) | function | ) | [virtual] |
Replace every element, x, of the lattice with the result of f(x).
You must pass in the address of the function -- so the function must be declared and defined in the scope of your program. Both versions of apply require a function that accepts a single argument of type T (the Lattice template actual type) and returns a result of the same type. The first apply expects a function with an argument passed by value; the second expects the argument to be passed by const reference. The first form ought to run faster for the built-in types, which may be an issue for large images stored in memory, where disk access is not an issue.
Reimplemented from casacore::Lattice< T >.
| void casacore::TempImage< T >::applyMask | ( | const String & | maskName | ) | [private] |
| void casacore::TempImage< T >::applyMaskSpecifier | ( | const MaskSpecifier & | ) | [private] |
| virtual void casacore::TempImage< T >::attachMask | ( | const Lattice< Bool > & | mask | ) | [virtual] |
Attach a mask to the TempImage.
It replaces a probably already attached mask. It has to have the same shape as the image.
| virtual Bool casacore::TempImage< T >::canReferenceArray | ( | ) | const [virtual] |
Can the lattice data be referenced as an array section?
Reimplemented from casacore::LatticeBase.
| virtual void casacore::TempImage< T >::clearCache | ( | ) | [virtual] |
Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSize was called.
Reimplemented from casacore::LatticeBase.
| virtual ImageInterface<T>* casacore::TempImage< T >::cloneII | ( | ) | const [virtual] |
Make a copy of the object (reference semantics).
Implements casacore::ImageInterface< T >.
| virtual Bool casacore::TempImage< T >::doGetMaskSlice | ( | Array< Bool > & | buffer, | |
| const Slicer & | section | |||
| ) | [virtual] |
Get a section of the mask.
It throws an exception if there is no mask.
Reimplemented from casacore::MaskedLattice< T >.
| virtual Bool casacore::TempImage< T >::doGetSlice | ( | Array< T > & | buffer, | |
| const Slicer & | theSlice | |||
| ) | [protected, virtual] |
Function which extracts an array from the map.
Implements casacore::Lattice< T >.
| virtual IPosition casacore::TempImage< T >::doNiceCursorShape | ( | uInt | maxPixels | ) | const [virtual] |
Help the user pick a cursor for most efficient access.
Reimplemented from casacore::LatticeBase.
| virtual void casacore::TempImage< T >::doPutSlice | ( | const Array< T > & | sourceBuffer, | |
| const IPosition & | where, | |||
| const IPosition & | stride | |||
| ) | [protected, virtual] |
Function to replace the values in the map with soureBuffer.
Implements casacore::Lattice< T >.
| virtual void casacore::TempImage< T >::flush | ( | ) | [virtual] |
Flush the data.
Reimplemented from casacore::LatticeBase.
| virtual T casacore::TempImage< T >::getAt | ( | const IPosition & | where | ) | const [virtual] |
Get or put a single pixel.
Note that the function operator () can also be used to get a pixel.
Reimplemented from casacore::Lattice< T >.
| virtual const LatticeRegion* casacore::TempImage< T >::getRegionPtr | ( | ) | const [protected, virtual] |
Get the region used (it always returns 0).
Implements casacore::MaskedLattice< T >.
| virtual Bool casacore::TempImage< T >::hasPixelMask | ( | ) | const [virtual] |
Does the image object use a pixelmask? This is similar to isMasked().
Reimplemented from casacore::MaskedLattice< T >.
| virtual String casacore::TempImage< T >::imageType | ( | ) | const [virtual] |
Get the image type (returns name of derived class).
Implements casacore::ImageInterface< T >.
| virtual Bool casacore::TempImage< T >::isMasked | ( | ) | const [virtual] |
It a mask attached to the image?
Reimplemented from casacore::MaskedLattice< T >.
| virtual Bool casacore::TempImage< T >::isPaged | ( | ) | const [virtual] |
Is the TempImage paged to disk?
Reimplemented from casacore::LatticeBase.
| virtual Bool casacore::TempImage< T >::isWritable | ( | ) | const [virtual] |
Is the TempImage writable?
Reimplemented from casacore::LatticeBase.
| virtual LatticeIterInterface<T>* casacore::TempImage< T >::makeIter | ( | const LatticeNavigator & | navigator, | |
| Bool | useRef | |||
| ) | const [virtual] |
This is the implementations of the letters for the envelope Iterator class
Note: Not for public use
.
Reimplemented from casacore::Lattice< T >.
| virtual uInt casacore::TempImage< T >::maximumCacheSize | ( | ) | const [virtual] |
| virtual String casacore::TempImage< T >::name | ( | Bool | stripPath = False |
) | const [virtual] |
Return the name of the current TempImage object.
It is always "Temporary_Image"
Implements casacore::ImageInterface< T >.
| virtual Bool casacore::TempImage< T >::ok | ( | ) | const [virtual] |
Check for symmetry in data members.
Implements casacore::ImageInterface< T >.
| TempImage<T>& casacore::TempImage< T >::operator= | ( | const TempImage< T > & | other | ) |
Assignment operator (reference semantics).
Reimplemented from casacore::ImageInterface< T >.
| virtual Lattice<Bool>& casacore::TempImage< T >::pixelMask | ( | ) | [virtual] |
Reimplemented from casacore::MaskedLattice< T >.
| virtual const Lattice<Bool>& casacore::TempImage< T >::pixelMask | ( | ) | const [virtual] |
Get access to the pixelmask used.
An exception is thrown if the image does not use a pixelmask.
Reimplemented from casacore::MaskedLattice< T >.
| virtual void casacore::TempImage< T >::putAt | ( | const T & | value, | |
| const IPosition & | where | |||
| ) | [virtual] |
Put the value of a single element.
The default implementation uses putSlice.
Reimplemented from casacore::Lattice< T >.
| void casacore::TempImage< T >::removeMask | ( | ) | [inline] |
Delete the pixel mask attached to the TempImage.
Does nothing if there isn't one
Definition at line 151 of file TempImage.h.
References casacore::TempImage< T >::setDefaultMask().
| virtual void casacore::TempImage< T >::removeRegion | ( | const String & | name, | |
| RegionHandler::GroupType | = RegionHandler::Any, |
|||
| Bool | throwIfUnknown = True | |||
| ) | [virtual] |
Remove a region/mask belonging to the image from the given group (which can be Any).
If a mask removed is the default mask, the image gets unmasked.
Optionally an exception is thrown if the region does not exist.
Reimplemented from casacore::ImageInterface< T >.
| virtual void casacore::TempImage< T >::reopen | ( | ) | [virtual] |
If needed, reopen a temporarily closed TempLattice.
Reimplemented from casacore::LatticeBase.
| virtual void casacore::TempImage< T >::resize | ( | const TiledShape & | newShape | ) | [virtual] |
Function which changes the shape of the image (N.B.
the data is thrown away - the Image will be filled with nonsense afterwards)
Implements casacore::ImageInterface< T >.
| virtual void casacore::TempImage< T >::set | ( | const T & | value | ) | [virtual] |
Function which sets all of the elements in the Lattice to a value.
Reimplemented from casacore::Lattice< T >.
| virtual void casacore::TempImage< T >::setCacheSizeFromPath | ( | const IPosition & | sliceShape, | |
| const IPosition & | windowStart, | |||
| const IPosition & | windowLength, | |||
| const IPosition & | axisPath | |||
| ) | [virtual] |
Set the cache size as to "fit" the indicated path.
Reimplemented from casacore::LatticeBase.
| virtual void casacore::TempImage< T >::setCacheSizeInTiles | ( | uInt | howManyTiles | ) | [virtual] |
Set the actual cache size for this Array to be be big enough for the indicated number of tiles.
This cache is not shared with PagedArrays in other rows and is always clipped to be less than the maximum value set using the setMaximumCacheSize member function. tiles. Tiles are cached using a first in first out algorithm.
Reimplemented from casacore::LatticeBase.
| virtual void casacore::TempImage< T >::setDefaultMask | ( | const String & | maskName | ) | [virtual] |
Set the default pixelmask to the mask with the given name (which has to exist in the "masks" group).
If the image table is writable, the setting is persistent by writing the name as a keyword. If the given regionName is the empty string, the default pixelmask is unset.
Reimplemented from casacore::ImageInterface< T >.
Referenced by casacore::TempImage< T >::removeMask().
| virtual void casacore::TempImage< T >::setMaximumCacheSize | ( | uInt | howManyPixels | ) | [virtual] |
Set the maximum (allowed) cache size as indicated.
Reimplemented from casacore::LatticeBase.
| virtual IPosition casacore::TempImage< T >::shape | ( | ) | const [virtual] |
Return the shape of the image.
Implements casacore::LatticeBase.
| virtual void casacore::TempImage< T >::showCacheStatistics | ( | ostream & | os | ) | const [virtual] |
Report on cache success.
Reimplemented from casacore::LatticeBase.
| virtual void casacore::TempImage< T >::tempClose | ( | ) | [virtual] |
Close the TempImage temporarily (if it is paged to disk).
Note that a possible mask is not closed. It'll be reopened automatically when needed or when reopen is called explicitly.
Reimplemented from casacore::LatticeBase.
| virtual void casacore::TempImage< T >::useMask | ( | MaskSpecifier | = MaskSpecifier() |
) | [virtual] |
Use the mask as specified.
If a mask was already in use, it is replaced by the new one.
Reimplemented from casacore::ImageInterface< T >.
TempLattice<T>* casacore::TempImage< T >::mapPtr_p [private] |
Definition at line 297 of file TempImage.h.
Lattice<Bool>* casacore::TempImage< T >::maskPtr_p [private] |
Definition at line 298 of file TempImage.h.
1.6.1
