Go to the documentation of this file.
28 #ifndef LATTICES_LATTICEITERATOR_H
29 #define LATTICES_LATTICEITERATOR_H
32 #include <casacore/casa/aips.h>
33 #include <casacore/lattices/Lattices/Lattice.h>
34 #include <casacore/lattices/Lattices/LatticeIterInterface.h>
35 #include <casacore/casa/Utilities/CountedPtr.h>
41 class LatticeNavigator;
42 template <
class T>
class Array;
43 template <
class T>
class Cube;
44 template <
class T>
class Matrix;
45 template <
class T>
class Vector;
525 #ifndef CASACORE_NO_AUTO_TEMPLATES
526 #include <casacore/lattices/Lattices/Lattice.tcc>
527 #include <casacore/lattices/Lattices/LatticeIterator.tcc>
528 #endif //# CASACORE_NO_AUTO_TEMPLATES
A 2-D Specialization of the Array class.
LatticeIterator(Lattice< T > &data, const LatticeNavigator &method, Bool useRef=True)
Construct the Iterator with the supplied data, and iteration strategy.
A Vector of integers, for indexing into Array<T> objects.
LatticeIterator< T > & operator=(const LatticeIterator< T > &other)
Assignment uses reference semantics (ie.
Cube< T > & woCubeCursor()
Bool operator++()
Increment operator - increment the cursor to the next position.
Matrix< T > & rwMatrixCursor()
Cube< T > & rwCubeCursor()
Referenced counted pointer for constant data.
Bool ok() const
Function which checks the internals of the class for consistency.
Bool isNull() const
Is the iterator object empty?
LatticeIterator(Lattice< T > &data, const IPosition &cursorShape, Bool useRef=True)
Iterate through the data with a LatticeStepper that has uses the supplied cursorShape.
A read/write lattice iterator.
RO_LatticeIterator(const RO_LatticeIterator< T > &other)
The copy constructor uses reference semantics (ie.
~LatticeIterator()
destructor (cleans up dangling references and releases memory)
LatticeIterator(Lattice< T > &data, Bool useRef=True)
Construct the Iterator with the supplied data.
LatticeIterator()
The default constructor creates an empty object which is practically unusable.
A 3-D Specialization of the Array class.
Bool atEnd() const
Function which returns a value of "True" if an attempt has been made to move the cursor beyond the en...
Bool ok() const
Function which checks the internals of the class for consistency.
Abstract base class to steer lattice iterators.
IPosition cursorShape() const
Function which returns the shape of the cursor which is iterating through the Lattice.
A readonly iterator for Lattices.
uInt nsteps() const
Function to return the number of steps (increments or decrements) taken since construction (or since ...
IPosition endPosition() const
Function which returns the current position of the end of the cursor.
Lattice< T > & lattice() const
Return the underlying lattice.
const Cube< T > & cubeCursor() const
const Vector< T > & vectorCursor() const
Functions which returns a window to the data in the Lattice.
const Matrix< T > & matrixCursor() const
this file contains all the compiler specific defines
Bool operator--()
Decrement operator - decrement the cursor to the previous position.
Vector< T > & woVectorCursor()
~RO_LatticeIterator()
Destructor (cleans up dangling references and releases memory)
RO_LatticeIterator< T > copy() const
Make a copy of the iterator object.
A templated, abstract base class for array-like objects.
template <class T, class U> class vector;
LatticeIterator(const LatticeIterator< T > &other)
The copy constructor uses reference semantics (ie.
Bool atStart() const
Function which returns a value of "True" if the cursor is at the beginning of the Lattice,...
bool Bool
Define the standard types used by Casacore.
RO_LatticeIterator(const Lattice< T > &data, const LatticeNavigator &method, Bool useRef=True)
Construct the Iterator with the supplied data, and iteration strategy.
CountedPtr< LatticeIterInterface< T > > itsIterPtr
The pointer to the Iterator.
Matrix< T > & woMatrixCursor()
IPosition latticeShape() const
Function which returns the shape of the Lattice being iterated through.
A 1-D Specialization of the Array class.
const Array< T > & cursor() const
RO_LatticeIterator< T > & operator=(const RO_LatticeIterator< T > &other)
Assignment uses reference semantics (ie.
IPosition position() const
Function which returns the current position of the beginning of the cursor within the Lattice.
Vector< T > & rwVectorCursor()
Functions to return a window to the data in the Lattice.
RO_LatticeIterator(const Lattice< T > &data, Bool useRef=True)
Construct the Iterator with the supplied data.
LatticeIterator< T > copy() const
Make a copy of the iterator object.
RO_LatticeIterator()
The default constructor creates an empty object which is practically unusable.
RO_LatticeIterator(const Lattice< T > &data, const IPosition &cursorShape, Bool useRef=True)
Construct the Iterator with the supplied data.
void reset()
Function which resets the cursor to the beginning of the Lattice and resets the number of steps taken...