This is a ILS where we use a Dispersion object to determine the wavenumbers of each pixel, and convolve against a IlsFunction. More...

#include <ils_convolution.h>

Inheritance diagram for FullPhysics::IlsConvolution:

Collaboration diagram for FullPhysics::IlsConvolution:

Public Member Functions
	IlsConvolution (const boost::shared_ptr< Dispersion > &Disp, const boost::shared_ptr< IlsFunction > &Ils_func, const DoubleWithUnit &Ils_half_width=DoubleWithUnit(20, units::inv_cm))
	Constructor. More...

	IlsConvolution (const boost::shared_ptr< Dispersion > &Disp, const boost::shared_ptr< IlsFunction > &Ils_func, double Ils_half_width)
	Constructor. More...

virtual	~IlsConvolution ()

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

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

virtual blitz::Array< double, 1 >	apply_ils (const blitz::Array< double, 1 > &High_resolution_wave_number, const blitz::Array< double, 1 > &High_resolution_radiance, const std::vector< int > &Pixel_list) const
	Apply the ILS. More...

virtual ArrayAd< double, 1 >	apply_ils (const blitz::Array< double, 1 > &High_resolution_wave_number, const ArrayAd< double, 1 > &High_resolution_radiance, const std::vector< int > &Pixel_list) const
	Apply the ILS. More...

virtual std::string	band_name () const
	Descriptive name of the band. More...

virtual boost::shared_ptr< Ils >	clone () const
	Clone an Ils object. More...

boost::shared_ptr< Dispersion >	dispersion () const
	Underlying dispersion. More...

virtual std::string	hdf_band_name () const
	In general, the name used in HDF files for a particular band is similar but not identical to the more human readable band_name. More...

boost::shared_ptr< IlsFunction >	ils_function () const
	Underlying IlsFunction. More...

virtual DoubleWithUnit	ils_half_width () const
	This is the half width of the ILS. More...

virtual void	ils_half_width (const DoubleWithUnit &half_width)
	Set the half width of the ILS. 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 (Dispersion &Observed_object)
	Called when an object is added to an Observable. More...

virtual void	notify_add ()

virtual void	notify_add ()

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

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

virtual void	notify_remove ()

virtual void	notify_remove ()

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

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

virtual SpectralDomain	pixel_grid () const
	This is the pixel grid for each pixel. More...

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

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

virtual void	remove_observer (Observer< Ils > &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...

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

void	add_observer_do (Observer< Ils > &Obs)

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

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

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

void	remove_observer_do (Observer< Ils > &Obs)

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

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

Detailed Description

This is a ILS where we use a Dispersion object to determine the wavenumbers of each pixel, and convolve against a IlsFunction.

Definition at line 14 of file ils_convolution.h.

Constructor & Destructor Documentation

◆ IlsConvolution() [1/2]

FullPhysics::IlsConvolution::IlsConvolution	(	const boost::shared_ptr< Dispersion > &	Disp,
		const boost::shared_ptr< IlsFunction > &	Ils_func,
		const DoubleWithUnit &	Ils_half_width = `DoubleWithUnit(20, units::inv_cm)`
	)

inline

Constructor.

Definition at line 19 of file ils_convolution.h.

◆ IlsConvolution() [2/2]

FullPhysics::IlsConvolution::IlsConvolution	(	const boost::shared_ptr< Dispersion > &	Disp,
		const boost::shared_ptr< IlsFunction > &	Ils_func,
		double	Ils_half_width
	)

inline

Constructor.

Definition at line 30 of file ils_convolution.h.

◆ ~IlsConvolution()

virtual FullPhysics::IlsConvolution::~IlsConvolution ( )

inlinevirtual

Definition at line 36 of file ils_convolution.h.

Member Function Documentation

◆ add_observer()

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

inlinevirtualinherited

Add an observer.

Implements FullPhysics::Observable< Ils >.

Definition at line 18 of file ils.h.

◆ add_observer_and_keep_reference()

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

inlineprotectedinherited

Add an observer.

Definition at line 148 of file observer.h.

◆ add_observer_do() [2/2]

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

inlineprotectedinherited

Definition at line 159 of file observer.h.

◆ apply_ils() [1/2]

blitz::Array< double, 1 > IlsConvolution::apply_ils	(	const blitz::Array< double, 1 > &	High_resolution_wave_number,
		const blitz::Array< double, 1 > &	High_resolution_radiance,
		const std::vector< int > &	Pixel_list
	)		const

virtual

Apply the ILS.

This version does not calculate a Jacobian.

Parameters

High_resolution_wave_number	The wave numbers going with the high resolution radiance data. This is in cm^-1, and should be ordered from smallest to largest wavenumber.
High_resolution_radiance	The high resolution radiance data. This is in w/m^2 / sr / cm^-1
Pixel_list	List of instrument pixels to include in the results. The order of the pixels is the same order that we return our results in.

Returns: Radiance with ILS applied. This is in w/m^2 / sr / cm^-1.

Implements FullPhysics::Ils.

Definition at line 20 of file ils_convolution.cc.

◆ apply_ils() [2/2]

ArrayAd< double, 1 > IlsConvolution::apply_ils	(	const blitz::Array< double, 1 > &	High_resolution_wave_number,
		const ArrayAd< double, 1 > &	High_resolution_radiance,
		const std::vector< int > &	Pixel_list
	)		const

virtual

Apply the ILS.

This includes propagating the Jacobian from the high resolution data, and adding in any dependence of the ILS on the state vector elements (e.g., dispersion state vector elements).

Parameters

High_resolution_wave_number	The wave numbers going with the high resolution radiance data. This is in cm^-1, and should be ordered from smallest to largest wavenumber.
High_resolution_radiance	The high resolution radiance data and jacobian . This is in w/m^2 / sr / cm^-1
Pixel_list	List of instrument pixels to include in the results. The order of the pixels is the same order that we return our results in.

Returns: Radiance with ILS applied, and Jacobian This is in w/m^2 / sr / cm^-1.

Implements FullPhysics::Ils.

Definition at line 95 of file ils_convolution.cc.

◆ band_name()

virtual std::string FullPhysics::IlsConvolution::band_name ( ) const

inlinevirtual

Descriptive name of the band.

Implements FullPhysics::Ils.

Definition at line 50 of file ils_convolution.h.

◆ clean_dead_ptr()

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

inlineprotectedinherited

Remove any dead pointers.

Definition at line 196 of file observer.h.

◆ clone()

boost::shared_ptr< Ils > IlsConvolution::clone ( ) const

virtual

Clone an Ils object.

Note that the cloned version will not be attached to and StateVector or Observer<Ils>, although you can of course attach them after receiving the cloned object.

Because this isn't attached to the StateVector, one use of the clone operator is to create a "frozen" Ils object.

Implements FullPhysics::Ils.

Definition at line 159 of file ils_convolution.cc.

◆ dispersion()

boost::shared_ptr<Dispersion> FullPhysics::IlsConvolution::dispersion ( ) const

inline

Underlying dispersion.

Definition at line 69 of file ils_convolution.h.

◆ hdf_band_name()

virtual std::string FullPhysics::IlsConvolution::hdf_band_name ( ) const

inlinevirtual

In general, the name used in HDF files for a particular band is similar but not identical to the more human readable band_name.

For example, with GOSAT we use the HDF field name "weak_co2", but the band name is "WC-Band". This gives the HDF name to use.

The default implementation just returns the same string as the band name.

Reimplemented from FullPhysics::Ils.

Definition at line 51 of file ils_convolution.h.

◆ ils_function()

boost::shared_ptr<IlsFunction> FullPhysics::IlsConvolution::ils_function ( ) const

inline

Underlying IlsFunction.

Definition at line 64 of file ils_convolution.h.

◆ ils_half_width() [1/2]

virtual DoubleWithUnit FullPhysics::IlsConvolution::ils_half_width ( ) const

inlinevirtual

This is the half width of the ILS.

Implements FullPhysics::Ils.

Definition at line 55 of file ils_convolution.h.

◆ ils_half_width() [2/2]

virtual void FullPhysics::IlsConvolution::ils_half_width ( const DoubleWithUnit & half_width )

inlinevirtual

Set the half width of the ILS.

Implements FullPhysics::Ils.

Definition at line 57 of file ils_convolution.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/4]

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/4]

