Index

class pyarts.arts.Index(*args, **kwargs)

A 64 bit signed integer type

Workspace methods that require Index

absorption_bandsKeepID() absorption_bandsLineMixingAdaptation() absorption_bandsReadHITRAN() absorption_bandsReadSpeciesSplitCatalog() absorption_bandsSelectFrequency() absorption_bandsSetZeeman() absorption_cia_dataAddCIARecord() absorption_cia_dataReadSpeciesSplitCatalog() absorption_lookup_tableSimpleWide() absorption_predefined_model_dataReadSpeciesSplitCatalog() absorption_xsec_fit_dataReadSpeciesSplitCatalog() abs_lines_per_speciesReadSpeciesSplitCatalog() atmospheric_fieldAppendAbsorptionData() atmospheric_fieldAppendBaseData() atmospheric_fieldAppendCIASpeciesData() atmospheric_fieldAppendLineIsotopologueData() atmospheric_fieldAppendLineLevelData() atmospheric_fieldAppendLineSpeciesData() atmospheric_fieldAppendPredefSpeciesData() atmospheric_fieldAppendTagsSpeciesData() atmospheric_fieldAppendXsecSpeciesData() atmospheric_fieldRead() jacobian_targetsAddSensorFrequencyPolyFit() OEM()

propagation_matrixAddCIA() propagation_matrixAddLines() propagation_matrixAddLookup() propagation_matrix_agendaAuto() ray_pathGeometric() ray_pathGeometricTangentAltitude() ray_path_spectral_radiance_scatteringSunsFirstOrderRayleigh() ray_path_suns_pathFromPathObserver() ray_path_transmission_matrixFromPath() ReadCatalogData() ReadXMLIndexed() RetrievalAddSensorFrequencyPolyFit() sortedIndexOfBands() spectral_radianceClearskyBackgroundTransmission() spectral_radianceClearskyEmission() spectral_radianceClearskyRayleighScattering() spectral_radianceClearskyTransmission() spectral_radiance_operatorClearsky1D() sun_pathFromObserverAgenda() water_equivalent_pressure_operatorMK05() WignerInit() WriteBuiltinPartitionFunctionsXML() WriteXML() WriteXMLIndexed()

Workspace variables of type Index

disort_fourier_mode_dimension disort_legendre_polynomial_dimension disort_quadrature_dimension

inversion_iterate_agenda_counter inversion_iterate_agenda_do_jacobian

Overview

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	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	fill()	Wrapper for numpy.ndarray.fill using ARTS types.
Method	flatten()	Wrapper for numpy.ndarray.flatten using ARTS types.
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	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	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__()	Overloaded function.
Operator	__and__()	Overloaded function.
Operator	__array__()	Returns a ndarray of the object.
Operator	__contains__()	Allows key in self
Operator	__divmod__()	Overloaded function.
Operator	__eq__()	Overloaded function.
Operator	__floordiv__()	Overloaded function.
Operator	__ge__()	Overloaded function.
Operator	__getitem__()	Allows self[key]
Operator	__getstate__()	__getstate__(self) -> tuple[int]
Operator	__gt__()	Overloaded function.
Operator	__hash__()	Allows hashing
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__()	Overloaded function.
Operator	__len__()	Allows len(self)
Operator	__lt__()	Overloaded function.
Operator	__matmul__()	Overloaded function.
Operator	__mod__()	Overloaded function.
Operator	__mul__()	Overloaded function.
Operator	__ne__()	Overloaded function.
Operator	__or__()	Overloaded function.
Operator	__pow__()	Overloaded function.
Operator	__radd__()	Overloaded function.
Operator	__rand__()	Overloaded function.
Operator	__rdivmod__()	Overloaded function.
Operator	__rfloordiv__()	Overloaded function.
Operator	__rmatmul__()	Overloaded function.
Operator	__rmod__()	Overloaded function.
Operator	__rmul__()	Overloaded function.
Operator	__ror__()	Overloaded function.
Operator	__rpow__()	Overloaded function.
Operator	__rsub__()	Overloaded function.
Operator	__rtruediv__()	Overloaded function.
Operator	__setitem__()	Allows self[key] = value
Operator	__setstate__()	__setstate__(self, arg: tuple[int], /) -> None
Operator	__truediv__()	Overloaded function.

Constructors

__init__(self) → None

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

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

Methods

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.

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.

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.

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.

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

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.Index

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, arg: pyarts.arts.Index, /) → object

__add__(self, arg: object, /) → object

__add__(self, value: object) → object

Overloaded function.

1. __add__(self, arg: pyarts.arts.Index, /) -> object

2. __add__(self, arg: object, /) -> object

3. __add__(self, value: object) -> object

Allows self + value

__and__(self, arg: pyarts.arts.Index, /) → object

__and__(self, arg: object, /) → object

