It is common to have a class that is an Observable with a set of coefficients, a subset of which are updated by changes to the StateVector. More...

#include <sub_state_vector_array.h>

Inheritance diagram for FullPhysics::SubStateVectorArray< Base >:

Collaboration diagram for FullPhysics::SubStateVectorArray< Base >:

Public Member Functions
	SubStateVectorArray (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)
	Constructor. More...

	SubStateVectorArray ()
	Default constructor, should call init. More...

	SubStateVectorArray (double Coeff, bool Used_flag)
	Special case when Coeff and Used_flag have exactly one row. More...

virtual	~SubStateVectorArray ()

const ArrayAd< double, 1 > &	coefficient () const

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...

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 void	notify_add ()

virtual void	notify_add (StateVector &Sv)
	Called when an object is added to 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...

const boost::shared_ptr< Pressure > &	pressure () const

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

std::string	print_to_string () const
	Print to string. 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	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...

int	pdep_start
	Index of first coefficient that depends on the number of pressure levels. More...

boost::shared_ptr< Pressure >	press
	Pressure. More...

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...

Detailed Description

template<class Base>
class FullPhysics::SubStateVectorArray< Base >

It is common to have a class that is an Observable with a set of coefficients, a subset of which are updated by changes to the StateVector.

This class captures this common behavior.

For some classes, we only use the set of levels that lie above the lowest pressure level. For those classes, you can also pass in the Pressure class to use. If this doesn't apply to your particular class, then just leave the pressure out. This applies to the old fixed level classes (pre B2.10), this isn't currently used in the production code anymore.

Definition at line 20 of file sub_state_vector_array.h.

Constructor & Destructor Documentation

◆ SubStateVectorArray() [1/3]

template<class Base>

FullPhysics::SubStateVectorArray< Base >::SubStateVectorArray	(	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`
	)

inline

Constructor.

The optional Mark_according_to_press and Pdep_start can be supplied with the Press. If this Mark_according_to_press it true, then we will only mark parameters in mark_used_sub() as used for i > Press->number_level() + Pdep_start. If Mark_according_to_press is false then we skip this logic but otherwise store the Pressure. This may seem a bit arcane, but it fits well with some of the classes that derive from this one (the old fixed level classes, used before B2.10)

Definition at line 38 of file sub_state_vector_array.h.

◆ SubStateVectorArray() [2/3]

template<class Base>

FullPhysics::SubStateVectorArray< Base >::SubStateVectorArray ( )

inline

Default constructor, should call init.

Definition at line 57 of file sub_state_vector_array.h.

◆ SubStateVectorArray() [3/3]

template<class Base>

FullPhysics::SubStateVectorArray< Base >::SubStateVectorArray	(	double	Coeff,
		bool	Used_flag
	)

inline

Special case when Coeff and Used_flag have exactly one row.

Definition at line 82 of file sub_state_vector_array.h.

◆ ~SubStateVectorArray()

template<class Base>

virtual FullPhysics::SubStateVectorArray< Base >::~SubStateVectorArray ( )

inlinevirtual

Definition at line 90 of file sub_state_vector_array.h.

Member Function Documentation

◆ coefficient()

template<class Base>

const ArrayAd<double, 1>& FullPhysics::SubStateVectorArray< Base >::coefficient ( ) const

inline

Definition at line 171 of file sub_state_vector_array.h.

◆ init()

template<class Base>

void FullPhysics::SubStateVectorArray< Base >::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`
	)

inline

Definition at line 59 of file sub_state_vector_array.h.

◆ mark_used()

void SubStateVectorObserver::mark_used	(	const StateVector &	Sv,
		blitz::Array< bool, 1 > &	Used
	)		const

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.

◆ mark_used_sub()

template<class Base>

void FullPhysics::SubStateVectorArray< Base >::mark_used_sub ( blitz::Array< bool, 1 > & Used ) const

inlinevirtual

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.

◆ notify_add() [1/2]

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

inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_add() [2/2]

virtual void FullPhysics::SubStateVectorObserver::notify_add ( StateVector & Observed_object )

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.

◆ notify_remove() [1/2]

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

inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_remove() [2/2]

virtual void FullPhysics::SubStateVectorObserver::notify_remove ( StateVector & Observed_object )

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.

◆ notify_update()

void SubStateVectorObserver::notify_update ( const StateVector & Observed_object )

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.

◆ pressure()

template<class Base>

const boost::shared_ptr<Pressure>& FullPhysics::SubStateVectorArray< Base >::pressure ( ) const

inline

Definition at line 186 of file sub_state_vector_array.h.

◆ print()

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

inlinevirtualinherited

