sdf_xarray.plotting.animate

Contents

sdf_xarray.plotting.animate#

sdf_xarray.plotting.animate(data, fps=10, min_percentile=0, max_percentile=100, title=None, display_sdf_name=False, ax=None, **kwargs)[source]#

Generate an animation

Parameters:

  • data (DataArray) – The dataarray containing the target data

  • fps (float) – Frames per second for the animation (default: 10)

  • min_percentile (float) – Minimum percentile of the data (default: 0)

  • max_percentile (float) – Maximum percentile of the data (default: 100)

  • title (str | None) – Custom title to add to the plot.

  • display_sdf_name (bool) – Display the sdf file name in the animation title

  • ax (Axes | None) – Matplotlib axes on which to plot.

  • kwargs – Keyword arguments to be passed to matplotlib.

Return type:

FuncAnimation

Examples

>>> dataset["Derived_Number_Density_Electron"].epoch.animate()
Contents