This class implements a Coxmunk plus Lambertian ground type. More...

#include <ground_coxmunk_plus_lambertian.h>

Inheritance diagram for FullPhysics::GroundCoxmunkPlusLambertian:

Collaboration diagram for FullPhysics::GroundCoxmunkPlusLambertian:

Public Member Functions
	GroundCoxmunkPlusLambertian (const boost::shared_ptr< GroundCoxmunk > &Coxmunk, const boost::shared_ptr< GroundLambertian > &Lambertian)

virtual void	add_observer (Observer< Ground > &Obs)
	Add an observer. More...

void	add_observer_and_keep_reference (boost::shared_ptr< Observer< Ground > > &Obs)
	Add an observer and keep a reference to it. More...

virtual boost::shared_ptr< Ground >	clone () const
	Clone a Ground object. More...

virtual const boost::shared_ptr< GroundCoxmunk >	coxmunk () const

virtual std::string	desc () const

virtual const boost::shared_ptr< GroundLambertian >	lambertian () const

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

virtual void	mark_used_sub (blitz::Array< bool, 1 > &Used) const
	Extracts the relevant portions of the passed arrays and passes them to the proxied objects. 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...

virtual void	print (std::ostream &Os) const
	Output the print results from the proxied classes. More...

std::string	print_to_string () const
	Print to string. More...

virtual void	remove_observer (Observer< Ground > &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 void	state_vector_name_sub (blitz::Array< std::string, 1 > &Sv_name) const
	Extracts the relevant portions of the passed arrays and passes them to the proxied objects. 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 ArrayAd< double, 1 >	surface_parameter (const double wn, const int spec_index) const
	Surface parmeters. More...

virtual void	update_sub_state (const ArrayAd< double, 1 > &Sv_sub, const blitz::Array< double, 2 > &Cov_sub)
	Extracts the relevant portions of the passed arrays and passes them to the proxied objects. More...

Protected Member Functions
void	add_observer_do (Observer< Ground > &Obs, Ground &t)
	Add an observer. More...

void	add_observer_do (Observer< Ground > &Obs)

void	clean_dead_ptr ()
	Remove any dead pointers. More...

void	initialize (const std::vector< boost::shared_ptr< SubStateVectorObserver > > &Proxied)
	Registers the classes that will be proxied. More...

void	notify_update_do (const Ground &Self)
	Function to call to notify Observers of a state change. More...

void	remove_observer_do (Observer< Ground > &Obs, Ground &t)
	Remove an observer. More...

void	remove_observer_do (Observer< Ground > &Obs)

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

Protected Attributes
std::list< boost::weak_ptr< Observer< Ground > > >	olist

std::vector< boost::shared_ptr< Observer< Ground > > >	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...

Detailed Description

This class implements a Coxmunk plus Lambertian ground type.

Definition at line 14 of file ground_coxmunk_plus_lambertian.h.

Constructor & Destructor Documentation

◆ GroundCoxmunkPlusLambertian()

GroundCoxmunkPlusLambertian::GroundCoxmunkPlusLambertian	(	const boost::shared_ptr< GroundCoxmunk > &	Coxmunk,
		const boost::shared_ptr< GroundLambertian > &	Lambertian
	)

Definition at line 28 of file ground_coxmunk_plus_lambertian.cc.

Member Function Documentation

◆ add_observer()

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

inlinevirtualinherited

Add an observer.

Implements FullPhysics::Observable< Ground >.

Definition at line 26 of file ground.h.

◆ add_observer_and_keep_reference()

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

inlineprotectedinherited

Add an observer.

Definition at line 148 of file observer.h.

◆ add_observer_do() [2/2]

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

inlineprotectedinherited

Definition at line 159 of file observer.h.

◆ clean_dead_ptr()

void FullPhysics::Observable< Ground >::clean_dead_ptr ( )

inlineprotectedinherited

Remove any dead pointers.

Definition at line 196 of file observer.h.

◆ clone()

boost::shared_ptr< Ground > GroundCoxmunkPlusLambertian::clone ( ) const

virtual

Clone a Ground object.

Note that the cloned version will not be attached to a StateVector, 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" Ground object.

Implements FullPhysics::Ground.

Definition at line 46 of file ground_coxmunk_plus_lambertian.cc.

◆ coxmunk()

virtual const boost::shared_ptr<GroundCoxmunk> FullPhysics::GroundCoxmunkPlusLambertian::coxmunk ( ) const

inlinevirtual

Definition at line 20 of file ground_coxmunk_plus_lambertian.h.

◆ desc()

virtual std::string FullPhysics::GroundCoxmunkPlusLambertian::desc ( ) const

inlinevirtual

Definition at line 28 of file ground_coxmunk_plus_lambertian.h.

◆ initialize()

void SubStateVectorProxy::initialize ( const std::vector< boost::shared_ptr< SubStateVectorObserver > > & Proxied )

protectedinherited

Registers the classes that will be proxied.

Must be called from subclasses constructor or else state vector will not be set up correctly.

Definition at line 13 of file sub_state_vector_proxy.cc.

◆ lambertian()

virtual const boost::shared_ptr<GroundLambertian> FullPhysics::GroundCoxmunkPlusLambertian::lambertian ( ) const

inlinevirtual

Definition at line 22 of file ground_coxmunk_plus_lambertian.h.

◆ mark_used() [1/2]

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() [2/2]

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.

◆ mark_used_sub()

void SubStateVectorProxy::mark_used_sub ( blitz::Array< bool, 1 > & Used ) const

virtualinherited

Extracts the relevant portions of the passed arrays and passes them to the proxied objects.

Reimplemented from FullPhysics::SubStateVectorObserver.

Definition at line 44 of file sub_state_vector_proxy.cc.

◆ notify_add() [1/3]

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/3]

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

inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_add() [3/3]

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/3]

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/3]

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

inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_remove() [3/3]

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() [1/2]

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.

◆ notify_update() [2/2]

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< Ground >::notify_update_do ( const Ground & 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.

◆ print()

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

virtual

Output the print results from the proxied classes.

Reimplemented from FullPhysics::SubStateVectorProxy.

Definition at line 50 of file ground_coxmunk_plus_lambertian.cc.

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

inlinevirtualinherited

Remove an observer.

Implements FullPhysics::Observable< Ground >.

Definition at line 28 of file ground.h.

◆ remove_observer_do() [1/2]

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

inlineprotectedinherited

Remove an observer.

Definition at line 173 of file observer.h.

◆ remove_observer_do() [2/2]

void FullPhysics::Observable< Ground >::remove_observer_do ( Observer< Ground > & Obs )

inlineprotectedinherited

Definition at line 181 of file observer.h.

◆ state_vector_name() [1/2]

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() [2/2]

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.

◆ state_vector_name_sub()

void SubStateVectorProxy::state_vector_name_sub ( blitz::Array< std::string, 1 > & Sv_name ) const

virtualinherited

Extracts the relevant portions of the passed arrays and passes them to the proxied objects.

Reimplemented from FullPhysics::SubStateVectorObserver.

Definition at line 61 of file sub_state_vector_proxy.cc.

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

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

◆ surface_parameter()

ArrayAd< double, 1 > GroundCoxmunkPlusLambertian::surface_parameter	(	const double	wn,
		const int	spec_index
	)		const

virtual

Surface parmeters.

What exactly these parameters mean is determined by the surface type, see the discussion in the comments before the Ground class.

Implements FullPhysics::Ground.

Definition at line 38 of file ground_coxmunk_plus_lambertian.cc.

◆ update_sub_state()

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

virtualinherited

Extracts the relevant portions of the passed arrays and passes them to the proxied objects.

Implements FullPhysics::SubStateVectorObserver.

Definition at line 29 of file sub_state_vector_proxy.cc.

Member Data Documentation

◆ olist

std::list<boost::weak_ptr<Observer<Ground > > > FullPhysics::Observable< Ground >::olist

protectedinherited

Definition at line 200 of file observer.h.

◆ ref_list

std::vector<boost::shared_ptr<Observer<Ground > > > FullPhysics::Observable< Ground >::ref_list

protectedinherited

Definition at line 201 of file observer.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.

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

Implementation/ground_coxmunk_plus_lambertian.h
Implementation/ground_coxmunk_plus_lambertian.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GroundCoxmunkPlusLambertian()

Member Function Documentation

◆ add_observer()

◆ add_observer_and_keep_reference()

◆ add_observer_do() [1/2]

◆ add_observer_do() [2/2]

◆ clean_dead_ptr()

◆ clone()

◆ coxmunk()

◆ desc()

◆ initialize()

◆ lambertian()

◆ mark_used() [1/2]

◆ mark_used() [2/2]

◆ mark_used_sub()

◆ notify_add() [1/3]

◆ notify_add() [2/3]

◆ notify_add() [3/3]

◆ notify_remove() [1/3]

◆ notify_remove() [2/3]

◆ notify_remove() [3/3]

◆ notify_update() [1/2]

◆ notify_update() [2/2]

◆ notify_update_do()

◆ print()

◆ print_to_string()

◆ remove_observer()

◆ remove_observer_do() [1/2]

◆ remove_observer_do() [2/2]

◆ state_vector_name() [1/2]

◆ state_vector_name() [2/2]

◆ state_vector_name_sub()

◆ state_vector_observer_initialize()

◆ state_vector_start_index()

◆ sub_vector_size()

◆ surface_parameter()

◆ update_sub_state()

Member Data Documentation

◆ olist

◆ ref_list

◆ sv_cov_full

◆ sv_cov_sub

◆ sv_full

◆ sv_sub