casacore::LCHDF5Mask Class Reference

Class to define a rectangular mask as a region. More...

#include <LCHDF5Mask.h>

Inheritance diagram for casacore::LCHDF5Mask:

Public Member Functions
	LCHDF5Mask ()
	LCHDF5Mask (const TiledShape &latticeShape, const CountedPtr< HDF5File > &file, const String &maskName)
	Construct an HDF5Mask object for (part of) a lattice.
	LCHDF5Mask (const TiledShape &maskShape, const LCBox &box, const CountedPtr< HDF5File > &file, const String &maskName)
	LCHDF5Mask (HDF5Lattice< Bool > &mask, const LCBox &box)
	LCHDF5Mask (const LCHDF5Mask &other)
	Copy constructor (copy semantics).
virtual	~LCHDF5Mask ()
	Destructor.
LCHDF5Mask &	operator= (const LCHDF5Mask &other)
	Assignment (reference semantics).
virtual Bool	operator== (const LCRegion &other) const
	Comparison.
virtual LCRegion *	cloneRegion () const
	Make a copy of the derived object.
virtual LatticeIterInterface < Bool > *	makeIter (const LatticeNavigator &navigator, Bool useRef) const
	This function is used by the LatticeIterator class to generate an iterator of the correct type for this Lattice.
virtual uInt	advisedMaxPixels () const
	Returns the maximum recommended number of pixels for a cursor.
virtual IPosition	doNiceCursorShape (uInt maxPixels) const
	Help the user pick a cursor for most efficient access.
virtual void	flush ()
	Flush the data (but do not unlock).
virtual String	type () const
	Region type.
virtual TableRecord	toRecord (const String &tableName) const
	Convert the (derived) object to a record.
virtual Bool	isWritable () const
	An LCHDF5Mask is writable if the underlying HDF5Lattice is.
Static Public Member Functions
static String	className ()
	Get the class name (to store in the record).
static LCHDF5Mask *	fromRecord (const TableRecord &, const String &tablename)
	Convert correct object from a record.
Protected Member Functions
virtual LCRegion *	doTranslate (const Vector< Float > &translateVector, const IPosition &newLatticeShape) const
	Construct another LCHDF5Mask (for e.g.
Private Member Functions
	LCHDF5Mask (HDF5Lattice< Bool > &mask, const IPosition &blc, const IPosition &latticeShape)
	Create the object from a record (for an existing mask).
Private Attributes
LCBox	itsBox
HDF5Lattice< Bool >	itsMask

Detailed Description

Class to define a rectangular mask as a region.

Intended use:

Internal

Prerequisite

LCRegionSingle

Synopsis

The LCHDF5Mask class is a specialization of class LCRegionSingle . It holds a mask for an HDF5Image in an HDF5Lattice<Bool> object.

Definition at line 57 of file LCHDF5Mask.h.

Constructor & Destructor Documentation

casacore::LCHDF5Mask::LCHDF5Mask ( )

casacore::LCHDF5Mask::LCHDF5Mask	(	const TiledShape &	latticeShape,
		const CountedPtr< HDF5File > &	file,
		const String &	maskName
	)

Construct an HDF5Mask object for (part of) a lattice.

It is put in group Masks of the HDF5 file. The group is created if not existing yet. The box defines the position of the mask. The default mask shape is the lattice shape.

casacore::LCHDF5Mask::LCHDF5Mask	(	const TiledShape &	maskShape,
		const LCBox &	box,
		const CountedPtr< HDF5File > &	file,
		const String &	maskName
	)

casacore::LCHDF5Mask::LCHDF5Mask	(	HDF5Lattice< Bool > &	mask,
		const LCBox &	box
	)

casacore::LCHDF5Mask::LCHDF5Mask ( const LCHDF5Mask & other )

Copy constructor (copy semantics).

virtual casacore::LCHDF5Mask::~LCHDF5Mask ( ) [virtual]

Destructor.

casacore::LCHDF5Mask::LCHDF5Mask	(	HDF5Lattice< Bool > &	mask,
		const IPosition &	blc,
		const IPosition &	latticeShape
	)			`[private]`

Create the object from a record (for an existing mask).

Member Function Documentation

virtual uInt casacore::LCHDF5Mask::advisedMaxPixels ( ) const [virtual]

Returns the maximum recommended number of pixels for a cursor.

This is the number of pixels in a tile.

Reimplemented from casacore::Lattice< Bool >.

static String casacore::LCHDF5Mask::className ( ) [static]

Get the class name (to store in the record).

virtual LCRegion* casacore::LCHDF5Mask::cloneRegion ( ) const [virtual]

Make a copy of the derived object.

Implements casacore::LCRegion.

virtual IPosition casacore::LCHDF5Mask::doNiceCursorShape ( uInt maxPixels ) const [virtual]

Help the user pick a cursor for most efficient access.

Reimplemented from casacore::LCRegionSingle.

virtual LCRegion* casacore::LCHDF5Mask::doTranslate	(	const Vector< Float > &	translateVector,
		const IPosition &	newLatticeShape
	)			const `[protected, virtual]`