pcl::octree::OctreeKey Class Reference

Octree key class More...

#include <pcl/octree/octree_key.h>

Classes
union	[union].__unnamed0__

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

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

Constructor & Destructor Documentation

OctreeKey() [1/3]

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

inline

Empty constructor.

Definition at line 55 of file octree_key.h.

Referenced by pcl::octree::OctreePointCloudAdjacency< PointT, LeafContainerT, BranchContainerT >::genOctreeKeyforPoint(), 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 58 of file octree_key.h.

OctreeKey() [3/3]

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

inline

Copy constructor.

Definition at line 61 of file octree_key.h.

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

Referenced by pcl::octree::OctreePointCloud< PointT, LeafContainerT, BranchContainerT, OctreeT >::addPointIdx(), pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::deleteLeafRecursive(), pcl::octree::Octree2BufBase< OctreeContainerPointIndices, OctreeContainerEmpty >::deserializeTree(), pcl::octree::OctreeBase< OctreeContainerPointIndices, OctreeContainerEmpty >::findLeaf(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::findLeafRecursive(), and pcl::octree::Octree2BufBase< OctreeContainerPointIndices, OctreeContainerEmpty >::setTreeDepth().

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

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

Referenced by operator<=().

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

References OctreeKey().

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

References OctreeKey().

popBranch()

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

inline

pop child node from octree key

Definition at line 120 of file octree_key.h.

Referenced by 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++(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::serializeTreeRecursive(), and pcl::octree::OctreeBase< 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 110 of file octree_key.h.

Referenced by 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++(), pcl::octree::Octree2BufBase< LeafContainerT, BranchContainerT >::serializeTreeRecursive(), and pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::serializeTreeRecursive().

Member Data Documentation

@077041350173033224163311043016364132262035166212

union pcl::octree::OctreeKey::[union].__unnamed0__ pcl::octree::OctreeKey

maxDepth

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

static

Initial value:

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

Definition at line 140 of file octree_key.h.

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

---

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

• pcl/octree/octree_key.h