vlines

mdtools.plot.vlines(ax, x, start, stop, xmin=None, xmax=None, ymin=None, ymax=None, legend_loc='best', **kwargs)[source]

Plot vertical lines at each x from start to stop into a matplotlib.axes.Axes object using matplotlib.axes.Axes.vlines().

Deprecated since version 0.0.0.dev2: Use matplotlib.axes.Axes.vlines(), matplotlib.axes.Axes.set() and matplotlib.axes.Axes.legend() directly.

Parameters:

  • ax (matplotlib.axes.Axes) – The axes to draw to.

  • x (scalar or array_like) – x-indices where to plot the lines.

  • start, stop (scalar or array_like) – Respective beginning and end of each line. If scalars are provided, all lines will have same length.

  • xmin (scalar, optional) – Left limit for plotting on x-axis. The left limit may be greater than the right limit, in which case the tick values will show up in decreasing order. Default is None, which means set the limit automatically.

  • xmax (scalar, optional) – Right limit for plotting on x-axis.

  • ymin, ymax (scalar, optional) – Same as xmin and xmax, but for the y-axis.

  • legend_loc (int or str, optional) – Position of the legend. See matplotlib.pyplot.legend() for possible arguments.

  • kwargs (dict, optional) – Keyword arguments to pass to matplotlib.axes.Axes.vlines(). See there for possible keyword arguments.

Returns:

img (matplotlib.collections.LineCollection) – A matplotlib.collections.LineCollection.