|
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 ') |
|
|
def | _getRegionLayerId (self) |
|
def | _clearImage (self) |
|
def | _mtv (self, image, mask=None, wcs=None, title="") |
|
def | _remove_masks (self) |
|
def | _buffer (self, enable=True) |
| Enable or disable buffering of writes to the display param enable True or False, as appropriate.
|
|
def | _flush (self) |
| Flush any I/O buffers.
|
|
def | _uploadTextData (self, regions) |
|
def | _close (self) |
|
def | _dot (self, symb, c, r, size, ctype, fontFamily="helvetica", textAngle=None) |
|
def | _drawLines (self, points, ctype) |
|
def | _erase (self) |
|
def | _setCallback (self, what, func) |
|
def | _getEvent (self) |
|
def | _scale (self, algorithm, min, max, unit=None, *args, **kwargs) |
|
def | _setMaskTransparency (self, transparency, maskName) |
|
def | _getMaskTransparency (self, maskName) |
|
def | _setMaskPlaneColor (self, maskName, color) |
|
def | _show (self) |
|
def | _zoom (self, zoomfac) |
|
def | _pan (self, colc, rowc) |
|
|
| _isBuffered |
|
| _regions |
|
| _regionLayerId |
|
| _fireflyFitsID |
|
| _fireflyMaskOnServer |
|
| _client |
|
| _channel |
|
| _url |
|
| _maskIds |
|
| _maskDict |
|
| _maskPlaneColors |
|
| _maskTransparencies |
|
| _lastZoom |
|
| _lastPan |
|
| _lastStretch |
|
| _stretchAlgorithm |
|
| _stretchMin |
|
| _stretchMax |
|
| _stretchUnit |
|
Device to talk to a firefly display
◆ _buffer()
def lsst.display.firefly.firefly.DisplayImpl._buffer |
( |
|
self, |
|
|
|
enable = True |
|
) |
| |
|
protected |
Enable or disable buffering of writes to the display param enable True or False, as appropriate.
◆ _clearImage()
def lsst.display.firefly.firefly.DisplayImpl._clearImage |
( |
|
self | ) |
|
|
protected |
Delete the current image in the Firefly viewer
◆ _close()
def lsst.display.firefly.firefly.DisplayImpl._close |
( |
|
self | ) |
|
|
protected |
Called when the device is closed
◆ _dot()
def lsst.display.firefly.firefly.DisplayImpl._dot |
( |
|
self, |
|
|
|
symb, |
|
|
|
c, |
|
|
|
r, |
|
|
|
size, |
|
|
|
ctype, |
|
|
|
fontFamily = "helvetica" , |
|
|
|
textAngle = None |
|
) |
| |
|
protected |
Draw a symbol onto the specified DS9 frame at (col,row) = (c,r) [0-based coordinates]
Possible values are:
+ Draw a +
x Draw an x
* Draw a *
o Draw a circle
@:Mxx,Mxy,Myy Draw an ellipse with moments (Mxx, Mxy, Myy) (argument size is ignored)
An object derived from afwGeom.ellipses.BaseCore Draw the ellipse (argument size is ignored)
Any other value is interpreted as a string to be drawn. Strings obey the fontFamily (which may be extended
with other characteristics, e.g. "times bold italic". Text will be drawn rotated by textAngle (textAngle
is ignored otherwise).
N.b. objects derived from BaseCore include Axes and Quadrupole.
◆ _drawLines()
def lsst.display.firefly.firefly.DisplayImpl._drawLines |
( |
|
self, |
|
|
|
points, |
|
|
|
ctype |
|
) |
| |
|
protected |
Connect the points, a list of (col,row)
Ctype is the name of a colour (e.g. 'red')
◆ _erase()
def lsst.display.firefly.firefly.DisplayImpl._erase |
( |
|
self | ) |
|
|
protected |
Erase all overlays on the image
◆ _flush()
def lsst.display.firefly.firefly.DisplayImpl._flush |
( |
|
self | ) |
|
|
protected |
◆ _getEvent()
def lsst.display.firefly.firefly.DisplayImpl._getEvent |
( |
|
self | ) |
|
|
protected |
Return an event generated by a keypress or mouse click
◆ _getMaskTransparency()
def lsst.display.firefly.firefly.DisplayImpl._getMaskTransparency |
( |
|
self, |
|
|
|
maskName |
|
) |
| |
|
protected |
Return the current mask's transparency
◆ _mtv()
def lsst.display.firefly.firefly.DisplayImpl._mtv |
( |
|
self, |
|
|
|
image, |
|
|
|
mask = None , |
|
|
|
wcs = None , |
|
|
|
title = "" |
|
) |
| |
|
protected |
Display an Image and/or Mask on a Firefly display
◆ _pan()
def lsst.display.firefly.firefly.DisplayImpl._pan |
( |
|
self, |
|
|
|
colc, |
|
|
|
rowc |
|
) |
| |
|
protected |
Pan to specified pixel coordinates
Parameters:
-----------
colc, rowc : `float`
column and row in units of pixels (zero-based convention,
with the xy0 already subtracted off)
◆ _remove_masks()
def lsst.display.firefly.firefly.DisplayImpl._remove_masks |
( |
|
self | ) |
|
|
protected |
◆ _scale()
def lsst.display.firefly.firefly.DisplayImpl._scale |
( |
|
self, |
|
|
|
algorithm, |
|
|
|
min, |
|
|
|
max, |
|
|
|
unit = None , |
|
|
* |
args, |
|
|
** |
kwargs |
|
) |
| |
|
protected |
Scale the image stretch and limits
Parameters:
-----------
algorithm : `str`
stretch algorithm, e.g. 'linear', 'log', 'loglog', 'equal', 'squared',
'sqrt', 'asinh', powerlaw_gamma'
min : `float` or `str`
lower limit, or 'minmax' for full range, or 'zscale'
max : `float` or `str`
upper limit; overrriden if min is 'minmax' or 'zscale'
unit : `str`
unit for min and max. 'percent', 'absolute', 'sigma'.
if not specified, min and max are presumed to be in 'absolute' units.
*args, **kwargs : additional position and keyword arguments.
The options are shown below:
**Q** : `float`, optional
The asinh softening parameter for asinh stretch.
Use Q=0 for linear stretch, increase Q to make brighter features visible.
When not specified or None, Q is calculated by Firefly to use full color range.
**gamma**
The gamma value for power law gamma stretch (default 2.0)
**zscale_contrast** : `int`, optional
Contrast parameter in percent for zscale algorithm (default 25)
**zscale_samples** : `int`, optional
Number of samples for zscale algorithm (default 600)
**zscale_samples_perline** : `int`, optional
Number of samples per line for zscale algorithm (default 120)
◆ _setMaskPlaneColor()
def lsst.display.firefly.firefly.DisplayImpl._setMaskPlaneColor |
( |
|
self, |
|
|
|
maskName, |
|
|
|
color |
|
) |
| |
|
protected |
◆ _setMaskTransparency()
def lsst.display.firefly.firefly.DisplayImpl._setMaskTransparency |
( |
|
self, |
|
|
|
transparency, |
|
|
|
maskName |
|
) |
| |
|
protected |
Specify mask transparency (percent); or None to not set it when loading masks
◆ _show()
def lsst.display.firefly.firefly.DisplayImpl._show |
( |
|
self | ) |
|
|
protected |
Show the requested window
◆ _zoom()
def lsst.display.firefly.firefly.DisplayImpl._zoom |
( |
|
self, |
|
|
|
zoomfac |
|
) |
| |
|
protected |
Zoom display by specified amount
Parameters:
-----------
zoomfac: `float`
zoom level in screen pixels per image pixel
◆ 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