ARTS 2.5.11 (git: 6827797f)
Hitran Namespace Reference

Typedefs

using HitranMap = std::map< Index, std::map< char, std::pair< Index, Numeric > > >
 
using OurHitranMap = std::map< Index, std::map< char, Species::IsotopeRecord > >
 

Functions

OurHitranMap to_species_map (const HitranMap &string_map)
 Turns the string-map required at compile time into a species-map to be used as a static runtime map.
 
QuantumIdentifier from_mol_iso (Index molnum, char isonum)
 Returns the species if possible or throws an error if it cannot be found.
 
QuantumIdentifier id_from_lookup (Index mol, char isochar)
 Finds the ID of the ARTS species from HITRAN.
 
Numeric ratio_from_lookup (Index mol, char isochar)
 Finds the isotopologue ratio of the species from HITRAN.
 
SpeciesIsotopologueRatios isotopologue_ratios_impl (const HitranMap &data)
 
SpeciesIsotopologueRatios isotopologue_ratios ()
 

Variables

const HitranMap molparam_map
 The latest version of the HITRAN online molparam.txt file as a map.
 

Typedef Documentation

◆ HitranMap

using Hitran::HitranMap = typedef std::map<Index, std::map<char, std::pair<Index, Numeric> >>

Definition at line 9 of file hitran_species.cc.

◆ OurHitranMap

using Hitran::OurHitranMap = typedef std::map<Index, std::map<char, Species::IsotopeRecord> >

Definition at line 393 of file hitran_species.cc.

Function Documentation

◆ from_mol_iso()

QuantumIdentifier Hitran::from_mol_iso ( Index  molnum,
char  isonum 
)

Returns the species if possible or throws an error if it cannot be found.

Parameters
[in]molnumThe hitran molecular number
[in]isonumThe hitran character representing an isotopologue
Returns
An ARTS identifier of the species' as a transition

Definition at line 419 of file hitran_species.cc.

References ARTS_USER_ERROR, Species::find_species_index(), molparam_map, and to_species_map().

Referenced by id_from_lookup().

◆ id_from_lookup()

QuantumIdentifier Hitran::id_from_lookup ( Index  mol,
char  isochar 
)

◆ isotopologue_ratios()

◆ isotopologue_ratios_impl()

SpeciesIsotopologueRatios Hitran::isotopologue_ratios_impl ( const HitranMap data)

Definition at line 446 of file hitran_species.cc.

References Species::IsotopologueRatios::data.

Referenced by isotopologue_ratios().

◆ ratio_from_lookup()

Numeric Hitran::ratio_from_lookup ( Index  mol,
char  isochar 
)

Finds the isotopologue ratio of the species from HITRAN.

Requires that id_from_lookup is called first for any error handling to happen...

Definition at line 442 of file hitran_species.cc.

References molparam_map.

Referenced by Absorption::ReadFromHitran2001Stream(), Absorption::ReadFromHitran2004Stream(), Absorption::ReadFromHitranOnlineStream(), and Absorption::ReadFromLBLRTMStream().

◆ to_species_map()

OurHitranMap Hitran::to_species_map ( const HitranMap string_map)

Turns the string-map required at compile time into a species-map to be used as a static runtime map.

Definition at line 398 of file hitran_species.cc.

References ARTS_ASSERT, and Species::Isotopologues.

Referenced by from_mol_iso().

Variable Documentation

◆ molparam_map

const HitranMap Hitran::molparam_map

The latest version of the HITRAN online molparam.txt file as a map.

Note that ARTS does not use AFGL notation as HITRAN so several species has to be changed manually when recreating this map. Please keep the comments of this change around so that it is easy to do this recreation. Thanks!

To recreate this map, run the pyarts.hitran.gen_latest_molparam_map. If more species names mismatch between ARTS and HITRAN, do please add a comment to indicate this when you update this variable. If any isotopologue ratio is changed, or any isotopologue key (the char) is changed, also update methods.cc ReadHITRAN as it depends on this map for versions of Hitran

Last Updated: 2021-11-25

Definition at line 25 of file hitran_species.cc.

Referenced by from_mol_iso(), isotopologue_ratios(), and ratio_from_lookup().