Stokvec
- class pyarts3.arts.Stokvec(*args, **kwargs)
A single Stokes vector (of length 4).
\[\begin{split}\vec{I} = \left[ \begin {array} {r} I \\ Q \\ U \\ V \end {array} \right]\end{split}\]The Stokes vector is used to represent the state of polarization of light.
The components of the Stokes vector are:
\(I\) - the total intensity of the light.
\(Q\) - the difference in intensity between horizontally and vertically polarized light.
\(U\) - the difference in intensity between light polarized at +45 degrees and -45 degrees.
\(V\) - the difference in intensity between right and left circularly polarized light.
The python mapping allows treating this 4-long
ndarray
in python.Workspace methods that require Stokvec
Overview
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
Returns [1.0, 0.0, 0.0, sin(angle)], the circular polarization vector for a given phase delay angle
Static Method
Create variable from file.
Static Method
Returns [1.0, cos(2*angle), sin(2*angle), 0.0], the linear polarization vector for a given angle
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
Operator
Operator
__format__(self, arg: str, /) -> str
Operator
Operator
Operator
Helper for pickle.
Operator
Operator
Return hash(self).
Operator
Operator
Operator
Operator
See
numpy.ndarray.__imatmul__
Operator
Operator
Operator
__init__(self, arg: pyarts3.arts.Stokvec) -> None
Operator
Operator
Operator
Operator
See
numpy.ndarray.__iter__
Operator
Operator
Operator
Operator
Operator
Operator
Operator
Operator
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: pyarts3.arts.PolarizationChoice, /) None
- __init__(self, arg: str, /) None
- __init__(self, arg: collections.abc.Sequence[float], /) None
- __init__(self) None
- __init__(self, arg: pyarts3.arts.Stokvec) None
Methods
- 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
- cirpol(angle: float) pyarts3.arts.Stokvec
Returns [1.0, 0.0, 0.0, sin(angle)], the circular polarization vector for a given phase delay angle
- fromxml(file: str) pyarts3.arts.Stokvec
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
- linpol(angle: float) pyarts3.arts.Stokvec
Returns [1.0, cos(2*angle), sin(2*angle), 0.0], the linear polarization vector for a given angle
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=(4), order='C'] | object
Returns a
ndarray
of the object.
- __getstate__()
Helper for pickle.
- __hash__()
Return hash(self).
- __init__(self, arg: float, /) None
- __init__(self, arg: pyarts3.arts.PolarizationChoice, /) None
- __init__(self, arg: str, /) None
- __init__(self, arg: collections.abc.Sequence[float], /) None
- __init__(self) None
- __init__(self, arg: pyarts3.arts.Stokvec) None