Module computing a sampling of an input boundary of the union of 3D balls. Module computing a sampling of an input boundary of the union of 3D balls. More...

#include "Union_of_balls_mesh_3_module.hpp"

Static Public Member Functions
static boost::program_options::options_description *&	get_options (void)
	Access to the options' description of the module.

Traits Requirements
typedef ModuleTraits::Union_of_balls_boundary_3	Union_of_balls_boundary_3
	Representation of the boundary of the union of balls.
typedef SBL::GT::T_Union_of_balls_epsilon_mesh_3< Union_of_balls_boundary_3 >	Sampler
	Construction of the mesh of the union of 3D balls such that any point at the surface of the union of balls has a point of the mesh in its epsilon-neighborhood.
typedef Sampler::FT	FT
	Number type used for representing coordinates of 3D balls and points.
typedef Sampler::Point_3	Point_3
	Representation of a 3D point.

Input Accessors
Union_of_balls_boundary_3 *&	get_boundary (void)
	Reference to a pointer over the input boundary.

Output Accessors
const std::vector< Point_3 > &	get_sampling (void) const
	Const reference to the output surface area and volume computation.
std::vector< Point_3 > &	get_sampling (void)
	Reference to the output surface area and volume computation.

Mandatory Requirements
void	run (unsigned verbose, std::ostream &out) override
	Runs the module following the input options.
bool	is_runnable (void) const override
	Checks that all the input options were set.
void	statistics (std::ostream &out) override
	Reports high-level statistics on the module.
std::string	get_name (void) const override
	Returns the name of the package.

Optional Requirements
boost::program_options::options_description	add_options (void) override
	Virtual method for adding options to the module.
bool	check_options (std::string &message) const override
	Checks that the input options' values are coherent.
std::string	get_output_prefix (void) const override
	Returns a prefix that concatains the input line options used when running the module.
void	report (const std::string &prefix) override
	Reports the output and statistics in output files.

Modules Management
void	set_module_instance_name (const std::string &module_instance_name)
	Sets a name for this instance of this module. In particular, it will be used in the prefix of output files generated by a collection of modules.
const std::string &	get_module_instance_name (void) const
	Get the name of this instance of this module.
void	set_report_mode (std::ios_base::openmode report_mode)
	Set a report mode, that is open or append modes.
void	set_report_mode (std::ios_base::openmode &report_mode)
	Set a report mode, that is open or append modes.
const std::ios_base::openmode	get_report_mode (void) const
	Get the report mode to be used when reporting.

Optional Requirements
void	check_filesystem_directory_exists (const std::string &output_prefix)
	To avoid later crash: check filesystem / existence of directory / directory exists.

Others
template<class Self_>
Self_ *	clone (const Self_ *s) const
	Clones the object using the copy constructor.
virtual bool	is_logical_module (void) const
	Checks that this module defines a logical operator.
virtual bool	is_condition_module (void) const
	Checks that this module defines a condition operator.
virtual bool	operator() (void)
	Only for condition modules, for returning the predicate value.
virtual bool	is_modules_collection (void) const
	Checks that this module defines a collection of modules.

Parameters
static void	set_epsilon (const FT &epsilon)
	Sets the epsilon value of the sampling.
static void	set_sampling_viewer (const std::string &viewer_name)
	Sets the sampling viewer mode for reporting the sampling.

Detailed Description

template<class ModuleTraits>
class SBL::Modules::T_Union_of_balls_mesh_3_module< ModuleTraits >

Module computing a sampling of an input boundary of the union of 3D balls. Module computing a sampling of an input boundary of the union of 3D balls.

It computes the sampling such that the nearest neighbor of each point of the sampling is under a user defined epsilon distance.

The input is the boundary of the union of 3D balls and can be set using the method SBL::Modules::T_Union_of_balls_mesh_3_module::get_boundary, that returns a reference to a pointer over the input boundary.

The output is a vector of 3D points.

Template Parameters

ModuleTraits Traits class defining the type SBL::Modules::T_Union_of_balls_mesh_3_module::Union_of_balls_boundary_3

Member Typedef Documentation

◆ FT

template<class ModuleTraits>

typedef Sampler::FT FT

Number type used for representing coordinates of 3D balls and points.

◆ Point_3

template<class ModuleTraits>

typedef Sampler::Point_3 Point_3

Representation of a 3D point.

◆ Sampler

template<class ModuleTraits>

typedef SBL::GT::T_Union_of_balls_epsilon_mesh_3<Union_of_balls_boundary_3> Sampler

Construction of the mesh of the union of 3D balls such that any point at the surface of the union of balls has a point of the mesh in its epsilon-neighborhood.

...

◆ Union_of_balls_boundary_3

template<class ModuleTraits>

typedef ModuleTraits::Union_of_balls_boundary_3 Union_of_balls_boundary_3

Representation of the boundary of the union of balls.

Template Parameters

WeightedAlphaComplex3	A Model of the 3D Weighted $\alpha$ -complex of the CGAL Library.
IS_CCW	Tag allowing to orientate in CW or CCW the sense of the half-edges.
HalfedgeDSBase	Base data structure for the boundary of union of balls.

Member Function Documentation

◆ add_options()

template<class ModuleTraits>

boost::program_options::options_description add_options ( void )

inlineoverridevirtual

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description< Dummy >.

◆ check_filesystem_directory_exists()

