2.3. distoptica.from_standard_to_generic_coord_transform_params

from_standard_to_generic_coord_transform_params(standard_coord_transform_params=None, skip_validation_and_conversion=False)[source]

Reparameterize a set of standard coordinate transformation parameters to to a set of generic coordinate transformation parameters.

The current Python function returns an instance of the class distoptica.CoordTransformParams, which store the parameters of a generic coordinate transformation that is mathematically equivalent to a standard coordinate transformation specified by the object standard_coord_transform_params. See the documentation for the classes distoptica.CoordTransformParams and distoptica.StandardCoordTransformParams for discussions on the parameterization of coordinate transformations.

Parameters:
standard_coord_transform_paramsdistoptica.StandardCoordTransformParams | None, optional

If standard_coord_transform_params is set to None, then the standard coordinate transformation \(\left(T_{⌑;x}\left(u_{x},u_{y}\right), T_{⌑;y}\left(u_{x},u_{y}\right)\right)\) is the identity transformation. Otherwise, standard_coord_transform_params specifies the parameters of the standard coordinate transformation.

skip_validation_and_conversionbool, optional

If skip_validation_and_conversion is set to False, then validations and conversions are performed on the above parameters.

Otherwise, if skip_validation_and_conversion is set to True, no validations and conversions are performed on the above parameters. This option is desired primarily when the user wants to avoid potentially expensive validation and/or conversion operations.

Returns:
generic_coord_transform_paramsdistoptica.CoordTransformParams

The parameters that specify the generic coordinate transformation that is mathematically equivalent to the standard coordinate transformation.