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

Restructure API, add two subpackages pattern and filters #169

Merged
merged 2 commits into from
May 14, 2020

Conversation

hakonanes
Copy link
Member

Description

Restructures the API, adding two subpackages:

  • kikuchipy.pattern. The single pattern processing used indirectly by the EBSD class is directly available from the subpackage. It also has two modules chunk and correlate, which expose the chunk processing used directly by the EBSD class, and for now only one method to correlate patterns (normalized cross-correlation), respectively.
  • kikuchipy.filters, containing methods to get transfer functions, spatial kernels etc. to do frequency domain filtering, neighbour pattern averaging etc.

The documentation, docstrings and tests have been updated accordingly.

Checklist

Minimal example of the bug fix or new feature

>>> import kikuchipy as kp
>>> kp.pattern.__all__
['chunk',
 'correlate',
 'fft',
 'fft_filter',
 'fft_frequency_vectors',
 'fft_spectrum',
 'get_dynamic_background',
 'get_image_quality',
 'ifft',
 'normalize_intensity',
 'remove_dynamic_background',
 'rescale_intensity']
>>> kp.filters.__all__
['distance_to_origin',
 'highpass_fft_filter',
 'lowpass_fft_filter',
 'modified_hann',
 'Window']
>>> kp.signals.__all__
['EBSD', 'EBSDMasterPattern', 'LazyEBSD', 'LazyEBSDMasterPattern', 'util']

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>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added documentation This relates to the documentation maintenance This relates to package maintenance tests labels May 14, 2020
@hakonanes hakonanes added this to the v0.2.0 milestone May 14, 2020
@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling f097e77 on hakonanes:restructure-api into 5032787 on kikuchipy:master.

@hakonanes hakonanes merged commit 6df76a5 into pyxem:master May 14, 2020
@hakonanes hakonanes deleted the restructure-api branch May 14, 2020 09:35
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 maintenance This relates to package maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants