get_neighbour_dot_product_matrices#

EBSD.get_neighbour_dot_product_matrices(window: Window | None = None, zero_mean: bool = True, normalize: bool = True, dtype_out: str | dtype | type = 'float32', show_progressbar: bool | None = None) → ndarray | Array[source]#

Get an array with dot products of a pattern and its neighbours within a window.

Parameters:
window

Window with integer coefficients defining the neighbours to calculate the dot products with. If not given, the four nearest neighbours are used. Must have the same number of dimensions as signal navigation dimensions.

zero_mean

Whether to subtract the mean of each pattern individually to center the intensities about zero before calculating the dot products. Default is True.

normalize

Whether to normalize the pattern intensities to a standard deviation of 1 before calculating the dot products. This operation is performed after centering the intensities if zero_mean=True. Default is True.

dtype_out

Data type of the output map. Default is "float32".

show_progressbar

Whether to show a progressbar. If not given, the value of hyperspy.api.preferences.General.show_progressbar is used.

Returns:
dp_matrices

Dot products between a pattern and its nearest neighbours.