pcl::octree::OctreeKey Class Reference

Octree key class More...

#include <pcl/octree/octree_key.h>

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

Public Attributes
union {
struct {
uindex_t   x
uindex_t   y
uindex_t   z
}
uindex_t   key_ [3]
};

Static Public Attributes
static const unsigned char	maxDepth

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 54 of file octree_key.h.

Constructor & Destructor Documentation

OctreeKey() [1/3]

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

inline

Empty constructor.

Definition at line 57 of file octree_key.h.

References x, y, and z.

Referenced by OctreeKey(), operator!=(), operator<=(), operator=(), operator==(), and operator>=().

OctreeKey() [2/3]

pcl::octree::OctreeKey::OctreeKey ( uindex_t keyX, uindex_t keyY, uindex_t keyZ )

inline

Constructor for key initialization.

Definition at line 60 of file octree_key.h.

References x, y, and z.

OctreeKey() [3/3]

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

inline

Copy constructor.

Definition at line 63 of file octree_key.h.

References key_, and OctreeKey().

Member Function Documentation

getChildIdxWithDepthMask()

unsigned char pcl::octree::OctreeKey::getChildIdxWithDepthMask ( uindex_t depthMask ) const

inline

get child node index using depthMask

Parameters

[in]

depthMask

bit mask with single bit set at query depth

Returns

child node index

Definition at line 134 of file octree_key.h.

References x, y, and z.

Referenced by pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::addPointIdx(), pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::createLeafRecursive(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::findLeafRecursive(), and pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::findLeafRecursive().

operator!=()

bool pcl::octree::OctreeKey::operator!= ( const OctreeKey & other ) const

inline

Inequal comparison operator.

Parameters

[in]

other

OctreeIteratorBase to compare with

Returns

"true" if the current and other iterators are different ; "false" otherwise.

Definition at line 83 of file octree_key.h.

References OctreeKey(), and operator==().

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 92 of file octree_key.h.

References OctreeKey(), x, y, and z.

operator=()

OctreeKey & pcl::octree::OctreeKey::operator= ( const OctreeKey & )

default

References OctreeKey().

operator==()

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 72 of file octree_key.h.

References OctreeKey(), x, y, and z.

Referenced by operator!=().

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 103 of file octree_key.h.

References OctreeKey(), x, y, and z.

popBranch()

void pcl::octree::OctreeKey::popBranch ( )

inline

pop child node from octree key

Definition at line 122 of file octree_key.h.

References x, y, and z.

Referenced by pcl::octree::OctreeBase< OctreeContainerPointIndices, OctreeContainerEmpty >::deserializeTree(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::deserializeTreeRecursive(), pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::deserializeTreeRecursive(), pcl::octree::OctreePointCloudVoxelCentroid< PointT, LeafContainerT, BranchContainerT >::getVoxelCentroidsRecursive(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::operator++(), and pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::serializeTreeRecursive().

pushBranch()

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

inline

push a child node to the octree key

Parameters

[in]

childIndex

index of child node to be added (0-7)

Definition at line 112 of file octree_key.h.

References x, y, and z.

Referenced by pcl::octree::OctreeBase< OctreeContainerPointIndices, OctreeContainerEmpty >::deserializeTree(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::deserializeTreeRecursive(), pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::deserializeTreeRecursive(), pcl::octree::OctreePointCloudVoxelCentroid< PointT, LeafContainerT, BranchContainerT >::getVoxelCentroidsRecursive(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::operator++(), and pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::serializeTreeRecursive().

Member Data Documentation

[union]

union { ... } pcl::octree::OctreeKey

key_

uindex_t pcl::octree::OctreeKey::key_[3]

Definition at line 153 of file octree_key.h.

Referenced by OctreeKey().

maxDepth

const unsigned char pcl::octree::OctreeKey::maxDepth

static

Initial value:

=
      static_cast<unsigned char>(sizeof(uindex_t) * 8)

Definition at line 142 of file octree_key.h.

Referenced by pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::getKeyBitSize(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::setMaxVoxelIndex(), pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::setMaxVoxelIndex(), and pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::setTreeDepth().

x

uindex_t pcl::octree::OctreeKey::x

Definition at line 149 of file octree_key.h.

Referenced by pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::approxNearestSearch(), 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::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genOctreeKeyforPoint(), pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::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(), OctreeKey(), OctreeKey(), operator<=(), operator==(), operator>=(), popBranch(), pushBranch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::radiusSearch(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset(), and pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::testForOcclusion().

y

uindex_t pcl::octree::OctreeKey::y

Definition at line 150 of file octree_key.h.

Referenced by pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::approxNearestSearch(), 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::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genOctreeKeyforPoint(), pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::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(), OctreeKey(), OctreeKey(), operator<=(), operator==(), operator>=(), popBranch(), pushBranch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::radiusSearch(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset(), and pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::testForOcclusion().

z

uindex_t pcl::octree::OctreeKey::z

Definition at line 151 of file octree_key.h.

Referenced by pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::approxNearestSearch(), 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::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::genOctreeKeyforPoint(), pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::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(), OctreeKey(), OctreeKey(), operator<=(), operator==(), operator>=(), popBranch(), pushBranch(), pcl::octree::OctreePointCloudSearch< PointT, LeafContainerT, BranchContainerT >::radiusSearch(), pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset(), pcl::octree::OctreeDepthFirstIterator< OctreeT >::reset(), and pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::testForOcclusion().

---

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

• pcl/octree/octree_key.h