API reference#

Release: 0.7.0

Date: Oct 29, 2022

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 My awes0m4 ..., dimensions: (3, 3|60, 60)>

Functions

load(filename[, lazy])

Load an EBSD, EBSDMasterPattern or ECPMasterPattern signal from a supported file format.

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.

generators

Generate signals from other signals.

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 and chunk pattern processing used by signals.

projections

Various projections and transformations relevant to EBSD.

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.