[ VIGRA Homepage | Function Index | Class Index | Namespaces | File List | Main Page ]

details ConstValueIterator< PIXELTYPE > Class Template Reference VIGRA

Iterator that always returns the constant specified in the constructor. More...

#include <vigra/imageiterator.hxx>

Public Types

typedef IteratorAdaptor< ConstValueIteratorPolicy< PIXELTYPE > > column_iterator
 
typedef Diff2D difference_type
 
typedef PIXELTYPE const & index_reference
 
typedef image_traverser_tag iterator_category
 
typedef std::ptrdiff_t MoveX
 
typedef std::ptrdiff_t MoveY
 
typedef PIXELTYPE PixelType
 
typedef PIXELTYPE const * pointer
 
typedef PIXELTYPE const & reference
 
typedef IteratorAdaptor< ConstValueIteratorPolicy< PIXELTYPE > > row_iterator
 
typedef PIXELTYPE value_type
 

Public Member Functions

column_iterator columnIterator () const
 
 ConstValueIterator ()
 
 ConstValueIterator (PixelType const &v)
 
 ConstValueIterator (ConstValueIterator const &v)
 
bool operator!= (ConstValueIterator const &r) const
 
index_reference operator() (std::ptrdiff_t const &, std::ptrdiff_t const &) const
 
reference operator* () const
 
ConstValueIterator operator+ (Diff2D const &d) const
 
ConstValueIteratoroperator+= (Diff2D const &d)
 
ConstValueIterator operator- (Diff2D const &d) const
 
Diff2D operator- (ConstValueIterator const &r) const
 
ConstValueIteratoroperator-= (Diff2D const &d)
 
pointer operator-> () const
 
ConstValueIteratoroperator= (ConstValueIterator const &v)
 
bool operator== (ConstValueIterator const &r) const
 
index_reference operator[] (Diff2D const &) const
 
row_iterator rowIterator () const
 

Public Attributes

Specify coordinate direction for navigation commands
std::ptrdiff_t x
 refer to x coordinate
 
std::ptrdiff_t y
 refer to y coordinate
 

Detailed Description

template<class PIXELTYPE>
class vigra::ConstValueIterator< PIXELTYPE >

Iterator that always returns the constant specified in the constructor.

This iterator can be used to simulate an image that does not actually exist.

#include <vigra/imageiterator.hxx>
Namespace: vigra

Member Typedef Documentation

§ value_type

typedef PIXELTYPE value_type

The type of the constant the iterator holds.

§ PixelType

typedef PIXELTYPE PixelType

The type of the constant the iterator holds.

§ reference

typedef PIXELTYPE const& reference

the iterator's reference type (return type of *iter)

§ index_reference

typedef PIXELTYPE const& index_reference

the iterator's index reference type (return type of iter[diff])

§ pointer

typedef PIXELTYPE const* pointer

the iterator's pointer type (return type of iter.operator->())

§ difference_type

the iterator's difference type (argument type of iter[diff])

§ iterator_category

typedef image_traverser_tag iterator_category

the iterator tag (image traverser)

§ row_iterator

typedef IteratorAdaptor<ConstValueIteratorPolicy<PIXELTYPE> > row_iterator

The associated row iterator.

§ column_iterator

typedef IteratorAdaptor<ConstValueIteratorPolicy<PIXELTYPE> > column_iterator

The associated column iterator.

§ MoveX

typedef std::ptrdiff_t MoveX

Let operations act in X direction

§ MoveY

typedef std::ptrdiff_t MoveY

Let operations act in Y direction

Constructor & Destructor Documentation

§ ConstValueIterator() [1/3]

Default Constructor. (the constant is set to NumericTraits<PIXELTYPE>::zero() )

§ ConstValueIterator() [2/3]

ConstValueIterator ( PixelType const &  v)

Construct with given constant.

§ ConstValueIterator() [3/3]

ConstValueIterator ( ConstValueIterator< PIXELTYPE > const &  v)

Copy Constructor.

Member Function Documentation

§ operator=()

ConstValueIterator& operator= ( ConstValueIterator< PIXELTYPE > const &  v)

Copy Assigment.

§ operator+=()

ConstValueIterator& operator+= ( Diff2D const &  d)

Move iterator by specified distance.

§ operator-=()

ConstValueIterator& operator-= ( Diff2D const &  d)

Move iterator by specified distance.

§ operator+()

ConstValueIterator operator+ ( Diff2D const &  d) const

Create iterator at specified distance.

§ operator-() [1/2]

ConstValueIterator operator- ( Diff2D const &  d) const

Create iterator at specified distance.

§ operator-() [2/2]

Diff2D operator- ( ConstValueIterator< PIXELTYPE > const &  r) const

Compute distance between two iterators

§ operator==()

bool operator== ( ConstValueIterator< PIXELTYPE > const &  r) const

Equality.

§ operator!=()

bool operator!= ( ConstValueIterator< PIXELTYPE > const &  r) const

Inequality.

§ operator*()

reference operator* ( ) const

Read current pixel (return specified constant).

§ operator->()

pointer operator-> ( ) const

Call member function for stored constant.

§ operator()()

index_reference operator() ( std::ptrdiff_t const &  ,
std::ptrdiff_t const &   
) const

Read pixel at a distance (return specified constant).

§ operator[]()

index_reference operator[] ( Diff2D const &  ) const

Read pixel at a distance (return specified constant).

§ rowIterator()

row_iterator rowIterator ( ) const

Get row iterator at current position (which will also hold the constant).

§ columnIterator()

column_iterator columnIterator ( ) const

Get column iterator at current position (which will also hold the constant).


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

© Ullrich Köthe (ullrich.koethe@iwr.uni-heidelberg.de)
Heidelberg Collaboratory for Image Processing, University of Heidelberg, Germany

html generated using doxygen and Python
vigra 1.11.0