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

This class implements an abstract iterator to "navigate" over a single band. More...

#include <BandIterator.h>

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

Public Member Functions
	AbstractBandIterator ()
	Constructor. More...
	AbstractBandIterator (const te::rst::Band *b)
	Constructor. More...
	AbstractBandIterator (const AbstractBandIterator &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...
virtual const T	operator* () const =0
	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...
AbstractBandIterator &	operator= (const AbstractBandIterator &rhs)
	Assignment operator. More...
virtual void	replaceBlock ()=0
	Replaces the current bufferized block values. More...
	~AbstractBandIterator ()
	Destructor. More...

Protected Attributes
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::AbstractBandIterator< T >

This class implements an abstract iterator to "navigate" over a single band.

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 56 of file BandIterator.h.

Constructor & Destructor Documentation

template<class T >

te::rst::AbstractBandIterator< T >::AbstractBandIterator

(

)

Constructor.

Definition at line 321 of file BandIterator.h.

template<class T >

te::rst::AbstractBandIterator< T >::AbstractBandIterator

(

const te::rst::Band *

b

)

Constructor.

Parameters

b	The band to iterate.

Definition at line 340 of file BandIterator.h.

References te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), te::rst::Band::getProperty(), te::rst::Band::getRaster(), te::rst::BandProperty::getType(), te::rst::AbstractBandIterator< T >::m_blk, te::rst::AbstractBandIterator< T >::m_blksize, te::rst::AbstractBandIterator< T >::m_getBuff, te::rst::AbstractBandIterator< T >::m_getBuffI, te::rst::AbstractBandIterator< T >::m_lastblksize, te::rst::AbstractBandIterator< T >::m_nblocksx, te::rst::AbstractBandIterator< T >::m_nblocksy, te::rst::AbstractBandIterator< T >::m_npxlsblk, te::rst::AbstractBandIterator< T >::m_setBuff, te::rst::AbstractBandIterator< T >::m_setBuffI, and te::rst::SetBlockFunctions().

template<class T >

te::rst::AbstractBandIterator< T >::AbstractBandIterator

(

const AbstractBandIterator< T > &

rhs

)

Copy constructor.

Parameters

rhs	The right-hand-side copy used to copy from.

Definition at line 363 of file BandIterator.h.

References te::rst::AbstractBandIterator< T >::m_blk, and te::rst::AbstractBandIterator< T >::m_blksize.

template<class T >

te::rst::AbstractBandIterator< T >::~AbstractBandIterator

(

)

Destructor.

Definition at line 383 of file BandIterator.h.

Member Function Documentation

template<class T >

unsigned int te::rst::AbstractBandIterator< T >::getColumn

(

)

const

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

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

Difference operator.

Parameters

rhs	The 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>

virtual const T te::rst::AbstractBandIterator< T >::operator* ( ) const

pure virtual

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

Implemented in te::rst::ConstBandIterator< T >, and te::rst::BandIterator< T >.

template<class T >

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

virtual

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--

(

)

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::AbstractBandIterator< T > & te::rst::AbstractBandIterator< T >::operator=

(

const AbstractBandIterator< T > &

rhs

)

Assignment operator.

Parameters

rhs	The right-hand-side copy used to copy from.

Returns

A reference to this object.

Definition at line 456 of file BandIterator.h.

References te::rst::AbstractBandIterator< T >::m_blkh, te::rst::AbstractBandIterator< T >::m_blksize, te::rst::AbstractBandIterator< T >::m_blkw, te::rst::AbstractBandIterator< T >::m_blkx, te::rst::AbstractBandIterator< T >::m_blky, te::rst::AbstractBandIterator< T >::m_i, te::rst::AbstractBandIterator< T >::m_lastblksize, te::rst::AbstractBandIterator< T >::m_nblocksx, te::rst::AbstractBandIterator< T >::m_nblocksy, and te::rst::AbstractBandIterator< T >::m_npxlsblk.

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

template<class T>

virtual void te::rst::AbstractBandIterator< T >::replaceBlock ( )

pure virtual

Replaces the current bufferized block values.

Implemented in te::rst::ConstBandIterator< T >, and te::rst::BandIterator< T >.

Member Data Documentation

template<class T>

T* te::rst::AbstractBandIterator< T >::m_blk

protected

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

protected

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_blksize

protected

The block size of the band.

Definition at line 127 of file BandIterator.h.

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

template<class T>

int te::rst::AbstractBandIterator< T >::m_blkw

protected

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

protected

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>

int te::rst::AbstractBandIterator< T >::m_blky

protected

The position in Y of the current block.

Definition at line 125 of file BandIterator.h.

Referenced by te::rst::BandIterator< T >::end(), te::rst::ConstBandIterator< T >::end(), te::rst::BandIteratorWithMask< T >::end(), te::rst::AbstractBandIterator< T >::operator!=(), and te::rst::AbstractBandIterator< T >::operator=().

template<class T>

te::rst::GetBufferValueFPtr te::rst::AbstractBandIterator< T >::m_getBuff

protected

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

protected

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

protected

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

protected

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

protected

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

protected

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

protected

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

protected

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

protected

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:

• /home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/raster/BandIterator.h