Footprints

class jdaviz.configs.imviz.plugins.footprints.footprints.Footprints(*args, **kwargs)

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:

• show()

• open_in_tray()

• close_in_tray()

• overlay (EditableSelectPluginComponent): the

  currently 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

• import_region()

• center_on_viewer()

• 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.

• overlay_regions()

Public constructor

Attributes Summary

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
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 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/latest/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)

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)

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)

Import an Astropy regions object (or file).

Parameters:

regionstr or regions.Regions object

remove_overlay(lbl)

Remove a overlay instance. If selected, the selected overlay will default to the first entry in the list.

Parameters:

lblstring

label of the overlay

rename_overlay(old_lbl, new_lbl)

Rename an existing overlay instance

Parameters:

old_lblstring

current label of the overlay

new_lblstring

new label of the overlay

vue_center_on_viewer(viewer_ref)

vue_link_by_wcs(*args)