OptimalEstimationDiagnostics

class pyarts3.arts.OptimalEstimationDiagnostics(*args, **kwargs)

Named OEM status, normalized costs, iteration count, damping history, and messages. Unavailable costs are NaN.

Overview

Method	readxml()	Read variable from file.
Method	savexml()	Saves variable to file.
Static Method	fromxml()	Create variable from file.
list[str]	errors	Errors and warnings recorded by OEM.
float	final_cost	Final total cost per measurement.
float	initial_cost	Starting total cost per measurement.
int	iterations	Number of completed outer iterations, zero when not run.
Vector	lm_ga_history	Initial and updated LM damping values.
float	measurement_cost	Final measurement cost per measurement.
OptimalEstimationStatus	status	Named OEM outcome; NotRun before inversion.
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.OptimalEstimationDiagnostics) -> 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: OptimalEstimationDiagnostics) → 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) → OptimalEstimationDiagnostics

Create variable from file.

Parameters:

file (str) – A file that can be read

Raises:

RuntimeError – For any failure to read.

Attributes

errors: list[str]

Errors and warnings recorded by OEM.

final_cost: float

Final total cost per measurement.

initial_cost: float

Starting total cost per measurement.

iterations: int

Number of completed outer iterations, zero when not run.

lm_ga_history: Vector

Initial and updated LM damping values.

measurement_cost: float

Final measurement cost per measurement.

status: OptimalEstimationStatus

Named OEM outcome; NotRun before inversion.

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: OptimalEstimationDiagnostics) → None

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

__str__(self) → str