#include <LCSlicer.h>

Public Member Functions
	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).
	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)
	LCSlicer (const LCSlicer &other)
	Copy constructor (reference semantics).
	~LCSlicer ()
LCSlicer &	operator= (const LCSlicer &other)
	Assignment (copy semantics).
Bool	operator== (const LCSlicer &other) const
	Test for equality.
Bool	operator!= (const LCSlicer &other) const
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.
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
String	type () const
	Get the region type.
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
TableRecord	toRecord (const String &tableName) const
	Convert the object to a record.

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

Detailed Description

Class to define a rectangular box of interest with strides.

Intended use:

Public interface

Prerequisite

Slicer

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 can be defined from an Slicer 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

Definition at line 81 of file LCSlicer.h.

Constructor & Destructor Documentation

◆ LCSlicer() [1/12]

casacore::LCSlicer::LCSlicer ( )

Referenced by fromRecord(), LCSlicer(), operator!=(), operator=(), and operator==().

◆ LCSlicer() [2/12]

casacore::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.
For each axis (or all axes) it can be defined if the blc/trc are given as pixel coordinates or as fractional values between 0 and 1. In the latter case the true pixel coordinate is derived from the image shape.
Also the region type can be given, if needed per axis.

RegionType::Abs is absolute
RegionType::RelRef is relative to reference pixel given in toSlice().
RegionType::RelCen is relative to image center.

References casacore::RegionType::Abs, blc(), casacore::False, and trc().

◆ LCSlicer() [3/12]

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

References casacore::RegionType::Abs, blc(), casacore::False, inc(), and trc().

◆ LCSlicer() [4/12]

casacore::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 )

References blc(), inc(), and trc().

◆ LCSlicer() [5/12]

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

References casacore::RegionType::Abs, blc(), casacore::False, and trc().

◆ LCSlicer() [6/12]

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

References casacore::RegionType::Abs, blc(), casacore::False, inc(), and trc().

◆ LCSlicer() [7/12]

casacore::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 )

References blc(), inc(), and trc().

◆ LCSlicer() [8/12]

casacore::LCSlicer::LCSlicer ( const Slicer & slicer )

◆ LCSlicer() [9/12]

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

References casacore::RegionType::Abs, blc(), and trc().

◆ LCSlicer() [10/12]

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

References casacore::RegionType::Abs, blc(), inc(), and trc().

◆ LCSlicer() [11/12]

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

References blc(), inc(), and trc().

◆ LCSlicer() [12/12]

casacore::LCSlicer::LCSlicer ( const LCSlicer & other )

Copy constructor (reference semantics).

References LCSlicer().

◆ ~LCSlicer()

casacore::LCSlicer::~LCSlicer ( )

Member Function Documentation

◆ blc()

const Vector< Float > & casacore::LCSlicer::blc ( ) const

inline

Simple accessor functions.

Definition at line 221 of file LCSlicer.h.

References itsBlc.

Referenced by fillFromDouble(), fillFromIPosition(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), and LCSlicer().

◆ className()

String casacore::LCSlicer::className ( )

static

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

◆ comment()

const String & casacore::LCSlicer::comment ( ) const

inline

Get or set the comment.

Definition at line 228 of file LCSlicer.h.

References itsComment.

Referenced by setComment(), and type().

◆ fill()

void casacore::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.

◆ fillFlags()

void casacore::LCSlicer::fillFlags	(	Bool	fractional,
		Int	absRel,
		uInt	nrblc,
		uInt	nrtrc,
		uInt	nrinc )

private

Fill the pixel based flags from the general ones.

◆ fillFromDouble()

void casacore::LCSlicer::fillFromDouble	(	const Vector< Double > &	blc,
		const Vector< Double > &	trc,
		const Vector< Double > &	inc )

private

Fill the vectors from the values given as doubles.

References blc(), inc(), and trc().

◆ fillFromIPosition()

void casacore::LCSlicer::fillFromIPosition	(	const IPosition &	blc,
		const IPosition &	trc,
		const IPosition &	inc )

private

Fill the vectors from the values given as IPositions.

References blc(), inc(), and trc().

◆ fromRecord()

LCSlicer * casacore::LCSlicer::fromRecord	(	const TableRecord &	,
		const String &	tablename )

static

Convert to correct object from a record.

References LCSlicer().

◆ inc()

const Vector< Float > & casacore::LCSlicer::inc ( ) const

inline

Definition at line 223 of file LCSlicer.h.

References itsInc.

Referenced by fillFromDouble(), fillFromIPosition(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), and LCSlicer().

◆ isAbsolute()

Bool casacore::LCSlicer::isAbsolute ( ) const

inline

Definition at line 225 of file LCSlicer.h.

References itsIsAbsolute.

◆ isComplete()

Bool casacore::LCSlicer::isComplete ( ) const

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

◆ isFractional()

Bool casacore::LCSlicer::isFractional ( ) const

inline

Definition at line 224 of file LCSlicer.h.

References itsIsFractional.

◆ isStrided()

Bool casacore::LCSlicer::isStrided ( ) const

inline

Definition at line 227 of file LCSlicer.h.

References itsIsStrided.

◆ isUnspecified()

