The lsst.display.ds9 module provides an SAOImage DS9 backend for the lsst.afw.display module.


lsst.display.ds9 is developed at You can find Jira issues for this module under the display_ds9 component.

Python API reference

lsst.display.ds9 Package


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.
selectFrame(frame) Convert integer frame number to DS9 command syntax.
set(xpa, xtemplate, paramList, mode, buf, len)
setFd1(xpa, xtemplate, paramList, mode, fd)


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.

Class Inheritance Diagram

Inheritance diagram of lsst.display.ds9.ds9.Buffer, lsst.display.ds9.ds9.DisplayImpl, lsst.display.ds9.ds9.Ds9Error, lsst.display.ds9.ds9.Ds9Event, lsst.display.ds9.xpa.xparec