casa::LCSlicer Class Reference
[Lattices]

#include <LCSlicer.h>

Collaboration diagram for casa::LCSlicer:

[legend]List of all members.

---

Detailed Description

Class to define a rectangular box of interest with strides.

Intended use:

Part of API

Prerequisite

• LCBox

Synopsis

The LCSlicer makes it possible to define a rectangular box with strides. Note that this class is not derived from LCRegion , so it cannot be used in a compound region object like LCUnion . The reason is that strides make it impossible to use a region in a compound.
The slicer region has to be defined from an LCBox object defining the blc/trc and a vector (of the same length) containing the strides. The LCSlicer can be of any type (thus relative, fractional, unspecified), while the strides can be defined as a number or a fraction.
It is also possible to construct it directly from a Slicer object,

Example

To Do

Definition at line 83 of file LCSlicer.h.

Public Member Functions
	LCSlicer ()
	LCSlicer (const LCSlicer &other)
	Copy constructor (reference semantics).
	~LCSlicer ()
LCSlicer &	operator= (const LCSlicer &other)
	Assignment (copy semantics).
Bool	isComplete () const
	The region is completely specified if it is absolute, not fractional, and has no unspecified values.
uInt	ndim () const
	Get the dimensionality of the region.
String	type () const
	Get the region type.
TableRecord	toRecord (const String &tableName) const
	Convert the object to a record.
	LCSlicer (const Vector< Float > &blc, const Vector< Float > &trc, Bool fractionalBlcTrc=False, RegionType::AbsRelType=RegionType::Abs)
	Construct a slicer from the blc, trc, and stride (default 1).
	LCSlicer (const Vector< Float > &blc, const Vector< Float > &trc, const Vector< Float > &inc, Bool fractionalBlcTrc=False, RegionType::AbsRelType=RegionType::Abs)
	LCSlicer (const Vector< Float > &blc, const Vector< Float > &trc, const Vector< Float > &inc, const Vector< Bool > &fractionalBlc, const Vector< Bool > &fractionalTrc, const Vector< Bool > &fractionalInc, const Vector< Int > &absRelBlc, const Vector< Int > &absRelTrc)
	LCSlicer (const Vector< Double > &blc, const Vector< Double > &trc, Bool fractionalBlcTrc=False, RegionType::AbsRelType=RegionType::Abs)
	LCSlicer (const Vector< Double > &blc, const Vector< Double > &trc, const Vector< Double > &inc, Bool fractionalBlcTrc=False, RegionType::AbsRelType=RegionType::Abs)
	LCSlicer (const Vector< Double > &blc, const Vector< Double > &trc, const Vector< Double > &inc, const Vector< Bool > &fractionalBlc, const Vector< Bool > &fractionalTrc, const Vector< Bool > &fractionalInc, const Vector< Int > &absRelBlc, const Vector< Int > &absRelTrc)
	LCSlicer (const Slicer &slicer)
	LCSlicer (const IPosition &blc, const IPosition &trc, RegionType::AbsRelType=RegionType::Abs)
	LCSlicer (const IPosition &blc, const IPosition &trc, const IPosition &inc, RegionType::AbsRelType=RegionType::Abs)
	LCSlicer (const IPosition &blc, const IPosition &trc, const IPosition &inc, const Vector< Int > &absRelBlc, const Vector< Int > &absRelTrc)
Bool	operator== (const LCSlicer &other) const
	Test for equality.
Bool	operator!= (const LCSlicer &other) const
const Vector< Float > &	blc () const
	Simple accessor functions.
const Vector< Float > &	trc () const
const Vector< Float > &	inc () const
Bool	isFractional () const
Bool	isAbsolute () const
Bool	isUnspecified () const
Bool	isStrided () const
const String &	comment () const
	Get or set the comment.
void	setComment (const String &comment)
Slicer	toSlicer (const IPosition &referencePixel, const IPosition &latticeShape) const
	Make the region complete using the given reference pixel and shape.
Slicer	toSlicer (const Vector< Double > &referencePixel, const IPosition &latticeShape) const
Slicer	toSlicer (const Vector< Float > &referencePixel, const IPosition &newLatticeShape) const
Static Public Member Functions
static String	className ()
	Get the class name (to store in the record).
static LCSlicer *	fromRecord (const TableRecord &, const String &tablename)
	Convert to correct object from a record.
Private Member Functions
void	fillFlags (Bool fractional, Int absRel, uInt nrblc, uInt nrtrc, uInt nrinc)
	Fill the pixel based flags from the general ones.
void	fillFromDouble (const Vector< Double > &blc, const Vector< Double > &trc, const Vector< Double > &inc)
	Fill the vectors from the values given as doubles.
