lsst.display.ds9  19.0.0-3-g2b32d65+9
Classes | Functions | Variables
lsst.display.ds9.ds9 Namespace Reference

Classes

class  Buffer
 
class  DisplayImpl
 
class  Ds9Error
 
class  Ds9Event
 

Functions

def getXpaAccessPoint ()
 
def ds9Version ()
 
def selectFrame (frame)
 
def ds9Cmd (cmd=None, trap=True, flush=False, silent=True, frame=None, get=False)
 
def initDS9 (execDs9=True)
 

Variables

 file
 
bool needShow = True
 
int XPA_SZ_LINE = 4096 - 100
 
 cmdBuffer
 
 haveGzip = not os.system("gzip < /dev/null > /dev/null 2>&1")
 
bool definedCallbacks = True
 

Function Documentation

◆ ds9Cmd()

def 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 225 of file ds9.py.

◆ ds9Version()

def lsst.display.ds9.ds9.ds9Version ( )
Get the version of DS9 in use.

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

Definition at line 89 of file ds9.py.

◆ getXpaAccessPoint()

def 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 61 of file ds9.py.

◆ initDS9()

def 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 282 of file ds9.py.

◆ selectFrame()

def 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 210 of file ds9.py.

Variable Documentation

◆ cmdBuffer

lsst.display.ds9.ds9.cmdBuffer

Definition at line 207 of file ds9.py.

◆ definedCallbacks

bool lsst.display.ds9.ds9.definedCallbacks = True

Definition at line 697 of file ds9.py.

◆ file

lsst.display.ds9.ds9.file

Definition at line 39 of file ds9.py.

◆ haveGzip

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

Definition at line 638 of file ds9.py.

◆ needShow

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

Definition at line 47 of file ds9.py.

◆ XPA_SZ_LINE

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

Definition at line 109 of file ds9.py.