Inheritance diagram for lsst.display.matplotlib.matplotlib.BlockingKeyInput:

Public Member Functions
def	__init__ (self, fig)

def	post_event (self)

def	__call__ (self, timeout=-1)

Public Attributes
	ev

Detailed Description

Callable class to retrieve a single keyboard click

Definition at line 751 of file matplotlib.py.

Constructor & Destructor Documentation

◆ init()

def lsst.display.matplotlib.matplotlib.BlockingKeyInput.__init__	(	self,
		fig
	)

Create a BlockingKeyInput

@param fig The figure to monitor for keyboard events

Definition at line 755 of file matplotlib.py.

     def __init__(self, fig):
         """Create a BlockingKeyInput
  
         @param fig The figure to monitor for keyboard events
         """
         BlockingInput.__init__(self, fig=fig, eventslist=('key_press_event',))
  

Member Function Documentation

◆ call()

def lsst.display.matplotlib.matplotlib.BlockingKeyInput.__call__	(	self,
		timeout = `-1`
	)

Blocking call to retrieve a single key click
Returns key or None if timeout (-1: never timeout)

Definition at line 774 of file matplotlib.py.

     def __call__(self, timeout=-1):
         """
         Blocking call to retrieve a single key click
         Returns key or None if timeout (-1: never timeout)
         """
         self.ev = None
  
         BlockingInput.__call__(self, n=1, timeout=timeout)
  
         return self.ev
  
 # -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  
  

◆ post_event()

def lsst.display.matplotlib.matplotlib.BlockingKeyInput.post_event ( self )

Return the event containing the key and (x, y)

Definition at line 762 of file matplotlib.py.

     def post_event(self):
         """
         Return the event containing the key and (x, y)
         """
         try:
             event = self.events[-1]
         except IndexError:
             # details of the event to pass back to the display
             self.ev = None
         else:
             self.ev = interface.Event(event.key, event.xdata, event.ydata)
  

Member Data Documentation

◆ ev

lsst.display.matplotlib.matplotlib.BlockingKeyInput.ev

Definition at line 770 of file matplotlib.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/display_matplotlib/22.0.0+297cba6710/python/lsst/display/matplotlib/matplotlib.py

Public Member Functions

Public Attributes