scatter#
- Orientation.scatter(projection: str = 'axangle', figure: Optional[Figure] = None, position: Optional[Union[int, Tuple[int], SubplotSpec]] = None, return_figure: bool = False, wireframe_kwargs: Optional[dict] = None, size: Optional[int] = None, direction: Optional[Vector3d] = None, figure_kwargs: Optional[dict] = 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
orRodriguesPlot
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()
ororix.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()
, ororix.plot.InversePoleFigurePlot.scatter()
.
- Returns:
figure
Figure with the added plot axis, if
return_figure=True
.