Bool casacore::LCSlicer::isUnspecified ( ) const

inline

Definition at line 226 of file LCSlicer.h.

References itsIsUnspecified.

◆ ndim()

uInt casacore::LCSlicer::ndim ( ) const

inline

Get the dimensionality of the region.

Definition at line 220 of file LCSlicer.h.

References itsBlc.

◆ operator!=()

Bool casacore::LCSlicer::operator!= ( const LCSlicer & other ) const

inline

Definition at line 219 of file LCSlicer.h.

References LCSlicer().

◆ operator=()

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

Assignment (copy semantics).

References LCSlicer().

◆ operator==()

Bool casacore::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.

References LCSlicer().

◆ setComment()

void casacore::LCSlicer::setComment ( const String & comment )

inline

Definition at line 229 of file LCSlicer.h.

References comment(), and itsComment.

◆ toRecord()

TableRecord casacore::LCSlicer::toRecord ( const String & tableName ) const

Convert the object to a record.

◆ toSlicer() [1/3]

Slicer casacore::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.

◆ toSlicer() [2/3]

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

◆ toSlicer() [3/3]

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

◆ trc()

const Vector< Float > & casacore::LCSlicer::trc ( ) const

inline

Definition at line 222 of file LCSlicer.h.

References itsTrc.

Referenced by fillFromDouble(), fillFromIPosition(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), LCSlicer(), and LCSlicer().

◆ type()

String casacore::LCSlicer::type ( ) const

Get the region type.

Returns className().

References comment().

Member Data Documentation

◆ itsAbsRelBlc

Vector<Int> casacore::LCSlicer::itsAbsRelBlc

private

Definition at line 210 of file LCSlicer.h.

◆ itsAbsRelTrc

Vector<Int> casacore::LCSlicer::itsAbsRelTrc

private

Definition at line 211 of file LCSlicer.h.

◆ itsBlc

Vector<Float> casacore::LCSlicer::itsBlc

private

Definition at line 204 of file LCSlicer.h.

Referenced by blc(), and ndim().

◆ itsComment

String casacore::LCSlicer::itsComment

private

Definition at line 216 of file LCSlicer.h.

Referenced by comment(), and setComment().

◆ itsFracBlc

Vector<Bool> casacore::LCSlicer::itsFracBlc

private

Definition at line 207 of file LCSlicer.h.

◆ itsFracInc

Vector<Bool> casacore::LCSlicer::itsFracInc

private

Definition at line 209 of file LCSlicer.h.

◆ itsFracTrc

Vector<Bool> casacore::LCSlicer::itsFracTrc

private

Definition at line 208 of file LCSlicer.h.

◆ itsInc

Vector<Float> casacore::LCSlicer::itsInc

private

Definition at line 206 of file LCSlicer.h.

Referenced by inc().

◆ itsIsAbsolute

Bool casacore::LCSlicer::itsIsAbsolute

private

Definition at line 213 of file LCSlicer.h.

Referenced by isAbsolute().

◆ itsIsFractional

Bool casacore::LCSlicer::itsIsFractional

private

Definition at line 212 of file LCSlicer.h.

Referenced by isFractional().

◆ itsIsStrided

Bool casacore::LCSlicer::itsIsStrided

private

Definition at line 215 of file LCSlicer.h.

Referenced by isStrided().

◆ itsIsUnspecified

Bool casacore::LCSlicer::itsIsUnspecified

private

Definition at line 214 of file LCSlicer.h.

Referenced by isUnspecified().

◆ itsTrc

Vector<Float> casacore::LCSlicer::itsTrc

private

Definition at line 205 of file LCSlicer.h.

Referenced by trc().

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

lattices/LRegions/LCSlicer.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Intended use:

Prerequisite

Synopsis

Example

Constructor & Destructor Documentation

◆ LCSlicer() [1/12]

◆ LCSlicer() [2/12]

◆ LCSlicer() [3/12]

◆ LCSlicer() [4/12]

◆ LCSlicer() [5/12]

◆ LCSlicer() [6/12]

◆ LCSlicer() [7/12]

◆ LCSlicer() [8/12]

◆ LCSlicer() [9/12]

◆ LCSlicer() [10/12]

◆ LCSlicer() [11/12]

◆ LCSlicer() [12/12]

◆ ~LCSlicer()

Member Function Documentation

◆ blc()

◆ className()

◆ comment()

◆ fill()

◆ fillFlags()

◆ fillFromDouble()

◆ fillFromIPosition()

◆ fromRecord()

◆ inc()

◆ isAbsolute()

◆ isComplete()

◆ isFractional()

◆ isStrided()

◆ isUnspecified()

◆ ndim()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ setComment()

◆ toRecord()

◆ toSlicer() [1/3]

◆ toSlicer() [2/3]

◆ toSlicer() [3/3]

◆ trc()

◆ type()

Member Data Documentation

◆ itsAbsRelBlc

◆ itsAbsRelTrc

◆ itsBlc

◆ itsComment

◆ itsFracBlc

◆ itsFracInc

◆ itsFracTrc

◆ itsInc

◆ itsIsAbsolute

◆ itsIsFractional

◆ itsIsStrided

◆ itsIsUnspecified

◆ itsTrc