Abstract Interface for Rt classes based on Spurr driver implementations. More...

#include <spurr_rt.h>

Inheritance diagram for FullPhysics::SpurrRt:

Collaboration diagram for FullPhysics::SpurrRt:

Public Member Functions
	SpurrRt (const boost::shared_ptr< RtAtmosphere > &Atm, const boost::shared_ptr< StokesCoefficient > &Stokes_coef, const blitz::Array< double, 1 > &Sza, const blitz::Array< double, 1 > &Zen, const blitz::Array< double, 1 > &Azm, bool do_solar=true, bool do_thermal=false)
	Constructor. More...

virtual void	add_observer (Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > &Obs)
	Required observable functions. More...

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

const boost::shared_ptr< RtAtmosphere > &	atmosphere () const

boost::shared_ptr< RtAtmosphere >	atmosphere_ptr () const

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

virtual void	notify_add ()

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

virtual void	notify_remove ()

void	notify_update (const RtAtmosphere &atm)
	For performance, we cache some data as we calculate it. More...

virtual int	number_moment () const =0
	Number of moments for scattering matrix. More...

virtual int	number_spectrometer () const
	Number of spectrometer we have. More...

virtual int	number_stokes () const
	Number of stokes in returned stokes values Note that LIDORT will only ever calculate the first stoke index for I,. More...

virtual int	number_stream () const =0
	Number of quadtature streams in the cosine half space. More...

virtual void	print (std::ostream &Os, bool Short_form=false) const
	Print to a stream. More...

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

virtual Spectrum	reflectance (const SpectralDomain &Spec_domain, int Spec_index, bool Skip_jacobian=false) const
	Calculate reflectance for the given set of wavenumbers/wavelengths. More...

virtual void	remove_observer (Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > &Obs)
	Remove an observer. More...

virtual blitz::Array< double, 2 >	stokes (const SpectralDomain &Spec_domain, int Spec_index) const
	Calculate stokes vector for the given set of wavenumbers/wavelengths. More...

virtual ArrayAd< double, 2 >	stokes_and_jacobian (const SpectralDomain &Spec_domain, int Spec_index) const
	Calculate stokes vector for the given set of wavenumbers/wavelengths. More...

virtual ArrayAd< double, 1 >	stokes_and_jacobian_single_wn (double Wn, int Spec_index, const ArrayAd< double, 2 > &Iv) const
	Calculate stokes vector and Jacobian for the given wavenumber. More...

const boost::shared_ptr< StokesCoefficient > &	stokes_coefficient () const
	Stokes coefficients used to go from Stokes vector to scalar reflectance. More...

virtual blitz::Array< double, 1 >	stokes_single_wn (double Wn, int Spec_index, const ArrayAd< double, 2 > &Iv) const
	Calculate stokes vector for the given wavenumber. More...

virtual int	surface_type () const
	Integer representing the surface type using the LIDORT indexing nomenclature. More...

Protected Member Functions
void	add_observer_do (Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > &Obs, std::vector< boost::shared_ptr< NamedSpectrum > > &t)
	Add an observer. More...

void	add_observer_do (Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > &Obs)

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

void	notify_update_do (const std::vector< boost::shared_ptr< NamedSpectrum > > &Self)
	Function to call to notify Observers of a state change. More...

boost::shared_ptr< boost::progress_display >	progress_display (const blitz::Array< double, 1 > &wn) const
	Helper routine, creates a progress meter. More...

void	remove_observer_do (Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > &Obs, std::vector< boost::shared_ptr< NamedSpectrum > > &t)
	Remove an observer. More...

void	remove_observer_do (Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > &Obs)

virtual void	setup_thermal_inputs (double wn, int spec_index) const

virtual void	update_altitude (int spec_index) const
	Update the altitude information. More...

virtual void	update_geometry (int spec_index) const
	Update the geometry if necessary, only needs to change when spectrometer index changes. More...

Protected Attributes
int	alt_spec_index_cache

boost::shared_ptr< RtAtmosphere >	atm

blitz::Array< double, 1 >	azm

bool	do_solar_sources

bool	do_thermal_emission

int	geo_spec_index_cache

std::list< boost::weak_ptr< Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > > >	olist

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

