SensorObsel

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

A single observation element.

Expected use of this type is to generate the measurement vector of a sensor, where this observation element represent the readout from that sensor in a convenient unit (commonly Kelvin or W sr \(^{-1}m :math:`^{-2}Hz :math:`^{-1}\), but not exclusively)

It deals with averaging the frequency grid sampled by a sensor element and the transmission of the sensor system onto the sampling device, as well as the sampling device’s polarization response.

Overview

Method	cutoff_frequency_weights()	Cuts out parts of the frequency grid with low weights
Method	ok()	Check if the obsel is valid
Method	readxml()	Read variable from file
Method	savexml()	Saves variable to file
Method	set_frequency_gaussian()	Gaussian frequency grid
Method	set_frequency_lochain()	Local oscillator style channel selection frequency grid
Static Method	fromxml()	Create variable from file
Attribute	f_grid	Frequency grid
Attribute	f_grid_w	Frequency weights
Attribute	polarization	Polarization sampling
Attribute	poslos	Position and line of sight grid
Attribute	poslos_w	Position and line of sight weights
Operator	__eq__()	Return self==value.
Operator	__ge__()	Return self>=value.
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__le__()	Return self<=value.
Operator	__lt__()	Return self<value.
Operator	__ne__()	Return self!=value.

Constructors

__init__(self) → None

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

__init__(self, arg0: pyarts.arts.Vector, arg1: pyarts.arts.AscendingGrid, arg2: pyarts.arts.MuelmatVector, arg3: pyarts.arts.SensorPosLosVector, arg4: pyarts.arts.Stokvec, /) → None

From pos and los

Methods

cutoff_frequency_weights(self, cutoff: float, relative: bool = True) → bool

Cuts out parts of the frequency grid with low weights

ok(self) → bool

Check if the obsel is valid

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 (ascii. zascii, or binary)

• clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:

Throws RuntimeError for any failure to save

set_frequency_gaussian(self, f0: float, fwhm: float, Nfwhm: int = 5, Nhwhm: int = 3) → None

Gaussian frequency grid

Parameters:

• f0 (float) – Center frequency

• fwhm (float) – Full width at half maximum

• Nfwhm (int) – Number of fwhm to include

• Nhwhm (int) – Number of half width at half maximum to include

set_frequency_lochain(self, f0s: pyarts.arts.Vector, width: float, N: int, filter: str = '') → None

Local oscillator style channel selection frequency grid

Parameters:

• f0s (list of descending floats) – Effectively, the local oscillator frequencies for the channels

• width (float) – Boxcar width of each sub-channel

• N (int) – Number of points per sub-channel

• filter (list of int, optional) – Selection of sub-channels to include - one shorter than f0s with each element being U for upper bandpass, L for lower bandpass, or anything else for full bandpass. Default is full bandpass.

Static Methods

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

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

Attributes

f_grid

Frequency grid

f_grid_w

Frequency weights

polarization

Polarization sampling

poslos

Position and line of sight grid

poslos_w

Position and line of sight weights

Operators

__eq__(value, /)

Return self==value.

__ge__(value, /)

Return self>=value.

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.