SensorObsel

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

A single observation element.

This should result in a single element in a measurement_vector.

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 \(^{-2}\) Hz \(^{-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.

Note

Multiple SensorObsel can be used to represent a single sensor with multiple channels, such as a sensor with multiple detectors or a sensor with multiple frequency channels. They then can conveniently share much of their grids, but have different weighting functions and/or different sampling devices.

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`AscendingGrid`	`f_grid`	Frequency grid
`SensorPosLosVector`	`poslos`	Position and line of sight grid
`SparseStokvecMatrix`	`weight_matrix`	Weights matrix
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__getstate__()`	Helper for pickle.
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	__init__(self, arg0: pyarts3.arts.AscendingGrid, arg1: pyarts3.arts.SensorPosLosVector, arg2: pyarts3.arts.StokvecMatrix, /) -> None
Operator	`__le__()`	Return self<=value.
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self) → None
__init__(self, arg: pyarts3.arts.SensorObsel) → None
__init__(self, arg0: pyarts3.arts.AscendingGrid, arg1: pyarts3.arts.SensorPosLosVector, arg2: pyarts3.arts.StokvecMatrix, /) → 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.SensorObsel

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

Attributes

f_grid: AscendingGrid: Frequency grid

poslos: SensorPosLosVector: Position and line of sight grid

weight_matrix: SparseStokvecMatrix: Weights matrix

Operators

__eq__(value, /): Return self==value.

__format__(self, arg: str, /) → str

__ge__(value, /): Return self>=value.

__getstate__(): Helper for pickle.

__gt__(value, /): Return self>value.

__hash__(): Return hash(self).

__init__(self) → None
__init__(self, arg: pyarts3.arts.SensorObsel) → None
__init__(self, arg0: pyarts3.arts.AscendingGrid, arg1: pyarts3.arts.SensorPosLosVector, arg2: pyarts3.arts.StokvecMatrix, /) → None

__le__(value, /): Return self<=value.

__lt__(value, /): Return self<value.

__ne__(value, /): Return self!=value.

__repr__(self) → str

__str__(self) → str