from astropy.wcs.wcsapi import BaseLowLevelWCS
from mpl_animators import ArrayAnimatorWCS
from .base import BasePlotter
from .plotting_utils import prep_plot_kwargs
__all__ = ['MatplotlibSequencePlotter', 'SequenceAnimator']
[docs]
class MatplotlibSequencePlotter(BasePlotter):
"""
Provide visualization methods for NDCubeSequence which use `matplotlib`.
This plotter delegates much of the visualization to the `ndcube.NDCube.plot`
which is assumed to employ the `~ndcube.visualization.mpl_plotter.MatplotlibPlotter`.
"""
[docs]
def plot(self, sequence_axis_coords=None, sequence_axis_unit=None, **kwargs):
"""
Visualize the `~ndcube.NDCubeSequence`.
Parameters
----------
sequence_axis_coords: `str` or array-like, optional
The real world value of each step along the sequence axis.
If `str`, the values are taken from `ndcube.NDCubeSequence.sequence_axis_coords`.
sequence_axis_unit: `str` or `astropy.units.Unit`, optional
The unit in which to display the sequence_axis_coords.
"""
sequence_dims = self._ndcube.dimensions
if len(sequence_dims) == 2:
raise NotImplementedError("Visualizing sequences of 1-D cubes not currently supported.")
else:
return self.animate(sequence_axis_coords, sequence_axis_unit, **kwargs)
[docs]
def animate(self, sequence_axis_coords=None, sequence_axis_unit=None, **kwargs):
"""
Animate the `~ndcube.NDCubeSequence` with the sequence axis as a slider.
Keyword arguments are passed to
`ndcube.visualization.mpl_plotter.MatplotlibPlotter.plot` and therefore only
apply to cube axes, not the sequence axis.
See that method's docstring for definition of keyword arguments.
Parameters
----------
sequence_axis_coords: `str` optional
The name of the coordinate in `~ndcube.NDCubeSequence.sequence_axis_coords`
to be used as the slider pixel values.
If None, array indices will be used.
sequence_axis_units: `astropy.units.Unit` or `str`, optional
The unit in which the sequence_axis_coordinates should be displayed.
If None, the default unit will be used.
"""
return SequenceAnimator(self._ndcube, sequence_axis_coords=sequence_axis_coords, sequence_axis_unit=sequence_axis_unit, **kwargs)
[docs]
class SequenceAnimator(ArrayAnimatorWCS):
"""
Animate an NDCubeSequence of NDCubes with >1 dimension.
The sequence axis is always set as a sliders axis.
All kwargs are passed to `ndcube.NDCube.plot`.
The bulk of the plotting work is performed by `ndcube.NDCube.plot`
which is assumed to exist and to call a matplotlib-based animator.
Parameters
----------
sequence: `~ndcube.NDCubeSequence`
The sequence to animate.
sequence_axis_coords: `str` or array-like, optional
The real world value of each step along the sequence axis.
If `str`, the values are taken from `ndcube.NDCubeSequence.sequence_axis_coords`.
sequence_axis_unit: `str` or `astropy.units.Unit`, optional
The unit in which to display the sequence_axis_coords.
"""
def __init__(self, sequence, sequence_axis_coords=None, sequence_axis_unit=None, **kwargs):
if sequence_axis_coords is not None:
raise NotImplementedError("Setting sequence_axis_coords not yet supported.")
if sequence_axis_unit is not None:
raise NotImplementedError("Setting sequence_axis_unit not yet supported.")
# Store sequence data
self._cubes = sequence.data
# Process kwargs used by cube plotter.
plot_axes = kwargs.pop("plot_axes", None)
axes_coordinates = kwargs.pop("axes_coordinates", None)
axes_units = kwargs.pop("axes_units", None)
self._data_unit = kwargs.pop("data_unit", None)
init_idx = 0
n_cube_dims = len(self._cubes[init_idx].dimensions)
init_wcs = self._cubes[init_idx].wcs
self._plot_axes, self._axes_coordinates, self._axes_units = prep_plot_kwargs(
n_cube_dims, init_wcs, plot_axes, axes_coordinates, axes_units)
# Define sequence axis slider properties and add to kwargs.
base_kwargs = {"slider_functions": [self._sequence_slider_function],
"slider_ranges": [[0, len(self._cubes)]]}
base_kwargs.update(kwargs)
# Calculate data and wcs for initial animation state and instantiate Animator.
data, wcs, plot_axes, coord_params = self._cubes[0].plotter._prep_animate_args(
self._cubes[0].wcs, self._plot_axes, self._axes_units, self._data_unit)
if not isinstance(wcs, BaseLowLevelWCS):
wcs = wcs.low_level_wcs
super().__init__(data, wcs, plot_axes, coord_params=coord_params, **base_kwargs)
def _sequence_slider_function(self, val, artist, slider):
self._sequence_idx = int(val)
self.data, self.wcs, _, _ = self._cubes[self._sequence_idx].plotter._prep_animate_args(
self._cubes[self._sequence_idx].wcs, self._plot_axes, self._axes_units, self._data_unit)
if self.plot_dimensionality == 1:
self.update_plot_1d(val, artist, slider)
elif self.plot_dimensionality == 2:
self.update_plot_2d(val, artist, slider)
