pyxem / kikuchipy

Toolbox for analysis of electron backscatter diffraction (EBSD) patterns
https://kikuchipy.org
GNU General Public License v3.0
79 stars 30 forks source link

Deprecate generators.VirtualBSEGenerator in favor of imaging.VirtualBSEImager #608

Closed hakonanes closed 1 year ago

hakonanes commented 1 year ago

Description of the change

kikuchipy.generators.VirtualBSEGenerator is deprecated in favor of kikuchipy.imaging.VirtualBSEImager. The deprecated class and the generators module will be removed in version 0.9.

Progress of the PR

Minimal example of the bug fix or new feature

>>> import kikuchipy as kp
>>> s = kp.data.nickel_ebsd_small()

# Before

>>> vbse_gen = kp.generators.VirtualBSEGenerator(s)

# Now
>>> vbse_imager = kp.imaging.VirtualBSEImager(s)

For reviewers