casacore
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::FITSErrorImage Class Reference

More...

#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...
 
FITSErrorImageoperator= (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...
 
- Public Member Functions inherited from casacore::FITSImage
 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...
 
FITSImageoperator= (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 &section)
 Do the actual get of the mask data. More...
 
virtual const LatticeRegiongetRegionPtr () 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...
 
- Public Member Functions inherited from casacore::ImageInterface< Float >
 ImageInterface ()
 
 ImageInterface (const RegionHandler &regionHandler)
 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 Unitunits () 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 CoordinateSystemcoordinates () const
 
virtual LELCoordinates lelCoordinates () const
 Function to get a LELCoordinate object containing the coordinates. More...
 
LoggerHolderlogger ()
 Get access to the LoggerHolder. More...
 
const LoggerHolderlogger () const
 
LogIOlogSink ()
 Allow messages to be logged to this ImageInterface. More...
 
const LogIOlogSink () const
 
void appendLog (const LoggerHolder &other)
 Add the messages from the other image logger to this one. More...
 
const TableRecordmiscInfo () const
 Often we have miscellaneous information we want to attach to an image. More...
 
virtual Bool setMiscInfo (const RecordInterface &newInfo)
 
const ImageInfoimageInfo () 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...
 
ImageInforwImageInfo ()
 Get non-const access to the ImageInfo. More...
 
virtual Bool setImageInfo (const ImageInfo &info)
 
virtual ImageAttrHandlerattrHandler (Bool createHandler=False)
 Get access to the attribute handler. More...
 
ImageAttrHandlerroAttrHandler () 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 &region, RegionHandler::GroupType, Bool overwrite=False)
 Define a region/mask belonging to the image. More...
 
virtual Bool hasRegion (const String &regionName, RegionHandler::GroupType=RegionHandler::Any) const
 Does the image have a region with the given name? More...
 
virtual ImageRegiongetImageRegionPtr (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< StringregionNames (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 &regionName)
 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 &regionName, 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)
 
- Public Member Functions inherited from casacore::MaskedLattice< T >
 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 LatticeRegionregion () 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 &section, 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 &section, 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< BoolgetMask (Bool removeDegenerateAxes=False) const
 
Array< BoolgetMaskSlice (const Slicer &section, Bool removeDegenerateAxes=False) const
 
Array< BoolgetMaskSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const
 
Array< BoolgetMaskSlice (const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const
 
- Public Member Functions inherited from casacore::Lattice< T >
virtual ~Lattice ()
 a virtual destructor is needed so that it will use the actual destructor in the derived class More...
 
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 &section, 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 &section, 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 &section, 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 &section)=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
 
- Public Member Functions inherited from casacore::LatticeBase
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 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 Public Member Functions inherited from casacore::FITSImage
static LatticeBaseopenFITSImage (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< Floatbuffer_p
 
FITSErrorImage::ErrorType errtype_p
 

Additional Inherited Members

- Protected Member Functions inherited from casacore::FITSImage
void setMaskZero (Bool filterZero)
 Set the masking of values 0.0. More...
 
- Protected Member Functions inherited from casacore::ImageInterface< Float >
ImageInterfaceoperator= (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...
 
RegionHandlergetRegionHandler ()
 Get access to the region handler. More...
 
- Protected Member Functions inherited from casacore::MaskedLattice< T >
MaskedLattice< T > & operator= (const MaskedLattice< T > &)
 Assignment can only be used by derived classes. More...
 
- Protected Member Functions inherited from casacore::Lattice< T >
 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 > &)
 
void handleMathTo (Lattice< Bool > &, int) const
 
- Protected Member Functions inherited from casacore::LatticeBase
 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...
 
LatticeBaseoperator= (const LatticeBase &)
 
void throwBoolMath () const
 Throw an exception for arithmetic on a Bool Lattice. More...
 

Detailed Description

Class providing native access to FITS Error images.

Intended use:

Public interface

Review Status

Test programs:
tFITSErrorImage

Prerequisite

Etymology

Synopsis

Example

Motivation

This provides native access to FITS error images.

Definition at line 77 of file FITSErrorImage.h.

Member Enumeration Documentation

◆ ErrorType

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 83 of file FITSErrorImage.h.

Constructor & Destructor Documentation

◆ FITSErrorImage() [1/3]

casacore::FITSErrorImage::FITSErrorImage ( const String name,
uInt  whichRep = 0,
uInt  whichHDU = 0,
FITSErrorImage::ErrorType  errtype = MSE 
)
explicit

Construct a FITSImage from the disk FITS file name and extension and apply mask.

◆ FITSErrorImage() [2/3]

casacore::FITSErrorImage::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.

◆ FITSErrorImage() [3/3]

casacore::FITSErrorImage::FITSErrorImage ( const FITSErrorImage other)

Copy constructor (reference semantics)

◆ ~FITSErrorImage()

virtual casacore::FITSErrorImage::~FITSErrorImage ( )
virtual

Destructor.

Member Function Documentation

◆ cloneII()

virtual ImageInterface<Float>* casacore::FITSErrorImage::cloneII ( ) const
virtual

Make a copy of the object with new (reference semantics).

Reimplemented from casacore::FITSImage.

◆ doGetSlice()

virtual Bool casacore::FITSErrorImage::doGetSlice ( Array< Float > &  buffer,
const Slicer theSlice 
)
virtual

Do the actual get of the data.

Returns False as the data do not reference another Array

Reimplemented from casacore::FITSImage.

◆ doPutSlice()

virtual void casacore::FITSErrorImage::doPutSlice ( const Array< Float > &  sourceBuffer,
const IPosition where,
const IPosition stride 
)
virtual

The FITSImage is not writable, so this throws an exception.

Reimplemented from casacore::FITSImage.

◆ errorType()

virtual FITSErrorImage::ErrorType casacore::FITSErrorImage::errorType ( ) const
inlinevirtual

Return the error type.

Definition at line 124 of file FITSErrorImage.h.

References errtype_p.

◆ errorTypeToString()

static String casacore::FITSErrorImage::errorTypeToString ( FITSErrorImage::ErrorType  errType)
static

Convert a String to an image type.

◆ imageType()

virtual String casacore::FITSErrorImage::imageType ( ) const
virtual

Get the image type (returns "FITSErrorImage").

Reimplemented from casacore::FITSImage.

◆ operator=()

FITSErrorImage& casacore::FITSErrorImage::operator= ( const FITSErrorImage other)

Assignment (reference semantics)

◆ setupMask()

void casacore::FITSErrorImage::setupMask ( )
private

Set the correct masking.

◆ stringToErrorType()

static FITSErrorImage::ErrorType casacore::FITSErrorImage::stringToErrorType ( String  errorTypeStr)
static

Convert an image type to String.

Member Data Documentation

◆ buffer_p

Array<Float> casacore::FITSErrorImage::buffer_p
private

Definition at line 138 of file FITSErrorImage.h.

◆ errtype_p

FITSErrorImage::ErrorType casacore::FITSErrorImage::errtype_p
private

Definition at line 139 of file FITSErrorImage.h.

Referenced by errorType().


The documentation for this class was generated from the following file: