ARTS 2.5.0 (git: 9ee3ac6c)
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. More...
 
template<Type t>
OurHitranMap select_hitran_map ()
 Selects the map and returns it. More...
 
template<Type t>
QuantumIdentifier from_mol_iso (Index molnum, char isonum)
 Returns the species if possible or throws an error if it cannot be found. More...
 
QuantumIdentifier id_from_lookup (Index mol, char isochar, Type type)
 
Numeric ratio_from_lookup (Index mol, char isochar, Type type)
 Finds the isotopologue ratio of the species from HITRAN. More...
 
SpeciesIsotopologueRatios isotopologue_ratios_impl (const HitranMap &data)
 
SpeciesIsotopologueRatios isotopologue_ratios (Type type)
 
 ENUMCLASS (Type, char, Pre2012CO2Change, Newest) QuantumIdentifier id_from_lookup(Index mol
 Hitran type for selection of data map. More...
 

Variables

const HitranMap pre2012co2change_molparam_map
 In 2012 the order if isotopologues were changed in HITRAN. More...
 
const HitranMap latest_molparam_map
 The latest version of the HITRAN online molparam.txt file as a map. More...
 
char isochar
 
char Type type
 

Typedef Documentation

◆ HitranMap

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

Definition at line 10 of file hitran_species.cc.

◆ OurHitranMap

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

Definition at line 495 of file hitran_species.cc.

Function Documentation

◆ ENUMCLASS()

Hitran::ENUMCLASS ( Type  ,
char  ,
Pre2012CO2Change  ,
Newest   
)

Hitran type for selection of data map.

Note that this should be appended as few time as possible.

Each type here has to correspond to a data-map in the .cc-file

Only add a new type here if HITRAN changes significantly the interpretation of their data Finds the ID of the ARTS species from HITRAN

◆ from_mol_iso()

template<Type t>
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 544 of file hitran_species.cc.

References ARTS_USER_ERROR, and good_enum().

◆ id_from_lookup()

◆ isotopologue_ratios()

◆ isotopologue_ratios_impl()

SpeciesIsotopologueRatios Hitran::isotopologue_ratios_impl ( const HitranMap data)

Definition at line 591 of file hitran_species.cc.

References data, and Species::IsotopologueRatios::data.

Referenced by isotopologue_ratios().

◆ ratio_from_lookup()

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

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 580 of file hitran_species.cc.

References isochar, latest_molparam_map, pre2012co2change_molparam_map, and type.

◆ select_hitran_map()

template<Type t>
OurHitranMap Hitran::select_hitran_map ( )

Selects the map and returns it.

Uses templates to avoid weird warnings

Definition at line 515 of file hitran_species.cc.

References good_enum(), latest_molparam_map, pre2012co2change_molparam_map, and to_species_map().

◆ 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 500 of file hitran_species.cc.

References ARTS_ASSERT, isot, and Species::Isotopologues.

Referenced by select_hitran_map().

Variable Documentation

◆ isochar

char Hitran::isochar

Definition at line 22 of file hitran_species.h.

Referenced by id_from_lookup(), and ratio_from_lookup().

◆ latest_molparam_map

const HitranMap Hitran::latest_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

Definition at line 260 of file hitran_species.cc.

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

◆ pre2012co2change_molparam_map

const HitranMap Hitran::pre2012co2change_molparam_map

In 2012 the order if isotopologues were changed in HITRAN.

This version takes that into account. Note that the other species are left as they were in the latest_molparam_map map at the time of creating this file (2021-03-10)

Definition at line 18 of file hitran_species.cc.

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

◆ type

char Type Hitran::type

Definition at line 22 of file hitran_species.h.

Referenced by abs_lines_per_speciesSetCutoff(), abs_lines_per_speciesSetCutoffForMatch(), abs_lines_per_speciesSetCutoffForSpecies(), abs_lines_per_speciesSetLineShapeType(), abs_lines_per_speciesSetLineShapeTypeForMatch(), abs_lines_per_speciesSetLineShapeTypeForSpecies(), abs_lines_per_speciesSetMirroring(), abs_lines_per_speciesSetMirroringForMatch(), abs_lines_per_speciesSetMirroringForSpecies(), abs_lines_per_speciesSetNormalization(), abs_lines_per_speciesSetNormalizationForMatch(), abs_lines_per_speciesSetNormalizationForSpecies(), abs_lines_per_speciesSetPopulation(), abs_lines_per_speciesSetPopulationForMatch(), abs_lines_per_speciesSetPopulationForSpecies(), abs_linesSetCutoff(), abs_linesSetCutoffForMatch(), abs_linesSetLineShapeType(), abs_linesSetLineShapeTypeForMatch(), abs_linesSetMirroring(), abs_linesSetMirroringForMatch(), abs_linesSetNormalization(), abs_linesSetNormalizationForMatch(), abs_linesSetPopulation(), abs_linesSetPopulationForMatch(), abs_linesSetZeemanCoefficients(), ArrayOfSpeciesTag::ArrayOfSpeciesTag(), c_errmsg(), LineShape::Calculator::Calculator(), check_continuum_model(), check_enum_error(), lm_hitran_2017::compute(), cumulative_transmission(), Interpolation::dl_dval(), Interpolation::Lagrange::dlx_finder(), Interpolation::FixedLagrange< PolyOrder >::dlx_finder(), Zeeman::dM(), Zeeman::end(), energylevelmaptype2string(), Quantum::ENUMCLASS(), Jacobian::ENUMCLASS(), Species::ENUMCLASS(), find_nonlinear_continua(), LineShape::from_linemixingdata(), LineShape::from_pressurebroadeningdata(), id_from_lookup(), oem::ArtsLog< type >::init(), isotopologue_ratios(), Interpolation::LagrangeVector(), LineShape::LegacyLineFunctionData::linemixingtag2variablesvector(), LineShape::LegacyLineFunctionData::lineshapetag2variablesvector(), Interpolation::Lagrange::lx_finder(), Interpolation::FixedLagrange< PolyOrder >::lx_finder(), Zeeman::Ml(), Zeeman::Mu(), nca_def_var(), nca_read_from_file(), nca_write_to_file(), Zeeman::nelem(), LineShape::Model::OK(), Zeeman::PolarizationFactor(), psd_mono_common(), ratio_from_lookup(), select_dims_by_size(), Zeeman::SelectPolarization(), LineShape::SingleModelParameter(), Zeeman::start(), oem::ArtsLog< type >::step(), Zeeman::Model::Strength(), Absorption::Lines::string2LineShapeType(), LineShape::LegacyLineMixingData::string2typelm(), LineShape::LegacyPressureBroadeningData::string2typepb(), LineShape::LegacyLineFunctionData::temperaturemodel2legacynelem(), test_hitran2017(), time_stepper_selection(), LineShape::LegacyLineMixingData::typelm2nelem(), LineShape::LegacyPressureBroadeningData::typepb2nelem(), LineShape::LegacyLineMixingData::vector2modellm(), LineShape::LegacyPressureBroadeningData::vector2modelpb(), xml_read_from_file(), xml_read_from_file_base(), xml_read_from_stream(), xml_write_to_file(), and xml_write_to_file_base().