SpectrogramCubeSequence#
- class irispy.SpectrogramCubeSequence(data_list, meta=None, common_axis=0)[source]#
Bases:
SpectrogramSequence
Class for holding, slicing and plotting IRIS spectrogram data.
This class contains all the functionality of its super class with some additional functionalities.
- Parameters:
data_list (
list
) – List ofSpectrogramCube
objects from the same spectral window and OBS ID.meta (
dict
or header object, optional) – Metadata associated with the sequence.common_axis (
int
, optional) – The axis of the NDCubes corresponding to time.
Methods Summary
convert_to
(new_unit_type, *[, copy])Converts data, uncertainty and unit of each spectrogram in sequence to new unit.
Methods Documentation
- convert_to(new_unit_type, *, copy=False)[source]#
Converts data, uncertainty and unit of each spectrogram in sequence to new unit.
- Parameters:
new_unit_type (
str
) – Unit type to convert data to. Three values are accepted: “DN”: Relevant IRIS data number based on detector type. “photons”: photon counts “radiance”: Performs radiometric calibration conversion.copy (
bool
) – If True a new instance with the converted data values is return. If False, the current instance is overwritten. Default=False