lsst.display.firefly.firefly.DisplayImpl Class Reference

Inheritance diagram for lsst.display.firefly.firefly.DisplayImpl:

Public Member Functions
	__init__ (self, display, verbose=False, url=None, name=None, *args, **kwargs)
	getClient (self)
	clearViewer (self)
	resetLayout (self)
	overlayFootprints (self, catalog, color='rgba(74, 144, 226, 0.60)', highlightColor='cyan', selectColor='orange', style='fill', layerString='detection footprints ', titleString='catalog footprints ')

Public Attributes
	frame

Protected Member Functions
	_getRegionLayerId (self)
	_clearImage (self)
	_mtv (self, image, mask=None, wcs=None, title="")
	_remove_masks (self)
	_buffer (self, enable=True)
	Enable or disable buffering of writes to the display param enable True or False, as appropriate.
	_flush (self)
	Flush any I/O buffers.
	_uploadTextData (self, regions)
	_close (self)
	_dot (self, symb, c, r, size, ctype, fontFamily="helvetica", textAngle=None)
	_drawLines (self, points, ctype)
	_erase (self)
	_setCallback (self, what, func)
	_getEvent (self)
	_scale (self, algorithm, min, max, unit=None, *args, **kwargs)
	_setMaskTransparency (self, transparency, maskName)
	_getMaskTransparency (self, maskName)
	_setMaskPlaneColor (self, maskName, color)
	_show (self)
	_zoom (self, zoomfac)
	_pan (self, colc, rowc)

Protected Attributes
	_isBuffered
	_regions
	_regionLayerId
	_fireflyFitsID
	_fireflyMaskOnServer
	_client
	_channel
	_url
	_maskIds
	_maskDict
	_maskPlaneColors
	_maskTransparencies
	_lastZoom
	_lastPan
	_lastStretch
	_stretchAlgorithm
	_stretchMin
	_stretchMax
	_stretchUnit

Detailed Description

Device to talk to a firefly display

Definition at line 55 of file firefly.py.

Constructor & Destructor Documentation

__init__()

lsst.display.firefly.firefly.DisplayImpl.__init__	(		self,
			display,
			verbose = False,
			url = None,
			name = None,
		*	args,
		**	kwargs )

Definition at line 75 of file firefly.py.

                 name=None, *args, **kwargs):
        virtualDevice.DisplayImpl.__init__(self, display, verbose)
 
        if self.verbose:
            print("Opening firefly device %s" % (self.display.frame if self.display else "[None]"))
 
        global _fireflyClient
        if not _fireflyClient:
            import os
            start_tab = None
            html_file = kwargs.get('html_file',
                                   os.environ.get('FIREFLY_HTML', 'slate.html'))
            if url is None:
                if (('fireflyLabExtension' in os.environ) and
                        ('fireflyURLLab' in os.environ)):
                    url = os.environ['fireflyURLLab']
                    start_tab = kwargs.get('start_tab', True)
                    start_browser_tab = kwargs.get('start_browser_tab', False)
                    if (name is None) and ('fireflyChannelLab' in os.environ):
                        name = os.environ['fireflyChannelLab']
                elif 'FIREFLY_URL' in os.environ:
                    url = os.environ['FIREFLY_URL']
                else:
                    raise RuntimeError('Cannot determine url from environment; you must pass url')
 
            token = kwargs.get('token',
                               os.environ.get('ACCESS_TOKEN', None))
 
            try:
                if start_tab:
                    if verbose:
                        print('Starting Jupyterlab client')
                    _fireflyClient = firefly_client.FireflyClient.make_lab_client(
                        start_tab=True, start_browser_tab=start_browser_tab,
                        html_file=kwargs.get('html_file'), verbose=verbose,
                        token=token)
 
                else:
                    if verbose:
                        print('Starting vanilla client')
                    _fireflyClient = firefly_client.FireflyClient.make_client(
                        url=url, html_file=html_file, launch_browser=True,
                        channel_override=name, verbose=verbose,
                        token=token)
 
            except (HandshakeError, gaierror) as e:
                raise RuntimeError("Unable to connect to %s: %s" % (url or '', e))
 
            try:
                _fireflyClient.add_listener(self.__handleCallbacks)
            except Exception as e:
                raise RuntimeError("Cannot add listener. Browser must be connected" +
                                   "to %s: %s" %
                                   (_fireflyClient.get_firefly_url(), e))
 
        self._isBuffered = False
        self._regions = []
        self._regionLayerId = self._getRegionLayerId()
        self._fireflyFitsID = None
        self._fireflyMaskOnServer = None
        self._client = _fireflyClient
        self._channel = _fireflyClient.channel
        self._url = _fireflyClient.get_firefly_url()
        self._maskIds = []
        self._maskDict = {}
        self._maskPlaneColors = {}
        self._maskTransparencies = {}
        self._lastZoom = None
        self._lastPan = None
        self._lastStretch = None
 

