jdaviz icon indicating copy to clipboard operation
jdaviz copied to clipboard

Region overlay marks and viewer convenience methods

Open bmorris3 opened this issue 1 month ago • 2 comments

Description

Introducing the RegionOverlay mark, which is similar to but distinct from the FootprintOverlay mark. FootprintOverlay is meant specifically for the Footprints plugin, RegionOverlay is for general use like (1) plotting footprints from fileset queries in loaders, (2) plotting the footprint of one image viewer in another. For the latter, think mast-aladin specifically, but this could equally apply to multiple jdaviz image viewers without matched pan/zoom.

RegionOverlay and the accompanying private methods on ImvizImageView plot sky regions in an image viewer. Region overlays have a selected state, and selecting the mark (1) changes the visual style of the mark, and (2) brings selected regions to the top of the plot so that they're not buried under non-selected regions.

These methods are private and API-only for now, though they could be made public and exposed in the UI in the future.

I will ask @Jenneh and @tomdonaldson for default and selected styles in Missions MAST, and update this PR as needed.

https://github.com/user-attachments/assets/a1aecd2f-033a-4596-af6e-4a0644cd3318

Change log entry

  • [ ] Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts, list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • [ ] Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • [ ] Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • [ ] Do the proposed changes follow the STScI Style Guides?
  • [ ] Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • [ ] Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • [ ] If new remote data is added that uses MAST, is the URI added to the cache-download.yml workflow?
  • [ ] Did the CI pass? If not, are the failures related?
  • [ ] Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • [ ] After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

bmorris3 avatar Oct 29 '25 19:10 bmorris3