EBSDDetectorPlotter#

class kikuchipy.draw.EBSDDetectorPlotter(detector: EBSDDetector, rotation: Rotation | None = None, *, inplace: bool = False)[source]#

Bases: object

Interactive EBSD detector plot with optional overlays.

Shows the detector-sample geometry (side view, top view) and an EBSD detector panel with interactive slider controls.

A single geometrical simulation and a single master pattern simulation can be overlayed on the detector, provided an initial crystal orientation is given.

Warning

This plotter is highly experimental, and breaking API changes can be made between releases without prior notice.

The plotter is considered as stable as the rest of the code base once this warning is removed.

Parameters:
detector

EBSD detector to visualize.

rotation

Initial crystal orientation as a single Rotation. Required when any overlay is added.

inplace

Whether interactive changes affect detector inplace. Default is False (a copy is used). If True, the projection center will be overwritten with the average projection center (required for the plot).

Methods

EBSDDetectorPlotter.set_geometrical_simulation(...)

Set the geometrical Kikuchi band simulation overlay.

EBSDDetectorPlotter.set_master_pattern(...)

Set the master pattern from which a simulated pattern is projected onto the detector.

EBSDDetectorPlotter.show([legend, ...])

Build the interactive figure and return it with its controls.

Examples using EBSDDetectorPlotter#

Interactive EBSD detector plotter

Interactive EBSD detector plotter

Detector-sample geometry views

Detector-sample geometry views