Matplotlib Animators Documentation#

The mpl_animators package provides a set of classes which allow the easy construction of interactive matplotlib widget based animations. “Out of the box” classes are provided for making line or image plots from numpy arrays, with sliders to control the animation automatically added for all dimensions not on the axes of the plot. As well as this there is a specialised ArrayAnimatorWCS class which can make line or image plots for a numpy array and associated World Coordinate System (WCS) object from astropy. Finally, there are two base classes: BaseFuncAnimator which can be extended to generate an interactive visualization from any data structure and set of functions to update the plot, and ArrayAnimator which can be extended to generate any visualisation based on the axes of a numpy array.

mpl_animators Package#

Classes#

ArrayAnimator(data[, image_axes, axis_ranges])

Create a Matplotlib backend independent data explorer.

ArrayAnimatorWCS(data, wcs, slices[, ...])

Animate an array with associated BaseLowLevelWCS object.

BaseFuncAnimator(data, slider_functions, ...)

Create a Matplotlib backend independent data explorer which allows definition of figure update functions for each slider.

ImageAnimator(data[, image_axes, axis_ranges])

Create a matplotlib backend independent data explorer for 2D images.

LineAnimator(data[, plot_axis_index, ...])

Create a matplotlib backend independent data explorer for 1D plots.

Class Inheritance Diagram#

Inheritance diagram of mpl_animators.base.ArrayAnimator, mpl_animators.wcs.ArrayAnimatorWCS, mpl_animators.base.BaseFuncAnimator, mpl_animators.image.ImageAnimator, mpl_animators.line.LineAnimator