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

This plugin supports loading and overplotting instrument footprint overlays on the image viewers. Any number of overlays can be plotted simultaneously from any number of the available preset instruments (requires pysiaf to be installed), by loading an Astropy regions object from a file, or by passing an STC-S string.

The top dropdown allows renaming, adding, and removing footprint overlays. To modify the display and input parameters for a given overlay, select the overlay in the dropdown, and modify the choices in the plugin to change its color, opacity, visibilities in any image viewer in the app. You can also select between various preset instruments and change the input options (position on the sky, position angle, offsets, etc).

To import a file, open the “Import” section at the top of the dropdown and select a valid file (must be able to be parsed by regions.Regions.read) from the applicable source.

UI Access#

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 = jd.plugins['Footprints']
plg.open_in_tray()
plg.add_overlay('my imported overlay')  # or fp.rename_overlay to rename an existing entry
plg.import_region(region)

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

  • enable_footprint_selection_tools()

    enable footprint selection tools in the viewer toolbar

  • disable_footprint_selection_tools()

    disable footprint selection tools in the viewer toolbar

For detailed API documentation, see Footprints.