pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT > Class Template Reference

Octree iterator class More...

#include <pcl/octree/octree_iterator.h>

Inheritance diagram for pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT >:

Collaboration diagram for pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT >:

List of all members.

Public Types
typedef OctreeIteratorBase < DataT, OctreeT >::LeafNode	LeafNode
typedef OctreeIteratorBase < DataT, OctreeT >::BranchNode	BranchNode
Public Member Functions
	OctreeDepthFirstIterator (OctreeT &octree_arg)
	Constructor.
virtual	~OctreeDepthFirstIterator ()
	Empty deconstructor.
virtual void	reset ()
	Reset the iterator to the root node of the octree.
OctreeDepthFirstIterator &	operator++ ()
	Preincrement operator.
OctreeDepthFirstIterator	operator++ (int)
	postincrement operator.
void	skipChildVoxels ()
	Skip all child voxels of current node and return to parent node.
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.
OctreeNode *	operator* () const
	*operator.
bool	isBranchNode () const
	check if current node is a branch node
bool	isLeafNode () const
	check if current node is a branch node
char	getNodeConfiguration () const
	Get bit pattern of children configuration of current node.
virtual void	getData (DataT &data_arg) const
	Method for retrieving a single DataT element from the octree leaf node.
virtual void	getData (std::vector< DataT > &dataVector_arg) const
	Method for retrieving a vector of DataT elements from the octree laef node.
virtual std::size_t	getSize () const
	Method for retrieving the size of the DataT vector from the octree laef node.
virtual unsigned long	getNodeID () const
	get a integer identifier for current node (note: identifier depends on tree depth).

---

Detailed Description

template<typename DataT, typename OctreeT>
class pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT >

Octree iterator class

Note:

This class implements a forward iterator for traversing octrees in a depth-first manner.

Author:

Julius Kammerl (julius@kammerl.de)

Definition at line 276 of file octree_iterator.h.

---

Member Typedef Documentation

template<typename DataT, typename OctreeT>

typedef OctreeIteratorBase<DataT, OctreeT>::BranchNode pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT >::BranchNode

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

Definition at line 282 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

typedef OctreeIteratorBase<DataT, OctreeT>::LeafNode pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT >::LeafNode

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

Definition at line 281 of file octree_iterator.h.

---

Constructor & Destructor Documentation

template<typename DataT , typename OctreeT >

pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT >::OctreeDepthFirstIterator

(

OctreeT &

octree_arg

)

[explicit]

Constructor.

Parameters:

[in]

octree_arg

Octree to be iterated. Initially the iterator is set to its root node.

Definition at line 53 of file octree_iterator.hpp.

template<typename DataT , typename OctreeT >

pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT >::~OctreeDepthFirstIterator

(

)

[virtual]

Empty deconstructor.

Definition at line 66 of file octree_iterator.hpp.

---

Member Function Documentation

template<typename DataT, typename OctreeT>

unsigned int pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getCurrentOctreeDepth

(

)

const [inline, inherited]

Get the current depth level of octree.

Returns:

depth level

Definition at line 140 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

const OctreeKey& pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getCurrentOctreeKey

(

)

const [inline, inherited]

Get octree key for the current iterator octree node.

Returns:

octree key of current node

Definition at line 131 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

OctreeNode* pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getCurrentOctreeNode

(

)

const [inline, inherited]

Get the current octree node.

Returns:

pointer to current octree node

Definition at line 149 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

virtual void pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getData

(

DataT &

data_arg

)

const [inline, virtual, inherited]

Method for retrieving a single DataT element from the octree leaf node.

Parameters:

[in]

data_arg

reference to return pointer of leaf node DataT element.

Definition at line 207 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

virtual void pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getData

(

std::vector< DataT > &

dataVector_arg

)

const [inline, virtual, inherited]

Method for retrieving a vector of DataT elements from the octree laef node.

Parameters:

[in]

dataVector_arg

reference to DataT vector that is extended with leaf node DataT elements.

Definition at line 219 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

char pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getNodeConfiguration

(

)

const [inline, inherited]

Get bit pattern of children configuration of current node.

Returns:

bit pattern (byte) describing the existence of 8 children of the current node

Definition at line 185 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

virtual unsigned long pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getNodeID

(

)

const [inline, virtual, inherited]

get a integer identifier for current node (note: identifier depends on tree depth).

Returns:

node id.

Definition at line 240 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

virtual std::size_t pcl::octree::OctreeIteratorBase< DataT, OctreeT >::getSize

(

)

const [inline, virtual, inherited]

Method for retrieving the size of the DataT vector from the octree laef node.

Definition at line 229 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

bool pcl::octree::OctreeIteratorBase< DataT, OctreeT >::isBranchNode

(

)

const [inline, inherited]

check if current node is a branch node

Returns:

true if current node is a branch node, false otherwise

Definition at line 167 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

bool pcl::octree::OctreeIteratorBase< DataT, OctreeT >::isLeafNode

(

)

const [inline, inherited]

check if current node is a branch node

Returns:

true if current node is a branch node, false otherwise

Definition at line 176 of file octree_iterator.h.

template<typename DataT, typename OctreeT>

OctreeNode* pcl::octree::OctreeIteratorBase< DataT, OctreeT >::operator*

(

)

const [inline, inherited]

*operator.

Returns:

pointer to the current octree node

Reimplemented in pcl::octree::OctreeLeafNodeIterator< DataT, OctreeT >.

Definition at line 158 of file octree_iterator.h.

template<typename DataT , typename OctreeT >

OctreeDepthFirstIterator< DataT, OctreeT > & pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT >::operator++

(

)

Preincrement operator.

Note:

recursively step to next octree node

Reimplemented in pcl::octree::OctreeLeafNodeIterator< DataT, OctreeT >.

Definition at line 115 of file octree_iterator.hpp.

template<typename DataT, typename OctreeT>

OctreeDepthFirstIterator pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT >::operator++

(

int

)

[inline]

postincrement operator.

Note:

recursively step to next octree node

Reimplemented in pcl::octree::OctreeLeafNodeIterator< DataT, OctreeT >.

Definition at line 311 of file octree_iterator.h.

template<typename DataT , typename OctreeT >

void pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT >::reset

(

)

[virtual]

Reset the iterator to the root node of the octree.

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

Reimplemented in pcl::octree::OctreeLeafNodeIterator< DataT, OctreeT >.

Definition at line 72 of file octree_iterator.hpp.

template<typename DataT , typename OctreeT >

void pcl::octree::OctreeDepthFirstIterator< DataT, OctreeT >::skipChildVoxels

(

)

Skip all child voxels of current node and return to parent node.

Definition at line 82 of file octree_iterator.hpp.

---

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

• /usr/src/RPM/BUILD/PCL-1.6.0-Source/octree/include/pcl/octree/octree_iterator.h
• /usr/src/RPM/BUILD/PCL-1.6.0-Source/octree/include/pcl/octree/impl/octree_iterator.hpp