MeasurementVectorSumupKernel

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

The kernel to use for summing up the measurement vectors.

This is used when summing up measurement_vec and measurement_jac.

Tthe observation elements in measurement_sensor. The kernel choice is just a trade-off between memory and performance. The “low memory” option will never allocate more than one StokvecVector and StokvecMatrix per core. The “high performance” option will allocate as many StokvecVector and StokvecMatrix as needed for the full observation geometry.

The low memory computation time is \(O(MN)\), where \(M\) is the number of frequency grids times the number of observation geometries, and \(N\) is the number of observation elements in measurement_sensor. It will only ever allocate memory proportional to \(N\).

The high performance computation time is \(O(M+N)\). It will allocate memory proportional to \(MN\). You should generally use this option unless you run into memory constraints.

Valid options:

"LowMem" or "Low Memory": Use the low memory kernel
"HighPerf" or "High Performance": Use the high performance kernel

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.MeasurementVectorSumupKernel.HighPerf`	“HighPerf” (`MeasurementVectorSumupKernel`)
Static Data	`pyarts3.arts.MeasurementVectorSumupKernel.LowMem`	“LowMem” (`MeasurementVectorSumupKernel`)
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: pyarts3.arts.MeasurementVectorSumupKernel) → 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) → pyarts3.arts.MeasurementVectorSumupKernel

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

get_options() → list[pyarts3.arts.MeasurementVectorSumupKernel]: 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: pyarts3.arts.MeasurementVectorSumupKernel, /) → bool: self == other

__format__(format_spec, /)

Default object formatter.

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

__ge__(self, arg: pyarts3.arts.MeasurementVectorSumupKernel, /) → bool: self >= other

__gt__(self, arg: pyarts3.arts.MeasurementVectorSumupKernel, /) → bool: self > other

__hash__(self) → int: Allows hashing

__init__(self) → None
__init__(self, arg: pyarts3.arts.MeasurementVectorSumupKernel) → None
__init__(self, arg: str, /) → None

__le__(self, arg: pyarts3.arts.MeasurementVectorSumupKernel, /) → bool: self <= other

__lt__(self, arg: pyarts3.arts.MeasurementVectorSumupKernel, /) → bool: self < other

__ne__(self, arg: pyarts3.arts.MeasurementVectorSumupKernel, /) → bool: self != other

__repr__(self) → str

__str__(self) → str