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

template<typename _units>
struct mx::astro::earthAlbedo< _units >

Earth Albedo Spectra.

The spectra can be one of:

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

Definition at line 289 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". More...

Static Public Member Functions
static std::string	fileName (const std::string &name)
	The name of the datafile is a constant. More...
static int	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. More...

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

Member Typedef Documentation

paramsT

template<typename _units >

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

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

Definition at line 296 of file astroSpectra.hpp.

Member Function Documentation

fileName()

template<typename _units >

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

inlinestatic

The name of the datafile is a constant.

Definition at line 308 of file astroSpectra.hpp.

readSpectrum()

template<typename _units >

static int mx::astro::earthAlbedo< _units >::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 vector. This should be an empty vector on input.
[out]	rawSpectrum	the raw spectrum. This should be an empty vector on input.
[in]	path	the full path to the file.
[in]	params	the parameters are passed in case needed to construct the spectrum

Definition at line 320 of file astroSpectra.hpp.

References mx::ioutils::readColumns().

Member Data Documentation

dataDirEnvVar

template<typename _units >

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

staticconstexpr

The location is specified by the EARTHSHINE_DATADIR environment variable.

Definition at line 305 of file astroSpectra.hpp.

fluxUnits

template<typename _units >

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

staticconstexpr

The Earthshine is a dimensionless albedo.

Definition at line 302 of file astroSpectra.hpp.

wavelengthUnits

template<typename _units >

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

staticconstexpr

Convert from A to SI m.

Definition at line 299 of file astroSpectra.hpp.

---

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

• astro/astroSpectra.hpp