This applies a solar model to radiances to model the incoming solar irradiance. More...

#include <solar_absorption_and_continuum.h>

Inheritance diagram for FullPhysics::SolarAbsorptionAndContinuum:

Collaboration diagram for FullPhysics::SolarAbsorptionAndContinuum:

Public Member Functions
	SolarAbsorptionAndContinuum (const boost::shared_ptr< SolarDopplerShift > &doppler_shiftv, const boost::shared_ptr< SolarAbsorptionSpectrum > &absorption_spectrumv, const boost::shared_ptr< SolarContinuumSpectrum > &continuum_spectrumv)
	Create a SolarModel that uses the given doppler shift, absorption spectrum, and continuum spectrum. More...

virtual	~SolarAbsorptionAndContinuum ()

const SolarAbsorptionSpectrum &	absorption_spectrum () const
	The SolarAbsorptionSpectrum object used by this class. More...

const boost::shared_ptr< SolarAbsorptionSpectrum > &	absorption_spectrum_ptr () const
	The SolarAbsorptionSpectrum object used by this class, as a ptr. More...

virtual void	add_observer (Observer< SpectrumEffect > &Obs)
	Add an observer. More...

void	add_observer_and_keep_reference (boost::shared_ptr< Observer< SpectrumEffect > > &Obs)
	Add an observer and keep a reference to it. More...

virtual void	apply_effect (Spectrum &Spec, const ForwardModelSpectralGrid &Forward_model_grid) const
	Apply correction to spectrum in place. More...

virtual Spectrum	apply_solar_model (const Spectrum &Spec) const
	Apply the solar model. More...

virtual boost::shared_ptr< SpectrumEffect >	clone () const
	Clone a SolarAbsorptionAndContinuum object. More...

const SolarContinuumSpectrum &	continuum_spectrum () const
	The SolarContinuumSpectrum object used by this class. More...

const boost::shared_ptr< SolarContinuumSpectrum > &	continuum_spectrum_ptr () const
	The SolarContinuumSpectrum object used by this class, as a ptr. More...

const SolarDopplerShift &	doppler_shift () const
	The SolarDopplerShift object used by this class. More...

const boost::shared_ptr< SolarDopplerShift > &	doppler_shift_ptr () const
	The SolarDopplerShift object used by this class, as a ptr. More...

