Alexandria  2.16
Please provide a description of the project.
Public Member Functions | Private Attributes | List of all members
Euclid::Configuration::PhotometryCatalogConfig Class Reference

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

#include <PhotometryCatalogConfig.h>

Inheritance diagram for Euclid::Configuration::PhotometryCatalogConfig:
[legend]
Collaboration diagram for Euclid::Configuration::PhotometryCatalogConfig:
[legend]

Public Member Functions

 PhotometryCatalogConfig (long manager_id)
 Constructs a new PhotometryCatalogConfig object. More...
 
virtual ~PhotometryCatalogConfig ()=default
 Destructor. More...
 
std::map< std::string, OptionDescriptionList > getProgramOptions () override
 Returns the program options defined by the PhotometryCatalogConfig. More...
 
void initialize (const UserValues &args) override
 Adds the PhotometryAttributeFromRow handler to the CatalogConfig. More...
 
bool isMissingPhotometryEnabled ()
 
bool isUpperLimitEnabled ()
 
- 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 preInitialize (const UserValues &args)
 Method which is called before the initialization phase. 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...
 

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  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 photometric catalog input.

Definition at line 42 of file PhotometryCatalogConfig.h.

Constructor & Destructor Documentation

◆ PhotometryCatalogConfig()

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

Constructs a new PhotometryCatalogConfig object.

Definition at line 44 of file PhotometryCatalogConfig.cpp.

◆ ~PhotometryCatalogConfig()

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

Destructor.

Member Function Documentation

◆ getProgramOptions()

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.

Returns
The map with the option descriptions

Reimplemented from Euclid::Configuration::Configuration.

Definition at line 49 of file PhotometryCatalogConfig.cpp.

References std::string::c_str(), Euclid::Configuration::ENABLE_UPPER_LIMIT, Euclid::Configuration::MISSING_PHOTOMETRY_FLAG, and Euclid::Configuration::UPPER_LIMIT_USE_THRESHOLD_FLAG.

Here is the call graph for this function:

◆ initialize()

void Euclid::Configuration::PhotometryCatalogConfig::initialize ( const UserValues &  args)
overridevirtual

Adds the PhotometryAttributeFromRow handler to the CatalogConfig.

Parameters
argsThe user parameters

Reimplemented from Euclid::Configuration::Configuration.

Definition at line 60 of file PhotometryCatalogConfig.cpp.

References std::map< K, T >::at(), Euclid::Configuration::ENABLE_UPPER_LIMIT, std::map< K, T >::end(), std::map< K, T >::find(), Elements::Logging::info(), Euclid::Configuration::logger, m_missing_photometry_enabled, m_upper_limit_enabled, Euclid::Configuration::MISSING_PHOTOMETRY_FLAG, std::move(), and Euclid::Configuration::UPPER_LIMIT_USE_THRESHOLD_FLAG.

Here is the call graph for this function:

◆ isMissingPhotometryEnabled()

bool Euclid::Configuration::PhotometryCatalogConfig::isMissingPhotometryEnabled ( )

Definition at line 100 of file PhotometryCatalogConfig.cpp.

References Euclid::Configuration::Configuration::getCurrentState(), Euclid::Configuration::Configuration::INITIALIZED, and m_missing_photometry_enabled.

Here is the call graph for this function:

◆ isUpperLimitEnabled()

bool Euclid::Configuration::PhotometryCatalogConfig::isUpperLimitEnabled ( )

Definition at line 110 of file PhotometryCatalogConfig.cpp.

References Euclid::Configuration::Configuration::getCurrentState(), Euclid::Configuration::Configuration::INITIALIZED, and m_upper_limit_enabled.

Here is the call graph for this function:

Member Data Documentation

◆ m_missing_photometry_enabled

bool Euclid::Configuration::PhotometryCatalogConfig::m_missing_photometry_enabled {false}
private

Definition at line 84 of file PhotometryCatalogConfig.h.

Referenced by initialize(), and isMissingPhotometryEnabled().

◆ m_upper_limit_enabled

bool Euclid::Configuration::PhotometryCatalogConfig::m_upper_limit_enabled {false}
private

Definition at line 85 of file PhotometryCatalogConfig.h.

Referenced by initialize(), and isUpperLimitEnabled().


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