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	Algorithm { Algorithm::NO_GROUPING, Algorithm::OVERLAPPING, Algorithm::SPLIT_SOURCES, Algorithm::MOFFAT }

Public Member Functions
virtual	~GroupingConfig ()=default
	Destructor. More...
	GroupingConfig (long manager_id)
	Constructs a new GroupingConfig object. More...
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
virtual void	preInitialize (const UserValues &args)

Private Attributes
Algorithm	m_selected_algorithm
double	m_moffat_threshold
double	m_moffat_max_distance
unsigned int	m_hard_limit

Detailed Description

Used to select a Grouping algorithm.

Definition at line 36 of file GroupingConfig.h.

Member Enumeration Documentation

enum SourceXtractor::GroupingConfig::Algorithm

strong

Enumerator
NO_GROUPING
OVERLAPPING
SPLIT_SOURCES
MOFFAT

Definition at line 39 of file GroupingConfig.h.

Constructor & Destructor Documentation

virtual SourceXtractor::GroupingConfig::~GroupingConfig ( )

virtualdefault

Destructor.

SourceXtractor::GroupingConfig::GroupingConfig ( long  manager_id )

explicit

Constructs a new GroupingConfig object.

Definition at line 46 of file GroupingConfig.cpp.

Member Function Documentation

Algorithm SourceXtractor::GroupingConfig::getAlgorithmOption ( ) const

inline

Definition at line 57 of file GroupingConfig.h.

References m_selected_algorithm.

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

inline

Definition at line 69 of file GroupingConfig.h.

References m_hard_limit.

double SourceXtractor::GroupingConfig::getMoffatMaxDistance ( ) const

inline

Definition at line 65 of file GroupingConfig.h.

References m_moffat_max_distance.

double SourceXtractor::GroupingConfig::getMoffatThreshold ( ) const

inline

Definition at line 61 of file GroupingConfig.h.

References m_moffat_threshold.

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:

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

overridevirtual

Reimplemented from Euclid::Configuration::Configuration.

Definition at line 64 of file GroupingConfig.cpp.

References 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.

Member Data Documentation

unsigned int SourceXtractor::GroupingConfig::m_hard_limit

private

Definition at line 77 of file GroupingConfig.h.

Referenced by getHardLimit(), and initialize().

double SourceXtractor::GroupingConfig::m_moffat_max_distance

private

Definition at line 76 of file GroupingConfig.h.

Referenced by getMoffatMaxDistance(), and initialize().

double SourceXtractor::GroupingConfig::m_moffat_threshold

private

Definition at line 75 of file GroupingConfig.h.

Referenced by getMoffatThreshold(), and initialize().

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