From a75c5a88b9ffa6bd6e68eefb0b17f080de907b11 Mon Sep 17 00:00:00 2001 From: Pierre Alliez Date: Tue, 9 Dec 2008 17:06:34 +0000 Subject: [PATCH] PCA: update doc and description --- .../Principal_component_analysis/PkgDescription.tex | 2 +- .../Principal_component_analysis/examples.tex | 6 +++--- .../introduction.tex | 12 +----------- .../Principal_component_analysis/description.txt | 6 +++--- 4 files changed, 8 insertions(+), 18 deletions(-) diff --git a/Principal_component_analysis/doc_tex/Principal_component_analysis/PkgDescription.tex b/Principal_component_analysis/doc_tex/Principal_component_analysis/PkgDescription.tex index 8ca6001d1ea..61703e2ffb9 100644 --- a/Principal_component_analysis/doc_tex/Principal_component_analysis/PkgDescription.tex +++ b/Principal_component_analysis/doc_tex/Principal_component_analysis/PkgDescription.tex @@ -1,6 +1,6 @@ \begin{ccPkgDescription}{Principal Component Analysis\label{Pkg:PrincipalComponentAnalysisD}} \ccPkgHowToCiteCgal{cgal:ap-pcad-08} -\ccPkgSummary{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 sets of bounded objects, 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.} +\ccPkgSummary{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.} %\ccPkgDependsOn{} \ccPkgIntroducedInCGAL{3.2} diff --git a/Principal_component_analysis/doc_tex/Principal_component_analysis/examples.tex b/Principal_component_analysis/doc_tex/Principal_component_analysis/examples.tex index 25a12b71b1b..732f719dcf5 100644 --- a/Principal_component_analysis/doc_tex/Principal_component_analysis/examples.tex +++ b/Principal_component_analysis/doc_tex/Principal_component_analysis/examples.tex @@ -5,16 +5,16 @@ In the following example we use \stl\ containers of 2D points and 3D points, and \ccIncludeExampleCode{Principal_component_analysis/bounding_box.cpp} \subsection{Centroid of 2D and 3D Objects} -In the following example we use \stl\ containers of 2D and 3D points and 3D triangles, and compute their centroid. The kernel from which the input points originate is automatically deduced by the function. The dimension tag indicates the dimension of the objects being fitted (0 for points, and 2 for triangles). Note that it is also possible to compute the centroid of the triangle edges (3D segments) by specifying 1 as dimension tag, and of the triangle vertices (3D points) by specifying 0 as dimension tag. \ccIncludeExampleCode{Principal_component_analysis/centroid.cpp} +In the following example we use \stl\ containers of 2D, 3D points and 3D triangles, and compute their centroid. The kernel from which the input objects originate is automatically deduced by the function. The dimension tag indicates the dimension of the objects being fitted (0 for points, 2 for triangles). Note that it is also possible to compute the centroid of the triangle edges (3D segments) by specifying 1 as dimension tag, and to compute the centroid of the triangle vertices (3D points) by specifying 0 as dimension tag. \ccIncludeExampleCode{Principal_component_analysis/centroid.cpp} \subsection{Barycenter of a Set of Weighted Points} -In the following example we use \stl\ containers of 2D and 3D weighted points, and compute their barycenter. The kernel from which the input points originate is automatically deduced by the function. \ccIncludeExampleCode{Principal_component_analysis/barycenter.cpp} +In the following example we use \stl\ containers of 2D and 3D weighted points, and compute their barycenter. The kernel from which the input weighted points originate is automatically deduced by the function. \ccIncludeExampleCode{Principal_component_analysis/barycenter.cpp} \subsection{Least Squares Fitting of a Line to a 2D Point Set} In the following example we use a \stl\ container of 2D points, and compute the best fitting line in the least squares sense. The kernel from which the input points originate is automatically deduced by the function. \ccIncludeExampleCode{Principal_component_analysis/linear_least_squares_fitting_points_2.cpp} \subsection{Least Squares Fitting of a Line and a Plane to a 3D Triangle Set} -In the following example we use a \stl\ container of 3D triangles, and compute the best fitting line and plane in the least squares sense. The kernel from which the input points originate is automatically deduced by the function. Note that we can fit either the whole triangles, the triangle edges or the triangle vertices. +In the following example we use a \stl\ container of 3D triangles, and compute the best fitting line and plane in the least squares sense. The kernel from which the input triangles originate is automatically deduced by the function. Note that we can fit either the whole triangles, the triangle edges or the triangle vertices. \ccIncludeExampleCode{Principal_component_analysis/linear_least_squares_fitting_triangles_3.cpp} diff --git a/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/introduction.tex b/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/introduction.tex index f131de99241..867908ba52b 100644 --- a/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/introduction.tex +++ b/Principal_component_analysis/doc_tex/Principal_component_analysis_ref/introduction.tex @@ -11,17 +11,7 @@ \ccChapterAuthor{Pierre Alliez, Sylvain Pion and Ankit Gupta} -This \cgal\ 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 sets of bounded -objects, 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. +This \cgal\ 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. \section{Classified Reference Pages} diff --git a/Principal_component_analysis/package_info/Principal_component_analysis/description.txt b/Principal_component_analysis/package_info/Principal_component_analysis/description.txt index 2ae38054958..756b13e0d03 100644 --- a/Principal_component_analysis/package_info/Principal_component_analysis/description.txt +++ b/Principal_component_analysis/package_info/Principal_component_analysis/description.txt @@ -2,6 +2,6 @@ Package Principal Component Analysis - provides functions for linear fitting (in the least squares sense) of sets of 2D and 3D kernel objects. - some basic shape analysis functions : - bounding_box() - centroid() - barycenter() only for sets of weighted points + bounding_box() for point sets. + centroid() for sets of 2D and 3D kernel objects. + barycenter() only for sets of weighted points.