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

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

#include <PositionIterator.h>

Inheritance diagram for te::rst::PolygonIterator< T >:
te::rst::AbstractPositionIterator< 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 PolygonIterator< 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...
 
PolygonIteratoroperator= (const PolygonIterator &rhs)
 
AbstractPositionIterator< T > & operator= (const AbstractPositionIterator< T > &rhs)
 Assignment operator. More...
 
operator[] (const unsigned int i) const
 Returns the real value in current position (column, row, band) from iterator. More...
 
 PolygonIterator ()
 
 PolygonIterator (const te::rst::Raster *r, const te::gm::Polygon *p)
 Constructor. More...
 
 PolygonIterator (const PolygonIterator &rhs)
 Copy constructor. More...
 
void setEnd ()
 Sets the iterator position to the end of the current band. More...
 
void setNextLine (bool updatecurrline=true)
 
 ~PolygonIterator ()
 

Static Public Member Functions

static PolygonIterator begin (const te::rst::Raster *r, const te::gm::Polygon *p)
 Returns an iterator referring to the first value of the band. More...
 
static PolygonIterator end (const te::rst::Raster *r, const te::gm::Polygon *p)
 Returns an iterator referring to after the end of the iterator. More...
 

Protected Member Functions

void clear ()
 Clear all internal allocated objects and reset back to the initial state. More...
 

Protected Attributes

int m_actualintersection
 The actual line of the iterator. More...
 
int m_column
 The current column of the iterator. More...
 
std::vector< std::pair< int, int > > m_columns
 Coordinates of the columns to be transversed. More...
 
te::gm::Linem_currline
 The current line in the iterator. More...
 
int m_endingcolumn
 The column (in current line) to finalize the iteration. More...
 
int m_endingrow
 The ending row of the iteration. More...
 
int m_maxcolumns
 The number of columns in band. More...
 
int m_maxrows
 The number of rows in band. More...
 
int m_nintersections
 The number number of intersected lines in current line of the iterator. More...
 
double m_operatorBrackets_value
 
std::complex< double > m_operatorParenthesis_value
 
const te::gm::Polygonm_polygon
 The spatial restriction to be applied in the iterator. More...
 
const te::rst::Rasterm_raster
 The band from where to get the values. More...
 
int m_row
 The current row of the iterator. More...
 
int m_startingcolumn
 The starting column (in current line) to initialize the iteration. More...
 
int m_startingrow
 The starting row of the iteration. More...
 
std::unique_ptr< te::rst::TileIndexerm_tileIndexer
 Tile indexer used to optimize the geometric operations. More...
 

Detailed Description

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

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

Definition at line 156 of file PositionIterator.h.

Constructor & Destructor Documentation

template<typename T >
te::rst::PolygonIterator< T >::PolygonIterator ( )

Definition at line 407 of file PositionIterator.h.

template<typename T >
te::rst::PolygonIterator< T >::PolygonIterator ( const PolygonIterator< T > &  rhs)

Copy constructor.

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

Definition at line 506 of file PositionIterator.h.

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

template<typename T >
te::rst::PolygonIterator< T >::~PolygonIterator ( )

Definition at line 524 of file PositionIterator.h.

References te::rst::PolygonIterator< T >::clear().

Member Function Documentation

template<typename T >
te::rst::PolygonIterator< T > te::rst::PolygonIterator< T >::begin ( const te::rst::Raster r,
const te::gm::Polygon p 
)
static

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

Definition at line 962 of file PositionIterator.h.

template<typename T >
te::rst::PolygonIterator< T > te::rst::PolygonIterator< T >::end ( const te::rst::Raster r,
const te::gm::Polygon p 
)
static

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

Definition at line 967 of file PositionIterator.h.

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

template<typename T >
unsigned int te::rst::PolygonIterator< T >::getColumn ( ) const
virtual

Returns the current column in iterator.

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

Definition at line 858 of file PositionIterator.h.

References te::rst::PolygonIterator< T >::m_column.

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

template<typename T >
unsigned int te::rst::PolygonIterator< T >::getRow ( ) const
virtual

