compass.ocean.tests.isomip_plus.viz.plot.MoviePlotter.plot_horiz_series

MoviePlotter.plot_horiz_series(da, nameInTitle, prefix, oceanDomain, units=None, vmin=None, vmax=None, cmap=None, cmap_set_under=None, cmap_set_over=None, cmap_scale='linear', time_indices=None, figsize=(9, 3))[source]

Plot a series of image of a given variable

Parameters:

  • da (xarray.DataArray) – The data array of time series to plot

  • nameInTitle (str) – The name of the variable to use in the title and the progress bar

  • prefix (str) – The nae of the variable to use in the subfolder and file prefix

  • oceanDomain (bool) – True if the variable is for the full ocean, False if only for the cavity

  • units (str, optional) – The units of the variable to be included in the title

  • vmin (float, optional) – The minimum and maximum values for the colorbar

  • vmax (float, optional) – The minimum and maximum values for the colorbar

  • cmap (Colormap or str, optional) – A color map to plot

  • cmap_set_under (str or None, optional) – A color for low out-of-range values

  • cmap_scale ({'log', 'linear'}, optional) – Whether the colormap is logarithmic or linear

  • time_indices (list of int, optional) – The time indices at which to plot. If not provided, set to all.