ArrayOfIndex

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

A list of Index

Workspace methods that can generate ArrayOfIndex

sortedIndexOfBands()

Overview

Method	`append()`	Append arg to the end of the list.
Method	`clear()`	Remove all items from list.
Method	`conj()`	Wrapper for `numpy.ndarray.conj` using ARTS types.
Method	`conjugate()`	Wrapper for `numpy.ndarray.conjugate` using ARTS types.
Method	`copy()`	Wrapper for `numpy.ndarray.copy` using ARTS types.
Method	`count()`	Return number of occurrences of arg.
Method	`cumprod()`	Wrapper for `numpy.ndarray.cumprod` using ARTS types.
Method	`cumsum()`	Wrapper for `numpy.ndarray.cumsum` using ARTS types.
Method	`diagonal()`	Wrapper for `numpy.ndarray.diagonal` using ARTS types.
Method	`extend()`	Extend self by appending elements from arg.
Method	`fill()`	Wrapper for `numpy.ndarray.fill` using ARTS types.
Method	`flatten()`	Wrapper for `numpy.ndarray.flatten` using ARTS types.
Method	`index()`	Return first occurence of value between start and end - defaults to full range
Method	`insert()`	Insert object arg1 before index arg0.
Method	`max()`	Wrapper for `numpy.ndarray.max` using ARTS types.
Method	`mean()`	Wrapper for `numpy.ndarray.mean` using ARTS types.
Method	`min()`	Wrapper for `numpy.ndarray.min` using ARTS types.
Method	`nonzero()`	Wrapper for `numpy.ndarray.nonzero` using ARTS types.
Method	`pop()`	Remove and return item at index (default last).
Method	`prod()`	Wrapper for `numpy.ndarray.prod` using ARTS types.
Method	`ravel()`	Wrapper for `numpy.ndarray.ravel` using ARTS types.
Method	`readxml()`	Read variable from file
Method	`remove()`	Remove first occurrence of arg.
Method	`repeat()`	Wrapper for `numpy.ndarray.repeat` using ARTS types.
Method	`reshape()`	Wrapper for `numpy.ndarray.reshape` using ARTS types.
Method	`round()`	Wrapper for `numpy.ndarray.round` using ARTS types.
Method	`savexml()`	Saves variable to file
Method	`squeeze()`	Wrapper for `numpy.ndarray.squeeze` using ARTS types.
Method	`std()`	Wrapper for `numpy.ndarray.std` using ARTS types.
Method	`sum()`	Wrapper for `numpy.ndarray.sum` using ARTS types.
Method	`tolist()`	Wrapper for `numpy.ndarray.tolist` using ARTS types.
Method	`trace()`	Wrapper for `numpy.ndarray.trace` using ARTS types.
Method	`transpose()`	Wrapper for `numpy.ndarray.transpose` using ARTS types.
Method	`var()`	Wrapper for `numpy.ndarray.var` using ARTS types.
Static Method	`fromxml()`	Create variable from file
Attribute	`T`	Wrapper for `numpy.ndarray.T` using ARTS types.
Attribute	`dtype`	Wrapper for `numpy.ndarray.dtype` using ARTS types.
Attribute	`imag`	Wrapper for `numpy.ndarray.imag` using ARTS types.
Attribute	`itemsize`	Wrapper for `numpy.ndarray.itemsize` using ARTS types.
Attribute	`nbytes`	Wrapper for `numpy.ndarray.nbytes` using ARTS types.
Attribute	`ndim`	Wrapper for `numpy.ndarray.ndim` using ARTS types.
Attribute	`real`	Wrapper for `numpy.ndarray.real` using ARTS types.
Attribute	`shape`	Wrapper for `numpy.ndarray.shape` using ARTS types.
Attribute	`size`	Wrapper for `numpy.ndarray.size` using ARTS types.
Attribute	`strides`	Wrapper for `numpy.ndarray.strides` using ARTS types.
Attribute	`value`	A `ndarray` of the object.
Operator	`__abs__()`	Allows abs(self)
Operator	`__add__()`	Allows self + value
Operator	`__and__()`	Allows self and value
Operator	`__array__()`	__array__(self, dtype: object \| None = None, copy: object \| None = None) -> object
Operator	`__contains__()`	Overloaded function.
Operator	`__delitem__()`	Overloaded function.
Operator	`__divmod__()`	Allows divmod(self, value)
Operator	`__eq__()`	Overloaded function.
Operator	`__floordiv__()`	Allows self // value
Operator	`__ge__()`	Allows self >= value
Operator	`__getitem__()`	Overloaded function.
Operator	`__getstate__()`	__getstate__(self) -> tuple[pyarts.arts.ArrayOfIndex]
Operator	`__gt__()`	Allows self > value
Operator	`__hash__()`	Return hash(self).
Operator	`__iadd__()`	Allows self += value
Operator	`__iand__()`	Allows self &= value
Operator	`__ifloordiv__()`	Allows self //= value
Operator	`__imatmul__()`	Allows self @= value
Operator	`__imod__()`	Allows self %= value
Operator	`__imul__()`	Allows self *= value
Operator	`__ior__()`	Allows self \|= value
Operator	`__ipow__()`	Allows self **= value
Operator	`__isub__()`	Allows self -= value
Operator	`__iter__()`	Allows iter(self)
Operator	`__itruediv__()`	Allows self /= value
Operator	`__le__()`	Allows self <= value
Operator	`__len__()`	Overloaded function.
Operator	`__lt__()`	Allows self < value
Operator	`__matmul__()`	Allows self @ value
Operator	`__mod__()`	Allows self % value
Operator	`__mul__()`	Allows self * value
Operator	`__ne__()`	Overloaded function.
Operator	`__or__()`	Allows self \| value
Operator	`__pow__()`	Allows self ** value
Operator	`__radd__()`	Allows value + self
Operator	`__rand__()`	Allows value & self
Operator	`__rdivmod__()`	Allows value / self
Operator	`__rfloordiv__()`	Allows value // self
Operator	`__rmatmul__()`	Allows value @ self
Operator	`__rmod__()`	Allows value % self
Operator	`__rmul__()`	Allows value * self
Operator	`__ror__()`	Allows value \| self
Operator	`__rpow__()`	Allows value ** self
Operator	`__rsub__()`	Allows value - self
Operator	`__rtruediv__()`	Allows value / self
Operator	`__setitem__()`	Overloaded function.
Operator	`__setstate__()`	__setstate__(self, arg: tuple[pyarts.arts.ArrayOfIndex]) -> None
Operator	`__truediv__()`	Allows self / value

