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

Deprecate kikuchipy.pattern.correlate module #377

Merged
merged 2 commits into from
Jun 20, 2021

Conversation

hakonanes
Copy link
Member

Description of the change

  • Deprecate kikuchipy.pattern.correlate module, to be removed in v0.5. Use kikuchipy.indexing.similarity_metrics instead.

Progress of the PR

Minimal example of the bug fix or new feature

>>> import kikuchipy as kp
>>> s = kp.data.nickel_ebsd_small()
>>> p1 = s.inav[0, 0].data
>>> p2 = s.inav[0, 1].data
>>> print(kp.pattern.correlate.normalized_correlation_coefficient(p1, p2))
0.9974703
/home/hakon/kode/kikuchipy/kikuchipy/pattern/correlate.py:32: VisibleDeprecationWarning: Function `normalized_correlation_coefficient()` is deprecated and will be removed in version 0.5. Use `kikuchipy.indexing.similarity_metrics.ncc()` instead.
  since="0.4",
>>> print(kp.indexing.similarity_metrics.ncc(p1, p2))
0.99747044

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>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added the deprecation Deprecated functionality label Jun 20, 2021
@hakonanes hakonanes added this to the v0.4.0 milestone Jun 20, 2021
@hakonanes
Copy link
Member Author

Will merge after checks pass.

@hakonanes hakonanes merged commit a2a22fa into pyxem:master Jun 20, 2021
@hakonanes hakonanes deleted the deprecate-correlate-module branch June 20, 2021 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Deprecated functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant