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 three Si single crystal EBSD patterns to data module, from external kikuchipy-data repo #320

Merged
merged 3 commits into from
Feb 9, 2021

Conversation

hakonanes
Copy link
Member

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

Description of the change

  • Add three single crystal Si EBSD patterns, acquired from the same sample position but with three different camera distances (reference/in/operating position, out 5 mm, out 10 mm), to the kikuchipy.data module. The patterns are stored in three separate kikuchipy h5ebsd files (should perhaps be stored in the same file...). These will be used in various user guides, first (will make PR later today) for showing the moving-screen PC estimation technique.
  • Add section detailing how to add data to the data module in the contributing guide, contributing.rst.

Progress of the PR

Minimal example of the bug fix or new feature

>>> import kikuchipy as kp
>>> s1 = kp.data.silicon_ebsd_moving_screen_in()
>>> s1
<EBSD, title: si_in Scan 1, dimensions: (|480, 480)>
>>> s1.metadata.Acquisition_instrument.SEM.Detector.EBSD.static_background
array([[7, 8, 7, ..., 7, 7, 7],
       [8, 8, 7, ..., 7, 7, 7],
       [7, 7, 7, ..., 7, 7, 7],
       ...,
       [7, 7, 7, ..., 7, 7, 7],
       [7, 7, 7, ..., 7, 7, 7],
       [7, 7, 7, ..., 7, 7, 7]], dtype=uint8)
>>> s2 = kp.data.silicon_ebsd_moving_screen_out5mm()
>>> s2
<EBSD, title: si_out5mm Scan 1, dimensions: (|480, 480)>
>>> s3 = kp.data.silicon_ebsd_moving_screen_out10mm()
>>> s3
<EBSD, title: si_out10mm Scan 1, dimensions: (|480, 480)>

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 doc/changelog.rst.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes self-assigned this Feb 9, 2021
@hakonanes hakonanes added the enhancement New feature or request label Feb 9, 2021
@hakonanes hakonanes added this to the v0.4.0 milestone Feb 9, 2021
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes merged commit 62ec60d into pyxem:master Feb 9, 2021
@hakonanes hakonanes deleted the add-three-silicon-patterns branch February 9, 2021 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant