casacore::ExtendSpecifier Class Reference

Specification of new and stretched lattice axes. More...

#include <ExtendSpecifier.h>

Public Member Functions
	ExtendSpecifier ()
	Default constructor generates empty IPositions. More...
	ExtendSpecifier (const IPosition &oldShape, const IPosition &newShape, const IPosition &newAxes, const IPosition &stretchAxes)
	Tell if no or all degenerate axes have to be removed. More...
	ExtendSpecifier (const ExtendSpecifier &other)
	Copy constructor (copy semantics). More...
	~ExtendSpecifier ()
ExtendSpecifier &	operator= (const ExtendSpecifier &other)
	Assignment (copy semantics). More...
const IPosition &	newShape () const
	Return the new shape. More...
const IPosition &	newAxes () const
	Return the new axes. More...
const IPosition &	stretchAxes () const
	Return the axes to be stretched. More...
const IPosition &	oldShape () const
	Return the old shape. More...
const IPosition &	extendAxes () const
	Return the axes to be extended (i.e. More...
const IPosition &	oldOldAxes () const
	Return the old axes (i.e. More...
const IPosition &	oldNewAxes () const
	Return the old axes as in new shape. More...
Slicer	convert (IPosition &shape, const Slicer &section) const
	Convert the slicer to the specification for the old shape. More...
IPosition	convertNew (const IPosition &oldShape) const
	Convert a shape to the specification for the new shape. More...

Private Member Functions
void	fill (Block< Bool > &flags, const IPosition &axes) const
	Fill the flags for the given axes. More...

Private Attributes
IPosition	itsOldShape
IPosition	itsNewShape
IPosition	itsNewAxes
IPosition	itsStretchAxes
IPosition	itsExtendAxes
IPosition	itsOldOldAxes
IPosition	itsOldNewAxes

Detailed Description

Specification of new and stretched lattice axes.

Intended use:

Internal

Review Status

Date Reviewed:

yyyy/mm/dd

Test programs:

tExtendSpecifier

Prerequisite

• IPosition

Synopsis

ExtendSpecifier is a class internally used by class ExtendLattice. It holds the information which axes are stretched and which axes are new. Note that a stretched axis has to have length 1 in the original shape.

The class only contains the functionality needed by ExtendLattice. which are (mainly) 2 conversion functions. One function converts a slicer from the extended lattice to the original lattice, so ExtendLattice can read the correct data. The other function converts a shape in the original lattice to the shape in the extended lattice.
Some data is precalculated for more efficient processing of the conversion of slicers and shapes.

Example

IPosition oldShape(4,10,1,3,1);
IPosition newShape(5,10,1,5,3,8);
ExtendSpecifier spec (oldShape, newShape, IPosition(1,2), IPosition(1,4));

This example extends the old shape to the new shape.
The 3rd argument tells that axes 2 is new. The newShape tells that its length will be 5. Note that adding this axis means that axes 2 in the old shape will get axes 3 in the new shape.
The 4th argument tells that axes 4 (in the new shape!!) is stretched (to 8 according to newShape).

Definition at line 90 of file ExtendSpecifier.h.

Constructor & Destructor Documentation

casacore::ExtendSpecifier::ExtendSpecifier

(

)

Default constructor generates empty IPositions.

casacore::ExtendSpecifier::ExtendSpecifier	(	const IPosition &	oldShape,
		const IPosition &	newShape,
		const IPosition &	newAxes,
		const IPosition &	stretchAxes
	)

Tell if no or all degenerate axes have to be removed.

casacore::ExtendSpecifier::ExtendSpecifier

(

const ExtendSpecifier &

other

)

Copy constructor (copy semantics).

casacore::ExtendSpecifier::~ExtendSpecifier

(

)

Member Function Documentation

Slicer casacore::ExtendSpecifier::convert	(	IPosition &	shape,
		const Slicer &	section
	)		const

Convert the slicer to the specification for the old shape.

It fills shape with the shape to reform the section length such that it contains the new axes.

IPosition casacore::ExtendSpecifier::convertNew

(

const IPosition &

oldShape

)

const

Convert a shape to the specification for the new shape.

const IPosition& casacore::ExtendSpecifier::extendAxes ( ) const

inline

Return the axes to be extended (i.e.

new and stretch axes).

Definition at line 128 of file ExtendSpecifier.h.

References itsExtendAxes.

void casacore::ExtendSpecifier::fill ( Block< Bool > &  flags, const IPosition &  axes  ) const

private

Fill the flags for the given axes.

It throws an exception if the axis is invalid or multiply given.

const IPosition& casacore::ExtendSpecifier::newAxes ( ) const

inline

Return the new axes.

Definition at line 116 of file ExtendSpecifier.h.

References itsNewAxes.

const IPosition& casacore::ExtendSpecifier::newShape ( ) const

inline

Return the new shape.

Definition at line 112 of file ExtendSpecifier.h.

References itsNewShape.

const IPosition& casacore::ExtendSpecifier::oldNewAxes ( ) const

inline

Return the old axes as in new shape.

Definition at line 136 of file ExtendSpecifier.h.

References itsOldNewAxes.

const IPosition& casacore::ExtendSpecifier::oldOldAxes ( ) const

inline

Return the old axes (i.e.

axes new nor stretched) as in old shape.

Definition at line 132 of file ExtendSpecifier.h.

References itsOldOldAxes.

const IPosition& casacore::ExtendSpecifier::oldShape ( ) const

inline

Return the old shape.

Definition at line 124 of file ExtendSpecifier.h.

References itsOldShape.

ExtendSpecifier& casacore::ExtendSpecifier::operator=

(

const ExtendSpecifier &

other

)

Assignment (copy semantics).

This and that do not have to have the same length.

const IPosition& casacore::ExtendSpecifier::stretchAxes ( ) const

inline

Return the axes to be stretched.

Definition at line 120 of file ExtendSpecifier.h.

References itsStretchAxes.

Member Data Documentation

IPosition casacore::ExtendSpecifier::itsExtendAxes

private

Definition at line 157 of file ExtendSpecifier.h.

Referenced by extendAxes().

IPosition casacore::ExtendSpecifier::itsNewAxes

private

Definition at line 155 of file ExtendSpecifier.h.

Referenced by newAxes().

IPosition casacore::ExtendSpecifier::itsNewShape

private

Definition at line 154 of file ExtendSpecifier.h.

Referenced by newShape().

IPosition casacore::ExtendSpecifier::itsOldNewAxes

private

Definition at line 159 of file ExtendSpecifier.h.

Referenced by oldNewAxes().

IPosition casacore::ExtendSpecifier::itsOldOldAxes

private

Definition at line 158 of file ExtendSpecifier.h.

Referenced by oldOldAxes().

IPosition casacore::ExtendSpecifier::itsOldShape

private

Definition at line 153 of file ExtendSpecifier.h.

Referenced by oldShape().

IPosition casacore::ExtendSpecifier::itsStretchAxes

private

Definition at line 156 of file ExtendSpecifier.h.

Referenced by stretchAxes().

---

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

• casa/casacore/casa/Arrays/ExtendSpecifier.h