template_match_ring#

Diffraction2D.template_match_ring(r_inner=5, r_outer=7, inplace=False, **kwargs)[source]#

Template match the signal dimensions with a ring.

Used to find diffraction rings in convergent beam electron diffraction data.

Parameters:
  • r_inner, r_outer (scalar, optional) – Inner and outer radius of the rings.

  • lazy_output (bool, default True) – If True, will return a LazyDiffraction2D object. If False, will compute the result and return a Diffraction2D object.

  • show_progressbar (bool, default True)

  • inplace (bool, optional) – If True, the data is replaced by the filtered data. If False, a new signal is returned. Default False.

  • kwargs – Passed to pyxem.utils.diffraction.normalize_template_match() or the hyperspy.api.BaseSignal.map() method.

Return type:

pyxem.signals.Diffraction2D

Examples

>>> s = pxm.data.dummy_data.get_cbed_signal()
>>> s_template = s.template_match_ring(show_progressbar=False)
>>> s.plot()