colour_hdri.distortion.characterise_vignette_2D_function#

colour_hdri.distortion.characterise_vignette_2D_function(image: ArrayLike, function: Literal['Parabolic', 'Hyperbolic Cosine'] | str = 'Parabolic') → DataVignetteCharacterisation[source]#

Characterise the vignette of given image using a given 2D function.

Parameters:

  • image (ArrayLike) – Image to characterise the vignette of.

  • function (Literal['Parabolic', 'Hyperbolic Cosine'] | str) – Characterisation function.

Returns:

Vignette characterisation.

Return type:

DataVignetteCharacterisation

Examples

>>> characterise_vignette_2D_function(  
...     apply_radial_gradient(np.ones([5, 7]))
... )
DataVignetteCharacterisation(parameters=array([[-5.        ,  0.5       ,  0.9       , -4.4699758...,  0.5       ,
         0.9       ]]), principal_point=array([ 0.4       ,  0.4285714...]))