SubsurfaceField

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

A sub-surface field.

A sub-surface field effectively holds two things:

1. A Numeric of the deepest depth of the subsurface. Unit: m

2. A map of SubsurfaceData. The available types of keys are:

   1. SubsurfaceKey

   2. SubsurfacePropertyTag

   See each key for more information on what type of data it allows holding.

Workspace variables of type SubsurfaceField

subsurf_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.
Numeric	bottom_depth	The depth of the bottom of the subsurface [m]
dict[SubsurfaceKey, SubsurfaceData]	other	Other data in the subsurface field
dict[SubsurfacePropertyTag, SubsurfaceData]	props	Properties of the subsurface field
Operator	__call__()	Overloaded function.
Operator	__contains__()	__contains__(self, arg: pyarts3.arts.SubsurfaceKey | pyarts3.arts.SubsurfacePropertyTag, /) -> bool
Operator	__eq__()	Return self==value.
Operator	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	Return self>=value.
Operator	__getitem__()	__getitem__(self, arg: pyarts3.arts.SubsurfaceKey | pyarts3.arts.SubsurfacePropertyTag, /) -> pyarts3.arts.SubsurfaceData
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	__init__(self, arg: pyarts3.arts.SubsurfaceField) -> 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.SubsurfaceKey | pyarts3.arts.SubsurfacePropertyTag, arg1: pyarts3.arts.SubsurfaceData, /) -> None
Operator	__str__()	__str__(self) -> str

Constructors

__init__(self, bottom_depth: float) → None

__init__(self) → None

__init__(self, arg: pyarts3.arts.SubsurfaceField) → None

Methods

keys(self) → list[pyarts3.arts.SubsurfaceKey | pyarts3.arts.SubsurfacePropertyTag]

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:

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

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

Attributes

bottom_depth: Numeric

The depth of the bottom of the subsurface [m]

other: dict[SubsurfaceKey, SubsurfaceData]

Other data in the subsurface field

props: dict[SubsurfacePropertyTag, SubsurfaceData]

Properties of the subsurface field

Operators

__call__(self, alt: float, lat: float, lon: float) → pyarts3.arts.SubsurfacePoint

__call__(self, h: pyarts3.arts.Vector, lat: pyarts3.arts.Vector, lon: pyarts3.arts.Vector) → pyarts3.arts.ArrayOfSubsurfacePoint

Overloaded function.

1. __call__(self, alt: float, lat: float, lon: float) -> pyarts3.arts.SubsurfacePoint

Get a point of data at the position

2. __call__(self, h: pyarts3.arts.Vector, lat: pyarts3.arts.Vector, lon: pyarts3.arts.Vector) -> pyarts3.arts.ArrayOfSubsurfacePoint

Get the data as a list

__contains__(self, arg: pyarts3.arts.SubsurfaceKey | pyarts3.arts.SubsurfacePropertyTag, /) → bool

__eq__(value, /)

Return self==value.

__format__(self, arg: str, /) → str

__ge__(value, /)

Return self>=value.

__getitem__(self, arg: pyarts3.arts.SubsurfaceKey | pyarts3.arts.SubsurfacePropertyTag, /) → pyarts3.arts.SubsurfaceData

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self, bottom_depth: float) → None

__init__(self) → None

__init__(self, arg: pyarts3.arts.SubsurfaceField) → None

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

__setitem__(self, arg0: pyarts3.arts.SubsurfaceKey | pyarts3.arts.SubsurfacePropertyTag, arg1: pyarts3.arts.SubsurfaceData, /) → None

__str__(self) → str