ReFRACtor
FullPhysics::ForwardModelSpectralGrid Class Reference

This is the Forward Model spectral grid. More...

#include <forward_model_spectral_grid.h>

+ Inheritance diagram for FullPhysics::ForwardModelSpectralGrid:
+ Collaboration diagram for FullPhysics::ForwardModelSpectralGrid:

Public Member Functions

 ForwardModelSpectralGrid (const boost::shared_ptr< Instrument > &Inst, const boost::shared_ptr< SpectralWindow > &Spectral_window, const boost::shared_ptr< SpectrumSampling > &Spectrum_sampling)
 
 ForwardModelSpectralGrid ()
 
virtual ~ForwardModelSpectralGrid ()
 
const SpectralDomain high_resolution_grid (int Spec_index) const
 The high resolution grid, possibly nonuniform. More...
 
const SpectralDomain high_resolution_interpolated_grid (int Spec_index) const
 The high resolution grid, interpolated to be uniform. More...
 
Spectrum interpolate_spectrum (const Spectrum &Spec_in, int Spec_index) const
 Interpolate a spectrum to the high_resolution_interpolated_grid() sampling. More...
 
const SpectralDomain low_resolution_grid (int Spec_index) const
 The low resolution grid. More...
 
int number_spectrometer () const
 Number of spectrometer. More...
 
const std::vector< int > pixel_list (int Spec_index) const
 Pixel indexes to use for low resolution grid. More...
 
virtual void print (std::ostream &Os) const
 
std::string print_to_string () const
 Print to string. More...
 

Detailed Description

This is the Forward Model spectral grid.

This is in a separate class because this is a bit complicated. We have 3 grids to worry about

  1. The low resolution grid, which is the ultimate output of the ForwardModel.
  2. The high resolution grid, which is where we calculate the RT on. This is the spectrum before we have convolved it with Ils. Depending on the options used, this grid might be nonuniform.
  3. The high resolution grid we interpolate to. If we are not doing nonuniform sampling, then this is the same as the high 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 29 of file forward_model_spectral_grid.h.

Constructor & Destructor Documentation

◆ ForwardModelSpectralGrid() [1/2]

FullPhysics::ForwardModelSpectralGrid::ForwardModelSpectralGrid ( const boost::shared_ptr< Instrument > &  Inst,
const boost::shared_ptr< SpectralWindow > &  Spectral_window,
const boost::shared_ptr< SpectrumSampling > &  Spectrum_sampling 
)
inline

Definition at line 31 of file forward_model_spectral_grid.h.

◆ ForwardModelSpectralGrid() [2/2]

FullPhysics::ForwardModelSpectralGrid::ForwardModelSpectralGrid ( )
inline

Definition at line 37 of file forward_model_spectral_grid.h.

◆ ~ForwardModelSpectralGrid()

virtual FullPhysics::ForwardModelSpectralGrid::~ForwardModelSpectralGrid ( )
inlinevirtual

Definition at line 38 of file forward_model_spectral_grid.h.

Member Function Documentation

◆ high_resolution_grid()

const SpectralDomain ForwardModelSpectralGrid::high_resolution_grid ( int  Spec_index) const

The high resolution grid, possibly nonuniform.

Definition at line 33 of file forward_model_spectral_grid.cc.

◆ high_resolution_interpolated_grid()

const SpectralDomain ForwardModelSpectralGrid::high_resolution_interpolated_grid ( int  Spec_index) const

The high resolution grid, interpolated to be uniform.

Definition at line 49 of file forward_model_spectral_grid.cc.

◆ interpolate_spectrum()

Spectrum ForwardModelSpectralGrid::interpolate_spectrum ( const Spectrum Spec_in,
int  Spec_index 
) const

Interpolate a spectrum to the high_resolution_interpolated_grid() sampling.

Definition at line 75 of file forward_model_spectral_grid.cc.

◆ low_resolution_grid()

const SpectralDomain ForwardModelSpectralGrid::low_resolution_grid ( int  Spec_index) const

The low resolution grid.

Definition at line 17 of file forward_model_spectral_grid.cc.

◆ number_spectrometer()

int FullPhysics::ForwardModelSpectralGrid::number_spectrometer ( ) const
inline

Number of spectrometer.

Definition at line 45 of file forward_model_spectral_grid.h.

◆ pixel_list()

const std::vector< int > ForwardModelSpectralGrid::pixel_list ( int  Spec_index) const

Pixel indexes to use for low resolution grid.

Definition at line 64 of file forward_model_spectral_grid.cc.

◆ print()

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

Definition at line 39 of file forward_model_spectral_grid.h.

◆ print_to_string()

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


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