scatter#

Orientation.scatter(projection: str = 'axangle', figure: Figure | None = None, position: int | Tuple[int] | SubplotSpec = (1, 1, 1), return_figure: bool = False, wireframe_kwargs: dict | None = None, size: int | None = None, direction: Vector3d | None = None, figure_kwargs: dict | None = None, **kwargs) Figure[source]#

Plot orientations in axis-angle space, the Rodrigues fundamental zone, or an inverse pole figure (IPF) given a sample direction.

Parameters:
projection

Which orientation space to plot orientations in, either “axangle” (default), “rodrigues” or “ipf” (inverse pole figure).

figure

If given, a new plot axis AxAnglePlot or RodriguesPlot is added to the figure in the position specified by position. If not given, a new figure is created.

position

Where to add the new plot axis. 121 or (1, 2, 1) places it in the first of two positions in a grid of 1 row and 2 columns. See add_subplot() for further details. Default is (1, 1, 1).

return_figure

Whether to return the figure. Default is False.

wireframe_kwargs

Keyword arguments passed to orix.plot.AxAnglePlot.plot_wireframe() or orix.plot.RodriguesPlot.plot_wireframe().

size

If not given, all orientations are plotted. If given, a random sample of this size of the orientations is plotted.

direction

Sample direction to plot with respect to crystal directions. If not given, the out of plane direction, sample Z, is used. Only used when plotting IPF(s).

figure_kwargs

Dictionary of keyword arguments passed to matplotlib.pyplot.figure() if figure is not given.

**kwargs

Keyword arguments passed to orix.plot.AxAnglePlot.scatter(), orix.plot.RodriguesPlot.scatter(), or orix.plot.InversePoleFigurePlot.scatter().

Returns:
figure

Figure with the added plot axis, if return_figure=True.