Point Cloud Library (PCL)  1.8.1-dev
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
List of all members | Public Member Functions | Public Attributes | Static Public Attributes
pcl::octree::OctreeKey Class Reference

Octree key class More...

#include <pcl/octree/octree_key.h>

Public Member Functions

 OctreeKey ()
 Empty constructor. More...
 
 OctreeKey (unsigned int keyX, unsigned int keyY, unsigned int keyZ)
 Constructor for key initialization. More...
 
 OctreeKey (const OctreeKey &source)
 Copy constructor. More...
 
bool operator== (const OctreeKey &b) const
 Operator== for comparing octree keys with each other. More...
 
bool operator!= (const OctreeKey &other) const
 Inequal comparison operator. More...
 
bool operator<= (const OctreeKey &b) const
 Operator<= for comparing octree keys with each other. More...
 
bool operator>= (const OctreeKey &b) const
 Operator>= for comparing octree keys with each other. More...
 
void pushBranch (unsigned char childIndex)
 push a child node to the octree key More...
 
void popBranch ()
 pop child node from octree key More...
 
unsigned char getChildIdxWithDepthMask (unsigned int depthMask) const
 get child node index using depthMask More...
 

Public Attributes

union {
   struct {
      uint32_t   x
 
      uint32_t   y
 
      uint32_t   z
 
   } 
 
   uint32_t   key_ [3]
 
}; 
 

Static Public Attributes

static const unsigned char maxDepth = static_cast<unsigned char>(sizeof(uint32_t)*8)
 

Detailed Description

Octree key class

Note
Octree keys contain integer indices for each coordinate axis in order to address an octree leaf node.
Author
Julius Kammerl (juliu.nosp@m.s@ka.nosp@m.mmerl.nosp@m..de)

Definition at line 51 of file octree_key.h.

Constructor & Destructor Documentation

pcl::octree::OctreeKey::OctreeKey ( )
inline

Empty constructor.

Definition at line 56 of file octree_key.h.

pcl::octree::OctreeKey::OctreeKey ( unsigned int  keyX,
unsigned int  keyY,
unsigned int  keyZ 
)
inline

Constructor for key initialization.

Definition at line 62 of file octree_key.h.

pcl::octree::OctreeKey::OctreeKey ( const OctreeKey source)
inline

Copy constructor.

Definition at line 68 of file octree_key.h.

References key_.

Member Function Documentation

unsigned char pcl::octree::OctreeKey::getChildIdxWithDepthMask ( unsigned int  depthMask) const
inline
bool pcl::octree::OctreeKey::operator!= ( const OctreeKey other) const
inline

Inequal comparison operator.

Parameters
[in]otherOctreeIteratorBase to compare with
Returns
"true" if the current and other iterators are different ; "false" otherwise.

Definition at line 86 of file octree_key.h.

References operator==().

bool pcl::octree::OctreeKey::operator<= ( const OctreeKey b) const
inline

Operator<= for comparing octree keys with each other.

Returns
"true" if key indices are not greater than the key indices of b ; "false" otherwise.

Definition at line 95 of file octree_key.h.

References x, y, and z.

bool pcl::octree::OctreeKey::operator== ( const OctreeKey b) const
inline

Operator== for comparing octree keys with each other.

Returns
"true" if leaf node indices are identical; "false" otherwise.

Definition at line 77 of file octree_key.h.

References x, y, and z.

Referenced by operator!=().

bool pcl::octree::OctreeKey::operator>= ( const OctreeKey b) const
inline

Operator>= for comparing octree keys with each other.

Returns
"true" if key indices are not smaller than the key indices of b ; "false" otherwise.

Definition at line 104 of file octree_key.h.

References x, y, and z.

void pcl::octree::OctreeKey::popBranch ( )
inline
void pcl::octree::OctreeKey::pushBranch ( unsigned char  childIndex)
inline

Member Data Documentation

union { ... }
uint32_t pcl::octree::OctreeKey::key_[3]

Definition at line 155 of file octree_key.h.

Referenced by OctreeKey().

const unsigned char pcl::octree::OctreeKey::maxDepth = static_cast<unsigned char>(sizeof(uint32_t)*8)
static
uint32_t pcl::octree::OctreeKey::x

Definition at line 151 of file octree_key.h.

Referenced by pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::approxNearestSearch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::approxNearestSearchRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::boxSearch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::boxSearchRecursive(), pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::computeNeighbors(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genLeafNodeCenterFromOctreeKey(), pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::genOctreeKeyforPoint(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genOctreeKeyforPoint(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genVoxelBoundsFromOctreeKey(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genVoxelCenterFromOctreeKey(), getChildIdxWithDepthMask(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelCenters(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelCentersRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelIndices(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelIndicesRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getKNearestNeighborRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getNeighborsWithinRadiusRecursive(), pcl::octree::OctreeIteratorBase< OctreeT >::getNodeID(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::getOccupiedVoxelCenters(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::getOccupiedVoxelCentersRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::nearestKSearch(), operator<=(), operator==(), operator>=(), popBranch(), pushBranch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::radiusSearch(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset(), and pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::testForOcclusion().

uint32_t pcl::octree::OctreeKey::y

Definition at line 152 of file octree_key.h.

Referenced by pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::approxNearestSearch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::approxNearestSearchRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::boxSearch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::boxSearchRecursive(), pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::computeNeighbors(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genLeafNodeCenterFromOctreeKey(), pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::genOctreeKeyforPoint(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genOctreeKeyforPoint(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genVoxelBoundsFromOctreeKey(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genVoxelCenterFromOctreeKey(), getChildIdxWithDepthMask(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelCenters(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelCentersRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelIndices(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelIndicesRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getKNearestNeighborRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getNeighborsWithinRadiusRecursive(), pcl::octree::OctreeIteratorBase< OctreeT >::getNodeID(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::getOccupiedVoxelCenters(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::getOccupiedVoxelCentersRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::nearestKSearch(), operator<=(), operator==(), operator>=(), popBranch(), pushBranch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::radiusSearch(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset(), and pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::testForOcclusion().

uint32_t pcl::octree::OctreeKey::z

Definition at line 153 of file octree_key.h.

Referenced by pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::approxNearestSearch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::approxNearestSearchRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::boxSearch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::boxSearchRecursive(), pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::computeNeighbors(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genLeafNodeCenterFromOctreeKey(), pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::genOctreeKeyforPoint(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genOctreeKeyforPoint(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genVoxelBoundsFromOctreeKey(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genVoxelCenterFromOctreeKey(), getChildIdxWithDepthMask(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelCenters(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelCentersRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelIndices(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getIntersectedVoxelIndicesRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getKNearestNeighborRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::getNeighborsWithinRadiusRecursive(), pcl::octree::OctreeIteratorBase< OctreeT >::getNodeID(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::getOccupiedVoxelCenters(), pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::getOccupiedVoxelCentersRecursive(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::nearestKSearch(), operator<=(), operator==(), operator>=(), popBranch(), pushBranch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::radiusSearch(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset(), and pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::testForOcclusion().


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