virtual void	mark_used (const StateVector &Sv, blitz::Array< bool, 1 > &Used) const
	Mark elements that we are actively using (i.e., that aren't ignored). More...

virtual std::string	name () const
	Name of spectrum effect, for use when outputting effects of effect. More...

virtual void	notify_add (StateVector &Observed_object)
	Called when an object is added to an Observable. More...

virtual void	notify_add ()

virtual void	notify_remove (StateVector &Observed_object)
	Called when an object is removed from an Observable. More...

virtual void	notify_remove ()

virtual void	notify_update (const StateVector &Observed_object)
	Called when the Observed object is updated. More...

virtual void	print (std::ostream &Os) const
	Print description of object. More...

std::string	print_to_string () const
	Print to string. More...

virtual void	remove_observer (Observer< SpectrumEffect > &Obs)
	Remove an observer. More...

virtual Spectrum	solar_spectrum (const SpectralDomain &Spec_domain) const
	Calculate solar spectrum. More...

virtual void	state_vector_name (const StateVector &Sv, blitz::Array< std::string, 1 > &Sv_name) const
	Update any portion of the list of the state vector names that apply to this object. More...

Protected Member Functions
void	add_observer_do (Observer< SpectrumEffect > &Obs, SpectrumEffect &t)
	Add an observer. More...

void	add_observer_do (Observer< SpectrumEffect > &Obs)

void	clean_dead_ptr ()
	Remove any dead pointers. More...

void	notify_update_do (const SpectrumEffect &Self)
	Function to call to notify Observers of a state change. More...

void	remove_observer_do (Observer< SpectrumEffect > &Obs, SpectrumEffect &t)
	Remove an observer. More...

void	remove_observer_do (Observer< SpectrumEffect > &Obs)

Protected Attributes
std::list< boost::weak_ptr< Observer< SpectrumEffect > > >	olist

std::vector< boost::shared_ptr< Observer< SpectrumEffect > > >	ref_list

Detailed Description

This applies a solar model to radiances to model the incoming solar irradiance.

This implementation is a common division of the solar model into

A Doppler correction
A solar absorption spectrum
A solar continuum spectrum

This uses 3 objects to do the work, a SolarDopplerShift, a SolarAbsorptionSpectrum, and a SolarContinuumSpectrum object. This class stitches these objects together to create the full spectrum.

Definition at line 25 of file solar_absorption_and_continuum.h.

Constructor & Destructor Documentation

◆ SolarAbsorptionAndContinuum()

FullPhysics::SolarAbsorptionAndContinuum::SolarAbsorptionAndContinuum	(	const boost::shared_ptr< SolarDopplerShift > &	doppler_shiftv,
		const boost::shared_ptr< SolarAbsorptionSpectrum > &	absorption_spectrumv,
		const boost::shared_ptr< SolarContinuumSpectrum > &	continuum_spectrumv
	)

inline

Create a SolarModel that uses the given doppler shift, absorption spectrum, and continuum spectrum.

Definition at line 32 of file solar_absorption_and_continuum.h.

◆ ~SolarAbsorptionAndContinuum()

virtual FullPhysics::SolarAbsorptionAndContinuum::~SolarAbsorptionAndContinuum ( )

inlinevirtual

Definition at line 41 of file solar_absorption_and_continuum.h.

Member Function Documentation

◆ absorption_spectrum()

const SolarAbsorptionSpectrum& FullPhysics::SolarAbsorptionAndContinuum::absorption_spectrum ( ) const

inline

The SolarAbsorptionSpectrum object used by this class.

Definition at line 73 of file solar_absorption_and_continuum.h.

◆ absorption_spectrum_ptr()

const boost::shared_ptr<SolarAbsorptionSpectrum>& FullPhysics::SolarAbsorptionAndContinuum::absorption_spectrum_ptr ( ) const

inline

The SolarAbsorptionSpectrum object used by this class, as a ptr.

Definition at line 80 of file solar_absorption_and_continuum.h.

◆ add_observer()

virtual void FullPhysics::SpectrumEffect::add_observer ( Observer< SpectrumEffect > & Obs )

inlinevirtualinherited

Add an observer.

Implements FullPhysics::Observable< SpectrumEffect >.

Definition at line 20 of file spectrum_effect.h.

◆ add_observer_and_keep_reference()

void FullPhysics::Observable< SpectrumEffect >::add_observer_and_keep_reference ( boost::shared_ptr< Observer< SpectrumEffect > > & Obs )

inlineinherited

Add an observer and keep a reference to it.

See the discussion in the Observer class description for details.

Definition at line 107 of file observer.h.

◆ add_observer_do() [1/2]

void FullPhysics::Observable< SpectrumEffect >::add_observer_do	(	Observer< SpectrumEffect > &	Obs,
		SpectrumEffect &	t
	)

inlineprotectedinherited

Add an observer.

Definition at line 148 of file observer.h.

◆ add_observer_do() [2/2]

void FullPhysics::Observable< SpectrumEffect >::add_observer_do ( Observer< SpectrumEffect > & Obs )

inlineprotectedinherited

Definition at line 159 of file observer.h.

◆ apply_effect()

virtual void FullPhysics::SolarModel::apply_effect	(	Spectrum &	Spec,
		const ForwardModelSpectralGrid &	Forward_model_grid
	)		const

inlinevirtualinherited

Apply correction to spectrum in place.

We pass in the forward model grids used. A class can use this to optimize its calculation, see for example FluorescenceEffect.

Implements FullPhysics::SpectrumEffect.

Definition at line 36 of file solar_model.h.

◆ apply_solar_model()

Spectrum SolarModel::apply_solar_model ( const Spectrum & Spec ) const

virtualinherited

Apply the solar model.

Parameters

Spec	Spectrum without solar model applied. This is per solid angle, e.g., sr^-1 (RT code generates "sun-normalized" output)

Returns: Spectrum with solar model applied.

Definition at line 21 of file solar_model.cc.

◆ clean_dead_ptr()

void FullPhysics::Observable< SpectrumEffect >::clean_dead_ptr ( )

inlineprotectedinherited

Remove any dead pointers.

Definition at line 196 of file observer.h.

◆ clone()

virtual boost::shared_ptr<SpectrumEffect> FullPhysics::SolarAbsorptionAndContinuum::clone ( ) const

inlinevirtual

Clone a SolarAbsorptionAndContinuum object.

Implements FullPhysics::SpectrumEffect.

Definition at line 48 of file solar_absorption_and_continuum.h.

◆ continuum_spectrum()

const SolarContinuumSpectrum& FullPhysics::SolarAbsorptionAndContinuum::continuum_spectrum ( ) const

inline

The SolarContinuumSpectrum object used by this class.

Definition at line 87 of file solar_absorption_and_continuum.h.

◆ continuum_spectrum_ptr()

const boost::shared_ptr<SolarContinuumSpectrum>& FullPhysics::SolarAbsorptionAndContinuum::continuum_spectrum_ptr ( ) const

inline

The SolarContinuumSpectrum object used by this class, as a ptr.

Definition at line 94 of file solar_absorption_and_continuum.h.

◆ doppler_shift()

const SolarDopplerShift& FullPhysics::SolarAbsorptionAndContinuum::doppler_shift ( ) const

inline

The SolarDopplerShift object used by this class.

Definition at line 60 of file solar_absorption_and_continuum.h.

◆ doppler_shift_ptr()

const boost::shared_ptr<SolarDopplerShift>& FullPhysics::SolarAbsorptionAndContinuum::doppler_shift_ptr ( ) const

inline

The SolarDopplerShift object used by this class, as a ptr.

Definition at line 66 of file solar_absorption_and_continuum.h.

◆ mark_used()

virtual void FullPhysics::StateVectorObserver::mark_used	(	const StateVector &	Sv,
		blitz::Array< bool, 1 > &	Used
	)		const

inlinevirtualinherited

Mark elements that we are actively using (i.e., that aren't ignored).

You only need to mark the ones that are used as true, everything is already initialized as false. Default is to do nothing.

Reimplemented in FullPhysics::SubStateVectorObserver.

Definition at line 26 of file state_vector_observer.h.

◆ name()

virtual std::string FullPhysics::SolarModel::name ( ) const

inlinevirtualinherited

Name of spectrum effect, for use when outputting effects of effect.

Implements FullPhysics::SpectrumEffect.

Definition at line 41 of file solar_model.h.

◆ notify_add() [1/2]

virtual void FullPhysics::Observer< StateVector >::notify_add ( StateVector & Observed_object )

inlinevirtualinherited

Called when an object is added to an Observable.

Default is to do nothing.

Reimplemented in FullPhysics::AtmosphereOco, and FullPhysics::SubStateVectorObserver.

Definition at line 47 of file observer.h.

◆ notify_add() [2/2]

virtual void FullPhysics::Observer< StateVector >::notify_add ( )

inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_remove() [1/2]

virtual void FullPhysics::Observer< StateVector >::notify_remove ( StateVector & Observed_object )

inlinevirtualinherited

Called when an object is removed from an Observable.

Default is to do nothing.

Reimplemented in FullPhysics::AtmosphereOco, and FullPhysics::SubStateVectorObserver.

Definition at line 55 of file observer.h.

◆ notify_remove() [2/2]

virtual void FullPhysics::Observer< StateVector >::notify_remove ( )

inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_update()

virtual void FullPhysics::Observer< StateVector >::notify_update ( const StateVector & Observed_object )

inlinevirtualinherited

Called when the Observed object is updated.

Reimplemented in FullPhysics::AtmosphereOco, FullPhysics::RadianceScalingSvFit, FullPhysics::AbsorberAbsco, FullPhysics::AerosolOptical, and FullPhysics::SubStateVectorObserver.

Definition at line 40 of file observer.h.

◆ notify_update_do()

void FullPhysics::Observable< SpectrumEffect >::notify_update_do ( const SpectrumEffect & Self )

inlineprotectedinherited

Function to call to notify Observers of a state change.

The object should pass itself to this function, so it can be passed to the Observers.

Definition at line 121 of file observer.h.

◆ print()

void SolarAbsorptionAndContinuum::print ( std::ostream & Os ) const

virtual

Print description of object.

Reimplemented from FullPhysics::SolarModel.

Definition at line 21 of file solar_absorption_and_continuum.cc.

◆ print_to_string()

std::string FullPhysics::Printable< StateVectorObserver >::print_to_string ( ) const

inlineinherited

Print to string.

This is primarily useful for SWIG wrappers to this class, e.g. a to_s method in ruby.

Definition at line 31 of file printable.h.

◆ remove_observer()

virtual void FullPhysics::SpectrumEffect::remove_observer ( Observer< SpectrumEffect > & Obs )

inlinevirtualinherited

Remove an observer.

Implements FullPhysics::Observable< SpectrumEffect >.

Definition at line 22 of file spectrum_effect.h.

◆ remove_observer_do() [1/2]

void FullPhysics::Observable< SpectrumEffect >::remove_observer_do	(	Observer< SpectrumEffect > &	Obs,
		SpectrumEffect &	t
	)

inlineprotectedinherited

Remove an observer.

Definition at line 173 of file observer.h.

◆ remove_observer_do() [2/2]

void FullPhysics::Observable< SpectrumEffect >::remove_observer_do ( Observer< SpectrumEffect > & Obs )

inlineprotectedinherited

Definition at line 181 of file observer.h.

◆ solar_spectrum()

Spectrum SolarAbsorptionAndContinuum::solar_spectrum ( const SpectralDomain & Spec_domain ) const

virtual

Calculate solar spectrum.

Parameters

Spec_domain Wavenumber/Wavelength reflectance is given

Returns: Solar spectrum. This should have units commensurate with something like W / m^2 / cm^-1.

Note that the wavenumber/frequency are in the earth rest frame. The solar model may need to work in the solar rest frame, bu the conversion to this is internal. The input and output from this function should be in the earth rest frame.

Implements FullPhysics::SolarModel.

Definition at line 32 of file solar_absorption_and_continuum.cc.

◆ state_vector_name()

virtual void FullPhysics::StateVectorObserver::state_vector_name	(	const StateVector &	Sv,
		blitz::Array< std::string, 1 > &	Sv_name
	)		const

inlinevirtualinherited

Update any portion of the list of the state vector names that apply to this object.

Default is to do nothing.

Reimplemented in FullPhysics::SubStateVectorObserver.

Definition at line 34 of file state_vector_observer.h.

Member Data Documentation

◆ olist

std::list<boost::weak_ptr<Observer<SpectrumEffect > > > FullPhysics::Observable< SpectrumEffect >::olist

protectedinherited

Definition at line 200 of file observer.h.

◆ ref_list

std::vector<boost::shared_ptr<Observer<SpectrumEffect > > > FullPhysics::Observable< SpectrumEffect >::ref_list

protectedinherited

Definition at line 201 of file observer.h.

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

Implementation/solar_absorption_and_continuum.h
Implementation/solar_absorption_and_continuum.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SolarAbsorptionAndContinuum()

◆ ~SolarAbsorptionAndContinuum()

Member Function Documentation

◆ absorption_spectrum()

◆ absorption_spectrum_ptr()

◆ add_observer()

◆ add_observer_and_keep_reference()

◆ add_observer_do() [1/2]

◆ add_observer_do() [2/2]

◆ apply_effect()

◆ apply_solar_model()

◆ clean_dead_ptr()

◆ clone()

◆ continuum_spectrum()

◆ continuum_spectrum_ptr()

◆ doppler_shift()

◆ doppler_shift_ptr()

◆ mark_used()

◆ name()

◆ notify_add() [1/2]

◆ notify_add() [2/2]

◆ notify_remove() [1/2]

◆ notify_remove() [2/2]

◆ notify_update()

◆ notify_update_do()

◆ print()

◆ print_to_string()

◆ remove_observer()

◆ remove_observer_do() [1/2]

◆ remove_observer_do() [2/2]

◆ solar_spectrum()

◆ state_vector_name()

Member Data Documentation

◆ olist

◆ ref_list