Propmat
- class pyarts3.arts.Propmat(*args, **kwargs)
A single propagation matrix.
Due to the properties of a propagation matrix, only 7 independents need be stored. The propagation matrix is thus represented as:
\[\begin{split}\mathbf{K} = \left[ \begin {array} {rrrr} A & B & C & D \\ B & A & U & V \\ C &-U & A & W \\ D &-V &-W & A \end {array} \right]\end{split}\]This type is related to
Stokvec
in that its first 4 elements are the same as the first 4 elements ofStokvec
for pure clearsky radiative transfers.This type is also related to
Muelmat
because it is computed often as the exponent of this term multiplied by a negative distance.Overview
Method
Returns the Propmat as a matrix.
Method
Method
Method
Method
Method
Method
Method
Method
Method
Method
Method
Method
Method
Method
Method
Read variable from file.
Method
Method
Method
Method
Saves variable to file.
Method
Method
Method
Method
Method
Method
Method
Static Method
Create variable from file.
See
numpy.ndarray.T
.See
numpy.ndarray.dtype
.See
numpy.ndarray.imag
.See
numpy.ndarray.nbytes
.See
numpy.ndarray.ndim
.See
numpy.ndarray.real
.See
numpy.ndarray.shape
.See
numpy.ndarray.size
.A
ndarray
of the object.Operator
Operator
Operator
Operator
Returns a
ndarray
of the object.Operator
Operator
Operator
Overloaded function.
Operator
Operator
__format__(self, arg: str, /) -> str
Operator
Overloaded function.
Operator
Operator
Helper for pickle.
Operator
Overloaded function.
Operator
Return hash(self).
Operator
Operator
Operator
Operator
See
numpy.ndarray.__imatmul__
Operator
Operator
Operator
__init__(self, arg: pyarts3.arts.Propmat) -> None
Operator
Operator
Operator
Operator
See
numpy.ndarray.__iter__
Operator
Operator
Overloaded function.
Operator
Operator
Overloaded function.
Operator
Operator
Operator
Operator
Overloaded function.
Operator
Operator
Operator
See
numpy.ndarray.__radd__
Operator
See
numpy.ndarray.__rand__
Operator
See
numpy.ndarray.__rdivmod__
Operator
__repr__(self) -> str
Operator
See
numpy.ndarray.__rfloordiv__
Operator
See
numpy.ndarray.__rmatmul__
Operator
See
numpy.ndarray.__rmod__
Operator
See
numpy.ndarray.__rmul__
Operator
See
numpy.ndarray.__ror__
Operator
See
numpy.ndarray.__rpow__
Operator
See
numpy.ndarray.__rsub__
Operator
See
numpy.ndarray.__rtruediv__
Operator
Operator
__str__(self) -> str
Operator
Constructors
- __init__(self, arg: float, /) None
- __init__(self, arg: collections.abc.Sequence[float], /) None
- __init__(self) None
- __init__(self, arg: pyarts3.arts.Propmat) None
Methods
- as_matrix(self) pyarts3.arts.Matrix
Returns the Propmat as a matrix.
- cumprod(self, axis: object | None = None, dtype: object | None = None, out: object | None = None) object
- cumsum(self, axis: object | None = None, dtype: object | None = None, out: object | None = None) object
- mean(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, keepdims: object = False) object
- prod(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, keepdims: object = False) object
- 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:
- 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:
- std(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, ddof: object = 0, keepdims: object = False) object
- sum(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, keepdims: object = False) object
- trace(self, offset: object = 0, axis1: object = 0, axis2: object = 1, dtype: object | None = None, out: object | None = None) object
- var(self, axis: object | None = None, dtype: object | None = None, out: object | None = None, ddof: object = 0, keepdims: object = False) object
Static Methods
- fromxml(file: str) pyarts3.arts.Propmat
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
Attributes
- T: object
See
numpy.ndarray.T
.
- dtype: object
See
numpy.ndarray.dtype
.
- imag: object
See
numpy.ndarray.imag
.
- 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
.
Operators
- __array__(self, dtype: object | None = None, copy: object | None = None) numpy.ndarray[dtype=float64, shape=(7), order='C'] | object
Returns a
ndarray
of the object.
- __eq__(self, value: object) object
- __eq__(self, arg: pyarts3.arts.Propmat, /) bool
Overloaded function.
__eq__(self, value: object) -> object
__eq__(self, arg: pyarts3.arts.Propmat, /) -> bool
- __ge__(self, value: object) object
- __ge__(self, arg: pyarts3.arts.Propmat, /) bool
Overloaded function.
__ge__(self, value: object) -> object
__ge__(self, arg: pyarts3.arts.Propmat, /) -> bool
- __getstate__()
Helper for pickle.
- __gt__(self, value: object) object
- __gt__(self, arg: pyarts3.arts.Propmat, /) bool
Overloaded function.
__gt__(self, value: object) -> object
__gt__(self, arg: pyarts3.arts.Propmat, /) -> bool
- __hash__()
Return hash(self).
- __init__(self, arg: float, /) None
- __init__(self, arg: collections.abc.Sequence[float], /) None
- __init__(self) None
- __init__(self, arg: pyarts3.arts.Propmat) None
- __le__(self, value: object) object
- __le__(self, arg: pyarts3.arts.Propmat, /) bool
Overloaded function.
__le__(self, value: object) -> object
__le__(self, arg: pyarts3.arts.Propmat, /) -> bool
- __lt__(self, value: object) object
- __lt__(self, arg: pyarts3.arts.Propmat, /) bool
Overloaded function.
__lt__(self, value: object) -> object
__lt__(self, arg: pyarts3.arts.Propmat, /) -> bool
- __ne__(self, value: object) object
- __ne__(self, arg: pyarts3.arts.Propmat, /) bool
Overloaded function.
__ne__(self, value: object) -> object
__ne__(self, arg: pyarts3.arts.Propmat, /) -> bool