FullPhysics::BadSampleNoiseModel Class Reference

When we have bad samples, we usually pass this to the spectral window to prevent the sample from even being used. More...

#include <bad_sample_noise_model.h>

Inheritance diagram for FullPhysics::BadSampleNoiseModel:

Collaboration diagram for FullPhysics::BadSampleNoiseModel:

Public Member Functions
template<class T >
	BadSampleNoiseModel (const boost::shared_ptr< NoiseModel > &Underlying_noise_model, const blitz::Array< T, 2 > &Bad_sample_mask, double Bad_sample_uncer)
const blitz::Array< bool, 2 > &	bad_sample_mask () const
double	bad_sample_uncertainty () const
virtual void	print (std::ostream &Os) const
	Print description of object. More...
std::string	print_to_string () const
	Print to string. More...
virtual blitz::Array< double, 1 >	uncertainty (int Spec_index, const blitz::Array< double, 1 > &Radiance) const
	Calculate uncertainty, using underlying model except where we have bad samples, where we set this to a fixed value. More...
const boost::shared_ptr< NoiseModel > &	underlying_noise_model () const

Detailed Description

When we have bad samples, we usually pass this to the spectral window to prevent the sample from even being used.

However, it can be useful to instead include the bad sample but give it a really large noise value (e.g., you want the residual calculated for a ARP investigation, but don't want it to have any weight in the retrieval). This adapter class takes a underlying noise model, but changes the uncertainty for any value that is marked as a bad sample.

Definition at line 16 of file bad_sample_noise_model.h.

Constructor & Destructor Documentation

BadSampleNoiseModel()

template<class T >

FullPhysics::BadSampleNoiseModel::BadSampleNoiseModel ( const boost::shared_ptr< NoiseModel > &  Underlying_noise_model, const blitz::Array< T, 2 > &  Bad_sample_mask, double  Bad_sample_uncer  )

inline

Definition at line 19 of file bad_sample_noise_model.h.

Member Function Documentation

bad_sample_mask()

const blitz::Array<bool, 2>& FullPhysics::BadSampleNoiseModel::bad_sample_mask ( ) const

inline

Definition at line 38 of file bad_sample_noise_model.h.

bad_sample_uncertainty()

double FullPhysics::BadSampleNoiseModel::bad_sample_uncertainty ( ) const

inline

Definition at line 35 of file bad_sample_noise_model.h.

print()

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

virtual

Print description of object.

Reimplemented from FullPhysics::NoiseModel.

Definition at line 32 of file bad_sample_noise_model.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.

uncertainty()

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

virtual

Calculate uncertainty, using underlying model except where we have bad samples, where we set this to a fixed value.

Implements FullPhysics::NoiseModel.

Definition at line 22 of file bad_sample_noise_model.cc.

underlying_noise_model()

const boost::shared_ptr<NoiseModel>& FullPhysics::BadSampleNoiseModel::underlying_noise_model ( ) const

inline

Definition at line 36 of file bad_sample_noise_model.h.

---

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

• Implementation/bad_sample_noise_model.h
• Implementation/bad_sample_noise_model.cc