__and__(self, value: object) → object

Overloaded function.

1. __and__(self, arg: pyarts.arts.Index, /) -> object

2. __and__(self, arg: object, /) -> object

3. __and__(self, value: object) -> object

Allows self and value

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

Returns a ndarray of the object.

__contains__(self, key: object) → object

Allows key in self

__divmod__(self, arg: pyarts.arts.Index, /) → object

__divmod__(self, arg: object, /) → object

__divmod__(self, value: object) → object

Overloaded function.

1. __divmod__(self, arg: pyarts.arts.Index, /) -> object

2. __divmod__(self, arg: object, /) -> object

3. __divmod__(self, value: object) -> object

Allows divmod(self, value)

__eq__(self, arg: pyarts.arts.Index, /) → object

__eq__(self, arg: object, /) → object

__eq__(self, value: object) → object

Overloaded function.

1. __eq__(self, arg: pyarts.arts.Index, /) -> object

2. __eq__(self, arg: object, /) -> object

3. __eq__(self, value: object) -> object

Allows self == value

__floordiv__(self, arg: pyarts.arts.Index, /) → object

__floordiv__(self, arg: object, /) → object

__floordiv__(self, value: object) → object

Overloaded function.

1. __floordiv__(self, arg: pyarts.arts.Index, /) -> object

2. __floordiv__(self, arg: object, /) -> object

3. __floordiv__(self, value: object) -> object

Allows self // value

__ge__(self, arg: pyarts.arts.Index, /) → object

__ge__(self, arg: object, /) → object

__ge__(self, value: object) → object

Overloaded function.

1. __ge__(self, arg: pyarts.arts.Index, /) -> object

2. __ge__(self, arg: object, /) -> object

3. __ge__(self, value: object) -> object

Allows self >= value

__getitem__(self, key: object) → object

Allows self[key]

__getstate__(self) → tuple[int]

__gt__(self, arg: pyarts.arts.Index, /) → object

__gt__(self, arg: object, /) → object

__gt__(self, value: object) → object

Overloaded function.

1. __gt__(self, arg: pyarts.arts.Index, /) -> object

2. __gt__(self, arg: object, /) -> object

3. __gt__(self, value: object) -> object

Allows self > value

__hash__(self) → int

Allows hashing

__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

Allows iter(self)

__itruediv__(self, value: object) → object

Allows self /= value

__le__(self, arg: pyarts.arts.Index, /) → object

__le__(self, arg: object, /) → object

__le__(self, value: object) → object

Overloaded function.

1. __le__(self, arg: pyarts.arts.Index, /) -> object

2. __le__(self, arg: object, /) -> object

3. __le__(self, value: object) -> object

Allows self <= value

__len__(self) → object

Allows len(self)

__lt__(self, arg: pyarts.arts.Index, /) → object

__lt__(self, arg: object, /) → object

__lt__(self, value: object) → object

Overloaded function.

1. __lt__(self, arg: pyarts.arts.Index, /) -> object

2. __lt__(self, arg: object, /) -> object

3. __lt__(self, value: object) -> object

Allows self < value

__matmul__(self, arg: pyarts.arts.Index, /) → object

__matmul__(self, arg: object, /) → object

__matmul__(self, value: object) → object

Overloaded function.

1. __matmul__(self, arg: pyarts.arts.Index, /) -> object

2. __matmul__(self, arg: object, /) -> object

3. __matmul__(self, value: object) -> object

Allows self @ value

__mod__(self, arg: pyarts.arts.Index, /) → object

__mod__(self, arg: object, /) → object

__mod__(self, value: object) → object

Overloaded function.

1. __mod__(self, arg: pyarts.arts.Index, /) -> object

2. __mod__(self, arg: object, /) -> object

3. __mod__(self, value: object) -> object

Allows self % value

__mul__(self, arg: pyarts.arts.Index, /) → object

__mul__(self, arg: object, /) → object

__mul__(self, value: object) → object

Overloaded function.

1. __mul__(self, arg: pyarts.arts.Index, /) -> object

2. __mul__(self, arg: object, /) -> object

3. __mul__(self, value: object) -> object

Allows self * value

__ne__(self, arg: pyarts.arts.Index, /) → object

__ne__(self, arg: object, /) → object

__ne__(self, value: object) → object

Overloaded function.

1. __ne__(self, arg: pyarts.arts.Index, /) -> object

2. __ne__(self, arg: object, /) -> object

3. __ne__(self, value: object) -> object

Allows self != value

__or__(self, arg: pyarts.arts.Index, /) → object

__or__(self, arg: object, /) → object

__or__(self, value: object) → object

Overloaded function.

1. __or__(self, arg: pyarts.arts.Index, /) -> object

2. __or__(self, arg: object, /) -> object

3. __or__(self, value: object) -> object

Allows self | value

