get_resolved_pearson_correlation#

PolarDiffraction2D.get_resolved_pearson_correlation(mask=None, krange=None, inplace=False, **kwargs)[source]#

Calculate the pearson rotational correlation with k resolution in the form of a Signal2D class.

Parameters:

  • mask (Numpy array) – A bool mask of values to ignore of shape equal to the signal shape. True for elements masked, False for elements unmasked

  • krange (tuple of int or float) – The range of k values for segment correlation. If type is int, the value is taken as the axis index. If type is float the value is in corresponding unit. If None (default), use the entire pattern .

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

  • kwargs (dict) – Any additional options for the map() function

Returns:

correlation – The pearson rotational correlation when inplace is False, otherwise return None

Return type:

Signal2D,