void	fillFromIPosition (const IPosition &blc, const IPosition &trc, const IPosition &inc)
	Fill the vectors from the values given as IPositions.
void	fill ()
	Fill the remaining variables.
Private Attributes
Vector< Float >	itsBlc
Vector< Float >	itsTrc
Vector< Float >	itsInc
Vector< Bool >	itsFracBlc
Vector< Bool >	itsFracTrc
Vector< Bool >	itsFracInc
Vector< Int >	itsAbsRelBlc
Vector< Int >	itsAbsRelTrc
Bool	itsIsFractional
Bool	itsIsAbsolute
Bool	itsIsUnspecified
Bool	itsIsStrided
String	itsComment

---

Constructor & Destructor Documentation

casa::LCSlicer::LCSlicer

(

)

casa::LCSlicer::LCSlicer	(	const Vector< Float > &	blc,
		const Vector< Float > &	trc,
		Bool	fractionalBlcTrc = False,
		RegionType::AbsRelType	= RegionType::Abs
	)

Construct a slicer from the blc, trc, and stride (default 1).

The vectors can be different in lengths. The longest determines the dimensionality of the region. The shorter ones get padded with default values.

casa::LCSlicer::LCSlicer	(	const Vector< Float > &	blc,
		const Vector< Float > &	trc,
		const Vector< Float > &	inc,
		Bool	fractionalBlcTrc = False,
		RegionType::AbsRelType	= RegionType::Abs
	)

casa::LCSlicer::LCSlicer	(	const Vector< Float > &	blc,
		const Vector< Float > &	trc,
		const Vector< Float > &	inc,
		const Vector< Bool > &	fractionalBlc,
		const Vector< Bool > &	fractionalTrc,
		const Vector< Bool > &	fractionalInc,
		const Vector< Int > &	absRelBlc,
		const Vector< Int > &	absRelTrc
	)

casa::LCSlicer::LCSlicer	(	const Vector< Double > &	blc,
		const Vector< Double > &	trc,
		Bool	fractionalBlcTrc = False,
		RegionType::AbsRelType	= RegionType::Abs
	)

casa::LCSlicer::LCSlicer	(	const Vector< Double > &	blc,
		const Vector< Double > &	trc,
		const Vector< Double > &	inc,
		Bool	fractionalBlcTrc = False,
		RegionType::AbsRelType	= RegionType::Abs
	)

casa::LCSlicer::LCSlicer	(	const Vector< Double > &	blc,
		const Vector< Double > &	trc,
		const Vector< Double > &	inc,
		const Vector< Bool > &	fractionalBlc,
		const Vector< Bool > &	fractionalTrc,
		const Vector< Bool > &	fractionalInc,
		const Vector< Int > &	absRelBlc,
		const Vector< Int > &	absRelTrc
	)

casa::LCSlicer::LCSlicer

(

const Slicer &

slicer

)

casa::LCSlicer::LCSlicer	(	const IPosition &	blc,
		const IPosition &	trc,
		RegionType::AbsRelType	= RegionType::Abs
	)

casa::LCSlicer::LCSlicer	(	const IPosition &	blc,
		const IPosition &	trc,
		const IPosition &	inc,
		RegionType::AbsRelType	= RegionType::Abs
	)

casa::LCSlicer::LCSlicer	(	const IPosition &	blc,
		const IPosition &	trc,
		const IPosition &	inc,
		const Vector< Int > &	absRelBlc,
		const Vector< Int > &	absRelTrc
	)

casa::LCSlicer::LCSlicer

(

const LCSlicer &

other

)

Copy constructor (reference semantics).

casa::LCSlicer::~LCSlicer

(

)

---

Member Function Documentation

LCSlicer& casa::LCSlicer::operator=

(

const LCSlicer &

other

)

Assignment (copy semantics).

Bool casa::LCSlicer::operator==

(

const LCSlicer &

other

)

const

Test for equality.

True is returned when the given region is a slicer with exactly the same specification as this slicer. It does not compare the comment.

Bool casa::LCSlicer::operator!=

(

const LCSlicer &

other

)

const [inline]

Definition at line 236 of file LCSlicer.h.

Bool casa::LCSlicer::isComplete

(

)

const

The region is completely specified if it is absolute, not fractional, and has no unspecified values.

uInt casa::LCSlicer::ndim

(

)

const [inline]

Get the dimensionality of the region.

Definition at line 240 of file LCSlicer.h.

References itsBlc, and casa::ArrayBase::nelements().

const Vector< Float > & casa::LCSlicer::blc

(

)

const [inline]

Simple accessor functions.

Definition at line 244 of file LCSlicer.h.

References itsBlc.

const Vector< Float > & casa::LCSlicer::trc

(

)

const [inline]

Definition at line 248 of file LCSlicer.h.

