Canoe
Comprehensive Atmosphere N' Ocean Engine
SpectralGridBase Class Reference

Base class for a collection of spectral grids. More...

#include <spectral_grid.hpp>

Inheritance diagram for SpectralGridBase:
[legend]

Public Member Functions

std::pair< Real, Real > ReadRangeFrom (YAML::Node const &my)
 Read the spectral range from a YAML node. More...
 

Public Attributes

std::vector< SpectralBinspec
 spectral grids More...
 
std::string unit_type
 defines the unit of the spectral grid More...
 

Detailed Description

Base class for a collection of spectral grids.

Definition at line 16 of file spectral_grid.hpp.

Member Function Documentation

◆ ReadRangeFrom()

std::pair< Real, Real > SpectralGridBase::ReadRangeFrom ( YAML::Node const &  my)

Read the spectral range from a YAML node.

Returns
[wave min, wave max]

wavenumber-range, wavelength-range, frequency-range, etc

Definition at line 13 of file spectral_grid.cpp.

Member Data Documentation

◆ spec

std::vector<SpectralBin> SpectralGridBase::spec

spectral grids

Definition at line 19 of file spectral_grid.hpp.

◆ unit_type

std::string SpectralGridBase::unit_type

defines the unit of the spectral grid

Choose from [wavenumber, wavelength, frequency]

Definition at line 24 of file spectral_grid.hpp.


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