39 #ifndef PCL_OCTREE_TREE_2BUF_BASE_H 40 #define PCL_OCTREE_TREE_2BUF_BASE_H 44 #include <pcl/octree/octree_nodes.h> 45 #include <pcl/octree/octree_container.h> 46 #include <pcl/octree/octree_key.h> 47 #include <pcl/octree/octree_iterator.h> 55 template<
typename ContainerT>
81 for (b = 0; b < 2; ++b)
82 for (i = 0; i < 8; ++i)
108 getChildPtr (
unsigned char buffer_arg,
unsigned char index_arg)
const 110 assert( (buffer_arg<2) && (index_arg<8));
119 inline void setChildPtr (
unsigned char buffer_arg,
unsigned char index_arg,
122 assert( (buffer_arg<2) && (index_arg<8));
131 inline bool hasChild (
unsigned char buffer_arg,
unsigned char index_arg)
const 133 assert( (buffer_arg<2) && (index_arg<8));
223 template<
typename LeafContainerT = int,
247 Iterator
begin(
unsigned int max_depth_arg = 0) {
return Iterator(
this, max_depth_arg);};
248 const Iterator end() {
return Iterator();};
253 LeafNodeIterator
leaf_begin(
unsigned int max_depth_arg = 0) {
return LeafNodeIterator(
this, max_depth_arg);};
254 const LeafNodeIterator
leaf_end() {
return LeafNodeIterator();};
259 DepthFirstIterator
depth_begin(
unsigned int maxDepth_arg = 0) {
return DepthFirstIterator(
this, maxDepth_arg);};
260 const DepthFirstIterator
depth_end() {
return DepthFirstIterator();};
265 BreadthFirstIterator
breadth_begin(
unsigned int max_depth_arg = 0) {
return BreadthFirstIterator(
this, max_depth_arg);};
266 const BreadthFirstIterator
breadth_end() {
return BreadthFirstIterator();};
277 leaf_count_ (source.leaf_count_),
278 branch_count_ (source.branch_count_),
279 root_node_ (new (BranchNode) (*(source.root_node_))),
280 depth_mask_ (source.depth_mask_),
281 max_key_ (source.max_key_),
282 buffer_selector_ (source.buffer_selector_),
283 tree_dirty_flag_ (source.tree_dirty_flag_),
284 octree_depth_ (source.octree_depth_),
285 dynamic_depth_enabled_(source.dynamic_depth_enabled_)
295 root_node_ =
new (BranchNode) (* (source.
root_node_));
309 setMaxVoxelIndex (
unsigned int max_voxel_index_arg);
315 setTreeDepth (
unsigned int depth_arg);
322 return this->octree_depth_;
333 createLeaf (
unsigned int idx_x_arg,
unsigned int idx_y_arg,
unsigned int idx_z_arg);
343 findLeaf (
unsigned int idx_x_arg,
unsigned int idx_y_arg,
unsigned int idx_z_arg);
352 existLeaf (
unsigned int idx_x_arg,
unsigned int idx_y_arg,
unsigned int idx_z_arg)
const;
360 removeLeaf (
unsigned int idx_x_arg,
unsigned int idx_y_arg,
unsigned int idx_z_arg);
367 return (leaf_count_);
375 return (branch_count_);
386 treeCleanUpRecursive (root_node_);
392 buffer_selector_ = !buffer_selector_;
393 treeCleanUpRecursive (root_node_);
406 serializeTree (std::vector<char>& binary_tree_out_arg,
407 bool do_XOR_encoding_arg =
false);
415 serializeTree (std::vector<char>& binary_tree_out_arg,
416 std::vector<LeafContainerT*>& leaf_container_vector_arg,
417 bool do_XOR_encoding_arg =
false);
423 serializeLeafs (std::vector<LeafContainerT*>& leaf_container_vector_arg);
429 serializeNewLeafs (std::vector<LeafContainerT*>& leaf_container_vector_arg);
436 deserializeTree (std::vector<char>& binary_tree_in_arg,
437 bool do_XOR_decoding_arg =
false);
445 deserializeTree (std::vector<char>& binary_tree_in_arg,
446 std::vector<LeafContainerT*>& leaf_container_vector_arg,
447 bool do_XOR_decoding_arg =
false);
459 return (this->root_node_);
466 inline LeafContainerT*
469 LeafContainerT* result = 0;
470 findLeafRecursive (key_arg, depth_mask_, root_node_, result);
479 inline LeafContainerT*
483 BranchNode* leaf_node_parent;
485 createLeafRecursive (key_arg, depth_mask_ ,root_node_, leaf_node, leaf_node_parent,
false);
498 return (findLeaf(key_arg) != 0);
506 if (key_arg <= max_key_)
508 deleteLeafRecursive (key_arg, depth_mask_, root_node_);
511 tree_dirty_flag_ =
true;
528 return (branch_arg.
getChildPtr(buffer_selector_, child_idx_arg) != 0);
538 unsigned char child_idx_arg)
const 540 return branch_arg.
getChildPtr(buffer_selector_, child_idx_arg);
551 branch_arg.
setChildPtr (buffer_selector_, child_idx_arg, new_child_arg);
565 for (i = 0; i < 8; i++)
568 node_bits |=
static_cast<char> ( (!!child) << i);
580 unsigned char bufferSelector_arg)
const 587 for (i = 0; i < 8; i++)
590 node_bits |=
static_cast<char> ( (!!child) << i);
601 const BranchNode& branch_arg)
const 607 node_bits[0] = node_bits[1] = 0;
609 for (i = 0; i < 8; i++)
614 node_bits[0] |=
static_cast<char> ( (!!childA) << i);
615 node_bits[1] |=
static_cast<char> ( (!!childB) << i);
618 return node_bits[0] ^ node_bits[1];
627 return (getBranchXORBitPattern (branch_arg) > 0);
636 unsigned char buffer_selector_arg,
637 unsigned char child_idx_arg)
639 if (branch_arg.
hasChild(buffer_selector_arg, child_idx_arg))
648 deleteBranch (*static_cast<BranchNode*> (branchChild));
651 delete (branchChild);
658 delete (branchChild);
666 branch_arg.
setChildPtr(buffer_selector_arg, child_idx_arg, 0);
676 deleteBranchChild(branch_arg, buffer_selector_, child_idx_arg);
687 for (i = 0; i < 8; i++)
693 deleteBranchChild (branch_arg, 0, i);
701 deleteBranchChild (branch_arg, 0, i);
702 deleteBranchChild (branch_arg, 1, i);
713 unsigned char child_idx_arg)
715 BranchNode* new_branch_child =
new BranchNode();
717 branch_arg.
setChildPtr (buffer_selector_, child_idx_arg,
718 static_cast<OctreeNode*> (new_branch_child));
720 return new_branch_child;
731 LeafNode* new_leaf_child =
new LeafNode();
733 branch_arg.
setChildPtr(buffer_selector_, child_idx_arg, new_leaf_child);
735 return new_leaf_child;
752 createLeafRecursive (
const OctreeKey& key_arg,
753 unsigned int depth_mask_arg,
754 BranchNode* branch_arg,
755 LeafNode*& return_leaf_arg,
756 BranchNode*& parent_of_leaf_arg,
757 bool branch_reset_arg =
false);
768 findLeafRecursive (
const OctreeKey& key_arg,
769 unsigned int depth_mask_arg,
770 BranchNode* branch_arg,
771 LeafContainerT*& result_arg)
const;
781 deleteLeafRecursive (
const OctreeKey& key_arg,
782 unsigned int depth_mask_arg,
783 BranchNode* branch_arg);
794 serializeTreeRecursive (BranchNode* branch_arg,
796 std::vector<char>* binary_tree_out_arg,
797 typename std::vector<LeafContainerT*>* leaf_container_vector_arg,
798 bool do_XOR_encoding_arg =
false,
799 bool new_leafs_filter_arg =
false);
813 deserializeTreeRecursive (BranchNode* branch_arg,
814 unsigned int depth_mask_arg,
816 typename std::vector<char>::const_iterator& binary_tree_in_it_arg,
817 typename std::vector<char>::const_iterator& binary_tree_in_it_end_arg,
818 typename std::vector<LeafContainerT*>::const_iterator* leaf_container_vector_it_arg,
819 typename std::vector<LeafContainerT*>::const_iterator* leaf_container_vector_it_end_arg,
820 bool branch_reset_arg =
false,
821 bool do_XOR_decoding_arg =
false);
850 treeCleanUpRecursive (BranchNode* branch_arg);
856 inline double Log2 (
double n_arg)
858 return log (n_arg) / log (2.0);
874 unsigned char mask = 1;
877 for (
int i = 0; i < 8; i++)
880 std::cout << ((data_arg & (mask << i)) ?
"1" :
"0");
882 std::cout << std::endl;
921 #ifdef PCL_NO_PRECOMPILE 922 #include <pcl/octree/impl/octree2buf_base.hpp> LeafContainerT * createLeaf(const OctreeKey &key_arg)
Create a leaf node.
double Log2(double n_arg)
Helper function to calculate the binary logarithm.
OctreeNode * getChildPtr(unsigned char buffer_arg, unsigned char index_arg) const
Get child pointer in current branch node.
LeafNodeIterator leaf_begin(unsigned int max_depth_arg=0)
const OctreeLeafNodeIterator< OctreeT > ConstLeafNodeIterator
virtual node_type_t getNodeType() const
Get the type of octree node.
bool octreeCanResize()
Test if octree is able to dynamically change its depth.
ContainerT * getContainerPtr()
Get pointer to container.
virtual ~BufferedBranchNode()
Empty constructor.
unsigned int octree_depth_
Octree depth.
Octree2BufBase(const Octree2BufBase &source)
Copy constructor.
const OctreeBreadthFirstIterator< OctreeT > ConstBreadthFirstIterator
char getBranchBitPattern(const BranchNode &branch_arg) const
Generate bit pattern reflecting the existence of child node pointers for current buffer.
virtual BufferedBranchNode * deepCopy() const
Method to perform a deep copy of the octree.
virtual node_type_t getNodeType() const =0
Pure virtual method for receiving the type of octree node (branch or leaf)
const DepthFirstIterator depth_end()
const ContainerT & operator*() const
Get const reference to container.
void setBranchChildPtr(BranchNode &branch_arg, unsigned char child_idx_arg, OctreeNode *new_child_arg)
Assign new child node to branch.
bool branchHasChild(const BranchNode &branch_arg, unsigned char child_idx_arg) const
Check if branch is pointing to a particular child node.
LeafNode * createLeafChild(BranchNode &branch_arg, unsigned char child_idx_arg)
Fetch and add a new leaf child to a branch class.
OctreeNode * getRootNode() const
Retrieve root node.
OctreeKey max_key_
key range
const OctreeDepthFirstIterator< OctreeT > ConstDepthFirstIterator
void deleteBranch(BranchNode &branch_arg)
Delete branch and all its subchilds from octree (both buffers)
LeafContainerT LeafContainer
Octree leaf node iterator class.
void deleteBranchChild(BranchNode &branch_arg, unsigned char child_idx_arg)
Delete child node and all its subchilds from octree in current buffer.
const OctreeDepthFirstIterator< OctreeT > ConstIterator
BranchContainerT BranchContainer
OctreeLeafNodeIterator< OctreeT > LeafNodeIterator
BreadthFirstIterator breadth_begin(unsigned int max_depth_arg=0)
void deleteBranchChild(BranchNode &branch_arg, unsigned char buffer_selector_arg, unsigned char child_idx_arg)
Delete child node and all its subchilds from octree in specific buffer.
bool dynamic_depth_enabled_
Enable dynamic_depth.
std::size_t getLeafCount() const
Return the amount of existing leafs in the octree.
virtual void deserializeTreeCallback(LeafContainerT &, const OctreeKey &)
Callback executed for every leaf node data during deserialization.
BufferedBranchNode()
Empty constructor.
const ContainerT & getContainer() const
Get const reference to container.
OctreeLeafNode< LeafContainerT > LeafNode
void deleteCurrentBuffer()
Delete the octree structure in the current buffer.
std::size_t branch_count_
Amount of branch nodes.
void deletePreviousBuffer()
Delete octree structure of previous buffer.
const BreadthFirstIterator breadth_end()
OctreeDepthFirstIterator< OctreeT > Iterator
OctreeNode * getBranchChildPtr(const BranchNode &branch_arg, unsigned char child_idx_arg) const
Retrieve a child node pointer for child node at child_idx.
char getBranchXORBitPattern(const BranchNode &branch_arg) const
Generate XOR bit pattern reflecting differences between the two octree buffers.
virtual OctreeNode * deepCopy() const =0
Pure virtual method to perform a deep copy of the octree.
Abstract octree leaf class
const ContainerT * operator->() const
Get const pointer to container.
const LeafNodeIterator leaf_end()
unsigned char buffer_selector_
Currently active octree buffer.
BufferedBranchNode< BranchContainerT > BranchNode
Iterator begin(unsigned int max_depth_arg=0)
void printBinary(char data_arg)
Prints binary representation of a byte - used for debugging.
const ContainerT * getContainerPtr() const
Get const pointer to container.
virtual void serializeTreeCallback(LeafContainerT &, const OctreeKey &)
Callback executed for every leaf node data during serialization.
Abstract octree iterator class
ContainerT & getContainer()
Get reference to container.
Octree double buffer class
void removeLeaf(const OctreeKey &key_arg)
Remove leaf node from octree.
BranchNode * createBranchChild(BranchNode &branch_arg, unsigned char child_idx_arg)
Fetch and add a new branch child to a branch class in current buffer.
std::size_t getBranchCount() const
Return the amount of existing branches in the octree.
BranchNode * root_node_
Pointer to root branch node of octree.
unsigned int depth_mask_
Depth mask based on octree depth.
char getBranchBitPattern(const BranchNode &branch_arg, unsigned char bufferSelector_arg) const
Generate bit pattern reflecting the existence of child node pointers in specific buffer.
void setChildPtr(unsigned char buffer_arg, unsigned char index_arg, OctreeNode *newNode_arg)
Set child pointer in current branch node.
bool hasBranchChanges(const BranchNode &branch_arg) const
Test if branch changed between previous and current buffer.
DepthFirstIterator depth_begin(unsigned int maxDepth_arg=0)
LeafContainerT * findLeaf(const OctreeKey &key_arg) const
Find leaf node.
Octree container class that does not store any information.
bool existLeaf(const OctreeKey &key_arg) const
Check for leaf not existance in the octree.
const ContainerT * getContainerPtr() const
Get const pointer to container.
OctreeNode * child_node_array_[2][8]
Abstract octree node class
Octree2BufBase< LeafContainerT, BranchContainerT > OctreeT
std::size_t leaf_count_
Amount of leaf nodes.
unsigned int getTreeDepth() const
Get the maximum depth of the octree.
BufferedBranchNode(const BufferedBranchNode &source)
Copy constructor.
void reset()
Reset branch node container for every branch buffer.
BufferedBranchNode & operator=(const BufferedBranchNode &source_arg)
Copy operator.
bool hasChild(unsigned char buffer_arg, unsigned char index_arg) const
Check if branch is pointing to a particular child node.