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

Reader for EBSD patterns in EDAX TSL's binary UP1/2 files #570

Merged
merged 9 commits into from
Oct 6, 2022

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Oct 6, 2022

Description of the change

Add reader for EBSD patterns in EDAX TSL's binary UP1/2 files, based on the reader in PyEBSDIndex written by @drowenhorst-nrl.

Closes #385.

Progress of the PR

Minimal example of the bug fix or new feature

>>> import kikuchipy as kp
>>> s = kp.load("data.up1")
>>> s
<EBSD, title: edax_binary, dimensions: (9|60, 60)>

# Supply navigation shape

>>> s = kp.load("data.up1", nav_shape=(3, 3))
>>> s
<EBSD, title: edax_binary, dimensions: (3, 3|60, 60)>

# Read patterns acquired in an hexagonal grid

>>> s = kp.load("data.up2")
/home/hakon/kode/kikuchipy/kikuchipy/io/plugins/edax_binary.py:154: UserWarning: Returned signal has one navigation dimension since an hexagonal grid is not supported
  warnings.warn(
>>> s
<EBSD, title: edax_binary, dimensions: (10|60, 60)>

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>
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>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added enhancement New feature or request documentation This relates to the documentation labels Oct 6, 2022
@hakonanes hakonanes added this to the v0.7.0 milestone Oct 6, 2022
@hakonanes
Copy link
Member Author

@IMBalENce, you might find this reader useful in your lab.

@hakonanes hakonanes merged commit 482c019 into pyxem:develop Oct 6, 2022
@hakonanes hakonanes deleted the edax-up1-up2-reader branch October 6, 2022 19:28
@IMBalENce
Copy link
Contributor

Thank you very much @hakonanes, I'll give it a test if I have any questions.

@hakonanes
Copy link
Member Author

That would be great, thanks! I haven't found many EDAX UP1/2 files available on the internet, so I've only tested the reader on a couple of datasets, one of them a hexagonal grid UP2 file you sent me last summer (thanks again!).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This relates to the documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Readers for EDAX TSL's .up1 and .up2 files would be nice
2 participants