Restructure API, add two subpackages pattern and filters #169
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Restructures the API, adding two subpackages:
kikuchipy.pattern
. The single pattern processing used indirectly by theEBSD
class is directly available from the subpackage. It also has two moduleschunk
andcorrelate
, which expose the chunk processing used directly by theEBSD
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
For reviewers
later.
__init__.py
.the unreleased section in
doc/changelog.rst
.