API reference#

Release: 0.2.0

Date: Aug 17, 2023

This reference manual details the public functions, modules, and objects in PyEBSDIndex. For learning how to use PyEBSDIndex, see the Tutorials.

Caution

PyEBSDIndex is in development. This means that some breaking changes and changes to this reference are likely with each release.

Functionality is inteded to be imported like this:

>>> from pyebsdindex import ebsd_index, pcopt
>>> indexer = ebsd_index.EBSDIndexer()

Modules

ebsd_index

Setup and handling of Radon indexing runs of EBSD patterns.

nlpar

Non-local pattern averaging and re-indexing (NLPAR).

pcopt

Optimization of the pattern center (PC) of EBSD patterns.

tripletvote

Creation of look-up tables from phase information for band indexing.