get_magnitude_signal#

DPCSignal2D.get_magnitude_signal(autolim=True, autolim_sigma=4, magnitude_limits=None)[source]#

Get DPC magnitude image visualized as greyscale.

Converts the x and y beam shifts into a magnitude map, showing the magnitude of the beam shifts.

Useful for visualizing magnetic domain structures.

Parameters:

autolim (bool, default True)
autolim_sigma (float, default 4)
magnitude_limits (tuple of floats, default None) – Manually sets the value limits for the magnitude signal. For this, autolim needs to be False.

Returns:

magnitude_signal

Return type:

HyperSpy 2D signal

Examples

>>> s = pxm.data.dummy_data.get_simple_dpc_signal()
>>> s_magnitude = s.get_magnitude_signal()
>>> s_magnitude.plot()