ArrayOfStokvecVector

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

A list of StokvecVector

Workspace variables of type ArrayOfStokvecVector

Overview

Method	`append()`	Append arg to the end of the list.
Method	`clear()`	Remove all items from list.
Method	`count()`	Return number of occurrences of arg.
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	`remove()`	Remove first occurrence of arg.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
Static Method	`fromxmls()`	Create variable from file.
Operator	`__contains__()`	__contains__(self, arg: object, /) -> bool
Operator	`__delitem__()`	__delitem__(self, arg: slice, /) -> None
Operator	`__eq__()`	__eq__(self, arg: object, /) -> bool
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__getitem__()`	__getitem__(self, arg: slice, /) -> pyarts3.arts.ArrayOfStokvecVector
Operator	`__getstate__()`	__getstate__(self) -> tuple[pyarts3.arts.ArrayOfStokvecVector]
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	Overloaded function.
Operator	`__iter__()`	__iter__(self) -> collections.abc.Iterator[pyarts3.arts.StokvecVector]
Operator	`__le__()`	Return self<=value.
Operator	`__len__()`	__len__(self) -> int
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	__ne__(self, arg: object, /) -> bool
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__setitem__()`	__setitem__(self, arg0: slice, arg1: pyarts3.arts.ArrayOfStokvecVector, /) -> None
Operator	`__setstate__()`	__setstate__(self, arg: tuple[pyarts3.arts.ArrayOfStokvecVector]) -> None
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self) → None

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

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

__init__(self) → None

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

Overloaded function.

__init__(self) -> None

Default constructor

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

Copy constructor

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

Construct from an iterable object

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

Methods

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

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

count(self, arg: pyarts3.arts.StokvecVector, /) → int: Return number of occurrences of arg.

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

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

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

remove(self, arg: pyarts3.arts.StokvecVector, /) → None: Remove first occurrence of arg.

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: