framework/a00980_source.html

 #ifndef ILS_H
 #define ILS_H
 #include "state_vector_observer.h"
 #include "double_with_unit.h"
 #include "spectral_domain.h"

 namespace FullPhysics {
 /****************************************************************/
 class Ils : virtual public StateVectorObserver,
                     public Observable<Ils> {
 public:
   virtual ~Ils() {}

   virtual void add_observer(Observer<Ils>& Obs)
   { add_observer_do(Obs, *this);}
   virtual void remove_observer(Observer<Ils>& Obs)
   { remove_observer_do(Obs, *this);}

 //-----------------------------------------------------------------------
 //-----------------------------------------------------------------------

   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;

 //-----------------------------------------------------------------------
 //-----------------------------------------------------------------------

   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;

 //-----------------------------------------------------------------------
 //-----------------------------------------------------------------------

   virtual std::string band_name() const = 0;

 //-----------------------------------------------------------------------
 //-----------------------------------------------------------------------

   virtual boost::shared_ptr<Ils> clone() const = 0;

 //-----------------------------------------------------------------------
 //-----------------------------------------------------------------------

   virtual std::string hdf_band_name() const { return band_name();}

 //-----------------------------------------------------------------------
 //-----------------------------------------------------------------------

   virtual SpectralDomain pixel_grid() const = 0;

 //-----------------------------------------------------------------------
 //-----------------------------------------------------------------------

   virtual DoubleWithUnit ils_half_width() const = 0;

 //-----------------------------------------------------------------------
 //-----------------------------------------------------------------------

   virtual void ils_half_width(const DoubleWithUnit& half_width) = 0;

 };
 }
 #endif
FullPhysics::Ils::ils_half_width
virtual DoubleWithUnit ils_half_width() const =0
This is the half width of the ILS.

state_vector_observer.h

FullPhysics::SpectralDomain
For different instruments, it is more natural to either work with wavenumbers (e.g., GOSAT) or wavelength (e.g., OCO).
Definition: spectral_domain.h:31

FullPhysics::Ils::remove_observer
virtual void remove_observer(Observer< Ils > &Obs)
Remove an observer.
Definition: ils.h:20

boost::shared_ptr
Definition: doxygen.h:52

FullPhysics::Observable< Ils >::add_observer_do
void add_observer_do(Observer< Ils > &Obs, Ils &t)
Add an observer.
Definition: observer.h:148

FullPhysics::StateVectorObserver
This is an observer of a StateVector.
Definition: state_vector_observer.h:15

FullPhysics::Ils::hdf_band_name
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...
Definition: ils.h:91

FullPhysics::Observable< Ils >::remove_observer_do
void remove_observer_do(Observer< Ils > &Obs, Ils &t)
Remove an observer.
Definition: observer.h:173

FullPhysics::Ils::add_observer
virtual void add_observer(Observer< Ils > &Obs)
Add an observer.
Definition: ils.h:18

FullPhysics::ArrayAd< double, 1 >

FullPhysics::Observable
Mixin for a class that allows other classes to observe it state.
Definition: observer.h:12

FullPhysics::Ils::pixel_grid
virtual SpectralDomain pixel_grid() const =0
This is the pixel grid for each pixel.

FullPhysics::Ils::band_name
virtual std::string band_name() const =0
Descriptive name of the band.

FullPhysics::DoubleWithUnit
We frequently have a double with units associated with it.
Definition: double_with_unit.h:13

FullPhysics::Ils::clone
virtual boost::shared_ptr< Ils > clone() const =0
Clone an Ils object.

FullPhysics::Ils
This class models an Instrument Line Shape (ILS).
Definition: ils.h:13

FullPhysics::Ils::~Ils
virtual ~Ils()
Definition: ils.h:16

spectral_domain.h

FullPhysics
Contains classes to abstract away details in various Spurr Radiative Transfer software.
Definition: doxygen_python.h:1

double_with_unit.h

FullPhysics::Ils::apply_ils
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.

FullPhysics::Observer< Ils >