pycvcam.core.Transform._get_jacobian_shorthands#

Transform._get_jacobian_shorthands()[source]#

Return a dictionary of short-hand notation for the Jacobian matrices.

This dictionary can be used to add custom views of the jacobian_dp matrix with respect to the parameters of the transformation.

{
    "dk": (0, 2, "Custom Jacobian view for two first parameters related to k1 and k2"),
    "dother": (2, 4, "Custom Jacobian view for other parameters related to k3 and k4"),
}
Returns:

A dictionary where keys are names of the custom Jacobian views and values are tuples containing:

  • start index (int): The starting index of the parameters to include in the custom Jacobian view.

  • end index (int): The ending index of the parameters to include in the custom Jacobian view.

  • doc (Optional[str]): A documentation string for the custom Jacobian view.

Return type:

Dict[str, Tuple[int, int, Optional[str]]]