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

Add warning about which point set to use as reference

This commit is contained in:
Simon Giraudot 2019-12-11 13:25:16 +01:00
parent 1646f9dba2
commit fd44fb278e
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Point_set_processing_3/include/CGAL/OpenGR/compute_registration_transformation.h
View File

@ -164,6 +164,14 @@ compute_registration_transformation(const PointRange1& range1, const PointRan
\note This function requires the \ref thirdpartyOpenGR library. \note This function requires the \ref thirdpartyOpenGR library.
\warning Although this may seem counter-intuitive, if one of the
two point set matches only a small section of the other one, it is
advised to _use the small point set as reference_ instead of the
big one. The reason is that the reference point set is used to
construct a base that is sought after in the other point set: if
the big point set is used as reference, chances are the constructed
base will not be present in the small point set.
\tparam PointRange1 is a model of `Range`. The value type of its iterator is \tparam PointRange1 is a model of `Range`. The value type of its iterator is
the key type of the named parameter `point_map` in `NamedParameters1`. the key type of the named parameter `point_map` in `NamedParameters1`.
\tparam PointRange2 is a model of `Range`. The value type of its iterator is \tparam PointRange2 is a model of `Range`. The value type of its iterator is

8
Point_set_processing_3/include/CGAL/OpenGR/register_point_sets.h
View File

@ -82,6 +82,14 @@ register_point_sets(const PointRange1& range1, PointRange2& range2,
\note This function requires the \ref thirdpartyOpenGR library. \note This function requires the \ref thirdpartyOpenGR library.
\warning Although this may seem counter-intuitive, if one of the two
point set matches only a small section of the other one, it is
advised to _use the small point set as reference_ instead of the
big one. The reason is that the reference point set is used to
construct a base that is sought after in the other point set: if
the big point set is used as reference, chances are the constructed
base will not be present in the small point set.
\tparam PointRange1 is a model of `Range`. The value type of its iterator is \tparam PointRange1 is a model of `Range`. The value type of its iterator is
the key type of the named parameter `point_map` in `NamedParameters1`. the key type of the named parameter `point_map` in `NamedParameters1`.
\tparam PointRange2 is a model of `Range`. The value type of its iterator is \tparam PointRange2 is a model of `Range`. The value type of its iterator is