Implements a fitted radiance scaling correction where the correction is determined by a linear fit of the measured spectra to the radiance input instead of using the state vector for fitting. More...

#include <radiance_scaling_linear_fit.h>

Inheritance diagram for FullPhysics::RadianceScalingLinearFit:

Collaboration diagram for FullPhysics::RadianceScalingLinearFit:

Public Member Functions
	RadianceScalingLinearFit (const SpectralRange &Measured_radiance, const DoubleWithUnit &Band_ref, const std::string &Band_name, const bool Do_offset=true)
	Constructor. More...

virtual	~RadianceScalingLinearFit ()

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

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

virtual void	apply_correction (const SpectralDomain &Pixel_grid, const std::vector< int > &Pixel_list, SpectralRange &Radiance) const
	Apply correction to radiance values, in place. More...

virtual void	apply_scaling (const SpectralDomain &Grid, SpectralRange &Radiance) const
	Apply scaling and offset coefficients to Radiance. More...

virtual boost::shared_ptr< InstrumentCorrection >	clone () const
	Clone an InstrumentCorrection 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 void	print (std::ostream &Os) const

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

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

virtual double	radiance_offset () const
	Return radiance scaling offset for the output file. More...

virtual blitz::Array< double, 1 >	radiance_scaling_coeff () const
	Return radiance scaling coefficients for the output file. More...

blitz::Array< double, 1 >	radiance_scaling_coeff_uncertainty () const
	Return radiance scaling coefficients uncertainty for the output file. More...

virtual void	remove_observer (Observer< InstrumentCorrection > &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< InstrumentCorrection > &Obs, InstrumentCorrection &t)
	Add an observer. More...

void	add_observer_do (Observer< InstrumentCorrection > &Obs)

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

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

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

void	remove_observer_do (Observer< InstrumentCorrection > &Obs)

Protected Attributes
std::string	band_name

DoubleWithUnit	band_ref

AutoDerivative< double >	offset

std::list< boost::weak_ptr< Observer< InstrumentCorrection > > >	olist

std::vector< boost::shared_ptr< Observer< InstrumentCorrection > > >	ref_list

ArrayAd< double, 1 >	scaling_coeff

Detailed Description

Implements a fitted radiance scaling correction where the correction is determined by a linear fit of the measured spectra to the radiance input instead of using the state vector for fitting.

Definition at line 16 of file radiance_scaling_linear_fit.h.

Constructor & Destructor Documentation

◆ RadianceScalingLinearFit()

FullPhysics::RadianceScalingLinearFit::RadianceScalingLinearFit	(	const SpectralRange &	Measured_radiance,
		const DoubleWithUnit &	Band_ref,
		const std::string &	Band_name,
		const bool	Do_offset = `true`
	)

inline

Constructor.

Parameters

Measured_radiance	Measured radiance for the band
Band_ref	The wavenumber/wavelength that the scaling coefficients are relative to.
Band_name	Name of band
Do_offset	If true then do the offset

Definition at line 28 of file radiance_scaling_linear_fit.h.

◆ ~RadianceScalingLinearFit()

virtual FullPhysics::RadianceScalingLinearFit::~RadianceScalingLinearFit ( )

inlinevirtual

Definition at line 36 of file radiance_scaling_linear_fit.h.

Member Function Documentation

◆ add_observer()

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

inlinevirtualinherited

Add an observer.

Implements FullPhysics::Observable< InstrumentCorrection >.

Definition at line 20 of file instrument_correction.h.

◆ add_observer_and_keep_reference()

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

inlineprotectedinherited

Add an observer.

Definition at line 148 of file observer.h.

◆ add_observer_do() [2/2]

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

inlineprotectedinherited

Definition at line 159 of file observer.h.

◆ apply_correction()

void RadianceScalingLinearFit::apply_correction	(	const SpectralDomain &	Pixel_grid,
		const std::vector< int > &	Pixel_list,
		SpectralRange &	Radiance
	)		const

virtual

Apply correction to radiance values, in place.

If Radiance includes a Jacobian, then we include the Jacobian calculation. Otherwise we don't include the Jacobian in the calculation.

Parameters

Pixel_grid	- The grid point of each pixel. We only use a subset of these points, but the full list is passed in for use by the class.
Pixel_list	- List of pixels that actually appear in Radiance, in the order that they appear.
Radiance	- Radiance values, that will be corrected in place.

Implements FullPhysics::InstrumentCorrection.

Definition at line 24 of file radiance_scaling_linear_fit.cc.

◆ apply_scaling()

void RadianceScaling::apply_scaling	(	const SpectralDomain &	Grid,
		SpectralRange &	Radiance
	)		const

virtualinherited

Apply scaling and offset coefficients to Radiance.

Definition at line 8 of file radiance_scaling.cc.

◆ clean_dead_ptr()

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

inlineprotectedinherited

Remove any dead pointers.

Definition at line 196 of file observer.h.

◆ clone()

boost::shared_ptr< InstrumentCorrection > RadianceScalingLinearFit::clone ( ) const

virtual

Clone an InstrumentCorrection object.

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

Implements FullPhysics::InstrumentCorrection.

Definition at line 94 of file radiance_scaling_linear_fit.cc.

◆ 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< InstrumentCorrection >::notify_update_do ( const InstrumentCorrection & 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 RadianceScalingLinearFit::print ( std::ostream & Os ) const

virtual

Reimplemented from FullPhysics::RadianceScaling.

Definition at line 100 of file radiance_scaling_linear_fit.cc.

◆ print_to_string() [1/2]

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.

◆ print_to_string() [2/2]

std::string FullPhysics::Printable< RadianceScaling >::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.

◆ radiance_offset()

virtual double FullPhysics::RadianceScaling::radiance_offset ( ) const

inlinevirtualinherited

Return radiance scaling offset for the output file.

Definition at line 79 of file radiance_scaling.h.

◆ radiance_scaling_coeff()

virtual blitz::Array<double, 1> FullPhysics::RadianceScaling::radiance_scaling_coeff ( ) const

inlinevirtualinherited

Return radiance scaling coefficients for the output file.

Definition at line 67 of file radiance_scaling.h.

◆ radiance_scaling_coeff_uncertainty()

blitz::Array<double, 1> FullPhysics::RadianceScalingLinearFit::radiance_scaling_coeff_uncertainty ( ) const

inlinevirtual

Return radiance scaling coefficients uncertainty for the output file.

Implements FullPhysics::RadianceScaling.

Definition at line 51 of file radiance_scaling_linear_fit.h.

◆ remove_observer()

virtual void FullPhysics::InstrumentCorrection::remove_observer ( Observer< InstrumentCorrection > & Obs )

inlinevirtualinherited

Remove an observer.

Implements FullPhysics::Observable< InstrumentCorrection >.

Definition at line 22 of file instrument_correction.h.

◆ remove_observer_do() [1/2]

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

inlineprotectedinherited

Remove an observer.

Definition at line 173 of file observer.h.

◆ remove_observer_do() [2/2]

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

◆ band_name

std::string FullPhysics::RadianceScaling::band_name

protectedinherited

Definition at line 85 of file radiance_scaling.h.

◆ band_ref

DoubleWithUnit FullPhysics::RadianceScaling::band_ref

protectedinherited

Definition at line 84 of file radiance_scaling.h.

◆ offset

AutoDerivative<double> FullPhysics::RadianceScaling::offset

mutableprotectedinherited

Definition at line 83 of file radiance_scaling.h.

◆ olist

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

protectedinherited

Definition at line 200 of file observer.h.

◆ ref_list

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

protectedinherited

Definition at line 201 of file observer.h.

◆ scaling_coeff

ArrayAd<double, 1> FullPhysics::RadianceScaling::scaling_coeff

mutableprotectedinherited

Definition at line 82 of file radiance_scaling.h.

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

Implementation/radiance_scaling_linear_fit.h
Implementation/radiance_scaling_linear_fit.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RadianceScalingLinearFit()

◆ ~RadianceScalingLinearFit()

Member Function Documentation

◆ add_observer()

◆ add_observer_and_keep_reference()

◆ add_observer_do() [1/2]

◆ add_observer_do() [2/2]

◆ apply_correction()

◆ apply_scaling()

◆ clean_dead_ptr()

◆ clone()

◆ mark_used()

◆ notify_add() [1/2]

◆ notify_add() [2/2]

◆ notify_remove() [1/2]

◆ notify_remove() [2/2]

◆ notify_update()

◆ notify_update_do()

◆ print()

◆ print_to_string() [1/2]

◆ print_to_string() [2/2]

◆ radiance_offset()

◆ radiance_scaling_coeff()

◆ radiance_scaling_coeff_uncertainty()

◆ remove_observer()

◆ remove_observer_do() [1/2]

◆ remove_observer_do() [2/2]

◆ state_vector_name()

Member Data Documentation

◆ band_name

◆ band_ref

◆ offset

◆ olist

◆ ref_list

◆ scaling_coeff