SurfaceField

class pyarts3.arts.SurfaceField(*args, **kwargs)

A surface field.

A surface field effectively holds two things:

A Vector2 of the ellipsoid. a and b parameters. Unit: m
A map of SurfaceData. The available types of keys are:
1. SurfaceKey - holds basic surface data like elevation and temperature.
2. SurfacePropertyTag - holds free-form surface properties. The type of data is free-form and depends on the surface model/method.

Workspace variables of type SurfaceField

surface_field

Overview

Method	`keys()`	Available keys
Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`Vector2`	`ellipsoid`	Ellipsoid parameters (semi-major axis, semi-minor axis)
`dict`[`SurfaceKey`, `SurfaceData`]	`other`	Other data in the surface field
`dict`[`SurfacePropertyTag`, `SurfaceData`]	`props`	Properties of the surface field
Operator	`__call__()`	Overloaded function.
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__getitem__()`	__getitem__(self, arg: pyarts3.arts.SurfaceKey \| pyarts3.arts.SurfacePropertyTag, /) -> pyarts3.arts.SurfaceData
Operator	`__getstate__()`	__getstate__(self) -> tuple[list[pyarts3.arts.SurfaceKey \| pyarts3.arts.SurfacePropertyTag], pyarts3.arts.ArrayOfSurfaceData]
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	__init__(self, arg: pyarts3.arts.SurfaceField) -> None
Operator	`__le__()`	Return self<=value.
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__setitem__()`	__setitem__(self, arg0: pyarts3.arts.SurfaceKey \| pyarts3.arts.SurfacePropertyTag, arg1: pyarts3.arts.SurfaceData, /) -> None
Operator	`__setstate__()`	__setstate__(self, arg: tuple[collections.abc.Sequence[pyarts3.arts.SurfaceKey \| pyarts3.arts.SurfacePropertyTag], pyarts3.arts.ArrayOfSurfaceData], /) -> None
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self, planet: str) → None
__init__(self) → None
__init__(self, arg: pyarts3.arts.SurfaceField) → None

Methods

keys(self) → list[pyarts3.arts.SurfaceKey | pyarts3.arts.SurfacePropertyTag]: Available keys

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: