CGAL::Feature_graph::Regularization_parameters_on_image Class Reference

#include <CGAL/Feature_graph/Regularization_parameters.h>

Inherits from

CGAL::Feature_graph::Regularization_parameters.

Definition

The class Regularization_parameters_on_image describes the parameters for the regularization step with default values adapted for image inputs.

See also

CGAL::Feature_graph::Regularization_parameters

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 Base::FT	FT
	Numerical type.

Constructor
template<typename NamedParameters = CGAL::parameters::Default_named_parameters>
	Regularization_parameters_on_image (const NamedParameters &np=parameters::default_values())
	constructs the parameters used to regularize the feature graph extracted from an image.

Additional Inherited Members
Public Types inherited from CGAL::Feature_graph::Regularization_parameters
typedef double	FT
	Numerical type.
Public Member Functions inherited from CGAL::Feature_graph::Regularization_parameters
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.

Constructor & Destructor Documentation

Regularization_parameters_on_image()

template<typename NamedParameters = CGAL::parameters::Default_named_parameters>

CGAL::Feature_graph::Regularization_parameters_on_image::Regularization_parameters_on_image

(

const NamedParameters &

np = parameters::default_values()

)

constructs the parameters used to regularize the feature graph extracted from an image.

Template Parameters

NamedParameters

a sequence of Named Parameters

Parameters

np	an optional sequence of Named Parameters among the ones listed below. The distances are expressed in terms of the longest voxel edge length.

Optional Named Parameters

line_distance_threshold the threshold on the distance between lines. In the regularization step, if the maximum distance of a line to another line is less than this threshold, then the line is collapsed. It can be a constant or a functor that return the threshold at a point on the surface. If it is a functor, it must implement template <typename DimensionTag, typename Point_3, typename Index> FT operator()(const Point_3& point_in_space, const Index& element_index) const Default: FT(4.0) Extra: This parameter sets a baseline distance and is overridden by the parameters parameters::isthmus_line_distance_threshold, parameters::simple_line_distance_threshold and parameters::corner_line_distance_threshold if they are set.
isthmus_line_distance_threshold the threshold on the distance between an isthmus line and any line. 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. It can be a constant or a functor that return the threshold at a point on the surface. If it is a functor, it must implement template <typename DimensionTag, typename Point_3, typename Index> FT operator()(const Point_3& point_in_space, const Index& element_index) const Default: FT(-1.0) Extra: Negative values implies the use of the parameter parameters::line_distance_threshold.
simple_line_distance_threshold the threshold on the distance between a simple line and any line. 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. It can be a constant or a functor that return the threshold at a point on the surface. If it is a functor, it must implement template <typename DimensionTag, typename Point_3, typename Index> FT operator()(const Point_3& point_in_space, const Index& element_index) const Default: FT(-1.0) Extra: Negative values implies the use of the parameter parameters::line_distance_threshold.
corner_line_distance_threshold the threshold on the distance between a corner line and any line. 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. It can be a constant or a functor that return the threshold at a point on the surface. If it is a functor, it must implement template <typename DimensionTag, typename Point_3, typename Index> FT operator()(const Point_3& point_in_space, const Index& element_index) const Default: FT(-1.0) Extra: Negative values implies the use of the parameter parameters::line_distance_threshold.