SparseStokvecMatrix

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

A sparse matrix of Stokvec

Overview

Method	conj()	See numpy.ndarray.conj
Method	conjugate()	See numpy.ndarray.conjugate
Method	copy()	See numpy.ndarray.copy
Method	cumprod()	See numpy.ndarray.cumprod
Method	cumsum()	See numpy.ndarray.cumsum
Method	diagonal()	See numpy.ndarray.diagonal
Method	fill()	See numpy.ndarray.fill
Method	flatten()	See numpy.ndarray.flatten
Method	max()	See numpy.ndarray.max
Method	mean()	See numpy.ndarray.mean
Method	min()	See numpy.ndarray.min
Method	nonzero()	See numpy.ndarray.nonzero
Method	prod()	See numpy.ndarray.prod
Method	ravel()	See numpy.ndarray.ravel
Method	readxml()	Read variable from file.
Method	reduce()	Reduces the matrix by polarization.
Method	repeat()	See numpy.ndarray.repeat
Method	reshape()	See numpy.ndarray.reshape
Method	round()	See numpy.ndarray.round
Method	savexml()	Saves variable to file.
Method	squeeze()	See numpy.ndarray.squeeze
Method	std()	See numpy.ndarray.std
Method	sum()	See numpy.ndarray.sum
Method	tolist()	See numpy.ndarray.tolist
Method	trace()	See numpy.ndarray.trace
Method	transpose()	See numpy.ndarray.transpose
Method	var()	See numpy.ndarray.var
Static Method	fromxml()	Create variable from file.
object	T	See numpy.ndarray.T.
StokvecMatrix	dense	Get a dense copy.
object	dtype	See numpy.ndarray.dtype.
object	imag	See numpy.ndarray.imag.
object	itemsize	See numpy.ndarray.itemsize.
object	nbytes	See numpy.ndarray.nbytes.
object	ndim	See numpy.ndarray.ndim.
object	real	See numpy.ndarray.real.
object	shape	See numpy.ndarray.shape.
object	size	See numpy.ndarray.size.
object	strides	See numpy.ndarray.strides.
ndarray	value	Allow using numpy on a copy of the class.
Operator	__abs__()	See numpy.ndarray.__abs__
Operator	__add__()	See numpy.ndarray.__add__
Operator	__and__()	See numpy.ndarray.__and__
Operator	__array__()	Allows array() to be called with the object.
Operator	__contains__()	See numpy.ndarray.__contains__
Operator	__divmod__()	See numpy.ndarray.__divmod__
Operator	__eq__()	See numpy.ndarray.__eq__
Operator	__floordiv__()	See numpy.ndarray.__floordiv__
Operator	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	See numpy.ndarray.__ge__
Operator	__getitem__()	Overloaded function.
Operator	__gt__()	See numpy.ndarray.__gt__
Operator	__hash__()	Return hash(self).
Operator	__iadd__()	See numpy.ndarray.__iadd__
Operator	__iand__()	See numpy.ndarray.__iand__
Operator	__ifloordiv__()	See numpy.ndarray.__ifloordiv__
Operator	__imatmul__()	See numpy.matmul
Operator	__imod__()	See numpy.ndarray.__imod__
Operator	__imul__()	See numpy.ndarray.__imul__
Operator	__init__()	__init__(self, arg: pyarts3.arts.SparseStokvecMatrix) -> None
Operator	__ior__()	See numpy.ndarray.__ior__
Operator	__ipow__()	See numpy.ndarray.__ipow__
Operator	__isub__()	See numpy.ndarray.__isub__
Operator	__iter__()	See iter()
Operator	__itruediv__()	See numpy.ndarray.__itruediv__
Operator	__le__()	See numpy.ndarray.__le__
Operator	__len__()	See numpy.ndarray.__len__
Operator	__lt__()	See numpy.ndarray.__lt__
Operator	__matmul__()	See numpy.ndarray.__matmul__
Operator	__mod__()	See numpy.ndarray.__mod__
Operator	__mul__()	See numpy.ndarray.__mul__
Operator	__ne__()	See numpy.ndarray.__ne__
Operator	__or__()	See numpy.ndarray.__or__
Operator	__pow__()	See numpy.ndarray.__pow__
Operator	__radd__()	See numpy.add
Operator	__rand__()	See numpy.bitwise_and
Operator	__rdivmod__()	See numpy.divmod
Operator	__repr__()	__repr__(self) -> str
Operator	__rfloordiv__()	See numpy.floor_divide
Operator	__rmatmul__()	See numpy.matmul
Operator	__rmod__()	See numpy.remainder
Operator	__rmul__()	See numpy.multiply
Operator	__ror__()	See numpy.bitwise_or
Operator	__rpow__()	See numpy.power
Operator	__rsub__()	See numpy.subtract
Operator	__rtruediv__()	See numpy.true_divide
Operator	__setitem__()	Overloaded function.
Operator	__str__()	__str__(self) -> str
Operator	__truediv__()	See numpy.ndarray.__truediv__