Member Function Documentation

_buffer()

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.

Definition at line 235 of file firefly.py.

    def _buffer(self, enable=True):
        """!Enable or disable buffering of writes to the display
        param enable  True or False, as appropriate
        """
        self._isBuffered = enable
 

_clearImage()

lsst.display.firefly.firefly.DisplayImpl._clearImage ( self )

protected

Delete the current image in the Firefly viewer

Definition at line 150 of file firefly.py.

    def _clearImage(self):
        """Delete the current image in the Firefly viewer
        """
        self._client.dispatch(action_type='ImagePlotCntlr.deletePlotView',
                              payload=dict(plotId=str(self.display.frame)))
 

_close()

lsst.display.firefly.firefly.DisplayImpl._close ( self )

protected

Called when the device is closed

Definition at line 262 of file firefly.py.

    def _close(self):
        """Called when the device is closed"""
        if self.verbose:
            print("Closing firefly device %s" % (self.display.frame if self.display else "[None]"))
        if _fireflyClient is not None:
            _fireflyClient.disconnect()
            _fireflyClient.session.close()
 

_dot()

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.

Definition at line 270 of file firefly.py.

    def _dot(self, symb, c, r, size, ctype, fontFamily="helvetica", textAngle=None):
        """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.
    """
        self._uploadTextData(ds9Regions.dot(symb, c, r, size, ctype, fontFamily, textAngle))
 

_drawLines()

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

Definition at line 287 of file firefly.py.

    def _drawLines(self, points, ctype):
        """Connect the points, a list of (col,row)
        Ctype is the name of a colour (e.g. 'red')"""
 
        self._uploadTextData(ds9Regions.drawLines(points, ctype))
 

_erase()

lsst.display.firefly.firefly.DisplayImpl._erase ( self )

protected

Erase all overlays on the image

Definition at line 293 of file firefly.py.

    def _erase(self):
        """Erase all overlays on the image"""
        if self.verbose:
            print('region layer id is {}'.format(self._regionLayerId))
        if self._regionLayerId:
            _fireflyClient.delete_region_layer(self._regionLayerId, plot_id=str(self.display.frame))
 

_flush()

lsst.display.firefly.firefly.DisplayImpl._flush ( self )

protected

Flush any I/O buffers.

Definition at line 241 of file firefly.py.

    def _flush(self):
        """!Flush any I/O buffers
        """
        if not self._regions:
            return
 
        if self.verbose:
            print("Flushing %d regions" % len(self._regions))
            print(self._regions)
 
        self._regionLayerId = self._getRegionLayerId()
        _fireflyClient.add_region_data(region_data=self._regions, plot_id=str(self.display.frame),
                                       region_layer_id=self._regionLayerId)
        self._regions = []
 

_getEvent()

lsst.display.firefly.firefly.DisplayImpl._getEvent ( self )

protected

Return an event generated by a keypress or mouse click

Definition at line 314 of file firefly.py.

    def _getEvent(self):
        """Return an event generated by a keypress or mouse click
        """
        ev = interface.Event("q")
 
        if self.verbose:
            print("virtual[%s]._getEvent() -> %s" % (self.display.frame, ev))
 
        return ev

_getMaskTransparency()

