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

Add warning about scope definition of feature generators

This commit is contained in:
Simon Giraudot 2018-12-11 12:11:00 +01:00
parent f2f919c6bd
commit 7d43e87716
2 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Classification/include/CGAL/Classification/Mesh_feature_generator.h
View File

@ -65,15 +65,20 @@ namespace Classification {
\brief Generates a set of generic features for surface mesh \brief Generates a set of generic features for surface mesh
classification. classification.
This class takes care of computing all necessary data structures and This class takes care of computing and storing all necessary data
of generating a set of generic features at multiple scales to structures and of generating a set of generic features at multiple
increase the reliability of the classification. scales to increase the reliability of the classification.
A `PointMap` is required: this map should associate each face of the A `PointMap` is required: this map should associate each face of the
mesh to a representative point (for example, the center of mass of mesh to a representative point (for example, the center of mass of
the face). It is used to generate point set features by considering the face). It is used to generate point set features by considering
the mesh as a point set. the mesh as a point set.
\warning The generated features use data structures that are stored
inside the generator. For this reason, the generator should be
instantiated _within the same scope_ as the feature set and should
not be deleted before the feature set.
\tparam GeomTraits model of \cgal Kernel. \tparam GeomTraits model of \cgal Kernel.
\tparam FaceListGraph model of `FaceListGraph`. \tparam FaceListGraph model of `FaceListGraph`.
\tparam PointMap model of `ReadablePropertyMap` whose key type is \tparam PointMap model of `ReadablePropertyMap` whose key type is

11
Classification/include/CGAL/Classification/Point_set_feature_generator.h
View File

@ -67,9 +67,14 @@ namespace Classification {
\brief Generates a set of generic features for point set \brief Generates a set of generic features for point set
classification. classification.
This class takes care of computing all necessary data structures and This class takes care of computing and storing all necessary data
of generating a set of generic features at multiple scales to structures and of generating a set of generic features at multiple
increase the reliability of the classification. scales to increase the reliability of the classification.
\warning The generated features use data structures that are stored
inside the generator. For this reason, the generator should be
instantiated _within the same scope_ as the feature set and should
not be deleted before the feature set.
\tparam GeomTraits model of \cgal Kernel. \tparam GeomTraits model of \cgal Kernel.
\tparam PointRange model of `ConstRange`. Its iterator type is \tparam PointRange model of `ConstRange`. Its iterator type is