cphot::Sun Class Reference

Class that handles the Sun's spectrum and references. More...

#include <sun.hpp>

Public Member Functions
	Sun (const QLength &distance=1 *au, const std::string &flavor="theoretical")
	Construct a new Sun object. More...
DMatrix	get_wavelength ()
	Get the internal wavelength in nm. More...
DMatrix	get_wavelength (const QLength &in)
	Get the internal wavelength in requested units. More...
DMatrix	get_flux ()
	Get the internal flux in flam. More...
DMatrix	get_flux (const QSpectralFluxDensity &in)
	Get the internal flux in requested units. More...

Detailed Description

Class that handles the Sun's spectrum and references.

Definition at line 43 of file sun.hpp.

Constructor & Destructor Documentation

Sun()

cphot::Sun::Sun	(	const QLength &	distance = 1 * au,
		const std::string &	flavor = "theoretical"
	)

Construct a new Sun object.

Parameters

distance	to the Sun (default 1 au)
flavor	theoretical or observed (default theoretical)

Definition at line 67 of file sun.hpp.

Member Function Documentation

get_flux() [1/2]

DMatrix cphot::Sun::get_flux

(

)

Get the internal flux in flam.

Returns

Sun flux in flam

Definition at line 109 of file sun.hpp.

get_flux() [2/2]

DMatrix cphot::Sun::get_flux

(

const QSpectralFluxDensity &

in

)

Get the internal flux in requested units.

Parameters

in	requested units for the flux

Returns

Sun flux units of in

Definition at line 119 of file sun.hpp.

get_wavelength() [1/2]

DMatrix cphot::Sun::get_wavelength

(

)

Get the internal wavelength in nm.

Returns

Sun wavelength in nm

Definition at line 90 of file sun.hpp.

get_wavelength() [2/2]

DMatrix cphot::Sun::get_wavelength

(

const QLength &

in

)

Get the internal wavelength in requested units.

Parameters

in	requested units for the wavelength

Returns

Sun wavelength units of in

Definition at line 100 of file sun.hpp.

---

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

• /home/runner/work/cphot/cphot/include/cphot/sun.hpp