Returns the current row in iterator.

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

Definition at line 853 of file PositionIterator.h.

References te::rst::PolygonIterator< T >::m_row.

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

template<typename T >
bool te::rst::PolygonIterator< T >::operator!= ( const PolygonIterator< T > &  rhs) const
template<typename T >
bool te::rst::PolygonIterator< T >::operator!= ( const AbstractPositionIterator< T > &  rhs) const
virtual

Difference operator.

Parameters
rhsThe 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 982 of file PositionIterator.h.

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

template<typename T >
std::complex< T > te::rst::PolygonIterator< T >::operator() ( const unsigned int  i) const
virtual

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

Parameters
iThe band index.
Returns
The pixel comples value in current position.
Note
For real values use operator[]

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

Definition at line 846 of file PositionIterator.h.

References te::rst::Raster::getValue(), te::rst::PolygonIterator< T >::m_column, te::rst::PolygonIterator< T >::m_operatorParenthesis_value, te::rst::PolygonIterator< T >::m_raster, and te::rst::PolygonIterator< T >::m_row.

template<typename T >
const std::vector< T > te::rst::PolygonIterator< T >::operator* ( ) const
virtual
template<typename T >
AbstractPositionIterator< T > & te::rst::PolygonIterator< T >::operator= ( const AbstractPositionIterator< T > &  rhs)
virtual

Assignment operator.

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

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

Definition at line 950 of file PositionIterator.h.

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

template<typename T >
T te::rst::PolygonIterator< T >::operator[] ( const unsigned int  i) const
virtual

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

Parameters
iThe band index.
Returns
The pixel real value in current position.
Note
For complex values use operator()

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

Definition at line 839 of file PositionIterator.h.

References te::rst::Raster::getValue(), te::rst::PolygonIterator< T >::m_column, te::rst::PolygonIterator< T >::m_operatorBrackets_value, te::rst::PolygonIterator< T >::m_raster, and te::rst::PolygonIterator< T >::m_row.

template<typename T >
void te::rst::PolygonIterator< T >::setEnd ( )
virtual
template<typename T >
void te::rst::PolygonIterator< T >::setNextLine ( bool  updatecurrline = true)

Member Data Documentation

template<typename T>
std::vector<std::pair<int, int> > te::rst::PolygonIterator< T >::m_columns
protected

Coordinates of the columns to be transversed.

Definition at line 228 of file PositionIterator.h.

Referenced by te::rst::PolygonIterator< T >::clear(), te::rst::PolygonIterator< T >::operator=(), and te::rst::PolygonIterator< T >::setNextLine().

template<typename T>
int te::rst::PolygonIterator< T >::m_endingcolumn
protected
template<typename T>
int te::rst::PolygonIterator< T >::m_maxcolumns
protected
template<typename T>
int te::rst::PolygonIterator< T >::m_maxrows
protected

The number of rows in band.

Definition at line 224 of file PositionIterator.h.

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

template<typename T>
int te::rst::PolygonIterator< T >::m_nintersections
protected

The number number of intersected lines in current line of the iterator.

Definition at line 226 of file PositionIterator.h.

Referenced by te::rst::PolygonIterator< T >::clear(), te::rst::PolygonIterator< T >::operator++(), te::rst::PolygonIterator< T >::operator=(), and te::rst::PolygonIterator< T >::setNextLine().

template<typename T>
double te::rst::PolygonIterator< T >::m_operatorBrackets_value
mutableprotected

Definition at line 231 of file PositionIterator.h.

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

template<typename T>
std::complex< double > te::rst::PolygonIterator< T >::m_operatorParenthesis_value
mutableprotected

Definition at line 232 of file PositionIterator.h.

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

template<typename T>
const te::gm::Polygon* te::rst::PolygonIterator< T >::m_polygon
protected
template<typename T>
int te::rst::PolygonIterator< T >::m_startingrow
protected
template<typename T>
std::unique_ptr<te::rst::TileIndexer> te::rst::PolygonIterator< T >::m_tileIndexer
protected

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