API reference#

Release: 0.10.dev0

Date: Nov 03, 2023

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.

Caution

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:

>>> import kikuchipy as kp
>>> s = kp.data.nickel_ebsd_small()
>>> s
<EBSD, title: patterns Scan 1, dimensions: (3, 3|60, 60)>

Functions

load(filename[, lazy])

Load an EBSD, EBSDMasterPattern or ECPMasterPattern signal from one of the Supported file formats.

set_log_level(level)

Set level of kikuchipy logging messages.

Modules

data

Example datasets for use when testing functionality.

detectors

Tools for handling the EBSD detector-sample geometry.

draw

Tools for use in plotting of signals.

filters

Pattern filters used on signals, e.g. for pattern averaging.

imaging

Imaging using the EBSD detector.

indexing

Tools for indexing of EBSD patterns by matching to a dictionary of simulated patterns.

io

Read and write signals from and to file.

pattern

Single pattern processing (used by signals).

signals

Experimental and simulated diffraction patterns and virtual backscatter electron images.

simulations

Simulations returned by a generator and handling of Kikuchi bands and zone axes.