normalize_template_match#

pyxem.utils.diffraction.normalize_template_match(z, template, subtract_min=True, pad_input=True, **kwargs)[source]#

Matches a template with an image z. Preformed a normalized cross-correlation using the given templates. If subtract_min is True then the minimum value will be subtracted from the correlation.

Parameters:

  • z (numpy.ndarray) – Two-dimensional data array containing signal.

  • template (numpy.ndarray) – Two-dimensional data array containing template.

  • subtract_min (bool) – If True the minimum value will be subtracted from the correlation.

  • pad_input (bool) – If True the input array will be padded. (This should be True otherwise the result will be shifted by half the template size)

  • **kwargs – Keyword arguments to be passed to skimage.feature.match_template()