Public Member Functions | Protected Attributes
pcl::OrganizedIndexIterator Class Reference

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

#include <organized_index_iterator.h>

Inheritance diagram for pcl::OrganizedIndexIterator:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Protected Attributes

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

Detailed Description

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

Author:
Suat Gedikli <gedikli@willowgarage.com>

Definition at line 45 of file organized_index_iterator.h.


Constructor & Destructor Documentation

constructor

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

Definition at line 104 of file organized_index_iterator.h.

virtual destructor

Definition at line 111 of file organized_index_iterator.h.


Member Function Documentation

unsigned pcl::OrganizedIndexIterator::getColumnIndex ( ) const [inline, virtual]

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 147 of file organized_index_iterator.h.

unsigned pcl::OrganizedIndexIterator::getIndex ( ) const [inline, virtual]

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 131 of file organized_index_iterator.h.

unsigned pcl::OrganizedIndexIterator::getRowIndex ( ) const [inline, virtual]

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

default implementation. Should be overloaded

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

Reimplemented in pcl::LineIterator.

Definition at line 140 of file organized_index_iterator.h.

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 124 of file organized_index_iterator.h.

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

go to next pixel/point in image/cloud

Implemented in pcl::LineIterator.

void pcl::OrganizedIndexIterator::operator++ ( int  ) [inline, virtual]

go to next pixel/point in image/cloud

Definition at line 117 of file organized_index_iterator.h.

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

resets the iterator to the beginning of the line

Implemented in pcl::LineIterator.


Member Data Documentation

the index of the current pixel/point

Definition at line 96 of file organized_index_iterator.h.

the width of the image/cloud

Definition at line 93 of file organized_index_iterator.h.


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


pcl
Author(s): Open Perception
autogenerated on Mon Oct 6 2014 03:19:42