songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update doc of remove_outliers

This commit is contained in:
Simon Giraudot 2020-04-16 13:55:38 +02:00
parent 1772709b94
commit 79dbfbf14e
2 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt
View File

@ -643,11 +643,12 @@ computed and stored as colors in a PLY file:
\section Point_set_processing_3OutlierRemoval Outlier Removal \section Point_set_processing_3OutlierRemoval Outlier Removal
Function `remove_outliers()` deletes a user-specified fraction Function `remove_outliers()` deletes a user-specified fraction of
of outliers from an input point set. More specifically, it sorts the outliers from an input point set. More specifically, it partitions the
input points in increasing order of average squared distances to their input points with respect to the average squared distances to their
nearest neighbors and deletes the points with largest value. The user nearest neighbors and deletes the points with largest value, either
can either specify a fixed number of nearest neighbors or a fixed partitionning with a threshold or removing a fixed percentage. The
user can either specify a fixed number of nearest neighbors or a fixed
spherical neighborhood radius. spherical neighborhood radius.
\subsection Point_set_processing_3Example_outlier_removal Example \subsection Point_set_processing_3Example_outlier_removal Example

6
Point_set_processing_3/include/CGAL/remove_outliers.h
View File

@ -88,7 +88,9 @@ compute_avg_knn_sq_distance_3(
\ingroup PkgPointSetProcessing3Algorithms \ingroup PkgPointSetProcessing3Algorithms
Removes outliers: Removes outliers:
- computes average squared distance to the nearest neighbors, - computes average squared distance to the nearest neighbors,
- and sorts the points in increasing order of average distance. - and partitions the points either using a threshold on the of
average distance or selecting a fixed percentage of points with
the highest average distances
This method modifies the order of input points so as to pack all remaining points first, This method modifies the order of input points so as to pack all remaining points first,
and returns an iterator over the first point to remove (see erase-remove idiom). and returns an iterator over the first point to remove (see erase-remove idiom).
@ -96,6 +98,8 @@ compute_avg_knn_sq_distance_3(
\pre `k >= 2` \pre `k >= 2`
\tparam ConcurrencyTag enables sequential versus parallel algorithm. Possible values are `Sequential_tag`,
`Parallel_tag`, and `Parallel_if_available_tag`.
\tparam PointRange is a model of `Range`. The value type of \tparam PointRange is a model of `Range`. The value type of
its iterator is the key type of the named parameter `point_map`. its iterator is the key type of the named parameter `point_map`.