Constructors

__init__(self) → None

__init__(self, arg: SparseStokvecMatrix) → None

Methods

conj(self) → object

See numpy.ndarray.conj

conjugate(self) → object

See numpy.ndarray.conjugate

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

See numpy.ndarray.copy

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

See numpy.ndarray.cumprod

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

See numpy.ndarray.cumsum

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

See numpy.ndarray.diagonal

fill(self, value: object) → object

See numpy.ndarray.fill

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

See numpy.ndarray.flatten

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

See numpy.ndarray.max

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

See numpy.ndarray.mean

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

See numpy.ndarray.min

nonzero(self) → object

See numpy.ndarray.nonzero

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

See numpy.ndarray.prod

ravel(self, order: object = 'C') → object

See numpy.ndarray.ravel

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

reduce(self, pol: Stokvec = [1, 0, 0, 0], along_poslos: bool = False, along_freq: bool = False) → Matrix | Vector | float

Reduces the matrix by polarization.

The reduction happens either along the position/line-of-sight axis, the frequency axis, or both. The reduction is the equivalent of performing np.einsum("ijk,k->ij", weight_matrix, pol)

where i is the position/line-of-sight index, j is the frequency index, and k is the Stokes index if both along_poslos and along_freq are False. If both are True, the result is a single number. If only one of them is True, the result is a vector the size of the remaining axis.

Parameters:

• pol (Stokvec) – The polarization to reduce with. Default is unpolarized, i.e., [1, 0, 0, 0].

• along_poslos (bool) – If True, reduce along the position/line-of-sight axis. Default is False.

• along_freq (bool) – If True, reduce along the frequency axis. Default is False.

Returns:

The reduced value, depending on the parameters.

Return type:

Numeric, Vector, or Matrix

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

See numpy.ndarray.repeat

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

See numpy.ndarray.reshape

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

See numpy.ndarray.round

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

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

See numpy.ndarray.squeeze

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

See numpy.ndarray.std

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

See numpy.ndarray.sum

tolist(self) → object

See numpy.ndarray.tolist

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

See numpy.ndarray.trace

transpose(self, *axes) → object

See numpy.ndarray.transpose

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

See numpy.ndarray.var

Static Methods

fromxml(file: str) → SparseStokvecMatrix

Create variable from file.

Parameters:

file (str) – A file that can be read

Raises:

RuntimeError – For any failure to read.

Attributes

T: object

See numpy.ndarray.T.

dense: StokvecMatrix

Get a dense copy.

dtype: object

See numpy.ndarray.dtype.

imag: object

See numpy.ndarray.imag.

itemsize: object

See numpy.ndarray.itemsize.

nbytes: object

See numpy.ndarray.nbytes.

ndim: object

See numpy.ndarray.ndim.

real: object

See numpy.ndarray.real.

shape: object

See numpy.ndarray.shape.

size: object

See numpy.ndarray.size.

strides: object

See numpy.ndarray.strides.

