Point Cloud Library (PCL)
1.10.0dev

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 (unsigned int max_depth_arg=0)  
Empty constructor. More...  
OctreeIteratorBase (OctreeT *octree_arg, unsigned int max_depth_arg=0)  
Constructor. More...  
OctreeIteratorBase (OctreeT *octree_arg, unsigned int 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...  
unsigned int  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...  
unsigned int  max_octree_depth_ 
Maximum octree depth. More...  
Abstract octree iterator class
Definition at line 75 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::BranchContainer = typename OctreeT::BranchContainer 
Definition at line 84 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::BranchNode = typename OctreeT::BranchNode 
Definition at line 81 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::LeafContainer = typename OctreeT::LeafContainer 
Definition at line 83 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::LeafNode = typename OctreeT::LeafNode 
Definition at line 80 of file octree_iterator.h.

inlineexplicit 
Empty constructor.
Definition at line 89 of file octree_iterator.h.

inlineexplicit 
Constructor.
[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 100 of file octree_iterator.h.

inlineexplicit 
Constructor.
[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 
Definition at line 114 of file octree_iterator.h.

inlinevirtual 
Empty deconstructor.
Definition at line 124 of file octree_iterator.h.

inline 
Method for retrieving the container from an octree branch node.
Definition at line 299 of file octree_iterator.h.

inline 
Method for retrieving the container from an octree branch node.
Definition at line 314 of file octree_iterator.h.

inline 
Get the current depth level of octree.
Definition at line 180 of file octree_iterator.h.
Referenced by pcl::octree::OctreePointCloud< PointT, LeafTWrap, BranchTWrap >::getVoxelBounds(), and pcl::octree::OctreeFixedDepthIterator< OctreeT >::reset().

inline 
Get octree key for the current iterator octree node.
Definition at line 168 of file octree_iterator.h.
Referenced by pcl::octree::OctreePointCloud< PointT, LeafTWrap, BranchTWrap >::getVoxelBounds().

inline 
Get the current octree node.
Definition at line 192 of file octree_iterator.h.

inline 
Method for retrieving a single leaf container from the octree leaf node.
Definition at line 269 of file octree_iterator.h.

inline 
Method for retrieving a single leaf container from the octree leaf node.
Definition at line 284 of file octree_iterator.h.

inline 
Get bit pattern of children configuration of current node.
Definition at line 244 of file octree_iterator.h.

inlinevirtual 
get a integer identifier for current node (note: identifier depends on tree depth).
Definition at line 329 of file octree_iterator.h.
References pcl::octree::OctreeKey::x, pcl::octree::OctreeKey::y, and pcl::octree::OctreeKey::z.

inline 
check if current node is a branch node
Definition at line 205 of file octree_iterator.h.
References pcl::octree::BRANCH_NODE.

inline 
check if current node is a branch node
Definition at line 217 of file octree_iterator.h.
References pcl::octree::LEAF_NODE.

inline 
Inequal comparison operator.
[in]  other  OctreeIteratorBase to compare with 
Definition at line 149 of file octree_iterator.h.
References pcl::operator==().

inline 
*operator.
Definition at line 229 of file octree_iterator.h.

inline 
Equal comparison operator.
[in]  other  OctreeIteratorBase to compare with 
Definition at line 131 of file octree_iterator.h.
References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::key_, pcl::octree::OctreeIteratorBase< OctreeT >::max_octree_depth_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.

inline 
Reset iterator.
Definition at line 155 of file octree_iterator.h.
Referenced by pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset(), and pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset().

protected 
Pointer to current iterator state.
Definition at line 354 of file octree_iterator.h.
Referenced by pcl::octree::OctreeDepthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeLeafNodeBreadthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeIteratorBase< OctreeT >::operator==(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset(), pcl::octree::OctreeFixedDepthIterator< OctreeT >::reset(), and pcl::octree::OctreeDepthFirstIterator< OctreeT >::skipChildVoxels().

protected 
Maximum octree depth.
Definition at line 357 of file octree_iterator.h.
Referenced by pcl::octree::OctreeDepthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeIteratorBase< OctreeT >::operator==(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset(), and pcl::octree::OctreeFixedDepthIterator< OctreeT >::reset().

protected 
Reference to octree class.
Definition at line 351 of file octree_iterator.h.
Referenced by pcl::octree::OctreeDepthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeIteratorBase< OctreeT >::operator==(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset(), and pcl::octree::OctreeFixedDepthIterator< OctreeT >::reset().