mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
mx::astro::astroFilter< _units, _rsr > Struct Template Reference

template<typename _units, bool _rsr = true>
struct mx::astro::astroFilter< _units, _rsr >

A spectrum from the astroFilt filter library.

Definition at line 68 of file astroSpectra.hpp.

#include <astro/astroSpectra.hpp>

Public Types

typedef std::string paramsT
 The astroFilters are parameterized by name. More...
 

Static Public Member Functions

static int readSpectrum (std::vector< realT > &rawLambda, std::vector< realT > &rawSpectrum, const std::string &path, const paramsT &params)
 

Static Public Attributes

static constexpr realT wavelengthUnits = static_cast<realT>(1e6)
 Convert from um to SI m. More...
 
static constexpr realT fluxUnits = static_cast<realT>(1)
 No conversion is performed on filter transmission. More...
 

Member Typedef Documentation

◆ paramsT

template<typename _units , bool _rsr = true>
typedef std::string mx::astro::astroFilter< _units, _rsr >::paramsT

The astroFilters are parameterized by name.

Definition at line 76 of file astroSpectra.hpp.

Member Function Documentation

◆ readSpectrum()

template<typename _units , bool _rsr = true>
static int mx::astro::astroFilter< _units, _rsr >::readSpectrum ( std::vector< realT > &  rawLambda,
std::vector< realT > &  rawSpectrum,
const std::string &  path,
const paramsT params 
)
inlinestatic
Parameters
[out]rawLambdathe raw wavelength vector. This should be an empty vector on input.
[out]rawSpectrumthe raw spectrum. This should be an empty vector on input.
[in]paththe full path to the file.
[in]paramsthe parameters are passed in case needed to construct the spectrum

Definition at line 91 of file astroSpectra.hpp.

References mx::ioutils::readColumns().

Member Data Documentation

◆ fluxUnits

template<typename _units , bool _rsr = true>
constexpr realT mx::astro::astroFilter< _units, _rsr >::fluxUnits = static_cast<realT>(1)
staticconstexpr

No conversion is performed on filter transmission.

Definition at line 82 of file astroSpectra.hpp.

◆ wavelengthUnits

template<typename _units , bool _rsr = true>
constexpr realT mx::astro::astroFilter< _units, _rsr >::wavelengthUnits = static_cast<realT>(1e6)
staticconstexpr

Convert from um to SI m.

Definition at line 79 of file astroSpectra.hpp.


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