Orientation#
- class jdaviz.configs.imviz.plugins.orientation.orientation.Orientation(*args, **kwargs)[source]#
Bases:
PluginTemplateMixin
,ViewerSelectMixin
See the Orientation Plugin Documentation for more details.
Note
Changing linking after adding markers via
add_markers
is unsupported and will raise an error requiring resetting the markers manually viaadd_markers
or clicking a button in the plugin first.Only the following attributes and methods are available through the public plugin API:
link_type
(SelectPluginComponent
)wcs_use_affine
delete_subsets
viewer
orientation
rotation_angle
east_left
add_orientation
Public constructor
Attributes Summary
A boolean (True, False) trait.
An instance of a Python dict.
An instance of a Python list.
A trait for unicode strings.
A boolean (True, False) trait.
A boolean (True, False) trait.
A boolean (True, False) trait.
A boolean (True, False) trait.
A trait for unicode strings.
A boolean (True, False) trait.
A trait for unicode strings.
An instance of a Python list.
A trait for unicode strings.
A boolean (True, False) trait.
Mixin to handle empty floating point field.
An instance of a Python list.
A trait for unicode strings.
A boolean (True, False) trait.
A boolean (True, False) trait.
A boolean (True, False) trait.
Methods Summary
add_orientation
([rotation_angle, east_left, ...])Add new orientation options.
create_north_up_east_left
([label, ...])Set the rotation angle and flip to achieve North up and East left according to the reference image WCS.
create_north_up_east_right
([label, ...])Set the rotation angle and flip to achieve North up and East right according to the reference image WCS.
rotation_angle_deg
([rotation_angle])vue_add_orientation
(*args, **kwargs)vue_delete_subsets
(*args)vue_select_default_orientation
(*args, **kwargs)vue_select_north_up_east_left
(*args, **kwargs)vue_select_north_up_east_right
(*args, **kwargs)Attributes Documentation
- east_left#
A boolean (True, False) trait.
- 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 ofvalue_trait
,per_key_traits
.
- link_type_items#
An instance of a Python list.
- link_type_selected#
A trait for unicode strings.
- linking_in_progress#
A boolean (True, False) trait.
- multiselect#
A boolean (True, False) trait.
- need_clear_astrowidget_markers#
A boolean (True, False) trait.
- need_clear_subsets#
A boolean (True, False) trait.
- new_layer_label#
A trait for unicode strings.
- new_layer_label_auto#
A boolean (True, False) trait.
- new_layer_label_default#
A trait for unicode strings.
- orientation_layer_items#
An instance of a Python list.
- orientation_layer_selected#
A trait for unicode strings.
- plugin_markers_exist#
A boolean (True, False) trait.
- ref_data#
- rotation_angle#
Mixin to handle empty floating point field.
- template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/latest/lib/python3.11/site-packages/jdaviz/configs/imviz/plugins/orientation/orientation.py', 'orientation.vue')#
- user_api#
- viewer_items#
An instance of a Python list.
- viewer_selected#
A trait for unicode strings.
- wcs_linking_available#
A boolean (True, False) trait.
- wcs_use_affine#
A boolean (True, False) trait.
- wcs_use_fallback#
A boolean (True, False) trait.
Methods Documentation
- add_orientation(rotation_angle=None, east_left=None, label=None, set_on_create=True, wrt_data=None)[source]#
Add new orientation options.
- Parameters:
- rotation_anglefloat, optional
Desired sky orientation angle in degrees. If
None
, the value will followself.rotation_angle
. If nothing is set anywhere, it defaults to zero degrees.- east_leftbool, optional
Set to
True
if you want N-up E-left orFalse
for N-up E-right. IfNone
, the value will followself.east_left
.- labelstr, optional
Data label for this new orientation layer. If
None
, the value will followself.new_layer_label
.- set_on_createbool, optional
If
True
, this new orientation layer will become active on creation. Otherwise, it will be created but stay inactive in the background.- wrt_datastr, optional
Orientation calculations is done with respect to this data WCS. If
None
, it grabs the first loaded data in the selected viewer (may or may not be visible); If no data is loaded in the viewer, nothing will be done.
- create_north_up_east_left(label='North-up, East-left', set_on_create=False, from_ui=False)[source]#
Set the rotation angle and flip to achieve North up and East left according to the reference image WCS.