SensorMetaInfo

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

Metadata describing a sensor’s mapping from measurement_vec to a gridded field.

Wraps a variant of gridded field types, one per sensor kind:

Passive FFTS: SortedGriddedField1 — 1D grid of frequencies.
Camera: CameraGriddedField — 2D pixel grid (angular offsets from boresight) plus a color/frequency axis.

Grids are set at sensor construction time. Data is zeroed and later filled from measurement_vec by measurement_sensor_metaFromMeasurementVec(). The start index into measurement_vec is not stored; it is derived from the cumulative count() of preceding elements in the array.

Each metadata block can also carry its observation Time. Sensor builders create one block per geometry, allowing otherwise identical measurements to remain separated by acquisition time.

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`int`	`count`	Total number of scalar elements (product of all grid sizes)
`GriddedField1`	`data`	The variant gridded field data
`Time`	`time`	Observation time for this measurement block, or None when unspecified.
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	`__format__(self, arg: str, /) -> str`
Operator	`__ge__()`	Return self>=value.
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	`__init__(self, arg: pyarts3.arts.SensorMetaInfo) -> 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: SensorMetaInfo) → 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) → SensorMetaInfo

Create variable from file.

Parameters:: file (str) – A file that can be read
Raises:: RuntimeError – For any failure to read.

Attributes

count: int: Total number of scalar elements (product of all grid sizes)

data: GriddedField1: The variant gridded field data

time: Time: Observation time for this measurement block, or None when unspecified.

Operators

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

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

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

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

__hash__(): Return hash(self).

__init__(self) → None
__init__(self, arg: SensorMetaInfo) → None

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

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

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

__repr__(self) → str

__str__(self) → str