void check_filesystem_directory_exists ( const std::string & output_prefix )

inlineinherited

To avoid later crash: check filesystem / existence of directory / directory exists.

◆ check_options()

template<class ModuleTraits>

bool check_options ( std::string & message ) const

inlineoverridevirtual

Checks that the input options' values are coherent.

Reimplemented from T_Module_option_description< Dummy >.

◆ clone()

template<class Self_>

Self_ * clone ( const Self_ * s ) const

inlineinherited

Clones the object using the copy constructor.

◆ get_boundary()

template<class ModuleTraits>

T_Union_of_balls_mesh_3_module< ModuleTraits >::Union_of_balls_boundary_3 *& get_boundary ( void )

inline

Reference to a pointer over the input boundary.

◆ get_module_instance_name()

const std::string & get_module_instance_name ( void ) const

inlineinherited

Get the name of this instance of this module.

◆ get_name()

template<class ModuleTraits>

std::string get_name ( void ) const

inlineoverridevirtual

Returns the name of the package.

Reimplemented from Module_base.

◆ get_options()

template<class Dummy = void>

boost::program_options::options_description *& get_options ( void )

inlinestaticinherited

Access to the options' description of the module.

◆ get_output_prefix()

template<class ModuleTraits>

std::string get_output_prefix ( void ) const

inlineoverridevirtual

Returns a prefix that concatains the input line options used when running the module.

Reimplemented from T_Module_option_description< Dummy >.

◆ get_report_mode()

const std::ios_base::openmode get_report_mode ( void ) const

inlineinherited

Get the report mode to be used when reporting.

◆ get_sampling() [1/2]

template<class ModuleTraits>

std::vector< typename T_Union_of_balls_mesh_3_module< ModuleTraits >::Point_3 > & get_sampling ( void )

inline

Reference to the output surface area and volume computation.

◆ get_sampling() [2/2]

template<class ModuleTraits>

const std::vector< typename T_Union_of_balls_mesh_3_module< ModuleTraits >::Point_3 > & get_sampling ( void ) const

inline

Const reference to the output surface area and volume computation.

◆ is_condition_module()

virtual bool is_condition_module ( void ) const

inlineprotectedvirtualinherited

Checks that this module defines a condition operator.

◆ is_logical_module()

virtual bool is_logical_module ( void ) const

inlineprotectedvirtualinherited

Checks that this module defines a logical operator.

◆ is_modules_collection()

virtual bool is_modules_collection ( void ) const

inlineprotectedvirtualinherited

Checks that this module defines a collection of modules.

◆ is_runnable()

template<class ModuleTraits>

bool is_runnable ( void ) const

inlineoverridevirtual

Checks that all the input options were set.

Reimplemented from Module_base.

◆ operator()()

virtual bool operator() ( void )

inlineprotectedvirtualinherited

Only for condition modules, for returning the predicate value.

◆ report()

template<class ModuleTraits>

void report ( const std::string & prefix )

inlineoverridevirtual

Reports the output and statistics in output files.

Reimplemented from Module_base.

◆ run()

template<class ModuleTraits>

void run	(	unsigned	verbose,
		std::ostream &	out )

inlineoverridevirtual

Runs the module following the input options.

Implements Module_base.

◆ set_epsilon()

template<class ModuleTraits>

void set_epsilon ( const FT & epsilon )

inlinestatic

Sets the epsilon value of the sampling.

◆ set_module_instance_name()

void set_module_instance_name ( const std::string & module_instance_name )

inlineinherited

Sets a name for this instance of this module. In particular, it will be used in the prefix of output files generated by a collection of modules.

◆ set_report_mode() [1/2]

void set_report_mode ( std::ios_base::openmode & report_mode )

inlineinherited

Set a report mode, that is open or append modes.

◆ set_report_mode() [2/2]

void set_report_mode ( std::ios_base::openmode report_mode )

inlineinherited

Set a report mode, that is open or append modes.

◆ set_sampling_viewer()

template<class ModuleTraits>

void set_sampling_viewer ( const std::string & viewer_name )

inlinestatic

Sets the sampling viewer mode for reporting the sampling.

◆ statistics()

template<class ModuleTraits>

void statistics ( std::ostream & out )

inlineoverridevirtual

Reports high-level statistics on the module.

Reimplemented from Module_base.

Static Public Member Functions

Traits Requirements

Input Accessors

Output Accessors

Mandatory Requirements

Optional Requirements

Modules Management

Optional Requirements

Others

Parameters

Detailed Description

Member Typedef Documentation

◆ FT

◆ Point_3

◆ Sampler

◆ Union_of_balls_boundary_3

Member Function Documentation

◆ add_options()

◆ check_filesystem_directory_exists()

◆ check_options()

◆ clone()

◆ get_boundary()

◆ get_module_instance_name()

◆ get_name()

◆ get_options()

◆ get_output_prefix()

◆ get_report_mode()

◆ get_sampling() [1/2]

◆ get_sampling() [2/2]

◆ is_condition_module()

◆ is_logical_module()

◆ is_modules_collection()

◆ is_runnable()

◆ operator()()

◆ report()

◆ run()

◆ set_epsilon()

◆ set_module_instance_name()

◆ set_report_mode() [1/2]

◆ set_report_mode() [2/2]

◆ set_sampling_viewer()

◆ statistics()