|
def | __init__ (self, display, verbose=False, url=None, name=None, *args, **kwargs) |
|
def | getClient (self) |
|
def | clearViewer (self) |
|
def | resetLayout (self) |
|
def | overlayFootprints (self, catalog, color='rgba(74, 144, 226, 0.60)', highlightColor='cyan', selectColor='orange', style='fill', layerString='detection footprints ', titleString='catalog footprints ') |
|
Device to talk to a firefly display
◆ clearViewer()
def lsst.display.firefly.firefly.DisplayImpl.clearViewer |
( |
|
self | ) |
|
◆ getClient()
def lsst.display.firefly.firefly.DisplayImpl.getClient |
( |
|
self | ) |
|
Get the instance of FireflyClient for this display
Returns:
--------
`firefly_client.FireflyClient`
Instance of FireflyClient used by this display
◆ overlayFootprints()
def lsst.display.firefly.firefly.DisplayImpl.overlayFootprints |
( |
|
self, |
|
|
|
catalog, |
|
|
|
color = 'rgba(74,144,226,0.60)' , |
|
|
|
highlightColor = 'cyan' , |
|
|
|
selectColor = 'orange' , |
|
|
|
style = 'fill' , |
|
|
|
layerString = 'detection footprints ' , |
|
|
|
titleString = 'catalog footprints ' |
|
) |
| |
Overlay outlines of footprints from a catalog
Overlay outlines of LSST footprints from the input catalog. The colors
and style can be specified as parameters, and the base color and style
can be changed in the Firefly browser user interface.
Parameters:
-----------
catalog : `lsst.afw.table.SourceCatalog`
Source catalog from which to display footprints.
color : `str`
Color for footprints overlay. Colors can be specified as a name
like 'cyan' or afwDisplay.RED; as an rgb value such as
'rgb(80,100,220)'; or as rgb plus alpha (transparency) such
as 'rgba('74,144,226,0.60)'.
highlightColor : `str`
Color for highlighted footprints
selectColor : `str`
Color for selected footprints
style : {'fill', 'outline'}
Style of footprints display, filled or outline
insertColumn : `int`
Column at which to insert the "family_id" and "category" columns
layerString: `str`
Name of footprints layer string, to concatenate with the frame
Re-using the layer_string will overwrite the previous table and
footprints
titleString: `str`
Title of catalog, to concatenate with the frame
◆ resetLayout()
def lsst.display.firefly.firefly.DisplayImpl.resetLayout |
( |
|
self | ) |
|
Reset the layout of the Firefly Slate browser
Clears the display and adds Slate cells to display image in upper left,
plot area in upper right, and plots stretch across the bottom
The documentation for this class was generated from the following file:
- python/lsst/display/firefly/firefly.py