lsst.display.firefly.firefly.DisplayImpl._getMaskTransparency ( self, maskName )

protected

Return the current mask's transparency

Definition at line 447 of file firefly.py.

    def _getMaskTransparency(self, maskName):
        """Return the current mask's transparency"""
        transparency = None
        if maskName in self._maskTransparencies:
            transparency = self._maskTransparencies[maskName]
        return transparency
 

_getRegionLayerId()

lsst.display.firefly.firefly.DisplayImpl._getRegionLayerId ( self )

protected

Definition at line 147 of file firefly.py.

    def _getRegionLayerId(self):
        return "lsstRegions%s" % self.display.frame if self.display else "None"
 

_mtv()

lsst.display.firefly.firefly.DisplayImpl._mtv ( self, image, mask = None, wcs = None, title = "" )

protected

Display an Image and/or Mask on a Firefly display

Definition at line 156 of file firefly.py.

    def _mtv(self, image, mask=None, wcs=None, title=""):
        """Display an Image and/or Mask on a Firefly display
        """
        if title == "":
            title = str(self.display.frame)
        if image:
            if self.verbose:
                print('displaying image')
            self._erase()
 
            with tempfile.NamedTemporaryFile() as fd:
                afwDisplay.writeFitsImage(fd.name, image, wcs, title)
                fd.flush()
                fd.seek(0, 0)
                self._fireflyFitsID = _fireflyClient.upload_data(fd, 'FITS')
 
            try:
                viewer_id = ('image-' + str(_fireflyClient.render_tree_id) + '-' +
                             str(self.frame))
            except AttributeError:
                viewer_id = 'image-' + str(self.frame)
            extraParams = dict(Title=title,
                               MultiImageIdx=0,
                               PredefinedOverlayIds=' ',
                               viewer_id=viewer_id)
            # Firefly's Javascript API requires a space for parameters;
            # otherwise the parameter will be ignored
 
            if self._lastZoom:
                extraParams['InitZoomLevel'] = self._lastZoom
                extraParams['ZoomType'] = 'LEVEL'
            if self._lastPan:
                extraParams['InitialCenterPosition'] = '{0:.3f};{1:.3f};PIXEL'.format(
                    self._lastPan[0], self._lastPan[1])
            if self._lastStretch:
                extraParams['RangeValues'] = self._lastStretch
 
            ret = _fireflyClient.show_fits(self._fireflyFitsID, plot_id=str(self.display.frame),
                                           **extraParams)
 
            if not ret["success"]:
                raise RuntimeError("Display of image failed")
 
        if mask:
            if self.verbose:
                print('displaying mask')
            with tempfile.NamedTemporaryFile() as fdm:
                afwDisplay.writeFitsImage(fdm.name, mask, wcs, title)
                fdm.flush()
                fdm.seek(0, 0)
                self._fireflyMaskOnServer = _fireflyClient.upload_data(fdm, 'FITS')
 
            maskPlaneDict = mask.getMaskPlaneDict()
            for k, v in maskPlaneDict.items():
                self._maskDict[k] = v
                self._maskPlaneColors[k] = self.display.getMaskPlaneColor(k)
            usedPlanes = int(afwMath.makeStatistics(mask, afwMath.SUM).getValue())
            for k in self._maskDict:
                if (((1 << self._maskDict[k]) & usedPlanes) and
                        (k in self._maskPlaneColors) and
                        (self._maskPlaneColors[k] is not None) and
                        (self._maskPlaneColors[k].lower() != 'ignore')):
                    _fireflyClient.add_mask(bit_number=self._maskDict[k],
                                            image_number=0,
                                            plot_id=str(self.display.frame),
                                            mask_id=k,
                                            title=k + ' - bit %d'%self._maskDict[k],
                                            color=self._maskPlaneColors[k],
                                            file_on_server=self._fireflyMaskOnServer)
                    if k in self._maskTransparencies:
                        self._setMaskTransparency(self._maskTransparencies[k], k)
                    self._maskIds.append(k)
 

_pan()

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)

