This is a instrument that uses a Ils object for each spectrometer to model the instrument. More...

#include <ils_instrument.h>

Inheritance diagram for FullPhysics::IlsInstrument:

Collaboration diagram for FullPhysics::IlsInstrument:

Public Member Functions
	IlsInstrument (const std::vector< boost::shared_ptr< Ils > > &Ils_list, const std::vector< std::vector< boost::shared_ptr< InstrumentCorrection > > > &Instrument_correction=std::vector< std::vector< boost::shared_ptr< InstrumentCorrection > > >())
	Constructor. More...

virtual	~IlsInstrument ()

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

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

virtual Spectrum	apply_instrument_model (const Spectrum &High_resolution_spectrum, const std::vector< int > &Pixel_list, int Spec_index) const
	Apply the instrument model to both the radiance and derivatives. More...

virtual std::string	band_name (int Spec_index) const
	Band name for given Spec_index. More...

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

virtual std::string	hdf_band_name (int Spec_index) 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< Ils >	ils (int Spec_index) const
	Underlying Ils. More...

virtual DoubleWithUnit	ils_half_width (int Spec_index) const
	This is the half width of the ILS in wavenumber. More...

virtual void	ils_half_width (int Spec_index, DoubleWithUnit &half_width)

const std::vector< boost::shared_ptr< InstrumentCorrection > > &	instrument_correction (int Spec_index) const
	Underlying InstrumentCorrection. 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 (InstrumentCorrection &Observed_object)
	Called when an object is added to an Observable. More...

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

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

virtual void	notify_add ()

virtual void	notify_add ()

virtual void	notify_add ()

virtual void	notify_remove (InstrumentCorrection &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 (Ils &Observed_object)
	Called when an object is removed from an Observable. More...

virtual void	notify_remove ()

virtual void	notify_remove ()

virtual void	notify_remove ()

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

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

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

virtual int	number_spectrometer () const
	Give number of spectrometers. More...

virtual SpectralDomain	pixel_spectral_domain (int Spec_index) const
	This is the pixel wavenumber/wavelength 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< Instrument > &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< Instrument > &Obs, Instrument &t)
	Add an observer. More...

void	add_observer_do (Observer< Instrument > &Obs)

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

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

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

void	remove_observer_do (Observer< Instrument > &Obs)

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

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

Detailed Description

This is a instrument that uses a Ils object for each spectrometer to model the instrument.

Definition at line 15 of file ils_instrument.h.

Constructor & Destructor Documentation

◆ IlsInstrument()

IlsInstrument::IlsInstrument	(	const std::vector< boost::shared_ptr< Ils > > &	Ils_list,
		const std::vector< std::vector< boost::shared_ptr< InstrumentCorrection > > > &	Instrument_correction = `std::vector<std::vector<boost::shared_ptr<InstrumentCorrection> > >()`
	)

Constructor.

Definition at line 21 of file ils_instrument.cc.

◆ ~IlsInstrument()

virtual FullPhysics::IlsInstrument::~IlsInstrument ( )

inlinevirtual

Definition at line 22 of file ils_instrument.h.

Member Function Documentation

◆ add_observer()

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

inlinevirtualinherited

Add an observer.

Implements FullPhysics::Observable< Instrument >.

Definition at line 22 of file instrument.h.

◆ add_observer_and_keep_reference()

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

inlineprotectedinherited

Add an observer.

Definition at line 148 of file observer.h.

◆ add_observer_do() [2/2]

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

inlineprotectedinherited

Definition at line 159 of file observer.h.

◆ apply_instrument_model()

Spectrum IlsInstrument::apply_instrument_model	(	const Spectrum &	High_resolution_spectrum,
		const std::vector< int > &	Pixel_list,
		int	Spec_index
	)		const

virtual

Apply the instrument model to both the radiance and derivatives.

Parameters

High_resolution_spectrum	High resolution spectrum.
Pixel_list	List of pixels to include in radiance
Spec_index	Spectral index

Returns: Spectrum with instrument model applied.

Implements FullPhysics::Instrument.

Definition at line 58 of file ils_instrument.cc.

◆ band_name()

virtual std::string FullPhysics::IlsInstrument::band_name ( int Spec_index ) const

inlinevirtual

Band name for given Spec_index.

Implements FullPhysics::Instrument.

Definition at line 33 of file ils_instrument.h.

◆ clean_dead_ptr()

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

inlineprotectedinherited

Remove any dead pointers.

Definition at line 196 of file observer.h.

◆ clone()

boost::shared_ptr< Instrument > IlsInstrument::clone ( ) const

virtual

Clone an Instrument object.

Note that the cloned version will not be attached to and StateVector or Observer<Instrument>, 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" Instrument object.

Implements FullPhysics::Instrument.

Definition at line 39 of file ils_instrument.cc.

◆ hdf_band_name()

virtual std::string FullPhysics::IlsInstrument::hdf_band_name ( int Spec_index ) 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::Instrument.

Definition at line 38 of file ils_instrument.h.

◆ ils()

boost::shared_ptr<Ils> FullPhysics::IlsInstrument::ils ( int Spec_index ) const

inline

Underlying Ils.

Definition at line 65 of file ils_instrument.h.

◆ ils_half_width() [1/2]

virtual DoubleWithUnit FullPhysics::IlsInstrument::ils_half_width ( int Spec_index ) const

inlinevirtual

This is the half width of the ILS in wavenumber.

Implements FullPhysics::Instrument.

Definition at line 44 of file ils_instrument.h.

◆ ils_half_width() [2/2]

virtual void FullPhysics::IlsInstrument::ils_half_width	(	int	Spec_index,
		DoubleWithUnit &	half_width
	)

inlinevirtual

Implements FullPhysics::Instrument.

Definition at line 49 of file ils_instrument.h.

◆ instrument_correction()

const std::vector<boost::shared_ptr<InstrumentCorrection> >& FullPhysics::IlsInstrument::instrument_correction ( int Spec_index ) const

inline

Underlying InstrumentCorrection.

Definition at line 75 of file ils_instrument.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/6]

virtual void FullPhysics::Observer< InstrumentCorrection >::notify_add ( InstrumentCorrection & 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/6]

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

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

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

inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_add() [5/6]

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

inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_add() [6/6]

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

inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_remove() [1/6]

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

virtual void FullPhysics::Observer< InstrumentCorrection >::notify_remove ( InstrumentCorrection & 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() [3/6]

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

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

inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_remove() [5/6]

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

inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_remove() [6/6]

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

inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_update() [1/3]

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

virtual void FullPhysics::IlsInstrument::notify_update ( const Ils & Observed_object )

inlinevirtual

Called when the Observed object is updated.

Reimplemented from FullPhysics::Observer< Ils >.

Definition at line 55 of file ils_instrument.h.

◆ notify_update() [3/3]

virtual void FullPhysics::IlsInstrument::notify_update ( const InstrumentCorrection & Observed_object )

inlinevirtual

Called when the Observed object is updated.

Reimplemented from FullPhysics::Observer< InstrumentCorrection >.

Definition at line 57 of file ils_instrument.h.

◆ notify_update_do()

void FullPhysics::Observable< Instrument >::notify_update_do ( const Instrument & 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::IlsInstrument::number_spectrometer ( ) const

inlinevirtual

Give number of spectrometers.

Implements FullPhysics::Instrument.

Definition at line 23 of file ils_instrument.h.

◆ pixel_spectral_domain()

virtual SpectralDomain FullPhysics::IlsInstrument::pixel_spectral_domain ( int Spec_index ) const

inlinevirtual

This is the pixel wavenumber/wavelength for each pixel.

Implements FullPhysics::Instrument.

Definition at line 28 of file ils_instrument.h.

◆ print()

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

virtual

Reimplemented from FullPhysics::Instrument.

Definition at line 99 of file ils_instrument.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::Instrument::remove_observer ( Observer< Instrument > & Obs )

inlinevirtualinherited

Remove an observer.

Implements FullPhysics::Observable< Instrument >.

Definition at line 24 of file instrument.h.

◆ remove_observer_do() [1/2]

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

inlineprotectedinherited

Remove an observer.

Definition at line 173 of file observer.h.

◆ remove_observer_do() [2/2]

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

protectedinherited

Definition at line 200 of file observer.h.

◆ ref_list

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

protectedinherited

Definition at line 201 of file observer.h.

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

Implementation/ils_instrument.h
Implementation/ils_instrument.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IlsInstrument()

◆ ~IlsInstrument()

Member Function Documentation

◆ add_observer()

◆ add_observer_and_keep_reference()

◆ add_observer_do() [1/2]

◆ add_observer_do() [2/2]

◆ apply_instrument_model()

◆ band_name()

◆ clean_dead_ptr()

◆ clone()

◆ hdf_band_name()

◆ ils()

◆ ils_half_width() [1/2]

◆ ils_half_width() [2/2]

◆ instrument_correction()

◆ mark_used()

◆ notify_add() [1/6]

◆ notify_add() [2/6]

◆ notify_add() [3/6]

◆ notify_add() [4/6]

◆ notify_add() [5/6]

◆ notify_add() [6/6]

◆ notify_remove() [1/6]

◆ notify_remove() [2/6]

◆ notify_remove() [3/6]

◆ notify_remove() [4/6]

◆ notify_remove() [5/6]

◆ notify_remove() [6/6]

◆ notify_update() [1/3]

◆ notify_update() [2/3]

◆ notify_update() [3/3]

◆ notify_update_do()

◆ number_spectrometer()

◆ pixel_spectral_domain()

◆ 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