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

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

Workspace variables of type SubsurfaceField

subsurface_field

Overview

Method	readxml()	Read variable from file
Method	savexml()	Saves variable to file
Static Method	fromxml()	Create variable from file
Attribute	bottom_depth	The depth of the bottom of the subsurface [m]
Attribute	other	Other data in the subsurface field
Operator	__eq__()	Return self==value.
Operator	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	Return self>=value.
Operator	__getstate__()	Helper for pickle.
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	__str__()	__str__(self) -> str

Constructors

__init__(self) → None

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

Methods

readxml(self, file: str) → str

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) → 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) – 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) → pyarts3.arts.SubsurfaceField

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

bottom_depth: Numeric

The depth of the bottom of the subsurface [m]

other: dict[SubsurfaceKey, SurfaceData]

Other data in the subsurface field

Operators

__eq__(value, /)

Return self==value.

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

__ge__(value, /)

Return self>=value.

__getstate__()

Helper for pickle.

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__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

__str__(self) → str