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

Add reader for EMsoft's simulated EBSD patterns #202

Merged
merged 5 commits into from
Aug 25, 2020

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Aug 24, 2020

Signed-off-by: Håkon Wiik Ånes hwaanes@gmail.com

Description

  • Reader for simulated EBSD patterns from EMsoft's program EMEBSD.
  • Add helpful writing of original metadata to metadata DictionaryTreeBrowser (HyperSpy) from mapping

Checklist

Minimal example of the bug fix or new feature

>>> import kikuchipy as kp
>>> ss = kp.load("my_emsoft_ebsd_file.h5")
>>> ss
<EBSD, title: ni1_sda_sim, dimensions: (29800|60, 60)>

# Provide a navigation shape (note that HyperSpy flips row, col in string representation)

>>> ss2 = kp.load("my_emsoft_ebsd_file.h5", scan_size=(149, 200))
>>> ss2
<EBSD, title: ni1_sda_sim, dimensions: (200, 149|60, 60)>

For reviewers

  • Check that the PR title is short, concise, and will make sense 1 year
    later.
  • Check that new functions are imported in corresponding __init__.py.
  • Check that new features, API changes, and deprecations are mentioned in
    the unreleased section in doc/changelog.rst.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added this to the v0.3.0 milestone Aug 24, 2020
@hakonanes hakonanes self-assigned this Aug 24, 2020
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
Copy link
Member Author

hakonanes commented Aug 25, 2020

Referring back to our discussion IRL yesterday, @friedkitteh and @onatlandsmyr, I think it is best to read simulated patterns from EMsoft into the kikuchipy.signals.EBSD class, instead of creating a new kikuchipy.signals.SimulatedEBSD. Just because it is simpler to maintain one class instead of two, and I don't think there are many methods or attributes that are specific to either experimental or simulated patterns.

@hakonanes
Copy link
Member Author

While the pattern centre (xpc, ypc, L or zpc) is read from the EMsoft simulated EBSD file, the orientations used to simulate the patterns (Euler angle triplets) are not read yet. We first need to add a EBSD.xmap attribute containing a orix.crystal_map.CrystalMap object. All orientation and crystal structure stuff will be handled through that attribute. Will try to set up a work in progress (WIP) PR right away to get this.

@hakonanes hakonanes merged commit c3cc161 into pyxem:master Aug 25, 2020
@hakonanes hakonanes deleted the add-emsoft-ebsd-reader branch August 25, 2020 10:37
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.

None yet

1 participant