From fed52c13da16c658fa6d6a77ec8a9bd53b45cb4c Mon Sep 17 00:00:00 2001 From: Necip Yildiran Date: Tue, 3 Sep 2019 23:06:46 -0400 Subject: [PATCH] Improved doc for OpenGR/PointMatcher wrappers OpenGR: param max_running_time PointMatcher: geom_traits --- .../doc/Point_set_processing_3/Point_set_processing_3.txt | 3 +-- .../include/CGAL/OpenGR/compute_registration_transformation.h | 4 ++-- .../include/CGAL/OpenGR/register_point_sets.h | 4 ++-- .../CGAL/pointmatcher/compute_registration_transformation.h | 3 +++ .../include/CGAL/pointmatcher/register_point_sets.h | 2 ++ 5 files changed, 10 insertions(+), 6 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 d8525dfde5c..edc88a81bd6 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 @@ -409,8 +409,7 @@ reduce the accuracy of the result. Maximum number of seconds after which the algorithm stops. Super4PCS explores the transformation space to align the two input clouds. Since the exploration is performed -randomly, it is recommended to use a large time value to explore the whole space -(e.g., 1000). +randomly, it is recommended to use a large time value to explore the whole space. \subsection Point_set_processing_3Examples_registration_PointMatcher PointMatcher Example diff --git a/Point_set_processing_3/include/CGAL/OpenGR/compute_registration_transformation.h b/Point_set_processing_3/include/CGAL/OpenGR/compute_registration_transformation.h index 2a19ea4a3fa..5dad0cd4950 100644 --- a/Point_set_processing_3/include/CGAL/OpenGR/compute_registration_transformation.h +++ b/Point_set_processing_3/include/CGAL/OpenGR/compute_registration_transformation.h @@ -226,8 +226,8 @@ compute_registration_transformation(const PointRange1& range1, const PointRan \cgalParamBegin{maximum_running_time} maximum number of seconds after which the algorithm stops. Super4PCS explores the transformation space to align the two input clouds. Since the exploration is performed randomly, - it is recommended to use a large time value to explore the whole space - (e.g., 1000).\cgalParamEnd + it is recommended to use a large time value to explore the whole space. + \cgalParamEnd \cgalParamBegin{geom_traits} an instance of a geometric traits class, model of `Kernel`\cgalParamEnd diff --git a/Point_set_processing_3/include/CGAL/OpenGR/register_point_sets.h b/Point_set_processing_3/include/CGAL/OpenGR/register_point_sets.h index 98b04179884..16f1be733ee 100644 --- a/Point_set_processing_3/include/CGAL/OpenGR/register_point_sets.h +++ b/Point_set_processing_3/include/CGAL/OpenGR/register_point_sets.h @@ -144,8 +144,8 @@ register_point_sets(const PointRange1& range1, PointRange2& range2, \cgalParamBegin{maximum_running_time} maximum number of seconds after which the algorithm stops. Super4PCS explores the transformation space to align the two input clouds. Since the exploration is performed randomly, - it is recommended to use a large time value to explore the whole space - (e.g., 1000).\cgalParamEnd + it is recommended to use a large time value to explore the whole space. + \cgalParamEnd \cgalParamBegin{geom_traits} an instance of a geometric traits class, model of `Kernel`\cgalParamEnd diff --git a/Point_set_processing_3/include/CGAL/pointmatcher/compute_registration_transformation.h b/Point_set_processing_3/include/CGAL/pointmatcher/compute_registration_transformation.h index 7ad1b47c45c..9712de645d4 100644 --- a/Point_set_processing_3/include/CGAL/pointmatcher/compute_registration_transformation.h +++ b/Point_set_processing_3/include/CGAL/pointmatcher/compute_registration_transformation.h @@ -499,6 +499,9 @@ compute_registration_transformation(const PointRange1& range1, const PointRange2 If this parameter is omitted, `NullLogger` is used. \cgalParamEnd + + \cgalParamBegin{geom_traits} an instance of a geometric traits class, + model of `Kernel`\cgalParamEnd \cgalNamedParamsEnd diff --git a/Point_set_processing_3/include/CGAL/pointmatcher/register_point_sets.h b/Point_set_processing_3/include/CGAL/pointmatcher/register_point_sets.h index 71bb3929678..c740067c32e 100644 --- a/Point_set_processing_3/include/CGAL/pointmatcher/register_point_sets.h +++ b/Point_set_processing_3/include/CGAL/pointmatcher/register_point_sets.h @@ -182,6 +182,8 @@ namespace pointmatcher { If this parameter is omitted, `NullLogger` is used. \cgalParamEnd + \cgalParamBegin{geom_traits} an instance of a geometric traits class, + model of `Kernel`\cgalParamEnd \cgalNamedParamsEnd \param np2 optional sequence of \ref psp_namedparameters "Named Parameters" among the ones listed below.