Slice#

class jdaviz.configs.cubeviz.plugins.slice.slice.Slice(*args, **kwargs)[source]#

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

show()
open_in_tray()
close_in_tray()
value Value (wavelength or frequency) of the current slice. When setting this directly, it will update automatically to the value corresponding to the nearest slice, if snap_to_slice is enabled.
show_indicator Whether to show indicator in spectral viewer when slice tool is inactive.
show_value Whether to show slice value in label to right of indicator.

Public constructor

Attributes Summary

`allow_disable_snapping`	A boolean (True, False) trait.
`cube_viewer_exists`	A boolean (True, False) trait.
`is_playing`	A boolean (True, False) trait.
`play_interval`	An int trait.
`show_indicator`	A boolean (True, False) trait.
`show_value`	A boolean (True, False) trait.
`show_wavelength`	Deprecated since version 3.9.
`slice`	Deprecated since version 3.9.
`slice_display_unit_name`
`slice_indicator_viewers`
`slice_selection_viewers`
`slider_throttle`	An int trait.
`snap_to_slice`	A boolean (True, False) trait.
`template_file`
`user_api`
`valid_indicator_values`
`valid_indicator_values_sorted`
`valid_selection_values`
`valid_selection_values_sorted`
`valid_slice_att_names`
`valid_values`
`valid_values_sorted`
`value`	Mixin to handle empty floating point field.
`value_editing`	A boolean (True, False) trait.
`value_label`	A trait for unicode strings.
`value_unit`	A trait for unicode strings.
`wavelength`	Deprecated since version 3.9.
`wavelength_unit`	Deprecated since version 3.9.

Methods Summary

Attributes Documentation

show_wavelength#: Deprecated since version 3.9: The show_wavelength function is deprecated and may be removed in a future version. Use show_value instead.

slice#: Deprecated since version 3.9: The slice function is deprecated and may be removed in a future version. Use value instead.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/latest/lib/python3.11/site-packages/jdaviz/configs/cubeviz/plugins/slice/slice.py', 'slice.vue')#

wavelength#: Deprecated since version 3.9: The wavelength function is deprecated and may be removed in a future version. Use value instead.

wavelength_unit#: Deprecated since version 3.9: The wavelength_unit function is deprecated and may be removed in a future version. Use value_unit instead.

Methods Documentation