SubsurfacePoint
- class pyarts3.arts.SubsurfacePoint(*args, **kwargs)
A subsurface point.
This keeps three things:
The subsurface temperature as
Numeric
.The subsurface density as
Numeric
.A map of the same keys as
SubsurfaceField
(bar those inSubsurfaceKey
that are extracted as above) but towardsNumeric
data.
Overview
Method
Available keys
Method
Read variable from file.
Method
Saves variable to file.
Static Method
Create variable from file.
Density [kg/m^3]
Properties of the subsurface point
Temperature [K]
Operator
Return self==value.
Operator
__format__(self, arg: str, /) -> str
Operator
Return self>=value.
Operator
__getitem__(self, arg: pyarts3.arts.SubsurfaceKey | pyarts3.arts.SubsurfacePropertyTag, /) -> float
Operator
Helper for pickle.
Operator
Return self>value.
Operator
Return hash(self).
Operator
__init__(self, arg: pyarts3.arts.SubsurfacePoint) -> None
Operator
Return self<=value.
Operator
Return self<value.
Operator
Return self!=value.
Operator
__repr__(self) -> str
Operator
__setitem__(self, arg0: pyarts3.arts.SubsurfaceKey | pyarts3.arts.SubsurfacePropertyTag, arg1: float, /) -> None
Operator
__str__(self) -> str
Constructors
- __init__(self) None
- __init__(self, arg: pyarts3.arts.SubsurfacePoint) 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:
- 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:
Static Methods
- fromxml(file: str) pyarts3.arts.SubsurfacePoint
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
- prop: dict[SubsurfacePropertyTag, Numeric]
Properties of the subsurface point
Operators
- __eq__(value, /)
Return self==value.
- __ge__(value, /)
Return self>=value.
- __getitem__(self, arg: pyarts3.arts.SubsurfaceKey | pyarts3.arts.SubsurfacePropertyTag, /) float
- __getstate__()
Helper for pickle.
- __gt__(value, /)
Return self>value.
- __hash__()
Return hash(self).
- __init__(self) None
- __init__(self, arg: pyarts3.arts.SubsurfacePoint) None
- __le__(value, /)
Return self<=value.
- __lt__(value, /)
Return self<value.
- __ne__(value, /)
Return self!=value.
- __setitem__(self, arg0: pyarts3.arts.SubsurfaceKey | pyarts3.arts.SubsurfacePropertyTag, arg1: float, /) None