lsst.display.ds9.ds9.Buffer Class Reference

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

Protected Member Functions
	_getSize (self)

Protected Attributes
	_commands
	_lenCommands
	_bufsize

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

Constructor & Destructor Documentation

__init__()

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

Definition at line 125 of file ds9.py.

        def __init__(self, size=0):
            self._commands = ""         # list of pending commands
            self._lenCommands = len(self._commands)
            self._bufsize = []          # stack of bufsizes
 
            self._bufsize.append(size)  # don't call self.size() as ds9Cmd isn't defined yet
 

Member Function Documentation

_getSize()

lsst.display.ds9.ds9.Buffer._getSize ( self )

protected

Get the current DS9 buffer size.

Returns
-------
size : `int`
    Size of buffer.

Definition at line 159 of file ds9.py.

        def _getSize(self):
            """Get the current DS9 buffer size.
 
            Returns
            -------
            size : `int`
                Size of buffer.
            """
            return self._bufsize[-1]
 

flush()

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

        def flush(self, silent=True):
            """Flush the pending commands.
 
            Parameters
            ----------
            silent : `bool`, optional
                Do not print error messages.
            """
            ds9Cmd(flush=True, silent=silent)
 
    cmdBuffer = Buffer(0)

popSize()

lsst.display.ds9.ds9.Buffer.popSize

(

self

)

Switch back to the previous command buffer size.

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

Definition at line 186 of file ds9.py.

        def popSize(self):
            """Switch back to the previous command buffer size.
 
            Notes
            -----
            See also `pushSize`.
            """
            self.flush(silent=True)
 
            if len(self._bufsize) > 1:
                self._bufsize.pop()
 

pushSize()

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

        def 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`.
            """
            self.flush(silent=True)
            self._bufsize.append(0)
            self.set(size, silent=True)
 

set()

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

        def 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`).
            """
            if size < 0:
                size = XPA_SZ_LINE - 5
 
            if size > XPA_SZ_LINE:
                print("xpa silently hardcodes a limit of %d for buffer sizes (you asked for %d) " %
                      (XPA_SZ_LINE, size), file=sys.stderr)
                self.set(-1)            # use max buffersize
                return
 
            if self._bufsize:
                self._bufsize[-1] = size  # change current value
            else:
                self._bufsize.append(size)  # there is no current value; set one
 
            self.flush(silent=silent)
 

Member Data Documentation

_bufsize

lsst.display.ds9.ds9.Buffer._bufsize

protected

Definition at line 128 of file ds9.py.

_commands

lsst.display.ds9.ds9.Buffer._commands

protected

Definition at line 126 of file ds9.py.

_lenCommands

lsst.display.ds9.ds9.Buffer._lenCommands

protected

Definition at line 127 of file ds9.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/display_ds9/gc28159a63d+0e5473021a/python/lsst/display/ds9/ds9.py