Classes
class	Buffer

class	DisplayImpl

class	Ds9Error

class	Ds9Event

Functions
	getXpaAccessPoint ()

	ds9Version ()

	selectFrame (frame)

	ds9Cmd (cmd=None, trap=True, flush=False, silent=True, frame=None, get=False)

	initDS9 (execDs9=True)

	_i_mtv (data, wcs, title, isMask, metadata)

Variables
	file

bool	needShow = True

	_maskTransparency = None

int	XPA_SZ_LINE = 4096 - 100

	cmdBuffer

	haveGzip = not os.system("gzip < /dev/null > /dev/null 2>&1")

Function Documentation

◆ _i_mtv()

lsst.display.ds9.ds9._i_mtv	(	data,
		wcs,
		title,
		isMask,
		metadata )

protected

Internal routine to display an image or a mask on a DS9 display.

Parameters
----------
data : Subclass of `lsst.afw.image.Image` or `lsst.afw.image.Mask`
    Data to display.
wcs : `lsst.afw.geom.SkyWcs`
    WCS of data.
title : `str`
    Title of display.
isMask : `bool`
    Is ``data`` a mask?
metadata : `lsst.daf.base.PropertySet`
    Additional metadata.

Definition at line 643 of file ds9.py.

◆ ds9Cmd()

lsst.display.ds9.ds9.ds9Cmd	(	cmd = None,
		trap = True,
		flush = False,
		silent = True,
		frame = None,
		get = False )

Issue a DS9 command, raising errors as appropriate.

Parameters
----------
cmd : `str`, optional
    Command to execute.
trap : `bool`, optional
    Trap errors.
flush : `bool`, optional
    Flush the output.
silent : `bool`, optional
    Do not print trapped error messages.
frame : `int`, optional
    Frame number on which to execute command.
get : `bool`, optional
    Return xpa response.

Definition at line 227 of file ds9.py.

◆ ds9Version()

lsst.display.ds9.ds9.ds9Version ( )

Get the version of DS9 in use.

Returns
-------
version : `str`
    Version of DS9 in use.

Definition at line 91 of file ds9.py.

◆ getXpaAccessPoint()

lsst.display.ds9.ds9.getXpaAccessPoint ( )

Parse XPA_PORT if set and return an identifier to send DS9 commands.

Returns
-------

xpaAccessPoint : `str`
    Either a reference to the local host with the configured port, or the
    string ``"ds9"``.

Notes
-----
If you don't have XPA_PORT set, the usual xpans tricks will be played
when we return ``"ds9"``.

Definition at line 63 of file ds9.py.

◆ initDS9()

lsst.display.ds9.ds9.initDS9 ( execDs9 = True )

Initialize DS9.

Parameters
----------
execDs9 : `bool`, optional
    If DS9 is not running, attempt to execute it.

Definition at line 283 of file ds9.py.

◆ selectFrame()

lsst.display.ds9.ds9.selectFrame ( frame )

Convert integer frame number to DS9 command syntax.

Parameters
----------
frame : `int`
    Frame number

Returns
-------
frameString : `str`

Definition at line 212 of file ds9.py.

Variable Documentation

◆ _maskTransparency

lsst.display.ds9.ds9._maskTransparency = None

protected

Definition at line 60 of file ds9.py.

◆ cmdBuffer

lsst.display.ds9.ds9.cmdBuffer

Definition at line 209 of file ds9.py.

◆ file

lsst.display.ds9.ds9.file

Definition at line 41 of file ds9.py.

◆ haveGzip

lsst.display.ds9.ds9.haveGzip = not os.system("gzip < /dev/null > /dev/null 2>&1")

Definition at line 640 of file ds9.py.

◆ needShow

bool lsst.display.ds9.ds9.needShow = True

Definition at line 49 of file ds9.py.

◆ XPA_SZ_LINE

int lsst.display.ds9.ds9.XPA_SZ_LINE = 4096 - 100

Definition at line 111 of file ds9.py.

Classes

Functions

Variables