Definition at line 493 of file firefly.py.

    def _pan(self, colc, rowc):
        """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)
        """
        self._lastPan = [colc+0.5, rowc+0.5]  # saved for future use in _mtv
        # Firefly's internal convention is first pixel is (0.5, 0.5)
        _fireflyClient.set_pan(plot_id=str(self.display.frame), x=colc, y=rowc)
 

_remove_masks()

lsst.display.firefly.firefly.DisplayImpl._remove_masks ( self )

protected

Remove mask layers

Definition at line 229 of file firefly.py.

    def _remove_masks(self):
        """Remove mask layers"""
        for k in self._maskIds:
            _fireflyClient.remove_mask(plot_id=str(self.display.frame), mask_id=k)
        self._maskIds = []
 

_scale()

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)

Definition at line 327 of file firefly.py.

    def _scale(self, algorithm, min, max, unit=None, *args, **kwargs):
        """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)
        """
        stretch_algorithms = ('linear', 'log', 'loglog', 'equal', 'squared', 'sqrt',
                              'asinh', 'powerlaw_gamma')
        interval_methods = ('percent', 'maxmin', 'absolute', 'zscale', 'sigma')
        #
        #
        # Normalise algorithm's case
        #
        if algorithm:
            algorithm = dict((a.lower(), a) for a in stretch_algorithms).get(algorithm.lower(), algorithm)
 
            if algorithm not in stretch_algorithms:
                raise FireflyError('Algorithm %s is invalid; please choose one of "%s"' %
                                   (algorithm, '", "'.join(stretch_algorithms)))
            self._stretchAlgorithm = algorithm
        else:
            algorithm = 'linear'
 
        # Translate parameters for asinh and powerlaw_gamma stretches
        if 'Q' in kwargs:
            kwargs['asinh_q_value'] = kwargs['Q']
            del kwargs['Q']
 
        if 'gamma' in kwargs:
            kwargs['gamma_value'] = kwargs['gamma']
            del kwargs['gamma']
 
        if min == 'minmax':
            interval_type = 'percent'
            unit = 'percent'
            min, max = 0, 100
        elif min == 'zscale':
            interval_type = 'zscale'
        else:
            interval_type = None
 
        if not unit:
            unit = 'absolute'
 
        units = ('percent', 'absolute', 'sigma')
        if unit not in units:
            raise FireflyError('Unit %s is invalid; please choose one of "%s"' % (unit, '", "'.join(units)))
 
        if unit == 'sigma':
            interval_type = 'sigma'
        elif unit == 'absolute' and interval_type is None:
            interval_type = 'absolute'
        elif unit == 'percent':
            interval_type = 'percent'
 
        self._stretchMin = min
        self._stretchMax = max
        self._stretchUnit = unit
 
        if interval_type not in interval_methods:
            raise FireflyError('Interval method %s is invalid' % interval_type)
 
        rval = {}
        if interval_type != 'zscale':
            rval = _fireflyClient.set_stretch(str(self.display.frame), stype=interval_type,
                                              algorithm=algorithm, lower_value=min,
                                              upper_value=max, **kwargs)
        else:
            if 'zscale_contrast' not in kwargs:
                kwargs['zscale_contrast'] = 25
            if 'zscale_samples' not in kwargs:
                kwargs['zscale_samples'] = 600
            if 'zscale_samples_perline' not in kwargs:
                kwargs['zscale_samples_perline'] = 120
            rval = _fireflyClient.set_stretch(str(self.display.frame), stype='zscale',
                                              algorithm=algorithm, **kwargs)
 
        if 'rv_string' in rval:
            self._lastStretch = rval['rv_string']
 

_setCallback()

lsst.display.firefly.firefly.DisplayImpl._setCallback ( self, what, func )

protected

Definition at line 300 of file firefly.py.

    def _setCallback(self, what, func):
        if func != interface.noop_callback:
            try:
                status = _fireflyClient.add_extension('POINT' if False else 'AREA_SELECT', title=what,
                                                      plot_id=str(self.display.frame),
                                                      extension_id=what)
                if not status['success']:
                    pass
            except Exception as e:
                raise RuntimeError("Cannot set callback. Browser must be (re)opened " +
                                   "to %s%s : %s" %
                                   (_fireflyClient.url_bw,
                                    _fireflyClient.channel, e))
 

