AtmData
- class pyarts3.arts.AtmData(*args, **kwargs)
An atmospheric data field.
Each atmospheric data field can be mapped to a single altitude-latitude-longitude coordinate, producing a
Numeric
value at that point in the atmosphere.It holds essentially two things:
Rules for how to extrapolate the data in the six directions of the atmosphere (up, down, north, south, east, west).
A data field. This data field is one of the following types:
Numeric
- The data field is constant in the atmosphere. Cannot consider the extrapolation rules as there is no grid.GeodeticField3
- The grids are altitude, latitude, longitude. Will consider the extrapolation rules but otherwise performs linear interpolation between all points. With the additional rule that longitude is considerd cyclic around [-180, 180).NumericTernaryOperator
- The data field has functional form. Cannot consider the extrapolation rules as there is no grid.
Overview
Method
Read variable from file.
Method
Regrid the data to a new grid.
Method
Saves variable to file.
Method
Set the extrapolation for all dimensions
Method
Get the weights of neighbors at a position
Static Method
Create variable from file.
Lower altitude limit
Upper altitude limit
The data.
The data type
Lower latitude limit
Upper latitude limit
Lower longitude limit
Upper longitude limit
Operator
Get a point of data at the position
Operator
Return self==value.
Operator
__format__(self, arg: str, /) -> str
Operator
Return self>=value.
Operator
__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
Return self>value.
Operator
Return hash(self).
Operator
Overloaded function.
Operator
Return self<=value.
Operator
Return self<value.
Operator
Return self!=value.
Operator
__repr__(self) -> str
Operator
__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__(self) -> str
Constructors
- __init__(self) None
- __init__(self, arg: pyarts3.arts.AtmData) None
- __init__(self, arg: pyarts3.arts.GeodeticField3, /) None
- __init__(self, arg: float, /) None
- __init__(self, arg: pyarts3.arts.NumericTernaryOperator, /) None
- __init__(self, arg: pyarts3.arts.GeodeticField3, /) None
- __init__(self, v: pyarts3.arts.GriddedField3) None
- __init__(self, v: pyarts3.arts.SortedGriddedField3) None
Overloaded function.
__init__(self) -> None
__init__(self, arg: pyarts3.arts.AtmData) -> None
__init__(self, arg: pyarts3.arts.GeodeticField3, /) -> None
__init__(self, arg: float, /) -> None
__init__(self, arg: pyarts3.arts.NumericTernaryOperator, /) -> None
__init__(self, arg: pyarts3.arts.GeodeticField3, /) -> None
__init__(self, v: pyarts3.arts.GriddedField3) -> None
Initialize with a gridded field
__init__(self, v: pyarts3.arts.SortedGriddedField3) -> None
Initialize with a gridded field
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:
- regrid(self, alt: pyarts3.arts.AscendingGrid, lat: pyarts3.arts.LatGrid, lon: pyarts3.arts.LonGrid, extrapolation: pyarts3.arts.InterpolationExtrapolation = 'Nearest') None
Regrid the data to a new grid.
This will convert the data to a GeodeticField3 if it is not already. It will not respect the existing extrapolation settings, so these must be set manually after calling this method.
- Parameters:
alt (AscendingGrid) – The new altitude grid.
lat (LatGrid) – The new latitude grid.
lon (LonGrid) – The new longitude grid.
extrapolation (InterpolationExtrapolation) – The extrapolation method to use. Defaults to Nearest
- 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:
- set_extrapolation(self, extrapolation: pyarts3.arts.InterpolationExtrapolation) None
Set the extrapolation for all dimensions
- ws(self, alt: float, lat: float, lon: float) list[tuple[int, float]]
Get the weights of neighbors at a position
Static Methods
- fromxml(file: str) pyarts3.arts.AtmData
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
- alt_low: InterpolationExtrapolation
Lower altitude limit
- alt_upp: InterpolationExtrapolation
Upper altitude limit
- data: GeodeticField3 | Numeric | NumericTernaryOperator
The data.
- lat_low: InterpolationExtrapolation
Lower latitude limit
- lat_upp: InterpolationExtrapolation
Upper latitude limit
- lon_low: InterpolationExtrapolation
Lower longitude limit
- lon_upp: InterpolationExtrapolation
Upper longitude limit
Operators
- __eq__(value, /)
Return self==value.
- __ge__(value, /)
Return self>=value.
- __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]
- __gt__(value, /)
Return self>value.
- __hash__()
Return hash(self).
- __init__(self) None
- __init__(self, arg: pyarts3.arts.AtmData) None
- __init__(self, arg: pyarts3.arts.GeodeticField3, /) None
- __init__(self, arg: float, /) None
- __init__(self, arg: pyarts3.arts.NumericTernaryOperator, /) None
- __init__(self, arg: pyarts3.arts.GeodeticField3, /) None
- __init__(self, v: pyarts3.arts.GriddedField3) None
- __init__(self, v: pyarts3.arts.SortedGriddedField3) None
Overloaded function.
__init__(self) -> None
__init__(self, arg: pyarts3.arts.AtmData) -> None
__init__(self, arg: pyarts3.arts.GeodeticField3, /) -> None
__init__(self, arg: float, /) -> None
__init__(self, arg: pyarts3.arts.NumericTernaryOperator, /) -> None
__init__(self, arg: pyarts3.arts.GeodeticField3, /) -> None
__init__(self, v: pyarts3.arts.GriddedField3) -> None
Initialize with a gridded field
__init__(self, v: pyarts3.arts.SortedGriddedField3) -> None
Initialize with a gridded field
- __le__(value, /)
Return self<=value.
- __lt__(value, /)
Return self<value.
- __ne__(value, /)
Return self!=value.
- __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