This is a simple SpectrumSampling that is just a uniform sampling. More...

#include <simple_fixed_spectrum_sampling.h>

Inheritance diagram for FullPhysics::SimpleFixedSpectrumSampling:

Collaboration diagram for FullPhysics::SimpleFixedSpectrumSampling:

Public Member Functions
	SimpleFixedSpectrumSampling (double wn_start, double wn_end, double wn_step)
	Constructor. More...

	SimpleFixedSpectrumSampling (double wn_start1, double wn_end1, double wn_step1, double wn_start2, double wn_end2, double wn_step2, double wn_start3, double wn_end3, double wn_step3)
	Constructor for 3 spectrum (this is a useful case, because it matches GOSAT) More...

virtual	~SimpleFixedSpectrumSampling ()

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
	Wave numbers 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 Attributes
int	nspectrometer

Detailed Description

This is a simple SpectrumSampling that is just a uniform sampling.

This is useful for doing unit testing.

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 17 of file simple_fixed_spectrum_sampling.h.

Constructor & Destructor Documentation

◆ SimpleFixedSpectrumSampling() [1/2]

SimpleFixedSpectrumSampling::SimpleFixedSpectrumSampling	(	double	wn_start,
		double	wn_end,
		double	wn_step
	)

Constructor.

This creates a fixed spacing grid. wn_end may be adjusted slightly if it isn't exactly wn_start + wn_step * i for some integer i.

Definition at line 12 of file simple_fixed_spectrum_sampling.cc.

◆ SimpleFixedSpectrumSampling() [2/2]

SimpleFixedSpectrumSampling::SimpleFixedSpectrumSampling	(	double	wn_start1,
		double	wn_end1,
		double	wn_step1,
		double	wn_start2,
		double	wn_end2,
		double	wn_step2,
		double	wn_start3,
		double	wn_end3,
		double	wn_step3
	)

Constructor for 3 spectrum (this is a useful case, because it matches GOSAT)

Definition at line 29 of file simple_fixed_spectrum_sampling.cc.

◆ ~SimpleFixedSpectrumSampling()

virtual FullPhysics::SimpleFixedSpectrumSampling::~SimpleFixedSpectrumSampling ( )

inlinevirtual

Definition at line 24 of file simple_fixed_spectrum_sampling.h.

Member Function Documentation

◆ need_interpolation()

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

inlinevirtualinherited

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

inlineinherited

Number of spectrometers we have.

Definition at line 26 of file spectrum_sampling.h.

◆ print()

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

virtual

Print to stream.

Reimplemented from FullPhysics::SpectrumSampling.

Definition at line 56 of file simple_fixed_spectrum_sampling.cc.

◆ 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::SimpleFixedSpectrumSampling::spectral_domain	(	int	spec_index,
		const SpectralDomain &	Lowres_grid,
		const DoubleWithUnit &	Ils_half_width
	)		const

inlinevirtual

Wave numbers to use for the given spectrometer.

Implements FullPhysics::SpectrumSampling.

Definition at line 30 of file simple_fixed_spectrum_sampling.h.

◆ spectral_domain_interpolated()

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

inlinevirtualinherited

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

protectedinherited

Definition at line 74 of file spectrum_sampling.h.

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

Implementation/simple_fixed_spectrum_sampling.h
Implementation/simple_fixed_spectrum_sampling.cc

Public Member Functions

Protected Attributes