#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 &section)
	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...

Public Member Functions inherited from casacore::Lattice< Bool >
virtual	~Lattice ()
	a virtual destructor is needed so that it will use the actual destructor in the derived class 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 &section, 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 &section, 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 &section, 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...

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 String	imageType () const
	Get the image type (returns name of derived class). More...

virtual Bool	isPersistent () const
	Is the lattice persistent and can it be loaded by other processes as well? That is the case for a PagedArray or PagedImage and for an ImageExpr which does not use transient lattices or regions. More...

virtual Bool	isPaged () const
	Is the lattice paged to disk? The default implementation returns False. 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 void	tempClose ()
	Temporarily close the lattice. More...

virtual void	reopen ()
	Explicitly reopen the temporarily closed lattice. More...

virtual String	name (Bool stripPath=False) const
	Return the name of the current Lattice object. 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...

virtual LELCoordinates	lelCoordinates () const
	Return the coordinates of the lattice. More...

IPosition	niceCursorShape (uInt maxPixels) const
	Returns a recommended cursor shape for iterating through all the pixels in the Lattice. More...

IPosition	niceCursorShape () const

virtual Bool	ok () const
	Check class internals - used for debugging. More...

virtual IPosition	doNiceCursorShape (uInt maxPixels) const
	The function (in the derived classes) doing the actual work. More...

virtual uInt	maximumCacheSize () const
	Maximum cache size - not necessarily all used. More...

virtual void	setMaximumCacheSize (uInt howManyPixels)
	Set the maximum (allowed) cache size as indicated. More...

virtual void	setCacheSizeInTiles (uInt howManyTiles)
	Set the actual cache size for this Array to be big enough for the indicated number of tiles. 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	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...

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
Protected Member Functions inherited from casacore::Lattice< Bool >
	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 > &)

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...

LatticeBase &	operator= (const LatticeBase &)

void	throwBoolMath () const
	Throw an exception for arithmetic on a Bool Lattice. More...

Detailed Description

Provides an on-the-fly mask for FITS images

Intended use:

Public interface

Prerequisite

Etymology

This class provides a pixel mask for the FITSImage class.

Synopsis

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.

Example

Motivation

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.

Constructor & Destructor Documentation

◆ FITSMask() [1/5]

casacore::FITSMask::FITSMask ( TiledFileAccess * tiledFileAccess )

Constructor (for 32 bit floating point).

The pointer is not cloned, just copied.

◆ FITSMask() [2/5]

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')

◆ FITSMask() [3/5]

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')

◆ FITSMask() [4/5]

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')

◆ FITSMask() [5/5]

casacore::FITSMask::FITSMask ( const FITSMask & other )

Copy constructor (reference semantics).

The TiledFileAccess pointer is just copied.

◆ ~FITSMask()

virtual casacore::FITSMask::~FITSMask ( )

virtual

Destructor

Member Function Documentation

◆ clone()

virtual Lattice<Bool>* casacore::FITSMask::clone ( ) const

virtual

Make a copy of the object (reference semantics).

Implements casacore::Lattice< Bool >.

◆ doGetSlice()

virtual Bool casacore::FITSMask::doGetSlice	(	Array< Bool > &	buffer,
		const Slicer &	section
	)

virtual

Do the actual getting of an array of values.

Implements casacore::Lattice< Bool >.

◆ doPutSlice()

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

virtual

Do the actual getting of an array of values.

Throws an exception.

Implements casacore::Lattice< Bool >.

◆ filterNaN()

void casacore::FITSMask::filterNaN	(	Bool *	pMask,
		const float *	pData,
		uInt	nelems
	)

private

Mask out ONLY NaN's.

◆ filterZeroNaN()

void casacore::FITSMask::filterZeroNaN	(	Bool *	pMask,
		const Float *	pData,
		uInt	nelems
	)

private

Mask out NaN's and values 0.0.

◆ isWritable()

virtual Bool casacore::FITSMask::isWritable ( ) const

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.

Reimplemented from casacore::LatticeBase.

◆ operator=()

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

The assignment operator with reference semantics.

The TiledFileAccess pointer is just copied.

◆ setFilterZero()

virtual void casacore::FITSMask::setFilterZero ( Bool filterZero )

virtual

Set the switch for also filtering 0.0 (besides NaNs).

◆ shape()

IPosition casacore::FITSMask::shape ( ) const

virtual

Return the shape of the Lattice including all degenerate axes (ie.

axes with a length of one)

Implements casacore::LatticeBase.

Member Data Documentation

◆ itsBuffer

Array<Float> casacore::FITSMask::itsBuffer

private

Definition at line 167 of file FITSMask.h.

◆ itsFilterZero

Bool casacore::FITSMask::itsFilterZero

private

Definition at line 173 of file FITSMask.h.

◆ itsHasIntBlanks

Bool casacore::FITSMask::itsHasIntBlanks

private

Definition at line 172 of file FITSMask.h.

◆ itsLongMagic

Int casacore::FITSMask::itsLongMagic

private

Definition at line 171 of file FITSMask.h.

◆ itsOffset

Float casacore::FITSMask::itsOffset

private

Definition at line 168 of file FITSMask.h.

◆ itsScale

Float casacore::FITSMask::itsScale

private

Definition at line 168 of file FITSMask.h.

◆ itsShortMagic

Short casacore::FITSMask::itsShortMagic

private

Definition at line 170 of file FITSMask.h.

◆ itsTiledFilePtr

TiledFileAccess* casacore::FITSMask::itsTiledFilePtr

private

Definition at line 166 of file FITSMask.h.

◆ itsUCharMagic

Short casacore::FITSMask::itsUCharMagic

private

Definition at line 169 of file FITSMask.h.

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

lattices/LRegions/FITSMask.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Intended use:

Prerequisite

Etymology

Synopsis

Example

Motivation

Constructor & Destructor Documentation

◆ FITSMask() [1/5]

◆ FITSMask() [2/5]

◆ FITSMask() [3/5]

◆ FITSMask() [4/5]

◆ FITSMask() [5/5]

◆ ~FITSMask()

Member Function Documentation

◆ clone()

◆ doGetSlice()

◆ doPutSlice()

◆ filterNaN()

◆ filterZeroNaN()

◆ isWritable()

◆ operator=()

◆ setFilterZero()

◆ shape()

Member Data Documentation

◆ itsBuffer

◆ itsFilterZero

◆ itsHasIntBlanks

◆ itsLongMagic

◆ itsOffset

◆ itsScale

◆ itsShortMagic

◆ itsTiledFilePtr

◆ itsUCharMagic