API reference

The public API of de-ebsd, generated from the docstrings. Each page links to the source line on GitHub.

de-ebsd is layered, and the reference follows that layering: de_ebsd.core (frames, constants) -> de_ebsd.crystal (unit cells, structure factors) -> de_ebsd.diffraction (Bloch waves) -> de_ebsd.sim (master patterns), with de_ebsd.index matching patterns back to orientations and de_ebsd.viz drawing everything.

The names most workflows need are re-exported at the top level:

>>> import de_ebsd as de
>>> de.Crystal, de.Microscope, de.MasterPatternSimulator, de.EBSDDetector
(...)

Modules

core	Frame conventions, physical constants and coordinate maps shared package-wide.
crystal	Crystallography: unit cells, atomic scattering factors and structure factors.
diffraction	Dynamical electron diffraction: reflection lists, Bethe potentials, Bloch waves.
sim	Master-pattern generation: the simulator, its output, and the detector geometry.
index	Orientation indexing: the matching counterpart to de_ebsd.sim.
viz	The anyplotlib display layer: every .show() in de_ebsd renders through here.