References itsTrc.

const Vector< Float > & casa::LCSlicer::inc

(

)

const [inline]

Definition at line 252 of file LCSlicer.h.

References itsInc.

Bool casa::LCSlicer::isFractional

(

)

const [inline]

Definition at line 256 of file LCSlicer.h.

References itsIsFractional.

Bool casa::LCSlicer::isAbsolute

(

)

const [inline]

Definition at line 260 of file LCSlicer.h.

References itsIsAbsolute.

Bool casa::LCSlicer::isUnspecified

(

)

const [inline]

Definition at line 264 of file LCSlicer.h.

References itsIsUnspecified.

Bool casa::LCSlicer::isStrided

(

)

const [inline]

Definition at line 268 of file LCSlicer.h.

References itsIsStrided.

static String casa::LCSlicer::className

(

)

[static]

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

String casa::LCSlicer::type

(

)

const

Get the region type.

Returns className().

const String & casa::LCSlicer::comment

(

)

const [inline]

Get or set the comment.

Definition at line 272 of file LCSlicer.h.

References itsComment.

Referenced by setComment().

void casa::LCSlicer::setComment

(

const String &

comment

)

[inline]

Definition at line 276 of file LCSlicer.h.

References comment(), and itsComment.

Slicer casa::LCSlicer::toSlicer	(	const IPosition &	referencePixel,
		const IPosition &	latticeShape
	)			const

Make the region complete using the given reference pixel and shape.

It returns a new region where the relative regions are made absolute by translating them with respect to the reference pixel. Furthermore unspecified values are filled in and fractional values are turned into absolute ones.

Slicer casa::LCSlicer::toSlicer	(	const Vector< Double > &	referencePixel,
		const IPosition &	latticeShape
	)			const

Slicer casa::LCSlicer::toSlicer	(	const Vector< Float > &	referencePixel,
		const IPosition &	newLatticeShape
	)			const

TableRecord casa::LCSlicer::toRecord

(

const String &

tableName

)

const

Convert the object to a record.

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

Convert to correct object from a record.

void casa::LCSlicer::fillFlags	(	Bool	fractional,
		Int	absRel,
		uInt	nrblc,
		uInt	nrtrc,
		uInt	nrinc
	)			[private]

Fill the pixel based flags from the general ones.

void casa::LCSlicer::fillFromDouble	(	const Vector< Double > &	blc,
		const Vector< Double > &	trc,
		const Vector< Double > &	inc
	)			[private]

Fill the vectors from the values given as doubles.

void casa::LCSlicer::fillFromIPosition	(	const IPosition &	blc,
		const IPosition &	trc,
		const IPosition &	inc
	)			[private]

Fill the vectors from the values given as IPositions.

\.

void casa::LCSlicer::fill

(

)

[private]

Fill the remaining variables.

It also adjust the lengths of the vectors if they are different. Check if everything is given correctly.

---

Member Data Documentation

Vector<Float> casa::LCSlicer::itsBlc [private]

Definition at line 220 of file LCSlicer.h.

Referenced by blc(), and ndim().

Vector<Float> casa::LCSlicer::itsTrc [private]

Definition at line 221 of file LCSlicer.h.

Referenced by trc().

Vector<Float> casa::LCSlicer::itsInc [private]

Definition at line 222 of file LCSlicer.h.

Referenced by inc().

Vector<Bool> casa::LCSlicer::itsFracBlc [private]

Definition at line 223 of file LCSlicer.h.

Vector<Bool> casa::LCSlicer::itsFracTrc [private]

Definition at line 224 of file LCSlicer.h.

Vector<Bool> casa::LCSlicer::itsFracInc [private]

Definition at line 225 of file LCSlicer.h.

Vector<Int> casa::LCSlicer::itsAbsRelBlc [private]

Definition at line 226 of file LCSlicer.h.

Vector<Int> casa::LCSlicer::itsAbsRelTrc [private]

Definition at line 227 of file LCSlicer.h.

Bool casa::LCSlicer::itsIsFractional [private]

Definition at line 228 of file LCSlicer.h.

Referenced by isFractional().

Bool casa::LCSlicer::itsIsAbsolute [private]

Definition at line 229 of file LCSlicer.h.

Referenced by isAbsolute().

Bool casa::LCSlicer::itsIsUnspecified [private]

Definition at line 230 of file LCSlicer.h.

Referenced by isUnspecified().

Bool casa::LCSlicer::itsIsStrided [private]

Definition at line 231 of file LCSlicer.h.

Referenced by isStrided().

String casa::LCSlicer::itsComment [private]

Definition at line 232 of file LCSlicer.h.

Referenced by comment(), and setComment().

---

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

• lattices/implement/Lattices/LCSlicer.h

---