Point Cloud Library (PCL)  1.12.1-dev
io.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: io.h 2413 2011-09-07 07:01:00Z rusu $
37  *
38  */
39 
40 #pragma once
41 
42 #include <pcl/point_cloud.h>
43 
44 namespace pcl
45 {
46  /** \brief Get a set of approximate indices for a given point cloud into a reference point cloud.
47  * The coordinates of the two point clouds can differ. The method uses an internal KdTree for
48  * finding the closest neighbors from \a cloud_in in \a cloud_ref.
49  *
50  * \param[in] cloud_in the input point cloud dataset
51  * \param[in] cloud_ref the reference point cloud dataset
52  * \param[out] indices the resultant set of nearest neighbor indices of \a cloud_in in \a cloud_ref
53  * \ingroup kdtree
54  */
55  template <typename PointT> void
57  const typename pcl::PointCloud<PointT>::ConstPtr &cloud_ref,
58  Indices &indices);
59 
60  /** \brief Get a set of approximate indices for a given point cloud into a reference point cloud.
61  * The coordinates of the two point clouds can differ. The method uses an internal KdTree for
62  * finding the closest neighbors from \a cloud_in in \a cloud_ref.
63  *
64  * \param[in] cloud_in the input point cloud dataset
65  * \param[in] cloud_ref the reference point cloud dataset
66  * \param[out] indices the resultant set of nearest neighbor indices of \a cloud_in in \a cloud_ref
67  * \ingroup kdtree
68  */
69  template <typename Point1T, typename Point2T> void
71  const typename pcl::PointCloud<Point2T>::ConstPtr &cloud_ref,
72  Indices &indices);
73 }
74 
75 #include <pcl/kdtree/impl/io.hpp>
shared_ptr< const PointCloud< PointT > > ConstPtr
Definition: point_cloud.h:414
void getApproximateIndices(const typename pcl::PointCloud< PointT >::ConstPtr &cloud_in, const typename pcl::PointCloud< PointT >::ConstPtr &cloud_ref, Indices &indices)
Get a set of approximate indices for a given point cloud into a reference point cloud.
Definition: io.hpp:67
IndicesAllocator<> Indices
Type used for indices in PCL.
Definition: types.h:133