Constructors

__init__(self) → None

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

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

__init__(self) → None

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

Overloaded function.

__init__(self) -> None

Default constructor

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

Copy constructor

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

Construct from an iterable object

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

Methods

append(self, value: int) → None: Append arg to the end of the list.

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

conj(self) → object

Wrapper for numpy.ndarray.conj using ARTS types.

Use the original for greater control and more functionality.

conjugate(self) → object

Wrapper for numpy.ndarray.conjugate using ARTS types.

Use the original for greater control and more functionality.

copy(self, order: str = 'C') → object

Wrapper for numpy.ndarray.copy using ARTS types.

Use the original for greater control and more functionality.

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

cumprod(self, axis: object | None = None, dtype: object | None = None, out: object | None = None) → object

Wrapper for numpy.ndarray.cumprod using ARTS types.

Use the original for greater control and more functionality.

cumsum(self, axis: object | None = None, dtype: object | None = None, out: object | None = None) → object

Wrapper for numpy.ndarray.cumsum using ARTS types.

Use the original for greater control and more functionality.

diagonal(self, offset: object = 0, axis1: object = 0, axis2: object = 1) → object

Wrapper for numpy.ndarray.diagonal using ARTS types.

Use the original for greater control and more functionality.

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

fill(self, value: object) → object

Wrapper for numpy.ndarray.fill using ARTS types.

Use the original for greater control and more functionality.

flatten(self, order: str = 'C') → object

Wrapper for numpy.ndarray.flatten using ARTS types.

Use the original for greater control and more functionality.

index(self, value: int, start: int = 0, end: int = 18446744073709551615) → int: Return first occurence of value between start and end - defaults to full range

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

max(self, axis: object | None = None, out: object | None = None, keepdims: object = False) → object