boost::shared_ptr< SpurrRtDriver >	rt_driver_

boost::shared_ptr< StokesCoefficient >	stokes_coef
	Object to go from stokes vector to reflectance. More...

int	surface_type_int

blitz::Array< double, 1 >	sza

blitz::Array< double, 1 >	zen

Static Protected Attributes
static AccumulatedTimer	timer

Detailed Description

Abstract Interface for Rt classes based on Spurr driver implementations.

Definition at line 16 of file spurr_rt.h.

Constructor & Destructor Documentation

◆ SpurrRt()

SpurrRt::SpurrRt	(	const boost::shared_ptr< RtAtmosphere > &	Atm,
		const boost::shared_ptr< StokesCoefficient > &	Stokes_coef,
		const blitz::Array< double, 1 > &	Sza,
		const blitz::Array< double, 1 > &	Zen,
		const blitz::Array< double, 1 > &	Azm,
		bool	do_solar = `true`,
		bool	do_thermal = `false`
	)

Constructor.

Parameters

Atm	The atmpsphere to use
Stokes_coef	The Stokes coefficients.
Sza	Solar zenith angle. This is in degrees, and should be in the range 0 to 90, and have size number_spectrometer()
Zen	Zenith angle (degrees), in range 0 to 90, and have size number_spectrometer()
Azm	Azimuth angle (degrees), in range 0 to 360, and have size number_spectrometer()

Definition at line 32 of file spurr_rt.cc.

Member Function Documentation

◆ add_observer()

virtual void FullPhysics::RadiativeTransferFixedStokesCoefficient::add_observer ( Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > & Obs )

inlinevirtualinherited

Required observable functions.

Implements FullPhysics::Observable< std::vector< boost::shared_ptr< NamedSpectrum > > >.

Definition at line 42 of file radiative_transfer_fixed_stokes_coefficient.h.

◆ add_observer_and_keep_reference()

