ReFRACtor
FullPhysics::UniformSpectrumSampling Class Reference

This spectrum sampling creates a grid that begins the nearest ils_half_width before the low resolution grid beginning point and uniformly increases along some spacing until one ils_half_width past the end of the lowe resolution grid. More...

#include <uniform_spectrum_sampling.h>

+ Inheritance diagram for FullPhysics::UniformSpectrumSampling:
+ Collaboration diagram for FullPhysics::UniformSpectrumSampling:

Public Member Functions

 UniformSpectrumSampling (const ArrayWithUnit< double, 1 > &Spec_spacing)
 
virtual ~UniformSpectrumSampling ()
 
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 spectrum sampling creates a grid that begins the nearest ils_half_width before the low resolution grid beginning point and uniformly increases along some spacing until one ils_half_width past the end of the lowe resolution grid.

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 19 of file uniform_spectrum_sampling.h.

Constructor & Destructor Documentation

◆ UniformSpectrumSampling()

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

Definition at line 21 of file uniform_spectrum_sampling.h.

◆ ~UniformSpectrumSampling()

virtual FullPhysics::UniformSpectrumSampling::~UniformSpectrumSampling ( )
inlinevirtual

Definition at line 24 of file uniform_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 UniformSpectrumSampling::print ( std::ostream &  Os) const
virtual

Print to stream.

Reimplemented from FullPhysics::SpectrumSampling.

Definition at line 64 of file uniform_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()

SpectralDomain UniformSpectrumSampling::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 8 of file uniform_spectrum_sampling.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:14