lsst.display.ds9
The lsst.display.ds9 module provides an SAOImage DS9 backend for the lsst.afw.display module.
Python API reference
lsst.display.ds9 Package
Functions
ds9Cmd([cmd, trap, flush, silent, frame, get])
  | 
Issue a DS9 command, raising errors as appropriate.  | 
ds9Version()
  | 
Get the version of DS9 in use.  | 
get(xpa, xtemplate, paramList, mode)
  | 
 | 
getXpaAccessPoint()
  | 
Parse XPA_PORT if set and return an identifier to send DS9 commands.  | 
initDS9([execDs9])
  | 
Initialize DS9.  | 
reset()
  | 
 | 
selectFrame(frame)
  | 
Convert integer frame number to DS9 command syntax.  | 
set(xpa, xtemplate, paramList, mode, buf[, len])
  | 
 | 
setFd1(xpa, xtemplate, paramList, mode, fd)
  | 
 | 
Classes
Buffer([size])
  | 
Buffer to control sending commands to DS9.  | 
DisplayImpl(display[, verbose])
  | 
Virtual device display implementation.  | 
Ds9Error
  | 
Represents an error communicating with DS9.  | 
Ds9Event(k, x, y)
  | 
An event generated by a mouse or key click on the display.  | 
xparec
  | 
 | 
Class Inheritance Diagram
digraph inheritance23bd3d18bb {
bgcolor=transparent;
rankdir=LR;
size="8.0, 12.0";
  "Buffer" [URL="../../../py-api/lsst.display.ds9.Buffer.html#lsst.display.ds9.Buffer",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Buffer to control sending commands to DS9."];
  "DisplayImpl" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Back-end for display objects."];
  "DisplayImpl" [URL="../../../py-api/lsst.display.ds9.DisplayImpl.html#lsst.display.ds9.DisplayImpl",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Virtual device display implementation."];
  "DisplayImpl" -> "DisplayImpl" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "Ds9Error" [URL="../../../py-api/lsst.display.ds9.Ds9Error.html#lsst.display.ds9.Ds9Error",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents an error communicating with DS9."];
  "Ds9Event" [URL="../../../py-api/lsst.display.ds9.Ds9Event.html#lsst.display.ds9.Ds9Event",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An event generated by a mouse or key click on the display."];
  "Event" -> "Ds9Event" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "Event" [URL="../../../py-api/lsst.afw.display.Event.html#lsst.afw.display.Event",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to handle events such as key presses in image display windows"];
  "pybind11_object" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
  "xparec" [URL="../../../py-api/lsst.display.ds9.xparec.html#lsst.display.ds9.xparec",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"];
  "pybind11_object" -> "xparec" [arrowsize=0.5,style="setlinewidth(0.5)"];
}