jacobianSetAffineTransformation
- Workspace.jacobianSetAffineTransformation(self: pyarts.arts._Workspace, jacobian_quantities: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfRetrievalQuantity]] = self.jacobian_quantities, transformation_matrix: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix], offset_vector: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) None
Adds an affine transformation of the last element of
jacobian_quantities
.See
jacobianSetFuncTransformation()
for a general description of how retrieval transformations are defined. Transformations are not applied by methods such asyCalc()
. Instead, the methodjacobianAdjustAndTransform()
must be called to activate the transformations.The affine transformation is specified by a transformation matrix, A, and an offset vector, b. These two are applied as described in
jacobianSetFuncTransformation()
.The transformations is applied as:
x = A * ( z - b )
where z is the retrieval quantity on the standard retrieval grids and x is the final state vector.
So far, the following must be true for valid A-matrices:
z = A' * x + b
That is, the reversed transformation is given by A transposed.
This method must only be called if an affine transformation is wanted. Default is to make no such tranformation at all.
Author(s): Simon Pfreundschuh
- Parameters:
jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See
jacobian_quantities
, defaults toself.jacobian_quantities
[INOUT]transformation_matrix (Matrix) – The transformation matrix A. [IN]
offset_vector (Vector) – The offset vector b. [IN]
verbosity (Verbosity) – ARTS verbosity. See
verbosity
, defaults toself.verbosity
[IN]