Euclid::SourceCatalog::SpectroscopicRedshiftAttributeFromRow Class Reference

Implementation of the AttributeFromRow for a SpectroscopicRedshift attribute. This class implements the createAttribute method that must be used to create SpectroscopicRedshift objects. More...

#include <SpectroscopicRedshiftAttributeFromRow.h>

Inheritance diagram for Euclid::SourceCatalog::SpectroscopicRedshiftAttributeFromRow:

Collaboration diagram for Euclid::SourceCatalog::SpectroscopicRedshiftAttributeFromRow:

Public Member Functions
	SpectroscopicRedshiftAttributeFromRow (std::shared_ptr< Euclid::Table::ColumnInfo > column_info_ptr, const std::string &specz_value_column_name, const std::string &specz_error_column_name)
	Create a SpectroscopicRedshiftAttributeFromRow object. More...
	SpectroscopicRedshiftAttributeFromRow (std::shared_ptr< Euclid::Table::ColumnInfo > column_info_ptr, const std::string &specz_value_column_name)
	Create a SpectroscopicRedshiftAttributeFromRow object. More...
	~SpectroscopicRedshiftAttributeFromRow () override=default
std::unique_ptr< Attribute >	createAttribute (const Euclid::Table::Row &row) override
	Create a photometricAttribute from a Table row. More...
Public Member Functions inherited from Euclid::SourceCatalog::AttributeFromRow
virtual	~AttributeFromRow ()=default

Private Attributes
size_t	m_value_column_index
bool	m_has_error_column
size_t	m_error_column_index

Detailed Description

Implementation of the AttributeFromRow for a SpectroscopicRedshift attribute. This class implements the createAttribute method that must be used to create SpectroscopicRedshift objects.

Definition at line 52 of file SpectroscopicRedshiftAttributeFromRow.h.

Constructor & Destructor Documentation

Euclid::SourceCatalog::SpectroscopicRedshiftAttributeFromRow::SpectroscopicRedshiftAttributeFromRow ( std::shared_ptr< Euclid::Table::ColumnInfo >  column_info_ptr, const std::string &  specz_value_column_name, const std::string &  specz_error_column_name  )

inline

Create a SpectroscopicRedshiftAttributeFromRow object.

Create a SpectroscopicRedshiftAttributeFromRow object, setting up the rule for building SpectroscopicRedshiftAttribute from table rows. The names provides the names used for the Table columns.

Parameters

column_info_ptr	describes the columns of the Table, providing in particular the required column names
specz_value_column_name	give the name of the spectroscopic redshift value table column
specz_error_column_name	give the name of the spectroscopic redshift error table column, if this name is missing or the column not found, the error is defaulted to 0

Exceptions

An	exception is thrown if the names provided in the mapping are not present in the columnInfo.

Definition at line 74 of file SpectroscopicRedshiftAttributeFromRow.h.

References m_error_column_index, m_has_error_column, and m_value_column_index.

Euclid::SourceCatalog::SpectroscopicRedshiftAttributeFromRow::SpectroscopicRedshiftAttributeFromRow ( std::shared_ptr< Euclid::Table::ColumnInfo >  column_info_ptr, const std::string &  specz_value_column_name  )

inline

Create a SpectroscopicRedshiftAttributeFromRow object.

Create a SpectroscopicRedshiftAttributeFromRow object, setting up the rule for building SpectroscopicRedshiftAttribute from table rows. The names provides the names used for the Table columns. This constructor is used when there is no Z error column in the catalog

Parameters

column_info_ptr	describes the columns of the Table, providing in particular the required column names
specz_value_column_name	give the name of the spectroscopic redshift value table column

Exceptions

An	exception is thrown if the names provided in the mapping are not present in the columnInfo.

Definition at line 110 of file SpectroscopicRedshiftAttributeFromRow.h.

References Euclid::SourceCatalog::logger, m_error_column_index, m_has_error_column, m_value_column_index, and Elements::Logging::warn().

Here is the call graph for this function:

Euclid::SourceCatalog::SpectroscopicRedshiftAttributeFromRow::~SpectroscopicRedshiftAttributeFromRow ( )

overridedefault

Member Function Documentation

std::unique_ptr<Attribute> Euclid::SourceCatalog::SpectroscopicRedshiftAttributeFromRow::createAttribute ( const Euclid::Table::Row &  row )

inlineoverridevirtual

Create a photometricAttribute from a Table row.

Create a photometricAttribute from a Table row using the mapping included in this object

Parameters

row	A Table row

Returns

A unique pointer to a (SpectroscopicRedshift) Attribute

Implements Euclid::SourceCatalog::AttributeFromRow.

Definition at line 134 of file SpectroscopicRedshiftAttributeFromRow.h.

References e, m_error_column_index, m_has_error_column, and m_value_column_index.

Member Data Documentation

size_t Euclid::SourceCatalog::SpectroscopicRedshiftAttributeFromRow::m_error_column_index

private

Definition at line 149 of file SpectroscopicRedshiftAttributeFromRow.h.

Referenced by createAttribute(), and SpectroscopicRedshiftAttributeFromRow().

bool Euclid::SourceCatalog::SpectroscopicRedshiftAttributeFromRow::m_has_error_column

private

Definition at line 148 of file SpectroscopicRedshiftAttributeFromRow.h.

Referenced by createAttribute(), and SpectroscopicRedshiftAttributeFromRow().

size_t Euclid::SourceCatalog::SpectroscopicRedshiftAttributeFromRow::m_value_column_index

private

Indices of the spectroscopic redshift value and error columns in the table

Definition at line 147 of file SpectroscopicRedshiftAttributeFromRow.h.

Referenced by createAttribute(), and SpectroscopicRedshiftAttributeFromRow().

---

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

• SourceCatalog/SourceCatalog/SourceAttributes/SpectroscopicRedshiftAttributeFromRow.h