save_colorbar

seas.colormaps.save_colorbar(scale: dict, path: str, colormap=None)[source]

Save a plt colorbar with a given scale to a specified path. Accepts plt or cv2 colormap objects.

Parameters

  • scale – The scale dictionary returned by rescale_movie. Must have keys ‘min’ and ‘max’ providing the range of the rescale.

  • path – Where to save the file to. (supported formats: eps, jpeg, jpg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff)

  • colormap – Which colormap to save. Should be a cv2 colormap object or name of a plt colormap. If left as None, the default colormap will be loaded.

Returns

Nothing

Raises

  • KeyError – The min and/or max keys were not in scale dictionary

  • ValueError – The path provided was not supported by plt figure outputs.