comet_maths.linear_algebra.matrix_calculation.calculate_Jacobian

comet_maths.linear_algebra.matrix_calculation.calculate_Jacobian#

comet_maths.linear_algebra.matrix_calculation.calculate_Jacobian(fun: Callable, x: array, Jx_diag: bool | None = False, step: float | None = None) array[source]#

Calculate the local Jacobian of function y=f(x) for a given value of x

Parameters:
  • fun – flattened measurement function

  • x – flattened local values of input quantities

  • Jx_diag – Bool to indicate whether the Jacobian matrix can be described with semi-diagonal elements. With this we mean that the measurand has the same shape as each of the input quantities and the square jacobain between the measurand and each of the input quantities individually, only has diagonal elements. Defaults to False

  • step – Defines the spacing used when calculating the Jacobian with numdifftools

Returns:

Jacobian