Point Cloud Library (PCL)  1.14.1-dev
octree_pointcloud_pointvector.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Point Cloud Library (PCL) - www.pointclouds.org
5  * Copyright (c) 2010-2011, Willow Garage, Inc.
6  *
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * * Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  * * Redistributions in binary form must reproduce the above
16  * copyright notice, this list of conditions and the following
17  * disclaimer in the documentation and/or other materials provided
18  * with the distribution.
19  * * Neither the name of Willow Garage, Inc. nor the names of its
20  * contributors may be used to endorse or promote products derived
21  * from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *
36  * $Id$
37  */
38 
39 #pragma once
40 
41 #include <pcl/octree/octree_pointcloud.h>
42 
43 namespace pcl {
44 namespace octree {
45 
46 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
47 /** \brief @b Octree pointcloud point vector class
48  * \note This pointcloud octree class generate an octrees from a point cloud
49  * (zero-copy). Every leaf node contains a list of point indices of the dataset given by
50  * \a setInputCloud.
51  * \note The octree pointcloud is initialized with its voxel resolution. Its bounding
52  * box is automatically adjusted or can be predefined.
53  * \tparam PointT type of point used in pointcloud
54  * \ingroup octree
55  * \author Julius Kammerl (julius@kammerl.de)
56  */
57 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
58 template <typename PointT,
59  typename LeafContainerT = OctreeContainerPointIndices,
60  typename BranchContainerT = OctreeContainerEmpty,
61  typename OctreeT = OctreeBase<LeafContainerT, BranchContainerT>>
63 : public OctreePointCloud<PointT, LeafContainerT, BranchContainerT, OctreeT> {
64 
65 public:
66  // public typedefs for single/double buffering
67  using SingleBuffer =
69  LeafContainerT,
70  BranchContainerT,
72  // typedef OctreePointCloudPointVector<PointT, LeafContainerT, BranchContainerT,
73  // Octree2BufBase<int, LeafContainerT, BranchContainerT> > DoubleBuffer;
74 
75  /** \brief Constructor.
76  * \param resolution_arg: octree resolution at lowest octree level
77  * */
78  OctreePointCloudPointVector(const double resolution_arg)
79  : OctreePointCloud<PointT, LeafContainerT, BranchContainerT, OctreeT>(resolution_arg)
80  {}
81 
82  /** \brief Empty class constructor. */
83  ~OctreePointCloudPointVector() override = default;
84 };
85 } // namespace octree
86 } // namespace pcl
87 
88 #define PCL_INSTANTIATE_OctreePointCloudPointVector(T) \
89  template class PCL_EXPORTS pcl::octree::OctreePointCloudPointVector<T>;
Octree pointcloud class
~OctreePointCloudPointVector() override=default
Empty class constructor.
OctreePointCloudPointVector(const double resolution_arg)
Constructor.
A point structure representing Euclidean xyz coordinates, and the RGB color.