Point Cloud Library (PCL)  1.14.1-dev
List of all members | Public Types | Public Member Functions | Protected Attributes
pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT > Class Template Reference
Module outofcore

#include <pcl/outofcore/outofcore_breadth_first_iterator.h>

+ Inheritance diagram for pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >:
+ Collaboration diagram for pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >:

Public Types

using OctreeDisk = pcl::outofcore::OutofcoreOctreeBase< ContainerT, PointT >
 
using OctreeDiskNode = pcl::outofcore::OutofcoreOctreeBaseNode< ContainerT, PointT >
 
using LeafNode = pcl::outofcore::OutofcoreOctreeBaseNode< ContainerT, PointT >
 
using BranchNode = pcl::outofcore::OutofcoreOctreeBaseNode< ContainerT, PointT >
 
- Public Types inherited from pcl::outofcore::OutofcoreIteratorBase< pcl::PointXYZ, OutofcoreOctreeDiskContainer< pcl::PointXYZ > >
using iterator_category = std::forward_iterator_tag
 
using value_type = const OutofcoreOctreeBaseNode< OutofcoreOctreeDiskContainer< pcl::PointXYZ >, pcl::PointXYZ >
 
using difference_type = void
 
using pointer = const OutofcoreOctreeBaseNode< OutofcoreOctreeDiskContainer< pcl::PointXYZ >, pcl::PointXYZ > *
 
using reference = const OutofcoreOctreeBaseNode< OutofcoreOctreeDiskContainer< pcl::PointXYZ >, pcl::PointXYZ > &
 
using OctreeDisk = pcl::outofcore::OutofcoreOctreeBase< OutofcoreOctreeDiskContainer< pcl::PointXYZ >, pcl::PointXYZ >
 
using OctreeDiskNode = pcl::outofcore::OutofcoreOctreeBaseNode< OutofcoreOctreeDiskContainer< pcl::PointXYZ >, pcl::PointXYZ >
 
using BranchNode = typename pcl::outofcore::OutofcoreOctreeBase< OutofcoreOctreeDiskContainer< pcl::PointXYZ >, pcl::PointXYZ >::BranchNode
 
using LeafNode = typename pcl::outofcore::OutofcoreOctreeBase< OutofcoreOctreeDiskContainer< pcl::PointXYZ >, pcl::PointXYZ >::LeafNode
 
using OutofcoreNodeType = typename OctreeDisk::OutofcoreNodeType
 

Public Member Functions

 OutofcoreBreadthFirstIterator (OctreeDisk &octree_arg)
 
 ~OutofcoreBreadthFirstIterator () override
 
OutofcoreBreadthFirstIterator & operator++ ()
 
OutofcoreBreadthFirstIterator operator++ (int)
 
void reset () override
 
void skipChildVoxels ()
 
- Public Member Functions inherited from pcl::outofcore::OutofcoreIteratorBase< pcl::PointXYZ, OutofcoreOctreeDiskContainer< pcl::PointXYZ > >
 OutofcoreIteratorBase (OctreeDisk &octree_arg)
 
 OutofcoreIteratorBase (const OutofcoreIteratorBase &src)
 
virtual ~OutofcoreIteratorBase ()=default
 
OutofcoreIteratorBase & operator= (const OutofcoreIteratorBase &src)
 
OutofcoreNodeType * operator* () const
 
virtual OutofcoreNodeType * getCurrentOctreeNode () const
 
void setMaxDepth (unsigned int max_depth)
 

Protected Attributes

std::deque< OctreeDiskNode * > FIFO_
 FIFO list. More...
 
bool skip_child_voxels_
 
- Protected Attributes inherited from pcl::outofcore::OutofcoreIteratorBase< pcl::PointXYZ, OutofcoreOctreeDiskContainer< pcl::PointXYZ > >
OctreeDisk & octree_
 
OctreeDiskNode * currentNode_
 
unsigned int currentOctreeDepth_
 
unsigned int max_depth_
 

Detailed Description

template<typename PointT = pcl::PointXYZ, typename ContainerT = OutofcoreOctreeDiskContainer<pcl::PointXYZ>>
class pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >

Author
Justin Rosen (jmyle.nosp@m.sros.nosp@m.en@gm.nosp@m.ail..nosp@m.com)
Note
Code adapted from octree_iterator.h in Module pcl::octree written by Julius Kammerl

Definition at line 57 of file outofcore_breadth_first_iterator.h.

Member Typedef Documentation

◆ BranchNode

template<typename PointT = pcl::PointXYZ, typename ContainerT = OutofcoreOctreeDiskContainer<pcl::PointXYZ>>
using pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::BranchNode = pcl::outofcore::OutofcoreOctreeBaseNode<ContainerT, PointT>

