Point Cloud Library (PCL)  1.11.1-dev
List of all members | Public Types | Public Member Functions | Protected Attributes
pcl::octree::OctreeIteratorBase< OctreeT > Class Template Reference
Module octree

Abstract octree iterator class More...

#include <pcl/octree/octree_iterator.h>

+ Inheritance diagram for pcl::octree::OctreeIteratorBase< OctreeT >:

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...
 

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/3]

template<typename OctreeT >
pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( unsigned int  max_depth_arg = 0)
inlineexplicit

Empty constructor.

Definition at line 85 of file octree_iterator.h.

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

◆ OctreeIteratorBase() [2/3]

template<typename OctreeT >
pcl::octree::OctreeIteratorBase< OctreeT >::OctreeIteratorBase ( OctreeT *  octree_arg,
unsigned int  max_depth_arg = 0 
)
inlineexplicit

Constructor.

Parameters
[in]octree_argOctree to be iterated. Initially the iterator is set to its root node.
[in]max_depth_argDepth limitation during traversal

Definition at line 96 of file octree_iterator.h.

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

◆ OctreeIteratorBase() [3/3]

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

Constructor.

Parameters
[in]octree_argOctree to be iterated. Initially the iterator is set to its root node.
[in]max_depth_argDepth limitation during traversal
[in]current_stateA pointer to the current iterator state
Warning
For advanced users only.

Definition at line 110 of file octree_iterator.h.

◆ ~OctreeIteratorBase()

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

Empty deconstructor.

Definition at line 117 of file octree_iterator.h.

Member Function Documentation

◆ getBranchContainer() [1/2]

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

Method for retrieving the container from an octree branch node.

Returns
BranchContainer.

Definition at line 305 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_.

◆ getBranchContainer() [2/2]

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

Method for retrieving the container from an octree branch node.

Returns
BranchContainer.

Definition at line 290 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_.

◆ getCurrentOctreeDepth()

template<typename OctreeT >
unsigned int pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeDepth ( ) const
inline

Get the current depth level of octree.

Returns
depth level

Definition at line 173 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, OctreeContainerPointIndex, OctreeContainerEmpty, OctreeBase< OctreeContainerPointIndex, OctreeContainerEmpty > >::getVoxelBounds().

◆ getCurrentOctreeKey()

template<typename OctreeT >
const OctreeKey& pcl::octree::OctreeIteratorBase< OctreeT >::getCurrentOctreeKey ( ) const
inline

Get octree key for the current iterator octree node.

Returns
octree key of current node

Definition at line 161 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, OctreeContainerPointIndex, OctreeContainerEmpty, OctreeBase< OctreeContainerPointIndex, OctreeContainerEmpty > >::getVoxelBounds().

◆ 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 185 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 275 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 260 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 236 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

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

Returns
node id.

Definition at line 320 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.

◆ isBranchNode()

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

check if current node is a branch node

Returns
true if current node is a branch node, false otherwise

Definition at line 197 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().

◆ isLeafNode()

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

check if current node is a branch node

Returns
true if current node is a branch node, false otherwise

Definition at line 209 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().

◆ operator!=()

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

Inequal comparison operator.

Parameters
[in]otherOctreeIteratorBase to compare with

Definition at line 142 of file octree_iterator.h.

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

◆ operator*()

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

*operator.

Returns
pointer to the current octree node

Definition at line 221 of file octree_iterator.h.

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

◆ operator==()

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

Equal comparison operator.

Parameters
[in]otherOctreeIteratorBase to compare with

Definition at line 123 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!=().

◆ reset()

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

Reset iterator.

Definition at line 149 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().

Member Data Documentation

◆ current_state_

template<typename OctreeT >
IteratorState* pcl::octree::OctreeIteratorBase< OctreeT >::current_state_
protected

Pointer to current iterator state.

Definition at line 344 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::OctreeLeafNodeDepthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::operator=(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator=(), pcl::octree::OctreeIteratorBase< OctreeT >::operator==(), and pcl::octree::OctreeIteratorBase< OctreeT >::reset().

◆ max_octree_depth_

template<typename OctreeT >
unsigned int pcl::octree::OctreeIteratorBase< OctreeT >::max_octree_depth_
protected

Maximum octree depth.

Definition at line 347 of file octree_iterator.h.

Referenced by pcl::octree::OctreeIteratorBase< OctreeT >::operator==(), and pcl::octree::OctreeIteratorBase< OctreeT >::reset().

◆ octree_

template<typename OctreeT >
OctreeT* pcl::octree::OctreeIteratorBase< OctreeT >::octree_
protected

Reference to octree class.

Definition at line 341 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().

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