spacepy.plot.spectrogram.simpleSpectrogram

spacepy.plot.spectrogram.simpleSpectrogram(*args, **kwargs)[source]

Plot a spectrogram given Z or X,Y,Z. This is a wrapper around pcolormesh() that can handle Y being a 2d array of time dependent bins. Like in the Van Allen Probes HOPE and MagEIS data files.

Parameters:
*args1 or 3 arraylike

Call Signatures:

simpleSpectrogram(Z, **kwargs)
simpleSpectrogram(X, Y, Z, **kwargs)
Returns:
axmatplotlib.axes._subplots.AxesSubplot

Matplotlib axes object that the plot is on

Other Parameters:
zlogbool

Plot the color with a log colorbar (default: True)

ylogbool

Plot the Y axis with a log scale (default: True)

alphascalar (0-1)

The alpha blending value (default: None)

cmapstring

The name of the colormap to use (default: system default)

vminfloat

Minimum color value (default: Z.min(), if log non-zero min)

vmaxfloat

Maximum color value (default: Z.max())

axmatplotlib.axes

Axes to plot the spectrogram on (default: None - new axes)

cbbool

Plot a colorbar (default: True)

cbtitlestring

Label to go on the colorbar (default: None)

zero_validbool

Treat zero as a valid value on zlog plots and use same color as other under-minimum values. No effect with linear colorbar. (default: False, draw as fill)

New in version 0.5.0.