CGAL 5.0 - Point Set Processing
|
In this package, all functions optional parameters are implemented as BGL optional named parameters (see Named Parameters for more information on how to use them).
Since the parameters of the various point set processing functions defined in this package are redundant, their long descriptions are centralized below.
In the following, we assume that the following types are provided as template parameters of point set processing functions and classes. Note that, for some of these functions, the type is more specific.
PointRange
is a model of Range
. The value type of its iterator is the key type of the related property maps (see below). GeomTraits
a geometric traits class in which constructions are performed and predicates evaluated. Everywhere in this package, a CGAL Kernel
fulfills the requirements. CGAL::parameters::all_default()
can be used to indicate that default values of optional named parameters must be used.
Here is the list of the named parameters available in this package:
geom_traits | the geometric traits instance in which the point set processing operation should be performed. |
point_map | is the property map containing the points associated to the elements of the point range |
normal_map | is the property map containing the normal vectors associated to the elements of the point range |
diagonalize_traits | is the solver used for diagonalizing covariance matrices. |
svd_traits | is the linear algebra algorithm required by the jet fitting method. For more information, please refer to the documentation of |
callback | is a mechanism to get feedback on the advancement of the algorithm while it's running and to interrupt it if needed. It is called regularly when the algorithm is running: the current advancement (between 0. and 1.) is passed as parameter. If it returns |
query_point_map | is the property map containing the points associated to the elements of the point range |
sharpness_angle | controls the sharpness of the result. The larger the value is, the smoother the result will be. The range of possible value is [0, 90]. |
edge_sensitivity | controls the priority of points inserted along sharp features. Larger values of edge-sensitivity give higher priority to inserting points along sharp features. The range of possible values is |
neighbor_radius | is the spherical neighborhood radius. |
number_of_output_points | is the number of output points to generate. |
size | maximum cluster size for hierarchical clustering. Must be strictly greather than 0. |
maximum_variation | maximum cluster size for hierarchical clustering. Must be strictly greather than 0. |
degree_fitting | is the degree of fitting (see |
degree_monge | is the Monge degree (see |
threshold_distance | is the minimum distance for a point to be considered as outlier (distance here is the square root of the average squared distance to K nearest neighbors). |
threshold_percent | is the maximum percentage (between 0 and 100) of points to remove in |
attraction_factor | multiple of a tolerance |
plane_map | is the property map containing the planes associated to the elements of the plane range |
plane_index_map | is the property map that associates the index of a point in the input range to the index of plane (-1 if point is not assigned to a plane). |
select_percentage | percentage of points to retain (between 0 and 100) in |
number_of_iterations | number of iterations to solve the optimsation problem in |
require_uniform_sampling | turn on or off an optional preprocessing of |
point_is_constrained_map | is the property map containing information about points being constrained or not. Constrained points are left unaltered and are used as seeds in |