From 679146f1116e4b9f0d44eed334d15c8be817cf82 Mon Sep 17 00:00:00 2001 From: Sven Oesau Date: Wed, 12 Feb 2025 10:35:25 +0100 Subject: [PATCH] some doc adjustments --- .../doc/Point_set_processing_3/Point_set_processing_3.txt | 6 +++--- Point_set_processing_3/include/CGAL/poisson_eliminate.h | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt b/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt index e17cf4bc5af..331f8922aa7 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt @@ -769,13 +769,13 @@ The poisson sample elimination has the following parameters: double(*func)(const Point &p, const Point &n, double squared_distance, double r_max) \endcode The default weight is \f$\left(1 - \frac{d_{p,n}}{2r_{max}}\right)^8\f$ with \f$d_{p,n}\f$ being the distance between the point p and its neighbor n. -- \f$r_{max}\f$: The \f$r_{max}\f$ parameter specifies the radius of the neighborhood, i.e., the neighboring points that are used to calculate the weight of a point. r_max has to be provided if a custom *weight_function* is used. Only points within a distance of \f$r_{max}\f$ is used to calculate the weight of a point. A large value can thus cause a large running time. The default is calculated based in the bounding volume \f$V\f$ of the input points, the *dimensions* parameter and the number of input points \f$N\f$: +- \f$r_{max}\f$: The \f$r_{max}\f$ parameter specifies the radius of the neighborhood, i.e., the neighboring points that are used to calculate the weight of a point. r_max has to be provided if a custom *weight_function* is used. Only points within a distance of \f$r_{max}\f$ are used to calculate the weight of a point. A large value can thus cause a large running time. The default is calculated based in the bounding volume \f$V\f$ of the input points, the *dimensions* parameter and the number of input points \f$N\f$: \f$dimensions = 2:\qquad\f$ \f$r_{max} = \sqrt{\frac{V}{2\sqrt{3}N}}\f$ \f$dimensions = 3:\qquad\f$ \f$r_{max} = \sqrt{\frac{V}{4\sqrt{2}N}}\f$ -- *progressive*: The output points of the function can be reordered to be progressive. A progressive ordering will increase the running time by at most 2 as the function is internally applied several times on increasingly smaller subsets. The default value is false. +- *progressive*: The output points of the function can be reordered to be progressive. A progressive ordering will increase the running time by a factor of at most 2 as the function is internally applied several times on increasingly smaller subsets. The default value is false. \cgalFigureAnchor{Point_set_processing_3figPoisson_elimination}
@@ -785,7 +785,7 @@ The default weight is \f$\left(1 - \frac{d_{p,n}}{2r_{max}}\right)^8\f$ with \f$ Poisson elimination on point cloud with 21k points and results with \f$\frac{1}{2}\f$, \f$\frac{1}{4}\f$ and \f$\frac{1}{8}\f$ of the input size. \cgalFigureCaptionEnd -\subsection Point_set_processing_3Example_poisson_elimination Poisson Sample Elimination Example +\subsubsection Point_set_processing_3Example_poisson_elimination Poisson Sample Elimination Example The following example reads a point cloud, applies poisson elimination to reduce the point cloud to \f$\frac{1}{5}\f$ of its size and saves it into a file. diff --git a/Point_set_processing_3/include/CGAL/poisson_eliminate.h b/Point_set_processing_3/include/CGAL/poisson_eliminate.h index 1cfbd780745..493b0ae182d 100644 --- a/Point_set_processing_3/include/CGAL/poisson_eliminate.h +++ b/Point_set_processing_3/include/CGAL/poisson_eliminate.h @@ -213,13 +213,13 @@ void pop_heap(std::vector& heap, std::vector& heap_pos \cgalParamNBegin{maximum_radius} \cgalParamDescription{radius of the poisson disk in which the neighboring points are taken into account for elimination.} \cgalParamType{double} - \cgalParamDefault{the default is calculated from the `dimension`, the volume of the bounding box and the `number_of_points`. For more details, see \ref Point_set_processing_3PoissonElimination.} + \cgalParamDefault{the default is calculated from the `dimension`, the volume of the bounding box and the `number_of_points`. For more details, see parameter section in \ref Point_set_processing_3PoissonElimination.} \cgalParamNEnd \cgalParamNBegin{weight_function} \cgalParamDescription{a weight function that calculates the weight of a neighbor point based on its squared distance and the `maximum_radius`.} \cgalParamType{an instance of `std::function`.} - \cgalParamDefault{See \ref Point_set_processing_3PoissonElimination.} + \cgalParamDefault{See parameter section in \ref Point_set_processing_3PoissonElimination.} \cgalParamNEnd \cgalParamNBegin{geom_traits}