IRISMapCube

class irispy.sji.IRISMapCube(data, wcs, uncertainty=None, unit=None, meta=None, mask=None, copy=False, scaled=None, **kwargs)[source]

Bases: sunraster.spectrogram.SpectrogramCube

Class representing SJI Image described by a single WCS.

Parameters
  • data (numpy.ndarray) – The array holding the actual data in this object.

  • wcs (ndcube.wcs.wcs.WCS) – The WCS object containing the axes’ information

  • unit (astropy.unit.Unit or str) – Unit for the dataset. Strings that can be converted to a Unit are allowed.

  • meta (dict-like object) – Additional meta information about the dataset.

  • uncertainty (any type, optional) – Uncertainty in the dataset. Should have an attribute uncertainty_type that defines what kind of uncertainty is stored, for example “std” for standard deviation or “var” for variance. A metaclass defining such an interface is NDUncertainty - but isn’t mandatory. If the uncertainty has no such attribute the uncertainty is stored as UnknownUncertainty. Defaults to None.

  • mask (any type, optional) – Mask for the dataset. Masks should follow the numpy convention that valid data points are marked by False and invalid ones with True. Defaults to None.

  • copy (bool, optional) – Indicates whether to save the arguments as copy. True copies every attribute before saving it while False tries to save every parameter as reference. Note however that it is not always possible to save the input as reference. Default is False.

  • scaled (bool, optional) – Indicates if the data has been scaled.

Methods Summary

apply_dust_mask([undo])

Applies or undoes an update of the mask with the dust particles positions.

plot(*args, **kwargs)

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

Methods Documentation

apply_dust_mask(undo=False)[source]

Applies or undoes an update of the mask with the dust particles positions.

Rewrite self.mask with/without the dust positions.

Parameters

undo (bool) – If False, dust particles positions mask will be applied. If True, dust particles positions mask will be removed. Default=False

plot(*args, **kwargs)[source]

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

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