ARTS 2.5.0 (git: 9ee3ac6c)
XsecRecord Class Reference

#include <hitran_xsec.h>

Public Member Functions

Species::Species Species () const
 Return species index. More...
 
String SpeciesName () const
 Return species name. More...
 
void SetSpecies (const Species::Species species)
 Set species name. More...
 
ConstVectorView Coeffs () const
 Get coefficients. More...
 
ConstVectorView RefPressure () const
 Get reference pressures. More...
 
ConstVectorView RefTemperature () const
 Get reference temperatures. More...
 
const ArrayOfVectorFgrids () const
 Get frequency grids of cross sections. More...
 
const ArrayOfVectorXsecs () const
 Get cross sections. More...
 
const ArrayOfVectorTemperatureSlope () const
 Get slope of temperature fit. More...
 
const ArrayOfVectorTemperatureIntersect () const
 Get intersect of temperature fit. More...
 
VectorCoeffs ()
 Get coefficients. More...
 
VectorRefPressure ()
 Get reference pressures. More...
 
VectorRefTemperature ()
 Get reference temperatures. More...
 
ArrayOfVectorFgrids ()
 Get frequency grids of cross sections. More...
 
ArrayOfVectorXsecs ()
 Get cross sections. More...
 
ArrayOfVectorTemperatureSlope ()
 Get slope of temperature fit. More...
 
ArrayOfVectorTemperatureIntersect ()
 Get intersect of temperature fit. More...
 
void Extract (VectorView result, ConstVectorView f_grid, const Numeric &pressure, const Numeric &temperature, const Index &apply_tfit, const Verbosity &verbosity) const
 Interpolate cross section data. More...
 

Private Attributes

Species::Species mspecies
 
Vector mcoeffs
 
Vector mrefpressure
 
Vector mreftemperature
 
ArrayOfVector mfgrids
 
ArrayOfVector mxsecs
 
ArrayOfVector mtslope
 
ArrayOfVector mtintersect
 

Friends

void xml_read_from_stream (std::istream &is_xml, XsecRecord &cr, bifstream *pbifs, const Verbosity &verbosity)
 

Detailed Description

Definition at line 37 of file hitran_xsec.h.

Member Function Documentation

◆ Coeffs() [1/2]

Vector & XsecRecord::Coeffs ( )
inline

Get coefficients.

Definition at line 70 of file hitran_xsec.h.

References mcoeffs.

◆ Coeffs() [2/2]

ConstVectorView XsecRecord::Coeffs ( ) const
inline

Get coefficients.

Definition at line 49 of file hitran_xsec.h.

References mcoeffs.

Referenced by xml_write_to_stream().

◆ Extract()

void XsecRecord::Extract ( VectorView  result,
ConstVectorView  f_grid,
const Numeric pressure,
const Numeric temperature,
const Index apply_tfit,
const Verbosity verbosity 
) const

Interpolate cross section data.

Interpolate Xsec data to given frequency vector and given scalar pressure. Uses third order interpolation in both coordinates, if grid length allows, otherwise lower order or no interpolation.

Parameters
[out]resultXsec value for given frequency grid and temperature.
[in]f_gridFrequency grid.
[in]pressureScalar pressure.
[in]temperatureScalar temperature.
[in]apply_tfitSet to 0 to not apply the temperature fit
[in]verbosityStandard verbosity object.

Definition at line 151 of file hitran_xsec.cc.

References ARTS_ASSERT, chk_interpolation_grids(), convolve(), CREATE_OUTS, func_2straights(), interpweights(), lorentz_pdf(), mcoeffs, mfgrids, mrefpressure, mreftemperature, mtintersect, mtslope, mxsecs, Array< base >::nelem(), ConstVectorView::nelem(), Absorption::nelem(), and Interpolation::reinterp().

Referenced by abs_xsec_per_speciesAddHitranXsec().

◆ Fgrids() [1/2]

ArrayOfVector & XsecRecord::Fgrids ( )
inline

Get frequency grids of cross sections.

Definition at line 79 of file hitran_xsec.h.

References mfgrids.

◆ Fgrids() [2/2]

const ArrayOfVector & XsecRecord::Fgrids ( ) const
inline

Get frequency grids of cross sections.

Definition at line 58 of file hitran_xsec.h.

References mfgrids.

Referenced by xml_write_to_stream().

◆ RefPressure() [1/2]

Vector & XsecRecord::RefPressure ( )
inline

Get reference pressures.

Definition at line 73 of file hitran_xsec.h.

References mrefpressure.

◆ RefPressure() [2/2]

