This is a RadiativeTransfer that supplies an interface that can be called for a single wavenumber. More...

#include <radiative_transfer_single_wn.h>

Inheritance diagram for FullPhysics::RadiativeTransferSingleWn:

Collaboration diagram for FullPhysics::RadiativeTransferSingleWn:

Public Member Functions
virtual	~RadiativeTransferSingleWn ()

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 int	number_spectrometer () const
	Number of spectrometer we have. More...

virtual int	number_stokes () const =0
	Number of stokes parameters we will return in stokes and stokes_and_jacobian. More...

virtual int	number_stream () const =0
	Number of streams to use in processing. More...

virtual void	print (std::ostream &Os, bool Short_form=false) const
	Print to 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=ArrayAd< double, 2 >()) const =0
	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=ArrayAd< double, 2 >()) const =0
	Calculate stokes vector for the given wavenumber. More...

Protected Member Functions
	RadiativeTransferSingleWn (const boost::shared_ptr< StokesCoefficient > &Stokes_coef, const boost::shared_ptr< RtAtmosphere > &Atm)
	Constructor. More...

	RadiativeTransferSingleWn ()
	Default constructor. Derived classes should fill in atm and stokes_coef. More...

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)

Protected Attributes
boost::shared_ptr< RtAtmosphere >	atm

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< StokesCoefficient >	stokes_coef
	Object to go from stokes vector to reflectance. More...

Static Protected Attributes
static AccumulatedTimer	timer

Detailed Description

This is a RadiativeTransfer that supplies an interface that can be called for a single wavenumber.

This class mixes in some of the common functionality needed by LRadRt and LidortDriver. We may want to pull some of this out into separate classes. But right now we only have a few examples of a RadiativeTransfer and it isn't at all clear what a useful hierarchy would be. Rather than try to predict what we might need in the future, we really just have two categories: "The LSI" and "LRad and LIDORT". This class is really the later, and I guess we could have called it StuffThatIsInCommonWithLRadAndLidort.

Definition at line 21 of file radiative_transfer_single_wn.h.

Constructor & Destructor Documentation

◆ ~RadiativeTransferSingleWn()

virtual FullPhysics::RadiativeTransferSingleWn::~RadiativeTransferSingleWn ( )

inlinevirtual

Definition at line 25 of file radiative_transfer_single_wn.h.

◆ RadiativeTransferSingleWn() [1/2]

FullPhysics::RadiativeTransferSingleWn::RadiativeTransferSingleWn	(	const boost::shared_ptr< StokesCoefficient > &	Stokes_coef,
		const boost::shared_ptr< RtAtmosphere > &	Atm
	)

inlineprotected

Constructor.

Parameters

Stokes_coef	The stokes coefficients to go from vector stokes parameters to reflectance. This should be number_spectrometer() x 4.
Atm	The RtAtmosphere to use.

Definition at line 88 of file radiative_transfer_single_wn.h.

◆ RadiativeTransferSingleWn() [2/2]

FullPhysics::RadiativeTransferSingleWn::RadiativeTransferSingleWn ( )

inlineprotected

Default constructor. Derived classes should fill in atm and stokes_coef.

Definition at line 96 of file radiative_transfer_single_wn.h.

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

inline

Definition at line 77 of file radiative_transfer_single_wn.h.

◆ atmosphere_ptr()

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

inline

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_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_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::RadiativeTransfer::number_stokes ( ) const

pure virtualinherited

Number of stokes parameters we will return in stokes and stokes_and_jacobian.

Implemented in FullPhysics::LRadRt, FullPhysics::SpurrRt, FullPhysics::ChapmanBoaRT, FullPhysics::LsiRt, and FullPhysics::HresWrapper.

◆ number_stream()

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

pure virtual

Number of streams to use in processing.

Note that Lidort 3.0 used a less common "full streams" that was twice the more commonly used "half streams". This function returns the later. This is the same as what is used in Lidort 3.5 and LRad. The "full streams" used in Lidort 3.0 would be twice this.

Implemented in FullPhysics::LRadRt, FullPhysics::SpurrRt, FullPhysics::RadiantDriver, FullPhysics::LidortRt, FullPhysics::HresWrapper, and FullPhysics::TwostreamRt.

◆ print()

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

virtual

Print to stream.

Reimplemented from FullPhysics::RadiativeTransferFixedStokesCoefficient.

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

Definition at line 41 of file radiative_transfer_single_wn.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.

◆ stokes()

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

virtual

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

virtual

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()

virtual ArrayAd<double, 1> FullPhysics::RadiativeTransferSingleWn::stokes_and_jacobian_single_wn	(	double	Wn,
		int	Spec_index,
		const ArrayAd< double, 2 > &	Iv = `ArrayAd< double, 2 >()`
	)		const

pure 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.

Implemented in FullPhysics::LRadRt, FullPhysics::SpurrRt, FullPhysics::RadiantDriver, and FullPhysics::HresWrapper.

◆ 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()

virtual blitz::Array<double, 1> FullPhysics::RadiativeTransferSingleWn::stokes_single_wn	(	double	Wn,
		int	Spec_index,
		const ArrayAd< double, 2 > &	Iv = `ArrayAd< double, 2 >()`
	)		const

pure 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.

Implemented in FullPhysics::LRadRt, FullPhysics::SpurrRt, FullPhysics::RadiantDriver, and FullPhysics::HresWrapper.

Member Data Documentation

◆ atm

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

protected

Definition at line 98 of file radiative_transfer_single_wn.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.

◆ 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.

◆ timer

AccumulatedTimer RadiativeTransfer::timer

staticprotectedinherited

Definition at line 92 of file radiative_transfer.h.

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

Interface/radiative_transfer_single_wn.h
Interface/radiative_transfer_single_wn.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~RadiativeTransferSingleWn()

◆ RadiativeTransferSingleWn() [1/2]

◆ RadiativeTransferSingleWn() [2/2]

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_update_do()

◆ 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]

◆ stokes()

◆ stokes_and_jacobian()

◆ stokes_and_jacobian_single_wn()

◆ stokes_coefficient()

◆ stokes_single_wn()

Member Data Documentation

◆ atm

◆ olist

◆ ref_list

◆ stokes_coef

◆ timer