spiketools.plts.annotate.add_box_shade

spiketools.plts.annotate.add_box_shade(x1, x2, y_val, y_range=0.41, ax=None, **plt_kwargs)[source]

Add a shaded box to a plot axis.

Parameters:
x1, x2float

The start and end positions for the shaded box on the x-axis.

y_valfloat

The position of the shaded box on the y-axis.

y_rangefloat

The range, as +/-, around the y position to shade the box.

axAxes, optional

Axis object upon which to plot.

plt_kwargs

Additional arguments to pass into the plot function.