TimesSeriesPlotMixin

class stixpy.product.sources.TimesSeriesPlotMixin

Bases: object

TimesSeries plot mixin providing timeseries plotting for pixel data.

Methods Summary

plot_timeseries([time_indices, ...])

Plot a times series of the selected times and energies.

Methods Documentation

plot_timeseries(time_indices=None, energy_indices=None, detector_indices='all', pixel_indices='all', axes=None, error_bar=False, **plot_kwarg)

Plot a times series of the selected times and energies.

Parameters:

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

• 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.

• 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.

• 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.

• 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.

• error_bar (optional bool) – Add error bars to plot.

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

Returns:

matplotlib.axes