28 #ifndef LATTICES_LATTICESTEPPER_H 29 #define LATTICES_LATTICESTEPPER_H 32 #include <casacore/casa/aips.h> 33 #include <casacore/lattices/Lattices/LatticeNavigator.h> 34 #include <casacore/lattices/Lattices/LatticeIndexer.h> 35 #include <casacore/casa/Arrays/IPosition.h> 336 virtual void reset();
445 uInt maxCacheSize,
uInt bucketSize)
const;
A Vector of integers, for indexing into Array<T> objects.
virtual IPosition blc() const
Return the bottom left hand corner (blc), top right corner (trc) or step size (increment) used by the...
LatticeIndexer itsIndexer
void padCursor()
Pad the cursor to the right number of dimensions.
virtual IPosition position() const
Functions which return the current position of the beginning of the cursor.
virtual IPosition increment() const
LatticeStepper()
Prevent the default constructor from being used.
A helper class for stepping through Lattices.
virtual Bool atEnd() const
Function which returns "True" if an attempt has been made to increment the cursor beyond the end of t...
virtual uInt nsteps() const
Function to return the number of steps (increments & decrements) taken since construction (or since l...
virtual Bool hangOver() const
Function which returns "True" if the increment/decrement operators have moved the cursor position suc...
virtual Bool ok() const
Function which checks the internal data of this class for correct dimensionality and consistant value...
virtual LatticeNavigator * clone() const
Function which returns a pointer to dynamic memory of an exact copy of this instance.
virtual IPosition cursorAxes() const
Function which returns the axes of the cursor.
Traverse a Lattice by cursor shape.
virtual uInt calcCacheSize(const IPosition &cubeShape, const IPosition &tileShape, uInt maxCacheSize, uInt bucketSize) const
Calculate the cache size (in tiles) for this type of access to a lattice in the given row of the tile...
virtual IPosition trc() const
PAD is the default and means that the cursor size supplied by the user is kept fixed.
virtual IPosition endPosition() const
Functions which return the current position of the end of the cursor.
virtual IPosition latticeShape() const
Functions which return the shape of the Lattice being iterated through.
virtual IPosition relativeEndPosition() const
virtual void reset()
Function to move the cursor to the beginning of the (sub)-Lattice.
LatticeStepper & operator=(const LatticeStepper &other)
The assignment operator uses copy semantics.
void setCursorShape(const IPosition &cursorShape)
Functions to change the cursor shape to a new one.
virtual const IPosition & axisPath() const
Return the axis path.
bool Bool
Define the standard types used by Casacore.
Bool niceFit() const
Check if the cursor shape is a factor of the Lattice shape.
virtual Bool atStart() const
Function which returns "True" if the cursor is at the beginning of the (sub)-Lattice, otherwise, returns "False".
RESIZE means that the cursor shape is adjusted whenever it approaches the edges of the Lattice so tha...
virtual IPosition subLatticeShape() const
hangOverPolicy
The hangOverPolicy enumerator is used in the constructors to indicate what this class should do when ...
virtual void subSection(const IPosition &blc, const IPosition &trc)
Functions to specify a "section" of the Lattice to step over.
virtual IPosition relativePosition() const
this file contains all the compiler specific defines
Abstract base class to steer lattice iterators.
virtual IPosition cursorShape() const
Function which returns the shape of the cursor.