PredefinedSensor

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

Code-defined satellite sensor channel configurations.

Each option identifies a complete instrument channel set, including channel centers, mixer offsets, bandwidths, and polarization. These definitions are compiled into ARTS and require no external sensor-response data files.

Valid options:

"AMSUA" or "AMSU-A": The 15-channel Advanced Microwave Sounding Unit A instrument.
"AMSUB" or "AMSU-B": The 5-channel Advanced Microwave Sounding Unit B instrument.
"ICI" or "IceCloudImager": The 11-channel Ice Cloud Imager instrument.
"HIRS" or "NOAA14HIRS": The 19-channel NOAA-14 High-resolution Infrared Radiation Sounder.
"AVHRR" or "NOAA19AVHRR": The 3-channel NOAA-19 Advanced Very High Resolution Radiometer response.
"MVIRI" or "MET2MVIRI": The 3-channel Meteosat-2 Visible and Infrared Imager response.
"SEVIRI" or "MET9SEVIRI": The 12-channel Meteosat-9 Spinning Enhanced Visible and Infrared Imager response.

Workspace methods that require PredefinedSensor

measurement_sensorFromPredefined()

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.PredefinedSensor.AMSUA`	“AMSUA” (`PredefinedSensor`)
Static Data	`pyarts3.arts.PredefinedSensor.AMSUB`	“AMSUB” (`PredefinedSensor`)
Static Data	`pyarts3.arts.PredefinedSensor.AVHRR`	“AVHRR” (`PredefinedSensor`)
Static Data	`pyarts3.arts.PredefinedSensor.HIRS`	“HIRS” (`PredefinedSensor`)
Static Data	`pyarts3.arts.PredefinedSensor.ICI`	“ICI” (`PredefinedSensor`)
Static Data	`pyarts3.arts.PredefinedSensor.IceCloudImager`	“ICI” (`PredefinedSensor`)
Static Data	`pyarts3.arts.PredefinedSensor.MET2MVIRI`	“MVIRI” (`PredefinedSensor`)
Static Data	`pyarts3.arts.PredefinedSensor.MET9SEVIRI`	“SEVIRI” (`PredefinedSensor`)
Static Data	`pyarts3.arts.PredefinedSensor.MVIRI`	“MVIRI” (`PredefinedSensor`)
Static Data	`pyarts3.arts.PredefinedSensor.NOAA14HIRS`	“HIRS” (`PredefinedSensor`)
Static Data	`pyarts3.arts.PredefinedSensor.NOAA19AVHRR`	“AVHRR” (`PredefinedSensor`)
Static Data	`pyarts3.arts.PredefinedSensor.SEVIRI`	“SEVIRI” (`PredefinedSensor`)
Operator	`__eq__()`	self == other
Operator	`__format__()`	Default object formatter.
Operator	`__ge__()`	self >= other
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	`__str__()`	`__str__(self) -> str`

Constructors

__init__(self) → None
__init__(self, arg: PredefinedSensor) → 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) → PredefinedSensor

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:: PredefinedSensor

get_options() → list[PredefinedSensor]: Get a list of all options

get_options_as_strings(i: int = 0) → list[str]: Get a list of all options as strings

Operators

__eq__(self, arg: PredefinedSensor, /) → bool: self == other

__format__(format_spec, /)

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__(self, arg: PredefinedSensor, /) → bool: self >= other

__gt__(self, arg: PredefinedSensor, /) → bool: self > other

__hash__(self) → int: Allows hashing

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

__le__(self, arg: PredefinedSensor, /) → bool: self <= other

__lt__(self, arg: PredefinedSensor, /) → bool: self < other

__ne__(self, arg: PredefinedSensor, /) → bool: self != other

__repr__(self) → str

__str__(self) → str