A common StateVectorObserver just "owns" a subset of the StateVector. More...

#include <sub_state_vector_observer.h>

Inheritance diagram for FullPhysics::SubStateVectorObserver:

Collaboration diagram for FullPhysics::SubStateVectorObserver:

Public Member Functions
virtual	~SubStateVectorObserver ()

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

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

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_sub)=0
	Called by update_state with the subset of the state vector used by this class. More...

Protected Member Functions
	SubStateVectorObserver (int Plen)
	Take the given number of state vector parameters. More...

	SubStateVectorObserver ()
	Default constructor. More...

void	state_vector_observer_initialize (int Plen)
	Take the given number of state vector parameters. More...

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

Detailed Description

A common StateVectorObserver just "owns" a subset of the StateVector.

This class gives the common behavior for this case.

Definition at line 12 of file sub_state_vector_observer.h.

Constructor & Destructor Documentation

◆ ~SubStateVectorObserver()

virtual FullPhysics::SubStateVectorObserver::~SubStateVectorObserver ( )

inlinevirtual

Definition at line 14 of file sub_state_vector_observer.h.

◆ SubStateVectorObserver() [1/2]

FullPhysics::SubStateVectorObserver::SubStateVectorObserver ( int Plen )

inlineprotected

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 83 of file sub_state_vector_observer.h.

◆ SubStateVectorObserver() [2/2]

FullPhysics::SubStateVectorObserver::SubStateVectorObserver ( )

inlineprotected

Default constructor.

Derived classes should call initialize before finishing there constructor.

Definition at line 94 of file sub_state_vector_observer.h.

Member Function Documentation

◆ mark_used()

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

virtual

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

virtual void FullPhysics::SubStateVectorObserver::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.

Definition at line 48 of file sub_state_vector_observer.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 )

inlinevirtual

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 )

inlinevirtual

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 )

virtual

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.

◆ print()

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

inlinevirtual

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

virtual

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_sub()

virtual void FullPhysics::SubStateVectorObserver::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.

Definition at line 57 of file sub_state_vector_observer.h.

◆ state_vector_observer_initialize()

void SubStateVectorObserver::state_vector_observer_initialize ( int Plen )

protected

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

inline

Starting index of state vector used by this object.

Definition at line 25 of file sub_state_vector_observer.h.

◆ sub_vector_size()

int FullPhysics::SubStateVectorObserver::sub_vector_size ( ) const

inline

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

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

pure virtual

Called by update_state with the subset of the state vector used by this class.

Member Data Documentation

◆ sv_cov_full

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

protected

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

protected

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

protected

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

protected

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.

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

Support/sub_state_vector_observer.h
Support/sub_state_vector_observer.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~SubStateVectorObserver()

◆ SubStateVectorObserver() [1/2]

◆ SubStateVectorObserver() [2/2]

Member Function Documentation

◆ mark_used()

◆ mark_used_sub()

◆ notify_add() [1/2]

◆ notify_add() [2/2]

◆ notify_remove() [1/2]

◆ notify_remove() [2/2]

◆ notify_update()

◆ print()

◆ print_to_string()

◆ state_vector_name()

◆ state_vector_name_sub()

◆ state_vector_observer_initialize()

◆ state_vector_start_index()

◆ sub_vector_size()

◆ update_sub_state()

Member Data Documentation

◆ sv_cov_full

◆ sv_cov_sub

◆ sv_full

◆ sv_sub