Footprints#
- class jdaviz.configs.imviz.plugins.footprints.footprints.Footprints(*args, **kwargs)[source]#
Bases:
PluginTemplateMixin
,ViewerSelectMixin
,HasFileImportSelect
See the Footprints Plugin Documentation for more details.
Only the following attributes and methods are available through the public plugin API:
overlay
(EditableSelectPluginComponent
): thecurrently active overlay (all other traitlets control this overlay instance)
rename_overlay()
rename any overlay
add_overlay()
add a new overlay instance (and select as active)
remove_overlay()
remove any overlay
viewer
(ViewerSelect
):viewer(s) to show the current overlay
visible
whether the currently selected overlay should be visible in the selected viewers
color
color of the currently selected overlay
fill_opacity
opacity of the filled region of the currently selected overlay
preset
(SelectPluginComponent
):selected overlay preset
ra
central right ascension for the footprint overlay
dec
central declination (in degrees) for the footprint overlay
pa
position angle (in degrees) measured from North to central vertical axis in North to East direction.
v2_offset
Additional V2 offset in telescope coordinates to apply to instrument center, as from a dither pattern.
v3_offset
Additional V3 offset in telescope coordinates to apply to instrument center, as from a dither pattern.
Public constructor
Attributes Summary
A trait for unicode strings.
Mixin to handle empty floating point field.
Mixin to handle empty floating point field.
A boolean (True, False) trait.
A boolean (True, False) trait.
A trait for unicode strings.
An instance of a Python list.
A trait for unicode strings.
Access the regions objects corresponding to the current settings
A trait for unicode strings.
Mixin to handle empty floating point field.
An instance of a Python list.
A trait for unicode strings.
Mixin to handle empty floating point field.
A boolean (True, False) trait.
Mixin to handle empty floating point field.
Mixin to handle empty floating point field.
A boolean (True, False) trait.
Methods Summary
add_overlay
(lbl)Add a new overlay instance, and set it as selected.
center_on_viewer
([viewer_ref])Center the values of RA and DEC based on the current zoom-limits of a viewer.
import_region
(region)Import an Astropy regions object (or file).
remove_overlay
(lbl)Remove a overlay instance.
rename_overlay
(old_lbl, new_lbl)Rename an existing overlay instance
vue_center_on_viewer
(viewer_ref)vue_link_by_wcs
(*args)Attributes Documentation
- color#
A trait for unicode strings.
- dec#
Mixin to handle empty floating point field.
- fill_opacity#
Mixin to handle empty floating point field.
- has_pysiaf#
A boolean (True, False) trait.
- is_pixel_linked#
A boolean (True, False) trait.
- marks#
- overlay_edit_value#
A trait for unicode strings.
- overlay_items#
An instance of a Python list.
- overlay_mode#
A trait for unicode strings.
- overlay_regions#
Access the regions objects corresponding to the current settings
- overlay_selected#
A trait for unicode strings.
- pa#
Mixin to handle empty floating point field.
- preset_items#
An instance of a Python list.
- preset_selected#
A trait for unicode strings.
- ra#
Mixin to handle empty floating point field.
- template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/stable/lib/python3.11/site-packages/jdaviz/configs/imviz/plugins/footprints/footprints.py', 'footprints.vue')#
- user_api#
- uses_active_status#
A boolean (True, False) trait.
- v2_offset#
Mixin to handle empty floating point field.
- v3_offset#
Mixin to handle empty floating point field.
- visible#
A boolean (True, False) trait.
Methods Documentation
- add_overlay(lbl)[source]#
Add a new overlay instance, and set it as selected. Once selected, the traitlets will then control the options of the new overlay.
- Parameters:
- lblstring
label of the overlay
- center_on_viewer(viewer_ref=None)[source]#
Center the values of RA and DEC based on the current zoom-limits of a viewer.
- Parameters:
- viewer_refstring, optional
Reference of the viewer to center, will default to the first selected viewer
- import_region(region)[source]#
Import an Astropy regions object (or file).
- Parameters:
- regionstr or regions.Regions object
- remove_overlay(lbl)[source]#
Remove a overlay instance. If selected, the selected overlay will default to the first entry in the list.
- Parameters:
- lblstring
label of the overlay