def setup_plot(cls,
width=16,
height=4,
ncols=1,
nrows=1,
interactive=None,
link_dataframes=None,
cursor_delta=None,
**kwargs):
"""
Common helper for setting up a matplotlib plot
:param width: Width of the plot (inches)
:type width: int or float
:param height: Height of each subplot (inches)
:type height: int or float
:param ncols: Number of plots on a single row
:type ncols: int
:param nrows: Number of plots in a single column
:type nrows: int
:param link_dataframes: Link the provided dataframes to the axes using
:func:`lisa.notebook.axis_link_dataframes`
:type link_dataframes: list(pandas.DataFrame) or None
:param cursor_delta: Add two vertical lines set with left and right
clicks, and show the time delta between them in a widget.
:type cursor_delta: bool or None
:param interactive: If ``True``, use the pyplot API of matplotlib,
which integrates well with notebooks. However, it can lead to
memory leaks in scripts generating lots of plots, in which case it
is better to use the non-interactive API. Defaults to ``True`` when
running under IPython or Jupyter notebook, `False`` otherwise.
:type interactive: bool
:Keywords arguments: Extra arguments to pass to
:obj:`matplotlib.figure.Figure.subplots`
:returns: tuple(matplotlib.figure.Figure, matplotlib.axes.Axes (or an
array of, if ``nrows`` > 1))
"""
figure, axes = make_figure(
interactive=interactive,
width=width,
height=height,
ncols=ncols,
nrows=nrows,
**kwargs,
)
if interactive is None:
interactive = is_running_ipython()
use_widgets = interactive
if link_dataframes:
if not use_widgets:
cls.get_logger().error(
'Dataframes can only be linked to axes in interactive widget plots'
)
else:
for axis in figure.axes:
axis_link_dataframes(axis, link_dataframes)
if cursor_delta or cursor_delta is None and use_widgets:
if not use_widgets and cursor_delta is not None:
cls.get_logger().error(
'Cursor delta can only be used in interactive widget plots'
)
else:
for axis in figure.axes:
axis_cursor_delta(axis)
for axis in figure.axes:
axis.relim(visible_only=True)
axis.autoscale_view(True)
# Needed for multirow plots to not overlap with each other
figure.set_tight_layout(dict(h_pad=3.5))
return figure, axes
def setup_plot(cls, width=16, height=4, ncols=1, nrows=1, interactive=None, link_dataframes=None, cursor_delta=None, **kwargs):
"""
Common helper for setting up a matplotlib plot
:param width: Width of the plot (inches)
:type width: int or float
:param height: Height of each subplot (inches)
:type height: int or float
:param ncols: Number of plots on a single row
:type ncols: int
:param nrows: Number of plots in a single column
:type nrows: int
:param link_dataframes: Link the provided dataframes to the axes using
:func:`lisa.notebook.axis_link_dataframes`
:type link_dataframes: list(pandas.DataFrame) or None
:param cursor_delta: Add two vertical lines set with left and right
clicks, and show the time delta between them in a widget.
:type cursor_delta: bool or None
:param interactive: If ``True``, use the pyplot API of matplotlib,
which integrates well with notebooks. However, it can lead to
memory leaks in scripts generating lots of plots, in which case it
is better to use the non-interactive API. Defaults to ``True`` when
running under IPython or Jupyter notebook, `False`` otherwise.
:type interactive: bool
:Keywords arguments: Extra arguments to pass to
:obj:`matplotlib.figure.Figure.subplots`
:returns: tuple(matplotlib.figure.Figure, matplotlib.axes.Axes (or an
array of, if ``nrows`` > 1))
"""
running_ipython = is_running_ipython()
if interactive is None:
interactive = running_ipython
if tuple(map(int, matplotlib.__version__.split('.'))) <= (3, 0, 3):
warnings.warn('This version of matplotlib does not allow saving figures from axis created using Figure(), forcing interactive=True')
interactive = True
if interactive:
figure, axes = plt.subplots(
ncols=ncols, nrows=nrows, figsize=(width, height * nrows),
**kwargs
)
else:
figure = Figure(figsize=(width, height * nrows))
axes = figure.subplots(ncols=ncols, nrows=nrows, **kwargs)
if isinstance(axes, Iterable):
ax_list = axes
else:
ax_list = [axes]
use_widgets = interactive and running_ipython
if link_dataframes:
if not use_widgets:
cls.get_logger().error('Dataframes can only be linked to axes in interactive widget plots')
else:
for axis in ax_list:
axis_link_dataframes(axis, link_dataframes)
if cursor_delta or cursor_delta is None and use_widgets:
if not use_widgets and cursor_delta is not None:
cls.get_logger().error('Cursor delta can only be used in interactive widget plots')
else:
for axis in ax_list:
axis_cursor_delta(axis)
# Needed for multirow plots to not overlap with each other
figure.set_tight_layout(dict(h_pad=3.5))
return figure, axes
