cgal/Shape_detection/doc/Shape_detection/PackageDescription.txt

136 lines
4.9 KiB
Plaintext

/*!
\defgroup PkgShapeDetectionRef Shape Detection Reference
\defgroup PkgShapeDetectionRG Region Growing
\ingroup PkgShapeDetectionRef
Reference Manual for the Region Growing shape detection component.
\defgroup PkgShapeDetectionRGConcepts Concepts
\ingroup PkgShapeDetectionRG
Concepts used for the parameters of the `CGAL::Shape_detection::Region_growing`.
\defgroup PkgShapeDetectionRGOnPoints Point Set
\ingroup PkgShapeDetectionRG
Models that can be used with the `CGAL::Shape_detection::Region_growing`
for shape detection in a point set.
\defgroup PkgShapeDetectionRGOnMesh Polygon Mesh
\ingroup PkgShapeDetectionRG
Models that can be used with the `CGAL::Shape_detection::Region_growing`
for shape detection on a polygon mesh.
\addtogroup PkgShapeDetectionRG
\defgroup PkgShapeDetectionRANSAC Efficient RANSAC
\ingroup PkgShapeDetectionRef
Reference Manual for the Efficient RANSAC shape detection component.
\defgroup PkgShapeDetectionRANSACConcepts Concepts
\ingroup PkgShapeDetectionRANSAC
Concepts used for the parameters of the `CGAL::Shape_detection::Efficient_RANSAC`.
\defgroup PkgShapeDetectionRANSACShapes Shapes
\ingroup PkgShapeDetectionRANSAC
Shape models that can be used with the `CGAL::Shape_detection::Efficient_RANSAC`.
\defgroup PkgShapeDetectionRANSACPropertyMaps Property Maps
\ingroup PkgShapeDetectionRANSAC
Property maps that can be used with the `CGAL::Shape_detection::Efficient_RANSAC`.
\addtogroup PkgShapeDetectionRANSAC
\defgroup PkgShapeDetectionDEPR Deprecated
\ingroup PkgShapeDetectionRef
Deprecated components.
\addtogroup PkgShapeDetectionRef
\cgalPkgDescriptionBegin{Shape Detection, PkgShapeDetection}
\cgalPkgPicture{shapes_detail.png}
\cgalPkgSummaryBegin
\cgalPkgAuthors{Sven Oesau, Yannick Verdie, Clément Jamin, Pierre Alliez, Florent Lafarge, Simon Giraudot, Thien Hoang, and Dmitry Anisimov}
\cgalPkgDesc{This package implements the Efficient RANSAC (RANdom SAmple Consensus) approach
for detecting arbitrary shapes in an unorganized point set with unoriented normals
and the Region Growing approach for detecting shapes in a set of arbitrary items.
With the Efficient RANSAC approach, five canonical shapes can be detected: planes, spheres,
cylinders, cones, and tori. Additional shapes can be detected, given a custom shape class by the user.
For the Region Growing approach, this package provides three particular shape detection components:
detecting lines in a 2D point set, detecting planes in a 3D point set, and detecting planes
on a polygon mesh.}
\cgalPkgManuals{Chapter_Shape_Detection, PkgShapeDetectionRef}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{4.7}
\cgalPkgBib{cgal:ovja-pssd}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyhedron demo,polyhedron_3.zip}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
## Efficient RANSAC ##
### Concepts ###
- `EfficientRANSACTraits`
### Algorithm ###
- `CGAL::Shape_detection::Efficient_RANSAC_traits<GeomTraits, InputRange, PointMap, NormalMap>`
- `CGAL::Shape_detection::Efficient_RANSAC<Traits>`
### Shapes ###
- `CGAL::Shape_detection::Plane<Traits>`
- `CGAL::Shape_detection::Sphere<Traits>`
- `CGAL::Shape_detection::Cylinder<Traits>`
- `CGAL::Shape_detection::Cone<Traits>`
- `CGAL::Shape_detection::Torus<Traits>`
### Shape Interface ###
- `CGAL::Shape_detection::Shape_base<Traits>`
### Property Maps ###
- `CGAL::Shape_detection::Plane_map<Traits>`
- `CGAL::Shape_detection::Point_to_shape_index_map<Traits>`
## Region Growing ##
### Concepts ###
- `NeighborQuery`
- `RegionType`
### Algorithm ###
- `CGAL::Shape_detection::Region_growing<InputRange, NeighborQuery, RegionType, SeedMap>`
### Point Set ###
- `CGAL::Shape_detection::Point_set::K_neighbor_query<GeomTraits, InputRange, PointMap>`
- `CGAL::Shape_detection::Point_set::Sphere_neighbor_query<GeomTraits, InputRange, PointMap>`
- `CGAL::Shape_detection::Point_set::Least_squares_line_fit_region<GeomTraits, InputRange, PointMap, NormalMap>`
- `CGAL::Shape_detection::Point_set::Least_squares_plane_fit_region<GeomTraits, InputRange, PointMap, NormalMap>`
- `CGAL::Shape_detection::Point_set::Least_squares_line_fit_sorting<GeomTraits, InputRange, NeighborQuery, PointMap>`
- `CGAL::Shape_detection::Point_set::Least_squares_plane_fit_sorting<GeomTraits, InputRange, NeighborQuery, PointMap>`
### Polygon Mesh ###
- `CGAL::Shape_detection::Polygon_mesh::One_ring_neighbor_query<PolygonMesh, FaceRange>`
- `CGAL::Shape_detection::Polygon_mesh::Least_squares_plane_fit_region<GeomTraits, PolygonMesh, FaceRange, VertexToPointMap>`
- `CGAL::Shape_detection::Polygon_mesh::Least_squares_plane_fit_sorting<GeomTraits, PolygonMesh, NeighborQuery, FaceRange, VertexToPointMap>`
## Deprecated Components ##
- `CGAL::Shape_detection::deprecated::Shape_detection_traits<GeomTraits, InputRange, PointMap, NormalMap>`
- `CGAL::Shape_detection::deprecated::Region_growing_depr<Traits>`
## Functions ##
- `CGAL::regularize_planes()`
*/