_setMaskPlaneColor()

lsst.display.firefly.firefly.DisplayImpl._setMaskPlaneColor ( self, maskName, color )

protected

Specify mask color 

Definition at line 454 of file firefly.py.

    def _setMaskPlaneColor(self, maskName, color):
        """Specify mask color """
        _fireflyClient.remove_mask(plot_id=str(self.display.frame),
                                   mask_id=maskName)
        self._maskPlaneColors[maskName] = color
        if (color.lower() != 'ignore'):
            _fireflyClient.add_mask(bit_number=self._maskDict[maskName],
                                    image_number=1,
                                    plot_id=str(self.display.frame),
                                    mask_id=maskName,
                                    color=self.display.getMaskPlaneColor(maskName),
                                    file_on_server=self._fireflyFitsID)
 

_setMaskTransparency()

lsst.display.firefly.firefly.DisplayImpl._setMaskTransparency ( self, transparency, maskName )

protected

Specify mask transparency (percent); or None to not set it when loading masks

Definition at line 433 of file firefly.py.

    def _setMaskTransparency(self, transparency, maskName):
        """Specify mask transparency (percent); or None to not set it when loading masks"""
        if maskName is not None:
            masklist = [maskName]
        else:
            masklist = set(self._maskIds + list(self.display._defaultMaskPlaneColor.keys()))
        for k in masklist:
            self._maskTransparencies[k] = transparency
            _fireflyClient.dispatch(action_type='ImagePlotCntlr.overlayPlotChangeAttributes',
                                    payload={'plotId': str(self.display.frame),
                                             'imageOverlayId': k,
                                             'attributes': {'opacity': 1.0 - transparency/100.},
                                             'doReplot': False})
 

_show()

lsst.display.firefly.firefly.DisplayImpl._show ( self )

protected

Show the requested window

Definition at line 467 of file firefly.py.

    def _show(self):
        """Show the requested window"""
        if self._client.render_tree_id is not None:
            # we are using Jupyterlab
            self._client.dispatch(self._client.ACTION_DICT['StartLabWindow'],
                                  {})
        else:
            localbrowser, url = _fireflyClient.launch_browser(verbose=self.verbose)
            if not localbrowser and not self.verbose:
                _fireflyClient.display_url()
 

_uploadTextData()

lsst.display.firefly.firefly.DisplayImpl._uploadTextData ( self, regions )

protected

Definition at line 256 of file firefly.py.

    def _uploadTextData(self, regions):
        self._regions += regions
 
        if not self._isBuffered:
            self._flush()
 

_zoom()

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

Definition at line 482 of file firefly.py.

    def _zoom(self, zoomfac):
        """Zoom display by specified amount
 
        Parameters:
        -----------
        zoomfac: `float`
            zoom level in screen pixels per image pixel
        """
        self._lastZoom = zoomfac
        _fireflyClient.set_zoom(plot_id=str(self.display.frame), factor=zoomfac)
 

clearViewer()

lsst.display.firefly.firefly.DisplayImpl.clearViewer

(

self

)

Reinitialize the viewer

Definition at line 518 of file firefly.py.

    def clearViewer(self):
        """Reinitialize the viewer
        """
        self._client.reinit_viewer()
 

getClient()

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

Definition at line 508 of file firefly.py.

    def getClient(self):
        """Get the instance of FireflyClient for this display
 
        Returns:
        --------
        `firefly_client.FireflyClient`
            Instance of FireflyClient used by this display
        """
        return self._client
 

overlayFootprints()

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

