spiketools.plts.task.plot_task_structure

spiketools.plts.task.plot_task_structure(task_ranges=None, event_lines=None, data_points=None, range_colors=None, line_colors=None, range_kwargs=None, line_kwargs=None, ax=None, **plt_kwargs)

Plot task structure with shaded ranges of event durations and lines for point events.

Parameters:

task_rangeslist of list of float, optional

List of start and end ranges to shade in, to indicate event durations. To add multiple different shaded regions, pass a list of multiple shade definitions.

event_lineslist of float, optional

Timestamps at which to draw vertical lines, to indicate point events. To add multiple different lines, pass a list of multiple line definitions.

data_points1d array, optional

Set of timestamps to indicate data points of interest on the plot.

range_colorslist of str, optional

Colors to plot the ranges in. Used if passing multiple task range sections.

line_colorslist of str, optional

Colors to plot the lines in. Used if passing multiple line sections.

range_kwargsdict, optional

Additional keyword arguments for the range shades.

line_kwargsdict, optional

Additional keyword arguments for the event lines.

axAxes, optional

Axis object upon which to plot.

plt_kwargs

Additional arguments to pass into the plot function.