Skip to main content
Ctrl+K
kikuchipy kikuchipy
  • User guide
  • API reference
  • Contributing
  • Changelog
  • GitHub
  • Gitter
  • User guide
  • API reference
  • Contributing
  • Changelog
  • GitHub
  • Gitter

Section Navigation

Getting started

  • Installation

Usage

  • Tutorials
    • Load and save data
    • Visualizing patterns
    • Pattern processing
    • Reference frames
    • Feature maps
    • Virtual backscatter electron imaging
    • Hough indexing
    • Pattern matching
    • Hybrid indexing
    • Orientation-dependence of the projection center
    • Fit a plane to selected projection centers
    • Extrapolate projection centers from a mean
    • PC calibration: “moving-screen” technique
    • Geometrical EBSD simulations
    • Kinematical EBSD simulations
    • Multivariate analysis
    • M&M 2021 Sunday Short Course
    • ESTEEM3 workshop
  • Examples
    • Pattern processing
      • Static background correction
      • Dynamic background correction
      • Pattern binning
      • Neighbour pattern averaging
      • Adaptive histogram equalization
    • Reference frames
      • Plot distribution of projection centers
      • Plot projection center on the detector
      • Crop an EBSD detector
      • Convert between detector coordinate formats
      • Interactive EBSD detector plotter
      • Rotate vectors from sample to detector reference frame
      • Fit a plane to selected projection centers
      • Estimate tilt about the detector x axis
      • Estimate tilts about the detector x and z axis
      • Detector-sample geometry views
    • Selecting data
      • Crop navigation axes
      • Crop signal axes
      • Extract patterns from a grid
    • Visualization
      • Plot nice master pattern image

Resources

  • Bibliography
  • Applications
  • Open datasets
  • Related projects
  • License
  • User guide
  • Related projects

Related projects#

This is a non-exhaustive list of related, open-source projects for analysis of EBSD data that users of kikuchipy might find useful:

  • HyperSpy: Python library with tools for multi-dimensional data analysis. kikuchipy extends this library for EBSD analysis.

  • EMsoft: Series of Fortran programs which, among numerous other tasks, can dynamically simulate EBSD, Electron Channeling Pattern (ECP) and Transmission Kikuchi Diffraction (TKD) master patterns.

  • orix: Python library for handling crystal orientation mapping data. kikuchipy depends on this library for all operations with vectors, rotations and crystal symmetry.

  • diffsims: Python library for simulating diffraction. kikuchipy depends on this library for handling of reciprocal lattice vectors.

  • pyxem: Python library for multi-dimensional diffraction microscopy.

  • PyEBSDIndex: Python library for Hough/Radon based EBSD indexing. kikuchipy depends on this library for Hough indexing.

  • OpenECCI: GUI-based software for controlled Electron Channelling Contrast Imaging (ECCI) analysis of crystal defects in an SEM.

  • MTEX: MATLAB toolbox for analyzing and modeling crystallographic textures by means of EBSD or pole figure data.

  • DREAM.3D: C++ library to reconstruct, instatiate, quantify, mesh, handle, and visualize multidimensional (3D), multimodal data (mainly EBSD orientation data).

  • AstroEBSD: MATLAB package with indexing tools for EBSD patterns.

  • xcdskd: Python library with tools for Kikuchi Diffraction in the SEM, with example Jupyter Notebooks.

  • OpenXY: MATLAB tool for cross-correlation analysis of EBSD patterns.

  • DefDAP: Python package for correlating EBSD and high-resolution digital image correlation data.

  • pycotem: Python package for working with crystal orientations in transmission electron microscopy.

previous

Open datasets

next

API reference
Edit on GitHub
Show Source

© Copyright 2019-2026, kikuchipy developers.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.18.0.