SourceXtractor::GroupingConfig Class Reference

Used to select a Grouping algorithm. More...

#include <GroupingConfig.h>

Inheritance diagram for SourceXtractor::GroupingConfig:

Collaboration diagram for SourceXtractor::GroupingConfig:

Public Types
enum class	Algorithm { NO_GROUPING , OVERLAPPING , SPLIT_SOURCES , MOFFAT }
Public Types inherited from Euclid::Configuration::Configuration
enum	State
typedef std::vector< boost::program_options::option_description >	OptionDescriptionList
typedef std::map< std::string, boost::program_options::variable_value >	UserValues

Public Member Functions
virtual	~GroupingConfig ()=default
	Destructor.
	GroupingConfig (long manager_id)
	Constructs a new GroupingConfig object.
std::map< std::string, Configuration::OptionDescriptionList >	getProgramOptions () override
void	initialize (const UserValues &args) override
Algorithm	getAlgorithmOption () const
double	getMoffatThreshold () const
double	getMoffatMaxDistance () const
unsigned int	getHardLimit () const
Public Member Functions inherited from Euclid::Configuration::Configuration
	Configuration (long manager_id)
virtual	~Configuration ()=default
virtual std::map< std::string, OptionDescriptionList >	getProgramOptions ()
virtual void	preInitialize (const UserValues &args)
virtual void	initialize (const UserValues &args)
virtual void	postInitialize (const UserValues &args)
const std::set< std::type_index > &	getDependencies ()
State &	getCurrentState ()
State	getCurrentState () const

Private Attributes
Algorithm	m_selected_algorithm
double	m_moffat_threshold
double	m_moffat_max_distance
unsigned int	m_hard_limit

Additional Inherited Members
Protected Member Functions inherited from Euclid::Configuration::Configuration
void	declareDependency ()
T &	getDependency ()
const T &	getDependency () const

Detailed Description

Used to select a Grouping algorithm.

Definition at line 36 of file GroupingConfig.h.

Member Enumeration Documentation

Algorithm

enum class SourceXtractor::GroupingConfig::Algorithm

strong

Enumerator
NO_GROUPING
OVERLAPPING
SPLIT_SOURCES
MOFFAT

Definition at line 39 of file GroupingConfig.h.

Constructor & Destructor Documentation

~GroupingConfig()

virtual SourceXtractor::GroupingConfig::~GroupingConfig ( )

virtualdefault

Destructor.

GroupingConfig()

SourceXtractor::GroupingConfig::GroupingConfig ( long  manager_id )

explicit

Constructs a new GroupingConfig object.

Definition at line 46 of file GroupingConfig.cpp.

Member Function Documentation

getAlgorithmOption()

Algorithm SourceXtractor::GroupingConfig::getAlgorithmOption ( ) const

inline

Definition at line 57 of file GroupingConfig.h.

References m_selected_algorithm.

getHardLimit()

unsigned int SourceXtractor::GroupingConfig::getHardLimit ( ) const

inline

Definition at line 69 of file GroupingConfig.h.

References m_hard_limit.

getMoffatMaxDistance()

double SourceXtractor::GroupingConfig::getMoffatMaxDistance ( ) const

inline

Definition at line 65 of file GroupingConfig.h.

References m_moffat_max_distance.

getMoffatThreshold()

double SourceXtractor::GroupingConfig::getMoffatThreshold ( ) const

inline

Definition at line 61 of file GroupingConfig.h.

References m_moffat_threshold.

getProgramOptions()

std::map< std::string, Configuration::OptionDescriptionList > SourceXtractor::GroupingConfig::getProgramOptions ( )

overridevirtual

Reimplemented from Euclid::Configuration::Configuration.

Definition at line 51 of file GroupingConfig.cpp.

References std::string::c_str(), SourceXtractor::GROUPING_ALGORITHM, SourceXtractor::GROUPING_ALGORITHM_SPLIT, SourceXtractor::GROUPING_HARD_LIMIT, SourceXtractor::GROUPING_MOFFAT_MAX_DISTANCE, and SourceXtractor::GROUPING_MOFFAT_THRESHOLD.

Here is the call graph for this function:

initialize()

void SourceXtractor::GroupingConfig::initialize ( const UserValues &  args )

overridevirtual

Reimplemented from Euclid::Configuration::Configuration.

Definition at line 64 of file GroupingConfig.cpp.

References std::map< K, T >::at(), std::map< K, T >::end(), std::map< K, T >::find(), SourceXtractor::GROUPING_ALGORITHM, SourceXtractor::GROUPING_ALGORITHM_MOFFAT, SourceXtractor::GROUPING_ALGORITHM_NONE, SourceXtractor::GROUPING_ALGORITHM_OVERLAP, SourceXtractor::GROUPING_ALGORITHM_SPLIT, SourceXtractor::GROUPING_HARD_LIMIT, SourceXtractor::GROUPING_MOFFAT_MAX_DISTANCE, SourceXtractor::GROUPING_MOFFAT_THRESHOLD, m_hard_limit, m_moffat_max_distance, m_moffat_threshold, m_selected_algorithm, MOFFAT, NO_GROUPING, OVERLAPPING, and SPLIT_SOURCES.

Here is the call graph for this function:

Member Data Documentation

m_hard_limit

unsigned int SourceXtractor::GroupingConfig::m_hard_limit

private

Definition at line 77 of file GroupingConfig.h.

Referenced by getHardLimit(), and initialize().

m_moffat_max_distance

double SourceXtractor::GroupingConfig::m_moffat_max_distance

private

Definition at line 76 of file GroupingConfig.h.

Referenced by getMoffatMaxDistance(), and initialize().

m_moffat_threshold

double SourceXtractor::GroupingConfig::m_moffat_threshold

private

Definition at line 75 of file GroupingConfig.h.

Referenced by getMoffatThreshold(), and initialize().

m_selected_algorithm

Algorithm SourceXtractor::GroupingConfig::m_selected_algorithm

private

Definition at line 74 of file GroupingConfig.h.

Referenced by getAlgorithmOption(), and initialize().

---

The documentation for this class was generated from the following files:

• SEImplementation/SEImplementation/Configuration/GroupingConfig.h
• SEImplementation/src/lib/Configuration/GroupingConfig.cpp