te::rst::ConstBandIterator< T > Class Template Reference

This class implements an iterator to "navigate" over a single band (const). More...

#include <BandIterator.h>

Inheritance diagram for te::rst::ConstBandIterator< T >:
te::rst::AbstractBandIterator< T >

Public Member Functions

 ConstBandIterator ()
 Constructor. More...
 
 ConstBandIterator (const Band *b)
 Constructor. More...
 
 ConstBandIterator (const ConstBandIterator &rhs)
 Copy constructor. More...
 
unsigned int getColumn () const
 Returns the current column in iterator. More...
 
unsigned int getRow () const
 Returns the current row in iterator. More...
 
bool operator!= (const AbstractBandIterator &rhs) const
 Difference operator. More...
 
const T operator* () const
 Returns the value in current position (column, row) from iterator. More...
 
virtual void operator++ ()
 Advances to the next position. More...
 
void operator-- ()
 Returns to the previous position. More...
 
ConstBandIteratoroperator= (const ConstBandIterator &rhs)
 Assignment operator. More...
 
void replaceBlock ()
 Replaces the current bufferized block values. More...
 

Static Public Member Functions

static ConstBandIterator begin (const Band *b)
 Returns an iterator referring to the first value of the band. More...
 
static ConstBandIterator end (const Band *b)
 Returns an iterator referring to after the end of the iterator. More...
 

Protected Attributes

const Bandm_band
 The band from where to get the values. More...
 
T * m_blk
 Internal block. More...
 
int m_blkh
 The internal block height. More...
 
int m_blksize
 The block size of the band. More...
 
int m_blkw
 The internal block width. More...
 
int m_blkx
 The position in X of the current block. More...
 
int m_blky
 The position in Y of the current block. More...
 
te::rst::GetBufferValueFPtr m_getBuff
 A pointer to a function that helps to extract a double or complex value from a specific buffer data type (char, int16, int32, float, ...). More...
 
te::rst::GetBufferValueFPtr m_getBuffI
 A pointer to a function that helps to extract the imaginary part value from a specific buffer data type (cint16, cint32, cfloat, cdouble). More...
 
int m_i
 The actual position inside the block. More...
 
int m_lastblksize
 The number of pixels inside the last block. More...
 
int m_nblocksx
 The number of blocks in X direction. More...
 
int m_nblocksy
 The number of blocks in Y direction. More...
 
int m_npxlsblk
 The maximum number of pixels inside the block. More...
 
te::rst::SetBufferValueFPtr m_setBuff
 A pointer to a function that helps to insert a double or complex value into a specific buffer data type (char, int16, int32, float, ...). More...
 
te::rst::SetBufferValueFPtr m_setBuffI
 A pointer to a function that helps to insert the imaginary part value into a specific buffer data type (cint16, cint32, cfloat, cdouble). More...
 

Detailed Description

template<class T>
class te::rst::ConstBandIterator< T >

This class implements an iterator to "navigate" over a single band (const).

We provide an efficient method to obtain all values in a raster, without regard to their locations. The implementation navigates through the blocks of the image.

See also
te::rst::Band

Definition at line 211 of file BandIterator.h.

Constructor & Destructor Documentation

template<class T >
te::rst::ConstBandIterator< T >::ConstBandIterator ( )

Constructor.

Definition at line 552 of file BandIterator.h.

template<class T >
te::rst::ConstBandIterator< T >::ConstBandIterator ( const Band b)

Constructor.

Parameters
bThe band to iterate.

Definition at line 558 of file BandIterator.h.

References te::rst::AbstractBandIterator< T >::m_blksize, and te::rst::ConstBandIterator< T >::replaceBlock().

template<class T >
te::rst::ConstBandIterator< T >::ConstBandIterator ( const ConstBandIterator< T > &  rhs)

Copy constructor.

Parameters
rhsThe right-hand-side copy used to copy from.

Definition at line 566 of file BandIterator.h.

References te::rst::AbstractBandIterator< T >::m_blksize, and te::rst::ConstBandIterator< T >::replaceBlock().

Member Function Documentation

template<class T >
te::rst::ConstBandIterator< T > te::rst::ConstBandIterator< T >::begin ( const Band b)
static

Returns an iterator referring to the first value of the band.

Definition at line 592 of file BandIterator.h.

template<class T >
te::rst::ConstBandIterator< T > te::rst::ConstBandIterator< T >::end ( const Band b)
static

Returns an iterator referring to after the end of the iterator.

Definition at line 597 of file BandIterator.h.

References te::rst::Band::getProperty(), te::rst::AbstractBandIterator< T >::m_blky, and te::rst::BandProperty::m_nblocksy.

template<class T >
unsigned int te::rst::AbstractBandIterator< T >::getColumn ( ) const
inherited

Returns the current column in iterator.

Definition at line 394 of file BandIterator.h.

template<class T >
unsigned int te::rst::AbstractBandIterator< T >::getRow ( ) const
inherited

Returns the current row in iterator.

Definition at line 389 of file BandIterator.h.

