Spectrum1DRefLayer

class specviz.core.data.Spectrum1DRefLayer(data, wcs=None, parent=None, layer_mask=None, *args, **kwargs)[source]

Bases: specutils.core.generic.Spectrum1DRef

Class to handle layers in SpecViz.

Parameters:
  • data (numpy.ndarray) – The flux.
  • wcs (WCS) – If specified, the WCS relating pixel to wavelength.
  • parent (layer) – If specified, the parent layer.
  • layer_mask (layer) – The layer defining the valid data mask.
  • kwargs (args,) – Arguments passed to the Spectrum1DRef object.

Attributes Summary

data Flux quantity with mask applied.
dispersion Dispersion quantity with mask applied.
full_mask Mask for spectrum data.
layer_mask Mask applied from an ROI.
raw_uncertainty Flux uncertainty with mask applied.
unmasked_data Flux quantity with no layer mask applied.
unmasked_dispersion Dispersion quantity with no layer mask applied.
unmasked_raw_uncertainty Flux uncertainty with mask applied.

Methods Summary

from_formula(formula, layers) Create a layer from an operation performed on other layers
from_parent(parent[, layer_mask, name]) Create a duplicate child layer from a parent layer
from_self([name, layer_mask]) Create a new, parentless, layer based on this layer
set_units(disp_unit, data_unit) Set the dispersion and flux units

Attributes Documentation

data

Flux quantity with mask applied. Returns a masked array containing a Quantity object.

dispersion

Dispersion quantity with mask applied. Returns a masked array containing a Quantity object.

full_mask

Mask for spectrum data.

layer_mask

Mask applied from an ROI.

raw_uncertainty

Flux uncertainty with mask applied. Returns a masked array containing a Quantity object.

unmasked_data

Flux quantity with no layer mask applied.

unmasked_dispersion

Dispersion quantity with no layer mask applied.

unmasked_raw_uncertainty

Flux uncertainty with mask applied. Returns a masked array containing a Quantity object.

Methods Documentation

classmethod from_formula(formula, layers)[source]

Create a layer from an operation performed on other layers

Parameters:
  • formula (str) – The operation to perform on the given layers.
  • layers ([layer, ..]) – The layers which are arguments to the given formula.
Returns:

Result of the operation
Return type:

new_layer
classmethod from_parent(parent, layer_mask=None, name=None)[source]

Create a duplicate child layer from a parent layer

Parameters:
  • parent (layer) – The layer to duplicate.
  • layer_mask (layer) – The layer defining the valid data mask.
  • name (str) – Layer’s name. If None, a name based on the parent layer is used.
Returns:

The new layer.
Return type:

child_layer
from_self(name=u'', layer_mask=None)[source]

Create a new, parentless, layer based on this layer

Parameters:
  • name (str) – Name of the new layer
  • layer_mask (layer) – The layer defining the valid data mask.
Returns:

The new, parentless, layer.
Return type:

new_layer
set_units(disp_unit, data_unit)[source]

Set the dispersion and flux units

Parameters:
  • disp_unit (units) – The dispersion units.
  • data_unit (units) – The flux units.