UnitConversion#

class jdaviz.configs.specviz.plugins.unit_conversion.unit_conversion.UnitConversion(*args, **kwargs)[source]#

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_unit (UnitSelectPluginComponent): Global display unit for flux axis.
angle_unit (UnitSelectPluginComponent): Solid angle unit.
sb_unit (str): Read-only property for the current surface brightness unit, derived from the set values of flux_unit and angle_unit.
spectral_y_type (SelectPluginComponent): Select the y-axis physical type for the spectrum-viewer (applicable only to Cubeviz).
spectral_y_unit: Read-only property for the current y-axis unit in the spectrum-viewer, either flux_unit or sb_unit depending on the selected spectral_y_type (applicable only to Cubeviz).

Public constructor

Attributes Summary

`angle_unit_items`	An instance of a Python list.
`angle_unit_selected`	A trait for unicode strings.
`flux_unit_items`	An instance of a Python list.
`flux_unit_selected`	A trait for unicode strings.
`has_angle`	A boolean (True, False) trait.
`has_flux`	A boolean (True, False) trait.
`has_sb`	A boolean (True, False) trait.
`has_spectral`	A boolean (True, False) trait.
`has_time`	A boolean (True, False) trait.
`image_layers`
`pixar_sr_exists`	A boolean (True, False) trait.
`sb_unit`
`sb_unit_selected`	A trait for unicode strings.
`spectral_unit_items`	An instance of a Python list.
`spectral_unit_selected`	A trait for unicode strings.
`spectral_y_type_items`	An instance of a Python list.
`spectral_y_type_selected`	A trait for unicode strings.
`spectral_y_unit`
`template_file`
`time_unit_items`	An instance of a Python list.
`time_unit_selected`	A trait for unicode strings.
`user_api`

Attributes Documentation

angle_unit_items#: An instance of a Python list.

angle_unit_selected#: A trait for unicode strings.

flux_unit_items#: An instance of a Python list.

flux_unit_selected#: A trait for unicode strings.

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

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

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

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

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

image_layers#

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

sb_unit#

sb_unit_selected#: A trait for unicode strings.

spectral_unit_items#: An instance of a Python list.

spectral_unit_selected#: A trait for unicode strings.

spectral_y_type_items#: An instance of a Python list.

spectral_y_type_selected#: A trait for unicode strings.

spectral_y_unit#

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')#

time_unit_items#: An instance of a Python list.

time_unit_selected#: A trait for unicode strings.

user_api#