ExtendSpecifier.h

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).

Member Description

ExtendSpecifier()

Default constructor generates empty IPositions.

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

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

ExtendSpecifier(const ExtendSpecifier& other)

Copy constructor (copy semantics).

~ExtendSpecifier()

ExtendSpecifier& operator= (const ExtendSpecifier& other)

Assignment (copy semantics). This and that do not have to have the same length.

const IPosition& newShape() const

Return the new shape.

const IPosition& newAxes() const

Return the new axes.

const IPosition& stretchAxes() const

Return the axes to be stretched.

const IPosition& oldShape() const

Return the old shape.

const IPosition& extendAxes() const

Return the axes to be extended (i.e. new and stretch axes).

const IPosition& oldOldAxes() const

Return the old axes (i.e. axes new nor stretched) as in old shape.

const IPosition& oldNewAxes() const

Return the old axes as in new shape.

Slicer 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 convertNew (const IPosition& oldShape) const

Convert a shape to the specification for the new shape.

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

Fill the flags for the given axes. It throws an exception if the axis is invalid or multiply given.