as_collections#
- GeometricalKikuchiPatternSimulation.as_collections(index: int | tuple | None = None, coordinates: str = '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 [source]#
Get a single simulation as a list of Matplotlib objects.
- Parameters:
- index
Index of the simulation to get collections from. If not given, this is the first simulation.
- coordinates
The coordinates of the plot axes, either
"detector"
(default) or"gnomonic"
.- lines
Whether to get the collection of Kikuchi lines. Default is
True
. These are returned asmatplotlib.collections.LineCollection
.- zone_axes
Whether to get the collection of zone axes. Default is
False
. These are returned asmatplotlib.collections.PathCollection
.- zone_axes_labels
Whether to get the collection of zone axes labels. Default is
False
. These are returned as a class:list ofmatplotlib.text.Text
.- lines_kwargs
Keyword arguments passed to
matplotlib.collections.LineCollection
to format Kikuchi lines iflines=True
.- zone_axes_kwargs
Keyword arguments passed to
matplotlib.collections.PathCollection
to format zone axes ifzone_axes=True
.- zone_axes_labels_kwargs
Keyword arguments passed to
matplotlib.text.Text
to format zone axes labels ifzone_axes_labels=True
.
- Returns:
collection_list
List of Matplotlib collections.
See also