casacore
|
Class providing native access to FITS Quality Images. More...
#include <FITSQualityImage.h>
Public Member Functions | |
FITSQualityImage (const String &name) | |
Construct a FITSQualityImage from the FITS file name and extensions specified in the input. More... | |
FITSQualityImage (const String &name, uInt whichDataHDU, uInt whichErrorHDU) | |
Construct a FITSQualityImage from the disk FITS file name and extensions. More... | |
FITSQualityImage (const FITSQualityImage &other) | |
Copy constructor (reference semantics) More... | |
~FITSQualityImage () | |
Destructor. More... | |
FITSQualityImage & | operator= (const FITSQualityImage &other) |
Assignment (reference semantics). More... | |
virtual ImageInterface< Float > * | cloneII () const |
Make a copy of the object with new (reference semantics). More... | |
FITSImage * | fitsData () const |
Get the FITS data. More... | |
FITSErrorImage * | fitsError () const |
Get the FITS error. More... | |
virtual String | imageType () const |
Get the image type (returns FITSImage). More... | |
virtual void | resize (const TiledShape &newShape) |
Function which changes the shape of the FITSQualityImage. More... | |
virtual Bool | isMasked () const |
Has the object really a mask? The FITSQualityImage always has a pixel mask and never has a region mask so this always returns True. More... | |
virtual Bool | hasPixelMask () const |
FITSQualityImage always has a pixel mask so returns True. More... | |
virtual const Lattice< Bool > & | pixelMask () const |
Get access to the pixelmask. More... | |
virtual Lattice< Bool > & | pixelMask () |
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 FITSQualityImage is not writable, so this throws an exception. More... | |
virtual Bool | doGetMaskSlice (Array< Bool > &buffer, const Slicer §ion) |
Do the actual get of the mask data. 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 FITSImage 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 FITSImage. 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 Bool | ok () const |
Check class invariants. More... | |
virtual void | tempClose () |
Temporarily close the image. More... | |
virtual void | tempCloseData () |
virtual void | tempCloseError () |
virtual void | reopen () |
Reopen a temporarily closed image. More... | |
DataType | dataType () const |
Return the (internal) data type (TpFloat or TpShort). More... | |
uInt | whichDataHDU () const |
Return the data HDU number. More... | |
uInt | whichErrorHDU () const |
Return the error HDU number. 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 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... | |
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... | |
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) |
![]() | |
MaskedLattice () | |
Default constructor. More... | |
MaskedLattice (const MaskedLattice< T > &) | |
Copy constructor. More... | |
virtual | ~MaskedLattice () |
a virtual destructor is needed so that it will use the actual destructor in the derived class More... | |
virtual Lattice< T > * | clone () const |
Make a copy of the derived object (reference semantics). More... | |
const LatticeRegion & | region () const |
Get the region used. More... | |
Bool | getMask (COWPtr< Array< Bool > > &buffer, Bool removeDegenerateAxes=False) const |
Get the mask or a slice from the mask. More... | |
Bool | getMaskSlice (COWPtr< Array< Bool > > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) const |
Bool | getMaskSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
Bool | getMaskSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
Bool | getMask (Array< Bool > &buffer, Bool removeDegenerateAxes=False) |
Bool | getMaskSlice (Array< Bool > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) |
Bool | getMaskSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) |
Bool | getMaskSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) |
Array< Bool > | getMask (Bool removeDegenerateAxes=False) const |
Array< Bool > | getMaskSlice (const Slicer §ion, Bool removeDegenerateAxes=False) const |
Array< Bool > | getMaskSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
Array< Bool > | getMaskSlice (const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
![]() | |
virtual | ~Lattice () |
a virtual destructor is needed so that it will use the actual destructor in the derived class More... | |
T | operator() (const IPosition &where) const |
Return the value of the single element located at the argument IPosition. More... | |
virtual T | getAt (const IPosition &where) const |
virtual void | putAt (const T &value, const IPosition &where) |
Put the value of a single element. More... | |
Bool | get (COWPtr< Array< T > > &buffer, Bool removeDegenerateAxes=False) const |
Functions which extract an Array of values from a Lattice. More... | |
Bool | getSlice (COWPtr< Array< T > > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) const |
Bool | getSlice (COWPtr< Array< T > > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
Bool | getSlice (COWPtr< Array< T > > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
Bool | get (Array< T > &buffer, Bool removeDegenerateAxes=False) |
Bool | getSlice (Array< T > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) |
Bool | getSlice (Array< T > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) |
Bool | getSlice (Array< T > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) |
Array< T > | get (Bool removeDegenerateAxes=False) const |
Array< T > | getSlice (const Slicer §ion, Bool removeDegenerateAxes=False) const |
Array< T > | getSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
Array< T > | getSlice (const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
void | putSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride) |
A function which places an Array of values within this instance of the Lattice at the location specified by the IPosition "where", incrementing by "stride". More... | |
void | putSlice (const Array< T > &sourceBuffer, const IPosition &where) |
void | put (const Array< T > &sourceBuffer) |
virtual void | set (const T &value) |
Set all elements in the Lattice to the given 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) |
void | operator+= (const Lattice< T > &other) |
Add, subtract, multiple, or divide by another Lattice. More... | |
void | operator-= (const Lattice< T > &other) |
void | operator*= (const Lattice< T > &other) |
void | operator/= (const Lattice< T > &other) |
virtual void | copyData (const Lattice< T > &from) |
Copy the data from the given lattice to this one. More... | |
virtual void | copyDataTo (Lattice< T > &to) const |
Copy the data from this lattice to the given lattice. More... | |
virtual LatticeIterInterface< T > * | makeIter (const LatticeNavigator &navigator, Bool useRef) const |
These functions are used by the LatticeIterator class to generate an iterator of the correct type for a specified Lattice. More... | |
virtual Bool | doGetSlice (Array< T > &buffer, const Slicer §ion)=0 |
The functions (in the derived classes) doing the actual work. More... | |
virtual void | doPutSlice (const Array< T > &buffer, const IPosition &where, const IPosition &stride)=0 |
![]() | |
virtual | ~LatticeBase () |
A virtual destructor is needed so that it will use the actual destructor in the derived class. More... | |
virtual Bool | canReferenceArray () const |
Can the lattice data be referenced as an array section? That is the case for an ArrayLattice or a Temp/SubLattice using it. More... | |
virtual void | save (const String &fileName) const |
Save the image in an AipsIO file with the given name. More... | |
virtual Bool | lock (FileLocker::LockType, uInt nattempts) |
It is strongly recommended to use class LatticeLocker to handle lattice locking. More... | |
virtual void | unlock () |
virtual Bool | hasLock (FileLocker::LockType) const |
virtual void | resync () |
Resynchronize the Lattice object with the lattice file. More... | |
virtual void | flush () |
Flush the data (but do not unlock). More... | |
virtual uInt | ndim () const |
Return the number of axes in this Lattice. More... | |
virtual size_t | nelements () const |
Return the total number of elements in this Lattice. More... | |
size_t | size () const |
Bool | conform (const LatticeBase &other) const |
Return a value of "True" if this instance of Lattice and 'other' have the same shape, otherwise returns a value of "False". More... | |
IPosition | niceCursorShape (uInt maxPixels) const |
Returns a recommended cursor shape for iterating through all the pixels in the Lattice. More... | |
IPosition | niceCursorShape () const |
Static Public Member Functions | |
static Bool | qualFITSInfo (String &error, TableRecord &dataExtMiscInfo, TableRecord &errorExtMiscInfo, const TableRecord &miscInfo) |
Given the misc-info of a CASA image (with quality-axis) the misc-info of the data sub-image and the error sub-image are produced. More... | |
Private Member Functions | |
void | reopenIfNeeded () const |
Reopen the image if needed. More... | |
void | reopenDataIfNeeded () |
void | reopenErrorIfNeeded () |
void | getExtInfo () |
Get the extension indices from an extension expression. More... | |
void | setup () |
Setup the object (used by constructors). More... | |
Bool | checkInput () |
Make sure the input is compatible. More... | |
Additional Inherited Members | |
![]() | |
ImageInterface & | operator= (const ImageInterface &other) |
Assignment (copy semantics) is only useful for derived classes. More... | |
Bool | restoreImageInfo (const RecordInterface &rec) |
Restore the image info from the record. More... | |
void | setLogMember (const LoggerHolder &logger) |
Set the image logger variable. More... | |
void | setImageInfoMember (const ImageInfo &imageInfo) |
Set the image info variable. More... | |
void | setCoordsMember (const CoordinateSystem &coords) |
Set the coordinate system variable. More... | |
void | setUnitMember (const Unit &unit) |
Set the unit variable. More... | |
void | setMiscInfoMember (const RecordInterface &rec) |
Set the miscinfo variable. More... | |
RegionHandler * | getRegionHandler () |
Get access to the region handler. More... | |
ImageInfo & | rwImageInfo () |
Get non-const access to the ImageInfo. More... | |
![]() | |
MaskedLattice< T > & | operator= (const MaskedLattice< T > &) |
Assignment can only be used by derived classes. More... | |
![]() | |
Lattice () | |
Define default constructor to satisfy compiler. More... | |
virtual void | handleMath (const Lattice< T > &from, int oper) |
Handle the Math operators (+=, -=, *=, /=). More... | |
virtual void | handleMathTo (Lattice< T > &to, int oper) const |
Lattice (const Lattice< T > &) | |
Copy constructor and assignment can only be used by derived classes. More... | |
Lattice< T > & | operator= (const Lattice< T > &) |
template<> | |
void | handleMathTo (Lattice< Bool > &, int) const |
![]() | |
LatticeBase () | |
Define default constructor to be used by derived classes. More... | |
LatticeBase (const LatticeBase &) | |
Copy constructor and assignment can only be used by derived classes. More... | |
LatticeBase & | operator= (const LatticeBase &) |
void | throwBoolMath () const |
Throw an exception for arithmetic on a Bool Lattice. More... | |
Class providing native access to FITS Quality Images.
Public interface
The class provides access to a quality image via two extensions in the corresponding FITS file.
A FITSQualityImage provides native access to FITS images by accessing the data and the error values via the classes FITSImage and FITSErrorImage, respectively. A QualityCoordinate connects these two layers. The FITSQualityImage is read only.
This provides access to FITS Quality Images
Definition at line 90 of file FITSQualityImage.h.
|
explicit |
Construct a FITSQualityImage from the FITS file name and extensions specified in the input.
|
explicit |
Construct a FITSQualityImage from the disk FITS file name and extensions.
casacore::FITSQualityImage::FITSQualityImage | ( | const FITSQualityImage & | other | ) |
Copy constructor (reference semantics)
casacore::FITSQualityImage::~FITSQualityImage | ( | ) |
Destructor.
|
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 >.
Referenced by fitsError().
|
private |
Make sure the input is compatible.
|
virtual |
Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSize was called.
Reimplemented from casacore::LatticeBase.
Referenced by whichErrorHDU().
|
virtual |
Make a copy of the object with new (reference semantics).
Implements casacore::ImageInterface< Float >.
|
virtual |
Return the (internal) data type (TpFloat or TpShort).
Reimplemented from casacore::Lattice< T >.
Referenced by fitsError().
|
virtual |
Do the actual get of the mask data.
The return value is always False, thus the buffer does not reference another array.
Reimplemented from casacore::MaskedLattice< T >.
Referenced by fitsError().
|
virtual |
Do the actual get of the data.
Returns False as the data do not reference another Array
Referenced by fitsError().
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.
Reimplemented from casacore::LatticeBase.
Referenced by fitsError().
|
virtual |
The FITSQualityImage is not writable, so this throws an exception.
Referenced by fitsError().
|
inline |
|
inline |
Get the FITS error.
Definition at line 125 of file FITSQualityImage.h.
References advisedMaxPixels(), dataType(), doGetMaskSlice(), doGetSlice(), doNiceCursorShape(), doPutSlice(), casacore::False, fitserror_p, getRegionPtr(), hasPixelMask(), imageType(), isMasked(), isPaged(), isPersistent(), isWritable(), name(), ok(), pixelMask(), reopen(), resize(), shape(), tempClose(), tempCloseData(), and tempCloseError().
|
private |
Get the extension indices from an extension expression.
|
virtual |
Get the region used.
There is no region. Always returns 0.
Implements casacore::MaskedLattice< T >.
Referenced by fitsError().
|
virtual |
FITSQualityImage always has a pixel mask so returns True.
Reimplemented from casacore::MaskedLattice< T >.
Referenced by fitsError().
|
virtual |
Get the image type (returns FITSImage).
Implements casacore::ImageInterface< Float >.
Referenced by fitsError().
|
virtual |
Has the object really a mask? The FITSQualityImage always has a pixel mask and never has a region mask so this always returns True.
Reimplemented from casacore::MaskedLattice< T >.
Referenced by fitsError().
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Maximum size - not necessarily all used.
In pixels.
Reimplemented from casacore::LatticeBase.
Referenced by whichErrorHDU().
Returns the name of the disk file.
Implements casacore::ImageInterface< Float >.
Referenced by fitsError().
|
virtual |
FITSQualityImage& casacore::FITSQualityImage::operator= | ( | const FITSQualityImage & | other | ) |
Assignment (reference semantics).
Get access to the pixelmask.
FITSQualityImage always has a pixel mask.
Reimplemented from casacore::MaskedLattice< T >.
Referenced by fitsError().
Reimplemented from casacore::MaskedLattice< T >.
|
static |
Given the misc-info of a CASA image (with quality-axis) the misc-info of the data sub-image and the error sub-image are produced.
This ensures that, if written to FITS, the data and error extensions have the all necessary keywords.
|
virtual |
Reopen a temporarily closed image.
Reimplemented from casacore::LatticeBase.
Referenced by fitsError().
|
private |
|
private |
|
private |
Reopen the image if needed.
|
virtual |
Function which changes the shape of the FITSQualityImage.
Throws an exception as FITSQualityImage is not writable.
Implements casacore::ImageInterface< Float >.
Referenced by fitsError().
|
virtual |
Set the cache size as to "fit" the indicated path.
Reimplemented from casacore::LatticeBase.
Referenced by whichErrorHDU().
|
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.
Referenced by whichErrorHDU().
|
virtual |
Set the maximum (allowed) cache size as indicated.
Reimplemented from casacore::LatticeBase.
Referenced by whichErrorHDU().
|
private |
Setup the object (used by constructors).
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Referenced by fitsError().
|
virtual |
Referenced by fitsError().
|
inline |
Return the data HDU number.
Definition at line 207 of file FITSQualityImage.h.
References whichDataHDU_p.
|
inline |
Return the error HDU number.
Definition at line 211 of file FITSQualityImage.h.
References clearCache(), maximumCacheSize(), setCacheSizeFromPath(), setCacheSizeInTiles(), setMaximumCacheSize(), showCacheStatistics(), and whichErrorHDU_p.
|
private |
Definition at line 250 of file FITSQualityImage.h.
|
private |
Definition at line 243 of file FITSQualityImage.h.
Referenced by fitsData().
|
private |
Definition at line 244 of file FITSQualityImage.h.
Referenced by fitsError().
|
private |
Definition at line 242 of file FITSQualityImage.h.
|
private |
Definition at line 251 of file FITSQualityImage.h.
|
private |
Definition at line 252 of file FITSQualityImage.h.
|
private |
Definition at line 253 of file FITSQualityImage.h.
|
private |
Definition at line 241 of file FITSQualityImage.h.
Definition at line 245 of file FITSQualityImage.h.
|
private |
Definition at line 246 of file FITSQualityImage.h.
|
private |
Definition at line 247 of file FITSQualityImage.h.
Referenced by whichDataHDU().
|
private |
Definition at line 248 of file FITSQualityImage.h.
Referenced by whichErrorHDU().
|
private |
Definition at line 249 of file FITSQualityImage.h.