Wrapper for numpy.ndarray.max using ARTS types.

Use the original for greater control and more functionality.

mean(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, keepdims: object = False) → object

Wrapper for numpy.ndarray.mean using ARTS types.

Use the original for greater control and more functionality.

min(self, axis: object | None = None, out: object | None = None, keepdims: object = False) → object

Wrapper for numpy.ndarray.min using ARTS types.

Use the original for greater control and more functionality.

nonzero(self) → object

Wrapper for numpy.ndarray.nonzero using ARTS types.

Use the original for greater control and more functionality.

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

prod(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, keepdims: object = False) → object

Wrapper for numpy.ndarray.prod using ARTS types.

Use the original for greater control and more functionality.

ravel(self, order: list) → object

Wrapper for numpy.ndarray.ravel using ARTS types.

Use the original for greater control and more functionality.

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

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

repeat(self, repeats: object, axis: object | None = None) → object

Wrapper for numpy.ndarray.repeat using ARTS types.

Use the original for greater control and more functionality.

reshape(self, shape: object, order: object = 'C') → object

Wrapper for numpy.ndarray.reshape using ARTS types.

Use the original for greater control and more functionality.

round(self, decimals: object = 0, out: object | None = None) → object

Wrapper for numpy.ndarray.round using ARTS types.

Use the original for greater control and more functionality.

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

squeeze(self, axis: object | None = None) → object

Wrapper for numpy.ndarray.squeeze using ARTS types.

Use the original for greater control and more functionality.

std(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, ddof: object = 0, keepdims: object = False) → object

Wrapper for numpy.ndarray.std using ARTS types.

Use the original for greater control and more functionality.

sum(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, keepdims: object = False) → object

Wrapper for numpy.ndarray.sum using ARTS types.

Use the original for greater control and more functionality.

tolist(self) → object

Wrapper for numpy.ndarray.tolist using ARTS types.

Use the original for greater control and more functionality.

trace(self, offset: object = 0, axis1: object = 0, axis2: object = 1, dtype: object | None = None, out: object | None = None) → object

Wrapper for numpy.ndarray.trace using ARTS types.

Use the original for greater control and more functionality.

transpose(self, axes: list | None = None) → object

Wrapper for numpy.ndarray.transpose using ARTS types.

Use the original for greater control and more functionality.

var(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, ddof: object = 0, keepdims: object = False) → object

Wrapper for numpy.ndarray.var using ARTS types.

Use the original for greater control and more functionality.

Static Methods

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

Create variable from file

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

On Error:: Throws RuntimeError for any failure to read

Attributes

T

Wrapper for numpy.ndarray.T using ARTS types.

Use the original for greater control and more functionality.

dtype

Wrapper for numpy.ndarray.dtype using ARTS types.

Use the original for greater control and more functionality.

imag

Wrapper for numpy.ndarray.imag using ARTS types.

Use the original for greater control and more functionality.

itemsize

Wrapper for numpy.ndarray.itemsize using ARTS types.

Use the original for greater control and more functionality.

nbytes

Wrapper for numpy.ndarray.nbytes using ARTS types.

Use the original for greater control and more functionality.

ndim

Wrapper for numpy.ndarray.ndim using ARTS types.

Use the original for greater control and more functionality.

real

Wrapper for numpy.ndarray.real using ARTS types.

Use the original for greater control and more functionality.

shape

Wrapper for numpy.ndarray.shape using ARTS types.

Use the original for greater control and more functionality.

size

Wrapper for numpy.ndarray.size using ARTS types.

Use the original for greater control and more functionality.

strides

Wrapper for numpy.ndarray.strides using ARTS types.

Use the original for greater control and more functionality.

value: A ndarray of the object.

Operators

__abs__(self) → object: Allows abs(self)

__add__(self, value: object) → object: Allows self + value

__and__(self, value: object) → object: Allows self and value

__array__(self, dtype: object | None = None, copy: object | None = None) → object

__contains__(self, key: object) → object

__contains__(self, arg: int, /) → bool

__contains__(self, arg: object, /) → bool

Overloaded function.

__contains__(self, key: object) -> object

Allows key in self

__contains__(self, arg: int, /) -> bool

Return true if arg is in the list.

