Automatic ref manual update

This commit is contained in:
Laurent Saboret 2009-06-24 13:47:25 +00:00
parent 78ff390920
commit 25ef46c2e1
5 changed files with 18 additions and 69 deletions

View File

@ -29,14 +29,14 @@
% Reduce left margin % Reduce left margin
\ccThree{123456789012345}{6789012}{} \ccThree{123456789012345}{6789012}{}
\ccFunction{template<typename ForwardIterator, typename PointPMap, typename Kernel> void jet_smooth_point_set(ForwardIterator first, ForwardIterator beyond, PointPMap point_pmap, unsigned int k, const Kernel& kernel, unsigned int degree_fitting = 2, unsigned int degree_monge = 2);} \ccFunction{template<typename InputIterator, typename PointPMap, typename Kernel> void jet_smooth_point_set(InputIterator first, InputIterator beyond, PointPMap point_pmap, unsigned int k, const Kernel& kernel, unsigned int degree_fitting = 2, unsigned int degree_monge = 2);}
{ {
Smoothes the [first, beyond) range of points using jet fitting on the k nearest neighbors and reprojection onto the jet. As this method relocates the points, it should not be called on containers sorted w.r.t. point locations. Smoothes the [first, beyond) range of points using jet fitting on the k nearest neighbors and reprojection onto the jet. As this method relocates the points, it should not be called on containers sorted w.r.t. point locations.
\ccPrecond k $>$= 2. \ccPrecond k $>$= 2.
\ccCommentHeading{Template Parameters} \\ \ccCommentHeading{Template Parameters} \\
\ccc{ForwardIterator}: iterator over input points. \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}. \ccc{InputIterator}: iterator over input points. \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{InputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}.
\ccCommentHeading{Parameters} \\ \ccCommentHeading{Parameters} \\
\ccc{first}: iterator over the first input point. \ccc{beyond}: past-the-end iterator over the input points. \ccc{point_pmap}: property map \ccc{ForwardIterator} -$>$ \ccc{Point_3}. \ccc{k}: number of neighbors. \ccc{kernel}: geometric traits. \ccc{first}: iterator over the first input point. \ccc{beyond}: past-the-end iterator over the input points. \ccc{point_pmap}: property map \ccc{InputIterator} -$>$ \ccc{Point_3}. \ccc{k}: number of neighbors. \ccc{kernel}: geometric traits.
} }
\ccGlue \ccGlue

View File

@ -32,16 +32,16 @@ This method modifies the order of input points so as to pack all remaining point
% Reduce left margin % Reduce left margin
\ccThree{123456789012345}{6789012}{} \ccThree{123456789012345}{6789012}{}
\ccFunction{template<typename ForwardIterator, typename PointPMap, typename Kernel> ForwardIterator remove_outliers(ForwardIterator first, ForwardIterator beyond, PointPMap point_pmap, unsigned int k, double threshold_percent, const Kernel& kernel);} \ccFunction{template<typename InputIterator, typename PointPMap, typename Kernel> InputIterator remove_outliers(InputIterator first, InputIterator beyond, PointPMap point_pmap, unsigned int k, double threshold_percent, const Kernel& kernel);}
{ {
Removes outliers: computes average squared distance to the K nearest neighbors, and sorts the points in increasing order of average distance. \\ Removes outliers: computes average squared distance to the K nearest neighbors, and sorts the points in increasing order of average distance. \\
This method modifies the order of input points so as to pack all remaining points first, and returns an iterator over the first point to remove (see erase-remove idiom). For this reason it should not be called on sorted containers. This method modifies the order of input points so as to pack all remaining points first, and returns an iterator over the first point to remove (see erase-remove idiom). For this reason it should not be called on sorted containers.
\ccPrecond k $>$= 2. \ccPrecond k $>$= 2.
\ccCommentHeading{Template Parameters} \\ \ccCommentHeading{Template Parameters} \\
\ccc{ForwardIterator}: iterator over input points. \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{ForwardIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}. \ccc{InputIterator}: iterator over input points. \ccc{PointPMap}: is a model of \ccc{boost::ReadablePropertyMap} with a \ccc{value_type} = \ccc{Point_3<Kernel>}. It can be omitted if \ccc{InputIterator} \ccc{value_type} is convertible to \ccc{Point_3<Kernel>}. \ccc{Kernel}: Geometric traits class. It can be omitted and deduced automatically from \ccc{PointPMap} \ccc{value_type}.
\ccCommentHeading{Returns} iterator over the first point to remove. \ccCommentHeading{Returns} iterator over the first point to remove.
\ccCommentHeading{Parameters} \\ \ccCommentHeading{Parameters} \\
\ccc{first}: iterator over the first input point. \ccc{beyond}: past-the-end iterator over the input points. \ccc{point_pmap}: property map \ccc{ForwardIterator} -$>$ \ccc{Point_3}. \ccc{k}: number of neighbors. \ccc{threshold_percent}: percentage of points to remove. \ccc{kernel}: geometric traits. \ccc{first}: iterator over the first input point. \ccc{beyond}: past-the-end iterator over the input points. \ccc{point_pmap}: property map \ccc{InputIterator} -$>$ \ccc{Point_3}. \ccc{k}: number of neighbors. \ccc{threshold_percent}: percentage of points to remove. \ccc{kernel}: geometric traits.
} }
\ccGlue \ccGlue

