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

Fix detector attribute in EBSD signals from NORDIF calibration patter reader #569

Conversation

hakonanes
Copy link
Member

Description of the change

This PR makes sure the EBSD.detector attribute in signals returned from the NORDIF calibration pattern reader is an EBSDDetector with the correct shape and not just a dictionary to create a detector with, as is the case in 0.6.1. It is a minor bug, so I consider it unnecessary to make a patch release.

Other things:

  • Fix some links in the documentation
  • Silence warnings raised in orix after 0.10.1 was released which relates to deprecations there
  • Try to make the weekly (Monday) check of the notebooks pass with nbval

Progress of the PR

Minimal example of the bug fix or new feature

>>> import kikuchipy as kp
>>> s = kp.load("Setting.txt")

# Before

>>> s.detector
{'shape': (60, 60), 'sample_tilt': 70.0, 'tilt': 0.0, 'azimuthal': 0.0}

# Now

>>> s.detector
EBSDDetector (60, 60), px_size 1 um, binning 1, tilt 0.0, azimuthal 0.0, pc (0.5, 0.5, 0.5)

For reviewers

  • The PR title is short, concise, and will make sense 1 year later.
  • New functions are imported in corresponding __init__.py.
  • New features, API changes, and deprecations are mentioned in the unreleased
    section in CHANGELOG.rst.
  • New contributors are added to release.py and .all-contributorsrc and the table
    is regenerated.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added bug Something isn't working documentation This relates to the documentation deprecation Deprecated functionality labels Oct 5, 2022
@hakonanes hakonanes added this to the v0.7.0 milestone Oct 5, 2022
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes merged commit cae508b into pyxem:develop Oct 6, 2022
@hakonanes hakonanes deleted the fix-nordif-calibration-patter-reader-detector branch October 6, 2022 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working deprecation Deprecated functionality documentation This relates to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant