LSSTApplications
10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
|
Classes | |
class | _Buffering |
Public Member Functions | |
def | __init__ |
Create an object able to display images and overplot glyphs. More... | |
def | __enter__ |
Support for python's with statement. More... | |
def | __exit__ |
Support for python's with statement. More... | |
def | __del__ |
def | close |
def | verbose |
The backend's verbosity. More... | |
def | verbose |
def | __str__ |
def | maskColorGenerator |
A generator for "standard" colours. More... | |
def | setMaskPlaneColor |
Request that mask plane name be displayed as color. More... | |
def | getMaskPlaneColor |
Return the colour associated with the specified mask plane name. More... | |
def | setMaskTransparency |
Specify display's mask transparency (percent); or None to not set it when loading masks. More... | |
def | getMaskTransparency |
Return the current display's mask transparency. More... | |
def | show |
Uniconify and Raise display. More... | |
def | mtv |
Display an Image or Mask on a DISPLAY display. More... | |
def | Buffering |
def | flush |
Flush the buffers. More... | |
def | erase |
Erase the specified DISPLAY frame. More... | |
def | dot |
Draw a symbol onto the specified DISPLAY frame at (col,row) = (c,r) [0-based coordinates]. More... | |
def | line |
Draw a set of symbols or connect the points, a list of (col,row) If symbs is True, draw points at the specified points using the desired symbol, otherwise connect the dots. More... | |
def | scale |
Set the range of the scaling from DN in the image to the image display. More... | |
def | zoom |
Zoom frame by specified amount, optionally panning also. More... | |
def | pan |
Pan to (rowc, colc); see also zoom. More... | |
def | interact |
Enter an interactive loop, listening for key presses in display and firing callbacks. More... | |
def | setCallback |
Set the callback for key k to be func, returning the old callback. More... | |
def | getActiveCallbackKeys |
Return all callback keys. More... | |
Static Public Member Functions | |
def | setDefaultBackend |
def | getDefaultBackend |
def | setDefaultFrame |
def | getDefaultFrame |
def | incrDefaultFrame |
def | setDefaultMaskTransparency |
def | setDefaultMaskPlaneColor |
Set the default mapping from mask plane names to colours. More... | |
def | getDisplay |
Return the Display indexed by frame, creating it if needs be. More... | |
def | delAllDisplays |
Delete and close all known display. More... | |
Public Attributes | |
frame | |
Private Attributes | |
_impl | |
_xy0 | |
_maskPlaneColors | |
_callbacks | |
Static Private Attributes | |
dictionary | _displays = {} |
_defaultBackend = None | |
int | _defaultFrame = 0 |
tuple | _defaultMaskPlaneColor |
dictionary | _defaultMaskTransparency = {} |
Definition at line 87 of file interface.py.
def lsst.afw.display.interface.Display.__init__ | ( | self, | |
frame, | |||
backend = None , |
|||
args, | |||
kwargs | |||
) |
Create an object able to display images and overplot glyphs.
frame | An identifier for the display |
backend | The backend to use (defaults to value set by setDefaultBackend()) |
args | Arguments to pass to the backend |
kwargs | Arguments to pass to the backend |
Definition at line 107 of file interface.py.
def lsst.afw.display.interface.Display.__del__ | ( | self | ) |
Definition at line 162 of file interface.py.
def lsst.afw.display.interface.Display.__enter__ | ( | self | ) |
Support for python's with statement.
Definition at line 154 of file interface.py.
def lsst.afw.display.interface.Display.__exit__ | ( | self, | |
args | |||
) |
Support for python's with statement.
Definition at line 158 of file interface.py.
def lsst.afw.display.interface.Display.__str__ | ( | self | ) |
Definition at line 183 of file interface.py.
def lsst.afw.display.interface.Display.Buffering | ( | self | ) |
Return a class intended to be used with python's with statement E.g. with display.Buffering(): display.dot("+", xc, yc)
Definition at line 400 of file interface.py.
def lsst.afw.display.interface.Display.close | ( | self | ) |
Definition at line 165 of file interface.py.
|
static |
Delete and close all known display.
Definition at line 273 of file interface.py.
def lsst.afw.display.interface.Display.dot | ( | self, | |
symb, | |||
c, | |||
r, | |||
size = 2 , |
|||
ctype = None , |
|||
origin = afwImage.PARENT , |
|||
args, | |||
kwargs | |||
) |
Draw a symbol onto the specified DISPLAY frame at (col,row) = (c,r) [0-based coordinates].
Possible values are:
N.b. objects derived from BaseCore include Axes and Quadrupole.
Definition at line 417 of file interface.py.
def lsst.afw.display.interface.Display.erase | ( | self | ) |
Erase the specified DISPLAY frame.
Definition at line 412 of file interface.py.
def lsst.afw.display.interface.Display.flush | ( | self | ) |
Flush the buffers.
Definition at line 408 of file interface.py.
def lsst.afw.display.interface.Display.getActiveCallbackKeys | ( | self, | |
onlyActive = True |
|||
) |
Return all callback keys.
onlyActive | If true only return keys that do something |
Definition at line 565 of file interface.py.
|
static |
Definition at line 199 of file interface.py.
|
static |
|
static |
Return the Display indexed by frame, creating it if needs be.
frame | The desired frame (None => use defaultFrame (see setDefaultFrame)) |
backend | create the specified frame using this backend (or the default if None) \ if it doesn't already exist. If backend == "", it's an error to specify a non-existent frame |
create | create the display if it doesn't already exist. |
verbose | Allow backend to be chatty |
args | arguments passed to Display constructor |
kwargs | keyword arguments passed to Display constructor |
Definition at line 248 of file interface.py.
def lsst.afw.display.interface.Display.getMaskPlaneColor | ( | self, | |
name | |||
) |
Return the colour associated with the specified mask plane name.
Definition at line 323 of file interface.py.
def lsst.afw.display.interface.Display.getMaskTransparency | ( | self, | |
name = None |
|||
) |
Return the current display's mask transparency.
Definition at line 347 of file interface.py.
|
static |
Increment the default frame for display
Definition at line 213 of file interface.py.
def lsst.afw.display.interface.Display.interact | ( | self | ) |
Enter an interactive loop, listening for key presses in display and firing callbacks.
Exit with q, CR
, or ESC
Definition at line 527 of file interface.py.
def lsst.afw.display.interface.Display.line | ( | self, | |
points, | |||
origin = afwImage.PARENT , |
|||
symbs = False , |
|||
ctype = None , |
|||
size = 0.5 |
|||
) |
Draw a set of symbols or connect the points, a list of (col,row) If symbs is True, draw points at the specified points using the desired symbol, otherwise connect the dots.
Ctype is the name of a colour (e.g. 'red')
If symbs supports indexing (which includes a string – caveat emptor) the elements are used to label the points
Definition at line 455 of file interface.py.
def lsst.afw.display.interface.Display.maskColorGenerator | ( | self, | |
omitBW = True |
|||
) |
A generator for "standard" colours.
omitBW | Don't include Black and White |
e.g. colorGenerator = interface.maskColorGenerator(omitBW=True) for p in planeList: print p, next(colorGenerator)
Definition at line 280 of file interface.py.
def lsst.afw.display.interface.Display.mtv | ( | self, | |
data, | |||
title = "" , |
|||
wcs = None |
|||
) |
Display an Image or Mask on a DISPLAY display.
Historical note: the name "mtv" comes from Jim Gunn's forth imageprocessing system, Mirella (named after Mirella Freni); The "m" stands for Mirella.
Definition at line 356 of file interface.py.
def lsst.afw.display.interface.Display.pan | ( | self, | |
colc = None , |
|||
rowc = None , |
|||
origin = afwImage.PARENT |
|||
) |
Pan to (rowc, colc); see also zoom.
Definition at line 522 of file interface.py.
def lsst.afw.display.interface.Display.scale | ( | self, | |
algorithm, | |||
min, | |||
max = None , |
|||
unit = None , |
|||
args, | |||
kwargs | |||
) |
Set the range of the scaling from DN in the image to the image display.
algorithm | Desired scaling (e.g. "linear" or "asinh") |
min | Minimum value, or "minmax" or "zscale" |
max | Maximum value (must be None for minmax|zscale) |
unit | Units for min and max (e.g. Percent, Absolute, Sigma; None if min==minmax|zscale) |
*args | Optional arguments |
**kwargs | Optional keyword arguments |
Definition at line 483 of file interface.py.
def lsst.afw.display.interface.Display.setCallback | ( | self, | |
k, | |||
func = None , |
|||
noRaise = False |
|||
) |
Set the callback for key k to be func, returning the old callback.
Definition at line 548 of file interface.py.
|
static |
Definition at line 190 of file interface.py.
|
static |
|
static |
Set the default mapping from mask plane names to colours.
name | name of mask plane, or a dict mapping names to colours |
color | Desired color, or None if name is a dict |
If name is None, use the hard-coded default dictionary
Definition at line 226 of file interface.py.
|
static |
Definition at line 219 of file interface.py.
def lsst.afw.display.interface.Display.setMaskPlaneColor | ( | self, | |
name, | |||
color = None |
|||
) |
Request that mask plane name be displayed as color.
name | Name of mask plane or a dictionary of name -> colourName |
color | The name of the colour to use (must be None if name is a dict) |
Colours may be specified as any X11-compliant string (e.g. "orchid"
), or by one of the following constants defined in afwDisplay:
BLACK
, WHITE
, RED
, BLUE
, GREEN
, CYAN
, MAGENTA
, YELLOW
.
The advantage of using the symbolic names is that the python interpreter can detect typos.
Definition at line 301 of file interface.py.
def lsst.afw.display.interface.Display.setMaskTransparency | ( | self, | |
transparency = None , |
|||
name = None |
|||
) |
Specify display's mask transparency (percent); or None to not set it when loading masks.
Definition at line 328 of file interface.py.
def lsst.afw.display.interface.Display.show | ( | self | ) |
Uniconify and Raise display.
N.b. throws an exception if frame doesn't exit
Definition at line 352 of file interface.py.
def lsst.afw.display.interface.Display.verbose | ( | self | ) |
The backend's verbosity.
Definition at line 174 of file interface.py.
def lsst.afw.display.interface.Display.verbose | ( | self, | |
value | |||
) |
Definition at line 179 of file interface.py.
def lsst.afw.display.interface.Display.zoom | ( | self, | |
zoomfac = None , |
|||
colc = None , |
|||
rowc = None , |
|||
origin = afwImage.PARENT |
|||
) |
Zoom frame by specified amount, optionally panning also.
Definition at line 502 of file interface.py.
|
private |
Definition at line 132 of file interface.py.
|
staticprivate |
Definition at line 89 of file interface.py.
|
staticprivate |
Definition at line 90 of file interface.py.
|
staticprivate |
Definition at line 91 of file interface.py.
|
staticprivate |
Definition at line 105 of file interface.py.
|
staticprivate |
Definition at line 88 of file interface.py.
|
private |
Definition at line 125 of file interface.py.
|
private |
Definition at line 129 of file interface.py.
|
private |
Definition at line 127 of file interface.py.
lsst.afw.display.interface.Display.frame |
Definition at line 124 of file interface.py.