This class implements the strategy to iterate with spatial restriction, the iteration occurs inside a vector of points. More...

#include <PositionIterator.h>

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

Public Member Functions
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 PointSetIterator< T > &rhs) const

bool	operator!= (const AbstractPositionIterator< T > &rhs) const
	Difference operator. More...

std::complex< T >	operator() (const unsigned int i) const
	Returns the complex value in current position (column, row, band) from iterator. More...

const std::vector< T >	operator* () const
	Returns a vector of the values in current position (column, row) from iterator. More...

void	operator++ ()
	Advances to the next position. More...

void	operator-- ()
	Returns to the previous position. More...

PointSetIterator &	operator= (const PointSetIterator &rhs)

AbstractPositionIterator< T > &	operator= (const AbstractPositionIterator< T > &rhs)
	Assignment operator. More...

T	operator[] (const unsigned int i) const
	Returns the real value in current position (column, row, band) from iterator. More...

	PointSetIterator ()

	PointSetIterator (const te::rst::Raster r, const std::vector< te::gm::Point > p)
	Constructor. More...

	PointSetIterator (const PointSetIterator &rhs)
	Copy constructor. More...

void	setEnd ()
	Sets the iterator position to the end of the current band. More...

	~PointSetIterator ()

Static Public Member Functions
static PointSetIterator	begin (const te::rst::Raster r, const std::vector< te::gm::Point > p)
	Returns an iterator referring to the first value of the band. More...

static PointSetIterator	end (const te::rst::Raster r, const std::vector< te::gm::Point > p)
	Returns an iterator referring to after the end of the iterator. More...

Protected Attributes
int	m_currentpixelindex
	The index of the current pixel location. More...

double	m_operatorBrackets_value
	Used by the operator[] method. More...

std::complex< double >	m_operatorParenthesis_value
	Used by the operator() method. More...

std::vector< te::gm::Point * >	m_pixelsinpointset
	The spatial restriction to be applied in the iterator. More...

const te::rst::Raster *	m_raster
	The band from where to get the values. More...

Detailed Description

template<typename T>
class te::rst::PointSetIterator< T >

This class implements the strategy to iterate with spatial restriction, the iteration occurs inside a vector of points.

Definition at line 321 of file PositionIterator.h.

Constructor & Destructor Documentation

template<typename T >

te::rst::PointSetIterator< T >::PointSetIterator ( )

Definition at line 1197 of file PositionIterator.h.

template<typename T >

te::rst::PointSetIterator< T >::PointSetIterator	(	const te::rst::Raster *	r,
		const std::vector< te::gm::Point * >	p
	)

Constructor.

Parameters

b	The band to iterate.
p	The vector of points where the iteration will navigate.

Definition at line 1204 of file PositionIterator.h.

References te::rst::Grid::geoToGrid(), te::rst::Raster::getExtent(), te::gm::GetGeomFromEnvelope(), te::rst::Raster::getGrid(), te::rst::Raster::getSRID(), te::gm::INTERSECTS, te::rst::PointSetIterator< T >::m_pixelsinpointset, te::rst::PointSetIterator< T >::m_raster, te::gm::SatisfySpatialRelation(), te::rst::PointSetIterator< T >::setEnd(), and TE_TR.

template<typename T >

te::rst::PointSetIterator< T >::PointSetIterator ( const PointSetIterator< T > & rhs )

Copy constructor.

Parameters

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

Definition at line 1240 of file PositionIterator.h.

template<typename T >

te::rst::PointSetIterator< T >::~PointSetIterator ( )

Definition at line 1247 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::m_pixelsinpointset.

Member Function Documentation

template<typename T >

te::rst::PointSetIterator< T > te::rst::PointSetIterator< T >::begin	(	const te::rst::Raster *	r,
		const std::vector< te::gm::Point * >	p
	)

static

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

Definition at line 1331 of file PositionIterator.h.

template<typename T >

te::rst::PointSetIterator< T > te::rst::PointSetIterator< T >::end	(	const te::rst::Raster *	r,
		const std::vector< te::gm::Point * >	p
	)

static

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

Definition at line 1336 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::setEnd().

template<typename T >

unsigned int te::rst::PointSetIterator< T >::getColumn ( ) const

virtual

Returns the current column in iterator.

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

Definition at line 1285 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::m_currentpixelindex, and te::rst::PointSetIterator< T >::m_pixelsinpointset.

Referenced by te::rst::PointSetIterator< T >::operator()(), te::rst::PointSetIterator< T >::operator*(), and te::rst::PointSetIterator< T >::operator[]().

template<typename T >

unsigned int te::rst::PointSetIterator< T >::getRow ( ) const

virtual

Returns the current row in iterator.

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

Definition at line 1280 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::m_currentpixelindex, and te::rst::PointSetIterator< T >::m_pixelsinpointset.

Referenced by te::rst::PointSetIterator< T >::operator()(), te::rst::PointSetIterator< T >::operator*(), and te::rst::PointSetIterator< T >::operator[]().

template<typename T >

bool te::rst::PointSetIterator< T >::operator!= ( const PointSetIterator< T > & rhs ) const

Definition at line 1345 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::m_currentpixelindex.

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

template<typename T >

bool te::rst::PointSetIterator< T >::operator!= ( const AbstractPositionIterator< T > & rhs ) const

virtual

Difference operator.

Parameters

