GeometricalKikuchiPatternSimulation

class kikuchipy.simulations.GeometricalKikuchiPatternSimulation(detector: EBSDDetector, rotations: Rotation, reflectors: ReciprocalLatticeVector, lines: KikuchiPatternLine, zone_axes: KikuchiPatternZoneAxis)

Bases: object

Collection of coordinates of Kikuchi lines and zone axes on an EBSD detector for simple plotting or creation of HyperSpy markers to plot onto EBSD signals.

Instances of this class are returned from kikuchipy.simulations.KikuchiPatternSimulator.on_detector(), and not ment to be created directly.

Parameters:

detector

EBSD detector.

rotations

Crystal orientations for which coordinates of Kikuchi lines and zone axes have been generated.

reflectors

Reciprocal lattice vectors used in the simulation.

lines

Collection of coordinates of Kikuchi lines on the detector.

zone_axes

Collection of coordinates of zone axes on the detector.

Attributes

GeometricalKikuchiPatternSimulation.detector	Return the EBSD detector onto which simulations were generated.
GeometricalKikuchiPatternSimulation.navigation_shape	Return the navigation shape of the simulations, equal to the shape of rotations.
GeometricalKikuchiPatternSimulation.reflectors	Return the reciprocal lattice vectors used in the simulations.
GeometricalKikuchiPatternSimulation.rotations	Return the crystal orientations for which simulations were generated.

Methods

GeometricalKikuchiPatternSimulation.as_collections([...])	Return a list of Matplotlib collections for a single simulation.
GeometricalKikuchiPatternSimulation.as_markers([...])	Return a list of simulation markers.
GeometricalKikuchiPatternSimulation.lines_coordinates([...])	Return Kikuchi line coordinates for a single simulation.
GeometricalKikuchiPatternSimulation.plot([...])	Plot a single simulation on the detector.
GeometricalKikuchiPatternSimulation.zone_axes_coordinates([...])	Return zone axes coordinates for a single simulation.