virtual void FullPhysics::Observer< Dispersion >::notify_add ( Dispersion & 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() [3/4]

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

inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_add() [4/4]

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

inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_remove() [1/4]

virtual void FullPhysics::Observer< Dispersion >::notify_remove ( Dispersion & 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/4]

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() [3/4]

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

inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_remove() [4/4]

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

inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_update() [1/2]

virtual void FullPhysics::IlsConvolution::notify_update ( const Dispersion & Observed_object )

inlinevirtual

Called when the Observed object is updated.

Reimplemented from FullPhysics::Observer< Dispersion >.

Definition at line 37 of file ils_convolution.h.

◆ notify_update() [2/2]

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< Ils >::notify_update_do ( const Ils & 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.

◆ pixel_grid()

virtual SpectralDomain FullPhysics::IlsConvolution::pixel_grid ( ) const

inlinevirtual

This is the pixel grid for each pixel.

Implements FullPhysics::Ils.

Definition at line 53 of file ils_convolution.h.

◆ print()

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

virtual

Reimplemented from FullPhysics::StateVectorObserver.

Definition at line 165 of file ils_convolution.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::Ils::remove_observer ( Observer< Ils > & Obs )

inlinevirtualinherited

Remove an observer.

Implements FullPhysics::Observable< Ils >.

Definition at line 20 of file ils.h.

◆ remove_observer_do() [1/2]

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

inlineprotectedinherited

Remove an observer.

Definition at line 173 of file observer.h.

◆ remove_observer_do() [2/2]

void FullPhysics::Observable< Ils >::remove_observer_do ( Observer< Ils > & 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.

Member Data Documentation

◆ olist

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

protectedinherited

Definition at line 200 of file observer.h.

◆ ref_list

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

protectedinherited

Definition at line 201 of file observer.h.

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

Implementation/ils_convolution.h
Implementation/ils_convolution.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IlsConvolution() [1/2]

◆ IlsConvolution() [2/2]

◆ ~IlsConvolution()

Member Function Documentation

◆ add_observer()

◆ add_observer_and_keep_reference()

◆ add_observer_do() [1/2]

◆ add_observer_do() [2/2]

◆ apply_ils() [1/2]

◆ apply_ils() [2/2]

◆ band_name()

◆ clean_dead_ptr()

◆ clone()

◆ dispersion()

◆ hdf_band_name()

◆ ils_function()

◆ ils_half_width() [1/2]

◆ ils_half_width() [2/2]

◆ mark_used()

◆ notify_add() [1/4]

◆ notify_add() [2/4]

◆ notify_add() [3/4]

◆ notify_add() [4/4]

◆ notify_remove() [1/4]

◆ notify_remove() [2/4]

◆ notify_remove() [3/4]

◆ notify_remove() [4/4]

◆ notify_update() [1/2]

◆ notify_update() [2/2]

◆ notify_update_do()

◆ pixel_grid()

◆ print()

◆ print_to_string()

◆ remove_observer()

◆ remove_observer_do() [1/2]

◆ remove_observer_do() [2/2]

◆ state_vector_name()

Member Data Documentation

◆ olist

◆ ref_list