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

#include <PositionIterator.h>

Inheritance diagram for te::rst::LineIterator< 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...

	LineIterator ()

	LineIterator (const te::rst::Raster r, const te::gm::Line l)
	Constructor. More...

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

bool	operator!= (const LineIterator< 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...

LineIterator &	operator= (const LineIterator &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...

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

	~LineIterator ()

Static Public Member Functions
static LineIterator	begin (const te::rst::Raster r, const te::gm::Line l)
	Returns an iterator referring to the first value of the band. More...

static LineIterator	end (const te::rst::Raster r, const te::gm::Line l)
	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...

const te::gm::Line *	m_line
	The spatial restriction to be applied in the iterator. 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_pixelsinline
	A vector of pixel locations that intersects the line. More...

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

Detailed Description

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

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

Definition at line 248 of file PositionIterator.h.

Constructor & Destructor Documentation

template<typename T >

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

Definition at line 1007 of file PositionIterator.h.

template<typename T >

te::rst::LineIterator< T >::LineIterator	(	const te::rst::Raster *	r,
		const te::gm::Line *	l
	)

Constructor.

Parameters

b	The band to iterate.
l	The line from where the iteration will navigate.

Definition at line 1015 of file PositionIterator.h.

References te::rst::Grid::geoToGrid(), te::gm::LineString::getEndPoint(), te::rst::Raster::getExtent(), te::gm::GetGeomFromEnvelope(), te::rst::Raster::getGrid(), te::rst::Raster::getResolutionX(), te::rst::Raster::getResolutionY(), te::rst::Raster::getSRID(), te::gm::Geometry::getSRID(), te::gm::LineString::getStartPoint(), te::rst::Grid::gridToGeo(), te::gm::Geometry::intersection(), te::gm::INTERSECTS, te::rst::LineIterator< T >::m_line, te::rst::LineIterator< T >::m_pixelsinline, te::rst::LineIterator< T >::m_raster, te::gm::SatisfySpatialRelation(), te::rst::LineIterator< T >::setEnd(), and TE_TR.

template<typename T >

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

Copy constructor.

Parameters

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

Definition at line 1078 of file PositionIterator.h.

template<typename T >

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

Definition at line 1085 of file PositionIterator.h.

References te::rst::LineIterator< T >::m_pixelsinline.

Member Function Documentation

template<typename T >

te::rst::LineIterator< T > te::rst::LineIterator< T >::begin	(	const te::rst::Raster *	r,
		const te::gm::Line *	l
	)

static

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

Definition at line 1170 of file PositionIterator.h.

template<typename T >

te::rst::LineIterator< T > te::rst::LineIterator< T >::end	(	const te::rst::Raster *	r,
		const te::gm::Line *	l
	)

static

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

Definition at line 1175 of file PositionIterator.h.

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

template<typename T >

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

virtual

Returns the current column in iterator.

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

Definition at line 1123 of file PositionIterator.h.

References te::rst::LineIterator< T >::m_currentpixelindex, and te::rst::LineIterator< T >::m_pixelsinline.

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

template<typename T >

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

virtual

Returns the current row in iterator.

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

Definition at line 1118 of file PositionIterator.h.

References te::rst::LineIterator< T >::m_currentpixelindex, and te::rst::LineIterator< T >::m_pixelsinline.

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

template<typename T >

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

Definition at line 1184 of file PositionIterator.h.

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

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

template<typename T >

bool te::rst::LineIterator< 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 1190 of file PositionIterator.h.

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

template<typename T >

std::complex< T > te::rst::LineIterator< 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 1111 of file PositionIterator.h.

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

template<typename T >

const std::vector< T > te::rst::LineIterator< 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 1090 of file PositionIterator.h.

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

template<typename T >

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

virtual

Advances to the next position.

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

Definition at line 1128 of file PositionIterator.h.

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

template<typename T >

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

virtual

Returns to the previous position.

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

Definition at line 1136 of file PositionIterator.h.

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

template<typename T >

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

Definition at line 1144 of file PositionIterator.h.

References te::rst::LineIterator< T >::m_currentpixelindex, te::rst::LineIterator< T >::m_line, te::rst::LineIterator< T >::m_pixelsinline, and te::rst::AbstractPositionIterator< T >::operator=().

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

template<typename T >

AbstractPositionIterator< T > & te::rst::LineIterator< 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 1159 of file PositionIterator.h.

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

template<typename T >

T te::rst::LineIterator< 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 1104 of file PositionIterator.h.

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

template<typename T >

void te::rst::LineIterator< 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 1165 of file PositionIterator.h.

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

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

Member Data Documentation

template<typename T>

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

protected

The index of the current pixel location.

Definition at line 305 of file PositionIterator.h.

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

template<typename T>

const te::gm::Line* te::rst::LineIterator< T >::m_line

protected

The spatial restriction to be applied in the iterator.

Definition at line 304 of file PositionIterator.h.

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

template<typename T>

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

mutableprotected

Used by the operator[] method.

Definition at line 307 of file PositionIterator.h.

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

template<typename T>

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

mutableprotected

Used by the operator() method.

Definition at line 308 of file PositionIterator.h.

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

template<typename T>

std::vector<te::gm::Point*> te::rst::LineIterator< T >::m_pixelsinline

protected

A vector of pixel locations that intersects the line.

Definition at line 306 of file PositionIterator.h.

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

template<typename T>

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

protected

The band from where to get the values.

Definition at line 303 of file PositionIterator.h.

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

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::LineIterator< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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