casacore
|
Provides an on-the-fly mask for FITS images. More...
#include <FITSMask.h>
Public Member Functions | |
FITSMask (TiledFileAccess *tiledFileAccess) | |
Constructor (for 32 bit floating point). More... | |
FITSMask (TiledFileAccess *tiledFileAccess, Float scale, Float offset, uChar magic, Bool hasBlanks) | |
Constructor (for 8 bit integers). More... | |
FITSMask (TiledFileAccess *tiledFileAccess, Float scale, Float offset, Short magic, Bool hasBlanks) | |
Constructor (for 16 bit integers). More... | |
FITSMask (TiledFileAccess *tiledFileAccess, Float scale, Float offset, Int magic, Bool hasBlanks) | |
Constructor (for 32 bit integers). More... | |
FITSMask (const FITSMask &other) | |
Copy constructor (reference semantics). More... | |
virtual | ~FITSMask () |
Destructor More... | |
FITSMask & | operator= (const FITSMask &other) |
The assignment operator with reference semantics. More... | |
virtual Lattice< Bool > * | clone () const |
Make a copy of the object (reference semantics). More... | |
virtual Bool | isWritable () const |
Is the FITSMask writable? Returns False. More... | |
IPosition | shape () const |
Return the shape of the Lattice including all degenerate axes (ie. More... | |
virtual Bool | doGetSlice (Array< Bool > &buffer, const Slicer §ion) |
Do the actual getting of an array of values. More... | |
virtual void | doPutSlice (const Array< Bool > &sourceBuffer, const IPosition &where, const IPosition &stride) |
Do the actual getting of an array of values. More... | |
virtual void | setFilterZero (Bool filterZero) |
Set the switch for also filtering 0.0 (besides NaNs). More... | |
![]() | |
virtual | ~Lattice () |
a virtual destructor is needed so that it will use the actual destructor in the derived class More... | |
virtual Lattice< Bool > * | clone () const=0 |
Make a copy of the derived object (reference semantics). More... | |
virtual DataType | dataType () const |
Get the data type of the lattice. More... | |
Bool | operator() (const IPosition &where) const |
Return the value of the single element located at the argument IPosition. More... | |
virtual Bool | getAt (const IPosition &where) const |
virtual void | putAt (const Bool &value, const IPosition &where) |
Put the value of a single element. More... | |
Bool | get (COWPtr< Array< Bool > > &buffer, Bool removeDegenerateAxes=False) const |
Functions which extract an Array of values from a Lattice. More... | |
Bool | get (Array< Bool > &buffer, Bool removeDegenerateAxes=False) |
Array< Bool > | get (Bool removeDegenerateAxes=False) const |
Bool | getSlice (COWPtr< Array< Bool > > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) const |
Bool | getSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
Bool | getSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
Bool | getSlice (Array< Bool > &buffer, const Slicer §ion, Bool removeDegenerateAxes=False) |
Bool | getSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) |
Bool | getSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) |
Array< Bool > | getSlice (const Slicer §ion, Bool removeDegenerateAxes=False) const |
Array< Bool > | getSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const |
Array< Bool > | getSlice (const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const |
void | putSlice (const Array< Bool > &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< Bool > &sourceBuffer, const IPosition &where) |
void | put (const Array< Bool > &sourceBuffer) |
virtual void | set (const Bool &value) |
Set all elements in the Lattice to the given value. More... | |
virtual void | apply (Bool(*function)(Bool)) |
Replace every element, x, of the Lattice with the result of f(x). More... | |
virtual void | apply (Bool(*function)(const Bool &)) |
virtual void | apply (const Functional< Bool, Bool > &function) |
void | operator+= (const Lattice< Bool > &other) |
Add, subtract, multiple, or divide by another Lattice. More... | |
void | operator-= (const Lattice< Bool > &other) |
void | operator*= (const Lattice< Bool > &other) |
void | operator/= (const Lattice< Bool > &other) |
virtual void | copyData (const Lattice< Bool > &from) |
Copy the data from the given lattice to this one. More... | |
virtual void | copyDataTo (Lattice< Bool > &to) const |
Copy the data from this lattice to the given lattice. More... | |
virtual uInt | advisedMaxPixels () const |
This function returns the advised maximum number of pixels to include in the cursor of an iterator. More... | |
virtual LatticeIterInterface< Bool > * | 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... | |
Private Member Functions | |
void | filterNaN (Bool *pMask, const float *pData, uInt nelems) |
Mask out ONLY NaN's. More... | |
void | filterZeroNaN (Bool *pMask, const Float *pData, uInt nelems) |
Mask out NaN's and values 0.0. More... | |
Private Attributes | |
TiledFileAccess * | itsTiledFilePtr |
Array< Float > | itsBuffer |
Float | itsScale |
Float | itsOffset |
Short | itsUCharMagic |
Short | itsShortMagic |
Int | itsLongMagic |
Bool | itsHasIntBlanks |
Bool | itsFilterZero |
Additional Inherited Members | |
![]() | |
Lattice () | |
Define default constructor to satisfy compiler. More... | |
Lattice (const Lattice< Bool > &) | |
Copy constructor and assignment can only be used by derived classes. More... | |
virtual void | handleMath (const Lattice< Bool > &from, int oper) |
Handle the Math operators (+=, -=, *=, /=). More... | |
virtual void | handleMathTo (Lattice< Bool > &to, int oper) const |
void | handleMathTo (Lattice< Bool > &, int) const |
Lattice< Bool > & | operator= (const Lattice< Bool > &) |
Provides an on-the-fly mask for FITS images.
Public interface
This class provides a pixel mask for the FITSImage class.
Masked values are indicated in FITS images via magic value blanking. This class provides an on-the-fly mask. The doGetSlice function reads the data values and returns an Array<Bool> which is True (good) or False (bad - blanked)
Because FITSMask inherits from Lattice<Bool> it can be used as the private pixel mask data member for FITSImage returned by the MaskedLattice::pixelMask() functions
The FITSMask object is constructed from a TiledFileAccess object. This must be the same one that the FITSImage object constructs internally. It is shared by both FITSImage and FITSMask.
FITSImage provides native access to FITS image files and needede an efficient way to handle the pixel mask other than iterating all the way through the image first to set a mask.
Definition at line 97 of file FITSMask.h.
casacore::FITSMask::FITSMask | ( | TiledFileAccess * | tiledFileAccess | ) |
Constructor (for 32 bit floating point).
The pointer is not cloned, just copied.
casacore::FITSMask::FITSMask | ( | TiledFileAccess * | tiledFileAccess, |
Float | scale, | ||
Float | offset, | ||
uChar | magic, | ||
Bool | hasBlanks | ||
) |
Constructor (for 8 bit integers).
The pointer is not cloned, just copied The scale, offset, magic blanking values must come from the FITS header ('bscale', 'bzero', 'blank')
casacore::FITSMask::FITSMask | ( | TiledFileAccess * | tiledFileAccess, |
Float | scale, | ||
Float | offset, | ||
Short | magic, | ||
Bool | hasBlanks | ||
) |
Constructor (for 16 bit integers).
The pointer is not cloned, just copied The scale, offset, magic blanking values must come from the FITS header ('bscale', 'bzero', 'blank')
casacore::FITSMask::FITSMask | ( | TiledFileAccess * | tiledFileAccess, |
Float | scale, | ||
Float | offset, | ||
Int | magic, | ||
Bool | hasBlanks | ||
) |
Constructor (for 32 bit integers).
The pointer is not cloned, just copied The scale, offset, magic blanking values must come from the FITS header ('bscale', 'bzero', 'blank')
casacore::FITSMask::FITSMask | ( | const FITSMask & | other | ) |
Copy constructor (reference semantics).
The TiledFileAccess pointer is just copied.
|
virtual |
Destructor
Make a copy of the object (reference semantics).
|
virtual |
Do the actual getting of an array of values.
Implements casacore::Lattice< Bool >.
|
virtual |
Do the actual getting of an array of values.
Throws an exception.
Implements casacore::Lattice< Bool >.
Mask out ONLY NaN's.
Mask out NaN's and values 0.0.
|
virtual |
Is the FITSMask writable? Returns False.
Although it is not hard to implement writing of the mask, data values would be lost because of magic blanking.
The assignment operator with reference semantics.
The TiledFileAccess pointer is just copied.
|
virtual |
Set the switch for also filtering 0.0 (besides NaNs).
IPosition casacore::FITSMask::shape | ( | ) | const |
Return the shape of the Lattice including all degenerate axes (ie.
axes with a length of one)
Definition at line 167 of file FITSMask.h.
|
private |
Definition at line 173 of file FITSMask.h.
|
private |
Definition at line 172 of file FITSMask.h.
|
private |
Definition at line 171 of file FITSMask.h.
|
private |
Definition at line 168 of file FITSMask.h.
|
private |
Definition at line 168 of file FITSMask.h.
|
private |
Definition at line 170 of file FITSMask.h.
|
private |
Definition at line 166 of file FITSMask.h.
|
private |
Definition at line 169 of file FITSMask.h.