Buffer

class lsst.display.ds9.Buffer(size=0)

Bases: object

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

Methods Summary

flush([silent])	Flush the pending commands.
popSize()	Switch back to the previous command buffer size.
pushSize([size])	Replace current DS9 command buffer size.
set(size[, silent])	Set the ds9 buffer size to size.

Methods Documentation

flush(silent=True)

Flush the pending commands.

Parameters

silentbool, optional

Do not print error messages.

popSize()

Switch back to the previous command buffer size.

Notes

See also pushSize.

pushSize(size=- 1)

Replace current DS9 command buffer size.

Parameters

sizeint, optional

Size of buffer. A negative value sets the largest possible buffer.

Notes

See also popSize.

set(size, silent=True)

Set the ds9 buffer size to size.

Parameters

sizeint

Size of buffer. Requesting a negative size provides the largest possible buffer given bugs in xpa.

silentbool, optional

Do not print error messages (default True).