Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Member Functions | Protected Attributes
pcl::OrganizedIndexIterator Class Referenceabstract

base class for iterators on 2-dimensional maps like images/organized clouds etc. More...

#include <pcl/geometry/organized_index_iterator.h>

+ Inheritance diagram for pcl::OrganizedIndexIterator:

Public Member Functions

 OrganizedIndexIterator (unsigned width)
 constructor More...
 
virtual ~OrganizedIndexIterator ()
 virtual destructor More...
 
virtual void operator++ ()=0
 go to next pixel/point in image/cloud More...
 
virtual void operator++ (int)
 go to next pixel/point in image/cloud More...
 
unsigned operator* () const
 returns the pixel/point index in the linearized memory of the image/cloud More...
 
virtual unsigned getIndex () const
 returns the pixel/point index in the linearized memory of the image/cloud More...
 
virtual unsigned getRowIndex () const
 returns the row index (y-coordinate) of the current pixel/point More...
 
virtual unsigned getColumnIndex () const
 returns the col index (x-coordinate) of the current pixel/point More...
 
virtual bool isValid () const =0
 return whether the current visited pixel/point is valid or not. More...
 
virtual void reset ()=0
 resets the iterator to the beginning of the line More...
 

Protected Attributes

unsigned width_
 the width of the image/cloud More...
 
unsigned index_
 the index of the current pixel/point More...
 

Detailed Description

base class for iterators on 2-dimensional maps like images/organized clouds etc.

Author
Suat Gedikli gedik.nosp@m.li@w.nosp@m.illow.nosp@m.gara.nosp@m.ge.co.nosp@m.m

Definition at line 44 of file organized_index_iterator.h.

Constructor & Destructor Documentation

pcl::OrganizedIndexIterator::OrganizedIndexIterator ( unsigned  width)
inline

constructor

Parameters
[in]widththe width of the image/organized cloud

Definition at line 103 of file organized_index_iterator.h.

pcl::OrganizedIndexIterator::~OrganizedIndexIterator ( )
inlinevirtual

virtual destructor

Definition at line 110 of file organized_index_iterator.h.

Member Function Documentation

unsigned pcl::OrganizedIndexIterator::getColumnIndex ( ) const
inlinevirtual

returns the col index (x-coordinate) of the current pixel/point

Returns
the col index (x-coordinate) of the current pixel/point

Reimplemented in pcl::LineIterator.

Definition at line 146 of file organized_index_iterator.h.

References index_, and width_.

unsigned pcl::OrganizedIndexIterator::getIndex ( ) const
inlinevirtual

returns the pixel/point index in the linearized memory of the image/cloud

Returns
the pixel/point index in the linearized memory of the image/cloud

Definition at line 130 of file organized_index_iterator.h.

References index_.

unsigned pcl::OrganizedIndexIterator::getRowIndex ( ) const
inlinevirtual

returns the row index (y-coordinate) of the current pixel/point

default implementation.

Returns
the row index (y-coordinate) of the current pixel/point

Should be overloaded

Reimplemented in pcl::LineIterator.

Definition at line 139 of file organized_index_iterator.h.

References index_, and width_.

virtual bool pcl::OrganizedIndexIterator::isValid ( ) const
pure virtual

return whether the current visited pixel/point is valid or not.

Returns
true if the current pixel/point is within the points to be iterated over, false otherwise

Implemented in pcl::LineIterator.

unsigned pcl::OrganizedIndexIterator::operator* ( ) const
inline

returns the pixel/point index in the linearized memory of the image/cloud

Returns
the pixel/point index in the linearized memory of the image/cloud

Definition at line 123 of file organized_index_iterator.h.

References index_.

virtual void pcl::OrganizedIndexIterator::operator++ ( )
pure virtual

go to next pixel/point in image/cloud

Implemented in pcl::LineIterator.

Referenced by operator++().

void pcl::OrganizedIndexIterator::operator++ ( int  )
inlinevirtual

go to next pixel/point in image/cloud

Definition at line 116 of file organized_index_iterator.h.

References operator++().

virtual void pcl::OrganizedIndexIterator::reset ( )
pure virtual

resets the iterator to the beginning of the line

Implemented in pcl::LineIterator.

Member Data Documentation

unsigned pcl::OrganizedIndexIterator::index_
protected
unsigned pcl::OrganizedIndexIterator::width_
protected

the width of the image/cloud

Definition at line 92 of file organized_index_iterator.h.

Referenced by getColumnIndex(), getRowIndex(), pcl::LineIterator::init(), and pcl::LineIterator::reset().


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