Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fit linear plane in pyxem.signals.BeamShift.get_linear_plane by minimising magnitude variance #1116

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Prev Previous commit
Next Next commit
Documentation
  • Loading branch information
sivborg committed Sep 17, 2024
commit 09b5371927a8cfd70ce291e63d1e225aa75345d5
3 changes: 2 additions & 1 deletion pyxem/signals/beam_shift.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 96,8 @@ def get_linear_plane(
last three entries for the y-shift. Currently only implemented for the
case when `constrain_magnitude` is `True`.
constrain_magnitude : bool, optional
Fits the linear planes to deflections with constant magnitude.
Fits the linear planes to deflections with constant magnitude. By default
set to `False`.
In the presence of electromagnetic fields in the sample area, least squares
fitting can give inaccurate results. If the region is expected to have
uniform field strength, we can fit planes by trying to minimise the variance
Expand Down
Loading