perturbopy.postproc.utils.plot_tools.plot_recip_pt_labels

perturbopy.postproc.utils.plot_tools.plot_recip_pt_labels(ax, labels, point_array, path_array, label_height='lower', show_line=True)

” Method to add reciprocal point labels to the plot

Parameters:

• ax (matplotlib.axes.Axes) – Axis with plotted dispersion

• labels (dict) – Dictionary with keys corresponding to reciprocal point labels as strings, and values corresponding to array_like reciprocal points

• point_array (array_like) – Array of points corresponding to the x-axis of the plot

• path_array (array_like) – The path coordinates corresponding to the point_array

• label_height (str) – Can either be “upper” or “lower” to specify if labels should be above or below the plot

• show_line (bool) – If true, a line will be plotted to mark labeled reciprocal points

Returns:

ax – Axis with the plotted dispersion and labeled reciprocal points

Return type:

matplotlib.axes.Axes