LineListMixin#

class jdaviz.configs.default.plugins.line_lists.line_list_mixin.LineListMixin[source]#

Line list-related methods and properties for use in the configuration helper classes.

Attributes Summary

`available_linelists`
`spectral_lines`

Methods Summary

`erase_spectral_lines`([name])	Convenience function to get to the viewer function
`load_line_list`(line_table[, replace])	Convenience function to get to the viewer function.
`plot_spectral_line`(line[, global_redshift])	Convenience function to get to the viewer function
`plot_spectral_lines`([global_redshift])	Convenience function to get to the viewer function
`set_redshift`(new_redshift)	Apply a redshift to any loaded spectral lines and data.
`set_redshift_slider_bounds`([range, step])	Set the range and/or step of the redshift slider.

Attributes Documentation

Methods Documentation

erase_spectral_lines(name=None)[source]#: Convenience function to get to the viewer function

load_line_list(line_table, replace=False)[source]#: Convenience function to get to the viewer function. Also broadcasts a message so the line list plugin UI can display lines loaded via the notebook.

plot_spectral_line(line, global_redshift=None)[source]#: Convenience function to get to the viewer function

plot_spectral_lines(global_redshift=None)[source]#: Convenience function to get to the viewer function

set_redshift(new_redshift)[source]#: Apply a redshift to any loaded spectral lines and data. Also updates the value shown in the slider.

set_redshift_slider_bounds(range=None, step=None)[source]#

Set the range and/or step of the redshift slider. Set either/both to ‘auto’ for default values based on the limits of the spectrum plot.

Parameters:

rangefloat or None or ‘auto’: Specifies the difference between the upper and lower bounds of the slider. Note that the slider specifies delta redshift from the current value, so a range of 0.1 would allow the user to change the current redshift by +/- 0.05. If None or not passed, will leave at the current value. If ‘auto’, will sync the range based on the limits of the spectrum plot.
stepfloat or None or ‘auto’: Specifies step size of the slider and redshift input (and will be converted to an estimated step for RV). Smaller step sizes will allow finer adjustments/smoother behavior at a potential cost to performance. If None or not passed, will leave at the current value. If ‘auto’, will sync the step size to 1000 steps within the current range.