Check out the Free (Big) Data analysis of 4D-STEM workshop in Trondheim, Norway, 11-13 June 2024

API reference#

This reference manual describes the public functions, modules, and objects in pyxem.

There are brief examples included for many functions as well as links to more detailed explanations of the functionality.

Modules

detectors

Detectors defined for pyFAI integration

data

Example datasets for use when testing functionality.

components

Classes for analyzing components in a material

dummy_data

Dummy data for testing and examples.

generators

Classes to help with generating some more complicated analysis/workflow

libraries

Library of data for crystallography in pyxem.

signals

Signal classes for diffraction data.

utils

Additional utility functions for processing signals.