SubsurfaceData

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

A data structure for subsurface field information.

This includes:

A data field that is one of Numeric, GeodeticField3, or NumericTernaryOperator.
InterpolationExtrapolation flags indicating how to extrapolate the data field in its interpolation routine.

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Method	`set_extrapolation()`	Set the extrapolation for all dimensions
Method	`ws()`	Get the weights of neighbors at a position
Static Method	`fromxml()`	Create variable from file.
`InterpolationExtrapolation`	`alt_low`	Lower altitude limit
`InterpolationExtrapolation`	`alt_upp`	Upper altitude limit
`GeodeticField3` or `Numeric` or `NumericTernaryOperator`	`data`	The data.
`String`	`data_type`	The data type
`InterpolationExtrapolation`	`lat_low`	Lower latitude limit
`InterpolationExtrapolation`	`lat_upp`	Upper latitude limit
`InterpolationExtrapolation`	`lon_low`	Lower longitude limit
`InterpolationExtrapolation`	`lon_upp`	Upper longitude limit
Operator	`__call__()`	Get a point of data at the position
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__getstate__()`	__getstate__(self) -> tuple[pyarts3.arts.GeodeticField3 \| float \| pyarts3.arts.NumericTernaryOperator, pyarts3.arts.InterpolationExtrapolation, pyarts3.arts.InterpolationExtrapolation, pyarts3.arts.InterpolationExtrapolation, pyarts3.arts.InterpolationExtrapolation, pyarts3.arts.InterpolationExtrapolation, pyarts3.arts.InterpolationExtrapolation]
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	Overloaded function.
Operator	`__le__()`	Return self<=value.
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__setstate__()`	__setstate__(self, arg: tuple[pyarts3.arts.GeodeticField3 \| float \| pyarts3.arts.NumericTernaryOperator, pyarts3.arts.InterpolationExtrapolation, pyarts3.arts.InterpolationExtrapolation, pyarts3.arts.InterpolationExtrapolation, pyarts3.arts.InterpolationExtrapolation, pyarts3.arts.InterpolationExtrapolation, pyarts3.arts.InterpolationExtrapolation], /) -> None
Operator	`__str__()`	__str__(self) -> str

Constructors

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

__init__(self, arg: float, /) → None

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

__init__(self, v: pyarts3.arts.GriddedField3) → None

__init__(self) → None

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

Overloaded function.

__init__(self, arg: pyarts3.arts.GeodeticField3, /) -> None
__init__(self, arg: float, /) -> None
__init__(self, arg: pyarts3.arts.NumericTernaryOperator, /) -> None
__init__(self, v: pyarts3.arts.GriddedField3) -> None

Initialize with a gridded field

__init__(self) -> None
__init__(self, arg: pyarts3.arts.SubsurfaceData) -> 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: