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 PC conventions and add a changelog #10

Merged

Conversation

hakonanes
Copy link
Collaborator

@hakonanes hakonanes commented Feb 11, 2022

  • Fix the PC conventions by indexing correctly into the Fortran NumPy array t.
  • Add a changelog, which can be used to communicate new features and the like to users, following Keep a Changelog. In the future, this changelog can be added as-is to a documentation page similar to kikuchipy's changelog.

I checked the supported vendor conventions in pyebsdindex.ebsd_index.EBSDIndexer.index_pats(), and they now work with the conventions used in kikuchipy, with one exception: The EMsoft convention here corresponds to the EMsoft v4 convention in kikuchipy... I believe it is correct here, and wrong in kikuchipy, because in EMsoft >= 5.0, the detector screen is viewed towards the sample, and xpc increases towards the right from the middle of the detector. Could you confirm that it's the EMsoft v5 convention you implemented?

Should close #3.

@drowenhorst-nrl drowenhorst-nrl merged commit 3096d4b into USNavalResearchLaboratory:main Feb 11, 2022
@hakonanes hakonanes deleted the fix-pc-conventions branch February 11, 2022 11:49
@drowenhorst-nrl
Copy link
Collaborator

Could you confirm that it's the EMsoft v5 convention you implemented?
In PyEBSDIndex I intended using the EMSoft v5 convention. +x moves right across the detector, +y moves up. Origin is at the center of the detector as noted here.
Thanks for the testing and correction. That col,row habit is going to take a long time to break.

@hakonanes
Copy link
Collaborator Author

In PyEBSDIndex I intended using the EMSoft v5 convention. +x moves right across the detector, +y moves up. Origin is at the center of the detector as noted here.

Great, then I'm certain we have it wrong in kikuchipy (but correct in the docstring text), both in the docstring equation EMsoft -> Bruker and the corresponding code, which previously was correct... @IMBalENce and I discussed this previously before making the change, but apparently had it wrong. Oh well.

Thanks for the testing and correction.

No problem, it's a joy using PyEBSDIndex, and equally so to contribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support for a non-square detector
2 participants