HitranLineStrengthOption

class pyarts.arts.HitranLineStrengthOption(*args, **kwargs)

Group name: “HitranLineStrengthOption”

The way line strength is computed in ARTS when reading Hitran data.

ARTS uses Einstein A-coefficients to compute the line strength. Hitran provides both the line strength and the Einstein A-coefficient. There is a 1-to-1 conversion between these two. However, as with all data, the numbers might differ slightly even if good cases, so we have provide this selection mechanism to make them match.

Valid options:

  • "S" or "s" or "strenght" or "s0" or "S0": Line strength

  • "A" or "a" or "einstein" or "ein" or "A0": Absorption intensity

Overview

Method

readxml()

Read variable from file

Method

savexml()

Saves variable to file

Static Method

fromxml()

Create variable from file

Static Method

get_options()

Get a list of all options

Static Method

get_options_as_strings()

Get a list of all options as strings

Static Data

pyarts.arts.HitranLineStrengthOption.A

“A” - HitranLineStrengthOption

Static Data

pyarts.arts.HitranLineStrengthOption.A0

“A” - HitranLineStrengthOption

Static Data

pyarts.arts.HitranLineStrengthOption.S

“S” - HitranLineStrengthOption

Static Data

pyarts.arts.HitranLineStrengthOption.S0

“S” - HitranLineStrengthOption

Static Data

pyarts.arts.HitranLineStrengthOption.a

“A” - HitranLineStrengthOption

Static Data

pyarts.arts.HitranLineStrengthOption.ein

“A” - HitranLineStrengthOption

Static Data

pyarts.arts.HitranLineStrengthOption.einstein

“A” - HitranLineStrengthOption

Static Data

pyarts.arts.HitranLineStrengthOption.s

“S” - HitranLineStrengthOption

Static Data

pyarts.arts.HitranLineStrengthOption.s0

“S” - HitranLineStrengthOption

Static Data

pyarts.arts.HitranLineStrengthOption.strenght

“S” - HitranLineStrengthOption

Operator

__eq__()

self == other

Operator

__ge__()

self >= other

Operator

__getstate__()

__getstate__(self) -> tuple[str]

Operator

__gt__()

self > other

Operator

__hash__()

Allows hashing

Operator

__le__()

self <= other

Operator

__lt__()

self < other

Operator

__ne__()

self != other

Operator

__setstate__()

__setstate__(self, arg: tuple[str], /) -> None

Constructors

__init__(self) None
__init__(self, arg: pyarts.arts.HitranLineStrengthOption) None
__init__(self, arg: str, /) None

Methods

readxml(self, file: str) None

Read variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) None

Saves variable to file

Parameters:
  • file (str) – The path to which the file is written. Note that several of the options might modify the name or write more files

  • type (str) – Type of file to save. See FileType for options.

  • clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:

Throws RuntimeError for any failure to save

Static Methods

fromxml(file: str) pyarts.arts.HitranLineStrengthOption

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

get_options() list[pyarts.arts.HitranLineStrengthOption]

Get a list of all options

get_options_as_strings() list[str]

Get a list of all options as strings

Operators

__eq__(self, arg: pyarts.arts.HitranLineStrengthOption, /) bool

self == other

__ge__(self, arg: pyarts.arts.HitranLineStrengthOption, /) bool

self >= other

__getstate__(self) tuple[str]
__gt__(self, arg: pyarts.arts.HitranLineStrengthOption, /) bool

self > other

__hash__(self) int

Allows hashing

__le__(self, arg: pyarts.arts.HitranLineStrengthOption, /) bool

self <= other

__lt__(self, arg: pyarts.arts.HitranLineStrengthOption, /) bool

self < other

__ne__(self, arg: pyarts.arts.HitranLineStrengthOption, /) bool

self != other

__setstate__(self, arg: tuple[str], /) None