casa::LCHDF5Mask Class Reference

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

#include <LCHDF5Mask.h>

Inheritance diagram for casa::LCHDF5Mask:

List of all members.

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 56 of file LCHDF5Mask.h.

---

Constructor & Destructor Documentation

casa::LCHDF5Mask::LCHDF5Mask

(

)

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

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

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

casa::LCHDF5Mask::LCHDF5Mask

(

const LCHDF5Mask &

other

)

Copy constructor (copy semantics).

virtual casa::LCHDF5Mask::~LCHDF5Mask

(

)

[virtual]

Destructor.

casa::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 casa::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 casa::Lattice< Bool >.

static String casa::LCHDF5Mask::className

(

)

[static]

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

virtual LCRegion* casa::LCHDF5Mask::cloneRegion

(

)

const [virtual]

Make a copy of the derived object.

Implements casa::LCRegion.

virtual IPosition casa::LCHDF5Mask::doNiceCursorShape

(

uInt

maxPixels

)

const [virtual]

Help the user pick a cursor for most efficient access.

Reimplemented from casa::LCRegionSingle.

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

Construct another LCHDF5Mask (for e.g.

another lattice) by moving this one. It recalculates the bounding mask. A positive translation value indicates "to right".

Implements casa::LCRegion.

virtual void casa::LCHDF5Mask::flush

(

)

[virtual]

Flush the data (but do not unlock).

Reimplemented from casa::LatticeBase.

static LCHDF5Mask* casa::LCHDF5Mask::fromRecord	(	const TableRecord &	,
		const String &	tablename
	)		[static]

Convert correct object from a record.

Reimplemented from casa::LCRegion.

virtual Bool casa::LCHDF5Mask::isWritable

(

)

const [virtual]

An LCHDF5Mask is writable if the underlying HDF5Lattice is.

Reimplemented from casa::LCRegion.

virtual LatticeIterInterface<Bool>* casa::LCHDF5Mask::makeIter	(	const LatticeNavigator &	navigator,
		Bool	useRef
	)		const [virtual]

This function is used by the LatticeIterator class to generate an iterator of the correct type for this Lattice.

Not recommended for general use.

Reimplemented from casa::LCRegionSingle.

LCHDF5Mask& casa::LCHDF5Mask::operator=

(

const LCHDF5Mask &

other

)

Assignment (reference semantics).

virtual Bool casa::LCHDF5Mask::operator==

(

const LCRegion &

other

)

const [virtual]

Comparison.

Reimplemented from casa::LCRegion.

virtual TableRecord casa::LCHDF5Mask::toRecord

(

const String &

tableName

)

const [virtual]

Convert the (derived) object to a record.

Implements casa::LCRegion.

virtual String casa::LCHDF5Mask::type

(

)

const [virtual]

Region type.

Returns class name.

Implements casa::LCRegion.

---

Member Data Documentation

LCBox casa::LCHDF5Mask::itsBox [private]

Definition at line 136 of file LCHDF5Mask.h.

HDF5Lattice<Bool> casa::LCHDF5Mask::itsMask [private]

Definition at line 137 of file LCHDF5Mask.h.

---

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

• casacore/lattices/Lattices/LCHDF5Mask.h