This class drives the LRAD code, which gives a polarization correction to scalar intensity and jacobians. More...

#include <l_rad_rt.h>

Inheritance diagram for FullPhysics::LRadRt:

Collaboration diagram for FullPhysics::LRadRt:

Public Types
enum	BrdfType { LAMBERTIAN = 1, COXMUNK = 2, BPDFVEGN = 3, BPDFSOIL = 4 }

Public Member Functions
	LRadRt (const boost::shared_ptr< RadiativeTransferSingleWn > &Rt, const SpectralBound &Spec_bound, const blitz::Array< double, 1 > &Sza, const blitz::Array< double, 1 > &Zen, const blitz::Array< double, 1 > &Azm, bool Pure_nadir, bool Use_first_order_scatt_calc=true, bool Do_second_order=false, double Spectrum_spacing=0.01, const LRadDriver::PsMode ps_mode=LRadDriver::DETECT)
	Constructor. More...

	LRadRt (const boost::shared_ptr< StokesCoefficient > &Stokes_coef, const boost::shared_ptr< RtAtmosphere > &Atm, const SpectralBound &Spec_bound, const blitz::Array< double, 1 > &Sza, const blitz::Array< double, 1 > &Zen, const blitz::Array< double, 1 > &Azm, bool Pure_nadir, int Number_stokes, bool Do_second_order=false, int Number_stream=4, double Spectrum_spacing=0.01, const LRadDriver::PsMode ps_mode=LRadDriver::DETECT)
	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

ArrayAd< double, 2 >	interp_z_matrix (double Wn)
	Return an interpolated z_matrix value for use in offline testing. More...

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

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

virtual int	number_stream () const
	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...

const boost::shared_ptr< RadiativeTransferSingleWn > &	radiative_transfer () const

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
	Returns an integer with l_rad's representation of surface type. 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)

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 class drives the LRAD code, which gives a polarization correction to scalar intensity and jacobians.

This can also be used on its own to provide a single scatter approximation to the RadiativeTransfer (i.e., without also running LIDORT).

Definition at line 19 of file l_rad_rt.h.

Member Enumeration Documentation

◆ BrdfType

enum FullPhysics::LRadRt::BrdfType

Enumerator
LAMBERTIAN
COXMUNK
BPDFVEGN
BPDFSOIL

Definition at line 24 of file l_rad_rt.h.

Constructor & Destructor Documentation

◆ LRadRt() [1/2]

LRadRt::LRadRt	(	const boost::shared_ptr< RadiativeTransferSingleWn > &	Rt,
		const SpectralBound &	Spec_bound,
		const blitz::Array< double, 1 > &	Sza,
		const blitz::Array< double, 1 > &	Zen,
		const blitz::Array< double, 1 > &	Azm,
		bool	Pure_nadir,
		bool	Use_first_order_scatt_calc = `true`,
		bool	Do_second_order = `false`,
		double	Spectrum_spacing = `0.01`,
		const LRadDriver::PsMode	ps_mode = `LRadDriver::DETECT`
	)

Constructor.

Note that we can run in two modes, either we are doing a polarization correction to an underlying multi-scatter RT code, or we are just doing a single-scatter calculation in the LRad alone. This constructor sets up for the mult-scatter correction.

Parameters

Rt	RT to apply polarization correction to.
Spec_bound	Spectral window bounds for each spectrometer.
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()
Pure_nadir	If true then scene is purely nadir
Use_first_order_scatt_calc	Use the first order of scattering calculation from LRad since it is a faster calculation than by most other radiative transfers. If using two RTs together the other RT must only calculate the multiple scattering component of the stokes vector.
Do_second_order	If true, we do second order corrections
Spectrum_spacing	The spectrum spacing
ps_mode	Which pseudo spherical mode to use: REGULAR, ENHANCED, PLANE_PARALLEL, DETECT

Definition at line 67 of file l_rad_rt.cc.

◆ LRadRt() [2/2]

LRadRt::LRadRt	(	const boost::shared_ptr< StokesCoefficient > &	Stokes_coef,
		const boost::shared_ptr< RtAtmosphere > &	Atm,
		const SpectralBound &	Spec_bound,
		const blitz::Array< double, 1 > &	Sza,
		const blitz::Array< double, 1 > &	Zen,
		const blitz::Array< double, 1 > &	Azm,
		bool	Pure_nadir,
		int	Number_stokes,
		bool	Do_second_order = `false`,
		int	Number_stream = `4`,
		double	Spectrum_spacing = `0.01`,
		const LRadDriver::PsMode	ps_mode = `LRadDriver::DETECT`
	)

Constructor.

Note that we can run in two modes, either we are doing a polarization correction to an underlying multi-scatter RT code, or we are just doing a single-scatter calculation in the LRad alone. This constructor sets up for the single-scatter calculation only, without a multi-scatter RT.

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.
Number_stream	The number of streams to calculate with. Note that this is the "half streams" more commonly used rather than the "full streams" used in LIDORT 3.0.
Spec_bound	Spectral window bounds for each spectrometer.
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()
Pure_nadir	If true then scene is purely nadir
Number_stokes	Number of stokes coefficients to use.
Do_second_order	If true, we do second order corrections
Spectrum_spacing	The spectrum spacing
ps_mode	Which pseudo spherical mode to use: REGULAR, ENHANCED, PLANE_PARALLEL, DETECT

Definition at line 128 of file l_rad_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.

◆ interp_z_matrix()

ArrayAd<double, 2> FullPhysics::LRadRt::interp_z_matrix ( double Wn )

inline

Return an interpolated z_matrix value for use in offline testing.

Definition at line 62 of file l_rad_rt.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::LRadRt::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 71 of file l_rad_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_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::LRadRt::number_stokes ( ) const

inlinevirtual

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

Implements FullPhysics::RadiativeTransfer.

Definition at line 55 of file l_rad_rt.h.

◆ number_stream()

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

inlinevirtual

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.

Implements FullPhysics::RadiativeTransferSingleWn.

Definition at line 56 of file l_rad_rt.h.

◆ print()

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

virtual

Print to stream.

Reimplemented from FullPhysics::RadiativeTransferSingleWn.

Definition at line 493 of file l_rad_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.

◆ radiative_transfer()

const boost::shared_ptr<RadiativeTransferSingleWn>& FullPhysics::LRadRt::radiative_transfer ( ) const

inline

Definition at line 76 of file l_rad_rt.h.

◆ 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

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 > LRadRt::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.

Implements FullPhysics::RadiativeTransferSingleWn.

Definition at line 405 of file l_rad_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()

blitz::Array< double, 1 > LRadRt::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 330 of file l_rad_rt.cc.

◆ surface_type()

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

inlinevirtual

Returns an integer with l_rad's representation of surface type.

Definition at line 59 of file l_rad_rt.h.

Member Data Documentation

◆ atm

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

protectedinherited

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:

Implementation/l_rad_rt.h
Implementation/l_rad_rt.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ BrdfType

Constructor & Destructor Documentation

◆ LRadRt() [1/2]

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

◆ interp_z_matrix()

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

◆ number_stream()

◆ print()

◆ print_to_string()

◆ progress_display()

◆ radiative_transfer()

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

◆ surface_type()

Member Data Documentation

◆ atm

◆ olist

◆ ref_list

◆ stokes_coef

◆ timer