SpectrogramPlotMixin#

class stixpy.product.sources.SpectrogramPlotMixin[source]#

Bases: object

Spectrogram plot mixin providing spectrogram plotting for pixel data.

Methods Summary

plot_spectrogram([axes, vtype, ...])

Plot a spectrogram for the selected time and energies.

Methods Documentation

plot_spectrogram(
axes=None,
vtype='dcr',
time_indices=None,
energy_indices=None,
detector_indices='all',
pixel_indices='all',
**plot_kwargs,
)[source]#

Plot a spectrogram for the selected time and energies.

Parameters:

  • axes (optional matplotlib.axes) – The axes the plot the spectrogram.

  • vtype (str) –

    Type of value to return control the default normalisation:

    • ’c’ - count [c]

    • ’cr’ - count rate [c/s]

    • ’dcr’ - differential count rate [c/(s keV)]

  • time_indices (list or numpy.ndarray) – If an 1xN array will be treated as mask if 2XN array will sum data between given indices. For example time_indices=[0, 2, 5] would return only the first, third and sixth times while time_indices=[[0, 2],[3, 5]] would sum the data between.

  • pixel_indices (list or numpy.ndarray) – If an 1xN array will be treated as mask if 2XN array will sum data between given indices. For example pixel_indices=[0, 2, 5] would return only the first, third and sixth pixels while pixel_indices=[[0, 2],[3, 5]] would sum the data between.

  • detector_indices (list or numpy.ndarray) – If an 1xN array will be treated as mask if 2XN array will sum data between given indices. For example detector_indices=[0, 2, 5] would return only the first, third and sixth detectors while detector_indices=[[0, 2],[3, 5]] would sum the data between.

  • energy_indices (list or numpy.ndarray) – If an 1xN array will be treated as mask if 2XN array will sum data between given indices. For example energy_indices=[0, 2, 5] would return only the first, third and sixth times while energy_indices=[[0, 2],[3, 5]] would sum the data between.

  • **plot_kwargs (dict) – Any additional arguments are passed to pcolormesh().

Returns:

matplotlib.axes

Notes

The units of the plotted data are determined by the vtype parameter: - ‘c’: counts - ‘cr’: counts per second - ‘dcr’: counts per second per keV