OptimalEstimationSettings
#########################

.. currentmodule:: pyarts3.arts

.. autoclass:: OptimalEstimationSettings

  .. rubric:: Overview

  .. list-table::

    * - Method
      - :func:`~pyarts3.arts.OptimalEstimationSettings.readxml`
      - Read variable from file.
    * - Method
      - :func:`~pyarts3.arts.OptimalEstimationSettings.savexml`
      - Saves variable to file.
    * - Method
      - :func:`~pyarts3.arts.OptimalEstimationSettings.validate`
      - Check all controls; oemCalc and oemCalcReduced also validate before calculation.
    * - Static Method
      - :func:`~pyarts3.arts.OptimalEstimationSettings.fromxml`
      - Create variable from file.
    * - :class:`int`
      - :attr:`~pyarts3.arts.OptimalEstimationSettings.cg_max_iter`
      - CG iteration limit; zero selects max(1000, 2 * dimension).
    * - :class:`float`
      - :attr:`~pyarts3.arts.OptimalEstimationSettings.cg_tolerance`
      - Positive relative CG residual tolerance.
    * - :class:`bool`
      - :attr:`~pyarts3.arts.OptimalEstimationSettings.clear_matrices`
      - Release Jacobian and gain when true.
    * - :class:`int`
      - :attr:`~pyarts3.arts.OptimalEstimationSettings.display_progress`
      - Print progress when 1.
    * - :class:`~pyarts3.arts.LevenbergMarquardtSettings`
      - :attr:`~pyarts3.arts.OptimalEstimationSettings.lm`
      - LM damping and trial controls.
    * - :class:`int`
      - :attr:`~pyarts3.arts.OptimalEstimationSettings.max_iter`
      - Maximum outer iterations.
    * - :class:`float`
      - :attr:`~pyarts3.arts.OptimalEstimationSettings.max_start_cost`
      - Maximum initial cost; infinity disables the cutoff.
    * - :class:`~pyarts3.arts.OptimalEstimationMethod`
      - :attr:`~pyarts3.arts.OptimalEstimationSettings.method`
      - Algorithm and linear solver.
    * - :class:`float`
      - :attr:`~pyarts3.arts.OptimalEstimationSettings.stop_dx`
      - Positive convergence tolerance.
    * - Operator
      - :func:`~pyarts3.arts.OptimalEstimationSettings.__eq__`
      - Return self==value.
    * - Operator
      - :func:`~pyarts3.arts.OptimalEstimationSettings.__format__`
      - ``__format__(self, arg: str, /) -> str``
    * - Operator
      - :func:`~pyarts3.arts.OptimalEstimationSettings.__ge__`
      - Return self>=value.
    * - Operator
      - :func:`~pyarts3.arts.OptimalEstimationSettings.__gt__`
      - Return self>value.
    * - Operator
      - :func:`~pyarts3.arts.OptimalEstimationSettings.__hash__`
      - Return hash(self).
    * - Operator
      - :func:`~pyarts3.arts.OptimalEstimationSettings.__init__`
      - ``__init__(self, *, method: pyarts3.arts.OptimalEstimationMethod = "gn", max_iter: int = 10, stop_dx: float = 0.01, max_start_cost: float = inf, cg_tolerance: float = 1e-10, cg_max_iter: int = 0, lm: pyarts3.arts.LevenbergMarquardtSettings = LevenbergMarquardtSettings(initial_damping=10, decrease_factor=2, increase_factor=2, maximum_damping=100, damping_threshold=1, convergence_damping_limit=0, maximum_trials=100), display_progress: int = 0, clear_matrices: bool = False) -> None``
    * - Operator
      - :func:`~pyarts3.arts.OptimalEstimationSettings.__le__`
      - Return self<=value.
    * - Operator
      - :func:`~pyarts3.arts.OptimalEstimationSettings.__lt__`
      - Return self<value.
    * - Operator
      - :func:`~pyarts3.arts.OptimalEstimationSettings.__ne__`
      - Return self!=value.
    * - Operator
      - :func:`~pyarts3.arts.OptimalEstimationSettings.__repr__`
      - ``__repr__(self) -> str``
    * - Operator
      - :func:`~pyarts3.arts.OptimalEstimationSettings.__str__`
      - ``__str__(self) -> str``

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

  .. automethod:: OptimalEstimationSettings.readxml
  .. automethod:: OptimalEstimationSettings.savexml
  .. automethod:: OptimalEstimationSettings.validate

  .. rubric:: Static Methods

  .. automethod:: OptimalEstimationSettings.fromxml

  .. rubric:: Attributes

  .. attribute:: OptimalEstimationSettings.cg_max_iter
     :type: int

     CG iteration limit; zero selects max(1000, 2 * dimension).

     .. :class:`int`


  .. attribute:: OptimalEstimationSettings.cg_tolerance
     :type: float

     Positive relative CG residual tolerance.

     .. :class:`float`


  .. attribute:: OptimalEstimationSettings.clear_matrices
     :type: bool

     Release Jacobian and gain when true.

     .. :class:`bool`


  .. attribute:: OptimalEstimationSettings.display_progress
     :type: int

     Print progress when 1.

     .. :class:`int`


  .. attribute:: OptimalEstimationSettings.lm
     :type: ~pyarts3.arts.LevenbergMarquardtSettings

     LM damping and trial controls.

     .. :class:`~pyarts3.arts.LevenbergMarquardtSettings`


  .. attribute:: OptimalEstimationSettings.max_iter
     :type: int

     Maximum outer iterations.

     .. :class:`int`


  .. attribute:: OptimalEstimationSettings.max_start_cost
     :type: float

     Maximum initial cost; infinity disables the cutoff.

     .. :class:`float`


  .. attribute:: OptimalEstimationSettings.method
     :type: ~pyarts3.arts.OptimalEstimationMethod

     Algorithm and linear solver.

     .. :class:`~pyarts3.arts.OptimalEstimationMethod`


  .. attribute:: OptimalEstimationSettings.stop_dx
     :type: float

     Positive convergence tolerance.

     .. :class:`float`



  .. rubric:: Operators

  .. automethod:: OptimalEstimationSettings.__eq__
  .. automethod:: OptimalEstimationSettings.__format__
  .. automethod:: OptimalEstimationSettings.__ge__
  .. automethod:: OptimalEstimationSettings.__gt__
  .. automethod:: OptimalEstimationSettings.__hash__
  .. automethod:: OptimalEstimationSettings.__init__
  .. automethod:: OptimalEstimationSettings.__le__
  .. automethod:: OptimalEstimationSettings.__lt__
  .. automethod:: OptimalEstimationSettings.__ne__
  .. automethod:: OptimalEstimationSettings.__repr__
  .. automethod:: OptimalEstimationSettings.__str__