ArrayOfAtmPoint

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

A list of AtmPoint

Workspace variables of type ArrayOfAtmPoint

atmospheric_profile 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	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	Return self>=value.
Operator	__getitem__()	__getitem__(self, arg: slice, /) -> pyarts3.arts.ArrayOfAtmPoint
Operator	__getstate__()	Helper for pickle.
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	Overloaded function.
Operator	__iter__()	__iter__(self) -> collections.abc.Iterator[pyarts3.arts.AtmPoint]
Operator	__le__()	Return self<=value.
Operator	__len__()	__len__(self) -> int
Operator	__lt__()	Return self<value.
Operator	__ne__()	Return self!=value.
Operator	__repr__()	__repr__(self) -> str
Operator	__setitem__()	__setitem__(self, arg0: slice, arg1: pyarts3.arts.ArrayOfAtmPoint, /) -> None
Operator	__str__()	__str__(self) -> str

Constructors

__init__(self) → None

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

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

__init__(self) → None

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

Overloaded function.

1. __init__(self) -> None

Default constructor

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

Copy constructor

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

Construct from an iterable object

4. __init__(self) -> None

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

Methods

append(self, arg: pyarts3.arts.AtmPoint, /) → None

Append arg to the end of the list.

clear(self) → None

Remove all items from list.

extend(self, arg: pyarts3.arts.ArrayOfAtmPoint, /) → None

Extend self by appending elements from arg.

extend_in_pressure(self, pressure: float, extrapolation_type: pyarts3.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 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: pyarts3.arts.AscendingGrid, extrap: pyarts3.arts.InterpolationExtrapolation = 'Nearest') → pyarts3.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”.

Returns:

atmospheric_field – The atmospheric field created from the profile.

Return type:

AtmField

insert(self, arg0: int, arg1: pyarts3.arts.AtmPoint, /) → None

Insert object arg1 before index arg0.

pop(self, index: int = -1) → pyarts3.arts.AtmPoint

Remove and return item at index (default last).

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

to_dict(self, core: bool = True, specs: bool = True, isots: bool = True, nlte: bool = True, ssprops: bool = True) → dict[pyarts3.arts.AtmKey | pyarts3.arts.SpeciesEnum | pyarts3.arts.SpeciesIsotope | pyarts3.arts.QuantumLevelIdentifier | pyarts3.arts.ScatteringSpeciesProperty, pyarts3.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.

Returns:

dict – A dictionary of atmospheric keys and corresponding data. The keys are the atmospheric point keys and the values are the corresponding data.

Return type:

dict

update(self, data: collections.abc.Mapping[pyarts3.arts.AtmKey | pyarts3.arts.SpeciesEnum | pyarts3.arts.SpeciesIsotope | pyarts3.arts.QuantumLevelIdentifier | pyarts3.arts.ScatteringSpeciesProperty, pyarts3.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[pyarts3.arts.AtmKey | pyarts3.arts.SpeciesEnum | pyarts3.arts.SpeciesIsotope | pyarts3.arts.QuantumLevelIdentifier | pyarts3.arts.ScatteringSpeciesProperty, pyarts3.arts.Vector], iso: pyarts3.arts.IsoRatioOption = 'Builtin') → pyarts3.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.

Returns:

atmospheric_profile – The atmospheric profile created from the dictionary.

Return type:

AtmProfile

fromxml(file: str) → pyarts3.arts.ArrayOfAtmPoint

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

Operators

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

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

__eq__(value, /)

Return self==value.

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

__ge__(value, /)

Return self>=value.

__getitem__(self, arg: int, /) → pyarts3.arts.AtmPoint

__getitem__(self, arg: slice, /) → pyarts3.arts.ArrayOfAtmPoint

__getstate__()

Helper for pickle.

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

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

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

__init__(self) → None

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

Overloaded function.

1. __init__(self) -> None

Default constructor

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

Copy constructor

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

Construct from an iterable object

4. __init__(self) -> None

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

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

__le__(value, /)

Return self<=value.

__len__(self) → int

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

__repr__(self) → str

__setitem__(self, arg0: int, arg1: pyarts3.arts.AtmPoint, /) → None

__setitem__(self, arg0: slice, arg1: pyarts3.arts.ArrayOfAtmPoint, /) → None

__str__(self) → str