as_collections

GeometricalKikuchiPatternSimulation.as_collections(index: int | tuple[int, ...] | None = None, coordinates: Literal['detector', 'gnomonic'] = 'detector', lines: bool = True, zone_axes: bool = False, zone_axes_labels: bool = False, lines_kwargs: dict | None = None, zone_axes_kwargs: dict | None = None, zone_axes_labels_kwargs: dict | None = None) → list

Return a list of Matplotlib collections for a single simulation.

Parameters:

index

Index of the simulation to get collections from. This is the first simulation if not given.

coordinates

Coordinate space for the plot axes, either “detector” (default) or “gnomonic”.

lines

Whether to get the collection of Kikuchi lines. Default is True. Returned as matplotlib.collections.LineCollection.

zone_axes

Whether to get the collection of zone axes. Default is False. Returned as matplotlib.collections.PathCollection.

zone_axes_labels

Whether to get the collection of zone axes labels. Default is False. Return as a list of matplotlib.text.Text.

lines_kwargs

Keyword arguments passed to matplotlib.collections.LineCollection to format Kikuchi lines if lines True.

zone_axes_kwargs

Keyword arguments passed to matplotlib.collections.PathCollection to format zone axes if zone_axes True.

zone_axes_labels_kwargs

Keyword arguments passed to matplotlib.text.Text to format zone axes labels if zone_axes_labels True.

Returns:

collection_list

List of Matplotlib collections.

See also

as_markers, plot