FullPhysics::SpectrallyResolvedNoise Class Reference

Adds a spectrally varying modification to an existing noise model. More...

#include <spectrally_resolved_noise.h>

Inheritance diagram for FullPhysics::SpectrallyResolvedNoise:

Collaboration diagram for FullPhysics::SpectrallyResolvedNoise:

Public Member Functions
	SpectrallyResolvedNoise (boost::shared_ptr< NoiseModel > Base_model)
	Create a new SpectrallyResolvedNoise modifying an existing noise model. More...
virtual void	print (std::ostream &Os) const
	Print description of object. More...
std::string	print_to_string () const
	Print to string. More...
virtual void	set_noise_coefficients (int Spec_index, const blitz::Array< double, 1 > Noise_coeff)
	Add noise coefficents for a given band index. More...
virtual blitz::Array< double, 1 >	uncertainty (int Spec_index, const blitz::Array< double, 1 > &Radiance) const
	Applies spectrally resolved noise coefficents to base model's uncertainty. More...

Detailed Description

Adds a spectrally varying modification to an existing noise model.

Noise coefficents scale the parent noise model's uncertainty at certain grid points.

Definition at line 16 of file spectrally_resolved_noise.h.

Constructor & Destructor Documentation

SpectrallyResolvedNoise()

FullPhysics::SpectrallyResolvedNoise::SpectrallyResolvedNoise ( boost::shared_ptr< NoiseModel >  Base_model )

inline

Create a new SpectrallyResolvedNoise modifying an existing noise model.

The created object should be used in place of the base model. The noise coefficents for each band must be set individually since they might vary in size

Definition at line 25 of file spectrally_resolved_noise.h.

Member Function Documentation

print()

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

virtual

Print description of object.

Reimplemented from FullPhysics::NoiseModel.

Definition at line 42 of file spectrally_resolved_noise.cc.

print_to_string()

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

set_noise_coefficients()

void SpectrallyResolvedNoise::set_noise_coefficients ( int  Spec_index, const blitz::Array< double, 1 >  Noise_coeff  )

virtual

Add noise coefficents for a given band index.

The coefficeints per band do not need to be added in any particular order

Definition at line 20 of file spectrally_resolved_noise.cc.

uncertainty()

blitz::Array< double, 1 > SpectrallyResolvedNoise::uncertainty ( int  Spec_index, const blitz::Array< double, 1 > &  Radiance  ) const

virtual

Applies spectrally resolved noise coefficents to base model's uncertainty.

If coefficents are not set for a a spec_index then the base model's uncertainty is returned as is.

Implements FullPhysics::NoiseModel.

Definition at line 32 of file spectrally_resolved_noise.cc.

---

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

• Implementation/spectrally_resolved_noise.h
• Implementation/spectrally_resolved_noise.cc