[ VIGRA Homepage | Function Index | Class Index | Namespaces | File List | Main Page ]
CoupledScanOrderIterator< N, HANDLES, DIMENSION > Class Template Reference |
Iterate over multiple images simultaneously in scan order. More...
#include <vigra/multi_iterator_coupled.hxx>
Public Types | |
typedef HANDLES | value_type |
Public Member Functions | |
template<unsigned int TARGET_INDEX> | |
CoupledHandleCast < TARGET_INDEX, value_type > ::type::reference | get () |
template<unsigned int TARGET_INDEX> | |
CoupledHandleCast < TARGET_INDEX, value_type > ::type::const_reference | get () const |
CoupledScanOrderIterator | getEndIterator () const |
Iterate over multiple images simultaneously in scan order.
The value type of this iterator is an instance of the handle class CoupledHandle. This allows to iterate over multiple arrays simultaneously. The coordinates can be accessed as a special band (index 0) in the handle. The scan-order is defined such that dimensions are iterated from front to back (first to last).
Instances of this class are usually constructed by calling createCoupledIterator() .
To get the type of a CoupledScanOrderIterator for arrays of a certain dimension and element types use CoupledIteratorType::type.
The iterator supports all functions listed in the STL documentation for Random Access Iterators.
Example of use:
#include <vigra/multi_iterator_coupled.hxx>
Namespace: vigra
typedef HANDLES value_type |
The type of the CoupledHandle.
CoupledScanOrderIterator getEndIterator | ( | ) | const |
Returns CoupledScanOrderIterator pointing beyond the last element.
CoupledHandleCast<TARGET_INDEX, value_type>::type::reference get | ( | ) |
Returns reference to the element in the band with index TARGET_INDEX.
CoupledHandleCast<TARGET_INDEX, value_type>::type::const_reference get | ( | ) | const |
Returns constant reference to the element in the band with index TARGET_INDEX.
© Ullrich Köthe (ullrich.koethe@iwr.uni-heidelberg.de) |
html generated using doxygen and Python
|