QuantumIdentifier

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

An ID for an absorption species state

It contains information about the species and a set of quantum numbers and can thus be used to identify one of the following:

  1. a species

  2. an isotopologue of a species

  3. an absorption band of an isotopologue

  4. an absorption line of an isotopologue

  5. the energy level of absorption band(s) of an isotopologue

  6. the energy level of absorption line(s) of an isotopologue

Workspace methods that require QuantumIdentifier

Overview

Method

as_symbol()

Get the molecular symbol as often seen in literature

Method

readxml()

Read variable from file

Method

savexml()

Saves variable to file

Static Method

fromxml()

Create variable from file

Attribute

isotopologue

SpeciesIsotope The isotopologue

Attribute

isotopologue_index

int The isotopologue index

Attribute

state

QuantumNumberValueList The values that make up the state

Operator

__eq__()

__eq__(self, arg: pyarts.arts.QuantumIdentifier, /) -> bool

Operator

__ge__()

__ge__(self, arg: pyarts.arts.QuantumIdentifier, /) -> bool

Operator

__gt__()

__gt__(self, arg: pyarts.arts.QuantumIdentifier, /) -> bool

Operator

__hash__()

__hash__(self) -> int

Operator

__le__()

__le__(self, arg: pyarts.arts.QuantumIdentifier, /) -> bool

Operator

__lt__()

__lt__(self, arg: pyarts.arts.QuantumIdentifier, /) -> bool

Operator

__ne__()

__ne__(self, arg: pyarts.arts.QuantumIdentifier, /) -> bool

Constructors

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

Methods

as_symbol(self) str

Get the molecular symbol as often seen in literature :returns: symbol – The symbol representation :rtype: str

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.QuantumIdentifier

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

isotopologue

SpeciesIsotope The isotopologue

isotopologue_index

int The isotopologue index

state

QuantumNumberValueList The values that make up the state

Operators

__eq__(self, arg: pyarts.arts.QuantumIdentifier, /) bool
__ge__(self, arg: pyarts.arts.QuantumIdentifier, /) bool
__gt__(self, arg: pyarts.arts.QuantumIdentifier, /) bool
__hash__(self) int
__le__(self, arg: pyarts.arts.QuantumIdentifier, /) bool
__lt__(self, arg: pyarts.arts.QuantumIdentifier, /) bool
__ne__(self, arg: pyarts.arts.QuantumIdentifier, /) bool