mx::astro::earthAlbedo< _units, verboseT > Struct Template Reference

template<typename _units, typename verboseT = verbose::d>
struct mx::astro::earthAlbedo< _units, verboseT >

Earth Albedo Spectra.

The spectra can be one of:

• "EPOXI" returns the apparent albedo spectrum from Cowan and Strait (2013) [6].
• "RawEarthshine" returns the unnormalized albedo spectrum measured using Earthshine by Turnbull et al. (2006) [35]
• "Earthshine" returns the Earthshine spectrum normalized to match the EPOXI result of 0.27 in the 550 nm band.

Definition at line 308 of file astroSpectra.hpp.

#include <astro/astroSpectra.hpp>

Public Types
typedef std::string	paramsT
	The name of the spectrum can be "EPOXI", "Earthshine", or "RawEarthshine".

Static Public Member Functions
static std::string	fileName (const std::string &name)
	The name of the datafile is a constant.
static error_t	readSpectrum (std::vector< realT > &rawLambda, std::vector< realT > &rawSpectrum, const std::string &path, const paramsT &params)
	Read the Earthshine albedo spectrum, which is a simple two column ASCII format.

Static Public Attributes
static constexpr realT	wavelengthUnits = static_cast<realT>( 1e6 )
	Convert from A to SI m.
static constexpr realT	fluxUnits = static_cast<realT>( 1 )
	The Earthshine is a dimensionless albedo.
static constexpr const char *	dataDirEnvVar = "EARTHSHINE_DATADIR"
	The location is specified by the EARTHSHINE_DATADIR environment variable.

Member Typedef Documentation

paramsT

template<typename _units, typename verboseT = verbose::d>

typedef std::string mx::astro::earthAlbedo< _units, verboseT >::paramsT

The name of the spectrum can be "EPOXI", "Earthshine", or "RawEarthshine".

Definition at line 315 of file astroSpectra.hpp.

Member Function Documentation

fileName()

template<typename _units, typename verboseT = verbose::d>

std::string mx::astro::earthAlbedo< _units, verboseT >::fileName ( const std::string & name )

inlinestatic

The name of the datafile is a constant.

Definition at line 327 of file astroSpectra.hpp.

References mx::invalidarg, and mx::internal::mxlib_error_report().

readSpectrum()

template<typename _units, typename verboseT = verbose::d>

error_t mx::astro::earthAlbedo< _units, verboseT >::readSpectrum ( std::vector< realT > & rawLambda, std::vector< realT > & rawSpectrum, const std::string & path, const paramsT & params )

inlinestatic

Read the Earthshine albedo spectrum, which is a simple two column ASCII format.

Parameters

[out]	rawLambda	the raw wavelength. Should be empty on input.
[out]	rawSpectrum	the raw spectrum. Should be empty on input.
[in]	path	the full path to the file.
[in]	params	the parameters needed to construct the spectrum

Definition at line 342 of file astroSpectra.hpp.

References mx::ioutils::readColumns().

Member Data Documentation

dataDirEnvVar

template<typename _units, typename verboseT = verbose::d>

const char* mx::astro::earthAlbedo< _units, verboseT >::dataDirEnvVar = "EARTHSHINE_DATADIR"

staticconstexpr

The location is specified by the EARTHSHINE_DATADIR environment variable.

Definition at line 324 of file astroSpectra.hpp.

fluxUnits

template<typename _units, typename verboseT = verbose::d>

realT mx::astro::earthAlbedo< _units, verboseT >::fluxUnits = static_cast<realT>( 1 )

staticconstexpr

The Earthshine is a dimensionless albedo.

Definition at line 321 of file astroSpectra.hpp.

wavelengthUnits

template<typename _units, typename verboseT = verbose::d>

realT mx::astro::earthAlbedo< _units, verboseT >::wavelengthUnits = static_cast<realT>( 1e6 )

staticconstexpr

Convert from A to SI m.

Definition at line 318 of file astroSpectra.hpp.

---

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

• astro/astroSpectra.hpp