Reimplemented from FullPhysics::StateVectorObserver.

Reimplemented in FullPhysics::EmpiricalOrthogonalFunction, FullPhysics::PressureFixedLevel, FullPhysics::DispersionPolynomial, FullPhysics::GroundBrdf, FullPhysics::AerosolPropertyRhHdf, FullPhysics::RadianceScalingSvFit, FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolPropertyImpBase, FullPhysics::AerosolExtinctionLog, FullPhysics::PressureSigma, FullPhysics::AerosolExtinctionLinear, FullPhysics::AerosolExtinctionImpBase, FullPhysics::PressureImpBase, FullPhysics::StokesCoefficientImpBase, FullPhysics::GroundLambertian, FullPhysics::TemperatureImpBase, FullPhysics::AerosolPropertyHdf, FullPhysics::FluorescenceEffect, FullPhysics::AbsorberVmrImpBase, FullPhysics::InstrumentDoppler, FullPhysics::GroundCoxmunk, FullPhysics::GroundCoxmunkPlusLambertian, FullPhysics::AbsorberVmrFixedLevel, FullPhysics::AbsorberVmrFixedLevelScaled, FullPhysics::AbsorberVmrMet, FullPhysics::SubStateVectorProxy, FullPhysics::AbsorberVmrLevel, FullPhysics::AbsorberVmrLevelScaled, FullPhysics::TemperatureFixedLevel, FullPhysics::AbsorberVmrScaled, FullPhysics::StokesCoefficientFraction, FullPhysics::TemperatureMet, FullPhysics::TemperatureLevelOffset, and FullPhysics::TemperatureOffset.

Definition at line 59 of file sub_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.

◆ state_vector_name()

void SubStateVectorObserver::state_vector_name	(	const StateVector &	Sv,
		blitz::Array< std::string, 1 > &	Sv_name
	)		const

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.

◆ state_vector_name_i()

template<class Base>

virtual std::string FullPhysics::SubStateVectorArray< Base >::state_vector_name_i ( int i ) const

inlinevirtual

Return state vector name for ith entry in coeff.

Reimplemented in FullPhysics::EmpiricalOrthogonalFunction, FullPhysics::PressureFixedLevel, FullPhysics::DispersionPolynomial, FullPhysics::GroundBrdf, FullPhysics::PressureSigma, FullPhysics::AerosolShapeGaussian, FullPhysics::RadianceScalingSvFit, FullPhysics::AerosolExtinctionLog, FullPhysics::AerosolExtinctionLinear, FullPhysics::GroundLambertian, FullPhysics::FluorescenceEffect, FullPhysics::AerosolPropertyImpBase, FullPhysics::AbsorberVmrFixedLevel, FullPhysics::InstrumentDoppler, FullPhysics::TemperatureFixedLevel, FullPhysics::GroundCoxmunk, FullPhysics::SurfaceTemperatureDirect, FullPhysics::TemperatureOffset, FullPhysics::AbsorberVmrFixedLevelScaled, FullPhysics::AbsorberVmrScaled, FullPhysics::AbsorberVmrLevel, and FullPhysics::StokesCoefficientFraction.

Definition at line 129 of file sub_state_vector_array.h.

◆ state_vector_name_sub()

template<class Base>

virtual void FullPhysics::SubStateVectorArray< Base >::state_vector_name_sub ( blitz::Array< std::string, 1 > & Sv_name ) const

inlinevirtual

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.

◆ state_vector_observer_initialize()

void SubStateVectorObserver::state_vector_observer_initialize ( int Plen )

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.

◆ state_vector_start_index()

int FullPhysics::SubStateVectorObserver::state_vector_start_index ( ) const

inlineinherited

Starting index of state vector used by this object.

Definition at line 25 of file sub_state_vector_observer.h.

◆ statevector_covariance()

template<class Base>

const blitz::Array<double, 2>& FullPhysics::SubStateVectorArray< Base >::statevector_covariance ( ) const

inline

Definition at line 181 of file sub_state_vector_array.h.

◆ sub_state_identifier()

template<class Base>

virtual std::string FullPhysics::SubStateVectorArray< Base >::sub_state_identifier ( ) const

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 in FullPhysics::EmpiricalOrthogonalFunction, FullPhysics::PressureFixedLevel, FullPhysics::DispersionPolynomial, FullPhysics::GroundBrdf, FullPhysics::PressureSigma, FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolExtinctionLog, FullPhysics::RadianceScalingSvFit, FullPhysics::AerosolExtinctionLinear, FullPhysics::GroundLambertian, FullPhysics::FluorescenceEffect, FullPhysics::AerosolPropertyImpBase, FullPhysics::AbsorberVmrFixedLevel, FullPhysics::TemperatureFixedLevel, FullPhysics::InstrumentDoppler, FullPhysics::GroundCoxmunk, FullPhysics::TemperatureOffset, FullPhysics::AbsorberVmrFixedLevelScaled, FullPhysics::AbsorberVmrLevel, FullPhysics::AbsorberVmrScaled, and FullPhysics::StokesCoefficientFraction.

