MatplotlibSequencePlotter#
- class ndcube.visualization.mpl_sequence_plotter.MatplotlibSequencePlotter(ndcube=None)[source]#
Bases:
BasePlotterProvide visualization methods for NDCubeSequence which use
matplotlib.This plotter delegates much of the visualization to the
ndcube.NDCube.plotwhich is assumed to employ theMatplotlibPlotter.Methods Summary
animate([sequence_axis_coords, ...])Animate the
NDCubeSequencewith the sequence axis as a slider.plot([sequence_axis_coords, sequence_axis_unit])Visualize the
NDCubeSequence.Methods Documentation
- animate(
- sequence_axis_coords=None,
- sequence_axis_unit=None,
- **kwargs,
Animate the
NDCubeSequencewith the sequence axis as a slider.Keyword arguments are passed to
ndcube.visualization.mpl_plotter.MatplotlibPlotter.plotand therefore only apply to cube axes, not the sequence axis. See that method’s docstring for definition of keyword arguments.- Parameters:
sequence_axis_coords (
stroptional) – The name of the coordinate insequence_axis_coordsto be used as the slider pixel values. If None, array indices will be used.sequence_axis_units (
astropy.units.Unitorstr, optional) – The unit in which the sequence_axis_coordinates should be displayed. If None, the default unit will be used.
- plot(
- sequence_axis_coords=None,
- sequence_axis_unit=None,
- **kwargs,
Visualize the
NDCubeSequence.- Parameters:
sequence_axis_coords (
stror array-like, optional) – The real world value of each step along the sequence axis. Ifstr, the values are taken fromndcube.NDCubeSequence.sequence_axis_coords.sequence_axis_unit (
strorastropy.units.Unit, optional) – The unit in which to display the sequence_axis_coords.