rhs	The right-hand side to compare.

Returns: Returns true if the iterators are at different positions, or false otherwise.

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

Definition at line 1351 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::operator!=().

template<typename T >

std::complex< T > te::rst::PointSetIterator< T >::operator() ( const unsigned int i ) const

virtual

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

Parameters

i	The band index.

Returns: The pixel comples value in current position.

Note: For real values use operator[]

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

Definition at line 1273 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::getColumn(), te::rst::PointSetIterator< T >::getRow(), te::rst::Raster::getValue(), te::rst::PointSetIterator< T >::m_operatorParenthesis_value, and te::rst::PointSetIterator< T >::m_raster.

template<typename T >

const std::vector< T > te::rst::PointSetIterator< T >::operator* ( ) const

virtual

Returns a vector of the values in current position (column, row) from iterator.

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

Definition at line 1252 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::getColumn(), te::rst::Raster::getNumberOfBands(), te::rst::PointSetIterator< T >::getRow(), te::rst::Raster::getValue(), and te::rst::PointSetIterator< T >::m_raster.

template<typename T >

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

virtual

Advances to the next position.

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

Definition at line 1290 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::m_currentpixelindex, te::rst::PointSetIterator< T >::m_pixelsinpointset, and te::rst::PointSetIterator< T >::setEnd().

template<typename T >

void te::rst::PointSetIterator< T >::operator-- ( )

virtual

Returns to the previous position.

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

Definition at line 1298 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::m_currentpixelindex, and te::rst::PointSetIterator< T >::setEnd().

template<typename T >

te::rst::PointSetIterator< T > & te::rst::PointSetIterator< T >::operator= ( const PointSetIterator< T > & rhs )

Definition at line 1306 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::m_currentpixelindex, te::rst::PointSetIterator< T >::m_pixelsinpointset, and te::rst::AbstractPositionIterator< T >::operator=().

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

template<typename T >

AbstractPositionIterator< T > & te::rst::PointSetIterator< T >::operator= ( const AbstractPositionIterator< T > & rhs )

virtual

Assignment operator.

Parameters

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

Returns: A reference to this object.

Reimplemented from te::rst::AbstractPositionIterator< T >.

Definition at line 1320 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::operator=().

template<typename T >

T te::rst::PointSetIterator< T >::operator[] ( const unsigned int i ) const

virtual

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

Parameters

i	The band index.

Returns: The pixel real value in current position.

Note: For complex values use operator()

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

Definition at line 1266 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::getColumn(), te::rst::PointSetIterator< T >::getRow(), te::rst::Raster::getValue(), te::rst::PointSetIterator< T >::m_operatorBrackets_value, and te::rst::PointSetIterator< T >::m_raster.

template<typename T >

void te::rst::PointSetIterator< T >::setEnd ( )

virtual

Sets the iterator position to the end of the current band.

Parameters

b	The band to retrieve the end information.

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

Definition at line 1326 of file PositionIterator.h.

References te::rst::PointSetIterator< T >::m_currentpixelindex.

Referenced by te::rst::PointSetIterator< T >::end(), te::rst::PointSetIterator< T >::operator++(), te::rst::PointSetIterator< T >::operator--(), and te::rst::PointSetIterator< T >::PointSetIterator().

Member Data Documentation

template<typename T>

int te::rst::PointSetIterator< T >::m_currentpixelindex

protected

The index of the current pixel location.

Definition at line 378 of file PositionIterator.h.

Referenced by te::rst::PointSetIterator< T >::getColumn(), te::rst::PointSetIterator< T >::getRow(), te::rst::PointSetIterator< T >::operator!=(), te::rst::PointSetIterator< T >::operator++(), te::rst::PointSetIterator< T >::operator--(), te::rst::PointSetIterator< T >::operator=(), and te::rst::PointSetIterator< T >::setEnd().

template<typename T>

double te::rst::PointSetIterator< T >::m_operatorBrackets_value

mutableprotected

Used by the operator[] method.

Definition at line 379 of file PositionIterator.h.

Referenced by te::rst::PointSetIterator< T >::operator[]().

template<typename T>

std::complex< double > te::rst::PointSetIterator< T >::m_operatorParenthesis_value

mutableprotected

Used by the operator() method.

Definition at line 380 of file PositionIterator.h.

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

template<typename T>

std::vector<te::gm::Point*> te::rst::PointSetIterator< T >::m_pixelsinpointset

protected

The spatial restriction to be applied in the iterator.

Definition at line 377 of file PositionIterator.h.

Referenced by te::rst::PointSetIterator< T >::getColumn(), te::rst::PointSetIterator< T >::getRow(), te::rst::PointSetIterator< T >::operator++(), te::rst::PointSetIterator< T >::operator=(), te::rst::PointSetIterator< T >::PointSetIterator(), and te::rst::PointSetIterator< T >::~PointSetIterator().

template<typename T>

const te::rst::Raster* te::rst::PointSetIterator< T >::m_raster

protected

The band from where to get the values.

Definition at line 376 of file PositionIterator.h.

Referenced by te::rst::PointSetIterator< T >::operator()(), te::rst::PointSetIterator< T >::operator*(), te::rst::PointSetIterator< T >::operator[](), and te::rst::PointSetIterator< T >::PointSetIterator().

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

template<typename T> class te::rst::PointSetIterator< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T>
class te::rst::PointSetIterator< T >