Alexandria 2.32.0
SDC-CH common library for the Euclid project
Loading...
Searching...
No Matches
Euclid::Configuration::PhotometryCatalogConfig Class Reference

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

#include <PhotometryCatalogConfig.h>

Inheritance diagram for Euclid::Configuration::PhotometryCatalogConfig:
Collaboration diagram for Euclid::Configuration::PhotometryCatalogConfig:

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 void preInitialize (const UserValues &args)
 Method which is called before 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

◆ PhotometryCatalogConfig()

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

Constructs a new PhotometryCatalogConfig object.

Definition at line 43 of file PhotometryCatalogConfig.cpp.

References Euclid::Configuration::Configuration::Configuration(), and Euclid::Configuration::Configuration::declareDependency().

Here is the call graph for this function:

◆ ~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 48 of file PhotometryCatalogConfig.cpp.

References Euclid::Configuration::ENABLE_UPPER_LIMIT, Euclid::Configuration::MISSING_PHOTOMETRY_FLAG, and Euclid::Configuration::UPPER_LIMIT_USE_THRESHOLD_FLAG.

◆ initialize()

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

◆ isMissingPhotometryEnabled()

bool Euclid::Configuration::PhotometryCatalogConfig::isMissingPhotometryEnabled ( )
Returns
True if the flag to recognize missing photometry values is enabled

Definition at line 94 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 ( )
Returns
True if the upper limit is enabled

Definition at line 103 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 91 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 92 of file PhotometryCatalogConfig.h.

Referenced by initialize(), and isUpperLimitEnabled().


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