absorption_speciesSet

Workspace.absorption_speciesSet(self, absorption_species: pyarts.arts.ArrayOfArrayOfSpeciesTag | None = None, species: pyarts.arts.ArrayOfString | None = None) → None

Set up a list of absorption species tag groups.

Workspace variables like absorption_species contain several tag groups. Each tag group contains one or more tags. This method converts descriptions of tag groups given in the keyword to the ARTS internal representation (an ArrayOfArrayOfSpeciesTag). A tag group selects spectral features which belong to the same species.

A tag is defined in terms of the name of the species, isotopologue, and a range of frequencies. Species are named after the standard chemical names, e.g., "O3". Isotopologues are given by the last digit of the atomic weight, i.g., "O3-668" for the asymmetric ozone molecule including an oxygen 18 atom. Groups of transitions are specified by giving a lower and upper limit of a frequency range, e.g., "O3-666-500e9-501e9".

The symbol "*" acts as a wild card. Furthermore, frequency range or frequency range and isotopologue may be omitted.

Example:

>>> species = [ "O3-666-500e9-501e9, O3-686", "O3", "H2O-PWR98" ]

The first tag group selects all O3-666 lines between 500 and 501 GHz plus all O3-686 lines.

The second tag group selects all remaining O3 transitions.

The third tag group selects H2O, with one of the complete absorption models (Rosenkranz 98). No spectrocopic line catalogue data will be used for that third tag group. For more available full absorption models see propagation_matrixAddPredefined()

Note that order of tag groups in the species list matters. In our example, changing the order of the first two tag group will give different results: as "O3" already selects all O3 transitions, no lines will remain to be selected by the "O3-666-500e9-501e9, O3-686" tag.

For CIA species the tag consists of the two involved species and a dataset index. CIA species can be defined for multiple regions The dataset index determines which region to use from the corresponding CIARecord in absorption_cia_data.

Example

>>> species = [ "N2-CIA-N2-0, N2-CIA-N2-1" ]

For Hitran cross section species the tag consists of the species and the tagtype XFIT, e.g. CFC11-XFIT. The data for the species must be available in the absorption_xsec_fit_data variable.

Author(s): Stefan Buehler

Parameters:

  • absorption_species (ArrayOfArrayOfSpeciesTag, optional) – Tag groups for gas absorption. See absorption_species, defaults to self.absorption_species [OUT]

  • species (ArrayOfString) – Specify one String for each tag group that you want to create. Inside the String, separate the tags by commas (plus optional blanks). [IN]