ReFRACtor
FullPhysics::SpectrumSamplingFixedSpacing Class Reference

This generates a spectrum sampling that covers all the high resolution points needed to create the spectral domain covered by the given Instrument, subject to the given low resolution grid. More...

#include <spectrum_sampling_fixed_spacing.h>

+ Inheritance diagram for FullPhysics::SpectrumSamplingFixedSpacing:
+ Collaboration diagram for FullPhysics::SpectrumSamplingFixedSpacing:

Public Member Functions

 SpectrumSamplingFixedSpacing (const ArrayWithUnit< double, 1 > &Spec_spacing)
 
virtual ~SpectrumSamplingFixedSpacing ()
 
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
 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 Attributes

int nspectrometer
 

Detailed Description

This generates a spectrum sampling that covers all the high resolution points needed to create the spectral domain covered by the given Instrument, subject to the given low resolution grid.

For each range in the spectrum, we produce equally spaced points.

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_fixed_spacing.h.

Constructor & Destructor Documentation

◆ SpectrumSamplingFixedSpacing()

FullPhysics::SpectrumSamplingFixedSpacing::SpectrumSamplingFixedSpacing ( const ArrayWithUnit< double, 1 > &  Spec_spacing)
inline

Definition at line 20 of file spectrum_sampling_fixed_spacing.h.

◆ ~SpectrumSamplingFixedSpacing()

virtual FullPhysics::SpectrumSamplingFixedSpacing::~SpectrumSamplingFixedSpacing ( )
inlinevirtual

Definition at line 23 of file spectrum_sampling_fixed_spacing.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()

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

Print to stream.

Reimplemented from FullPhysics::SpectrumSampling.

Definition at line 27 of file spectrum_sampling_fixed_spacing.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()

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

Implements FullPhysics::SpectrumSampling.

Definition at line 15 of file spectrum_sampling_fixed_spacing.cc.

◆ 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:

Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:13