get_phase_signal#

BeamShift.get_phase_signal(rotation=None, add_color_wheel_marker=True)[source]#

Get beam shift phase image visualized using continuous color scale.

Converts the x and y beam shifts into an RGB array, showing the direction of the beam shifts.

Useful for visualizing magnetic domain structures.

Parameters:

rotation (float, optional) – In degrees. Useful for correcting the mismatch between scan direction and diffraction pattern rotation.
autolim (bool, default True)
autolim_sigma (float, default 4)

Returns:

phase_signal

Return type:

HyperSpy 2D RGB signal

Examples

>>> s = pxm.data.dummy_data.get_simple_beam_shift_signal()
>>> s_color = s.get_phase_signal(rotation=20)
>>> s_color.plot()