W3cubDocs

/PointCloudLibrary

Abstract octree iterator class More...

#include <pcl/octree/octree_iterator.h>

Public Types

using LeafNode = typename OctreeT::LeafNode
using BranchNode = typename OctreeT::BranchNode
using LeafContainer = typename OctreeT::LeafContainer
using BranchContainer = typename OctreeT::BranchContainer

Public Member Functions

OctreeIteratorBase ()
Empty constructor. More...
OctreeIteratorBase (uindex_t max_depth_arg)
Constructor. More...
OctreeIteratorBase (OctreeT *octree_arg)
Constructor. More...
OctreeIteratorBase (OctreeT *octree_arg, uindex_t max_depth_arg)
Constructor. More...
OctreeIteratorBase (OctreeT *octree_arg, uindex_t max_depth_arg, IteratorState *current_state)
Constructor. More...
virtual ~OctreeIteratorBase ()
Empty deconstructor. More...
bool operator== (const OctreeIteratorBase &other) const
Equal comparison operator. More...
bool operator!= (const OctreeIteratorBase &other) const
Inequal comparison operator. More...
void reset ()
Reset iterator. More...
const OctreeKey & getCurrentOctreeKey () const
Get octree key for the current iterator octree node. More...
uindex_t getCurrentOctreeDepth () const
Get the current depth level of octree. More...
OctreeNode * getCurrentOctreeNode () const
Get the current octree node. More...
bool isBranchNode () const
check if current node is a branch node More...
bool isLeafNode () const
check if current node is a branch node More...
OctreeNode * operator* () const
*operator. More...
char getNodeConfiguration () const
Get bit pattern of children configuration of current node. More...
const LeafContainer & getLeafContainer () const
Method for retrieving a single leaf container from the octree leaf node. More...
LeafContainer & getLeafContainer ()
Method for retrieving a single leaf container from the octree leaf node. More...
const BranchContainer & getBranchContainer () const
Method for retrieving the container from an octree branch node. More...
BranchContainer & getBranchContainer ()
Method for retrieving the container from an octree branch node. More...
virtual unsigned long getNodeID () const
get a integer identifier for current node (note: identifier depends on tree depth). More...

Protected Attributes

OctreeT * octree_
Reference to octree class. More...
IteratorState * current_state_
Pointer to current iterator state. More...
uindex_t max_octree_depth_
Maximum octree depth. More...

Detailed Description

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

Abstract octree iterator class

Note
Octree iterator base class
Author
Julius Kammerl (juliu.nosp@m.s@ka.nosp@m.mmerl.nosp@m..de)

Definition at line 71 of file octree_iterator.h.

Member Typedef Documentation

BranchContainer

template<typename OctreeT >
using pcl::octree::OctreeIteratorBase< OctreeT >::BranchContainer = typename OctreeT::BranchContainer

Definition at line 81 of file octree_iterator.h.

BranchNode

template<typename OctreeT >
using pcl::octree::OctreeIteratorBase< OctreeT >::BranchNode = typename OctreeT::BranchNode

Definition at line 78 of file octree_iterator.h.

LeafContainer

template<typename OctreeT >
using pcl::octree::OctreeIteratorBase< OctreeT >::LeafContainer = typename OctreeT::LeafContainer

Definition at line 80 of file octree_iterator.h.

LeafNode

template<typename OctreeT >
using pcl::octree::OctreeIteratorBase< OctreeT >::LeafNode = typename OctreeT::LeafNode

Definition at line 77 of file octree_iterator.h.

Constructor & Destructor Documentation

OctreeIteratorBase() [1/5]

template<typename OctreeT >
pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( )
inline

Empty constructor.

Definition at line 85 of file octree_iterator.h.

OctreeIteratorBase() [2/5]

template<typename OctreeT >
pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( uindex_t max_depth_arg )
inlineexplicit

Constructor.

Parameters
[in] max_depth_arg Depth limitation during traversal

Definition at line 90 of file octree_iterator.h.

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

OctreeIteratorBase() [3/5]

