EBSP Indexer is a graphical user interface that allows for processing and indexing of Electron backscatter patterns, generated by scanning electron microscopes. Its goal is to make the rich functionality of the open-source library kikuchipy more accessible to users, without requiring knowledge of python or the library itself.

The GUI supports:

• Customizable Dictionary and Hough indexing
• Refinement of orientations
• Signal improvements
  • Static background removal
  • Dynamic background removal
  • Averaging by neighbour patterns
• Pattern center calibration from
  • Existing calibration patterns
  • Selection of patterns
  • Working distance for added Microscopes
• Region of interest
• Signal navigation of patterns
• Pre- and post-indexing maps
• Accessible interactive interpreter for python

The project was originally developed by students at The Department of Material Science at Norwegian University of Science and Techonolgy (NTNU), and is open source and free to use.

Known issues ❗

• macOS might experience leaked semaphores when creating images in threads, e.g. Inverse Pole Figure Map in Hough Indexing.

  As of now, it is recommended to run indexing without generating images on Mac.

• Refinement of orientations of a crystal map which includes not_indexed points, might produce results that cannot be opened in signal navigation.

• Updating the application's settings will set the current working directory to the specified default directory (if checked).

• Updating the application's settings will reset the current selected file, even though it appears to be selected.

• When saving a merged crystal map in the case where only one phase is identified, save will fail since a crystal map with the same name exists already.

Minimum requirements 🔧

• Windows 10/11 or macOS 13 (Ventura)
• x86_64-based CPU (arm64 chipset is experimental)

In addition, the windows version requires Microsoft Visual C++ Redistributable packages for Visual Studio 2015, 2017, 2019, and 2022. This is included in our installer, and is automatically installed if needed.

Downloads ⬇️

⚠️ Make sure to read the aboves about Known issues and Minimum requirements before downloading the software.

Installer for Windows and App for macOS are available to download from Zenodo or SourceForge.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Erlend M. Østvold 💻 🐛 📖 🤔

olavlet 💻 🐛 📖 🤔

htrellin 💻 🐛 📖 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!