lsst.display.astrowidgets g009b5efdf7+6afbf1a318
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.display.astrowidgets.astrowidgets.DisplayImpl Class Reference
Inheritance diagram for lsst.display.astrowidgets.astrowidgets.DisplayImpl:

Public Member Functions

def __init__ (self, display, dims=None, use_opencv=False, verbose=False, *args, **kwargs)
 
def embed (self)
 
def get_viewer (self)
 
def show_color_bar (self, show=True)
 
def show_pan_mark (self, show=True, color='red')
 
def overlay_mask (self, maskImage, maskDict, maskAlpha)
 
def beginMarking (self, symb='+', ctype='cyan', size=10, label='interactive')
 
def endMarking (self)
 
def getMarkers (self, label='interactive')
 
def clearMarkers (self, label=None)
 
def linkMarkers (self, ctype='brown', label='interactive')
 
def clearLines (self)
 

Public Attributes

 logger
 

Static Public Attributes

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

Detailed Description

Virtual device display implementation.

Parameters
----------
display : `lsst.afw.display.virtualDevice.DisplayImpl`
    Display object to connect to.
dims : `tuple` [`int`, `int`], optional
    Dimensions of the viewer window.
use_opencv : `bool`, optional
    Should openCV be used to speed drawing?
verbose : `bool`, optional
    Increase log verbosity?

Definition at line 81 of file astrowidgets.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 97 of file astrowidgets.py.

Member Function Documentation

◆ beginMarking()

def lsst.display.astrowidgets.astrowidgets.DisplayImpl.beginMarking (   self,
  symb = '+',
  ctype = 'cyan',
  size = 10,
  label = 'interactive' 
)
Begin interactive mark adding.

Parameters
----------
symb : `str`, optional
    Symbol to use.  Should be one of '+', 'x', '*', 'o', '.'.
ctype : `str`, optional
    Color of markers.
size : `float`, optional
    Size of marker.
label : `str`
    Label to store this marker in the internal list.

Definition at line 351 of file astrowidgets.py.

◆ clearLines()

def lsst.display.astrowidgets.astrowidgets.DisplayImpl.clearLines (   self)
Remove all lines from the display.

Definition at line 421 of file astrowidgets.py.

◆ clearMarkers()

def lsst.display.astrowidgets.astrowidgets.DisplayImpl.clearMarkers (   self,
  label = None 
)
Clear markers.

Parameters
----------
label : `str`, optional
    Marker label to clear.  If None, all markers are cleared.

Definition at line 387 of file astrowidgets.py.

◆ embed()

def lsst.display.astrowidgets.astrowidgets.DisplayImpl.embed (   self)
Attach this display to the output of the current cell.

Definition at line 122 of file astrowidgets.py.

◆ endMarking()

def lsst.display.astrowidgets.astrowidgets.DisplayImpl.endMarking (   self)
End interactive mark adding.

Definition at line 368 of file astrowidgets.py.

◆ get_viewer()

def lsst.display.astrowidgets.astrowidgets.DisplayImpl.get_viewer (   self)
Return the ginga viewer

Definition at line 126 of file astrowidgets.py.

◆ getMarkers()

def lsst.display.astrowidgets.astrowidgets.DisplayImpl.getMarkers (   self,
  label = 'interactive' 
)
Get list of markers.

Parameters
----------
label : `str`, optional
    Marker label to return.

Returns
-------
table : `astropy.table.Table`
    Table of markers with the given label.

Definition at line 372 of file astrowidgets.py.

◆ linkMarkers()

def lsst.display.astrowidgets.astrowidgets.DisplayImpl.linkMarkers (   self,
  ctype = 'brown',
  label = 'interactive' 
)
Connect markers with lines.

Parameters
----------
ctype : `str`, optional
    Color to draw the lines.
label : `str`, optional
    Marker label to connect.  Lines are drawn in the order
    found in the table.

Definition at line 400 of file astrowidgets.py.

◆ overlay_mask()

def lsst.display.astrowidgets.astrowidgets.DisplayImpl.overlay_mask (   self,
  maskImage,
  maskDict,
  maskAlpha 
)
Draw mask onto the image display.

Parameters
----------
maskImage : `lsst.afw.image.Mask`
    Mask to display.
maskDict : `dict` [`str`, `str`]
    Dictionary of mask plane names to colors.
maskAlpha : `float`
    Transparency to display the mask.

Definition at line 231 of file astrowidgets.py.

◆ show_color_bar()

def lsst.display.astrowidgets.astrowidgets.DisplayImpl.show_color_bar (   self,
  show = True 
)
Show (or hide) the colour bar.

Parameters
----------
show : `bool`, optional
    Should the color bar be shown?

Definition at line 130 of file astrowidgets.py.

◆ show_pan_mark()

def lsst.display.astrowidgets.astrowidgets.DisplayImpl.show_pan_mark (   self,
  show = True,
  color = 'red' 
)
Show (or hide) the pan mark.

Parameters
----------
show : `bool`, optional
    Should the pan marker be shown?
color : `str`, optional
    What color should the pan mark be?

Definition at line 140 of file astrowidgets.py.

Member Data Documentation

◆ logger

lsst.display.astrowidgets.astrowidgets.DisplayImpl.logger

Definition at line 104 of file astrowidgets.py.

◆ markerDict

dictionary lsst.display.astrowidgets.astrowidgets.DisplayImpl.markerDict = {'+': 'plus', 'x': 'cross', '.': 'circle', '*': 'circle', 'o': 'circle'}
static

Definition at line 95 of file astrowidgets.py.


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