pyoculus.utils.plot

This module provides a function to create a canvas for plotting using Matplotlib.

authors:

Functions

clean_bigsteps(array[, threshold])

place nans where the difference between two consecutive values is greater than a threshold

create_canvas([rcstyle])

Create a Matplotlib canvas with a figure and axes.
pyoculus.utils.plot.create_canvas(rcstyle=None, **kwargs) → tuple

Create a Matplotlib canvas with a figure and axes.

This function checks if a figure or axes object is provided in the keyword arguments. If neither is provided, it creates a new figure and axes. It returns the figure, axes, and any remaining keyword arguments.

Parameters:

  • rcstyle (str) – The Matplotlib style to use.

  • **kwargs – Arbitrary keyword arguments. Can include fig for a Matplotlib figure or ax for axes.

Returns:

A tuple containing the figure, axes, and remaining keyword arguments.

Return type:

tuple

pyoculus.utils.plot.clean_bigsteps(array, threshold=0.1)

place nans where the difference between two consecutive values is greater than a threshold

Useful for removing modulo-boundary crossing lines, that are very long