LineListTool#

class jdaviz.configs.default.plugins.line_lists.line_lists.LineListTool(*args, **kwargs)[source]#

Bases: PluginTemplateMixin, ViewerSelectMixin, CustomToolbarToggleMixin

Public constructor

Attributes Summary

`available_lists`	An instance of a Python list.
`custom_name`	A trait for unicode strings.
`custom_rest`	A trait for unicode strings.
`custom_unit`	A trait for unicode strings.
`custom_unit_choices`	An instance of a Python list.
`dc_items`	An instance of a Python list.
`dialog`	A boolean (True, False) trait.
`filter_range`	A boolean (True, False) trait.
`filter_range_icon`	A trait for unicode strings.
`identify_label`	A trait for unicode strings.
`identify_line_icon`	A trait for unicode strings.
`lines_filter`	A trait which allows any value.
`list_contents`	An instance of a Python dict.
`loaded_lists`	An instance of a Python list.
`rs_enabled`	A boolean (True, False) trait.
`rs_redshift`	Mixin to handle empty floating point field.
`rs_rv`	Mixin to handle empty floating point field.
`rs_rv_step`	A float trait.
`rs_slider`	A float trait.
`rs_slider_half_range`	A float trait.
`rs_slider_ndigits`	An int trait.
`rs_slider_range_auto`	A boolean (True, False) trait.
`rs_slider_step`	A float trait.
`rs_slider_step_auto`	A boolean (True, False) trait.
`rs_slider_throttle`	An int trait.
`spectrum_viewer_max`	A float trait.
`spectrum_viewer_min`	A float trait.
`template_file`

Methods Summary

`import_line_list`(line_table[, show])	Import a line list from a QTable object.
`update_line_mark_dict`()
`vue_add_custom_line`(event)	Add a line to the "Custom" line list from UI input
`vue_change_line_obs`(kwargs)
`vue_change_visible`(data)	Plot or erase a single line as needed when "Visible" checkbox is changed
`vue_erase_all_lines`(event)	Erase all lines from the viewer
`vue_hide_all_in_list`(listname)	Toggle all lines in list to be hidden
`vue_list_selected`(event)	Handle list selection from presets dropdown selector
`vue_load_list`(event)	Load one of the preset line lists, storing it's info in a vuetify-friendly manner in addition to loading the astropy table into the viewer's spectral_lines attribute.
`vue_plot_all_lines`(event)	Plot all the currently loaded lines in the viewer
`vue_remove_line`(line[, erase])	Method to remove a line from the plot when the line is deselected in the expansion panel content.
`vue_remove_list`(listname)	Method to remove line list from available expansion panels when the x on the panel header is clicked.
`vue_set_color`(data)	Change the color either of all members of a line list, or of an individual line.
`vue_set_identify`([data])	Set the selected line as "identified"
`vue_show_all_in_list`(listname)	Toggle all lines in list to be visible
`vue_slider_reset`(event)
`vue_unpause_tables`([event])

Attributes Documentation

available_lists#: An instance of a Python list.

custom_name#: A trait for unicode strings.

custom_rest#: A trait for unicode strings.

custom_unit#: A trait for unicode strings.

custom_unit_choices#: An instance of a Python list.

dc_items#: An instance of a Python list.

dialog#: A boolean (True, False) trait.

filter_range#: A boolean (True, False) trait.

filter_range_icon#: A trait for unicode strings.

identify_label#: A trait for unicode strings.

identify_line_icon#: A trait for unicode strings.

lines_filter#: A trait which allows any value.

list_contents#

An instance of a Python dict.

One or more traits can be passed to the constructor to validate the keys and/or values of the dict. If you need more detailed validation, you may use a custom validator method.

Changed in version 5.0: Added key_trait for validating dict keys.

Changed in version 5.0: Deprecated ambiguous trait, traits args in favor of value_trait, per_key_traits.

loaded_lists#: An instance of a Python list.

rs_enabled#: A boolean (True, False) trait.

rs_redshift#: Mixin to handle empty floating point field.

rs_rv#: Mixin to handle empty floating point field.

rs_rv_step#: A float trait.

rs_slider#: A float trait.

rs_slider_half_range#: A float trait.

rs_slider_ndigits#: An int trait.

rs_slider_range_auto#: A boolean (True, False) trait.

rs_slider_step#: A float trait.

rs_slider_step_auto#: A boolean (True, False) trait.

rs_slider_throttle#: An int trait.

spectrum_viewer_max#: A float trait.

spectrum_viewer_min#: A float trait.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/4148/lib/python3.13/site-packages/jdaviz/configs/default/plugins/line_lists/line_lists.py', 'line_lists.vue')#

Methods Documentation

import_line_list(line_table, show=True)[source]#

Import a line list from a QTable object.

Parameters:

line_tableQTable: Table with line list data. The table must have at least ‘linename’ and ‘rest’ columns. The ‘rest’ column must have proper astropy units.
showbool, optional: Whether to show the lines by default. Defaults to True for API usage.

update_line_mark_dict()[source]#

vue_add_custom_line(event)[source]#: Add a line to the “Custom” line list from UI input

vue_change_line_obs(kwargs)[source]#

vue_change_visible(data)[source]#: Plot or erase a single line as needed when “Visible” checkbox is changed

vue_erase_all_lines(event)[source]#: Erase all lines from the viewer

vue_hide_all_in_list(listname)[source]#: Toggle all lines in list to be hidden

vue_list_selected(event)[source]#: Handle list selection from presets dropdown selector

vue_load_list(event)[source]#: Load one of the preset line lists, storing it’s info in a vuetify-friendly manner in addition to loading the astropy table into the viewer’s spectral_lines attribute.

vue_plot_all_lines(event)[source]#: Plot all the currently loaded lines in the viewer

vue_remove_line(line, erase=True)[source]#: Method to remove a line from the plot when the line is deselected in the expansion panel content. Input must have “linename” and “rest” values for indexing on the astropy table.

vue_remove_list(listname)[source]#: Method to remove line list from available expansion panels when the x on the panel header is clicked. Also removes line marks from plot and updates the “show” value in the astropy table to False.

vue_set_color(data)[source]#: Change the color either of all members of a line list, or of an individual line.

vue_set_identify(data=None)[source]#: Set the selected line as “identified”

vue_show_all_in_list(listname)[source]#: Toggle all lines in list to be visible

vue_slider_reset(event)[source]#

vue_unpause_tables(event=None)[source]#