ArrayOfAtmPoint

class pyarts.arts.ArrayOfAtmPoint(*args, **kwargs)

A list of AtmPoint

Workspace variables of type ArrayOfAtmPoint

ray_path_atmospheric_point

Overview

Method	`append()`	Append arg to the end of the list.
Method	`clear()`	Remove all items from list.
Method	`extend()`	Extend self by appending elements from arg.
Method	`extend_in_pressure()`	Extend the atmosphere to a new pressure point.
Method	`field1D()`	Create an atmospheric field from a profile of atmospheric points.
Method	`insert()`	Insert object arg1 before index arg0.
Method	`pop()`	Remove and return item at index (default last).
Method	`readxml()`	Read variable from file
Method	`savexml()`	Saves variable to file
Method	`to_dict()`	Convert an array of atmospheric points to a dictionary.
Method	`update()`	Update the array of atmospheric points.
Static Method	`from_dict()`	Create an array of atmospheric points from a dictionary.
Static Method	`fromxml()`	Create variable from file
Operator	`__delitem__()`	__delitem__(self, arg: slice, /) -> None
Operator	`__eq__()`	Return self==value.
Operator	`__ge__()`	Return self>=value.
Operator	`__getitem__()`	__getitem__(self, arg: slice, /) -> pyarts.arts.ArrayOfAtmPoint
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__iter__()`	__iter__(self) -> collections.abc.Iterator[pyarts.arts.AtmPoint]
Operator	`__le__()`	Return self<=value.
Operator	`__len__()`	__len__(self) -> int
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__setitem__()`	__setitem__(self, arg0: slice, arg1: pyarts.arts.ArrayOfAtmPoint, /) -> None

Constructors

__init__(self) → None

__init__(self, arg: pyarts.arts.ArrayOfAtmPoint) → None

__init__(self, arg: collections.abc.Iterable[pyarts.arts.AtmPoint], /) → None

__init__(self) → None

__init__(self, arg: pyarts.arts.ArrayOfAtmPoint) → None

Overloaded function.

__init__(self) -> None

Default constructor

__init__(self, arg: pyarts.arts.ArrayOfAtmPoint) -> None

Copy constructor

__init__(self, arg: collections.abc.Iterable[pyarts.arts.AtmPoint], /) -> None

Construct from an iterable object

__init__(self) -> None
__init__(self, arg: pyarts.arts.ArrayOfAtmPoint) -> None

Methods

append(self, arg: pyarts.arts.AtmPoint, /) → None: Append arg to the end of the list.

clear(self) → None: Remove all items from list.

extend(self, arg: pyarts.arts.ArrayOfAtmPoint, /) → None: Extend self by appending elements from arg.

extend_in_pressure(self, pressure: float, extrapolation_type: pyarts.arts.InterpolationExtrapolation = 'Nearest', logarithmic: bool = True) → None

Extend the atmosphere to a new pressure point.

The logarithm of the pressure profile will be used as a pseudo-altitude coordinate in calling :method:`field1D`. The extrapolation type will be used for the new points, above and below the original profile (if necessary).

Parameters:

extrapolation_type (InterpolationExtrapolation) – The extrapolation type to use for the new points. Default is “Nearest”.
pressure (Numeric, optional) – The new pressure point.
logarithmic (bool, optional) – The grid should be extended as in logarithmic pressure. Default is True.

field1D(self, altitudes: pyarts.arts.AscendingGrid, extrap: pyarts.arts.InterpolationExtrapolation = 'Nearest') → pyarts.arts.AtmField

Create an atmospheric field from a profile of atmospheric points.

The field is a 1D profile

Parameters:

atm (ArrayOfAtmPoint) – The atmospheric profile.
altitudes (AscendingGrid) – The altitude grid
extrap (InterpolationExtrapolation, optional) – The extrapolation method to use for the new keys. Default is “Nearest”.

insert(self, arg0: int, arg1: pyarts.arts.AtmPoint, /) → None: Insert object arg1 before index arg0.

pop(self, index: int = -1) → pyarts.arts.AtmPoint: Remove and return item at index (default last).

readxml(self, file: str) → None

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) → None

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

to_dict(self, core: bool = True, specs: bool = True, isots: bool = True, nlte: bool = True, ssprops: bool = True) → dict[pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty, pyarts.arts.Vector]

Convert an array of atmospheric points to a dictionary.

Tip

The function stringify_keys() may be used to convert the dictionary keys to strings. This allows for easier manipulation of the data of the dictionary.

Parameters:

core (bool, optional) – If True, the core atmospheric data will be included (i.e., temperature, pressure, etc). Default is True.
specs (bool, optional) – If True, the species VMR data will be included. Default is True.
isots (bool, optional) – If True, the isotopologue ratio data will be included. Default is True.
nlte (bool, optional) – If True, the NLTE data will be included. Default is True.
ssprops (bool, optional) – If True, the scattering species properties data will be included. Default is True.

update(self, data: collections.abc.Mapping[pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty, pyarts.arts.Vector]) → None

Update the array of atmospheric points.

Tip

Each key-type of the dictionary is constructible from a str. So using a dictionary with string keys is possible.

Parameters:: data (dict) – A dictionary with keys as the atmospheric point keys and values.

Static Methods

from_dict(data: collections.abc.Mapping[pyarts.arts.AtmKey | pyarts.arts.SpeciesEnum | pyarts.arts.SpeciesIsotope | pyarts.arts.QuantumIdentifier | pyarts.arts.ScatteringSpeciesProperty, pyarts.arts.Vector], iso: pyarts.arts.IsoRatioOption = 'Builtin') → pyarts.arts.ArrayOfAtmPoint

Create an array of atmospheric points from a dictionary.

Tip

Each key-type of the dictionary is constructible from a str. So using a dictionary with string keys is possible.

Parameters:

data (dict) – A dictionary with keys as the atmospheric point keys and values.
iso (IsoRatioOption, optional) – The isotopologue ratio option to use. Default is “Builtin”. Use “None” to create points without isotopologue ratios.

fromxml(file: str) → pyarts.arts.ArrayOfAtmPoint

Create variable from file

Parameters:: file (str) – A file that can be read

On Error:: Throws RuntimeError for any failure to read

Operators

__delitem__(self, arg: int, /) → None
__delitem__(self, arg: slice, /) → None

__eq__(value, /): Return self==value.

__ge__(value, /): Return self>=value.

__getitem__(self, arg: int, /) → pyarts.arts.AtmPoint
__getitem__(self, arg: slice, /) → pyarts.arts.ArrayOfAtmPoint

__gt__(value, /): Return self>value.

__hash__(): Return hash(self).

__iter__(self) → collections.abc.Iterator[pyarts.arts.AtmPoint]

__le__(value, /): Return self<=value.

__len__(self) → int

__lt__(value, /): Return self<value.

__ne__(value, /): Return self!=value.

__setitem__(self, arg0: int, arg1: pyarts.arts.AtmPoint, /) → None
__setitem__(self, arg0: slice, arg1: pyarts.arts.ArrayOfAtmPoint, /) → None