PolarizationChoice

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

Group name: “PolarizationChoice”

Named polarization states to help create relevant Stokvec.

Note that these are just user friendly 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

pyarts.arts.PolarizationChoice.I

“I” - PolarizationChoice

Static Data

pyarts.arts.PolarizationChoice.Ih

“Ih” - PolarizationChoice

Static Data

pyarts.arts.PolarizationChoice.Ilhc

“Ilhc” - PolarizationChoice

Static Data

pyarts.arts.PolarizationChoice.Im45

“Im45” - PolarizationChoice

Static Data

pyarts.arts.PolarizationChoice.Ip45

“Ip45” - PolarizationChoice

Static Data

pyarts.arts.PolarizationChoice.Irhc

“Irhc” - PolarizationChoice

Static Data

pyarts.arts.PolarizationChoice.Iv

“Iv” - PolarizationChoice

Static Data

pyarts.arts.PolarizationChoice.LC

“Ilhc” - PolarizationChoice

Static Data

pyarts.arts.PolarizationChoice.Q

“Q” - PolarizationChoice

Static Data

pyarts.arts.PolarizationChoice.RC

“Irhc” - PolarizationChoice

Static Data

pyarts.arts.PolarizationChoice.U

“U” - PolarizationChoice

Static Data

pyarts.arts.PolarizationChoice.V

“V” - PolarizationChoice

Operator

__eq__()

self == other

Operator

__ge__()

self >= other

Operator

__gt__()

self > other

Operator

__hash__()

Allows hashing

Operator

__le__()

self <= other

Operator

__lt__()

self < other

Operator

__ne__()

self != other

Constructors

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

Methods

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

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

Static Methods

fromxml(file: str) → pyarts.arts.PolarizationChoice

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

get_options() → list[pyarts.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: pyarts.arts.PolarizationChoice, /) → bool

self == other

__ge__(self, arg: pyarts.arts.PolarizationChoice, /) → bool

self >= other

__gt__(self, arg: pyarts.arts.PolarizationChoice, /) → bool

self > other

__hash__(self) → int

Allows hashing

__le__(self, arg: pyarts.arts.PolarizationChoice, /) → bool

self <= other

__lt__(self, arg: pyarts.arts.PolarizationChoice, /) → bool

self < other

__ne__(self, arg: pyarts.arts.PolarizationChoice, /) → bool

self != other