template<typename OctreeT >
pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( OctreeT * octree_arg )
inline

Constructor.

Parameters
[in] octree_arg Octree to be iterated. Initially the iterator is set to its root node.

Definition at line 100 of file octree_iterator.h.

OctreeIteratorBase() [4/5]

template<typename OctreeT >
pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( OctreeT * octree_arg,
uindex_t max_depth_arg
)
inlineexplicit

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 107 of file octree_iterator.h.

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

OctreeIteratorBase() [5/5]

template<typename OctreeT >
pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( OctreeT * octree_arg,
uindex_t max_depth_arg,
IteratorState * current_state
)
inlineexplicit

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
[in] current_state A pointer to the current iterator state
Warning
For advanced users only.

Definition at line 121 of file octree_iterator.h.

~OctreeIteratorBase()

template<typename OctreeT >
virtual pcl::octree::OctreeIteratorBase< OctreeT >::~OctreeIteratorBase ( )
inlinevirtual

Empty deconstructor.

Definition at line 128 of file octree_iterator.h.

Member Function Documentation

getBranchContainer() [1/2]

template<typename OctreeT >
BranchContainer& pcl::octree::OctreeIteratorBase< OctreeT >::getBranchContainer ( )
inline

getBranchContainer() [2/2]

template<typename OctreeT >
const BranchContainer& pcl::octree::OctreeIteratorBase< OctreeT >::getBranchContainer ( ) const
inline

getCurrentOctreeDepth()

getCurrentOctreeKey()

getCurrentOctreeNode()

template<typename OctreeT >
OctreeNode* pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeNode ( ) const
inline

Get the current octree node.

Returns
pointer to current octree node

Definition at line 196 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::node_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

getLeafContainer() [1/2]

template<typename OctreeT >
LeafContainer& pcl::octree::OctreeIteratorBase< OctreeT >::getLeafContainer ( )
inline

Method for retrieving a single leaf container from the octree leaf node.

Returns
Reference to container class of leaf node.

Definition at line 286 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeIteratorBase< OctreeT >::isLeafNode(), pcl::octree::IteratorState::node_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

getLeafContainer() [2/2]

template<typename OctreeT >
const LeafContainer& pcl::octree::OctreeIteratorBase< OctreeT >::getLeafContainer ( ) const
inline

Method for retrieving a single leaf container from the octree leaf node.

Returns
Reference to container class of leaf node.

Definition at line 271 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeIteratorBase< OctreeT >::isLeafNode(), pcl::octree::IteratorState::node_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

getNodeConfiguration()

template<typename OctreeT >
char pcl::octree::OctreeIteratorBase< OctreeT >::getNodeConfiguration ( ) const
inline

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 247 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeIteratorBase< OctreeT >::isBranchNode(), pcl::octree::IteratorState::node_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

getNodeID()

template<typename OctreeT >
virtual unsigned long pcl::octree::OctreeIteratorBase< OctreeT >::getNodeID ( ) const
inlinevirtual

isBranchNode()

isLeafNode()

template<typename OctreeT >
bool pcl::octree::OctreeIteratorBase< OctreeT >::isLeafNode ( ) const
inline

operator!=()

template<typename OctreeT >
bool pcl::octree::OctreeIteratorBase< OctreeT >::operator!= ( const OctreeIteratorBase< OctreeT > & other ) const
inline

Inequal comparison operator.

Parameters
[in] other OctreeIteratorBase to compare with

Definition at line 153 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::operator==().

operator*()

template<typename OctreeT >
OctreeNode* pcl::octree::OctreeIteratorBase< OctreeT >::operator* ( ) const
inline

operator==()

template<typename OctreeT >
bool pcl::octree::OctreeIteratorBase< OctreeT >::operator== ( const OctreeIteratorBase< OctreeT > & other ) const
inline

reset()

Member Data Documentation

current_state_

max_octree_depth_

template<typename OctreeT >
uindex_t pcl::octree::OctreeIteratorBase< OctreeT >::max_octree_depth_
protected

octree_


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

© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/classpcl_1_1octree_1_1_octree_iterator_base.html