Kikuchipy

==================

Added
-----
- Explicit support for Python 3.11.
(`646 <https://github.com/pyxem/kikuchipy/pull/646>`_)
- Allow Hough indexing of all Laue groups with PyEBSDIndex v0.2 (not just *m-3m*, i.e.
FCC and BCC). (`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Control of reflector lists in Hough indexing. One reflector list per phase in the
phase list can be passed to ``EBSDDetector.get_indexer()`` to obtain an
``EBSDIndexer`` for use in ``EBSD.hough_indexing()``.
(`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Allow passing keyword arguments to ``EBSD.hough_indexing_optimize_pc()`` to control
the new particle swarm optimization algorithm in PyEBSDIndex v0.2.
(`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Allow getting one projection center (PC) per pattern when optimizing PCs using the new
particle swarm optimization in PyEBSDIndex v0.2 (passing ``batch=True``).
(`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)

Changed
-------
- Parameter ``zone_axes_kwargs`` in
``GeometricalKikuchiPatternSimulation.as_collections()`` does not accept ``color``
internally to set the default color to white anymore. It accepts ``fc`` (facecolor)
instead. This change was necessary to improve handling of other keyword arguments.
(`643 <https://github.com/pyxem/kikuchipy/pull/643>`_)
- Increase minimal versions of diffsims, NumPy, Matplotlib, and PyEBSDIndex to 0.5.1,
1.21.6, 3.5, and 0.2, respectively.
(`646 <https://github.com/pyxem/kikuchipy/pull/646>`_,
`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Remove dependency on Panel for documentation, and with that the interactive 3D
visualization of master patterns in the documentation. The plan is to reintroduce the
interactive plots with trame later on.
(`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Restrict HyperSpy to below the forthcoming version 2. The plan is to remove this
restriction once kikuchipy is compatible with this version.
(`657 <https://github.com/pyxem/kikuchipy/pull/657>`_)

Removed
-------
- ``generators`` and ``projections`` modules which were deprecated in version 0.8.
(`612 <https://github.com/pyxem/kikuchipy/pull/612>`_)
- The deprecated PyPI selector ``viz`` is removed.
(`643 <https://github.com/pyxem/kikuchipy/pull/643>`_)
- The data module functions ``silicon_ebsd_moving_screen_x()``, where "x" is "in",
"out5mm" or "out10mm". They were deprecated in version 0.8.
(`656 <https://github.com/pyxem/kikuchipy/pull/656>`_)

Fixed
-----
- Conversion from EDAX TSL projection center (PC) convention for (PCy, PCz) for
rectangular detectors is corrected.
(`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Downloading files in the ``data`` module to the local cache on Windows.
(`655 <https://github.com/pyxem/kikuchipy/pull/655>`_)

==================

Fixed
-----
- Passing a 3-component PC array with more than one dimension to
``EBSD.hough_indexing_optimize_pc()`` works.
(`647 <https://github.com/pyxem/kikuchipy/pull/647>`_)

==================

Changed
-------
- Use memory mapping (``numpy.memmap()``) instead of reading into memory
(``numpy.fromfile()``) for non-lazy reading of EBSD patterns from EDAX binary .up1/2
files. (`641 <https://github.com/pyxem/kikuchipy/pull/641>`_)

Fixed
-----
- EBSD patterns from some EDAX binary .up1/2 files were incorrectly read due to an
incorrect file offset, making the patterns appear shifted horizontally.
(`641 <https://github.com/pyxem/kikuchipy/pull/641>`_)
- Reading of EBSD patterns from H5OINA files with the "Camera Binning Mode" dataset not
containing the detector binning.
(`641 <https://github.com/pyxem/kikuchipy/pull/641>`_)

==================

Fixed
-----
- Not-indexed points in crystal maps are handled correctly when merging.
(`639 <https://github.com/pyxem/kikuchipy/pull/639>`_)

==================

Fixed
-----
- Points considered not-indexed in a crystal map are maintained after EBSD refinement.
(`632 <https://github.com/pyxem/kikuchipy/pull/632>`_)

Changed
-------
- EBSD detector returned from combined EBSD and projection center (PC) refinement now
has PC values equal to the number of indexed points, accounting for points not being
in the data, navigation mask *and* points considered as not-indexed. This means that
it might not have a 2D navigation shape, even though the returned crystal map has.
(`632 <https://github.com/pyxem/kikuchipy/pull/632>`_)

==================

Changed
-------
- ``EBSD.hough_indexing()`` info message now informs that the given projection center is
in Bruker's convention. (`628 <https://github.com/pyxem/kikuchipy/pull/628>`_)