__pow__(self, arg: pyarts.arts.Index, /) → object

__pow__(self, arg: object, /) → object

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

Overloaded function.

1. __pow__(self, arg: pyarts.arts.Index, /) -> object

2. __pow__(self, arg: object, /) -> object

3. __pow__(self, value: object, mod: object | None = None) -> object

Allows self ** value

__radd__(self, arg: pyarts.arts.Index, /) → object

__radd__(self, arg: object, /) → object

__radd__(self, value: object) → object

Overloaded function.

1. __radd__(self, arg: pyarts.arts.Index, /) -> object

2. __radd__(self, arg: object, /) -> object

3. __radd__(self, value: object) -> object

Allows value + self

__rand__(self, arg: pyarts.arts.Index, /) → object

__rand__(self, arg: object, /) → object

__rand__(self, value: object) → object

Overloaded function.

1. __rand__(self, arg: pyarts.arts.Index, /) -> object

2. __rand__(self, arg: object, /) -> object

3. __rand__(self, value: object) -> object

Allows value & self

__rdivmod__(self, arg: pyarts.arts.Index, /) → object

__rdivmod__(self, arg: object, /) → object

__rdivmod__(self, value: object) → object

Overloaded function.

1. __rdivmod__(self, arg: pyarts.arts.Index, /) -> object

2. __rdivmod__(self, arg: object, /) -> object

3. __rdivmod__(self, value: object) -> object

Allows value / self

__rfloordiv__(self, arg: pyarts.arts.Index, /) → object

__rfloordiv__(self, arg: object, /) → object

__rfloordiv__(self, value: object) → object

Overloaded function.

1. __rfloordiv__(self, arg: pyarts.arts.Index, /) -> object

2. __rfloordiv__(self, arg: object, /) -> object

3. __rfloordiv__(self, value: object) -> object

Allows value // self

__rmatmul__(self, arg: pyarts.arts.Index, /) → object

__rmatmul__(self, arg: object, /) → object

__rmatmul__(self, value: object) → object

Overloaded function.

1. __rmatmul__(self, arg: pyarts.arts.Index, /) -> object

2. __rmatmul__(self, arg: object, /) -> object

3. __rmatmul__(self, value: object) -> object

Allows value @ self

__rmod__(self, arg: pyarts.arts.Index, /) → object

__rmod__(self, arg: object, /) → object

__rmod__(self, value: object) → object

Overloaded function.

1. __rmod__(self, arg: pyarts.arts.Index, /) -> object

2. __rmod__(self, arg: object, /) -> object

3. __rmod__(self, value: object) -> object

Allows value % self

__rmul__(self, arg: pyarts.arts.Index, /) → object

__rmul__(self, arg: object, /) → object

__rmul__(self, value: object) → object

Overloaded function.

1. __rmul__(self, arg: pyarts.arts.Index, /) -> object

2. __rmul__(self, arg: object, /) -> object

3. __rmul__(self, value: object) -> object

Allows value * self

__ror__(self, arg: pyarts.arts.Index, /) → object

__ror__(self, arg: object, /) → object

__ror__(self, value: object) → object

Overloaded function.

1. __ror__(self, arg: pyarts.arts.Index, /) -> object

2. __ror__(self, arg: object, /) -> object

3. __ror__(self, value: object) -> object

Allows value | self

__rpow__(self, arg: pyarts.arts.Index, /) → object

__rpow__(self, arg: object, /) → object

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

Overloaded function.

1. __rpow__(self, arg: pyarts.arts.Index, /) -> object

2. __rpow__(self, arg: object, /) -> object

3. __rpow__(self, value: object, mod: object | None = None) -> object

Allows value ** self

__rsub__(self, arg: pyarts.arts.Index, /) → object

__rsub__(self, arg: object, /) → object

__rsub__(self, value: object) → object

Overloaded function.

1. __rsub__(self, arg: pyarts.arts.Index, /) -> object

2. __rsub__(self, arg: object, /) -> object

3. __rsub__(self, value: object) -> object

Allows value - self

__rtruediv__(self, arg: pyarts.arts.Index, /) → object

__rtruediv__(self, arg: object, /) → object

__rtruediv__(self, value: object) → object

Overloaded function.

1. __rtruediv__(self, arg: pyarts.arts.Index, /) -> object

2. __rtruediv__(self, arg: object, /) -> object

3. __rtruediv__(self, value: object) -> object

Allows value / self

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

Allows self[key] = value

__setstate__(self, arg: tuple[int], /) → None

__truediv__(self, arg: pyarts.arts.Index, /) → object

__truediv__(self, arg: object, /) → object

__truediv__(self, value: object) → object

Overloaded function.

1. __truediv__(self, arg: pyarts.arts.Index, /) -> object

2. __truediv__(self, arg: object, /) -> object

3. __truediv__(self, value: object) -> object

Allows self / value