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

#include <SpecZCatalogConfig.h>

Inheritance diagram for Euclid::Configuration::SpecZCatalogConfig:

Collaboration diagram for Euclid::Configuration::SpecZCatalogConfig:

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

virtual	~SpecZCatalogConfig ()=default
	Destructor. More...

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

void	preInitialize (const UserValues &args) override
	Checks that all the options are valid. See the exceptions thrown for a detailed list of the checks. More...

void	initialize (const UserValues &args) override
	Adds the SpectroscopicRedshiftAttributeFromRow handler to the CatalogCnofig. More...

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

virtual	~Configuration ()=default
	Destructor. More...

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

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

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

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

Additional Inherited Members
Public Types inherited from Euclid::Configuration::Configuration
enum	State { State::CONSTRUCTED, State::PRE_INITIALIZED, State::INITIALIZED, State::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. More...

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

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

Detailed Description

Configuration class for enabling SpecZ catalog input.

Definition at line 39 of file SpecZCatalogConfig.h.

Constructor & Destructor Documentation

Euclid::Configuration::SpecZCatalogConfig::SpecZCatalogConfig ( long manager_id )

explicit

Constructs a new SpecZCatalogConfig object.

Definition at line 40 of file SpecZCatalogConfig.cpp.

virtual Euclid::Configuration::SpecZCatalogConfig::~SpecZCatalogConfig ( )

virtualdefault

Destructor.

Member Function Documentation

auto Euclid::Configuration::SpecZCatalogConfig::getProgramOptions ( )

overridevirtual

Returns the program options defined by the SpecZCatalogConfig.

These options are:

spec-z-column-name : The name of the column containing the SpecZ
spec-z-column-index : The index (1-based) of the column containing the SpecZ
spec-z-err-column-name : The name of the column containing the SpecZ error
spec-z-err-column-index : The index (1-based) of the column containing the SpecZ error

Either the name or the column index can be provided but not both. The SpecZ column information is mandatory while the error is optional (the error is set to 0 if not provided)

All options are in a group called "Input catalog options".

Returns: The map with the option descriptions

Reimplemented from Euclid::Configuration::Configuration.

Definition at line 44 of file SpecZCatalogConfig.cpp.

References std::string::c_str(), Euclid::Configuration::SPECZ_COLUMN_INDEX, Euclid::Configuration::SPECZ_COLUMN_NAME, Euclid::Configuration::SPECZ_ERR_COLUMN_INDEX, and Euclid::Configuration::SPECZ_ERR_COLUMN_NAME.

Here is the call graph for this function:

void Euclid::Configuration::SpecZCatalogConfig::initialize ( const UserValues & args )

overridevirtual

Adds the SpectroscopicRedshiftAttributeFromRow handler to the CatalogCnofig.

Parameters

args	The user parameters

Exceptions

Elements::Exception	If the defined SpecZ column does not exist
Elements::Exception	If the defined SpecZ error column does not exist

Reimplemented from Euclid::Configuration::Configuration.

Definition at line 117 of file SpecZCatalogConfig.cpp.

References std::map< K, T >::end(), std::map< K, T >::find(), Euclid::Configuration::getErrColumnFromOptions(), Euclid::Configuration::getFluxColumnFromOptions(), std::shared_ptr::reset(), Euclid::Configuration::SPECZ_ERR_COLUMN_INDEX, and Euclid::Configuration::SPECZ_ERR_COLUMN_NAME.

Here is the call graph for this function:

void Euclid::Configuration::SpecZCatalogConfig::preInitialize ( const UserValues & args )

overridevirtual

Checks that all the options are valid. See the exceptions thrown for a detailed list of the checks.

Parameters

args	The user parameters

Exceptions

Elements::Exception	If both the spec-z-column-name and spec-z-column-index are given
Elements::Exception	If none of the spec-z-column-name and spec-z-column-index are given
Elements::Exception	If the spec-z-column-index is an invalid one-based index (less than 1)
Elements::Exception	If both the spec-z-err-column-name and spec-z-err-column-index are given
Elements::Exception	If the spec-z-err-column-index is an invalid one-based index (less than 1)

Reimplemented from Euclid::Configuration::Configuration.

Definition at line 56 of file SpecZCatalogConfig.cpp.

References std::map< K, T >::at(), std::map< K, T >::end(), std::map< K, T >::find(), Euclid::Configuration::SPECZ_COLUMN_INDEX, Euclid::Configuration::SPECZ_COLUMN_NAME, Euclid::Configuration::SPECZ_ERR_COLUMN_INDEX, and Euclid::Configuration::SPECZ_ERR_COLUMN_NAME.

Here is the call graph for this function:

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

Configuration/Configuration/SpecZCatalogConfig.h
Configuration/src/lib/SpecZCatalogConfig.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation