|
| __init__ (self, display, verbose=False, *args, **kwargs) |
|
|
| _close (self) |
|
| _setMaskTransparency (self, transparency, maskplane) |
|
| _getMaskTransparency (self, maskplane) |
|
| _show (self) |
|
| _mtv (self, image, mask=None, wcs=None, title="") |
|
| _buffer (self, enable=True) |
|
| _flush (self) |
|
| _erase (self) |
|
| _dot (self, symb, c, r, size, ctype, fontFamily="helvetica", textAngle=None) |
|
| _drawLines (self, points, ctype) |
|
| _scale (self, algorithm, min, max, unit, *args, **kwargs) |
|
| _zoom (self, zoomfac) |
|
| _pan (self, colc, rowc) |
|
| _getEvent (self) |
|
Virtual device display implementation.
Definition at line 344 of file ds9.py.
◆ __init__()
lsst.display.ds9.ds9.DisplayImpl.__init__ |
( |
| self, |
|
|
| display, |
|
|
| verbose = False, |
|
|
* | args, |
|
|
** | kwargs ) |
◆ _buffer()
lsst.display.ds9.ds9.DisplayImpl._buffer |
( |
| self, |
|
|
| enable = True ) |
|
protected |
Push and pop buffer size.
Parameters
----------
enable : `bool`, optional
If `True` (default), push size; else pop it.
Definition at line 464 of file ds9.py.
◆ _close()
lsst.display.ds9.ds9.DisplayImpl._close |
( |
| self | ) |
|
|
protected |
Called when the device is closed.
Definition at line 351 of file ds9.py.
◆ _dot()
lsst.display.ds9.ds9.DisplayImpl._dot |
( |
| self, |
|
|
| symb, |
|
|
| c, |
|
|
| r, |
|
|
| size, |
|
|
| ctype, |
|
|
| fontFamily = "helvetica", |
|
|
| textAngle = None ) |
|
protected |
Draw a symbol onto the specified DS9 frame.
Parameters
----------
symb : `str`, or subclass of `lsst.afw.geom.ellipses.BaseCore`
Symbol to be drawn. 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);(the ``size`` parameter is ignored)
- An object derived from `lsst.afw.geom.ellipses.BaseCore`: Draw
the ellipse (argument size is ignored)
Any other value is interpreted as a string to be drawn.
c : `int`
Column to draw symbol [0-based coordinates].
r : `int`
Row to draw symbol [0-based coordinates].
size : `float`
Size of symbol.
ctype : `str`
the name of a colour (e.g. ``"red"``)
fontFamily : `str`, optional
String font. May be extended with other characteristics,
e.g. ``"times bold italic"``.
textAngle: `float`, optional
Text will be drawn rotated by ``textAngle``.
Notes
-----
Objects derived from `lsst.afw.geom.ellipses.BaseCore` include
`~lsst.afw.geom.ellipses.Axes` and `lsst.afw.geom.ellipses.Quadrupole`.
Definition at line 487 of file ds9.py.
◆ _drawLines()
lsst.display.ds9.ds9.DisplayImpl._drawLines |
( |
| self, |
|
|
| points, |
|
|
| ctype ) |
|
protected |
Connect the points.
Parameters
-----------
points : `list` of (`int`, `int`)
A list of points specified as (col, row).
ctype : `str`
The name of a colour (e.g. ``"red"``).
Definition at line 530 of file ds9.py.
◆ _erase()
lsst.display.ds9.ds9.DisplayImpl._erase |
( |
| self | ) |
|
|
protected |
Erase all regions in current frame.
Definition at line 482 of file ds9.py.
◆ _flush()
lsst.display.ds9.ds9.DisplayImpl._flush |
( |
| self | ) |
|
|
protected |
Flush buffer.
Definition at line 477 of file ds9.py.
◆ _getEvent()
lsst.display.ds9.ds9.DisplayImpl._getEvent |
( |
| self | ) |
|
|
protected |
Listen for a key press on a frame in DS9 and return an event.
Returns
-------
event : `Ds9Event`
Event with (key, x, y).
Definition at line 607 of file ds9.py.
◆ _getMaskTransparency()
lsst.display.ds9.ds9.DisplayImpl._getMaskTransparency |
( |
| self, |
|
|
| maskplane ) |
|
protected |
Return the current DS9's mask transparency.
Parameters
----------
maskplane : unused
This parameter does nothing.
Definition at line 373 of file ds9.py.
◆ _mtv()
lsst.display.ds9.ds9.DisplayImpl._mtv |
( |
| self, |
|
|
| image, |
|
|
| mask = None, |
|
|
| wcs = None, |
|
|
| title = "" ) |
|
protected |
Display an Image and/or Mask on a DS9 display.
Parameters
----------
image : subclass of `lsst.afw.image.Image`
Image to display.
mask : subclass of `lsst.afw.image.Mask`, optional
Mask.
wcs : `lsst.afw.geom.SkyWcs`, optional
WCS of data
title : `str`, optional
Title of image.
Definition at line 393 of file ds9.py.
◆ _pan()
lsst.display.ds9.ds9.DisplayImpl._pan |
( |
| self, |
|
|
| colc, |
|
|
| rowc ) |
|
protected |
Pan frame.
Parameters
----------
colc : `int`
Physical column to which to pan.
rowc : `int`
Physical row to which to pan.
Definition at line 591 of file ds9.py.
◆ _scale()
lsst.display.ds9.ds9.DisplayImpl._scale |
( |
| self, |
|
|
| algorithm, |
|
|
| min, |
|
|
| max, |
|
|
| unit, |
|
|
* | args, |
|
|
** | kwargs ) |
|
protected |
Set image color scale.
Parameters
----------
algorithm : {``"linear"``, ``"log"``, ``"pow"``, ``"sqrt"``, ``"squared"``, ``"asinh"``, ``"sinh"``, ``"histequ"``} # noqa: E501
Scaling algorithm. May be any value supported by DS9.
min : `float`
Minimum value for scale.
max : `float`
Maximum value for scale.
unit : `str`
Ignored.
*args
Ignored.
**kwargs
Ignored
Definition at line 546 of file ds9.py.
◆ _setMaskTransparency()
lsst.display.ds9.ds9.DisplayImpl._setMaskTransparency |
( |
| self, |
|
|
| transparency, |
|
|
| maskplane ) |
|
protected |
Specify DS9's mask transparency.
Parameters
----------
transparency : `int`
Percent transparency.
maskplane : `NoneType`
If `None`, transparency is enabled. Otherwise, this parameter is
ignored.
Definition at line 356 of file ds9.py.
◆ _show()
lsst.display.ds9.ds9.DisplayImpl._show |
( |
| self | ) |
|
|
protected |
Uniconify and raise DS9.
Notes
-----
Raises if ``self.display.frame`` doesn't exist.
Definition at line 384 of file ds9.py.
◆ _zoom()
lsst.display.ds9.ds9.DisplayImpl._zoom |
( |
| self, |
|
|
| zoomfac ) |
|
protected |
Zoom frame by specified amount.
Parameters
----------
zoomfac : `int`
DS9 zoom factor.
Definition at line 578 of file ds9.py.
The documentation for this class was generated from the following file:
- python/lsst/display/ds9/ds9.py