cgal/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt

46 lines
2.3 KiB
Plaintext

/// \defgroup PkgPrincipalComponentAnalysisDRef Reference Manual
/// \defgroup PkgPrincipalComponentAnalysisDBary CGAL::barycenter()
/// \ingroup PkgPrincipalComponentAnalysisDRef
/// \defgroup PkgPrincipalComponentAnalysisDbb CGAL::bounding_box()
/// \ingroup PkgPrincipalComponentAnalysisDRef
/// \defgroup PkgPrincipalComponentAnalysisDCentroid CGAL::centroid()
/// \ingroup PkgPrincipalComponentAnalysisDRef
/// \defgroup PkgPrincipalComponentAnalysisDLLSF2 CGAL::linear_least_square_fitting_2()
/// \ingroup PkgPrincipalComponentAnalysisDRef
/// \defgroup PkgPrincipalComponentAnalysisDLLSF3 CGAL::linear_least_square_fitting_3()
/// \ingroup PkgPrincipalComponentAnalysisDRef
/*!
\addtogroup PkgPrincipalComponentAnalysisDRef
\cgalPkgDescriptionBegin{Principal Component Analysis,PkgPrincipalComponentAnalysisD}
\cgalPkgPicture{teaserLeastSquaresFitting.png}
\cgalPkgSummaryBegin
\cgalPkgAuthors{Pierre Alliez, Sylvain Pion, and Ankit Gupta}
\cgalPkgDesc{This package provides functions to compute global information about the shape of a set of 2D or 3D objects. It provides the computation of axis-aligned bounding boxes for point sets, and barycenters of weighted point sets. In addition, it provides computation of centroids (center of mass) and linear least squares fitting for point sets as well as for sets of other bounded objects. More specifically, it is possible to fit 2D lines to 2D segments, circles, disks, iso rectangles and triangles, as well as to fit 3D lines or 3D planes to 3D segments, triangles, iso cuboids, tetrahedra, spheres and balls. The common interface to these functions takes an iterator range of objects.}
\cgalPkgManuals{Chapter_Principal_Component_Analysis,PkgPrincipalComponentAnalysisDRef}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{3.2}
\cgalPkgDependsOn{\ref PkgSolverInterface}
\cgalPkgBib{cgal:ap-pcad}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Principal Component Analysis,pca.zip,Operations on Polygons,polygon.zip,CGAL Lab,CGALlab.zip}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
\cgalCRPSection{Functions}
- \link PkgPrincipalComponentAnalysisDbb `CGAL::barycenter()` \endlink
- `CGAL::bounding_box()`
- `CGAL::centroid()`
- `CGAL::linear_least_squares_fitting_2()`
- `CGAL::linear_least_squares_fitting_3()`
*/