CGAL::Feature_graph::Regularization_parameters Class Reference

#include <CGAL/Feature_graph/Regularization_parameters.h>

Inherited by CGAL::Feature_graph::Regularization_parameters_on_image, and CGAL::Feature_graph::Regularization_parameters_on_surface.

Definition

The class Regularization_parameters describes the parameters for the regularization step.

See also

CGAL::Feature_graph::Regularization_parameters_on_image

CGAL::Feature_graph::Regularization_parameters_on_surface

CGAL::Feature_graph::Detect_sharp_features_on_labeled_image

CGAL::Feature_graph::Detect_sharp_features_on_surface

Types
typedef double	FT
	Numerical type.

Access Functions
template<typename DimensionTag , typename Point_3 , typename Index >
FT	isthmus_line_distance_threshold (const Point_3 &point_in_space, const Index &element_index) const
	returns the threshold on the distance between an isthmus line and any line at a point on the surface.
template<typename DimensionTag , typename Point_3 , typename Index >
FT	simple_line_distance_threshold (const Point_3 &point_in_space, const Index &element_index) const
	returns the threshold on the distance between a simple line and any line at a point on the surface.
template<typename DimensionTag , typename Point_3 , typename Index >
FT	corner_line_distance_threshold (const Point_3 &point_in_space, const Index &element_index) const
	returns the threshold on the distance between a corner line and any line at a point on the surface.

Member Function Documentation

corner_line_distance_threshold()

template<typename DimensionTag , typename Point_3 , typename Index >

FT CGAL::Feature_graph::Regularization_parameters::corner_line_distance_threshold	(	const Point_3 &	point_in_space,
		const Index &	element_index
	)		const

returns the threshold on the distance between a corner line and any line at a point on the surface.

A corner line is neither isthmus nor simple. In the regularization step, if the maximum distance of a line to another line is less than this threshold, then the line is collapsed.

Template Parameters

DimensionTag	a tag that represent the element type. Can be CGAL::Dimension_tag<0>, CGAL::Dimension_tag<1> or CGAL::Dimension_tag<2>
Point_3	class model of Kernel::Point_3.
Index	the type of index used to identify the element to evaluate, which can be a vertex, an edge, or a facet according to the DimesionTag.

Parameters

point_in_space	the position to evaluate from in 3D space.
element_index	the index of the element on the surface.

isthmus_line_distance_threshold()

template<typename DimensionTag , typename Point_3 , typename Index >

FT CGAL::Feature_graph::Regularization_parameters::isthmus_line_distance_threshold	(	const Point_3 &	point_in_space,
		const Index &	element_index
	)		const

returns the threshold on the distance between an isthmus line and any line at a point on the surface.

An isthmus line is bounded by a corner that is incident to only the same line. In the regularization step, if the maximum distance of a line to another line is less than this threshold, then the line is collapsed.

Template Parameters

DimensionTag	a tag that represent the element type. Can be CGAL::Dimension_tag<0>, CGAL::Dimension_tag<1> or CGAL::Dimension_tag<2>
Point_3	class model of Kernel::Point_3.
Index	the type of index used to identify the element to evaluate, which can be a vertex, an edge, or a facet according to the DimesionTag.

Parameters

point_in_space	the position to evaluate from in 3D space.
element_index	the index of the element on the surface.

simple_line_distance_threshold()

template<typename DimensionTag , typename Point_3 , typename Index >

FT CGAL::Feature_graph::Regularization_parameters::simple_line_distance_threshold	(	const Point_3 &	point_in_space,
		const Index &	element_index
	)		const

returns the threshold on the distance between a simple line and any line at a point on the surface.

A simple line is a line that can be removed without splitting the graph of its neighbors. In the regularization step, if the maximum distance of a line to another line is less than this threshold, then the line is collapsed.

Template Parameters

DimensionTag	a tag that represent the element type. Can be CGAL::Dimension_tag<0>, CGAL::Dimension_tag<1> or CGAL::Dimension_tag<2>
Point_3	class model of Kernel::Point_3.
Index	the type of index used to identify the element to evaluate, which can be a vertex, an edge, or a facet according to the DimesionTag.

Parameters

point_in_space	the position to evaluate from in 3D space.
element_index	the index of the element on the surface.