RasterCollection#

class irispy.spectrograph.RasterCollection(key_data_pairs, aligned_axes=None, meta=None, **kwargs)[source]#

Bases: NDCollection

Subclass of NDCollection for holding a collection of SpectrogramCube or SpectrogramCubeSequence with keys being the spectral windows.

Attributes Summary

`aligned_axes`	The axes of each array that are aligned in numpy order.
`aligned_axis_physical_types`	The physical types common to all members that are associated with each aligned axis.
`aligned_dimensions`	The lengths of all aligned axes.

Methods Summary

`clear`()	Remove all items from the dict.
`copy`()	Return a shallow copy of the dict.
`fromkeys`(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
`get`(key[, default])	Return the value for key if key is in the dictionary, else default.
`items`()	Return a set-like object providing a view on the dict's items.
`keys`()	Return a set-like object providing a view on the dict's keys.
`pop`(key)	Remove a member from the `NDCollection` and return it.
`popitem`()	Not supported by `NDCollection`
`setdefault`()	Not supported by `NDCollection`
`update`(*args)	Merges a new collection with current one replacing objects with common keys.
`values`()	Return an object providing a view on the dict's values.

Attributes Documentation

aligned_axes#: The axes of each array that are aligned in numpy order.

aligned_axis_physical_types#

The physical types common to all members that are associated with each aligned axis.

One tuple is returned for each axis as there can be more than one physical type associated with an aligned axis. If there are no physical types associated with an aligned that is common to all collection members, an empty tuple is returned for that axis.

aligned_dimensions#

The lengths of all aligned axes.

If there are no aligned axes, returns None.

Methods Documentation

clear()#: Remove all items from the dict.

copy()#: Return a shallow copy of the dict.

classmethod fromkeys(iterable, value=None, /)#: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#: Return the value for key if key is in the dictionary, else default.

items()#: Return a set-like object providing a view on the dict’s items.

keys()#: Return a set-like object providing a view on the dict’s keys.

pop(key)#

Remove a member from the NDCollection and return it.

Parameters:: key (str) – The name of the member to remove and return.

popitem()#: Not supported by NDCollection

setdefault()#: Not supported by NDCollection

update(*args)#

Merges a new collection with current one replacing objects with common keys.

Takes either a single input (NDCollection) or two inputs (sequence of key/value pairs and aligned axes associated with each key/value pair.

values()#: Return an object providing a view on the dict’s values.