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

documentation

This commit is contained in:
Jane Tournois 2023-01-20 14:40:03 +01:00
parent 46808d4267
commit 7bbe3b9d56
3 changed files with 28 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Mesh_3/include/CGAL/Labeled_mesh_domain_3.h
View File

@ -622,6 +622,11 @@ public:
* domain to be discretized is the union of voxels that have non-zero
* values.
*
* \returns either a `Labeled_mesh_domain_3`,
* or a `Mesh_domain_with_polyline_features_3<Labeled_mesh_domain_3>`
* depending on whether one or more of the named parameters
* `detect_features` and `input_features` are provided.
*
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
* \param image_ the input 3D image.
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below:
@ -650,11 +655,25 @@ public:
* \cgalParamNEnd
*
* \cgalParamNBegin{detect_features}
* \cgalParamDescription{ a functor can be passed to
* `std::function<void(const CGAL::Image_3&, Mesh_domain_with_polyline_features_3<Labeled_mesh_domain_3>&)>`.
* \cgalParamDescription{ a functor that can be passed to
* `std::function<
* std::vector<std::vector<Point_3>>
* (const CGAL::Image_3&, Mesh_domain_with_polyline_features_3<Labeled_mesh_domain_3>&)>`
* and that returns a range of detected polyline features for feature protection.
* Polyline features are added to the domain for further feature protection.
* See \ref PkgMesh3FeatureDetection for available functors.}
* \cgalParamDefault{CGAL::Null_functor()}
* \cgalParamExtra{The return type of the function depends on whether this parameter is provided or not.}
* \cgalParamExtra{The return type of the function depends on whether this parameter
or `input_features` are provided or not.}
* \cgalParamExtra{If `weights` is provided, this parameter is ignored}
* \cgalParamNEnd
*
* \cgalParamNBegin{input_features}
* \cgalParamDescription{ a `Range` of polyline features, represented as `Range`s of `Point_3`.
* Polyline features are added to the domain for further feature protection.}
* \cgalParamDefault{`std::vector<std::vector<Point_3>>()`}
* \cgalParamExtra{The return type of the function depends on whether this parameter
or `input_features` are provided or not.}
* \cgalParamExtra{If `weights` is provided, this parameter is ignored}
* \cgalParamNEnd
*

3
Mesh_3/include/CGAL/Mesh_3/Detect_features_in_image.h
View File

@ -268,6 +268,9 @@ public:
* \tparam Mesh_domain class model of `MeshDomainWithFeatures_3`
* \param image the input image
* \param domain the mesh domain to be enriched with polyline features
*
* \returns a `std::vector<std::vector<typename Mesh_domain::Point_3>>`
* containing the constructed polylines
*/
template<typename Mesh_domain>
std::vector<std::vector<typename Mesh_domain::Point_3>>

3
Mesh_3/include/CGAL/Mesh_3/Detect_features_on_image_bbox.h
View File

@ -78,6 +78,9 @@ public:
*
* \param image the input image
* \param domain the mesh domain to be enriched with polyline features
*
* \returns a `std::vector<std::vector<typename Mesh_domain::Point_3>>`
* containing the constructed polylines
*/
template<typename Mesh_domain>
std::vector<std::vector<typename Mesh_domain::Point_3>>