Point Cloud Library (PCL)
1.14.1-dev
|
Abstract octree iterator class More...
#include <pcl/octree/octree_iterator.h>
Public Types | |
using | iterator_category = std::forward_iterator_tag |
using | value_type = const OctreeNode |
using | difference_type = void |
using | pointer = const OctreeNode * |
using | reference = const OctreeNode & |
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 ()=default |
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... | |
virtual OctreeIteratorBase & | operator++ ()=0 |
Preincrement operator. 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... | |
virtual 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... | |
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 87 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::BranchNode = typename OctreeT::BranchNode |
Definition at line 84 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::difference_type = void |
Definition at line 79 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::iterator_category = std::forward_iterator_tag |
Definition at line 77 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::LeafContainer = typename OctreeT::LeafContainer |
Definition at line 86 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::LeafNode = typename OctreeT::LeafNode |
Definition at line 83 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::pointer = const OctreeNode* |
Definition at line 80 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::reference = const OctreeNode& |
Definition at line 81 of file octree_iterator.h.
using pcl::octree::OctreeIteratorBase< OctreeT >::value_type = const OctreeNode |
Definition at line 78 of file octree_iterator.h.
|
inline |
Empty constructor.
Definition at line 91 of file octree_iterator.h.
|
inlineexplicit |
Constructor.
[in] | max_depth_arg | Depth limitation during traversal |
Definition at line 96 of file octree_iterator.h.
References pcl::octree::OctreeIteratorBase< OctreeT >::reset().
|
inline |
Constructor.
[in] | octree_arg | Octree to be iterated. Initially the iterator is set to its root node. |
Definition at line 106 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 113 of file octree_iterator.h.
References pcl::octree::OctreeIteratorBase< OctreeT >::reset().
|
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 127 of file octree_iterator.h.
|
virtualdefault |
Empty deconstructor.
|
inline |
Method for retrieving the container from an octree branch node.
Definition at line 328 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_.
|
inline |
Method for retrieving the container from an octree branch node.
Definition at line 313 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_.
|
inline |
Get the current depth level of octree.
Definition at line 196 of file octree_iterator.h.
References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::depth_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.
Referenced by pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::getVoxelBounds().
|
inline |
Get octree key for the current iterator octree node.
Definition at line 184 of file octree_iterator.h.
References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::key_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.
Referenced by pcl::octree::OctreeIteratorBase< OctreeT >::getNodeID(), and pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::getVoxelBounds().
|
inline |
Get the current octree node.
Definition at line 208 of file octree_iterator.h.
References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::node_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.
|
inline |
Method for retrieving a single leaf container from the octree leaf node.
Definition at line 298 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_.
|
inline |
Method for retrieving a single leaf container from the octree leaf node.
Definition at line 283 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_.
|
inline |
Get bit pattern of children configuration of current node.
Definition at line 259 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_.
|
inlinevirtual |
get a integer identifier for current node (note: identifier depends on tree depth).
Definition at line 343 of file octree_iterator.h.
References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeKey(), pcl::octree::OctreeIteratorBase< OctreeT >::octree_, 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 220 of file octree_iterator.h.
References pcl::octree::BRANCH_NODE, pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeNode::getNodeType(), pcl::octree::IteratorState::node_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.
Referenced by pcl::octree::OctreeIteratorBase< OctreeT >::getBranchContainer(), and pcl::octree::OctreeIteratorBase< OctreeT >::getNodeConfiguration().
|
inline |
check if current node is a branch node
Definition at line 232 of file octree_iterator.h.
References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeNode::getNodeType(), pcl::octree::LEAF_NODE, pcl::octree::IteratorState::node_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.
Referenced by pcl::octree::OctreeIteratorBase< OctreeT >::getLeafContainer().
|
inline |
Inequal comparison operator.
[in] | other | OctreeIteratorBase to compare with |
Definition at line 159 of file octree_iterator.h.
References pcl::octree::OctreeIteratorBase< OctreeT >::operator==().
|
inlinevirtual |
*operator.
Reimplemented in pcl::octree::OctreeLeafNodeBreadthFirstIterator< OctreeT >, and pcl::octree::OctreeLeafNodeDepthFirstIterator< OctreeT >.
Definition at line 244 of file octree_iterator.h.
References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::IteratorState::node_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.
|
pure virtual |
Preincrement operator.
Implemented in pcl::octree::OctreeLeafNodeBreadthFirstIterator< OctreeT >, pcl::octree::OctreeLeafNodeDepthFirstIterator< OctreeT >, pcl::octree::OctreeBreadthFirstIterator< OctreeT >, and pcl::octree::OctreeDepthFirstIterator< OctreeT >.
|
inline |
Equal comparison operator.
[in] | other | OctreeIteratorBase to compare with |
Definition at line 140 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_.
Referenced by pcl::octree::OctreeIteratorBase< OctreeT >::operator!=().
|
inline |
Reset iterator.
Definition at line 166 of file octree_iterator.h.
References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeIteratorBase< OctreeT >::max_octree_depth_, and pcl::octree::OctreeIteratorBase< OctreeT >::octree_.
Referenced by pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator(), pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset(), and pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset().
|
protected |
Pointer to current iterator state.
Definition at line 367 of file octree_iterator.h.
Referenced by pcl::octree::OctreeIteratorBase< OctreeT >::getBranchContainer(), pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeDepth(), pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeKey(), pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeNode(), pcl::octree::OctreeIteratorBase< OctreeT >::getLeafContainer(), pcl::octree::OctreeIteratorBase< OctreeT >::getNodeConfiguration(), pcl::octree::OctreeIteratorBase< OctreeT >::getNodeID(), pcl::octree::OctreeIteratorBase< OctreeT >::isBranchNode(), pcl::octree::OctreeIteratorBase< OctreeT >::isLeafNode(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::OctreeDepthFirstIterator(), pcl::octree::OctreeIteratorBase< OctreeT >::operator*(), pcl::octree::OctreeLeafNodeDepthFirstIterator< OctreeT >::operator*(), pcl::octree::OctreeLeafNodeBreadthFirstIterator< OctreeT >::operator*(), pcl::octree::OctreeLeafNodeDepthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator=(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::operator=(), pcl::octree::OctreeIteratorBase< OctreeT >::operator==(), and pcl::octree::OctreeIteratorBase< OctreeT >::reset().
|
protected |
Maximum octree depth.
Definition at line 370 of file octree_iterator.h.
Referenced by pcl::octree::OctreeIteratorBase< OctreeT >::operator==(), and pcl::octree::OctreeIteratorBase< OctreeT >::reset().
|
protected |
Reference to octree class.
Definition at line 364 of file octree_iterator.h.
Referenced by pcl::octree::OctreeIteratorBase< OctreeT >::getBranchContainer(), pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeDepth(), pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeKey(), pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeNode(), pcl::octree::OctreeIteratorBase< OctreeT >::getLeafContainer(), pcl::octree::OctreeIteratorBase< OctreeT >::getNodeConfiguration(), pcl::octree::OctreeIteratorBase< OctreeT >::getNodeID(), pcl::octree::OctreeIteratorBase< OctreeT >::isBranchNode(), pcl::octree::OctreeIteratorBase< OctreeT >::isLeafNode(), pcl::octree::OctreeIteratorBase< OctreeT >::operator*(), pcl::octree::OctreeIteratorBase< OctreeT >::operator==(), and pcl::octree::OctreeIteratorBase< OctreeT >::reset().