View File

@ -22,7 +22,7 @@
% The section below is automatically generated. Do not edit! % The section below is automatically generated. Do not edit!
%START-AUTO(\ccDefinition) %START-AUTO(\ccDefinition)
\ccc{APSS_reconstruction_function} computes an implicit function that defines a Point Set Surface (PSS) based on moving least squares (MLS) fitting of algebraic spheres. \ccc{APSS_reconstruction_function} computes a signed distance field that defines a Point Set Surface (PSS) based on moving least squares (MLS) fitting of algebraic spheres.
This class implements a variant of the {\em Algebraic Point Set Surfaces} method by Guennebaud and Gross \cite{Guennebaud07}. This class implements a variant of the {\em Algebraic Point Set Surfaces} method by Guennebaud and Gross \cite{Guennebaud07}.
@ -97,6 +97,11 @@ typedef to \ccc{Geom_traits::Vector_3}
typedef to \ccc{Geom_traits::Sphere_3} typedef to \ccc{Geom_traits::Sphere_3}
} }
\ccGlue \ccGlue
\ccNestedType{BBox}
{
typedef to \ccc{Bbox_3}
}
\ccGlue
%END-AUTO(\ccTypes) %END-AUTO(\ccTypes)
@ -148,7 +153,11 @@ Sets smoothness factor. Typical choices are in the range 2 (clean datasets) and
Returns a sphere bounding the inferred surface. Returns a sphere bounding the inferred surface.
} }
\ccGlue \ccGlue
\ccMethod{FT operator()(const Point& p) const;} \ccMethod{BBox bounding_box() const;}
{
}
\ccGlue
\ccMethod{FT operator()(const Point& p, bool * ok = 0) const;}
{ {
\ccc{ImplicitFunction} interface: evaluates the implicit function at a given 3D query point. \ccc{ImplicitFunction} interface: evaluates the implicit function at a given 3D query point.
} }

View File

@ -73,7 +73,7 @@ Geometric traits class.
\ccGlue \ccGlue
\ccNestedType{Triangulation} \ccNestedType{Triangulation}
{ {
Typedef to \ccc{Reconstruction_triangulation_3<Gt>}. Internal 3D triangulation, of type \ccc{Reconstruction_triangulation_3}.
} }
\ccGlue \ccGlue
\ccNestedType{FT} \ccNestedType{FT}

View File

@ -1,60 +0,0 @@
% +------------------------------------------------------------------------+
% | Reference manual page: output_surface_facets_to_polyhedron.tex
% +------------------------------------------------------------------------+
% | 07.01.2009 Pierre Alliez, Laurent Saboret, Gael Guennebaud
% | Package: Surface_reconstruction_points_3
% |
\RCSdef{\RCSsurfacereconstructionoutputsurfacefacetsRev}{$Id$}
\RCSdefDate{\RCSsurfacereconstructionoutputsurfacefacetsDate}{$Date$}
% |
\ccRefPageBegin
%%RefPage: end of header, begin of main body
% +------------------------------------------------------------------------+
\begin{ccRefFunction}{output_surface_facets_to_polyhedron} %% add template arg's if necessary
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
%% \ccHtmlIndexC[function]{} %% add further index entries
\ccDefinition
\ccc{output_surface_facets_to_polyhedron()} converts a surface reconstructed by \ccc{make_surface_mesh()} to a \ccc{Polyhedron_3<Traits>}.
\ccInclude{CGAL/output_surface_facets_to_polyhedron.h}
% The section below is automatically generated. Do not edit!
%START-AUTO(\ccDefinition)
% Reduce left margin
\ccThree{123456789012345}{6789012}{}
\ccFunction{template<class SurfaceMeshComplex_2InTriangulation_3, class Polyhedron> void output_surface_facets_to_polyhedron(const SurfaceMeshComplex_2InTriangulation_3& c2t3, Polyhedron& output_polyhedron);}
{
Gets reconstructed surface out of a \ccc{SurfaceMeshComplex_2InTriangulation_3} object. \\
This variant exports the surface as a polyhedron. It requires the surface to be manifold. For this purpose, you may call \ccc{make_surface_mesh}() with \ccc{Manifold_tag} or \ccc{Manifold_with_boundary_tag} parameter.
\ccCommentHeading{Template Parameters} \\
\ccc{SurfaceMeshComplex_2InTriangulation_3}: model of the \ccc{SurfaceMeshComplex_2InTriangulation_3} concept. \ccc{Polyhedron}: an instance of \ccc{Polyhedron_3<Traits>}.
\ccCommentHeading{Parameters} \\
\ccc{c2t3}: Input surface. \ccc{output_polyhedron}: Output polyhedron.
}
\ccGlue
%END-AUTO(\ccDefinition)
\ccSeeAlso
\ccRefIdfierPage{CGAL::output_surface_facets_to_off} \\
\ccExample
See \ccc{APSS_reconstruction.cpp} example.
\end{ccRefFunction}
% +------------------------------------------------------------------------+
%%RefPage: end of main body, begin of footer
\ccRefPageEnd
% EOF
% +------------------------------------------------------------------------+