Octree iterator class More...

#include <pcl/octree/octree_iterator.h>

Inheritance diagram for pcl::octree::OctreeBreadthFirstIterator< OctreeT >:

Public Member Functions
	OctreeBreadthFirstIterator (unsigned int max_depth_arg=0)
	Empty constructor.
	OctreeBreadthFirstIterator (OctreeT *octree_arg, unsigned int max_depth_arg=0)
	Constructor.
virtual	~OctreeBreadthFirstIterator ()
	Empty deconstructor.
OctreeBreadthFirstIterator &	operator= (const OctreeBreadthFirstIterator &src)
	Copy operator.
void	reset ()
	Reset the iterator to the root node of the octree.
OctreeBreadthFirstIterator &	operator++ ()
	Preincrement operator.
OctreeBreadthFirstIterator	operator++ (int)
	postincrement operator.
Public Member Functions inherited from pcl::octree::OctreeIteratorBase< OctreeT >
	OctreeIteratorBase (unsigned int max_depth_arg=0)
	Empty constructor.
	OctreeIteratorBase (OctreeT *octree_arg, unsigned int max_depth_arg=0)
	Constructor.
	OctreeIteratorBase (const OctreeIteratorBase &src, unsigned int max_depth_arg=0)
	Copy constructor.
OctreeIteratorBase &	operator= (const OctreeIteratorBase &src)
	Copy operator.
virtual	~OctreeIteratorBase ()
	Empty deconstructor.
bool	operator== (const OctreeIteratorBase &other) const
	Equal comparison operator.
bool	operator!= (const OctreeIteratorBase &other) const
	Inequal comparison operator.
const OctreeKey &	getCurrentOctreeKey () const
	Get octree key for the current iterator octree node.
unsigned int	getCurrentOctreeDepth () const
	Get the current depth level of octree.
OctreeNode *	getCurrentOctreeNode () const
	Get the current octree node.
bool	isBranchNode () const
	check if current node is a branch node
bool	isLeafNode () const
	check if current node is a branch node
OctreeNode *	operator* () const
	*operator.
char	getNodeConfiguration () const
	Get bit pattern of children configuration of current node.
const LeafContainer &	getLeafContainer () const
	Method for retrieving a single leaf container from the octree leaf node.
LeafContainer &	getLeafContainer ()
	Method for retrieving a single leaf container from the octree leaf node.
const BranchContainer &	getBranchContainer () const
	Method for retrieving the container from an octree branch node.
BranchContainer &	getBranchContainer ()
	Method for retrieving the container from an octree branch node.
virtual unsigned long	getNodeID () const
	get a integer identifier for current node (note: identifier depends on tree depth).

Protected Attributes
std::deque< IteratorState >	FIFO_
	FIFO list.
Protected Attributes inherited from pcl::octree::OctreeIteratorBase< OctreeT >
OctreeT *	octree_
	Reference to octree class.
IteratorState *	current_state_
	Pointer to current iterator state.
unsigned int	max_octree_depth_
	Maximum octree depth.

Additional Inherited Members
Public Types inherited from pcl::octree::OctreeIteratorBase< OctreeT >
typedef OctreeT::LeafNode	LeafNode
typedef OctreeT::BranchNode	BranchNode
typedef OctreeT::LeafContainer	LeafContainer
typedef OctreeT::BranchContainer	BranchContainer

Detailed Description

template<typename OctreeT>
class pcl::octree::OctreeBreadthFirstIterator< OctreeT >

Octree iterator class

Note: This class implements a forward iterator for traversing octrees in a breadth-first manner.

Author: Julius Kammerl (juliu.nosp@m.s@ka.nosp@m.mmerl.nosp@m..de)

Definition at line 454 of file octree_iterator.h.

Constructor & Destructor Documentation

template<typename OctreeT >

pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator ( unsigned int max_depth_arg = 0 )

explicit

Empty constructor.

Parameters

[in] max_depth_arg Depth limitation during traversal

Definition at line 185 of file octree_iterator.hpp.

References pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset().

template<typename OctreeT >

pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator	(	OctreeT *	octree_arg,
		unsigned int	max_depth_arg = `0`
	)

explicit

Constructor.

Parameters

[in]	octree_arg	Octree to be iterated. Initially the iterator is set to its root node.
[in]	max_depth_arg	Depth limitation during traversal

Definition at line 196 of file octree_iterator.hpp.

References pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset().

template<typename OctreeT >

pcl::octree::OctreeBreadthFirstIterator< OctreeT >::~OctreeBreadthFirstIterator ( )

virtual

Empty deconstructor.

Definition at line 207 of file octree_iterator.hpp.

Member Function Documentation

template<typename OctreeT >

OctreeBreadthFirstIterator< OctreeT > & pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++ ( )

Preincrement operator.

Note: step to next octree node

Definition at line 237 of file octree_iterator.hpp.

References pcl::octree::BRANCH_NODE, pcl::octree::IteratorState::depth_, pcl::octree::OctreeNode::getNodeType(), pcl::octree::IteratorState::key_, pcl::octree::IteratorState::node_, pcl::octree::OctreeKey::popBranch(), and pcl::octree::OctreeKey::pushBranch().

template<typename OctreeT >

OctreeBreadthFirstIterator pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++ ( int )

inline

postincrement operator.

Note: step to next octree node

Definition at line 516 of file octree_iterator.h.

template<typename OctreeT >

OctreeBreadthFirstIterator& pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator= ( const OctreeBreadthFirstIterator< OctreeT > & src )

inline

Copy operator.

Parameters

[in] src the iterator to copy into this

Definition at line 483 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, and pcl::octree::OctreeBreadthFirstIterator< OctreeT >::FIFO_.

template<typename OctreeT >

void pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset ( )

Reset the iterator to the root node of the octree.

Reimplemented from pcl::octree::OctreeIteratorBase< OctreeT >.

Definition at line 213 of file octree_iterator.hpp.

References pcl::octree::IteratorState::depth_, pcl::octree::IteratorState::key_, pcl::octree::IteratorState::node_, pcl::octree::OctreeIteratorBase< OctreeT >::reset(), pcl::octree::OctreeKey::x, pcl::octree::OctreeKey::y, and pcl::octree::OctreeKey::z.

Referenced by pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator().

Member Data Documentation

template<typename OctreeT >

std::deque<IteratorState> pcl::octree::OctreeBreadthFirstIterator< OctreeT >::FIFO_

protected

FIFO list.

Definition at line 525 of file octree_iterator.h.

Referenced by pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator=().

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

/tmp/buildd/pcl-1.7-1.7.0/octree/include/pcl/octree/octree_iterator.h
/tmp/buildd/pcl-1.7-1.7.0/octree/include/pcl/octree/impl/octree_iterator.hpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename OctreeT> class pcl::octree::OctreeBreadthFirstIterator< OctreeT >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename OctreeT>
class pcl::octree::OctreeBreadthFirstIterator< OctreeT >