SurfaceKey

class pyarts3.arts.SurfaceKey(*args, **kwargs)

A key to identify a surface property.

This is used to identify core components in the surface. See SurfaceField and SurfacePoint for its usage.

A core component must either be available or internal calculations will assume it has a value of 0 once the data is extracted. This might yield NaN or Inf values in relevant calculations. Or it might simply disable a functionality.

Valid options:

  • "h" or "elevation": Altitude [m]

  • "t" or "temperature": Temperature [K]

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

pyarts3.arts.SurfaceKey.elevation

“h” (SurfaceKey)

Static Data

pyarts3.arts.SurfaceKey.h

“h” (SurfaceKey)

Static Data

pyarts3.arts.SurfaceKey.t

“t” (SurfaceKey)

Static Data

pyarts3.arts.SurfaceKey.temperature

“t” (SurfaceKey)

Operator

__eq__()

self == other

Operator

__format__()

Default object formatter.

Operator

__ge__()

self >= other

Operator

__getstate__()

__getstate__(self) -> tuple[str]

Operator

__gt__()

self > other

Operator

__hash__()

Allows hashing

Operator

__init__()

__init__(self, arg: str, /) -> None

Operator

__le__()

self <= other

Operator

__lt__()

self < other

Operator

__ne__()

self != other

Operator

__repr__()

__repr__(self) -> str

Operator

__setstate__()

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

Operator

__str__()

__str__(self) -> str

Constructors

__init__(self) None
__init__(self, arg: pyarts3.arts.SurfaceKey) None
__init__(self, arg: str, /) None

Methods

readxml(self, file: str) str

Read variable from file.

Parameters:

file (str) – A file that can be read.

Raises:

RuntimeError – For any failure to read.

Returns:

file – The file path found (may differ from input due to environment variables).

Return type:

str

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

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, optional) – Type of file to save. See FileType for options. Defaults is “ascii”.

  • clobber (bool, optional) – Overwrite existing files or add new file with modified name? Defaults is True.

Raises:

RuntimeError – For any failure to write.

Returns:

file – The file saved. May differ from input.

Return type:

str

Static Methods

fromxml(file: str) pyarts3.arts.SurfaceKey

Create variable from file.

Parameters:

file (str) – A file that can be read

Raises:

RuntimeError – For any failure to read.

Returns:

artstype – The variable created from the file.

Return type:

T

get_options() list[pyarts3.arts.SurfaceKey]

Get a list of all options

get_options_as_strings() list[str]

Get a list of all options as strings

Operators

__eq__(self, arg: pyarts3.arts.SurfaceKey, /) bool

self == other

__format__(format_spec, /)

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__(self, arg: pyarts3.arts.SurfaceKey, /) bool

self >= other

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

self > other

__hash__(self) int

Allows hashing

__init__(self) None
__init__(self, arg: pyarts3.arts.SurfaceKey) None
__init__(self, arg: str, /) None
__le__(self, arg: pyarts3.arts.SurfaceKey, /) bool

self <= other

__lt__(self, arg: pyarts3.arts.SurfaceKey, /) bool

self < other

__ne__(self, arg: pyarts3.arts.SurfaceKey, /) bool

self != other

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