atm_fieldAppendCIASpeciesData

Workspace.atm_fieldAppendCIASpeciesData(self, atm_field: AtmField = self.atm_field, abs_cia_data: CIARecords = self.abs_cia_data, basename: String, extrapolation: String = Linear, missing_is_zero: Index = 0, replace_existing: Index = 0) → None

Append species data to the atmospheric field based on collision-induced absorption data.

This will look at the valid basename for files matching base data. The base data file names are of the short-name form: “species1.xml” “species2.xml” (e.g., “H2O.xml” “CO2.xml”). See SpeciesEnum for valid short names.

See InterpolationExtrapolation for valid extrapolation.

The missing_is_zero sets missing data to zero.

The replace_existing is used to determine if the data should be replaced if it already exists in the atmospheric field.

Author: Richard Larsson

Parameters:

  • atm_field (~pyarts3.arts.AtmField, optional) – An atmospheric field in ARTS, this is the main atmospheric data structure in ARTS. Defaults to self.atm_field. [INOUT]

  • abs_cia_data (~pyarts3.arts.CIARecords, optional) – HITRAN Collision-Induced Absorption (CIA) Data. Defaults to self.abs_cia_data. [IN]

  • basename (String) – The base name of the files. [IN]

  • extrapolation (~pyarts3.arts.String, optional) – The extrapolation to use. Defaults to "Linear" [IN]

  • missing_is_zero (~pyarts3.arts.Index, optional) – Whether or not to zero-out missing data. Defaults to 0 [IN]

  • replace_existing (~pyarts3.arts.Index, optional) – Whether or not to replace existing data. Defaults to 0 [IN]