template<class T >
bool te::rst::AbstractBandIterator< T >::operator!= ( const AbstractBandIterator< T > &  rhs) const
inherited

Difference operator.

Parameters
rhsThe right-hand side to compare.
Returns
Returns true if the iterators are at different positions, or false otherwise.

Definition at line 477 of file BandIterator.h.

References te::rst::AbstractBandIterator< T >::m_blky.

template<class T >
const T te::rst::ConstBandIterator< T >::operator* ( ) const
virtual

Returns the value in current position (column, row) from iterator.

Implements te::rst::AbstractBandIterator< T >.

Definition at line 574 of file BandIterator.h.

template<class T >
void te::rst::AbstractBandIterator< T >::operator++ ( )
virtualinherited

Advances to the next position.

Reimplemented in te::rst::BandIteratorWithMask< T >.

Definition at line 399 of file BandIterator.h.

Referenced by te::rst::BandIteratorWithMask< T >::operator++().

template<class T >
void te::rst::AbstractBandIterator< T >::operator-- ( )
inherited

Returns to the previous position.

Definition at line 428 of file BandIterator.h.

Referenced by te::rst::BandIteratorWithMask< T >::operator--().

template<class T >
te::rst::ConstBandIterator< T > & te::rst::ConstBandIterator< T >::operator= ( const ConstBandIterator< T > &  rhs)

Assignment operator.

Parameters
rhsThe right-hand-side copy used to copy from.
Returns
A reference to this object.

Definition at line 583 of file BandIterator.h.

References te::rst::ConstBandIterator< T >::m_band, and te::rst::AbstractBandIterator< T >::operator=().

template<class T >
void te::rst::ConstBandIterator< T >::replaceBlock ( )
virtual

Replaces the current bufferized block values.

Implements te::rst::AbstractBandIterator< T >.

Definition at line 606 of file BandIterator.h.

Referenced by te::rst::ConstBandIterator< T >::ConstBandIterator().

Member Data Documentation

template<class T>
const Band* te::rst::ConstBandIterator< T >::m_band
protected

The band from where to get the values.

Definition at line 255 of file BandIterator.h.

Referenced by te::rst::ConstBandIterator< T >::operator=().

template<class T>
T* te::rst::AbstractBandIterator< T >::m_blk
protectedinherited

Internal block.

Definition at line 128 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator().

template<class T>
int te::rst::AbstractBandIterator< T >::m_blkh
protectedinherited

The internal block height.

Definition at line 119 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::operator=().

template<class T>
int te::rst::AbstractBandIterator< T >::m_blkw
protectedinherited

The internal block width.

Definition at line 118 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::operator=().

template<class T>
int te::rst::AbstractBandIterator< T >::m_blkx
protectedinherited

The position in X of the current block.

Definition at line 124 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::operator=().

template<class T>
te::rst::GetBufferValueFPtr te::rst::AbstractBandIterator< T >::m_getBuff
protectedinherited

A pointer to a function that helps to extract a double or complex value from a specific buffer data type (char, int16, int32, float, ...).

Definition at line 129 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator().

template<class T>
te::rst::GetBufferValueFPtr te::rst::AbstractBandIterator< T >::m_getBuffI
protectedinherited

A pointer to a function that helps to extract the imaginary part value from a specific buffer data type (cint16, cint32, cfloat, cdouble).

Definition at line 130 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator().

template<class T>
int te::rst::AbstractBandIterator< T >::m_i
protectedinherited

The actual position inside the block.

Definition at line 123 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::operator=().

template<class T>
int te::rst::AbstractBandIterator< T >::m_lastblksize
protectedinherited

The number of pixels inside the last block.

Definition at line 126 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator(), and te::rst::AbstractBandIterator< T >::operator=().

template<class T>
int te::rst::AbstractBandIterator< T >::m_nblocksx
protectedinherited

The number of blocks in X direction.

Definition at line 121 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator(), and te::rst::AbstractBandIterator< T >::operator=().

template<class T>
int te::rst::AbstractBandIterator< T >::m_nblocksy
protectedinherited

The number of blocks in Y direction.

Definition at line 122 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator(), and te::rst::AbstractBandIterator< T >::operator=().

template<class T>
int te::rst::AbstractBandIterator< T >::m_npxlsblk
protectedinherited

The maximum number of pixels inside the block.

Definition at line 120 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator(), and te::rst::AbstractBandIterator< T >::operator=().

template<class T>
te::rst::SetBufferValueFPtr te::rst::AbstractBandIterator< T >::m_setBuff
protectedinherited

A pointer to a function that helps to insert a double or complex value into a specific buffer data type (char, int16, int32, float, ...).

Definition at line 131 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator().

template<class T>
te::rst::SetBufferValueFPtr te::rst::AbstractBandIterator< T >::m_setBuffI
protectedinherited

A pointer to a function that helps to insert the imaginary part value into a specific buffer data type (cint16, cint32, cfloat, cdouble).

Definition at line 132 of file BandIterator.h.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator().


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