get_angular_correlation#

PolarDiffraction2D.get_angular_correlation(mask=None, normalize=True, inplace=False, **kwargs)[source]#

Calculate the angular auto-correlation function in the form of a Signal2D class.

The angular correlation measures the angular symmetry by computing the self or auto correlation. The equation being calculated is $ C(phi,k,n)= frac{ <I(theta,k,n)*I(theta+phi,k,n)>_theta-<I(theta,k,n)>^2}{<I(theta,k,n)>^2}$

Parameters:

  • mask (Numpy array or Signal2D) – A bool mask of values to ignore of shape equal to the signal shape. If the mask is a BaseSignal than it is iterated with the polar signal

  • normalize (bool) – Normalize the radial correlation by the average value at some radius.

  • kwargs (dict) – Any additional options for the hyperspy.api.signals.BaseSignal.map() function

  • inplace (bool) – From hyperspy.api.signals.BaseSignal.map(). inplace=True means the signal is overwritten.

Returns:

correlation – The radial correlation for the signal2D, when inplace is False, otherwise None

Return type:

Signal2D