Footprints#

Plugin Availability

The plugin will be visible when at least one viewer is available.

Overlay instrument footprints on sky images.

Description#

The Footprints plugin displays instrument field-of-view footprints on images, showing detector layouts and orientations for planning or analysis.

Key Features:

  • Display JWST/HST instrument footprints

  • Position and rotate footprints

  • Multiple footprint overlays

  • Export footprint regions

UI Access#

v0.1
Click toolbar icons to toggle different sidebars
Data Menu

Control data and subset layer order and visibility for each viewer. Toggle layer visibility, reorder layers by dragging, and manage which data appears in the viewer. 

dm = jd.viewers[viewer].data_menu

Click the Footprints icon in the plugin toolbar to:

  1. Select instrument

  2. Position footprint on image

  3. Adjust orientation

  4. Toggle visibility

API Access#

plg = imviz.plugins['Footprints']
# Add and configure footprints programmatically

API References#

Only the following attributes and methods are available through the

public plugin API:

  • show()

  • open_in_tray()

  • close_in_tray()

  • loaders Dictionary of loaders to load subsets into the plugin.

  • 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_obs (SelectPluginComponent):

    selected observatories to filter preset choices.

  • 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()

For detailed API documentation, see Footprints.

See Also#