Configuration class for enabling photometric catalog input. More...

Inheritance diagram for Euclid::Configuration::PhotometryCatalogConfig:

Collaboration diagram for Euclid::Configuration::PhotometryCatalogConfig:

[legend]

Public Member Functions
	PhotometryCatalogConfig (long manager_id)
	Constructs a new PhotometryCatalogConfig object.

virtual	~PhotometryCatalogConfig ()=default
	Destructor.

std::map< std::string, OptionDescriptionList >	getProgramOptions () override
	Returns the program options defined by the PhotometryCatalogConfig.

void	initialize (const UserValues &args) override
	Adds the PhotometryAttributeFromRow handler to the CatalogConfig.

bool	isMissingPhotometryEnabled ()

bool	isUpperLimitEnabled ()

Public Member Functions inherited from Euclid::Configuration::Configuration
	Configuration (long manager_id)
	Constructs a new Configuration instance.

virtual	~Configuration ()=default
	Destructor.

virtual std::map< std::string, OptionDescriptionList >	getProgramOptions ()
	Returns the program options defined by a specific configuration.

virtual void	preInitialize (const UserValues &args)
	Method which is called before the initialization phase.

virtual void	initialize (const UserValues &args)
	Method which is called during the initialization phase.

virtual void	postInitialize (const UserValues &args)
	Method which is called after the initialization phase.

const std::set< std::type_index > &	getDependencies ()
	Returns the dependencies of the configuration.

State &	getCurrentState ()
	Returns the current state of the configuration.

State	getCurrentState () const
	Returns the current state of the configuration.

Private Attributes
bool	m_missing_photometry_enabled {false}

bool	m_upper_limit_enabled {false}

Additional Inherited Members
Public Types inherited from Euclid::Configuration::Configuration
enum class	State { CONSTRUCTED , PRE_INITIALIZED , INITIALIZED , FINAL }
	Defines the different states the configuration object can be in. More...

using	OptionDescriptionList = std::vector< boost::program_options::option_description >

using	UserValues = std::map< std::string, boost::program_options::variable_value >

Protected Member Functions inherited from Euclid::Configuration::Configuration
template<typename T >
void	declareDependency ()
	Declares a Configuration as dependency.

template<typename T >
T &	getDependency ()
	Returns a dependency.

template<typename T >
const T &	getDependency () const

Detailed Description

Configuration class for enabling photometric catalog input.

Definition at line 42 of file PhotometryCatalogConfig.h.

Constructor & Destructor Documentation

Euclid::Configuration::PhotometryCatalogConfig::PhotometryCatalogConfig ( long manager_id )

explicit

Constructs a new PhotometryCatalogConfig object.

virtual Euclid::Configuration::PhotometryCatalogConfig::~PhotometryCatalogConfig ( )

virtualdefault

Destructor.

auto Euclid::Configuration::PhotometryCatalogConfig::getProgramOptions ( )

overridevirtual

Returns the program options defined by the PhotometryCatalogConfig.

These options are:

missing-photometry-flag : The flux value to indicate missing photometry data If not provided the functionality is disabled
enable-upper-limit : Define if the catalog contains flux upper limit (YES/NO by default NO)

All options are in a group called "Input catalog options". They are all optional. The missing-photometr-flag defaults to the value -99.