==================
Details of all development associated with this release are available `here
<https://github.com/pyxem/kikuchipy/milestone/2?closed=1>`_.
Contributors
------------
- Håkon Wiik Ånes
- Tina Bergh
Added
-----
- Jupyter Notebooks with tutorials and example workflows available.
- 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 <https://github.com/pyxem/kikuchipy/pull/170>`_)
- EBSD master pattern class and reader of master patterns from EMsoft's EBSD master
pattern file. (`159 <https://github.com/pyxem/kikuchipy/pull/159>`_)
- Python 3.8 support. (`157 <https://github.com/pyxem/kikuchipy/pull/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 <https://github.com/pyxem/kikuchipy/pull/169>`_)
- Intensity normalization of scan or single patterns.
(`157 <https://github.com/pyxem/kikuchipy/pull/157>`_)
- Fast Fourier Transform (FFT) filtering of scan or single patterns using SciPy's fft
routines and `Connelly Barnes' filterfft
<https://www.connellybarnes.com/code/python/filterfft>`_.
(`157 <https://github.com/pyxem/kikuchipy/pull/157>`_)
- Numba dependency to improve pattern rescaling and normalization.
(`157 <https://github.com/pyxem/kikuchipy/pull/157>`_)
- Computing of the dynamic background in the spatial or frequency domain for scan or
single patterns. (`157 <https://github.com/pyxem/kikuchipy/pull/157>`_)
- Image quality (IQ) computation for scan or single patterns based on N. C. K. Lassen's
definition. (`157 <https://github.com/pyxem/kikuchipy/pull/157>`_)
- Averaging of patterns with nearest neighbours with an arbitrary kernel, e.g.
rectangular or Gaussian. (`134 <https://github.com/pyxem/kikuchipy/pull/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
module.
(`134 <https://github.com/pyxem/kikuchipy/pull/134>`_,
`157 <https://github.com/pyxem/kikuchipy/pull/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 <https://github.com/pyxem/kikuchipy/pull/157>`_,
`170 <https://github.com/pyxem/kikuchipy/pull/170>`_)
- Renamed kikuchipy_metadata to ebsd_metadata.
(`169 <https://github.com/pyxem/kikuchipy/pull/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 <https://github.com/pyxem/kikuchipy/pull/157>`_)
- Read the Docs CSS style. (`157 <https://github.com/pyxem/kikuchipy/pull/157>`_)
- New logo with a gradient from experimental to simulated pattern (with EMsoft), with a
color gradient from the plasma color maps.
(`157 <https://github.com/pyxem/kikuchipy/pull/157>`_)
- Dynamic background correction can be done faster due to Gaussian blurring in the
frequency domain to get the dynamic background to remove.
(`157 <https://github.com/pyxem/kikuchipy/pull/157>`_)
Removed
-------
- Explicit dependency on scikit-learn (it is imported via HyperSpy).
(`168 <https://github.com/pyxem/kikuchipy/pull/168>`_)
- Dependency on pyxem. Parts of their virtual imaging methods are adapted here---a big
thank you to the pyxem/HyperSpy team!
(`168 <https://github.com/pyxem/kikuchipy/pull/168>`_)
Fixed
-----
- RtD builds documentation with Python 3.8 (fixed problem of missing .egg leading build
to fail). (`158 <https://github.com/pyxem/kikuchipy/pull/158>`_)