casacore
|
#include <FITSErrorImage.h>
Public Types | |
enum | ErrorType { MSE, RMSE, INVMSE, INVRMSE, UNKNOWN, DEFAULT } |
The enum describes which types of error images exist. More... | |
Public Member Functions | |
FITSErrorImage (const String &name, uInt whichRep=0, uInt whichHDU=0, FITSErrorImage::ErrorType errtype=MSE) | |
Construct a FITSImage from the disk FITS file name and extension and apply mask. More... | |
FITSErrorImage (const String &name, const MaskSpecifier &mask, uInt whichRep=0, uInt whichHDU=0, FITSErrorImage::ErrorType errtype=MSE) | |
Construct a FITSImage from the disk FITS file name and extension and apply mask or not. More... | |
FITSErrorImage (const FITSErrorImage &other) | |
Copy constructor (reference semantics) More... | |
virtual | ~FITSErrorImage () |
Destructor. More... | |
FITSErrorImage & | operator= (const FITSErrorImage &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 "FITSErrorImage"). 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 FITSImage is not writable, so this throws an exception. More... | |
virtual FITSErrorImage::ErrorType | errorType () const |
Return the error type. More... | |
![]() | |
FITSImage (const String &name, uInt whichRep=0, uInt whichHDU=0) | |
Construct a FITSImage from the disk FITS file name and extension and apply mask. More... | |
FITSImage (const String &name, const MaskSpecifier &mask, uInt whichRep=0, uInt whichHDU=0) | |
Construct a FITSImage from the disk FITS file name and extension and apply mask or not. More... | |
FITSImage (const FITSImage &other) | |
Copy constructor (reference semantics) More... | |
virtual | ~FITSImage () |
Destructor does nothing. More... | |
FITSImage & | operator= (const FITSImage &other) |
Assignment (reference semantics) More... | |
virtual void | resize (const TiledShape &newShape) |
Function which changes the shape of the FITSImage. More... | |
virtual Bool | isMasked () const |
Has the object really a mask? The FITSImage always has a pixel mask and never has a region mask so this always returns True. More... | |
virtual Bool | hasPixelMask () const |
FITSimage 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 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 | 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 void | tempClose () |
Temporarily close the image. More... | |
virtual void | reopen () |
Reopen a temporarily closed image. More... | |
virtual Bool | ok () const |
Check class invariants. More... | |
virtual DataType | dataType () const |
Return the data type (TpFloat). More... | |
DataType | internalDataType () const |
Return the (internal) data type. More... | |
uInt | whichHDU () const |
Return the 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 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... | |
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 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) |
Static Public Member Functions | |
static FITSErrorImage::ErrorType | stringToErrorType (String errorTypeStr) |
Convert an image type to String. More... | |
static String | errorTypeToString (FITSErrorImage::ErrorType errType) |
Convert a String to an image type. More... | |
![]() | |
static LatticeBase * | openFITSImage (const String &name, const MaskSpecifier &) |
Function to open a FITS image (new parser) More... | |
static void | registerOpenFunction () |
Register the open function. More... | |
static String | get_fitsname (const String &fullname) |
Separate any extension specification and return the pure fitsname. More... | |
static uInt | get_hdunum (const String &fullname) |
Get the extension index for any extension specification given in the full name. More... | |
static String | className () |
returns "FITSImage". More... | |
Private Member Functions | |
void | setupMask () |
Set the correct masking. More... | |
Private Attributes | |
Array< Float > | buffer_p |
FITSErrorImage::ErrorType | errtype_p |
Additional Inherited Members | |
![]() | |
void | setMaskZero (Bool filterZero) |
Set the masking of values 0.0. More... | |
![]() | |
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... | |
Class providing native access to FITS Error images.
Public interface
This provides native access to FITS error images.
Definition at line 79 of file FITSErrorImage.h.
The enum describes which types of error images exist.
The type is fixed during object creation and can not be changed at a later time.
Enumerator | |
---|---|
MSE | |
RMSE | |
INVMSE | |
INVRMSE | |
UNKNOWN | |
DEFAULT |
Definition at line 85 of file FITSErrorImage.h.
|
explicit |
casacore::FITSErrorImage::FITSErrorImage | ( | const String & | name, |
const MaskSpecifier & | mask, | ||
uInt | whichRep = 0 , |
||
uInt | whichHDU = 0 , |
||
FITSErrorImage::ErrorType | errtype = MSE |
||
) |
casacore::FITSErrorImage::FITSErrorImage | ( | const FITSErrorImage & | other | ) |
Copy constructor (reference semantics)
|
virtual |
Destructor.
|
virtual |
Make a copy of the object with new (reference semantics).
Reimplemented from casacore::FITSImage.
|
virtual |
Do the actual get of the data.
Returns False as the data do not reference another Array
Reimplemented from casacore::FITSImage.
|
virtual |
The FITSImage is not writable, so this throws an exception.
Reimplemented from casacore::FITSImage.
|
inlinevirtual |
|
static |
Convert a String to an image type.
|
virtual |
Get the image type (returns "FITSErrorImage").
Reimplemented from casacore::FITSImage.
FITSErrorImage& casacore::FITSErrorImage::operator= | ( | const FITSErrorImage & | other | ) |
Assignment (reference semantics)
|
private |
Set the correct masking.
|
static |
Convert an image type to String.
Definition at line 140 of file FITSErrorImage.h.
|
private |
Definition at line 141 of file FITSErrorImage.h.
Referenced by errorType().