Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: display_firefly
-
Labels:None
-
Story Points:14
-
Epic Link:
-
Sprint:SUIT Sprint 2018-10, SUIT Sprint 2018-11
-
Team:Science User Interface
Description
Implement functionality as part of the display_firefly backend to enable drawing footprints on an image, a custom method of the Display object.
The overlayFootprints method will take the SourceCatalog instance as a required arguments, and will upload a table object that Firefly will understand to contain LSST detection footprints for drawing. Functionality will be added for setting the layout to place the image at upper left and the table at bottom in the Firefly display, similar to IRSA's Gator layout.
The example notebook is https://github.com/lsst/display_firefly/blob/master/examples/HSC-Footprints.ipynb
Attachments
Issue Links
- has to be finished together with
-
- Done
- relates to
-
DM-16451 Fix color parameter names for overlaying footprints
- Done
-
- Done
-
- Won't Fix
-
DM-16441 Speed up creation of footprints table for Firefly
- Done
-
- Done
- mentioned in
-
Page Loading...
Activity
David Shupe
created issue -
David Shupe
made changes -
| Field | Original Value | New Value |
|---|---|---|
| Risk Score | 0 |
David Shupe
made changes -
David Shupe
made changes -
David Shupe
made changes -
| Team | Science User Interface [ 10303 ] | |
| Priority | Undefined [ 10000 ] | Major [ 3 ] |
| Remote Link | This issue links to "Page (Confluence)" [ 17976 ] |
| Epic Link |
|
| Sprint | SUIT Sprint 2018-10 [ 740 ] | |
| Story Points | 14 |
David Shupe
made changes -
| Status | To Do [ 10001 ] | In Progress [ 3 ] |
David Shupe
made changes -
| Sprint | SUIT Sprint 2018-10 [ 740 ] | SUIT Sprint 2018-10, SUIT Sprint 2018-11 [ 740, 741 ] |
David Shupe
made changes -
| Description |
Implement a {{browse}} or {{browse_sources}} function as part of the {{display_firefly}} backend, either as a custom method of the D{{isplay}} object, or as a function in a module inside the backend.
Starting with a Butler instance and a {{dataId}} for a coadd or a single exposure, retrieve the appropriate {{SourceCatalog}} from the Butler instance. The {{browse_sources}} method or function will take the {{SourceCatalog}} instance and a Butler instance as required arguments, and will include boolean switches for {{image}} and {{footprints}} indicating whether to display them. From the {{SourceCatalog}}, the method will infer the corresponding image, retrieve it from the Butler and display it (except when {{image}} is set to {{False}}). The method will compute the JSON object for the footprints and overlay it on the image, except when {{footprints}} is set to False. The layout will place the image at upper left and the table at upper right in the Firefly display, similar to IRSA's Gator layout. The {{browse}} method or function will take the {{dataId}} as the first argument and a Butler instance as a second required argument., and will include boolean switches for {{image}}, {{sources}} and {{footprints}}. For the switches set to {{True}}, the method will display the image, source table, and footprints according to the switches. Assumption: the Butler needs to be passed in explicitly as an argument and the {{SourceCatalog}} does not know what Butler repository it came from. |
Implement functionality as part of the {{display_firefly}} backend to enable drawing footprints on an image, a custom method of the {{Display}} object.
The {{overlayFootprints}} method will take the {{SourceCatalog}} instance as a required arguments, and will upload a table object that Firefly will understand to contain LSST detection footprints for drawing. Functionality will be added for setting the layout to place the image at upper left and the table at bottom in the Firefly display, similar to IRSA's Gator layout. |
David Shupe
made changes -
| Reviewers | Gregory Dubois-Felsmann [ gpdf ] | Jim Bosch [ jbosch ] |
| Status | In Progress [ 3 ] | In Review [ 10004 ] |
David Shupe
made changes -
David Shupe
made changes -
Looks good, to the extend I can judge given my lack of knowledge of VOTable and Firefly protocols; my comments are mostly style issues that are mostly fixable with some linting.
It'd definitely be good to update the example notebook after this functionality is live on lsp-dev to reflect that environment in terms of data locations and Firefly server access.
| Status | In Review [ 10004 ] | Reviewed [ 10101 ] |
David Shupe
made changes -
Tested in the lsst-lspdev environment with Firefly server url as http://lsst-demo.ncsa.illinois.edu/firefly
In the future we will want to make use of slots_centroid_x and slots_centroid_y as noted on the review of the pull request.
In the lsst-lspdev environment, the creation of the VOTable for Firefly can be quite slow. DM-16441 has been filed to address this aspect of performance.
David Shupe
added a comment - Tested in the lsst-lspdev environment with Firefly server url as http://lsst-demo.ncsa.illinois.edu/firefly
In the future we will want to make use of slots_centroid_x and slots_centroid_y as noted on the review of the pull request.
In the lsst-lspdev environment, the creation of the VOTable for Firefly can be quite slow. DM-16441 has been filed to address this aspect of performance. David Shupe
made changes -
| Resolution | Done [ 10000 ] | |
| Status | Reviewed [ 10101 ] | Done [ 10002 ] |
David Shupe
made changes -
David Shupe
made changes -
| Description |
Implement functionality as part of the {{display_firefly}} backend to enable drawing footprints on an image, a custom method of the {{Display}} object.
The {{overlayFootprints}} method will take the {{SourceCatalog}} instance as a required arguments, and will upload a table object that Firefly will understand to contain LSST detection footprints for drawing. Functionality will be added for setting the layout to place the image at upper left and the table at bottom in the Firefly display, similar to IRSA's Gator layout. |
Implement functionality as part of the {{display_firefly}} backend to enable drawing footprints on an image, a custom method of the {{Display}} object.
The {{overlayFootprints}} method will take the {{SourceCatalog}} instance as a required arguments, and will upload a table object that Firefly will understand to contain LSST detection footprints for drawing. Functionality will be added for setting the layout to place the image at upper left and the table at bottom in the Firefly display, similar to IRSA's Gator layout. The example notebook is https://github.com/lsst/display_firefly/blob/master/examples/HSC-Footprints.ipynb |
There is a large function to convert the afwTable.SourceCatalog into an astropy.vo.VOTableFile that Firefly uses draw the detection footprints and link them to the table. An example notebook has been provided.
Final review probably ought to wait until we have the updated Firefly server and firefly_client available for testing from the lsst-lspdev science platform.