JacobianSubsurfaceTarget
########################

.. currentmodule:: pyarts3.arts

.. autoclass:: JacobianSubsurfaceTarget

  .. rubric:: Overview

  .. list-table::

    * - Method
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.readxml`
      - Read variable from file.
    * - Method
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.savexml`
      - Saves variable to file.
    * - Static Method
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.fromxml`
      - Create variable from file.
    * - :class:`Numeric`
      - :attr:`~pyarts3.arts.JacobianSubsurfaceTarget.d`
      - Perturbation magnitude
    * - :class:`~collections.abc.Callable`
      - :attr:`~pyarts3.arts.JacobianSubsurfaceTarget.inverse_jacobian`
      - Transform a native-unit Jacobian into model-state units.
    * - :class:`~collections.abc.Callable`
      - :attr:`~pyarts3.arts.JacobianSubsurfaceTarget.inverse_state`
      - Transform model-state values back into native target values.
    * - :class:`Index`
      - :attr:`~pyarts3.arts.JacobianSubsurfaceTarget.target_pos`
      - Target position
    * - :class:`~collections.abc.Callable`
      - :attr:`~pyarts3.arts.JacobianSubsurfaceTarget.transform_state`
      - Transform native target values into the model state.
    * - :class:`SubsurfaceKeyVal`
      - :attr:`~pyarts3.arts.JacobianSubsurfaceTarget.type`
      - Type of target
    * - :class:`Index`
      - :attr:`~pyarts3.arts.JacobianSubsurfaceTarget.x_size`
      - Size of target in state vector
    * - :class:`Index`
      - :attr:`~pyarts3.arts.JacobianSubsurfaceTarget.x_start`
      - Start index of target in state vector
    * - Operator
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.__eq__`
      - Return self==value.
    * - Operator
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.__format__`
      - __format__(self, arg: str, /) -> str
    * - Operator
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.__ge__`
      - Return self>=value.
    * - Operator
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.__gt__`
      - Return self>value.
    * - Operator
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.__hash__`
      - Return hash(self).
    * - Operator
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.__init__`
      - __init__(self, arg: pyarts3.arts.JacobianSubsurfaceTarget) -> None
    * - Operator
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.__le__`
      - Return self<=value.
    * - Operator
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.__lt__`
      - Return self<value.
    * - Operator
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.__ne__`
      - Return self!=value.
    * - Operator
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.__repr__`
      - __repr__(self) -> str
    * - Operator
      - :func:`~pyarts3.arts.JacobianSubsurfaceTarget.__str__`
      - __str__(self) -> str

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

  .. automethod:: JacobianSubsurfaceTarget.readxml
  .. automethod:: JacobianSubsurfaceTarget.savexml

  .. rubric:: Static Methods

  .. automethod:: JacobianSubsurfaceTarget.fromxml

  .. rubric:: Attributes

  .. attribute:: JacobianSubsurfaceTarget.d
     :type: Numeric

     Perturbation magnitude

     .. :class:`Numeric`


  .. attribute:: JacobianSubsurfaceTarget.inverse_jacobian
     :type: ~collections.abc.Callable

     Transform a native-unit Jacobian into model-state units.

     The callable signature is ``(jacobian, model_state, context) -> jacobian`` and
     must apply the derivative of ``inverse_state`` with respect to the model
     state.

     .. :class:`~collections.abc.Callable`


  .. attribute:: JacobianSubsurfaceTarget.inverse_state
     :type: ~collections.abc.Callable

     Transform model-state values back into native target values.

     The callable signature is ``(model_state, context) -> native_state``.  The
     context is the complete field or data object that owns the target.

     .. :class:`~collections.abc.Callable`


  .. attribute:: JacobianSubsurfaceTarget.target_pos
     :type: Index

     Target position

     .. :class:`Index`


  .. attribute:: JacobianSubsurfaceTarget.transform_state
     :type: ~collections.abc.Callable

     Transform native target values into the model state.

     The callable signature is ``(native_state, context) -> model_state``.  The
     context is the complete field or data object that owns the target.

     .. :class:`~collections.abc.Callable`


  .. attribute:: JacobianSubsurfaceTarget.type
     :type: SubsurfaceKeyVal

     Type of target

     .. :class:`SubsurfaceKeyVal`


  .. attribute:: JacobianSubsurfaceTarget.x_size
     :type: Index

     Size of target in state vector

     .. :class:`Index`


  .. attribute:: JacobianSubsurfaceTarget.x_start
     :type: Index

     Start index of target in state vector

     .. :class:`Index`



  .. rubric:: Operators

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