UnitConversion

class jdaviz.configs.specviz.plugins.unit_conversion.unit_conversion.UnitConversion(*args, **kwargs)

Bases: PluginTemplateMixin

The Unit Conversion plugin handles global app-wide unit-conversion. See the Unit Conversion 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()

• spectral_unit (UnitSelectPluginComponent): Global unit to use for all spectral axes.

• flux_or_sb_unit (UnitSelectPluginComponent): Global unit to use for all flux/surface brightness (depending on flux_or_sb selection) axes.

• flux_or_sb (SelectPluginComponent): Y-axis physical type selection. Currently only accessible in Cubeviz (pixel scale factor added in Cubeviz Spectral Extraction, and is used for this translation).

Public constructor

Attributes Summary

flux_or_sb_items	An instance of a Python list.
flux_or_sb_selected	A trait for unicode strings.
flux_unit_items	An instance of a Python list.
flux_unit_selected	A trait for unicode strings.
show_translator	A boolean (True, False) trait.
spectral_unit_items	An instance of a Python list.
spectral_unit_selected	A trait for unicode strings.
template_file
user_api

Methods Summary

translate_units(flux_or_sb_selected)

Attributes Documentation

flux_or_sb_items

An instance of a Python list.

flux_or_sb_selected

A trait for unicode strings.

flux_unit_items

An instance of a Python list.

flux_unit_selected

A trait for unicode strings.

show_translator

A boolean (True, False) trait.

spectral_unit_items

An instance of a Python list.

spectral_unit_selected

A trait for unicode strings.

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

user_api

Methods Documentation

translate_units(flux_or_sb_selected)