inversion_iterate_agendaOperator

class pyarts.arts.inversion_iterate_agendaOperator(*args, **kwargs)

Work in progress …

The WSV measurement_jacobian is both in- and output. As input variable, measurement_jacobian is assumed to be valid for the previous iteration. For the first iteration the input measurement_jacobian shall be set to have size zero, to flag that there is not yet any calculated Jacobian.

Workspace methods that require inversion_iterate_agendaOperator

Overview

Method	`readxml()`	Read variable from file
Method	`savexml()`	Saves variable to file
Static Method	`fromxml()`	Create variable from file
Operator	`__call__()`	Execute the method directly in python
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, arg: pyarts.arts.inversion_iterate_agendaOperator) -> 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, arg: collections.abc.Callable[[pyarts.arts.Vector, int, int], tuple[pyarts.arts.Vector, pyarts.arts.Matrix]], /) → None
__init__(self) → None
__init__(self, arg: pyarts.arts.inversion_iterate_agendaOperator) → None

Methods

readxml(self, file: str) → None

Read variable from file

Parameters:: file (str) – A file that can be read

On Error:: Throws RuntimeError for any failure to read

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) → None

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) – Type of file to save. See FileType for options.
clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:: Throws RuntimeError for any failure to save

Static Methods

fromxml(file: str) → pyarts.arts.inversion_iterate_agendaOperator

Create variable from file

Parameters:: file (str) – A file that can be read

On Error:: Throws RuntimeError for any failure to read

Operators

__call__(self, model_state_vector: pyarts.arts.Vector, inversion_iterate_agenda_do_jacobian: int, inversion_iterate_agenda_counter: int) → tuple[pyarts.arts.Vector, pyarts.arts.Matrix]

Execute the method directly in python

Parameters:

model_state_vector (Vector) – A state vector of the model. See also model_state_vector.
inversion_iterate_agenda_do_jacobian (Index) – A boolean for if Jacobian calculations should be done. See also inversion_iterate_agenda_do_jacobian.
inversion_iterate_agenda_counter (Index) – A counter for the inversion iterate agenda. See also inversion_iterate_agenda_counter.

Returns:

measurement_vector_fitted (Vector) – As measurement_vector, but fitted to the model. See also measurement_vector_fitted.
measurement_jacobian (Matrix) – The partial derivatives of the measurement_vector. See also measurement_jacobian.

__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, arg: collections.abc.Callable[[pyarts.arts.Vector, int, int], tuple[pyarts.arts.Vector, pyarts.arts.Matrix]], /) → None
__init__(self) → None
__init__(self, arg: pyarts.arts.inversion_iterate_agendaOperator) → None

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

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

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

__repr__(self) → str

__str__(self) → str