magnopy.PlotlyEngine.plot_spin_directions#

method

PlotlyEngine.plot_spin_directions(positions, spin_directions, colors='#000000', legend_label=None, legend_group=None, row=1, col=1)[source]#

Plots a set of spin directions.

Parameters:

positions(N, 3) array-like: Positions of magnetic centers.
spin_directions(N, 3) array-like: Direction of spin vectors for each magnetic center. Only direction is used, the modulus is ignored. Spin directions are all normalized to the same length but not necessary to 1.
colorsstr or list of str, default "#000000": Color or colors for the arrows. Any value that is supported by Plotly.
legend_labelstr, optional: Label of the line that is displayed in the figure.
legend_groupstr, optional: Legend's group. If None, then defaults to the random string of 10 characters.
rowint, default 1: Row of the subplot.
colint, default 1: Column of the subplot.