LineAnalysis

class jdaviz.configs.specviz.plugins.line_analysis.line_analysis.LineAnalysis(*args, **kwargs)[source] [edit on github]

Bases: PluginTemplateMixin, DatasetSelectMixin, SpectralSubsetSelectMixin, DatasetSpectralSubsetValidMixin

The Line Analysis plugin returns specutils analysis for a single spectral line. See the Line Analysis Plugin Documentation for more details.

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

  • show()

  • open_in_tray()

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

  • spatial_subset (SubsetSelect): Select which region’s collapsed spectrum to analyze or Entire Cube.

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

  • continuum (SubsetSelect): Subset to use for the continuum, or Surrounding to use a region surrounding the subset set in spectral_subset.

  • width: Width, relative to the overall line spectral region, to fit the linear continuum (excluding the region containing the line). If 1, will use endpoints within line region only.

  • show_continuum_marks()

  • get_results()

Public constructor

Attributes Summary

continuum_subset_items

An instance of a Python list.

continuum_subset_selected

A trait for unicode strings.

dialog

A boolean (True, False) trait.

identified_line

A trait for unicode strings.

line_items

An instance of a Python list.

marks

results

An instance of a Python list.

results_centroid

A float trait.

results_computing

A boolean (True, False) trait.

selected_line

A trait for unicode strings.

selected_line_redshift

A float trait.

spatial_subset_items

An instance of a Python list.

spatial_subset_selected

A trait for unicode strings.

sync_identify

A boolean (True, False) trait.

sync_identify_icon_disabled

A trait for unicode strings.

sync_identify_icon_enabled

A trait for unicode strings.

template_file

user_api

width

Mixin to handle empty floating point field.

Methods Summary

get_results()

show_continuum_marks([show])

Show (or hide) the marks indicating the continuum on the spectrum viewer.

update_results([results, mark_x, mark_y])

vue_line_assign([msg])

Attributes Documentation

continuum_subset_items

An instance of a Python list.

continuum_subset_selected

A trait for unicode strings.

dialog

A boolean (True, False) trait.

identified_line

A trait for unicode strings.

line_items

An instance of a Python list.

marks
results

An instance of a Python list.

results_centroid

A float trait.

results_computing

A boolean (True, False) trait.

selected_line

A trait for unicode strings.

selected_line_redshift

A float trait.

spatial_subset_items

An instance of a Python list.

spatial_subset_selected

A trait for unicode strings.

sync_identify

A boolean (True, False) trait.

sync_identify_icon_disabled

A trait for unicode strings.

sync_identify_icon_enabled

A trait for unicode strings.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/v3.5.0/lib/python3.9/site-packages/jdaviz/configs/specviz/plugins/line_analysis/line_analysis.py', 'line_analysis.vue')
user_api
width

Mixin to handle empty floating point field.

Methods Documentation

get_results()[source] [edit on github]
show_continuum_marks(show=True)[source] [edit on github]

Show (or hide) the marks indicating the continuum on the spectrum viewer.

Parameters:
showbool

Whether to show (or hide) the marks

update_results(results=None, mark_x={}, mark_y={})[source] [edit on github]
vue_line_assign(msg=None)[source] [edit on github]