Definition at line 120 of file sub_state_vector_array.h.

◆ sub_vector_size()

int FullPhysics::SubStateVectorObserver::sub_vector_size ( ) const

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.

◆ update_sub_state()

template<class Base>

virtual void FullPhysics::SubStateVectorArray< Base >::update_sub_state	(	const ArrayAd< double, 1 > &	Sv_sub,
		const blitz::Array< double, 2 > &	Cov_sub
	)

inlinevirtual

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.

◆ update_sub_state_hook()

template<class Base>

virtual void FullPhysics::SubStateVectorArray< Base >::update_sub_state_hook ( )

inlinevirtual

Hook for anything a derived class needs to do after coefficient is updated and before notify_update.

Default is nothing.

Reimplemented in FullPhysics::GroundCoxmunk, FullPhysics::PressureImpBase, FullPhysics::StokesCoefficientImpBase, FullPhysics::TemperatureImpBase, FullPhysics::AerosolExtinctionImpBase, and FullPhysics::AbsorberVmrImpBase.

Definition at line 167 of file sub_state_vector_array.h.

◆ used_flag_value()

template<class Base>

const blitz::Array<bool, 1>& FullPhysics::SubStateVectorArray< Base >::used_flag_value ( ) const

inline

Definition at line 176 of file sub_state_vector_array.h.

Member Data Documentation

◆ coeff

template<class Base>

ArrayAd<double, 1> FullPhysics::SubStateVectorArray< Base >::coeff

protected

Coefficients.

Definition at line 196 of file sub_state_vector_array.h.

◆ cov

template<class Base>

blitz::Array<double, 2> FullPhysics::SubStateVectorArray< Base >::cov

protected

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.

◆ mark_according_to_press

template<class Base>

bool FullPhysics::SubStateVectorArray< Base >::mark_according_to_press

protected

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.

◆ pdep_start

template<class Base>

int FullPhysics::SubStateVectorArray< Base >::pdep_start

protected

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.

◆ press

template<class Base>

boost::shared_ptr<Pressure> FullPhysics::SubStateVectorArray< Base >::press

protected

Pressure.

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.

◆ sv_cov_full

blitz::Array<double, 2> FullPhysics::SubStateVectorObserver::sv_cov_full

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.

◆ sv_cov_sub

blitz::Array<double, 2> FullPhysics::SubStateVectorObserver::sv_cov_sub

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.

◆ sv_full

ArrayAd<double, 1> FullPhysics::SubStateVectorObserver::sv_full

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.

◆ sv_sub

ArrayAd<double, 1> FullPhysics::SubStateVectorObserver::sv_sub

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.

◆ used_flag

template<class Base>

blitz::Array<bool, 1> FullPhysics::SubStateVectorArray< Base >::used_flag

protected

Flag indicating which of the coefficients gets updated by the StateVector.

Definition at line 210 of file sub_state_vector_array.h.

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

Support/sub_state_vector_array.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class Base> class FullPhysics::SubStateVectorArray< Base >

Constructor & Destructor Documentation

◆ SubStateVectorArray() [1/3]

◆ SubStateVectorArray() [2/3]

◆ SubStateVectorArray() [3/3]

◆ ~SubStateVectorArray()

Member Function Documentation

◆ coefficient()

◆ init()

◆ mark_used()

◆ mark_used_sub()

◆ notify_add() [1/2]

◆ notify_add() [2/2]

◆ notify_remove() [1/2]

◆ notify_remove() [2/2]

◆ notify_update()

◆ pressure()

◆ print()

◆ print_to_string()

◆ state_vector_name()

◆ state_vector_name_i()

◆ state_vector_name_sub()

◆ state_vector_observer_initialize()

◆ state_vector_start_index()

◆ statevector_covariance()

◆ sub_state_identifier()

◆ sub_vector_size()

◆ update_sub_state()

◆ update_sub_state_hook()

◆ used_flag_value()

Member Data Documentation

◆ coeff

◆ cov

◆ mark_according_to_press

◆ pdep_start

◆ press

◆ sv_cov_full

◆ sv_cov_sub

◆ sv_full

◆ sv_sub

◆ used_flag

template<class Base>
class FullPhysics::SubStateVectorArray< Base >