SpectralRadianceUnitType

class pyarts.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]\to [F(I),F(Q),F(U),F(V)]$$

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

For Planck brightness temperature the conversion is:

$$[I,Q,U,V]\to [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)]$$

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

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

$$[I,Q,U,V]\to [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]\to [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]\to [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 variables of type SpectralRadianceUnitType

spectral_radiance_unit

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.SpectralRadianceUnitType.PlanckBT	“PlanckBT” - SpectralRadianceUnitType
Static Data	pyarts.arts.SpectralRadianceUnitType.RJBT	“RJBT” - SpectralRadianceUnitType
Static Data	pyarts.arts.SpectralRadianceUnitType.Tb	“PlanckBT” - SpectralRadianceUnitType
Static Data	pyarts.arts.SpectralRadianceUnitType.Tr	“RJBT” - SpectralRadianceUnitType
Static Data	pyarts.arts.SpectralRadianceUnitType.W_m2_m1_sr	“W_m2_m1_sr” - SpectralRadianceUnitType
Static Data	pyarts.arts.SpectralRadianceUnitType.W_m2_m_sr	“W_m2_m_sr” - SpectralRadianceUnitType
Static Data	pyarts.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: pyarts.arts.SpectralRadianceUnitType) → 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.SpectralRadianceUnitType

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.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: pyarts.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: pyarts.arts.SpectralRadianceUnitType, /) → bool

self >= other

__getstate__(self) → tuple[str]

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

self > other

__hash__(self) → int

Allows hashing

__init__(self) → None

__init__(self, arg: pyarts.arts.SpectralRadianceUnitType) → None

__init__(self, arg: str, /) → None

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

self <= other

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

self < other

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

self != other

__repr__(self) → str

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

__str__(self) → str