Compass#

class jdaviz.configs.imviz.plugins.compass.compass.Compass(*args, **kwargs)[source]#

Bases: PluginTemplateMixin, ViewerSelectMixin

See the Compass 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()
viewer (ViewerSelect): Viewer to show orientation/compass information.
data_label: label of the top-layer shown in the compass (read-only)

Public constructor

Attributes Summary

`canvas_angle`	A float trait.
`canvas_flip_horizontal`	A boolean (True, False) trait.
`data_label`	A trait for unicode strings.
`icon`	A trait for unicode strings.
`img_data`	A trait for unicode strings.
`template_file`
`user_api`
`uses_active_status`	A boolean (True, False) trait.

Methods Summary

`clear_compass`()	Clear the content of the plugin.
`draw_compass`(data_label, img_data)	Draw compass in the plugin.

Attributes Documentation

canvas_angle#: A float trait.

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

data_label#: A trait for unicode strings.

icon#: A trait for unicode strings.

img_data#: A trait for unicode strings.

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

user_api#

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

Methods Documentation

clear_compass()[source]#: Clear the content of the plugin.

draw_compass(data_label, img_data)[source]#: Draw compass in the plugin. Input is rendered buffer from Matplotlib.