BeamShift

class pyxem.signals.BeamShift(*args, **kwargs)

Bases: DiffractionVectors1D

Signal class for working with shift of the direct beam.

Attributes

BeamShift.beam_energy

Methods

BeamShift.calibrate_electric_shifts(thickness)	Calibrate the shifts into the electric field
BeamShift.get_bivariate_histogram([...])	Useful for finding the distribution of the beam shifts.
BeamShift.get_color_signal(**kwargs)	[Deprecated]
BeamShift.get_linear_plane([mask, ...])	Fit linear planes to the beam shifts, and returns a BeamShift signal with the planes.
BeamShift.get_magnitude_phase_signal([...])	Get beam shift image visualized using continuous color scale.
BeamShift.get_magnitude_signal([autolim, ...])	Get beam shift magnitude image visualized as greyscale.
BeamShift.get_phase_signal([rotation, ...])	Get beam shift phase image visualized using continuous color scale.
BeamShift.make_linear_plane(**kwargs)	[Deprecated]
BeamShift.phase_retrieval([method, ...])	Retrieve the phase from two orthogonal phase gradients.
BeamShift.pixels_to_calibrated_units([...])	Convert the beam shifts from pixels to calibrated units using the signal axes passed or saved in the metadata.
BeamShift.plot_on_signal(signal, **kwargs)	Plot the beam shifts on top of a signal.
BeamShift.rotate_beam_shifts(angle)	Rotate the beam shift vector.
BeamShift.rotate_scan_dimensions(angle[, ...])	Rotate the scan dimensions by angle.