def peek(self, gamma=None, resample=None, **kwargs):
"""
A animation plotting routine that animates each element in the
MapCube
Parameters
----------
gamma: float
Gamma value to use for the color map
fig: mpl.figure
Figure to use to create the explorer
resample: list or False
Draws the map at a lower resolution to increase the speed of
animation. Specify a list as a fraction i.e. [0.25, 0.25] to
plot at 1/4 resolution.
[Note: this will only work where the map arrays are the same size]
annotate: bool
Annotate the figure with scale and titles
interval: int
Animation interval in ms
colorbar: bool
Plot colorbar
Returns
-------
Returns a MapCubeAnimator object
See Also
--------
sunpy.visualization.mapcubeanimator.MapCubeAnimator
Examples
--------
>>> cube = sunpy.Map(files, cube=True)
>>> ani = cube.plot(colorbar=True)
>>> plt.show()
Plot the map at 1/2 original resolution
>>> cube = sunpy.Map(files, cube=True)
>>> ani = cube.plot(resample=[0.5, 0.5], colorbar=True)
>>> plt.show()
Decide you want an animation:
>>> cube = sunpy.Map(files, cube=True)
>>> ani = cube.plot(resample=[0.5, 0.5], colorbar=True)
>>> mplani = ani.get_animation()
"""
if gamma is not None:
self[0].cmap.set_gamma(gamma)
if resample:
#This assumes that the maps a homogenous!
#TODO: Update this!
resample = np.array(len(self._maps) - 1) * np.array(resample)
for amap in self._maps:
amap.resample(resample)
return MapCubeAnimator(self, **kwargs)
def peek(self, resample=None, **kwargs):
"""
A animation plotting routine that animates each element in the
MapCube
Parameters
----------
fig: mpl.figure
Figure to use to create the explorer
resample: list or False
Draws the map at a lower resolution to increase the speed of
animation. Specify a list as a fraction i.e. [0.25, 0.25] to
plot at 1/4 resolution.
[Note: this will only work where the map arrays are the same size]
annotate: bool
Annotate the figure with scale and titles
interval: int
Animation interval in ms
colorbar: bool
Plot colorbar
plot_function : function
A function to call to overplot extra items on the map plot.
For more information see `sunpy.visualization.MapCubeAnimator`.
Returns
-------
mapcubeanim : `sunpy.visualization.MapCubeAnimator`
A mapcube animator instance.
See Also
--------
sunpy.visualization.mapcubeanimator.MapCubeAnimator
Examples
--------
>>> import matplotlib.pyplot as plt
>>> from sunpy.map import Map
>>> cube = Map(files, cube=True) # doctest: +SKIP
>>> ani = cube.peek(colorbar=True) # doctest: +SKIP
>>> plt.show() # doctest: +SKIP
Plot the map at 1/2 original resolution
>>> cube = Map(files, cube=True) # doctest: +SKIP
>>> ani = cube.peek(resample=[0.5, 0.5], colorbar=True) # doctest: +SKIP
>>> plt.show() # doctest: +SKIP
Plot the map with the limb at each time step
>>> def myplot(fig, ax, sunpy_map):
... p = sunpy_map.draw_limb()
... return p
>>> cube = Map(files, cube=True) # doctest: +SKIP
>>> ani = cube.peek(plot_function=myplot) # doctest: +SKIP
>>> plt.show() # doctest: +SKIP
Decide you want an animation:
>>> cube = Map(files, cube=True) # doctest: +SKIP
>>> ani = cube.peek(resample=[0.5, 0.5], colorbar=True) # doctest: +SKIP
>>> mplani = ani.get_animation() # doctest: +SKIP
"""
if resample:
if self.all_maps_same_shape():
resample = np.array(len(self) - 1) * np.array(resample)
for i in range(0, len(self)):
self._get_map(i).resample(resample)
else:
raise ValueError('Maps do not all have the same shape.')
return MapCubeAnimator(self, **kwargs)