PolarizationChoice

class pyarts3.arts.PolarizationChoice(*args, **kwargs)

Named polarization states to help create relevant Stokvec.

Note that these are just user fri’n’y suggestions and it is recommended to create the correct Stokvec manually if the desired polarization state is not represented below.

Also, be aware that the unit of, e.g., spectral_radiance (often the last choice of SpectralRadianceUnitType) is in Kelvin, then the code below will give the measured brightness temperature in Kelvin for these polarization states, but that if the unit is still in Watts of any kind, then the code below will give 2 times the select polarized brightness temperatures (but still the correct unpolarized radiation).

Valid options:

"I" or "I": No polarization state [1, 0, 0, 0].
"Q" or "Q": Difference between vertical and horizontal linear polarization [0, 1, 0, 0].
"U" or "U": Difference between plus and minus 45 degrees linear polarization [0, 0, 1, 0].
"V" or "V": Difference between right and left circular polarization [0, 0, 0, 1].
"Iv" or "Iv": Vertical linear polarization [1, 1, 0, 0].
"Ih" or "Ih": Horizontal linear polarization [1, -1, 0, 0].
"Ip45" or "I+45": Plus 45 degrees linear polarization [1, 0, 1, 0].
"Im45" or "I-45": Minus 45 degrees linear polarization [1, 0, -1, 0].
"Ilhc" or "LC": Left circular polarization [1, 0, 0, -1].
"Irhc" or "RC": Right circular polarization [1, 0, 0, 1].

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
Static Method	`get_options()`	Get a list of all options
Static Method	`get_options_as_strings()`	Get a list of all options as strings
Static Data	`pyarts3.arts.PolarizationChoice.I`	“I” (`PolarizationChoice`)
Static Data	`pyarts3.arts.PolarizationChoice.Ih`	“Ih” (`PolarizationChoice`)
Static Data	`pyarts3.arts.PolarizationChoice.Ilhc`	“Ilhc” (`PolarizationChoice`)
Static Data	`pyarts3.arts.PolarizationChoice.Im45`	“Im45” (`PolarizationChoice`)
Static Data	`pyarts3.arts.PolarizationChoice.Ip45`	“Ip45” (`PolarizationChoice`)
Static Data	`pyarts3.arts.PolarizationChoice.Irhc`	“Irhc” (`PolarizationChoice`)
Static Data	`pyarts3.arts.PolarizationChoice.Iv`	“Iv” (`PolarizationChoice`)
Static Data	`pyarts3.arts.PolarizationChoice.LC`	“Ilhc” (`PolarizationChoice`)
Static Data	`pyarts3.arts.PolarizationChoice.Q`	“Q” (`PolarizationChoice`)
Static Data	`pyarts3.arts.PolarizationChoice.RC`	“Irhc” (`PolarizationChoice`)
Static Data	`pyarts3.arts.PolarizationChoice.U`	“U” (`PolarizationChoice`)
Static Data	`pyarts3.arts.PolarizationChoice.V`	“V” (`PolarizationChoice`)
Operator	`__eq__()`	self == other
Operator	`__format__()`	Default object formatter.
Operator	`__ge__()`	self >= other
Operator	`__getstate__()`	__getstate__(self) -> tuple[str]
Operator	`__gt__()`	self > other
Operator	`__hash__()`	Allows hashing
Operator	`__init__()`	__init__(self, arg: str, /) -> None
Operator	`__le__()`	self <= other
Operator	`__lt__()`	self < other
Operator	`__ne__()`	self != other
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__setstate__()`	__setstate__(self, arg: tuple[str], /) -> None
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self) → None
__init__(self, arg: pyarts3.arts.PolarizationChoice) → None
__init__(self, arg: str, /) → None

Methods

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

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

Static Methods

fromxml(file: str) → pyarts3.arts.PolarizationChoice

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

get_options() → list[pyarts3.arts.PolarizationChoice]: Get a list of all options

get_options_as_strings() → list[str]: Get a list of all options as strings

Operators

__eq__(self, arg: pyarts3.arts.PolarizationChoice, /) → bool: self == other

__format__(format_spec, /)

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__(self, arg: pyarts3.arts.PolarizationChoice, /) → bool: self >= other

__getstate__(self) → tuple[str]

__gt__(self, arg: pyarts3.arts.PolarizationChoice, /) → bool: self > other

__hash__(self) → int: Allows hashing

__init__(self) → None
__init__(self, arg: pyarts3.arts.PolarizationChoice) → None
__init__(self, arg: str, /) → None

__le__(self, arg: pyarts3.arts.PolarizationChoice, /) → bool: self <= other

__lt__(self, arg: pyarts3.arts.PolarizationChoice, /) → bool: self < other

__ne__(self, arg: pyarts3.arts.PolarizationChoice, /) → bool: self != other

__repr__(self) → str

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

__str__(self) → str