void FullPhysics::Observable< std::vector< boost::shared_ptr< NamedSpectrum > > >::add_observer_and_keep_reference ( boost::shared_ptr< Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > > & 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< std::vector< boost::shared_ptr< NamedSpectrum > > >::add_observer_do	(	Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > &	Obs,
		std::vector< boost::shared_ptr< NamedSpectrum > > &	t
	)

inlineprotectedinherited

Add an observer.

Definition at line 148 of file observer.h.

◆ add_observer_do() [2/2]

void FullPhysics::Observable< std::vector< boost::shared_ptr< NamedSpectrum > > >::add_observer_do ( Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > & Obs )

inlineprotectedinherited

Definition at line 159 of file observer.h.

◆ atmosphere()

const boost::shared_ptr<RtAtmosphere>& FullPhysics::RadiativeTransferSingleWn::atmosphere ( ) const

inlineinherited

Definition at line 77 of file radiative_transfer_single_wn.h.

◆ atmosphere_ptr()

boost::shared_ptr<RtAtmosphere> FullPhysics::RadiativeTransferSingleWn::atmosphere_ptr ( ) const

inlineinherited

Definition at line 26 of file radiative_transfer_single_wn.h.

◆ clean_dead_ptr()

void FullPhysics::Observable< std::vector< boost::shared_ptr< NamedSpectrum > > >::clean_dead_ptr ( )

inlineprotectedinherited

Remove any dead pointers.

Definition at line 196 of file observer.h.

◆ notify_add() [1/2]

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

inlinevirtualinherited

Called when an object is added to an Observable.

Default is to do nothing.

Definition at line 47 of file observer.h.

◆ notify_add() [2/2]

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

inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_remove() [1/2]

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

inlinevirtualinherited

Called when an object is removed from an Observable.

Default is to do nothing.

Definition at line 55 of file observer.h.

◆ notify_remove() [2/2]

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

inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_update()

void FullPhysics::SpurrRt::notify_update ( const RtAtmosphere & atm )

inlinevirtual

For performance, we cache some data as we calculate it.

This becomes stale when the Atmosphere is changed, so we observe atm and mark the cache when it changes.

Reimplemented from FullPhysics::Observer< RtAtmosphere >.

Definition at line 34 of file spurr_rt.h.

◆ notify_update_do()

void FullPhysics::Observable< std::vector< boost::shared_ptr< NamedSpectrum > > >::notify_update_do ( const std::vector< boost::shared_ptr< NamedSpectrum > > & 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.

◆ number_moment()

virtual int FullPhysics::SpurrRt::number_moment ( ) const

pure virtual

Number of moments for scattering matrix.

Implemented in FullPhysics::LidortRt, and FullPhysics::TwostreamRt.

◆ number_spectrometer()

virtual int FullPhysics::RadiativeTransferFixedStokesCoefficient::number_spectrometer ( ) const

inlinevirtualinherited

Number of spectrometer we have.

Implements FullPhysics::RadiativeTransfer.

Definition at line 31 of file radiative_transfer_fixed_stokes_coefficient.h.

◆ number_stokes()

virtual int FullPhysics::SpurrRt::number_stokes ( ) const

inlinevirtual

Number of stokes in returned stokes values Note that LIDORT will only ever calculate the first stoke index for I,.

Implements FullPhysics::RadiativeTransfer.

Definition at line 38 of file spurr_rt.h.

◆ number_stream()

virtual int FullPhysics::SpurrRt::number_stream ( ) const

pure virtual

Number of quadtature streams in the cosine half space.

Implements FullPhysics::RadiativeTransferSingleWn.

Implemented in FullPhysics::LidortRt, and FullPhysics::TwostreamRt.

◆ print()

void SpurrRt::print	(	std::ostream &	Os,
		bool	Short_form = `false`
	)		const

virtual

Print to a stream.

Reimplemented from FullPhysics::RadiativeTransferSingleWn.

Reimplemented in FullPhysics::LidortRt, and FullPhysics::TwostreamRt.

Definition at line 282 of file spurr_rt.cc.

◆ print_to_string()

std::string FullPhysics::Printable< RadiativeTransfer >::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.

◆ progress_display()

boost::shared_ptr< boost::progress_display > RadiativeTransfer::progress_display ( const blitz::Array< double, 1 > & wn ) const

protectedinherited

Helper routine, creates a progress meter.

This will return 0 if we aren't logging, or if we don't have enough points to bother with.

Definition at line 19 of file radiative_transfer.cc.

◆ reflectance()

Spectrum RadiativeTransferFixedStokesCoefficient::reflectance	(	const SpectralDomain &	Spec_domain,
		int	Spec_index,
		bool	Skip_jacobian = `false`
	)		const

virtualinherited

Calculate reflectance for the given set of wavenumbers/wavelengths.

Parameters

Spec_domain	List of wavenumber/wavelength to calculate for.
Spec_index	The Spectral index
Skip_jacobian	If true, don't do the Jacobian calculation. Often this is significantly faster to calculate.

Returns: The set of reflectance values.

Implements FullPhysics::RadiativeTransfer.

Definition at line 12 of file radiative_transfer_fixed_stokes_coefficient.cc.

◆ remove_observer()

virtual void FullPhysics::RadiativeTransferFixedStokesCoefficient::remove_observer ( Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > & Obs )

inlinevirtualinherited

Remove an observer.

Implements FullPhysics::Observable< std::vector< boost::shared_ptr< NamedSpectrum > > >.

Definition at line 44 of file radiative_transfer_fixed_stokes_coefficient.h.

◆ remove_observer_do() [1/2]

void FullPhysics::Observable< std::vector< boost::shared_ptr< NamedSpectrum > > >::remove_observer_do	(	Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > &	Obs,
		std::vector< boost::shared_ptr< NamedSpectrum > > &	t
	)

inlineprotectedinherited

Remove an observer.

Definition at line 173 of file observer.h.

◆ remove_observer_do() [2/2]

void FullPhysics::Observable< std::vector< boost::shared_ptr< NamedSpectrum > > >::remove_observer_do ( Observer< std::vector< boost::shared_ptr< NamedSpectrum > > > & Obs )

inlineprotectedinherited

Definition at line 181 of file observer.h.

◆ setup_thermal_inputs()

void SpurrRt::setup_thermal_inputs	(	double	wn,
		int	spec_index
	)		const

protectedvirtual

Definition at line 116 of file spurr_rt.cc.

◆ stokes()

Array< double, 2 > RadiativeTransferSingleWn::stokes	(	const SpectralDomain &	Spec_domain,
		int	Spec_index
	)		const

virtualinherited

Calculate stokes vector for the given set of wavenumbers/wavelengths.

Parameters

Spec_domain	List of wavenumber/wavelength to calculate for.
Spec_index	The Spectral index

Returns: The set of stokes coefficients. This is Spec_domain.data().rows() x number_stokes() in size.

Implements FullPhysics::RadiativeTransfer.

Definition at line 7 of file radiative_transfer_single_wn.cc.

◆ stokes_and_jacobian()

ArrayAd< double, 2 > RadiativeTransferSingleWn::stokes_and_jacobian	(	const SpectralDomain &	Spec_domain,
		int	Spec_index
	)		const

virtualinherited

Calculate stokes vector for the given set of wavenumbers/wavelengths.

This also calculates the Jacobian of the stokes with respect to the state vector elements.

Parameters

Spec_domain	List of wavenumber/wavelength to calculate for.
Spec_index	The Spectral index

Returns: The set of stokes coefficients, along with derivatives with respect to the state vector elements. This is Spec_domain.data().rows() x number_stokes() in size.

Implements FullPhysics::RadiativeTransfer.

Definition at line 22 of file radiative_transfer_single_wn.cc.

◆ stokes_and_jacobian_single_wn()

ArrayAd< double, 1 > SpurrRt::stokes_and_jacobian_single_wn	(	double	Wn,
		int	Spec_index,
		const ArrayAd< double, 2 > &	Iv
	)		const

virtual

Calculate stokes vector and Jacobian for the given wavenumber.

You can optionally supply a set of intermediate atmosphere variables (e.g., taug, taur, taua_i) to use instead of with atmosphere_ptr() to calculate this.

Parameters

Wn	Wavenumber to calculate for. This should be in cm^-1
Spec_index	The Spectral index
Iv	Optional intermediate variables to use, rather than calculating.

Returns: The set of stokes coefficients. This is number_stokes() in size.

To speed up the calculation, the Atmosphere Jacobian was calculated relative to the RtAtmosphere "intermediate variables". The Surface Jacobian was calculated relative to the surface parameters. For both of these, calculate these relative to the state vector variables. Then sum the Atmosphere Jacobian over the layers and add in the surface Jacobian to give us the total Jacobian to the reflectance with respect to the state vector.

Implements FullPhysics::RadiativeTransferSingleWn.

Definition at line 174 of file spurr_rt.cc.

◆ stokes_coefficient()

const boost::shared_ptr<StokesCoefficient>& FullPhysics::RadiativeTransferFixedStokesCoefficient::stokes_coefficient ( ) const

inlineinherited

Stokes coefficients used to go from Stokes vector to scalar reflectance.

Definition at line 24 of file radiative_transfer_fixed_stokes_coefficient.h.

◆ stokes_single_wn()

Array< double, 1 > SpurrRt::stokes_single_wn	(	double	Wn,
		int	Spec_index,
		const ArrayAd< double, 2 > &	Iv
	)		const

virtual

Calculate stokes vector for the given wavenumber.

You can optionally supply a set of intermediate atmosphere variables (e.g., taug, taur, taua_i) to use instead of with atmosphere_ptr() to calculate this.

Parameters

Wn	Wavenumber to calculate for. This should be in cm^-1
Spec_index	The Spectral index
Iv	Optional intermediate variables to use, rather than calculating.

Returns: The set of stokes coefficients. This is number_stokes() in size.

Implements FullPhysics::RadiativeTransferSingleWn.

Definition at line 125 of file spurr_rt.cc.

◆ surface_type()

virtual int FullPhysics::SpurrRt::surface_type ( ) const

inlinevirtual

Integer representing the surface type using the LIDORT indexing nomenclature.

Definition at line 47 of file spurr_rt.h.

◆ update_altitude()

void SpurrRt::update_altitude ( int spec_index ) const

protectedvirtual

Update the altitude information.

This can change the number of layers if desired.

Definition at line 83 of file spurr_rt.cc.

◆ update_geometry()

void SpurrRt::update_geometry ( int spec_index ) const

protectedvirtual

Update the geometry if necessary, only needs to change when spectrometer index changes.

Definition at line 102 of file spurr_rt.cc.

Member Data Documentation

◆ alt_spec_index_cache

int FullPhysics::SpurrRt::alt_spec_index_cache

mutableprotected

Definition at line 64 of file spurr_rt.h.

◆ atm

boost::shared_ptr<RtAtmosphere> FullPhysics::RadiativeTransferSingleWn::atm

protectedinherited

Definition at line 98 of file radiative_transfer_single_wn.h.

◆ azm

blitz::Array<double, 1> FullPhysics::SpurrRt::azm

protected

Definition at line 59 of file spurr_rt.h.

◆ do_solar_sources

bool FullPhysics::SpurrRt::do_solar_sources

protected

Definition at line 57 of file spurr_rt.h.

◆ do_thermal_emission

bool FullPhysics::SpurrRt::do_thermal_emission

protected

Definition at line 57 of file spurr_rt.h.

◆ geo_spec_index_cache

int FullPhysics::SpurrRt::geo_spec_index_cache

mutableprotected

Definition at line 64 of file spurr_rt.h.

◆ olist

std::list<boost::weak_ptr<Observer<std::vector< boost::shared_ptr< NamedSpectrum > > > > > FullPhysics::Observable< std::vector< boost::shared_ptr< NamedSpectrum > > >::olist

protectedinherited

Definition at line 200 of file observer.h.

◆ ref_list

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

protectedinherited

Definition at line 201 of file observer.h.

◆ rt_driver_

boost::shared_ptr<SpurrRtDriver> FullPhysics::SpurrRt::rt_driver_

protected

Definition at line 61 of file spurr_rt.h.

◆ stokes_coef

boost::shared_ptr<StokesCoefficient> FullPhysics::RadiativeTransferFixedStokesCoefficient::stokes_coef

protectedinherited

Object to go from stokes vector to reflectance.

Definition at line 65 of file radiative_transfer_fixed_stokes_coefficient.h.

◆ surface_type_int

int FullPhysics::SpurrRt::surface_type_int

protected

Definition at line 56 of file spurr_rt.h.

◆ sza

blitz::Array<double, 1> FullPhysics::SpurrRt::sza

protected

Definition at line 59 of file spurr_rt.h.

◆ timer

AccumulatedTimer RadiativeTransfer::timer

staticprotectedinherited

Definition at line 92 of file radiative_transfer.h.

◆ zen

blitz::Array<double, 1> FullPhysics::SpurrRt::zen

protected

Definition at line 59 of file spurr_rt.h.

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

Interface/spurr_rt.h
Interface/spurr_rt.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SpurrRt()

Member Function Documentation

◆ add_observer()

◆ add_observer_and_keep_reference()

◆ add_observer_do() [1/2]

◆ add_observer_do() [2/2]

◆ atmosphere()

◆ atmosphere_ptr()

◆ clean_dead_ptr()

◆ notify_add() [1/2]

◆ notify_add() [2/2]

◆ notify_remove() [1/2]

◆ notify_remove() [2/2]

◆ notify_update()

◆ notify_update_do()

◆ number_moment()

◆ number_spectrometer()

◆ number_stokes()

◆ number_stream()

◆ print()

◆ print_to_string()

◆ progress_display()

◆ reflectance()

◆ remove_observer()

◆ remove_observer_do() [1/2]

◆ remove_observer_do() [2/2]

◆ setup_thermal_inputs()

◆ stokes()

◆ stokes_and_jacobian()

◆ stokes_and_jacobian_single_wn()

◆ stokes_coefficient()

◆ stokes_single_wn()

◆ surface_type()

◆ update_altitude()

◆ update_geometry()

Member Data Documentation

◆ alt_spec_index_cache

◆ atm

◆ azm

◆ do_solar_sources

◆ do_thermal_emission

◆ geo_spec_index_cache

◆ olist

◆ ref_list

◆ rt_driver_

◆ stokes_coef

◆ surface_type_int

◆ sza

◆ timer

◆ zen