lsst.display.ds9  16.0-2-g9d5294e+53
Public Member Functions | List of all members
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

Control buffering the sending of commands to ds9;
annoying but necessary for anything resembling performance

The usual usage pattern (from a module importing this file, ds9.py) is:

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

Definition at line 95 of file ds9.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.display.ds9.ds9.Buffer.__init__ (   self,
  size = 0 
)
Create a command buffer, with a maximum depth of size

Definition at line 107 of file ds9.py.

Member Function Documentation

◆ flush()

def lsst.display.ds9.ds9.Buffer.flush (   self,
  silent = True 
)
Flush the pending commands

Definition at line 151 of file ds9.py.

◆ popSize()

def lsst.display.ds9.ds9.Buffer.popSize (   self)
Switch back to the previous command buffer size (see also pushSize)

Definition at line 144 of file ds9.py.

◆ pushSize()

def lsst.display.ds9.ds9.Buffer.pushSize (   self,
  size = -1 
)
Replace current ds9 command buffer size with size (see also popSize)
@param:  Size of buffer (-1: largest possible given bugs in xpa)

Definition at line 137 of file ds9.py.

◆ set()

def lsst.display.ds9.ds9.Buffer.set (   self,
  size,
  silent = True 
)
Set the ds9 buffer size to size

Definition at line 115 of file ds9.py.


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