Point Cloud Library (PCL) 1.15.1-dev
Loading...
Searching...
No Matches
mls.hpp
1/*
2 * Software License Agreement (BSD License)
3 *
4 * Point Cloud Library (PCL) - www.pointclouds.org
5 * Copyright (c) 2009-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
40#ifndef PCL_SURFACE_IMPL_MLS_H_
41#define PCL_SURFACE_IMPL_MLS_H_
42
43#include <pcl/common/centroid.h>
44#include <pcl/common/common.h> // for getMinMax3D
45#include <pcl/common/copy_point.h>
46#include <pcl/common/eigen.h>
47#include <pcl/search/auto.h>
48#include <pcl/surface/mls.h>
49#include <pcl/type_traits.h>
50
51#include <Eigen/Geometry> // for cross
52#include <Eigen/LU> // for inverse
53
54#include <memory>
55
56#ifdef _OPENMP
57#include <omp.h>
58#endif
59
60//////////////////////////////////////////////////////////////////////////////////////////////
61template <typename PointInT, typename PointOutT> void
63{
64 // Reset or initialize the collection of indices
65 corresponding_input_indices_.reset (new PointIndices);
66
67 normals_.reset (new NormalCloud); // always init this since it is dereferenced in performUpsampling
68 // Check if normals have to be computed/saved
69 if (compute_normals_)
70 {
71 // Copy the header
72 normals_->header = input_->header;
73 // Clear the fields in case the method exits before computation
74 normals_->width = normals_->height = 0;
75 normals_->points.clear ();
76 }
77
78 // Copy the header
79 output.header = input_->header;
80 output.width = output.height = 0;
81 output.clear ();
82
83 if (search_radius_ <= 0 || sqr_gauss_param_ <= 0)
84 {
85 PCL_ERROR ("[pcl::%s::process] Invalid search radius (%f) or Gaussian parameter (%f)!\n", getClassName ().c_str (), search_radius_, sqr_gauss_param_);
86 return;
87 }
88
89 // Check if distinct_cloud_ was set
90 if (upsample_method_ == DISTINCT_CLOUD && !distinct_cloud_)
91 {
92 PCL_ERROR ("[pcl::%s::process] Upsample method was set to DISTINCT_CLOUD, but no distinct cloud was specified.\n", getClassName ().c_str ());
93 return;
94 }
95
96 if (!initCompute ())
97 return;
98
99 // Initialize the spatial locator
100 if (!tree_)
101 {
102 KdTreePtr tree (pcl::search::autoSelectMethod<PointInT> (input_, false));
103 setSearchMethod (tree);
104 }
105 else
106 {
107 // Send the surface dataset to the spatial locator
108 tree_->setInputCloud (input_);
109 }
110
111 switch (upsample_method_)
112 {
113 // Initialize random number generator if necessary
114 case (RANDOM_UNIFORM_DENSITY):
115 {
116 std::random_device rd;
117 rng_.seed (rd());
118 const double tmp = search_radius_ / 2.0;
119 rng_uniform_distribution_ = std::make_unique<std::uniform_real_distribution<>> (-tmp, tmp);
120
121 break;
122 }
123 case (VOXEL_GRID_DILATION):
124 case (DISTINCT_CLOUD):
125 {
126 if (!cache_mls_results_)
127 PCL_WARN ("The cache mls results is forced when using upsampling method VOXEL_GRID_DILATION or DISTINCT_CLOUD.\n");
128
129 cache_mls_results_ = true;
130 break;
131 }
132 default:
133 break;
134 }
135
136 if (cache_mls_results_)
137 {
138 mls_results_.resize (input_->size ());
139 }
140 else
141 {
142 mls_results_.resize (1); // Need to have a reference to a single dummy result.
143 }
144
145 // Perform the actual surface reconstruction
146 performProcessing (output);
147
148 if (compute_normals_)
149 {
150 normals_->height = 1;
151 normals_->width = normals_->size ();
152
153 for (std::size_t i = 0; i < output.size (); ++i)
154 {
155 using FieldList = typename pcl::traits::fieldList<PointOutT>::type;
156 pcl::for_each_type<FieldList> (SetIfFieldExists<PointOutT, float> (output[i], "normal_x", (*normals_)[i].normal_x));
157 pcl::for_each_type<FieldList> (SetIfFieldExists<PointOutT, float> (output[i], "normal_y", (*normals_)[i].normal_y));
158 pcl::for_each_type<FieldList> (SetIfFieldExists<PointOutT, float> (output[i], "normal_z", (*normals_)[i].normal_z));
159 pcl::for_each_type<FieldList> (SetIfFieldExists<PointOutT, float> (output[i], "curvature", (*normals_)[i].curvature));
160 }
161
162 }
163
164 // Set proper widths and heights for the clouds
165 output.height = 1;
166 output.width = output.size ();
167
168 deinitCompute ();
169}
170
171//////////////////////////////////////////////////////////////////////////////////////////////
172template <typename PointInT, typename PointOutT> void
174 const pcl::Indices &nn_indices,
175 PointCloudOut &projected_points,
176 NormalCloud &projected_points_normals,
177 PointIndices &corresponding_input_indices,
178 MLSResult &mls_result) const
179{
180 // Note: this method is const because it needs to be thread-safe
181 // (MovingLeastSquaresOMP calls it from multiple threads)
182
183 mls_result.computeMLSSurface<PointInT> (*input_, index, nn_indices, search_radius_, order_);
184
185 switch (upsample_method_)
186 {
187 case (NONE):
188 {
189 const MLSResult::MLSProjectionResults proj = mls_result.projectQueryPoint (projection_method_, nr_coeff_);
190 addProjectedPointNormal (index, proj.point, proj.normal, mls_result.curvature, projected_points, projected_points_normals, corresponding_input_indices);
191 break;
192 }
193
194 case (SAMPLE_LOCAL_PLANE):
195 {
196 // Uniformly sample a circle around the query point using the radius and step parameters
197 for (float u_disp = -static_cast<float> (upsampling_radius_); u_disp <= upsampling_radius_; u_disp += static_cast<float> (upsampling_step_))
198 for (float v_disp = -static_cast<float> (upsampling_radius_); v_disp <= upsampling_radius_; v_disp += static_cast<float> (upsampling_step_))
199 if (u_disp * u_disp + v_disp * v_disp < upsampling_radius_ * upsampling_radius_)
200 {
202 addProjectedPointNormal (index, proj.point, proj.normal, mls_result.curvature, projected_points, projected_points_normals, corresponding_input_indices);
203 }
204 break;
205 }
206
207 case (RANDOM_UNIFORM_DENSITY):
208 {
209 // Compute the local point density and add more samples if necessary
210 const int num_points_to_add = static_cast<int> (std::floor (desired_num_points_in_radius_ / 2.0 / static_cast<double> (nn_indices.size ())));
211
212 // Just add the query point, because the density is good
213 if (num_points_to_add <= 0)
214 {
215 // Just add the current point
216 const MLSResult::MLSProjectionResults proj = mls_result.projectQueryPoint (projection_method_, nr_coeff_);
217 addProjectedPointNormal (index, proj.point, proj.normal, mls_result.curvature, projected_points, projected_points_normals, corresponding_input_indices);
218 }
219 else
220 {
221 // Sample the local plane
222 for (int num_added = 0; num_added < num_points_to_add;)
223 {
224 const double u = (*rng_uniform_distribution_) (rng_);
225 const double v = (*rng_uniform_distribution_) (rng_);
226
227 // Check if inside circle; if not, try another coin flip
228 if (u * u + v * v > search_radius_ * search_radius_ / 4)
229 continue;
230
232 if (order_ > 1 && mls_result.num_neighbors >= 5 * nr_coeff_)
233 proj = mls_result.projectPointSimpleToPolynomialSurface (u, v);
234 else
235 proj = mls_result.projectPointToMLSPlane (u, v);
236
237 addProjectedPointNormal (index, proj.point, proj.normal, mls_result.curvature, projected_points, projected_points_normals, corresponding_input_indices);
238
239 num_added++;
240 }
241 }
242 break;
243 }
244
245 default:
246 break;
247 }
248}
249
250template <typename PointInT, typename PointOutT> void
252 const Eigen::Vector3d &point,
253 const Eigen::Vector3d &normal,
254 double curvature,
255 PointCloudOut &projected_points,
256 NormalCloud &projected_points_normals,
257 PointIndices &corresponding_input_indices) const
258{
259 PointOutT aux;
260 aux.x = static_cast<float> (point[0]);
261 aux.y = static_cast<float> (point[1]);
262 aux.z = static_cast<float> (point[2]);
263
264 // Copy additional point information if available
265 copyMissingFields ((*input_)[index], aux);
266
267 projected_points.push_back (aux);
268 corresponding_input_indices.indices.push_back (index);
269
270 if (compute_normals_)
271 {
272 pcl::Normal aux_normal;
273 aux_normal.normal_x = static_cast<float> (normal[0]);
274 aux_normal.normal_y = static_cast<float> (normal[1]);
275 aux_normal.normal_z = static_cast<float> (normal[2]);
276 aux_normal.curvature = curvature;
277 projected_points_normals.push_back (aux_normal);
278 }
279}
280
281//////////////////////////////////////////////////////////////////////////////////////////////
282template <typename PointInT, typename PointOutT> void
284{
285 // Compute the number of coefficients
286 nr_coeff_ = (order_ + 1) * (order_ + 2) / 2;
287
288#ifdef _OPENMP
289 // (Maximum) number of threads
290 const unsigned int threads = threads_ == 0 ? 1 : threads_;
291 // Create temporaries for each thread in order to avoid synchronization
292 typename PointCloudOut::CloudVectorType projected_points (threads);
293 typename NormalCloud::CloudVectorType projected_points_normals (threads);
294 std::vector<PointIndices> corresponding_input_indices (threads);
295#endif
296
297 // For all points
298#pragma omp parallel for \
299 default(none) \
300 shared(corresponding_input_indices, projected_points, projected_points_normals) \
301 schedule(dynamic,1000) \
302 num_threads(threads)
303 for (int cp = 0; cp < static_cast<int> (indices_->size ()); ++cp)
304 {
305 // Allocate enough space to hold the results of nearest neighbor searches
306 // \note resize is irrelevant for a radiusSearch ().
307 pcl::Indices nn_indices;
308 std::vector<float> nn_sqr_dists;
309
310 // Get the initial estimates of point positions and their neighborhoods
311 if (searchForNeighbors ((*indices_)[cp], nn_indices, nn_sqr_dists))
312 {
313 // Check the number of nearest neighbors for normal estimation (and later for polynomial fit as well)
314 if (nn_indices.size () >= 3)
315 {
316 // This thread's ID (range 0 to threads-1)
317#ifdef _OPENMP
318 const int tn = omp_get_thread_num ();
319 // Size of projected points before computeMLSPointNormal () adds points
320 std::size_t pp_size = projected_points[tn].size ();
321#else
322 PointCloudOut projected_points;
323 NormalCloud projected_points_normals;
324#endif
325
326 // Get a plane approximating the local surface's tangent and project point onto it
327 const int index = (*indices_)[cp];
328
329 std::size_t mls_result_index = 0;
330 if (cache_mls_results_)
331 mls_result_index = index; // otherwise we give it a dummy location.
332
333#ifdef _OPENMP
334 computeMLSPointNormal (index, nn_indices, projected_points[tn], projected_points_normals[tn], corresponding_input_indices[tn], mls_results_[mls_result_index]);
335
336 // Copy all information from the input cloud to the output points (not doing any interpolation)
337 for (std::size_t pp = pp_size; pp < projected_points[tn].size (); ++pp)
338 copyMissingFields ((*input_)[(*indices_)[cp]], projected_points[tn][pp]);
339#else
340 computeMLSPointNormal (index, nn_indices, projected_points, projected_points_normals, *corresponding_input_indices_, mls_results_[mls_result_index]);
341
342 // Append projected points to output
343 output.insert (output.end (), projected_points.begin (), projected_points.end ());
344 if (compute_normals_)
345 normals_->insert (normals_->end (), projected_points_normals.begin (), projected_points_normals.end ());
346#endif
347 }
348 }
349 }
350
351#ifdef _OPENMP
352 // Combine all threads' results into the output vectors
353 for (unsigned int tn = 0; tn < threads; ++tn)
354 {
355 output.insert (output.end (), projected_points[tn].begin (), projected_points[tn].end ());
356 corresponding_input_indices_->indices.insert (corresponding_input_indices_->indices.end (),
357 corresponding_input_indices[tn].indices.begin (), corresponding_input_indices[tn].indices.end ());
358 if (compute_normals_)
359 normals_->insert (normals_->end (), projected_points_normals[tn].begin (), projected_points_normals[tn].end ());
360 }
361#endif
362
363 // Perform the distinct-cloud or voxel-grid upsampling
364 performUpsampling (output);
365}
366
367//////////////////////////////////////////////////////////////////////////////////////////////
368template <typename PointInT, typename PointOutT> void
370{
371
372 if (upsample_method_ == DISTINCT_CLOUD)
373 {
374 corresponding_input_indices_.reset (new PointIndices);
375 for (std::size_t dp_i = 0; dp_i < distinct_cloud_->size (); ++dp_i) // dp_i = distinct_point_i
376 {
377 // Distinct cloud may have nan points, skip them
378 if (!std::isfinite ((*distinct_cloud_)[dp_i].x))
379 continue;
380
381 // Get 3D position of point
382 //Eigen::Vector3f pos = (*distinct_cloud_)[dp_i].getVector3fMap ();
383 pcl::Indices nn_indices;
384 std::vector<float> nn_dists;
385 tree_->nearestKSearch ((*distinct_cloud_)[dp_i], 1, nn_indices, nn_dists);
386 const auto input_index = nn_indices.front ();
387
388 // If the closest point did not have a valid MLS fitting result
389 // OR if it is too far away from the sampled point
390 if (!mls_results_[input_index].valid)
391 continue;
392
393 Eigen::Vector3d add_point = (*distinct_cloud_)[dp_i].getVector3fMap ().template cast<double> ();
394 MLSResult::MLSProjectionResults proj = mls_results_[input_index].projectPoint (add_point, projection_method_, 5 * nr_coeff_);
395 addProjectedPointNormal (input_index, proj.point, proj.normal, mls_results_[input_index].curvature, output, *normals_, *corresponding_input_indices_);
396 }
397 }
398
399 // For the voxel grid upsampling method, generate the voxel grid and dilate it
400 // Then, project the newly obtained points to the MLS surface
401 if (upsample_method_ == VOXEL_GRID_DILATION)
402 {
403 corresponding_input_indices_.reset (new PointIndices);
404
405 MLSVoxelGrid voxel_grid (input_, indices_, voxel_size_, dilation_iteration_num_);
406 for (int iteration = 0; iteration < dilation_iteration_num_; ++iteration)
407 voxel_grid.dilate ();
408
409 for (auto m_it = voxel_grid.voxel_grid_.begin (); m_it != voxel_grid.voxel_grid_.end (); ++m_it)
410 {
411 // Get 3D position of point
412 Eigen::Vector3f pos;
413 voxel_grid.getPosition (m_it->first, pos);
414
415 PointInT p;
416 p.x = pos[0];
417 p.y = pos[1];
418 p.z = pos[2];
419
420 pcl::Indices nn_indices (1);
421 std::vector<float> nn_dists (1);
422 tree_->nearestKSearch (p, 1, nn_indices, nn_dists);
423 const auto input_index = nn_indices.front ();
424
425 // If the closest point did not have a valid MLS fitting result
426 // OR if it is too far away from the sampled point
427 if (!mls_results_[input_index].valid)
428 continue;
429
430 Eigen::Vector3d add_point = p.getVector3fMap ().template cast<double> ();
431 MLSResult::MLSProjectionResults proj = mls_results_[input_index].projectPoint (add_point, projection_method_, 5 * nr_coeff_);
432 addProjectedPointNormal (input_index, proj.point, proj.normal, mls_results_[input_index].curvature, output, *normals_, *corresponding_input_indices_);
433 }
434 }
435}
436
437//////////////////////////////////////////////////////////////////////////////////////////////
438pcl::MLSResult::MLSResult (const Eigen::Vector3d &a_query_point,
439 const Eigen::Vector3d &a_mean,
440 const Eigen::Vector3d &a_plane_normal,
441 const Eigen::Vector3d &a_u,
442 const Eigen::Vector3d &a_v,
443 const Eigen::VectorXd &a_c_vec,
444 const int a_num_neighbors,
445 const float a_curvature,
446 const int a_order) :
447 query_point (a_query_point), mean (a_mean), plane_normal (a_plane_normal), u_axis (a_u), v_axis (a_v), c_vec (a_c_vec), num_neighbors (a_num_neighbors),
448 curvature (a_curvature), order (a_order), valid (true)
449{}
450
451void
452pcl::MLSResult::getMLSCoordinates (const Eigen::Vector3d &pt, double &u, double &v, double &w) const
453{
454 Eigen::Vector3d delta = pt - mean;
455 u = delta.dot (u_axis);
456 v = delta.dot (v_axis);
457 w = delta.dot (plane_normal);
458}
459
460void
461pcl::MLSResult::getMLSCoordinates (const Eigen::Vector3d &pt, double &u, double &v) const
462{
463 Eigen::Vector3d delta = pt - mean;
464 u = delta.dot (u_axis);
465 v = delta.dot (v_axis);
466}
467
468double
469pcl::MLSResult::getPolynomialValue (const double u, const double v) const
470{
471 // Compute the polynomial's terms at the current point
472 // Example for second order: z = a + b*y + c*y^2 + d*x + e*x*y + f*x^2
473 int j = 0;
474 double u_pow = 1;
475 double result = 0;
476 for (int ui = 0; ui <= order; ++ui)
477 {
478 double v_pow = 1;
479 for (int vi = 0; vi <= order - ui; ++vi)
480 {
481 result += c_vec[j++] * u_pow * v_pow;
482 v_pow *= v;
483 }
484 u_pow *= u;
485 }
486
487 return (result);
488}
489
491pcl::MLSResult::getPolynomialPartialDerivative (const double u, const double v) const
492{
493 // Compute the displacement along the normal using the fitted polynomial
494 // and compute the partial derivatives needed for estimating the normal
496 Eigen::VectorXd u_pow (order + 2), v_pow (order + 2);
497 int j = 0;
498
499 d.z = d.z_u = d.z_v = d.z_uu = d.z_vv = d.z_uv = 0;
500 u_pow (0) = v_pow (0) = 1;
501 for (int ui = 0; ui <= order; ++ui)
502 {
503 for (int vi = 0; vi <= order - ui; ++vi)
504 {
505 // Compute displacement along normal
506 d.z += u_pow (ui) * v_pow (vi) * c_vec[j];
507
508 // Compute partial derivatives
509 if (ui >= 1)
510 d.z_u += c_vec[j] * ui * u_pow (ui - 1) * v_pow (vi);
511
512 if (vi >= 1)
513 d.z_v += c_vec[j] * vi * u_pow (ui) * v_pow (vi - 1);
514
515 if (ui >= 1 && vi >= 1)
516 d.z_uv += c_vec[j] * ui * u_pow (ui - 1) * vi * v_pow (vi - 1);
517
518 if (ui >= 2)
519 d.z_uu += c_vec[j] * ui * (ui - 1) * u_pow (ui - 2) * v_pow (vi);
520
521 if (vi >= 2)
522 d.z_vv += c_vec[j] * vi * (vi - 1) * u_pow (ui) * v_pow (vi - 2);
523
524 if (ui == 0)
525 v_pow (vi + 1) = v_pow (vi) * v;
526
527 ++j;
528 }
529 u_pow (ui + 1) = u_pow (ui) * u;
530 }
531
532 return (d);
533}
534
536pcl::MLSResult::projectPointOrthogonalToPolynomialSurface (const double u, const double v, const double w) const
537{
538 double gu = u;
539 double gv = v;
540 double gw = 0;
541
543 result.normal = plane_normal;
544 if (order > 1 && c_vec.size () >= (order + 1) * (order + 2) / 2 && std::isfinite (c_vec[0]))
545 {
546 PolynomialPartialDerivative d = getPolynomialPartialDerivative (gu, gv);
547 gw = d.z;
548 double err_total;
549 const double dist1 = std::abs (gw - w);
550 double dist2;
551 do
552 {
553 double e1 = (gu - u) + d.z_u * gw - d.z_u * w;
554 double e2 = (gv - v) + d.z_v * gw - d.z_v * w;
555
556 const double F1u = 1 + d.z_uu * gw + d.z_u * d.z_u - d.z_uu * w;
557 const double F1v = d.z_uv * gw + d.z_u * d.z_v - d.z_uv * w;
558
559 const double F2u = d.z_uv * gw + d.z_v * d.z_u - d.z_uv * w;
560 const double F2v = 1 + d.z_vv * gw + d.z_v * d.z_v - d.z_vv * w;
561
562 Eigen::MatrixXd J (2, 2);
563 J (0, 0) = F1u;
564 J (0, 1) = F1v;
565 J (1, 0) = F2u;
566 J (1, 1) = F2v;
567
568 Eigen::Vector2d err (e1, e2);
569 Eigen::Vector2d update = J.inverse () * err;
570 gu -= update (0);
571 gv -= update (1);
572
573 d = getPolynomialPartialDerivative (gu, gv);
574 gw = d.z;
575 dist2 = std::sqrt ((gu - u) * (gu - u) + (gv - v) * (gv - v) + (gw - w) * (gw - w));
576
577 err_total = std::sqrt (e1 * e1 + e2 * e2);
578
579 } while (err_total > 1e-8 && dist2 < dist1);
580
581 if (dist2 > dist1) // the optimization was diverging reset the coordinates for simple projection
582 {
583 gu = u;
584 gv = v;
585 d = getPolynomialPartialDerivative (u, v);
586 gw = d.z;
587 }
588
589 result.u = gu;
590 result.v = gv;
591 result.normal -= (d.z_u * u_axis + d.z_v * v_axis);
592 result.normal.normalize ();
593 }
594
595 result.point = mean + gu * u_axis + gv * v_axis + gw * plane_normal;
596
597 return (result);
598}
599
601pcl::MLSResult::projectPointToMLSPlane (const double u, const double v) const
602{
604 result.u = u;
605 result.v = v;
606 result.normal = plane_normal;
607 result.point = mean + u * u_axis + v * v_axis;
608
609 return (result);
610}
611
613pcl::MLSResult::projectPointSimpleToPolynomialSurface (const double u, const double v) const
614{
616 double w = 0;
617
618 result.u = u;
619 result.v = v;
620 result.normal = plane_normal;
621
622 if (order > 1 && c_vec.size () >= (order + 1) * (order + 2) / 2 && std::isfinite (c_vec[0]))
623 {
624 const PolynomialPartialDerivative d = getPolynomialPartialDerivative (u, v);
625 w = d.z;
626 result.normal -= (d.z_u * u_axis + d.z_v * v_axis);
627 result.normal.normalize ();
628 }
629
630 result.point = mean + u * u_axis + v * v_axis + w * plane_normal;
631
632 return (result);
633}
634
636pcl::MLSResult::projectPoint (const Eigen::Vector3d &pt, ProjectionMethod method, int required_neighbors) const
637{
638 double u, v, w;
639 getMLSCoordinates (pt, u, v, w);
640
642 if (order > 1 && num_neighbors >= required_neighbors && std::isfinite (c_vec[0]) && method != NONE)
643 {
644 if (method == ORTHOGONAL)
645 proj = projectPointOrthogonalToPolynomialSurface (u, v, w);
646 else // SIMPLE
647 proj = projectPointSimpleToPolynomialSurface (u, v);
648 }
649 else
650 {
651 proj = projectPointToMLSPlane (u, v);
652 }
653
654 return (proj);
655}
656
658pcl::MLSResult::projectQueryPoint (ProjectionMethod method, int required_neighbors) const
659{
661 if (order > 1 && num_neighbors >= required_neighbors && std::isfinite (c_vec[0]) && method != NONE)
662 {
663 if (method == ORTHOGONAL)
664 {
665 double u, v, w;
666 getMLSCoordinates (query_point, u, v, w);
667 proj = projectPointOrthogonalToPolynomialSurface (u, v, w);
668 }
669 else // SIMPLE
670 {
671 // Projection onto MLS surface along Darboux normal to the height at (0,0)
672 proj.point = mean + (c_vec[0] * plane_normal);
673
674 // Compute tangent vectors using the partial derivates evaluated at (0,0) which is c_vec[order_+1] and c_vec[1]
675 proj.normal = plane_normal - c_vec[order + 1] * u_axis - c_vec[1] * v_axis;
676 proj.normal.normalize ();
677 }
678 }
679 else
680 {
681 proj.normal = plane_normal;
682 proj.point = mean;
683 }
684
685 return (proj);
686}
687
688template <typename PointT> void
690 pcl::index_t index,
691 const pcl::Indices &nn_indices,
692 double search_radius,
693 int polynomial_order,
694 std::function<double(const double)> weight_func)
695{
696 // Compute the plane coefficients
697 EIGEN_ALIGN16 Eigen::Matrix3d covariance_matrix;
698 Eigen::Vector4d xyz_centroid;
699
700 // Estimate the XYZ centroid
701 pcl::compute3DCentroid (cloud, nn_indices, xyz_centroid);
702
703 // Compute the 3x3 covariance matrix
704 pcl::computeCovarianceMatrix (cloud, nn_indices, xyz_centroid, covariance_matrix);
705 EIGEN_ALIGN16 Eigen::Vector3d::Scalar eigen_value;
706 EIGEN_ALIGN16 Eigen::Vector3d eigen_vector;
707 Eigen::Vector4d model_coefficients (0, 0, 0, 0);
708 pcl::eigen33 (covariance_matrix, eigen_value, eigen_vector);
709 model_coefficients.head<3> ().matrix () = eigen_vector;
710 model_coefficients[3] = -1 * model_coefficients.dot (xyz_centroid);
711
712 query_point = cloud[index].getVector3fMap ().template cast<double> ();
713
714 if (!std::isfinite(eigen_vector[0]) || !std::isfinite(eigen_vector[1]) || !std::isfinite(eigen_vector[2]))
715 {
716 // Invalid plane coefficients, this may happen if the input cloud is non-dense (it contains invalid points).
717 // Keep the input point and stop here.
718 valid = false;
719 mean = query_point;
720 return;
721 }
722
723 // Projected query point
724 valid = true;
725 const double distance = query_point.dot (model_coefficients.head<3> ()) + model_coefficients[3];
726 mean = query_point - distance * model_coefficients.head<3> ();
727
728 curvature = covariance_matrix.trace ();
729 // Compute the curvature surface change
730 if (curvature != 0)
731 curvature = std::abs (eigen_value / curvature);
732
733 // Get a copy of the plane normal easy access
734 plane_normal = model_coefficients.head<3> ();
735
736 // Local coordinate system (Darboux frame)
737 v_axis = plane_normal.unitOrthogonal ();
738 u_axis = plane_normal.cross (v_axis);
739
740 // Perform polynomial fit to update point and normal
741 ////////////////////////////////////////////////////
742 num_neighbors = static_cast<int> (nn_indices.size ());
743 order = polynomial_order;
744 if (order > 1)
745 {
746 const int nr_coeff = (order + 1) * (order + 2) / 2;
747
748 if (num_neighbors >= nr_coeff)
749 {
750 if (!weight_func)
751 weight_func = [this, search_radius] (const double sq_dist) { return this->computeMLSWeight (sq_dist, search_radius * search_radius); };
752
753 // Allocate matrices and vectors to hold the data used for the polynomial fit
754 Eigen::VectorXd weight_vec (num_neighbors);
755 Eigen::MatrixXd P (nr_coeff, num_neighbors);
756 Eigen::VectorXd f_vec (num_neighbors);
757 Eigen::MatrixXd P_weight_Pt (nr_coeff, nr_coeff);
758
759 // Update neighborhood, since point was projected, and computing relative
760 // positions. Note updating only distances for the weights for speed
761 std::vector<Eigen::Vector3d, Eigen::aligned_allocator<Eigen::Vector3d> > de_meaned (num_neighbors);
762 for (std::size_t ni = 0; ni < static_cast<std::size_t>(num_neighbors); ++ni)
763 {
764 de_meaned[ni][0] = cloud[nn_indices[ni]].x - mean[0];
765 de_meaned[ni][1] = cloud[nn_indices[ni]].y - mean[1];
766 de_meaned[ni][2] = cloud[nn_indices[ni]].z - mean[2];
767 weight_vec (ni) = weight_func (de_meaned[ni].dot (de_meaned[ni]));
768 }
769
770 // Go through neighbors, transform them in the local coordinate system,
771 // save height and the evaluation of the polynomial's terms
772 for (std::size_t ni = 0; ni < static_cast<std::size_t>(num_neighbors); ++ni)
773 {
774 // Transforming coordinates
775 const double u_coord = de_meaned[ni].dot(u_axis);
776 const double v_coord = de_meaned[ni].dot(v_axis);
777 f_vec (ni) = de_meaned[ni].dot (plane_normal);
778
779 // Compute the polynomial's terms at the current point
780 int j = 0;
781 double u_pow = 1;
782 for (int ui = 0; ui <= order; ++ui)
783 {
784 double v_pow = 1;
785 for (int vi = 0; vi <= order - ui; ++vi)
786 {
787 P (j++, ni) = u_pow * v_pow;
788 v_pow *= v_coord;
789 }
790 u_pow *= u_coord;
791 }
792 }
793
794 // Computing coefficients
795 const Eigen::MatrixXd P_weight = P * weight_vec.asDiagonal(); // size will be (nr_coeff_, nn_indices.size ());
796 P_weight_Pt.noalias() = P_weight * P.transpose ();
797 c_vec.noalias() = P_weight * f_vec;
798 P_weight_Pt.llt ().solveInPlace (c_vec);
799 }
800 }
801}
802
803//////////////////////////////////////////////////////////////////////////////////////////////
804template <typename PointInT, typename PointOutT>
806 IndicesPtr &indices,
807 float voxel_size,
808 int dilation_iteration_num) :
809 voxel_grid_ (), voxel_size_ (voxel_size)
810{
811 pcl::getMinMax3D (*cloud, *indices, bounding_min_, bounding_max_);
812 bounding_min_ -= Eigen::Vector4f::Constant(voxel_size_ * (dilation_iteration_num + 1));
813 bounding_max_ += Eigen::Vector4f::Constant(voxel_size_ * (dilation_iteration_num + 1));
814
815 Eigen::Vector4f bounding_box_size = bounding_max_ - bounding_min_;
816 const double max_size = (std::max) ((std::max)(bounding_box_size.x (), bounding_box_size.y ()), bounding_box_size.z ());
817 // Put initial cloud in voxel grid
818 data_size_ = static_cast<std::uint64_t> (std::ceil(max_size / voxel_size_));
819 for (std::size_t i = 0; i < indices->size (); ++i)
820 if (std::isfinite ((*cloud)[(*indices)[i]].x))
821 {
822 Eigen::Vector3i pos;
823 getCellIndex ((*cloud)[(*indices)[i]].getVector3fMap (), pos);
824
825 std::uint64_t index_1d;
826 getIndexIn1D (pos, index_1d);
827 Leaf leaf;
828 voxel_grid_[index_1d] = leaf;
829 }
830}
831
832//////////////////////////////////////////////////////////////////////////////////////////////
833template <typename PointInT, typename PointOutT> void
835{
836 HashMap new_voxel_grid = voxel_grid_;
837 for (auto m_it = voxel_grid_.begin (); m_it != voxel_grid_.end (); ++m_it)
838 {
839 Eigen::Vector3i index;
840 getIndexIn3D (m_it->first, index);
841
842 // Now dilate all of its voxels
843 for (int x = -1; x <= 1; ++x)
844 for (int y = -1; y <= 1; ++y)
845 for (int z = -1; z <= 1; ++z)
846 if (x != 0 || y != 0 || z != 0)
847 {
848 Eigen::Vector3i new_index;
849 new_index = index + Eigen::Vector3i (x, y, z);
850
851 std::uint64_t index_1d;
852 getIndexIn1D (new_index, index_1d);
853 Leaf leaf;
854 new_voxel_grid[index_1d] = leaf;
855 }
856 }
857 voxel_grid_ = new_voxel_grid;
858}
859
860
861/////////////////////////////////////////////////////////////////////////////////////////////
862template <typename PointInT, typename PointOutT> void
864 PointOutT &point_out) const
865{
866 PointOutT temp = point_out;
867 copyPoint (point_in, point_out);
868 point_out.x = temp.x;
869 point_out.y = temp.y;
870 point_out.z = temp.z;
871}
872
873#define PCL_INSTANTIATE_MovingLeastSquares(T,OutT) template class PCL_EXPORTS pcl::MovingLeastSquares<T,OutT>;
874#define PCL_INSTANTIATE_MovingLeastSquaresOMP(T,OutT) template class PCL_EXPORTS pcl::MovingLeastSquaresOMP<T,OutT>;
875
876#endif // PCL_SURFACE_IMPL_MLS_H_
Define methods for centroid estimation and covariance matrix calculus.
A minimalistic implementation of a voxel grid, necessary for the point cloud upsampling.
Definition mls.h:568
void getPosition(const std::uint64_t &index_1d, Eigen::Vector3f &point) const
Definition mls.h:605
void getIndexIn1D(const Eigen::Vector3i &index, std::uint64_t &index_1d) const
Definition mls.h:581
void getCellIndex(const Eigen::Vector3f &p, Eigen::Vector3i &index) const
Definition mls.h:598
MLSVoxelGrid(PointCloudInConstPtr &cloud, IndicesPtr &indices, float voxel_size, int dilation_iteration_num)
Definition mls.hpp:805
std::map< std::uint64_t, Leaf > HashMap
Definition mls.h:613
void performUpsampling(PointCloudOut &output)
Perform upsampling for the distinct-cloud and voxel-grid methods.
Definition mls.hpp:369
typename KdTree::Ptr KdTreePtr
Definition mls.h:266
typename PointCloudIn::ConstPtr PointCloudInConstPtr
Definition mls.h:276
void copyMissingFields(const PointInT &point_in, PointOutT &point_out) const
Definition mls.hpp:863
void performProcessing(PointCloudOut &output) override
Abstract surface reconstruction method.
Definition mls.hpp:283
void computeMLSPointNormal(pcl::index_t index, const pcl::Indices &nn_indices, PointCloudOut &projected_points, NormalCloud &projected_points_normals, PointIndices &corresponding_input_indices, MLSResult &mls_result) const
Smooth a given point and its neighborghood using Moving Least Squares.
Definition mls.hpp:173
void process(PointCloudOut &output) override
Base method for surface reconstruction for all points given in <setInputCloud (), setIndices ()>
Definition mls.hpp:62
void addProjectedPointNormal(pcl::index_t index, const Eigen::Vector3d &point, const Eigen::Vector3d &normal, double curvature, PointCloudOut &projected_points, NormalCloud &projected_points_normals, PointIndices &corresponding_input_indices) const
This is a helper function for adding projected points.
Definition mls.hpp:251
void push_back(const PointT &pt)
Insert a new point in the cloud, at the end of the container.
std::uint32_t width
The point cloud width (if organized as an image-structure).
iterator insert(iterator position, const PointT &pt)
Insert a new point in the cloud, given an iterator.
pcl::PCLHeader header
The point cloud header.
std::vector< PointCloud< PointOutT >, Eigen::aligned_allocator< PointCloud< PointOutT > > > CloudVectorType
iterator end() noexcept
std::uint32_t height
The point cloud height (if organized as an image-structure).
void clear()
Removes all points in a cloud and sets the width and height to 0.
std::size_t size() const
iterator begin() noexcept
Define standard C methods and C++ classes that are common to all methods.
void getMinMax3D(const pcl::PointCloud< PointT > &cloud, PointT &min_pt, PointT &max_pt)
Get the minimum and maximum values on each of the 3 (x-y-z) dimensions in a given pointcloud.
Definition common.hpp:295
void copyPoint(const PointInT &point_in, PointOutT &point_out)
Copy the fields of a source point into a target point.
unsigned int computeCovarianceMatrix(const pcl::PointCloud< PointT > &cloud, const Eigen::Matrix< Scalar, 4, 1 > &centroid, Eigen::Matrix< Scalar, 3, 3 > &covariance_matrix)
Compute the 3x3 covariance matrix of a given set of points.
Definition centroid.hpp:192
void eigen33(const Matrix &mat, typename Matrix::Scalar &eigenvalue, Vector &eigenvector)
determines the eigenvector and eigenvalue of the smallest eigenvalue of the symmetric positive semi d...
Definition eigen.hpp:295
unsigned int compute3DCentroid(ConstCloudIterator< PointT > &cloud_iterator, Eigen::Matrix< Scalar, 4, 1 > &centroid)
Compute the 3D (X-Y-Z) centroid of a set of points and return it as a 3D vector.
Definition centroid.hpp:57
detail::int_type_t< detail::index_type_size, detail::index_type_signed > index_t
Type used for an index in PCL.
Definition types.h:112
IndicesAllocator<> Indices
Type used for indices in PCL.
Definition types.h:133
shared_ptr< Indices > IndicesPtr
Definition pcl_base.h:58
Data structure used to store the MLS projection results.
Definition mls.h:82
Eigen::Vector3d point
The projected point.
Definition mls.h:87
double v
The v-coordinate of the projected point in local MLS frame.
Definition mls.h:86
Eigen::Vector3d normal
The projected point's normal.
Definition mls.h:88
double u
The u-coordinate of the projected point in local MLS frame.
Definition mls.h:85
Data structure used to store the MLS polynomial partial derivatives.
Definition mls.h:71
double z_uv
The partial derivative d^2z/dudv.
Definition mls.h:77
double z_u
The partial derivative dz/du.
Definition mls.h:73
double z_uu
The partial derivative d^2z/du^2.
Definition mls.h:75
double z
The z component of the polynomial evaluated at z(u, v).
Definition mls.h:72
double z_vv
The partial derivative d^2z/dv^2.
Definition mls.h:76
double z_v
The partial derivative dz/dv.
Definition mls.h:74
Data structure used to store the results of the MLS fitting.
Definition mls.h:61
MLSProjectionResults projectPoint(const Eigen::Vector3d &pt, ProjectionMethod method, int required_neighbors=0) const
Project a point using the specified method.
Definition mls.hpp:636
MLSResult()
Definition mls.h:93
MLSProjectionResults projectPointOrthogonalToPolynomialSurface(const double u, const double v, const double w) const
Project a point orthogonal to the polynomial surface.
Definition mls.hpp:536
ProjectionMethod
Definition mls.h:63
int num_neighbors
The number of neighbors used to create the mls surface.
Definition mls.h:222
void computeMLSSurface(const pcl::PointCloud< PointT > &cloud, pcl::index_t index, const pcl::Indices &nn_indices, double search_radius, int polynomial_order=2, std::function< double(const double)> weight_func={})
Smooth a given point and its neighborhood using Moving Least Squares.
Definition mls.hpp:689
void getMLSCoordinates(const Eigen::Vector3d &pt, double &u, double &v, double &w) const
Given a point calculate its 3D location in the MLS frame.
Definition mls.hpp:452
float curvature
The curvature at the query point.
Definition mls.h:223
PolynomialPartialDerivative getPolynomialPartialDerivative(const double u, const double v) const
Calculate the polynomial's first and second partial derivatives.
Definition mls.hpp:491
MLSProjectionResults projectPointSimpleToPolynomialSurface(const double u, const double v) const
Project a point along the MLS plane normal to the polynomial surface.
Definition mls.hpp:613
MLSProjectionResults projectPointToMLSPlane(const double u, const double v) const
Project a point onto the MLS plane.
Definition mls.hpp:601
double getPolynomialValue(const double u, const double v) const
Calculate the polynomial.
Definition mls.hpp:469
MLSProjectionResults projectQueryPoint(ProjectionMethod method, int required_neighbors=0) const
Project the query point used to generate the mls surface about using the specified method.
Definition mls.hpp:658
A point structure representing normal coordinates and the surface curvature estimate.
A helper functor that can set a specific value in a field if the field exists.