Module which computes clusters from a cloud of points Module which computes clusters from a cloud of points.
More...
#include "Cluster_engine_module.hpp"
Static Public Member Functions
static boost::program_options::options_description *&
get_options (void)
Access to the options' description of the module.
More...
Input Accessors and modifiers
std::vector< Point > *& get_points (void)
Cluster_engine & get_engine (void)
std::vector< std::size_t > & get_clusters (void)
Mandatory Requirements
void
run (unsigned verbose, std::ostream &out) override
Runs the module following the input options.
More...
Checks that all the input options were set.
More...
Reports high-level statistics on the module.
More...
boost::program_options::options_description
add_options () override
Virtual method for adding options to the module.
More...
std::string
get_name (void) const override
Returns the name of the package.
More...
Optional Requirements
Checks that the input options' values are coherent.
More...
void
report (const std::string &prefix) override
Reports the output and statistics in output files.
More...
Returns a prefix that concatains the input line options used when running the module.
More...
Modules Management
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.
More...
Get the name of this instance of this module.
More...
Set a report mode, that is open or append modes.
More...
Set a report mode, that is open or append modes.
More...
Get the report mode to be used when reporting.
More...
Optional Requirements
To avoid later crash: check filesystem / existence of directory / directory exists.
More...
Others
template<class Self_ >
Self_ *
clone (const Self_ *s) const
Clones the object using the copy constructor.
More...
Checks that this module defines a logical operator.
More...
Checks that this module defines a condition operator.
More...
Only for condition modules, for returning the predicate value.
More...
Checks that this module defines a collection of modules.
More...
Detailed Description
template<class ModuleTraits>
class SBL::Modules::T_Cluster_engine_module< ModuleTraits >
Module which computes clusters from a cloud of points Module which computes clusters from a cloud of points.
Member Function Documentation
◆ add_options()
boost::program_options::options_description add_options
(
void
)
inlineoverridevirtual
◆ 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()
bool check_options
(
std::string &
message )
const
inlineoverridevirtual
◆ clone()
Self_* clone
(
const Self_ *
s )
const
inlineinherited
Clones the object using the copy constructor.
◆ 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()
std::string get_name
(
void
)
const
inlineoverridevirtual
Returns the name of the package.
Reimplemented from Module_base.
◆ get_options()
static boost::program_options::options_description*& get_options
(
void
)
inlinestaticinherited
Access to the options' description of the module.
◆ get_output_prefix()
std::string get_output_prefix
(
void
)
const
inlineoverridevirtual
◆ get_report_mode()
const std::ios_base::openmode get_report_mode
(
void
)
const
inlineinherited
Get the report mode to be used when reporting.
◆ 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()
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()
void report
(
const std::string &
prefix )
inlineoverridevirtual
Reports the output and statistics in output files.
Reimplemented from Module_base.
◆ run()
void run
(
unsigned
verbose,
std::ostream &
out
)
inlineoverridevirtual
Runs the module following the input options.
Implements Module_base.
◆ 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.
◆ statistics()
void statistics
(
std::ostream &
out )
inlineoverridevirtual
Reports high-level statistics on the module.
Reimplemented from Module_base.