ArrayOfSensorObsel

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

A list of SensorObsel

Workspace variables of type ArrayOfSensorObsel

measurement_sensor

Overview

Method	`append()`	Append arg to the end of the list.
Method	`clear()`	Remove all items from list.
Method	`collect_frequency_grids()`	Collect all frequency grids in a single grid.
Method	`collect_poslos_grids()`	Collect all poslos grids in a single grid.
Method	`extend()`	Extend self by appending elements from arg.
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	`unique_frequency_grids()`	List of the unique frequency grids
Method	`unique_poslos_grids()`	List of the unique poslos grids
Static Method	`fromxml()`	Create variable from file.
Static Method	`fromxmls()`	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.ArrayOfSensorObsel
Operator	`__getstate__()`	__getstate__(self) -> tuple[pyarts3.arts.ArrayOfSensorObsel]
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	Overloaded function.
Operator	`__iter__()`	__iter__(self) -> collections.abc.Iterator[pyarts3.arts.SensorObsel]
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.ArrayOfSensorObsel, /) -> None
Operator	`__setstate__()`	__setstate__(self, arg: tuple[pyarts3.arts.ArrayOfSensorObsel]) -> None
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self) → None

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

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

__init__(self) → None

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

Overloaded function.

__init__(self) -> None

Default constructor

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

Copy constructor

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

Construct from an iterable object

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

Methods

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

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

collect_frequency_grids(self) → None: Collect all frequency grids in a single grid.

Tip

This generally speeds up radiative transfer calculations. The internal weighting matrix is updated internally to give the same forward model result. This matrix is stored sparsely, so memory usage should not be a big issue. Beware that accessing the weight matrix creates a dense matrix copy, which might be large if many frequency grids are combined.

Note

If you need to consider sensor error corrections in frequency, such as frequency shifts, stretches or standing waves, this method might not have the desired effect. All channels are considered as part of the same “physical” spectrometer, i.e., a standing wave in one channel will stretch to all the rest.

collect_poslos_grids(self) → None: Collect all poslos grids in a single grid.

Tip

This generally speeds up radiative transfer calculations. The internal weighting matrix is updated internally to give the same forward model result. This matrix is stored sparsely, so memory usage should not be a big issue. Beware that accessing the weight matrix creates a dense matrix copy, which might be large if many poslos grids are combined.

Note

If you need to consider sensor error corrections in line-of-sight or position, this method might not have the desired effect. All channels are considered as part of the same “physical” sensor, i.e., a correction in position or line-of-sight of one channel will affect all channels.

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

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

pop(self, index: int = -1) → pyarts3.arts.SensorObsel: 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

unique_frequency_grids(self) → pyarts3.arts.ArrayOfAscendingGrid: List of the unique frequency grids

unique_poslos_grids(self) → pyarts3.arts.ArrayOfSensorPosLosVector: List of the unique poslos grids

Static Methods

fromxml(file: str) → pyarts3.arts.ArrayOfSensorObsel

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

fromxmls(files: pyarts3.arts.ArrayOfString) → pyarts3.arts.ArrayOfSensorObsel

Create variable from file.

Like fromxml() but for split/multiple files.

Parameters:: files (list[str]) – A list of files 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.SensorObsel
__getitem__(self, arg: slice, /) → pyarts3.arts.ArrayOfSensorObsel

__getstate__(self) → tuple[pyarts3.arts.ArrayOfSensorObsel]

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

__hash__(): Return hash(self).

__init__(self) → None

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

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

__init__(self) → None

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

Overloaded function.

__init__(self) -> None

Default constructor

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

Copy constructor

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

Construct from an iterable object

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

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

__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.SensorObsel, /) → None
__setitem__(self, arg0: slice, arg1: pyarts3.arts.ArrayOfSensorObsel, /) → None

__setstate__(self, arg: tuple[pyarts3.arts.ArrayOfSensorObsel]) → None

__str__(self) → str