RasterSequence¶

class sunraster.RasterSequence(data_list, common_axis, meta=None)[source]¶

Bases: sunraster.spectrogram_sequence.SpectrogramSequence

Class for holding, slicing and plotting series of spectrograph raster scans.

Parameters

data_list (list) – List of SpectrogramCube objects from the same spectral window and OBS ID. Must also contain the ‘detector type’ in its meta attribute.
common_axis (int) – The axis of the SpectrogramCube instances corresponding to the slit step axis.
meta (dict or header object (optional)) – Metadata associated with the sequence.

Attributes Summary

`raster_array_axis_physical_types`	The physical types associated with each array axis, including the sequence axis.
`raster_axis_coords`	Return the coordinate values along the sequence axis.
`raster_dimensions`	The length of each axis including the sequence axis.
`raster_instrument_axes_types`
`slice_as_raster`	Method to slice instance as though data were 4D, i.e. raster number, slit step position, position along slit, wavelength.
`slice_as_sns`	Method to slice instance as though data were taken as a sit-and-stare, i.e. slit position and raster number are combined into a single axis.
`sns_array_axis_physical_types`	The physical types associated with each array axis, omitting the sequence axis.
`sns_axis_coords`	The coordinate values at each location along the common axis across all cubes.
`sns_dimensions`	The length of each array axis as if all cubes were concatenated along the common axis.
`sns_instrument_axes_types`

Methods Summary

`plot_as_raster`(args, *kwargs)	A convenience function for the plotters default `plot()` method.
`plot_as_sns`(args, *kwargs)

Attributes Documentation

raster_array_axis_physical_types¶: The physical types associated with each array axis, including the sequence axis.

raster_axis_coords¶

Return the coordinate values along the sequence axis.

These are compiled from the GlobalCoords objects attached to each NDCube where each cube represents a location along the sequence axis. Only coordinates that are common to all cubes are returned.

raster_dimensions¶: The length of each axis including the sequence axis.

raster_instrument_axes_types¶

slice_as_raster¶: Method to slice instance as though data were 4D, i.e. raster number, slit step position, position along slit, wavelength.

slice_as_sns¶: Method to slice instance as though data were taken as a sit-and-stare, i.e. slit position and raster number are combined into a single axis.

sns_array_axis_physical_types¶: The physical types associated with each array axis, omitting the sequence axis.

sns_axis_coords¶

The coordinate values at each location along the common axis across all cubes.

Only coordinates associated with the common axis in all cubes in the sequence are returned. Coordinates from different cubes are concatenated along the common axis. They thus represent the coordinate values at each location as if all cubes in the sequence were concatenated along the common axis.

sns_dimensions¶: The length of each array axis as if all cubes were concatenated along the common axis.

sns_instrument_axes_types¶

Methods Documentation

plot_as_raster(*args, **kwargs)¶

A convenience function for the plotters default plot() method.

Calling this method is the same as calling sequence.plotter.plot, the behaviour of this method can change if the NDCubeSequence.plotter class is set to a different Plotter class.

plot_as_sns(*args, **kwargs)¶