DataQuality

class jdaviz.configs.default.plugins.data_quality.data_quality.DataQuality(*args, **kwargs)

Bases: PluginTemplateMixin, ViewerSelectMixin

See the Data Quality 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()

• science_layer (LayerSelect)

• dq_layer (LayerSelect):

  data quality layer corresponding to the science data in science_layer

• dq_layer_opacity: Opacity of the data quality layer.

• decoded_flags: List of decoded flags from the selected flag map.

• flags_filter: List of flags to display.

• flag_map_definitions_selected: Dictionary of the selected flag map.

Public constructor

Attributes Summary

decoded_flags	An instance of a Python list.
dq_layer_items	An instance of a Python list.
dq_layer_multiselect	A boolean (True, False) trait.
dq_layer_opacity	A float trait.
dq_layer_selected	A trait which allows any value.
dq_layer_selected_flattened
flag_map_definitions	An instance of a Python dict.
flag_map_definitions_selected	An instance of a Python dict.
flag_map_items	An instance of a Python list.
flag_map_selected	A trait which allows any value.
flags_filter	An instance of a Python list.
icon_checktoradial	A trait for unicode strings.
icon_radialtocheck	A trait for unicode strings.
icons	An instance of a Python dict.
init_decoding
mission_or_instrument_from_meta
science_layer_items	An instance of a Python list.
science_layer_multiselect	A boolean (True, False) trait.
science_layer_selected	A trait which allows any value.
template_file
unique_flags
update_dq_layer
update_flag_map_definitions_selected
update_opacity
user_api
validate_flag_decode_possible

Methods Summary

get_dq_layers([viewers])
get_science_layers([viewers])
load_default_flag_maps()
update_color(index, color)
update_visibility(index)
vue_clear_flags_filter(event)
vue_hide_all_flags(event)
vue_show_all_flags(event)
vue_update_cmap()
vue_update_color(args)
vue_update_visibility(index)

Attributes Documentation

decoded_flags

An instance of a Python list.

dq_layer_items

An instance of a Python list.

dq_layer_multiselect

A boolean (True, False) trait.

dq_layer_opacity

A float trait.

dq_layer_selected

A trait which allows any value.

dq_layer_selected_flattened

flag_map_definitions

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.

flag_map_definitions_selected

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.

flag_map_items

An instance of a Python list.

flag_map_selected

A trait which allows any value.

flags_filter

An instance of a Python list.

icon_checktoradial

A trait for unicode strings.

icon_radialtocheck

A trait for unicode strings.

icons

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.

init_decoding

mission_or_instrument_from_meta

science_layer_items

An instance of a Python list.

science_layer_multiselect

A boolean (True, False) trait.

science_layer_selected

A trait which allows any value.

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

unique_flags

update_dq_layer

update_flag_map_definitions_selected

update_opacity

user_api

validate_flag_decode_possible

Methods Documentation

get_dq_layers(viewers=None)

get_science_layers(viewers=None)

load_default_flag_maps()

update_color(index, color)

update_visibility(index)

vue_clear_flags_filter(event)

vue_hide_all_flags(event)

vue_show_all_flags(event)

vue_update_cmap()

vue_update_color(args)

vue_update_visibility(index)