ConstVectorView XsecRecord::RefPressure ( ) const
inline

Get reference pressures.

Definition at line 52 of file hitran_xsec.h.

References mrefpressure.

Referenced by xml_write_to_stream().

◆ RefTemperature() [1/2]

Vector & XsecRecord::RefTemperature ( )
inline

Get reference temperatures.

Definition at line 76 of file hitran_xsec.h.

References mreftemperature.

◆ RefTemperature() [2/2]

ConstVectorView XsecRecord::RefTemperature ( ) const
inline

Get reference temperatures.

Definition at line 55 of file hitran_xsec.h.

References mreftemperature.

Referenced by xml_write_to_stream().

◆ SetSpecies()

void XsecRecord::SetSpecies ( const Species::Species  species)
inline

Set species name.

Definition at line 46 of file hitran_xsec.h.

References mspecies.

◆ Species()

Species::Species XsecRecord::Species ( ) const
inline

Return species index.

Definition at line 40 of file hitran_xsec.h.

References mspecies.

Referenced by operator<<().

◆ SpeciesName()

String XsecRecord::SpeciesName ( ) const

Return species name.

Definition at line 53 of file hitran_xsec.cc.

References mspecies.

Referenced by xml_write_to_stream().

◆ TemperatureIntersect() [1/2]

ArrayOfVector & XsecRecord::TemperatureIntersect ( )
inline

Get intersect of temperature fit.

Definition at line 88 of file hitran_xsec.h.

References mtintersect.

◆ TemperatureIntersect() [2/2]

const ArrayOfVector & XsecRecord::TemperatureIntersect ( ) const
inline

Get intersect of temperature fit.

Definition at line 67 of file hitran_xsec.h.

References mtintersect.

Referenced by xml_write_to_stream().

◆ TemperatureSlope() [1/2]

ArrayOfVector & XsecRecord::TemperatureSlope ( )
inline

Get slope of temperature fit.

Definition at line 85 of file hitran_xsec.h.

References mtslope.

◆ TemperatureSlope() [2/2]

const ArrayOfVector & XsecRecord::TemperatureSlope ( ) const
inline

Get slope of temperature fit.

Definition at line 64 of file hitran_xsec.h.

References mtslope.

Referenced by xml_write_to_stream().

◆ Xsecs() [1/2]

ArrayOfVector & XsecRecord::Xsecs ( )
inline

Get cross sections.

Definition at line 82 of file hitran_xsec.h.

References mxsecs.

◆ Xsecs() [2/2]

const ArrayOfVector & XsecRecord::Xsecs ( ) const
inline

Get cross sections.

Definition at line 61 of file hitran_xsec.h.

References mxsecs.

Referenced by xml_write_to_stream().

Friends And Related Function Documentation

◆ xml_read_from_stream

void xml_read_from_stream ( std::istream &  is_xml,
XsecRecord cr,
bifstream pbifs,
const Verbosity verbosity 
)
friend

Member Data Documentation

◆ mcoeffs

Vector XsecRecord::mcoeffs
private

Definition at line 117 of file hitran_xsec.h.

Referenced by Coeffs(), Extract(), and xml_read_from_stream().

◆ mfgrids

ArrayOfVector XsecRecord::mfgrids
private

Definition at line 120 of file hitran_xsec.h.

Referenced by Extract(), Fgrids(), and xml_read_from_stream().

◆ mrefpressure

Vector XsecRecord::mrefpressure
private

Definition at line 118 of file hitran_xsec.h.

Referenced by Extract(), RefPressure(), and xml_read_from_stream().

◆ mreftemperature

Vector XsecRecord::mreftemperature
private

Definition at line 119 of file hitran_xsec.h.

Referenced by Extract(), RefTemperature(), and xml_read_from_stream().

◆ mspecies

Species::Species XsecRecord::mspecies
private

Definition at line 116 of file hitran_xsec.h.

Referenced by SetSpecies(), Species(), SpeciesName(), and xml_read_from_stream().

◆ mtintersect

ArrayOfVector XsecRecord::mtintersect
private

Definition at line 123 of file hitran_xsec.h.

Referenced by Extract(), TemperatureIntersect(), and xml_read_from_stream().

◆ mtslope

ArrayOfVector XsecRecord::mtslope
private

Definition at line 122 of file hitran_xsec.h.

Referenced by Extract(), TemperatureSlope(), and xml_read_from_stream().

◆ mxsecs

ArrayOfVector XsecRecord::mxsecs
private

Definition at line 121 of file hitran_xsec.h.

Referenced by Extract(), xml_read_from_stream(), and Xsecs().


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