Cube¶

class kgpy.observatories.iris.spectrograph.Cube(intensity=None, intensity_uncertainty=None, wcs=None, time=None, time_index=None, channel=None, exposure_length=None, time_wcs=None)¶

Bases: Cube

Parameters

intensity (Optional[Quantity]) –
intensity_uncertainty (Optional[Quantity]) –
wcs (Optional[ndarray]) –
time (Optional[Time]) –
time_index (Optional[ndarray]) –
channel (Optional[Quantity]) –
exposure_length (Optional[Quantity]) –
time_wcs (Optional[Quantity]) –

__init__(intensity=None, intensity_uncertainty=None, wcs=None, time=None, time_index=None, channel=None, exposure_length=None, time_wcs=None)¶

Parameters

intensity (Optional[Quantity]) –
intensity_uncertainty (Optional[Quantity]) –
wcs (Optional[ndarray]) –
time (Optional[Time]) –
time_index (Optional[ndarray]) –
channel (Optional[Quantity]) –
exposure_length (Optional[Quantity]) –
time_wcs (Optional[Quantity]) –

Return type

None

Attributes

`axis`	Relationship between physical dimension and axis index.
`channel`
`channel_labels`
`colors`
`exposure_half_length`
`exposure_length`
`intensity`	Intensity of each pixel in the data
`intensity_despiked`
`intensity_uncertainty`
`num_channels`
`num_times`
`num_wavelength`
`num_x`
`num_y`
`shape`
`time`
`time_exp_end`
`time_exp_start`
`time_index`
`time_wcs`
`wcs`

Methods

`__init__`([intensity, intensity_uncertainty, ...])
`add_index_axis_to_shared_time_axes`(axs)	rtype `typing.Sequence`[`matplotlib.axes.Axes`]
`add_index_axis_to_time_axis`(ax)	rtype `matplotlib.axes.Axes`
`animate`(data[, time_slice, axs, thresh_min, ...])	rtype `matplotlib.animation.FuncAnimation`
`animate_channel`(images, image_names[, ax, ...])
`animate_colors`(ax[, channel_index, ...])	rtype `matplotlib.animation.FuncAnimation`
`animate_intensity`([axs, thresh_min, ...])	rtype `matplotlib.animation.FuncAnimation`
`animate_intensity_channel`([ax, time_slice, ...])	rtype `matplotlib.animation.FuncAnimation`
`from_archive`(archive[, spectral_window])	rtype `kgpy.observatories.iris.spectrograph.Cube`
`from_path_sequence`(path_sequence[, ...])	rtype `kgpy.observatories.iris.spectrograph.Cube`
`from_pickle`([path])
`plot_channel`(image[, image_name, ax, ...])	rtype `matplotlib.axes.Axes`
`plot_channel_from_data`(data[, ax, ...])	rtype `matplotlib.axes.Axes`
`plot_exposure_length`(ax)	rtype `typing.Tuple`[`matplotlib.axes.Axes`, `typing.List`[`matplotlib.lines.Line2D`]]
`plot_intensity_channel`([ax, time_index, ...])	rtype `matplotlib.axes.Axes`
`plot_intensity_mean_vs_time`(ax)	rtype `typing.Tuple`[`matplotlib.axes.Axes`, `typing.List`[`matplotlib.lines.Line2D`]]
`plot_intensity_time`([axs, time_index, ...])	rtype `numpy.ndarray`
`plot_quantity_vs_index`(ax, a[, t, a_name])	rtype `typing.Tuple`[`matplotlib.axes.Axes`, `typing.List`[`matplotlib.lines.Line2D`]]
`plot_time`(images, image_names, axs[, ...])	rtype `numpy.ndarray`
`plot_time_from_data`(data[, axs, time_index, ...])	rtype `numpy.ndarray`
`to_pickle`(path)
`window_doppler`([shift_doppler])	rtype `kgpy.observatories.iris.spectrograph.Cube`
`zeros`(shape)	rtype `kgpy.observatories.iris.spectrograph.Cube`

Inheritance Diagram

add_index_axis_to_shared_time_axes(axs)¶

Return type: typing.Sequence[matplotlib.axes.Axes]
Parameters: axs (Sequence[Axes]) –

add_index_axis_to_time_axis(ax)¶

Return type: matplotlib.axes.Axes
Parameters: ax (Axes) –

animate(data, time_slice=slice(None, None, None), axs=None, thresh_min=<Quantity 0.01 %>, thresh_max=<Quantity 99.9 %>, norm_gamma=1, frame_interval=<Quantity 100. ms>)¶

Return type

matplotlib.animation.FuncAnimation

Parameters

data (Quantity) –
time_slice (slice) –
axs (Optional[ndarray]) –
thresh_min (Quantity) –
thresh_max (Quantity) –
norm_gamma (float) –
frame_interval (Quantity) –

animate_channel(images, image_names, ax=None, thresh_min=<Quantity 0.01 %>, thresh_max=<Quantity 99.9 %>, norm_gamma=1, norm_vmin=None, norm_vmax=None, frame_interval=<Quantity 1. s>, colormap=None)¶

Parameters

images (Quantity) –
image_names (List[str]) –
ax (Optional[Axes]) –
thresh_min (Quantity) –
thresh_max (Quantity) –
norm_gamma (float) –
norm_vmin (Optional[Quantity]) –
norm_vmax (Optional[Quantity]) –
frame_interval (Quantity) –
colormap (Optional[str]) –

animate_colors(ax, channel_index=0, thresh_min=<Quantity 0.01 %>, thresh_max=<Quantity 99.9 %>, frame_interval=<Quantity 1. s>)¶

Return type

matplotlib.animation.FuncAnimation

Parameters

ax (Axes) –
channel_index (int) –
thresh_min (Quantity) –
thresh_max (Quantity) –
frame_interval (Quantity) –

animate_intensity(axs=None, thresh_min=<Quantity 0.01 %>, thresh_max=<Quantity 99.9 %>, norm_gamma=1, frame_interval=<Quantity 100. ms>)¶

Return type

matplotlib.animation.FuncAnimation

Parameters

axs (Optional[MutableSequence[Axes]]) –
thresh_min (Quantity) –
thresh_max (Quantity) –
norm_gamma (float) –
frame_interval (Quantity) –

animate_intensity_channel(ax=None, time_slice=None, channel_index=0, thresh_min=<Quantity 0.01 %>, thresh_max=<Quantity 99.9 %>, norm_gamma=1, norm_vmin=None, norm_vmax=None, frame_interval=<Quantity 100. ms>, colormap=None)¶

Return type

matplotlib.animation.FuncAnimation

Parameters

ax (Optional[Axes]) –
time_slice (Optional[slice]) –
channel_index (int) –
thresh_min (Quantity) –
thresh_max (Quantity) –
norm_gamma (float) –
norm_vmin (Optional[Quantity]) –
norm_vmax (Optional[Quantity]) –
frame_interval (Quantity) –
colormap (Optional[str]) –

classmethod from_archive(archive, spectral_window='Si IV 1394')¶

Return type

kgpy.observatories.iris.spectrograph.Cube

Parameters

archive (Path) –
spectral_window (str) –

classmethod from_path_sequence(path_sequence, spectral_window='Si IV 1394')¶

Return type

kgpy.observatories.iris.spectrograph.Cube

Parameters

path_sequence (Sequence[Path]) –
spectral_window (str) –

classmethod from_pickle(path=None)¶

Parameters: path (Optional[Path]) –

plot_channel(image, image_name='', ax=None, thresh_min=<Quantity 0.01 %>, thresh_max=<Quantity 99.9 %>, colorbar_location='right', transpose=False)¶