Definition at line 550 of file firefly.py.

                          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
        """
        footprintTable = createFootprintsTable(catalog)
        with BytesIO() as fd:
            footprintTable.to_xml(fd)
            tableval = self._client.upload_data(fd, 'UNKNOWN')
        self._client.overlay_footprints(footprint_file=tableval,
                                        title=titleString + str(self.display.frame),
                                        footprint_layer_id=layerString + str(self.display.frame),
                                        plot_id=str(self.display.frame),
                                        color=color,
                                        highlightColor=highlightColor,
                                        selectColor=selectColor,
                                        style=style)

resetLayout()

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

Definition at line 523 of file firefly.py.

    def 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
        """
        self.clearViewer()
        try:
            tables_cell_id = 'tables-' + str(_fireflyClient.render_tree_id)
        except AttributeError:
            tables_cell_id = 'tables'
        self._client.add_cell(row=2, col=0, width=4, height=2, element_type='tables',
                              cell_id=tables_cell_id)
        try:
            image_cell_id = ('image-' + str(_fireflyClient.render_tree_id) + '-' +
                             str(self.frame))
        except AttributeError:
            image_cell_id = 'image-' + str(self.frame)
        self._client.add_cell(row=0, col=0, width=2, height=3, element_type='images',
                              cell_id=image_cell_id)
        try:
            plots_cell_id = 'plots-' + str(_fireflyClient.render_tree_id)
        except AttributeError:
            plots_cell_id = 'plots'
        self._client.add_cell(row=0, col=2, width=2, height=3, element_type='xyPlots',
                              cell_id=plots_cell_id)
 

Member Data Documentation

_channel

lsst.display.firefly.firefly.DisplayImpl._channel

protected

Definition at line 137 of file firefly.py.

_client

lsst.display.firefly.firefly.DisplayImpl._client

protected

Definition at line 136 of file firefly.py.

_fireflyFitsID

lsst.display.firefly.firefly.DisplayImpl._fireflyFitsID

protected

Definition at line 134 of file firefly.py.

_fireflyMaskOnServer

lsst.display.firefly.firefly.DisplayImpl._fireflyMaskOnServer

protected

Definition at line 135 of file firefly.py.

_isBuffered

lsst.display.firefly.firefly.DisplayImpl._isBuffered

protected

Definition at line 131 of file firefly.py.

_lastPan

lsst.display.firefly.firefly.DisplayImpl._lastPan

protected

Definition at line 144 of file firefly.py.

_lastStretch

lsst.display.firefly.firefly.DisplayImpl._lastStretch

protected

Definition at line 145 of file firefly.py.

_lastZoom

lsst.display.firefly.firefly.DisplayImpl._lastZoom

protected

Definition at line 143 of file firefly.py.

_maskDict

lsst.display.firefly.firefly.DisplayImpl._maskDict

protected

Definition at line 140 of file firefly.py.

_maskIds

lsst.display.firefly.firefly.DisplayImpl._maskIds

protected

Definition at line 139 of file firefly.py.

_maskPlaneColors

lsst.display.firefly.firefly.DisplayImpl._maskPlaneColors

protected

Definition at line 141 of file firefly.py.

_maskTransparencies

lsst.display.firefly.firefly.DisplayImpl._maskTransparencies

protected

Definition at line 142 of file firefly.py.

_regionLayerId

lsst.display.firefly.firefly.DisplayImpl._regionLayerId

protected

Definition at line 133 of file firefly.py.

_regions

lsst.display.firefly.firefly.DisplayImpl._regions

protected

Definition at line 132 of file firefly.py.

_stretchAlgorithm

lsst.display.firefly.firefly.DisplayImpl._stretchAlgorithm

protected

Definition at line 372 of file firefly.py.

_stretchMax

lsst.display.firefly.firefly.DisplayImpl._stretchMax

protected

Definition at line 409 of file firefly.py.

_stretchMin

lsst.display.firefly.firefly.DisplayImpl._stretchMin

protected

Definition at line 408 of file firefly.py.

_stretchUnit

lsst.display.firefly.firefly.DisplayImpl._stretchUnit

protected

Definition at line 410 of file firefly.py.

_url

lsst.display.firefly.firefly.DisplayImpl._url

protected

Definition at line 138 of file firefly.py.

frame

lsst.display.firefly.firefly.DisplayImpl.frame

Definition at line 174 of file firefly.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/display_firefly/gb6a65358fc+0e5473021a/python/lsst/display/firefly/firefly.py