LSST Applications g0da5cf3356+25b44625d0,g17e5ecfddb+50a5ac4092,g1c76d35bf8+585f0f68a2,g295839609d+8ef6456700,g2e2c1a68ba+cc1f6f037e,g38293774b4+62d12e78cb,g3b44f30a73+2891c76795,g48ccf36440+885b902d19,g4b2f1765b6+0c565e8f25,g5320a0a9f6+bd4bf1dc76,g56364267ca+403c24672b,g56b687f8c9+585f0f68a2,g5c4744a4d9+78cd207961,g5ffd174ac0+bd4bf1dc76,g6075d09f38+3075de592a,g667d525e37+cacede5508,g6f3e93b5a3+da81c812ee,g71f27ac40c+cacede5508,g7212e027e3+eb621d73aa,g774830318a+18d2b9fa6c,g7985c39107+62d12e78cb,g79ca90bc5c+fa2cc03294,g881bdbfe6c+cacede5508,g91fc1fa0cf+82a115f028,g961520b1fb+2534687f64,g96f01af41f+f2060f23b6,g9ca82378b8+cacede5508,g9d27549199+78cd207961,gb065e2a02a+ad48cbcda4,gb1df4690d6+585f0f68a2,gb35d6563ee+62d12e78cb,gbc3249ced9+bd4bf1dc76,gbec6a3398f+bd4bf1dc76,gd01420fc67+bd4bf1dc76,gd59336e7c4+c7bb92e648,gf46e8334de+81c9a61069,gfed783d017+bd4bf1dc76,v25.0.1.rc3
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
lsst.display.matplotlib.matplotlib.BlockingKeyInput Class Reference
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.

755 def __init__(self, fig):
756 """Create a BlockingKeyInput
757
758 @param fig The figure to monitor for keyboard events
759 """
760 BlockingInput.__init__(self, fig=fig, eventslist=('key_press_event',))
761

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.

774 def __call__(self, timeout=-1):
775 """
776 Blocking call to retrieve a single key click
777 Returns key or None if timeout (-1: never timeout)
778 """
779 self.ev = None
780
781 BlockingInput.__call__(self, n=1, timeout=timeout)
782
783 return self.ev
784
785# -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
786
787

◆ 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.

762 def post_event(self):
763 """
764 Return the event containing the key and (x, y)
765 """
766 try:
767 event = self.events[-1]
768 except IndexError:
769 # details of the event to pass back to the display
770 self.ev = None
771 else:
772 self.ev = interface.Event(event.key, event.xdata, event.ydata)
773

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: