Collapse

class jdaviz.configs.default.plugins.collapse.collapse.Collapse(*args, **kwargs)

Bases: PluginTemplateMixin, DatasetSelectMixin, SpectralSubsetSelectMixin, AddResultsMixin

See the Collapse Plugin Documentation for more details.

Only the following attributes and methods are available through the public plugin API:

• show()

• open_in_tray()

• close_in_tray()

• dataset (DatasetSelect): Dataset to use for computing line statistics.

• spectral_subset (SubsetSelect): Subset to use for the line, or Entire Spectrum.

• add_results (AddResults)

• collapse()

Public constructor

Attributes Summary

collapsed_flux_available	A boolean (True, False) trait.
export_enabled	A boolean (True, False) trait.
filename	A trait for unicode strings.
function_items	An instance of a Python list.
function_selected	A trait for unicode strings.
template_file
user_api

Methods Summary

collapse([add_data])	Collapse over the spectral axis.
vue_collapse(*args, **kwargs)

Attributes Documentation

collapsed_flux_available

A boolean (True, False) trait.

export_enabled

A boolean (True, False) trait.

filename

A trait for unicode strings.

function_items

An instance of a Python list.

function_selected

A trait for unicode strings.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz-javerbukh/envs/loader-docs/lib/python3.11/site-packages/jdaviz/configs/default/plugins/collapse/collapse.py', 'collapse.vue')

user_api

Methods Documentation

collapse(add_data=True)

Collapse over the spectral axis.

Parameters:

add_databool

Whether to load the resulting data back into the application according to add_results.

vue_collapse(*args, **kwargs)