Definition at line 64 of file outofcore_breadth_first_iterator.h.

◆ LeafNode

template<typename PointT = pcl::PointXYZ, typename ContainerT = OutofcoreOctreeDiskContainer<pcl::PointXYZ>>
using pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::LeafNode = pcl::outofcore::OutofcoreOctreeBaseNode<ContainerT, PointT>

Definition at line 63 of file outofcore_breadth_first_iterator.h.

◆ OctreeDisk

template<typename PointT = pcl::PointXYZ, typename ContainerT = OutofcoreOctreeDiskContainer<pcl::PointXYZ>>
using pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::OctreeDisk = pcl::outofcore::OutofcoreOctreeBase<ContainerT, PointT>

Definition at line 60 of file outofcore_breadth_first_iterator.h.

◆ OctreeDiskNode

template<typename PointT = pcl::PointXYZ, typename ContainerT = OutofcoreOctreeDiskContainer<pcl::PointXYZ>>
using pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::OctreeDiskNode = pcl::outofcore::OutofcoreOctreeBaseNode<ContainerT, PointT>

Definition at line 61 of file outofcore_breadth_first_iterator.h.

Constructor & Destructor Documentation

◆ OutofcoreBreadthFirstIterator()

template<typename PointT = pcl::PointXYZ, typename ContainerT = OutofcoreOctreeDiskContainer<pcl::PointXYZ>>
pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::OutofcoreBreadthFirstIterator ( OctreeDisk &  octree_arg)
explicit

Definition at line 48 of file outofcore_breadth_first_iterator.hpp.

References pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::reset().

◆ ~OutofcoreBreadthFirstIterator()

template<typename PointT , typename ContainerT >
pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::~OutofcoreBreadthFirstIterator ( )
overridedefault

Member Function Documentation

◆ operator++() [1/2]

template<typename PointT , typename ContainerT >
OutofcoreBreadthFirstIterator< PointT, ContainerT > & pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::operator++

Definition at line 63 of file outofcore_breadth_first_iterator.hpp.

References pcl::octree::BRANCH_NODE, pcl::outofcore::OutofcoreOctreeBaseNode< ContainerT, PointT >::getDepth(), and pcl::outofcore::OutofcoreOctreeBaseNode< ContainerT, PointT >::getNodeType().

◆ operator++() [2/2]

template<typename PointT = pcl::PointXYZ, typename ContainerT = OutofcoreOctreeDiskContainer<pcl::PointXYZ>>
OutofcoreBreadthFirstIterator pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::operator++ ( int  )
inline

Definition at line 77 of file outofcore_breadth_first_iterator.h.

◆ reset()

template<typename PointT = pcl::PointXYZ, typename ContainerT = OutofcoreOctreeDiskContainer<pcl::PointXYZ>>
void pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::reset ( )
inlineoverridevirtual

Reimplemented from pcl::outofcore::OutofcoreIteratorBase< pcl::PointXYZ, OutofcoreOctreeDiskContainer< pcl::PointXYZ > >.

Definition at line 85 of file outofcore_breadth_first_iterator.h.

References pcl::outofcore::OutofcoreIteratorBase< pcl::PointXYZ, OutofcoreOctreeDiskContainer< pcl::PointXYZ > >::currentNode_, pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::FIFO_, pcl::outofcore::OutofcoreIteratorBase< PointT, ContainerT >::reset(), and pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::skip_child_voxels_.

Referenced by pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::OutofcoreBreadthFirstIterator().

◆ skipChildVoxels()

template<typename PointT = pcl::PointXYZ, typename ContainerT = OutofcoreOctreeDiskContainer<pcl::PointXYZ>>
void pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::skipChildVoxels ( )
inline

Definition at line 98 of file outofcore_breadth_first_iterator.h.

References pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::skip_child_voxels_.

Member Data Documentation

◆ FIFO_

template<typename PointT = pcl::PointXYZ, typename ContainerT = OutofcoreOctreeDiskContainer<pcl::PointXYZ>>
std::deque<OctreeDiskNode*> pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::FIFO_
protected

FIFO list.

Definition at line 105 of file outofcore_breadth_first_iterator.h.

Referenced by pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::reset().

◆ skip_child_voxels_

template<typename PointT = pcl::PointXYZ, typename ContainerT = OutofcoreOctreeDiskContainer<pcl::PointXYZ>>
bool pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::skip_child_voxels_
protected

Definition at line 106 of file outofcore_breadth_first_iterator.h.

Referenced by pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::reset(), and pcl::outofcore::OutofcoreBreadthFirstIterator< PointT, ContainerT >::skipChildVoxels().

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