API reference — kikuchipy 0.14.1 documentation

This reference manual describes the public functions, modules, and objects in kikuchipy. Many of the descriptions include brief examples. For learning how to use kikuchipy, see the Examples or Tutorials.
kikuchipy is in continuous development, meaning that some breaking changes and changes to this reference are likely with each release.
kikuchipy’s import structure is designed to feel familiar to HyperSpy users. It is recommended to import functionality from the below list of functions and modules like this:
load(filename[, lazy])
Load a supported signal from one of the Supported file formats.
set_log_level(level)
Set level of kikuchipy logging messages.
Example datasets for use when testing functionality.
Tools for handling the EBSD detector-sample geometry.
Plotters and tools for use in plotting of signals.
Pattern filters used on signals, e.g. for pattern averaging.
Imaging using the EBSD detector.
Tools for indexing of EBSD patterns by matching to a dictionary of simulated patterns.
Read and write signals from and to file.
Single pattern processing (used by signals).
Experimental and simulated diffraction patterns and virtual backscatter electron images.
Simulations returned by a generator and handling of Kikuchi bands and zone axes.
© Copyright 2019-2026, kikuchipy developers.
Created using Sphinx 9.0.4.
Built with the PyData Sphinx Theme 0.24.0.