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

Print indexing and refinement speed #461

Merged
merged 6 commits into from
Nov 2, 2021

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Nov 2, 2021

Description of the change

  • Print indexing speed (patterns/s and comparisons/s) and refinement speed (patters/s) after these operations.
  • Update relevant notebooks.
  • Remove restriction on newest version of h5py <= 3.4 introduced in Fix projection center conversions in EBSDDetector #455 and instead restrict lowest version of hyperspy >= 1.6.5.

Addresses #452.

I'll release v0.5.3 after this PR is in main.

Progress of the PR

Minimal example of the bug fix or new feature

The last line in this example is new!

>>> from orix import sampling
>>> import kikuchipy as kp
>>> s = kp.data.nickel_ebsd_large()
>>> s.remove_static_background()
>>> s.remove_dynamic_background()
>>> energy = 20
>>> mp = kp.data.nickel_ebsd_master_pattern_small(projection="lambert", energy=energy)
>>> detector = kp.detectors.EBSDDetector(
...     shape=s.axes_manager.signal_shape[::-1],
...     pc=(0.421, 0.7794, 0.5049),
...     sample_tilt=70,
...     convention="tsl",
... )
>>> rotations = sampling.get_sample_fundamental(
...     method="cubochoric", resolution=4, point_group=mp.phase.point_group
... )
>>> sim = mp.get_patterns(rotations=rotations, detector=detector, energy=energy)
>>> xmap = s.dictionary_indexing(sim)
Dictionary indexing information:
        Phase name: ni
        Matching 4125 experimental pattern(s) to 11935 dictionary pattern(s)
        NormalizedCrossCorrelationMetric: float32, greater is better, rechunk: False, signal mask: False
100%|████████████████████████████████████████████████████████████████████| 11/11 [00:04<00:00,  2.73it/s]
        Indexing speed: 1022 patterns/s, 12205115 comparisons/s

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 CHANGELOG.rst.
  • New contributors are added to .all-contributorsrc and the table is regenerated.

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>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added enhancement New feature or request maintenance This relates to package maintenance labels Nov 2, 2021
@hakonanes hakonanes added this to the v0.5.3 milestone Nov 2, 2021
@hakonanes hakonanes linked an issue Nov 2, 2021 that may be closed by this pull request
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes merged commit e0a7d26 into pyxem:main Nov 2, 2021
@hakonanes hakonanes deleted the add-indexing-speed-print branch November 2, 2021 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request maintenance This relates to package maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Print indexing speed after completed indexing
1 participant