Skip to content

kikuchipy 0.2.0

Pre-release
Pre-release
Compare
Choose a tag to compare
@hakonanes hakonanes released this 19 May 15:37
v0.2.0
290583d
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

kikuchipy 0.2.0 is a minor release of kikuchipy, an open-source Python library for processing and analysis of electron backscatter diffraction patterns.

A significant amount of new functionality have been added in this release cycle, as summarized under "Added" below. The API has changed somewhat, see "Changed" below. Details of all development associated with this release are available here.

Contributors

  • Håkon Wiik Ånes
  • Tina Bergh

Added

  • Jupyter Notebooks with tutorials and example workflows available via https://github.com/kikuchipy/kikuchipy-demos.
  • Grey scale and RGB virtual backscatter electron (BSE) images can be easily generated with the VirtualBSEGenerator class. The generator return objects of the new signal class VirtualBSEImage, which inherit functionality from HyperSpy's Signal2D class. (#170)
  • EBSD master pattern class and reader of master patterns from EMsoft's EBSD master pattern file. (#159)
  • Python 3.8 support. (#157)
  • The public API has been restructured. The pattern processing used by the EBSD class is available in the kikuchipy.pattern subpackage, and filters/kernels used in frequency domain filtering and pattern averaging are available in the kikuchipy.filters subpackage. (#169)
  • Intensity normalization of scan or single patterns. (#157)
  • Fast Fourier Transform (FFT) filtering of scan or single patterns using SciPy's fft routines and Connelly Barnes' filterfft. (#157)
  • Numba dependency to improve pattern rescaling and normalization. (#157)
  • Computing of the dynamic background in the spatial or frequency domain for scan or single patterns. (#157)
  • Image quality (IQ) computation for scan or single patterns based on N. C. K. Lassen's definition. (#157)
  • Averaging of patterns with nearest neighbours with an arbitrary kernel, e.g. rectangular or Gaussian. (#134)
  • Window/kernel/filter/mask class to handle such things, e.g. for pattern averaging or filtering in the frequency or spatial domain. Available in the kikuchipy.filters subpackage. (#134, #157)

Changed

  • Renamed five EBSD methods: static_background_correction to remove_static_background, dynamic_background_correction to remove_dynamic_background, rescale_intensities to rescale_intensity, virtual_backscatter_electron_imaging to plot_virtual_bse_intensity, and get_virtual_image to get_virtual_bse_intensity. (#157, #170)
  • Renamed kikuchipy_metadata to ebsd_metadata. (#169)
  • Source code link in the documentation should point to proper GitHub line. This linkcode_resolve in the conf.py file is taken from SciPy. (#157)
  • Read the Docs CSS style. (#157)
  • New logo with a gradient from experimental to simulated pattern (with EMsoft), with a color gradient from the plasma color maps. (#157)
  • Dynamic background correction can be done faster due to Gaussian blurring in the frequency domain to get the dynamic background to remove. (#157)

Removed

  • Explicit dependency on scikit-learn (it is imported via HyperSpy). (#168)
  • Dependency on pyxem. Parts of their virtual imaging methods are adapted here---a big thank you to the pyxem/HyperSpy team! (#168)

Fixed

  • RtD builds documentation with Python 3.8 (fixed problem of missing .egg leading build to fail). (#158)
Assets 2
Loading