add_peak_array_as_markers#

Diffraction2D.add_peak_array_as_markers(peak_array, permanent=True, **kwargs)[source]#

[Deprecated] Add a peak array to the signal as HyperSpy markers.

Parameters:

peak_array (NumPy 4D array)
color (string, optional) – Default ‘red’
size (scalar, optional) – Default 20
permanent (bool, optional) – Default False, if True the markers will be added to the signal permanently.
**kwargs – Passed to hyperspy.api.plot.markers.Points

Examples

>>> s, parray = pxm.data.dummy_data.get_simple_ellipse_signal_peak_array()
>>> s.add_peak_array_as_markers(parray)
>>> s.plot()

Notes

Deprecated since version 0.16.0: Function add_peak_array_as_markers() is deprecated and will be removed in version 1.0.0.