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

Load either unprocessed or processed patterns from H5OINA files #702

Merged
merged 8 commits into from
Nov 30, 2024

Conversation

hakonanes
Copy link
Member

Description of the change

This PR addresses #692 by adding a processed: bool = True parameter to the Oxford Instruments h5ebsd reader (H5OINA). By passing False we attempt to load the "Unprocessed Patterns", failing if they are not available.

This also fixes an issue where the unprocessed patterns were read into the EBSD signal original metadata unnecessarily. This could use a lot of memory...

Progress of the PR

Minimal example of the bug fix or new feature

>>> import kikuchipy as kp
>>> s_processed = kp.load("patterns.h5oina")
>>> s_unprocessed = kp.load("patterns.h5oina", processed=False)

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 kikuchipy/__init__.py and .zenodo.json.

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 bug Something isn't working enhancement New feature or request labels Nov 20, 2024
@hakonanes hakonanes added this to the v0.11.1 milestone Nov 20, 2024
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@hakonanes hakonanes merged commit 9a5728e into pyxem:main Nov 30, 2024
11 checks passed
@hakonanes hakonanes deleted the 692-h5oina-un-processed-patterns branch November 30, 2024 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant