FullPhysics::SpectrumSampling Class Reference

This determines the sampling of the spectrum that should be used for each of the spectrum indexes. More...

#include <spectrum_sampling.h>

Inheritance diagram for FullPhysics::SpectrumSampling:

Collaboration diagram for FullPhysics::SpectrumSampling:

Public Member Functions
virtual	~SpectrumSampling ()
virtual bool	need_interpolation (int Spec_index) const
	Indicate if spectral_domain and spectral_domain_interpolated are different at all. More...
int	number_spectrometer () const
	Number of spectrometers we have. More...
virtual void	print (std::ostream &Os) const
	Print to stream. More...
std::string	print_to_string () const
	Print to string. More...
virtual SpectralDomain	spectral_domain (int spec_index, const SpectralDomain &Lowres_grid, const DoubleWithUnit &Ils_half_width) const =0
	Wavenumbers/Wavelengths to use for the given spectrometer. More...
virtual SpectralDomain	spectral_domain_interpolated (int Spec_index, const SpectralDomain &Lowres_grid, const DoubleWithUnit &Ils_half_width) const
	The interpolated spectral domain. More...

Protected Member Functions
	SpectrumSampling (int num_spectrometer)
	Constructor. More...
	SpectrumSampling ()
	Default constructor, derived classes should set nspectrometer. More...

Protected Attributes
int	nspectrometer

Detailed Description

This determines the sampling of the spectrum that should be used for each of the spectrum indexes.

Note that there are a few closely related classes, with similar sounding names. See Spectrum related classes for a description of each of these.

Definition at line 18 of file spectrum_sampling.h.

Constructor & Destructor Documentation

~SpectrumSampling()

virtual FullPhysics::SpectrumSampling::~SpectrumSampling ( )

inlinevirtual

Definition at line 20 of file spectrum_sampling.h.

SpectrumSampling() [1/2]

FullPhysics::SpectrumSampling::SpectrumSampling ( int  num_spectrometer )

inlineprotected

Constructor.

Definition at line 67 of file spectrum_sampling.h.

SpectrumSampling() [2/2]

FullPhysics::SpectrumSampling::SpectrumSampling ( )

inlineprotected

Default constructor, derived classes should set nspectrometer.

Definition at line 72 of file spectrum_sampling.h.

Member Function Documentation

need_interpolation()

virtual bool FullPhysics::SpectrumSampling::need_interpolation ( int  Spec_index ) const

inlinevirtual

Indicate if spectral_domain and spectral_domain_interpolated are different at all.

Reimplemented in FullPhysics::NonuniformSpectrumSampling.

Definition at line 55 of file spectrum_sampling.h.

number_spectrometer()

int FullPhysics::SpectrumSampling::number_spectrometer ( ) const

inline

Number of spectrometers we have.

Definition at line 26 of file spectrum_sampling.h.

print()

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

inlinevirtual

Print to stream.

Reimplemented in FullPhysics::NonuniformSpectrumSampling, FullPhysics::SimpleFixedSpectrumSampling, FullPhysics::UniformSpectrumSampling, and FullPhysics::SpectrumSamplingFixedSpacing.

Definition at line 61 of file spectrum_sampling.h.

print_to_string()

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

spectral_domain()

virtual SpectralDomain FullPhysics::SpectrumSampling::spectral_domain ( int  spec_index, const SpectralDomain &  Lowres_grid, const DoubleWithUnit &  Ils_half_width  ) const

pure virtual

Wavenumbers/Wavelengths to use for the given spectrometer.

We pass in the low resolution grid that we are going to generate after the ILS convolution, along with the ILS half width so we can generate the high resolution points needed to supply the ILS.

Implemented in FullPhysics::NonuniformSpectrumSampling, FullPhysics::SimpleFixedSpectrumSampling, FullPhysics::UniformSpectrumSampling, and FullPhysics::SpectrumSamplingFixedSpacing.

spectral_domain_interpolated()

virtual SpectralDomain FullPhysics::SpectrumSampling::spectral_domain_interpolated ( int  Spec_index, const SpectralDomain &  Lowres_grid, const DoubleWithUnit &  Ils_half_width  ) const

inlinevirtual

The interpolated spectral domain.

The default is that this is just the same as spectral_domain, but derived classes can supply a different implementation if it is doing nonuniform sampling.

Reimplemented in FullPhysics::NonuniformSpectrumSampling.

Definition at line 45 of file spectrum_sampling.h.

Member Data Documentation

nspectrometer

int FullPhysics::SpectrumSampling::nspectrometer

protected

Definition at line 74 of file spectrum_sampling.h.

---

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

• Interface/spectrum_sampling.h