ReFRACtor
|
Corrects Spectrum spectral domain to account for the doppler shift due to the relative velocity between earth and the instrument. More...
#include <instrument_doppler.h>
Public Member Functions | |
InstrumentDoppler (const DoubleWithUnit &Relative_velocity, const bool Used_flag=false) | |
InstrumentDoppler (const double Relative_velocity_value, const std::string &Relative_velocity_units, const bool Used_flag=false) | |
virtual void | add_observer (Observer< SpectrumEffect > &Obs) |
Add an observer. More... | |
void | add_observer_and_keep_reference (boost::shared_ptr< Observer< SpectrumEffect > > &Obs) |
Add an observer and keep a reference to it. More... | |
virtual void | apply_effect (Spectrum &Spec, const ForwardModelSpectralGrid &Forward_model_grid) const |
Apply correction to spectrum in place. More... | |
virtual boost::shared_ptr< SpectrumEffect > | clone () const |
Clone a SpectrumEffect object. More... | |
const ArrayAd< double, 1 > & | coefficient () const |
virtual std::string | desc () const |
Description of object, to be printed to stream. More... | |
void | init (const blitz::Array< double, 1 > &Coeff, const blitz::Array< bool, 1 > &Used_flag, const boost::shared_ptr< Pressure > &Press=boost::shared_ptr< Pressure >(), bool Mark_according_to_press=true, int Pdep_start=0) |
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 | 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... | |
void | mark_used_sub (blitz::Array< bool, 1 > &Used) const |
Called by mark_used with the subset of the state vector used by this class. More... | |
virtual std::string | name () const |
Name of spectrum effect, for use when outputting effects of effect. 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_add (StateVector &Sv) |
Called when an object is added to 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 (StateVector &Sv) |
Called when an object is removed from an Observable. More... | |
virtual void | notify_update (const StateVector &Sv) |
Called when the Observed object is updated. More... | |
virtual void | notify_update (const StateVector &Observed_object) |
Called when the Observed object is updated. More... | |
const boost::shared_ptr< Pressure > & | pressure () const |
virtual void | print (std::ostream &Os, bool Short_form=false) const |
Print to stream. More... | |
virtual void | print (std::ostream &Os) const |
std::string | print_to_string () const |
Print to string. More... | |
virtual void | remove_observer (Observer< SpectrumEffect > &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... | |
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... | |
virtual std::string | state_vector_name_i (int i) const |
Return state vector name for ith entry in coeff. More... | |
virtual void | state_vector_name_sub (blitz::Array< std::string, 1 > &Sv_name) const |
Called by state_vector_name with the subset of the Sv_name used by this class. More... | |
int | state_vector_start_index () const |
Starting index of state vector used by this object. More... | |
const blitz::Array< double, 2 > & | statevector_covariance () const |
virtual std::string | sub_state_identifier () const |
Return a string to identify this part of the state, this name should be all lower case and seperate parts with a /. More... | |
int | sub_vector_size () const |
Length of the sub set of the state vector used by this object. More... | |
virtual void | update_sub_state (const ArrayAd< double, 1 > &Sv_sub, const blitz::Array< double, 2 > &Cov) |
Called by update_state with the subset of the state vector used by this class. More... | |
virtual void | update_sub_state_hook () |
Hook for anything a derived class needs to do after coefficient is updated and before notify_update. More... | |
const blitz::Array< bool, 1 > & | used_flag_value () const |
Protected Member Functions | |
void | add_observer_do (Observer< SpectrumEffect > &Obs, SpectrumEffect &t) |
Add an observer. More... | |
void | add_observer_do (Observer< SpectrumEffect > &Obs) |
void | clean_dead_ptr () |
Remove any dead pointers. More... | |
void | notify_update_do (const SpectrumEffect &Self) |
Function to call to notify Observers of a state change. More... | |
void | remove_observer_do (Observer< SpectrumEffect > &Obs, SpectrumEffect &t) |
Remove an observer. More... | |
void | remove_observer_do (Observer< SpectrumEffect > &Obs) |
void | state_vector_observer_initialize (int Plen) |
Take the given number of state vector parameters. More... | |
Protected Attributes | |
ArrayAd< double, 1 > | coeff |
Coefficients. More... | |
blitz::Array< double, 2 > | cov |
Last covariance matrix updated from the StateVector. More... | |
bool | mark_according_to_press |
Flag indicating if we only mark coefficients >= pdep_start + press->number_level() in mark_used_sub. More... | |
std::list< boost::weak_ptr< Observer< SpectrumEffect > > > | olist |
int | pdep_start |
Index of first coefficient that depends on the number of pressure levels. More... | |
boost::shared_ptr< Pressure > | press |
Pressure. More... | |
std::vector< boost::shared_ptr< Observer< SpectrumEffect > > > | ref_list |
blitz::Array< double, 2 > | sv_cov_full |
The last full covariance matrix we have been with, saved for reference by derived class. More... | |
blitz::Array< double, 2 > | sv_cov_sub |
The subset of cov_full that is "owned" by this class, what was passed through update_sub_state. More... | |
ArrayAd< double, 1 > | sv_full |
The last full state vector we have been updated with, saved for reference by derived class. More... | |
ArrayAd< double, 1 > | sv_sub |
The subset of sv_full that is "owned" by this class, what was passed through update_sub_state. More... | |
blitz::Array< bool, 1 > | used_flag |
Flag indicating which of the coefficients gets updated by the StateVector. More... | |
Corrects Spectrum spectral domain to account for the doppler shift due to the relative velocity between earth and the instrument.
This value is retrievable due to the way the class is structured.
Definition at line 15 of file instrument_doppler.h.
InstrumentDoppler::InstrumentDoppler | ( | const DoubleWithUnit & | Relative_velocity, |
const bool | Used_flag = false |
||
) |
Definition at line 17 of file instrument_doppler.cc.
InstrumentDoppler::InstrumentDoppler | ( | const double | Relative_velocity_value, |
const std::string & | Relative_velocity_units, | ||
const bool | Used_flag = false |
||
) |
Definition at line 28 of file instrument_doppler.cc.
|
inlinevirtualinherited |
Add an observer.
Implements FullPhysics::Observable< SpectrumEffect >.
Definition at line 20 of file spectrum_effect.h.
|
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.
|
inlineprotectedinherited |
Add an observer.
Definition at line 148 of file observer.h.
|
inlineprotectedinherited |
Definition at line 159 of file observer.h.
|
virtual |
Apply correction to spectrum in place.
We pass in the forward model grids used. A class can use this to optimize its calculation, see for example FluorescenceEffect.
Implements FullPhysics::SpectrumEffect.
Definition at line 40 of file instrument_doppler.cc.
|
inlineprotectedinherited |
Remove any dead pointers.
Definition at line 196 of file observer.h.
|
virtual |
Clone a SpectrumEffect object.
Note that the cloned version will not be attached to and StateVector or Observer<SpectrumEffect>, 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" SpectrumEffect object.
Implements FullPhysics::SpectrumEffectImpBase.
Definition at line 61 of file instrument_doppler.cc.
|
inlineinherited |
Definition at line 171 of file sub_state_vector_array.h.
|
inlinevirtualinherited |
Description of object, to be printed to stream.
This gives a cleaner interface for deriving from python.
Definition at line 33 of file spectrum_effect_imp_base.h.
|
inlineinherited |
Definition at line 59 of file sub_state_vector_array.h.
|
virtualinherited |
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 from FullPhysics::StateVectorObserver.
Definition at line 35 of file sub_state_vector_observer.cc.
|
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.
|
inlinevirtualinherited |
Called by mark_used with the subset of the state vector used by this class.
The default marks everything as used, but derived classes can override this.
Reimplemented from FullPhysics::SubStateVectorObserver.
Definition at line 91 of file sub_state_vector_array.h.
|
inlinevirtual |
Name of spectrum effect, for use when outputting effects of effect.
Implements FullPhysics::SpectrumEffect.
Definition at line 33 of file instrument_doppler.h.
|
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.
|
inlinevirtualinherited |
Definition at line 48 of file observer.h.
|
inlinevirtualinherited |
Called when an object is added to an Observable.
Default is to do nothing.
Reimplemented from FullPhysics::Observer< StateVector >.
Definition at line 60 of file sub_state_vector_observer.h.
|
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.
|
inlinevirtualinherited |
Definition at line 56 of file observer.h.
|
inlinevirtualinherited |
Called when an object is removed from an Observable.
Default is to do nothing.
Reimplemented from FullPhysics::Observer< StateVector >.
Definition at line 68 of file sub_state_vector_observer.h.
|
virtualinherited |
Called when the Observed object is updated.
Reimplemented from FullPhysics::Observer< StateVector >.
Reimplemented in FullPhysics::RadianceScalingSvFit.
Definition at line 6 of file sub_state_vector_observer.cc.
|
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.
|
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.
|
inlineinherited |
Definition at line 186 of file sub_state_vector_array.h.
|
inlinevirtualinherited |
Print to stream.
The default calls the function "desc" that returns a string. This gives cleaner interface for deriving from this class in python, but most C++ classes will want to override this function rather than using desc.
Definition at line 27 of file spectrum_effect_imp_base.h.
|
virtual |
Reimplemented from FullPhysics::SubStateVectorObserver.
Definition at line 66 of file instrument_doppler.cc.
|
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.
|
inlinevirtualinherited |
Remove an observer.
Implements FullPhysics::Observable< SpectrumEffect >.
Definition at line 22 of file spectrum_effect.h.
|
inlineprotectedinherited |
Remove an observer.
Definition at line 173 of file observer.h.
|
inlineprotectedinherited |
Definition at line 181 of file observer.h.
|
virtualinherited |
Update any portion of the list of the state vector names that apply to this object.
Default is to do nothing.
Reimplemented from FullPhysics::StateVectorObserver.
Definition at line 52 of file sub_state_vector_observer.cc.
|
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.
|
inlinevirtual |
Return state vector name for ith entry in coeff.
Reimplemented from FullPhysics::SubStateVectorArray< SpectrumEffect >.
Definition at line 29 of file instrument_doppler.h.
|
inlinevirtualinherited |
Called by state_vector_name with the subset of the Sv_name used by this class.
The default function doesn't change anything, but derived classes can ovveride this.
Reimplemented from FullPhysics::SubStateVectorObserver.
Definition at line 134 of file sub_state_vector_array.h.
|
protectedinherited |
Take the given number of state vector parameters.
We determine where the starting point to use is when we attach to the state vector.
Note that it is perfectly legal for Plen to be 0, that just means we don't have any parameters. This is a useful edge case that we support.
Definition at line 80 of file sub_state_vector_observer.cc.
|
inlineinherited |
Starting index of state vector used by this object.
Definition at line 25 of file sub_state_vector_observer.h.
|
inlineinherited |
Definition at line 181 of file sub_state_vector_array.h.
|
inlinevirtual |
Return a string to identify this part of the state, this name should be all lower case and seperate parts with a /.
For example, an aerosol named strat would be named as: aerosol/strat. A gas named CO2 would be named like this: absorber/co2 The name is intended to be used for looking up retrieval values for a configuration system. Classes that have the same type of inputs should have the same name.
Reimplemented from FullPhysics::SubStateVectorArray< SpectrumEffect >.
Definition at line 27 of file instrument_doppler.h.
|
inlineinherited |
Length of the sub set of the state vector used by this object.
Definition at line 31 of file sub_state_vector_observer.h.
|
inlinevirtualinherited |
Called by update_state with the subset of the state vector used by this class.
Implements FullPhysics::SubStateVectorObserver.
Definition at line 145 of file sub_state_vector_array.h.
|
inlinevirtualinherited |
Hook for anything a derived class needs to do after coefficient is updated and before notify_update.
Default is nothing.
Definition at line 167 of file sub_state_vector_array.h.
|
inlineinherited |
Definition at line 176 of file sub_state_vector_array.h.
|
protectedinherited |
Coefficients.
Definition at line 196 of file sub_state_vector_array.h.
|
protectedinherited |
Last covariance matrix updated from the StateVector.
If we haven't updated yet, this will be a 0x0 array.
Definition at line 216 of file sub_state_vector_array.h.
|
protectedinherited |
Flag indicating if we only mark coefficients >= pdep_start + press->number_level() in mark_used_sub.
This may seem a bit arcane, but this matches some of the classes that derive from this one (e.g., TemperatureFixedLevel).
Definition at line 225 of file sub_state_vector_array.h.
|
protectedinherited |
Definition at line 200 of file observer.h.
|
protectedinherited |
Index of first coefficient that depends on the number of pressure levels.
This is only used if mark_according_to_press to true, otherwise we don't do anything with this value.
Definition at line 233 of file sub_state_vector_array.h.
|
protectedinherited |
This may be a null pointer, which just means this particular class doesn't store the Pressure object.
Definition at line 203 of file sub_state_vector_array.h.
|
protectedinherited |
Definition at line 201 of file observer.h.
|
protectedinherited |
The last full covariance matrix we have been with, saved for reference by derived class.
Definition at line 108 of file sub_state_vector_observer.h.
|
protectedinherited |
The subset of cov_full that is "owned" by this class, what was passed through update_sub_state.
Saved for reference by derived class.
Definition at line 122 of file sub_state_vector_observer.h.
|
protectedinherited |
The last full state vector we have been updated with, saved for reference by derived class.
Definition at line 102 of file sub_state_vector_observer.h.
|
protectedinherited |
The subset of sv_full that is "owned" by this class, what was passed through update_sub_state.
Saved for reference by derived class.
Definition at line 115 of file sub_state_vector_observer.h.
|
protectedinherited |
Flag indicating which of the coefficients gets updated by the StateVector.
Definition at line 210 of file sub_state_vector_array.h.