ReFRACtor
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FullPhysics::Ils Class Referenceabstract

This class models an Instrument Line Shape (ILS). More...

#include <ils.h>

+ Inheritance diagram for FullPhysics::Ils:
+ Collaboration diagram for FullPhysics::Ils:

Public Member Functions

virtual ~Ils ()
 
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 =0
 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 =0
 Apply the ILS. More...
 
virtual std::string band_name () const =0
 Descriptive name of the band. More...
 
virtual boost::shared_ptr< Ils > clone () const =0
 Clone an Ils object. 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...
 
virtual DoubleWithUnit ils_half_width () const =0
 This is the half width of the ILS. More...
 
virtual void ils_half_width (const DoubleWithUnit &half_width)=0
 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 ()
 
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 SpectralDomain pixel_grid () const =0
 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 class models an Instrument Line Shape (ILS).

We convolve with high resolution data to produce a model of what we expect to observe in the Level 1b data.

Definition at line 13 of file ils.h.

Constructor & Destructor Documentation

◆ ~Ils()

virtual FullPhysics::Ils::~Ils ( )
inlinevirtual

Definition at line 16 of file ils.h.

Member Function Documentation

◆ add_observer()

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

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]

virtual blitz::Array<double, 1> FullPhysics::Ils::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
pure virtual

Apply the ILS.

This version does not calculate a Jacobian.

Parameters
High_resolution_wave_numberThe 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_radianceThe high resolution radiance data. This is in w/m^2 / sr / cm^-1
Pixel_listList 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.

Implemented in FullPhysics::IlsConvolution.

◆ apply_ils() [2/2]

virtual ArrayAd<double, 1> FullPhysics::Ils::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
pure 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_numberThe 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_radianceThe high resolution radiance data and jacobian . This is in w/m^2 / sr / cm^-1
Pixel_listList 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.

Implemented in FullPhysics::IlsConvolution.

◆ band_name()

virtual std::string FullPhysics::Ils::band_name ( ) const
pure virtual

Descriptive name of the band.

Implemented in FullPhysics::IlsConvolution.

◆ clean_dead_ptr()

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

Remove any dead pointers.

Definition at line 196 of file observer.h.

◆ clone()

virtual boost::shared_ptr<Ils> FullPhysics::Ils::clone ( ) const
pure 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.

Implemented in FullPhysics::IlsConvolution.

◆ hdf_band_name()

virtual std::string FullPhysics::Ils::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 in FullPhysics::IlsConvolution.

Definition at line 91 of file ils.h.

◆ ils_half_width() [1/2]

virtual DoubleWithUnit FullPhysics::Ils::ils_half_width ( ) const
pure virtual

This is the half width of the ILS.

Implemented in FullPhysics::IlsConvolution.

◆ ils_half_width() [2/2]

virtual void FullPhysics::Ils::ils_half_width ( const DoubleWithUnit &  half_width)
pure virtual

Set the half width of the ILS.

Implemented in FullPhysics::IlsConvolution.

◆ 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< 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::Ils::pixel_grid ( ) const
pure virtual

This is the pixel grid for each pixel.

Implemented in FullPhysics::IlsConvolution.

◆ print()

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

Reimplemented in FullPhysics::AtmosphereOco, FullPhysics::EmpiricalOrthogonalFunction, FullPhysics::AbsorberAbsco, FullPhysics::SolarAbsorptionAndContinuum, FullPhysics::PressureFixedLevel, FullPhysics::Instrument, FullPhysics::DispersionPolynomial, FullPhysics::GroundBrdf, FullPhysics::AerosolOptical, FullPhysics::SubStateVectorObserver, FullPhysics::RadianceScaling, FullPhysics::IlsInstrument, FullPhysics::AerosolPropertyRhHdf, FullPhysics::IlsConvolution, FullPhysics::RadianceScalingSvFit, FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolPropertyImpBase, FullPhysics::AerosolExtinctionLog, FullPhysics::PressureSigma, FullPhysics::RadianceScalingLinearFit, FullPhysics::AerosolExtinctionLinear, FullPhysics::AerosolExtinctionImpBase, FullPhysics::PressureImpBase, FullPhysics::StokesCoefficientImpBase, FullPhysics::GroundLambertian, FullPhysics::TemperatureImpBase, FullPhysics::AerosolPropertyHdf, FullPhysics::FluorescenceEffect, FullPhysics::AbsorberVmrImpBase, FullPhysics::SolarModel, FullPhysics::InstrumentDoppler, FullPhysics::GroundCoxmunk, FullPhysics::ApplyInstrumentUnits, FullPhysics::GroundCoxmunkPlusLambertian, FullPhysics::AbsorberVmrFixedLevel, FullPhysics::AbsorberVmrFixedLevelScaled, FullPhysics::AbsorberVmrMet, FullPhysics::SubStateVectorProxy, FullPhysics::AbsorberVmrLevel, FullPhysics::AbsorberVmrLevelScaled, FullPhysics::TemperatureFixedLevel, FullPhysics::AbsorberVmrScaled, FullPhysics::StokesCoefficientFraction, FullPhysics::TemperatureMet, FullPhysics::TemperatureLevelOffset, FullPhysics::TemperatureOffset, and FullPhysics::StokesCoefficientConstant.

Definition at line 37 of file state_vector_observer.h.

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

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 file:
Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:12