Interface class for radiative transfer implementations that happen to have retrievable parameters. More...

#include <radiative_transfer_retrievable.h>

Inheritance diagram for FullPhysics::RadiativeTransferRetrievable:

Collaboration diagram for FullPhysics::RadiativeTransferRetrievable:

Public Member Functions
virtual	~RadiativeTransferRetrievable ()

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

void	add_observer_and_keep_reference (boost::shared_ptr< Observer< RadiativeTransferRetrievable > > &Obs)
	Add an observer and keep a reference to it. 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 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 int	number_spectrometer () const =0
	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 void	print (std::ostream &Os, bool Short_form=false) const
	Print to stream. More...

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

std::string	print_to_string () const
	Print to string. 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 =0
	Calculate reflectance for the given set of wavenumbers/wavelengths. More...

virtual void	remove_observer (Observer< RadiativeTransferRetrievable > &Obs)
	Remove an observer. 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...

virtual blitz::Array< double, 2 >	stokes (const SpectralDomain &Spec_domain, int Spec_index) const =0
	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 =0
	Calculate stokes vector for the given set of wavenumbers/wavelengths. More...

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

void	add_observer_do (Observer< RadiativeTransferRetrievable > &Obs)

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

void	notify_update_do (const RadiativeTransferRetrievable &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< RadiativeTransferRetrievable > &Obs, RadiativeTransferRetrievable &t)
	Remove an observer. More...

void	remove_observer_do (Observer< RadiativeTransferRetrievable > &Obs)

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

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

Static Protected Attributes
static AccumulatedTimer	timer

Detailed Description

Interface class for radiative transfer implementations that happen to have retrievable parameters.

Definition at line 14 of file radiative_transfer_retrievable.h.

Constructor & Destructor Documentation

◆ ~RadiativeTransferRetrievable()

virtual FullPhysics::RadiativeTransferRetrievable::~RadiativeTransferRetrievable ( )

inlinevirtual

Definition at line 18 of file radiative_transfer_retrievable.h.

Member Function Documentation

◆ add_observer()

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

inlinevirtual

Add an observer.

Implements FullPhysics::Observable< RadiativeTransferRetrievable >.

Definition at line 20 of file radiative_transfer_retrievable.h.

◆ add_observer_and_keep_reference()

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

inlineprotectedinherited

Add an observer.

Definition at line 148 of file observer.h.

◆ add_observer_do() [2/2]

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

inlineprotectedinherited

Definition at line 159 of file observer.h.

◆ clean_dead_ptr()

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

inlineprotectedinherited

Remove any dead pointers.

Definition at line 196 of file observer.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.

◆ 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< RadiativeTransferRetrievable >::notify_update_do ( const RadiativeTransferRetrievable & 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::RadiativeTransfer::number_spectrometer ( ) const

pure virtualinherited

Number of spectrometer we have.

Implemented in FullPhysics::ChapmanBoaRT, and FullPhysics::RadiativeTransferFixedStokesCoefficient.

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

◆ print() [1/2]

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

inlinevirtual

Print to stream.

Reimplemented from FullPhysics::RadiativeTransfer.

Reimplemented in FullPhysics::RadiativeTransferImpBase.

Definition at line 29 of file radiative_transfer_retrievable.h.

◆ print() [2/2]

virtual void FullPhysics::StateVectorObserver::print ( std::ostream & Os ) const

inlinevirtualinherited

Definition at line 37 of file state_vector_observer.h.

◆ print_to_string() [1/2]

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.

◆ print_to_string() [2/2]

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.

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

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

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

Implemented in FullPhysics::ChapmanBoaRT, FullPhysics::RadiativeTransferFixedStokesCoefficient, and FullPhysics::RadiativeTransferImpBase.

◆ remove_observer()

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

inlinevirtual

Remove an observer.

Implements FullPhysics::Observable< RadiativeTransferRetrievable >.

Definition at line 22 of file radiative_transfer_retrievable.h.

◆ remove_observer_do() [1/2]

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

inlineprotectedinherited

Remove an observer.

Definition at line 173 of file observer.h.

◆ remove_observer_do() [2/2]

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

inlineprotectedinherited

Definition at line 181 of file observer.h.

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

◆ stokes()

virtual blitz::Array<double, 2> FullPhysics::RadiativeTransfer::stokes	(	const SpectralDomain &	Spec_domain,
		int	Spec_index
	)		const

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

Implemented in FullPhysics::ChapmanBoaRT, FullPhysics::RadiativeTransferSingleWn, and FullPhysics::LsiRt.

◆ stokes_and_jacobian()

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

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

Implemented in FullPhysics::ChapmanBoaRT, FullPhysics::RadiativeTransferSingleWn, and FullPhysics::LsiRt.

Member Data Documentation

◆ olist

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

protectedinherited

Definition at line 200 of file observer.h.

◆ ref_list

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

protectedinherited

Definition at line 201 of file observer.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 file:

Interface/radiative_transfer_retrievable.h

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~RadiativeTransferRetrievable()

Member Function Documentation

◆ add_observer()

◆ add_observer_and_keep_reference()

◆ add_observer_do() [1/2]

◆ add_observer_do() [2/2]

◆ clean_dead_ptr()

◆ mark_used()

◆ notify_add() [1/2]

◆ notify_add() [2/2]

◆ notify_remove() [1/2]

◆ notify_remove() [2/2]

◆ notify_update()

◆ notify_update_do()

◆ number_spectrometer()

◆ number_stokes()

◆ print() [1/2]

◆ print() [2/2]

◆ print_to_string() [1/2]

◆ print_to_string() [2/2]

◆ progress_display()

◆ reflectance()

◆ remove_observer()

◆ remove_observer_do() [1/2]

◆ remove_observer_do() [2/2]

◆ state_vector_name()

◆ stokes()

◆ stokes_and_jacobian()

Member Data Documentation

◆ olist

◆ ref_list

◆ timer