SurfacePoint

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

A surface point.

This keeps four things:

1. The elevation in meters as Numeric.

2. The temperature in Kelvin as Numeric.

3. The local normal vector.

4. A map of the same keys as SurfaceField (bar those in SurfaceKey that are extracted as above) but towards Numeric data.

Note

It is required to keep the SurfaceField around if the reference ellipsoid is required.

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	elevation	Surface elevation [m]
Vector2	normal	Surface normal vector
Numeric	temperature	Temperature [K]
Operator	__contains__()	__contains__(self, arg: pyarts3.arts.SurfaceKey | pyarts3.arts.SurfacePropertyTag, /) -> 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.SurfaceKey | pyarts3.arts.SurfacePropertyTag, /) -> float
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	__init__(self, arg: pyarts3.arts.SurfacePoint) -> 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: float, /) -> None
Operator	__str__()	__str__(self) -> str

Constructors

__init__(self) → None

__init__(self, arg: SurfacePoint) → None

Methods

keys(self) → list[SurfaceKey | 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:

RuntimeError – For any failure to write.

Returns:

file – The file saved. May differ from input.

Return type:

str

Static Methods

fromxml(file: str) → SurfacePoint

Create variable from file.

Parameters:

file (str) – A file that can be read

Raises:

RuntimeError – For any failure to read.

Attributes

elevation: Numeric

Surface elevation [m]

normal: Vector2

Surface normal vector

temperature: Numeric

Temperature [K]

Operators

__contains__(self, arg: SurfaceKey | SurfacePropertyTag, /) → bool

__eq__(value, /)

Return self==value.

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

__ge__(value, /)

Return self>=value.

__getitem__(self, arg: SurfaceKey | SurfacePropertyTag, /) → float

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

__init__(self, arg: SurfacePoint) → None

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

__setitem__(self, arg0: SurfaceKey | SurfacePropertyTag, arg1: float, /) → None

__str__(self) → str