Organized Index Iterator for iterating over the "pixels" for a given line using the Bresenham algorithm. Supports 4 and 8 neighborhood connectivity. More...

#include <line_iterator.h>

Inheritance diagram for pcl::LineIterator:

[legend]

List of all members.

Public Types
enum	Neighborhood { Neighbor4 = 4, Neighbor8 = 8 }
	Neighborhood connectivity. More...
Public Member Functions
virtual unsigned	getColumnIndex () const
	returns the col index (x-coordinate) of the current pixel/point
virtual unsigned	getRowIndex () const
	returns the row index (y-coordinate) of the current pixel/point
virtual bool	isValid () const
	return whether the current visited pixel/point is valid or not.
	LineIterator (unsigned x_start, unsigned y_start, unsigned x_end, unsigned y_end, unsigned width, const Neighborhood &neighborhood=Neighbor8)
	Constructor.
virtual void	operator++ ()
	go to next pixel/point in image/cloud
virtual void	reset ()
	resets the iterator to the beginning of the line
virtual	~LineIterator ()
	Destructor.
Protected Member Functions
void	init (const Neighborhood &neighborhood)
	initializes the variables for the Bresenham algorithm
Protected Attributes
int	error_
	current distance to the line
int	error_max_
	error threshold
int	error_minus_
	increment of error (distance) value in case of an y-step (if dx > dy)
int	error_plus_
	increment of error (distance) value in case of just an x-step (if dx > dy)
int	index_minus_
	increment pixel/point index in case of just an y-step (if dx > dy)
int	index_plus_
	increment pixel/point index in case of just an x-step (if dx > dy)
unsigned	x_
	current column index
unsigned	x_end_
	column index of end pixel/point
int	x_minus_
	increment of column index in case of just an y-step (if dx > dy)
int	x_plus_
	increment of column index in case of just an x-step (if dx > dy)
unsigned	x_start_
	column index of first pixel/point
unsigned	y_
	current row index
unsigned	y_end_
	row index of end pixel/point
int	y_minus_
	increment of row index in case of just an y-step (if dx > dy)
int	y_plus_
	increment of row index in case of just an x-step (if dx > dy)
unsigned	y_start_
	row index of first pixel/point

Detailed Description

Organized Index Iterator for iterating over the "pixels" for a given line using the Bresenham algorithm. Supports 4 and 8 neighborhood connectivity.

Note:: iterator does not visit the given end-point (on purpose).

Author:: Suat Gedikli <gedikli@willowgarage.com>

Definition at line 48 of file line_iterator.h.

Member Enumeration Documentation

enum pcl::LineIterator::Neighborhood

Neighborhood connectivity.

Enumerator:

Neighbor4
Neighbor8

Definition at line 52 of file line_iterator.h.

Constructor & Destructor Documentation

pcl::LineIterator::LineIterator	(	unsigned	x_start,
		unsigned	y_start,
		unsigned	x_end,
		unsigned	y_end,
		unsigned	width,
		const Neighborhood &	neighborhood = `Neighbor8`
	)		`[inline]`

Constructor.

Parameters:

x_start	column of the start pixel of the line
y_start	row of the start pixel of the line
x_end	column of the end pixel of the line
y_end	row of the end pixel of the line
width	width of the organized structure e.g. image/cloud/map etc..
neighborhood	connectivity of the neighborhood