lsst.display.ds9.ds9.Buffer Class Reference

Inheritance diagram for lsst.display.ds9.ds9.Buffer:

Public Member Functions
def	__init__ (self, size=0)
def	set (self, size, silent=True)
def	pushSize (self, size=-1)
def	popSize (self)
def	flush (self, silent=True)

Detailed Description

Buffer to control sending commands to DS9.

Notes
-----
The usual usage pattern is:

>>> with ds9.Buffering():
...     # bunches of ds9.{dot,line} commands
...     ds9.flush()
...     # bunches more ds9.{dot,line} commands

Definition at line 111 of file ds9.py.

Constructor & Destructor Documentation

__init__()

def lsst.display.ds9.ds9.Buffer.__init__	(		self,
			size = 0
	)

Definition at line 124 of file ds9.py.

Member Function Documentation

flush()

def lsst.display.ds9.ds9.Buffer.flush	(		self,
			silent = True
	)

Flush the pending commands.

Parameters
----------
silent : `bool`, optional
    Do not print error messages.

Definition at line 197 of file ds9.py.

popSize()

def lsst.display.ds9.ds9.Buffer.popSize

(

self

)

Switch back to the previous command buffer size.

Notes
-----
See also `pushSize`.

Definition at line 185 of file ds9.py.

pushSize()

def lsst.display.ds9.ds9.Buffer.pushSize	(		self,
			size = -1
	)

Replace current DS9 command buffer size.

Parameters
----------
size : `int`, optional
    Size of buffer. A negative value sets the largest possible
    buffer.

Notes
-----
See also `popSize`.

Definition at line 168 of file ds9.py.

set()

def lsst.display.ds9.ds9.Buffer.set	(		self,
			size,
			silent = True
	)

Set the ds9 buffer size to size.

Parameters
----------
size : `int`
    Size of buffer. Requesting a negative size provides the
    largest possible buffer given bugs in xpa.
silent : `bool`, optional
    Do not print error messages (default `True`).

Definition at line 131 of file ds9.py.

---

The documentation for this class was generated from the following file:

• python/lsst/display/ds9/ds9.py