ReFRACtor
FullPhysics::Dispersion Class Referenceabstract

This class calculates the wavenumber for each pixel in a single band of an Instrument. More...

#include <dispersion.h>

+ Inheritance diagram for FullPhysics::Dispersion:
+ Collaboration diagram for FullPhysics::Dispersion:

Public Member Functions

virtual ~Dispersion ()
 
virtual void add_observer (Observer< Dispersion > &Obs)
 Add an observer. More...
 
void add_observer_and_keep_reference (boost::shared_ptr< Observer< Dispersion > > &Obs)
 Add an observer and keep a reference to it. More...
 
virtual boost::shared_ptr< Dispersionclone () const =0
 Clone an Dispersion object. 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
 Returns as list of grid points for each instrument pixel, and the gradient of the points wrt the state vector. More...
 
virtual void print (std::ostream &Os) const
 
std::string print_to_string () const
 Print to string. More...
 
virtual void remove_observer (Observer< Dispersion > &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< Dispersion > &Obs, Dispersion &t)
 Add an observer. More...
 
void add_observer_do (Observer< Dispersion > &Obs)
 
void clean_dead_ptr ()
 Remove any dead pointers. More...
 
void notify_update_do (const Dispersion &Self)
 Function to call to notify Observers of a state change. More...
 
void remove_observer_do (Observer< Dispersion > &Obs, Dispersion &t)
 Remove an observer. More...
 
void remove_observer_do (Observer< Dispersion > &Obs)
 

Protected Attributes

std::list< boost::weak_ptr< Observer< Dispersion > > > olist
 
std::vector< boost::shared_ptr< Observer< Dispersion > > > ref_list
 

Detailed Description

This class calculates the wavenumber for each pixel in a single band of an Instrument.

Definition at line 12 of file dispersion.h.

Constructor & Destructor Documentation

◆ ~Dispersion()

virtual FullPhysics::Dispersion::~Dispersion ( )
inlinevirtual

Definition at line 15 of file dispersion.h.

Member Function Documentation

◆ add_observer()

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

Add an observer.

Implements FullPhysics::Observable< Dispersion >.

Definition at line 16 of file dispersion.h.

◆ add_observer_and_keep_reference()

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

Add an observer.

Definition at line 148 of file observer.h.

◆ add_observer_do() [2/2]

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

Definition at line 159 of file observer.h.

◆ clean_dead_ptr()

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

Remove any dead pointers.

Definition at line 196 of file observer.h.

◆ clone()

virtual boost::shared_ptr<Dispersion> FullPhysics::Dispersion::clone ( ) const
pure virtual

Clone an Dispersion object.

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

Implemented in FullPhysics::DispersionPolynomial.

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

Returns as list of grid points for each instrument pixel, and the gradient of the points wrt the state vector.

This is for the full instrument pixels, i.e., any windowing etc. happens in later processing.

Implemented in FullPhysics::DispersionPolynomial.

◆ 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::Dispersion::remove_observer ( Observer< Dispersion > &  Obs)
inlinevirtual

Remove an observer.

Implements FullPhysics::Observable< Dispersion >.

Definition at line 18 of file dispersion.h.

◆ remove_observer_do() [1/2]

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

Remove an observer.

Definition at line 173 of file observer.h.

◆ remove_observer_do() [2/2]

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

Definition at line 200 of file observer.h.

◆ ref_list

std::vector<boost::shared_ptr<Observer<Dispersion > > > FullPhysics::Observable< Dispersion >::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