DisplayImpl

class lsst.display.astrowidgets.DisplayImpl(display, dims=None, use_opencv=False, verbose=False, *args, **kwargs)

Bases: DisplayImpl

Virtual device display implementation.

Parameters:

displaylsst.afw.display.virtualDevice.DisplayImpl

Display object to connect to.

dimstuple [int, int], optional

Dimensions of the viewer window.

use_opencvbool, optional

Should openCV be used to speed drawing?

verbosebool, optional

Increase log verbosity?

Attributes Summary

markerDict

Methods Summary

beginMarking([symb, ctype, size, label])	Begin interactive mark adding.
clearLines()	Remove all lines from the display.
clearMarkers([label])	Clear markers.
embed()	Attach this display to the output of the current cell.
endMarking()	End interactive mark adding.
getMarkers([label])	Get list of markers.
get_viewer()	Return the ginga viewer
linkMarkers([ctype, label])	Connect markers with lines.
overlay_mask(maskImage, maskDict, maskAlpha)	Draw mask onto the image display.
show_color_bar([show])	Show (or hide) the colour bar.
show_pan_mark([show, color])	Show (or hide) the pan mark.

Attributes Documentation

markerDict = {'*': 'circle', '+': 'plus', '.': 'circle', 'o': 'circle', 'x': 'cross'}

Methods Documentation

beginMarking(symb='+', ctype='cyan', size=10, label='interactive')

Begin interactive mark adding.

Parameters:

symbstr, optional

Symbol to use. Should be one of ‘+’, ‘x’, ‘*’, ‘o’, ‘.’.

ctypestr, optional

Color of markers.

sizefloat, optional

Size of marker.

labelstr

Label to store this marker in the internal list.

clearLines()

Remove all lines from the display.

clearMarkers(label=None)

Clear markers.

Parameters:

labelstr, optional

Marker label to clear. If None, all markers are cleared.

embed()

Attach this display to the output of the current cell.

endMarking()

End interactive mark adding.

getMarkers(label='interactive')

Get list of markers.

Parameters:

labelstr, optional

Marker label to return.

Returns:

tableastropy.table.Table

Table of markers with the given label.

get_viewer()

Return the ginga viewer

linkMarkers(ctype='brown', label='interactive')

Connect markers with lines.

Parameters:

ctypestr, optional

Color to draw the lines.

labelstr, optional

Marker label to connect. Lines are drawn in the order found in the table.

overlay_mask(maskImage, maskDict, maskAlpha)

Draw mask onto the image display.

Parameters:

maskImagelsst.afw.image.Mask

Mask to display.

maskDictdict [str, str]

Dictionary of mask plane names to colors.

maskAlphafloat

Transparency to display the mask.

show_color_bar(show=True)

Show (or hide) the colour bar.

Parameters:

showbool, optional

Should the color bar be shown?

show_pan_mark(show=True, color='red')

Show (or hide) the pan mark.

Parameters:

showbool, optional

Should the pan marker be shown?

colorstr, optional

What color should the pan mark be?