SpectralRadianceUnitType

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

Choice of spectral radiance unit in conversions.

The conversion to one of these units is expected to happen from the internal representation of spectral_radiance, which is [W / m \(^{2}\) Hz sr].

For the description below, \(c\) is the speed of light, \(k\) is the Boltzmann constant, \(f\) is the frequency, \(h\) is the Planck constant, \(F(x)\) is the conversion function, and \([I,\; Q,\; U,\; V]\) is the internal representation of spectral_radiance.

For Rayleigh-Jeans brightness temperature the conversion is:

\[[I,\; Q,\; U,\; V] \rightarrow [F(I),\; F(Q),\; F(U),\; F(V)]\]

\[F(x) = \frac{c^2 x}{2 k f^2}.\]

For Planck brightness temperature the conversion is:

\[[I,\; Q,\; U,\; V] \rightarrow \left[ F(I),\; F\left( \frac{I + Q}{2} \right) - F\left( \frac{I - Q}{2} \right),\; F\left( \frac{I + U}{2} \right) - F\left( \frac{I - U}{2} \right),\; F\left( \frac{I + V}{2} \right) - F\left( \frac{I - V}{2} \right) \right]\]

\[F(x) = \frac{h f}{k}\left[\log\left(1 + \frac{2hf^3}{c^2x}\right)\right]^{-1}.\]

The spectral radiance per wavelength [W / m \(^{2}\) m sr] is:

\[[I,\; Q,\; U,\; V] \rightarrow [F(I),\; F(Q),\; F(U),\; F(V)]\]

\[F(x) = \frac{f^2 x}{c}.\]

The spectral radiance per wavenumber [W / m \(^{2}\) m \(^{-1}\) sr] is:

\[[I,\; Q,\; U,\; V] \rightarrow [F(I),\; F(Q),\; F(U),\; F(V)]\]

\[F(x) = \frac{x}{c}.\]

Lastly, the unit option of course just retains the current state [W / m \(^{2}\) Hz sr].

\[[I,\; Q,\; U,\; V] \rightarrow [I,\; Q,\; U,\; V].\]

Valid options:

"RJBT" or "Tr": Rayleigh-Jeans brightness temperature [K]
"PlanckBT" or "Tb": Planck brightness temperature [K]
"W_m2_m_sr" or "W/(m^2 m sr)": Spectral radiance wavelength [W / m \(^{2}\) m sr]
"W_m2_m1_sr" or "W/(m^2 m-1 sr)": Spectral radiance wavenumber [W / m \(^{2}\) m \(^{-1}\) sr]
"unit" or "1": Unit spectral radiance [W / m \(^{2}\) Hz sr]

Workspace methods that require SpectralRadianceUnitType

spectral_radiance_transform_operatorSet()

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.SpectralRadianceUnitType.PlanckBT`	“PlanckBT” (`SpectralRadianceUnitType`)
Static Data	`pyarts3.arts.SpectralRadianceUnitType.RJBT`	“RJBT” (`SpectralRadianceUnitType`)
Static Data	`pyarts3.arts.SpectralRadianceUnitType.Tb`	“PlanckBT” (`SpectralRadianceUnitType`)
Static Data	`pyarts3.arts.SpectralRadianceUnitType.Tr`	“RJBT” (`SpectralRadianceUnitType`)
Static Data	`pyarts3.arts.SpectralRadianceUnitType.W_m2_m1_sr`	“W_m2_m1_sr” (`SpectralRadianceUnitType`)
Static Data	`pyarts3.arts.SpectralRadianceUnitType.W_m2_m_sr`	“W_m2_m_sr” (`SpectralRadianceUnitType`)
Static Data	`pyarts3.arts.SpectralRadianceUnitType.unit`	“unit” (`SpectralRadianceUnitType`)
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.SpectralRadianceUnitType) → 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.SpectralRadianceUnitType

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.SpectralRadianceUnitType]: 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.SpectralRadianceUnitType, /) → 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.SpectralRadianceUnitType, /) → bool: self >= other

__getstate__(self) → tuple[str]

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

__hash__(self) → int: Allows hashing

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

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

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

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

__repr__(self) → str

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

__str__(self) → str