__contains__(self, arg: object, /) -> bool

Return false.

__delitem__(self, i: int) → None

__delitem__(self, slice: slice) → None

Overloaded function.

__delitem__(self, i: int) -> None

Remove the i-th item from the list.

__delitem__(self, slice: slice) -> None

Remove a slice of the list.

__divmod__(self, value: object) → object: Allows divmod(self, value)

__eq__(self, value: object) → object

__eq__(self, arg: pyarts.arts.ArrayOfIndex, /) → bool

Overloaded function.

__eq__(self, value: object) -> object

Allows self == value

__eq__(self, arg: pyarts.arts.ArrayOfIndex, /) -> bool

self == other

__floordiv__(self, value: object) → object: Allows self // value

__ge__(self, value: object) → object: Allows self >= value

__getitem__(self, key: object) → object

__getitem__(self, i: int) → int

__getitem__(self, slice: slice) → pyarts.arts.ArrayOfIndex

Overloaded function.

__getitem__(self, key: object) -> object

Allows self[key]

__getitem__(self, i: int) -> int

Return the i-th item.

__getitem__(self, slice: slice) -> pyarts.arts.ArrayOfIndex

Return a slice of the list.

__getstate__(self) → tuple[pyarts.arts.ArrayOfIndex]

__gt__(self, value: object) → object: Allows self > value

__hash__(): Return hash(self).

__iadd__(self, value: object) → object: Allows self += value

__iand__(self, value: object) → object: Allows self &= value

__ifloordiv__(self, value: object) → object: Allows self //= value

__imatmul__(self, value: object) → object: Allows self @= value

__imod__(self, value: object) → object: Allows self %= value

__imul__(self, value: object) → object: Allows self *= value

__ior__(self, value: object) → object: Allows self |= value

__ipow__(self, value: object) → object: Allows self **= value

__isub__(self, value: object) → object: Allows self -= value

__iter__(self) → object
__iter__(self) → collections.abc.Iterator[int]: Allows iter(self)

__itruediv__(self, value: object) → object: Allows self /= value

__le__(self, value: object) → object: Allows self <= value

__len__(self) → object

__len__(self) → int

Overloaded function.

__len__(self) -> object

Allows len(self)

__len__(self) -> int

Return the number of items in the list.

__lt__(self, value: object) → object: Allows self < value

__matmul__(self, value: object) → object: Allows self @ value

__mod__(self, value: object) → object: Allows self % value

__mul__(self, value: object) → object: Allows self * value

__ne__(self, value: object) → object

__ne__(self, arg: pyarts.arts.ArrayOfIndex, /) → bool

Overloaded function.

__ne__(self, value: object) -> object

Allows self != value

__ne__(self, arg: pyarts.arts.ArrayOfIndex, /) -> bool

self != other

__or__(self, value: object) → object: Allows self | value

__pow__(self, value: object, mod: object | None = None) → object: Allows self ** value

__radd__(self, value: object) → object: Allows value + self

__rand__(self, value: object) → object: Allows value & self

__rdivmod__(self, value: object) → object: Allows value / self

__rfloordiv__(self, value: object) → object: Allows value // self

__rmatmul__(self, value: object) → object: Allows value @ self

__rmod__(self, value: object) → object: Allows value % self

__rmul__(self, value: object) → object: Allows value * self

__ror__(self, value: object) → object: Allows value | self

__rpow__(self, value: object, mod: object | None = None) → object: Allows value ** self

__rsub__(self, value: object) → object: Allows value - self

__rtruediv__(self, value: object) → object: Allows value / self

__setitem__(self, key: object, value: object) → object

__setitem__(self, i: int, value: int) → None

__setitem__(self, slice: slice, value: pyarts.arts.ArrayOfIndex) → None

Overloaded function.

__setitem__(self, key: object, value: object) -> object

Allows self[key] = value

__setitem__(self, i: int, value: int) -> None

Set the i-th item to value.

__setitem__(self, slice: slice, value: pyarts.arts.ArrayOfIndex) -> None

Set a slice of the list.

__setstate__(self, arg: tuple[pyarts.arts.ArrayOfIndex]) → None

__truediv__(self, value: object) → object: Allows self / value