casacore::FITSMask Class Reference

Provides an on-the-fly mask for FITS images. More...

#include <FITSMask.h>

Inheritance diagram for casacore::FITSMask:

List of all members.

Public Member Functions
	FITSMask (TiledFileAccess *tiledFileAccess)
	Constructor (for 32 bit floating point).
	FITSMask (TiledFileAccess *tiledFileAccess, Float scale, Float offset, uChar magic, Bool hasBlanks)
	Constructor (for 8 bit integers).
	FITSMask (TiledFileAccess *tiledFileAccess, Float scale, Float offset, Short magic, Bool hasBlanks)
	Constructor (for 16 bit integers).
	FITSMask (TiledFileAccess *tiledFileAccess, Float scale, Float offset, Int magic, Bool hasBlanks)
	Constructor (for 32 bit integers).
	FITSMask (const FITSMask &other)
	Copy constructor (reference semantics).
virtual	~FITSMask ()
	Destructor.
FITSMask &	operator= (const FITSMask &other)
	The assignment operator with reference semantics.
virtual Lattice< Bool > *	clone () const
	Make a copy of the object (reference semantics).
virtual Bool	isWritable () const
	Is the FITSMask writable? Returns False.
IPosition	shape () const
	Return the shape of the Lattice including all degenerate axes (ie.
virtual Bool	doGetSlice (Array< Bool > &buffer, const Slicer &section)
	Do the actual getting of an array of values.
virtual void	doPutSlice (const Array< Bool > &sourceBuffer, const IPosition &where, const IPosition &stride)
	Do the actual getting of an array of values.
virtual void	setFilterZero (Bool filterZero)
	Set the switch for also filtering 0.0 (besides NaNs).
Private Member Functions
void	filterNaN (Bool pMask, const float pData, uInt nelems)
	Mask out ONLY NaN's.
void	filterZeroNaN (Bool pMask, const Float pData, uInt nelems)
	Mask out NaN's and values 0.0.
Private Attributes
TiledFileAccess *	itsTiledFilePtr
Array< Float >	itsBuffer
Float	itsScale
Float	itsOffset
Short	itsUCharMagic
Short	itsShortMagic
Int	itsLongMagic
Bool	itsHasIntBlanks
Bool	itsFilterZero

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

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 casacore::FITSMask::~FITSMask ( ) [virtual]

Destructor.

Member Function Documentation

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

Make a copy of the object (reference semantics).

Implements casacore::Lattice< Bool >.

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

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

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

Mask out ONLY NaN's.

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

Mask out NaN's and values 0.0.

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.

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

The assignment operator with reference semantics.

The TiledFileAccess pointer is just copied.

Reimplemented from casacore::LatticeBase.

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

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

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

Array<Float> casacore::FITSMask::itsBuffer [private]

Definition at line 167 of file FITSMask.h.

Bool casacore::FITSMask::itsFilterZero [private]

Definition at line 173 of file FITSMask.h.

Bool casacore::FITSMask::itsHasIntBlanks [private]

Definition at line 172 of file FITSMask.h.

Int casacore::FITSMask::itsLongMagic [private]

Definition at line 171 of file FITSMask.h.

Float casacore::FITSMask::itsOffset [private]

Definition at line 168 of file FITSMask.h.

Float casacore::FITSMask::itsScale [private]

Definition at line 168 of file FITSMask.h.

Short casacore::FITSMask::itsShortMagic [private]

Definition at line 170 of file FITSMask.h.

TiledFileAccess* casacore::FITSMask::itsTiledFilePtr [private]

Definition at line 166 of file FITSMask.h.

Short casacore::FITSMask::itsUCharMagic [private]

Definition at line 169 of file FITSMask.h.

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

casacore/lattices/LRegions/FITSMask.h

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by 1.6.1