Specviz2d

class jdaviz.configs.specviz2d.helper.Specviz2d(*args, **kwargs)[source] [edit on github]

Bases: ConfigHelper, LineListMixin

Specviz2D Helper class

Attributes Summary

specviz

A Specviz helper (Specviz) for the Jdaviz application that is wrapped by Specviz2d.

Methods Summary

load_data([spectrum_2d, spectrum_1d, ...])

Load and parse a pair of corresponding 1D and 2D spectra.

load_trace(trace, data_label[, show_in_viewer])

Load a trace object and load into the spectrum-2d-viewer

Attributes Documentation

specviz

A Specviz helper (Specviz) for the Jdaviz application that is wrapped by Specviz2d.

Methods Documentation

load_data(spectrum_2d=None, spectrum_1d=None, spectrum_1d_label=None, spectrum_2d_label=None, show_in_viewer=True)[source] [edit on github]

Load and parse a pair of corresponding 1D and 2D spectra.

Parameters
spectrum_2d: str

A spectrum as translatable container objects (e.g., Spectrum1D) that can be read by glue-jupyter. Alternatively, can be a string file path.

spectrum_1d: str or Spectrum1D

A spectrum as translatable container objects (e.g., Spectrum1D) that can be read by glue-jupyter. Alternatively, can be a string file path.

spectrum_1d_labelstr

String representing the label for the data item loaded via spectrum_1d.

spectrum_2d_labelstr

String representing the label for the data item loaded via spectrum_2d.

show_in_viewerbool

Show data in viewer(s).

load_trace(trace, data_label, show_in_viewer=True)[source] [edit on github]

Load a trace object and load into the spectrum-2d-viewer

Parameters
traceTrace

A specreduce trace object

data_labelstr

String representing the label

show_in_viewerbool

Whether to load into the spectrum-2d-viewer.