value: ndarray

Allow using numpy on a copy of the class.

Operators

__abs__(self) → object

See numpy.ndarray.__abs__

__add__(self, value: object) → object

See numpy.ndarray.__add__

__and__(self, value: object) → object

See numpy.ndarray.__and__

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

Allows array() to be called with the object.

__contains__(self, key: object) → object

See numpy.ndarray.__contains__

__divmod__(self, value: object) → object

See numpy.ndarray.__divmod__

__eq__(self, value: object) → object

See numpy.ndarray.__eq__

__floordiv__(self, value: object) → object

See numpy.ndarray.__floordiv__

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

__ge__(self, value: object) → object

See numpy.ndarray.__ge__

__getitem__(self, arg: tuple[int, int], /) → Stokvec

__getitem__(self, arg: tuple[int, int, int], /) → float

__getitem__(self, key: object) → object

Overloaded function.

1. __getitem__(self, arg: tuple[int, int], /) -> pyarts3.arts.Stokvec

2. __getitem__(self, arg: tuple[int, int, int], /) -> float

3. __getitem__(self, key: object) -> object

See numpy.ndarray.__getitem__

__gt__(self, value: object) → object

See numpy.ndarray.__gt__

__hash__()

Return hash(self).

__iadd__(self, value: object) → object

See numpy.ndarray.__iadd__

__iand__(self, value: object) → object

See numpy.ndarray.__iand__

__ifloordiv__(self, value: object) → object

See numpy.ndarray.__ifloordiv__

__imatmul__(self, value: object) → object

See numpy.matmul

__imod__(self, value: object) → object

See numpy.ndarray.__imod__

__imul__(self, value: object) → object

See numpy.ndarray.__imul__

__init__(self) → None

__init__(self, arg: SparseStokvecMatrix) → None

__ior__(self, value: object) → object

See numpy.ndarray.__ior__

__ipow__(self, value: object) → object

See numpy.ndarray.__ipow__

__isub__(self, value: object) → object

See numpy.ndarray.__isub__

__iter__(self) → object

See iter()

__itruediv__(self, value: object) → object

See numpy.ndarray.__itruediv__

__le__(self, value: object) → object

See numpy.ndarray.__le__

__len__(self) → object

See numpy.ndarray.__len__

__lt__(self, value: object) → object

See numpy.ndarray.__lt__

__matmul__(self, value: object) → object

See numpy.ndarray.__matmul__

__mod__(self, value: object) → object

See numpy.ndarray.__mod__

__mul__(self, value: object) → object

See numpy.ndarray.__mul__

__ne__(self, value: object) → object

See numpy.ndarray.__ne__

__or__(self, value: object) → object

See numpy.ndarray.__or__

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

See numpy.ndarray.__pow__

__radd__(self, value: object) → object

See numpy.add

__rand__(self, value: object) → object

See numpy.bitwise_and

__rdivmod__(self, value: object) → object

See numpy.divmod

__repr__(self) → str

__rfloordiv__(self, value: object) → object

See numpy.floor_divide

__rmatmul__(self, value: object) → object

See numpy.matmul

__rmod__(self, value: object) → object

See numpy.remainder

__rmul__(self, value: object) → object

See numpy.multiply

__ror__(self, value: object) → object

See numpy.bitwise_or

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

See numpy.power

__rsub__(self, value: object) → object

See numpy.subtract

__rtruediv__(self, value: object) → object

See numpy.true_divide

__setitem__(self, arg0: tuple[int, int], arg1: Stokvec, /) → None

__setitem__(self, arg0: tuple[int, int, int], arg1: float, /) → None

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

Overloaded function.

1. __setitem__(self, arg0: tuple[int, int], arg1: pyarts3.arts.Stokvec, /) -> None

2. __setitem__(self, arg0: tuple[int, int, int], arg1: float, /) -> None

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

See numpy.ndarray.__setitem__

__str__(self) → str

__truediv__(self, value: object) → object

See numpy.ndarray.__truediv__