voxel_grid_graph_builder.h
Go to the documentation of this file.
1/*
2 * Software License Agreement (BSD License)
3 *
4 * Point Cloud Library (PCL) - www.pointclouds.org
5 * Copyright (c) 2014-, Open Perception, 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 the copyright holder(s) 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 */
37
38#ifndef PCL_GRAPH_VOXEL_GRID_GRAPH_BUILDER_H
39#define PCL_GRAPH_VOXEL_GRID_GRAPH_BUILDER_H
40
41#include "graph_builder.h"
42
43namespace pcl::graph
44{
45
46 /** This class builds a BGL graph representing an input dataset by using
47 * octree::OctreePointCloud.
48 *
49 * For additional information see documentation for \ref GraphBuilder.
50 *
51 * \author Sergey Alexandrov
52 * \ingroup graph */
53 template <typename PointT, typename GraphT>
54 class PCL_EXPORTS VoxelGridGraphBuilder : public GraphBuilder<PointT, GraphT>
55 {
56
57 using PCLBase<PointT>::initCompute;
58 using PCLBase<PointT>::deinitCompute;
59 using PCLBase<PointT>::indices_;
60 using PCLBase<PointT>::input_;
61 using GraphBuilder<PointT, GraphT>::point_to_vertex_map_;
62
63 public:
67
68 /** Constructor.
69 *
70 * \param[in] voxel_resolution resolution of the voxel grid */
71 VoxelGridGraphBuilder(float voxel_resolution) : voxel_resolution_(voxel_resolution)
72 {
73 }
74
75 virtual void compute(GraphT& graph);
76
77 inline void
78 setVoxelResolution(float resolution)
79 {
80 voxel_resolution_ = resolution;
81 }
82
83 inline float
85 {
86 return (voxel_resolution_);
87 }
88
89 private:
90 /// Resolution of the voxel grid.
91 float voxel_resolution_;
92 };
93
94} // namespace pcl::graph
95
97
98#endif /* PCL_GRAPH_VOXEL_GRID_GRAPH_BUILDER_H */
This is an abstract base class for building a BGL-compatible point cloud graph from a point cloud.
boost::graph_traits< GraphT >::vertex_descriptor VertexId
point_cloud_graph_traits< GraphT >::point_type PointOutT
Type of points in the output graph.
std::vector< VertexId > point_to_vertex_map_
PointT PointInT
Type of points in the input cloud.
VoxelGridGraphBuilder(float voxel_resolution)
Constructor.