matplotlib.github.com/_modules/matplotlib/blocking_input.html at master · pjastr/matplotlib.github.com

History

500 lines (411 loc) · 51.1 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.blocking_input — Matplotlib 3.1.0 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.1.0 documentation"

href="../../_static/opensearch.xml"/>

</head>

<body>

The 2019 SciPy John Hunter Excellence in Plotting Contest is accepting submissions!

<a href="https://docs.google.com/forms/d/e/1FAIpQLSe-_AnKvYSzeQWfNDRoXgW0vl7_8q6jj3QbLIac8eUcb9lSAA/viewform?usp=sf_link" style="font-weight: bold;">Apply by June 8th</a>

</div>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.1.0</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li><a href="../../gallery/index.html">examples</a>| </li>

<li><a href="../../tutorials/index.html">tutorials</a>| </li>

<li><a href="../../contents.html">contents</a> »</li>

<li><a href="../index.html" >Module code</a> »</li>

<li><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

<h3>Related Topics</h3>

<ul>

<li><a href="../../contents.html">Documentation overview</a><ul>

<li><a href="../index.html">Module code</a><ul>

<li><a href="../matplotlib.html">matplotlib</a><ul>

</ul></li>

</ul>

</div>

<h1>Source code for matplotlib.blocking_input</h1><div class="highlight"><pre>

"""

This provides several classes used for blocking interaction with figure

windows:

`BlockingInput`

Creates a callable object to retrieve events in a blocking way for

interactive sessions. Base class of the other classes listed here.

`BlockingKeyMouseInput`

Creates a callable object to retrieve key or mouse clicks in a blocking

way for interactive sessions. Used by `waitforbuttonpress`.

`BlockingMouseInput`

Creates a callable object to retrieve mouse clicks in a blocking way for

interactive sessions. Used by `ginput`.

`BlockingContourLabeler`

Creates a callable object to retrieve mouse clicks in a blocking way that

will then be used to place labels on a `ContourSet`. Used by `clabel`.

"""

import logging

from numbers import Integral

import matplotlib.lines as mlines

_log = logging.getLogger(__name__)

<div class="viewcode-block" id="BlockingInput"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingInput">[docs]</a>class BlockingInput(object):

"""Callable for retrieving events in a blocking way."""

self.fig = fig

self.eventslist = eventslist

<div class="viewcode-block" id="BlockingInput.on_event"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingInput.on_event">[docs]</a> def on_event(self, event):

"""

Event handler; will be passed to the current figure to retrieve events.

"""

# Add a new event to list - using a separate function is overkill for

# the base class, but this is consistent with subclasses.

self.add_event(event)

_log.info("Event %i", len(self.events))

# This will extract info from events.

self.post_event()

# Check if we have enough events already.

if len(self.events) >= self.n > 0:

<div class="viewcode-block" id="BlockingInput.post_event"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingInput.post_event">[docs]</a> def post_event(self):

"""For baseclass, do nothing but collect events."""</div>

<div class="viewcode-block" id="BlockingInput.cleanup"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingInput.cleanup">[docs]</a> def cleanup(self):

"""Disconnect all callbacks."""

for cb in self.callbacks:

self.fig.canvas.mpl_disconnect(cb)

self.callbacks = []</div>

<div class="viewcode-block" id="BlockingInput.add_event"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingInput.add_event">[docs]</a> def add_event(self, event):

"""For base class, this just appends an event to events."""

self.events.append(event)</div>

<div class="viewcode-block" id="BlockingInput.pop_event"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingInput.pop_event">[docs]</a> def pop_event(self, index=-1):

"""

Remove an event from the event list -- by default, the last.

Note that this does not check that there are events, much like the

normal pop method. If no events exist, this will throw an exception.

"""

self.events.pop(index)</div>

pop = pop_event

def __call__(self, n=1, timeout=30):

"""Blocking call to retrieve *n* events."""

if not isinstance(n, Integral):

raise ValueError("Requires an integer argument")

self.n = n

self.events = []

if hasattr(self.fig.canvas, "manager"):

# Ensure that the figure is shown, if we are managing it.

self.fig.show()

# Connect the events to the on_event function call.

self.callbacks = [self.fig.canvas.mpl_connect(name, self.on_event)

for name in self.eventslist]

try:

# Start event loop.

self.fig.canvas.start_event_loop(timeout=timeout)

finally: # Run even on exception like ctrl-c.

# Disconnect the callbacks.

self.cleanup()

# Return the events in this case.

return self.events</div>

<div class="viewcode-block" id="BlockingMouseInput"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingMouseInput">[docs]</a>class BlockingMouseInput(BlockingInput):

"""

Callable for retrieving mouse clicks in a blocking way.

This class will also retrieve keypresses and map them to mouse clicks:

delete and backspace are like mouse button 3, enter is like mouse button 2

and all others are like mouse button 1.

"""

button_add = 1

button_pop = 3

button_stop = 2

def __init__(self, fig, mouse_add=1, mouse_pop=3, mouse_stop=2):

BlockingInput.__init__(self, fig=fig,

eventslist=('button_press_event',

'key_press_event'))

self.button_add = mouse_add

self.button_pop = mouse_pop

self.button_stop = mouse_stop

<div class="viewcode-block" id="BlockingMouseInput.post_event"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingMouseInput.post_event">[docs]</a> def post_event(self):

"""Process an event."""

if len(self.events) == 0:

_log.warning("No events yet")

elif self.events[-1].name == 'key_press_event':

self.key_event()

else:

self.mouse_event()</div>

<div class="viewcode-block" id="BlockingMouseInput.mouse_event"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingMouseInput.mouse_event">[docs]</a> def mouse_event(self):

"""Process a mouse click event."""

event = self.events[-1]

button = event.button

if button == self.button_pop:

self.mouse_event_pop(event)

elif button == self.button_stop:

self.mouse_event_stop(event)

elif button == self.button_add:

self.mouse_event_add(event)</div>

<div class="viewcode-block" id="BlockingMouseInput.key_event"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingMouseInput.key_event">[docs]</a> def key_event(self):

"""

Process a key press event, mapping keys to appropriate mouse clicks.

"""

if event.key is None:

# At least in OSX gtk backend some keys return None.

return

key = event.key.lower()

if key in ['backspace', 'delete']:

self.mouse_event_pop(event)

elif key in ['escape', 'enter']:

self.mouse_event_stop(event)

else:

self.mouse_event_add(event)</div>

<div class="viewcode-block" id="BlockingMouseInput.mouse_event_add"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingMouseInput.mouse_event_add">[docs]</a> def mouse_event_add(self, event):

"""

Process an button-1 event (add a click if inside axes).

Parameters

----------

event : `~.backend_bases.MouseEvent`

"""

if event.inaxes:

self.add_click(event)

else: # If not a valid click, remove from event list.

BlockingInput.pop(self)</div>

<div class="viewcode-block" id="BlockingMouseInput.mouse_event_stop"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingMouseInput.mouse_event_stop">[docs]</a> def mouse_event_stop(self, event):

"""

Process an button-2 event (end blocking input).

Parameters

----------

event : `~.backend_bases.MouseEvent`

"""

# Remove last event just for cleanliness.

BlockingInput.pop(self)

# This will exit even if not in infinite mode. This is consistent with

# MATLAB and sometimes quite useful, but will require the user to test

# how many points were actually returned before using data.

<div class="viewcode-block" id="BlockingMouseInput.mouse_event_pop"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingMouseInput.mouse_event_pop">[docs]</a> def mouse_event_pop(self, event):

"""

Process an button-3 event (remove the last click).

Parameters

----------

event : `~.backend_bases.MouseEvent`

"""

# Remove this last event.

BlockingInput.pop(self)

# Now remove any existing clicks if possible.

if self.events:

self.pop(event)</div>

<div class="viewcode-block" id="BlockingMouseInput.add_click"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingMouseInput.add_click">[docs]</a> def add_click(self, event):

"""

Add the coordinates of an event to the list of clicks.

Parameters

----------

event : `~.backend_bases.MouseEvent`

"""

self.clicks.append((event.xdata, event.ydata))

_log.info("input %i: %f, %f",

len(self.clicks), event.xdata, event.ydata)

# If desired, plot up click.

if self.show_clicks:

line = mlines.Line2D([event.xdata], [event.ydata],

marker='+', color='r')

event.inaxes.add_line(line)

self.marks.append(line)

<div class="viewcode-block" id="BlockingMouseInput.pop_click"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingMouseInput.pop_click">[docs]</a> def pop_click(self, event, index=-1):

"""

Remove a click (by default, the last) from the list of clicks.

Parameters

----------

event : `~.backend_bases.MouseEvent`

"""

self.clicks.pop(index)

if self.show_clicks:

self.marks.pop(index).remove()

<div class="viewcode-block" id="BlockingMouseInput.pop"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingMouseInput.pop">[docs]</a> def pop(self, event, index=-1):

"""

Removes a click and the associated event from the list of clicks.

Defaults to the last click.

"""

self.pop_click(event, index)

BlockingInput.pop(self, index)</div>

<div class="viewcode-block" id="BlockingMouseInput.cleanup"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingMouseInput.cleanup">[docs]</a> def cleanup(self, event=None):

"""

Parameters

----------

event : `~.backend_bases.MouseEvent`, optional

Not used

"""

# Clean the figure.

if self.show_clicks:

for mark in self.marks:

mark.remove()

self.marks = []

# Call base class to remove callbacks.

BlockingInput.cleanup(self)</div>

"""

Blocking call to retrieve *n* coordinate pairs through mouse clicks.

"""

self.show_clicks = show_clicks

self.clicks = []

self.marks = []

BlockingInput.__call__(self, n=n, timeout=timeout)

return self.clicks</div>

<div class="viewcode-block" id="BlockingContourLabeler"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingContourLabeler">[docs]</a>class BlockingContourLabeler(BlockingMouseInput):

"""

Callable for retrieving mouse clicks and key presses in a blocking way.

Used to place contour labels.

"""

def __init__(self, cs):

self.cs = cs

BlockingMouseInput.__init__(self, fig=cs.ax.figure)

<div class="viewcode-block" id="BlockingContourLabeler.add_click"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingContourLabeler.add_click">[docs]</a> def add_click(self, event):

self.button1(event)</div>

<div class="viewcode-block" id="BlockingContourLabeler.pop_click"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingContourLabeler.pop_click">[docs]</a> def pop_click(self, event, index=-1):

self.button3(event)</div>

<div class="viewcode-block" id="BlockingContourLabeler.button1"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingContourLabeler.button1">[docs]</a> def button1(self, event):

"""

Process an button-1 event (add a label to a contour).

Parameters

----------

event : `~.backend_bases.MouseEvent`

"""

# Shorthand

if event.inaxes == self.cs.ax:

self.cs.add_label_near(event.x, event.y, self.inline,

inline_spacing=self.inline_spacing,

transform=False)

else: # Remove event if not valid

BlockingInput.pop(self)</div>

<div class="viewcode-block" id="BlockingContourLabeler.button3"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingContourLabeler.button3">[docs]</a> def button3(self, event):

"""

Process an button-3 event (remove a label if not in inline mode).

Unfortunately, if one is doing inline labels, then there is currently

no way to fix the broken contour - once humpty-dumpty is broken, he

can't be put back together. In inline mode, this does nothing.

Parameters

----------

event : `~.backend_bases.MouseEvent`

"""

if self.inline:

pass

else:

self.cs.pop_label()

self.cs.ax.figure.canvas.draw()</div>

def __call__(self, inline, inline_spacing=5, n=-1, timeout=-1):

self.inline = inline

self.inline_spacing = inline_spacing

BlockingMouseInput.__call__(self, n=n, timeout=timeout,

show_clicks=False)</div>

<div class="viewcode-block" id="BlockingKeyMouseInput"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingKeyMouseInput">[docs]</a>class BlockingKeyMouseInput(BlockingInput):

"""

Callable for retrieving mouse clicks and key presses in a blocking way.

"""

def __init__(self, fig):

'button_press_event', 'key_press_event'))

<div class="viewcode-block" id="BlockingKeyMouseInput.post_event"><a class="viewcode-back" href="../../api/blocking_input_api.html#matplotlib.blocking_input.BlockingKeyMouseInput.post_event">[docs]</a> def post_event(self):

"""Determine if it is a key event."""

if self.events:

self.keyormouse = self.events[-1].name == 'key_press_event'

else:

_log.warning("No events yet.")</div>

def __call__(self, timeout=30):

"""

Blocking call to retrieve a single mouse click or key press.

Returns ``True`` if key press, ``False`` if mouse click, or ``None`` if

timed out.

"""

self.keyormouse = None

BlockingInput.__call__(self, n=1, timeout=timeout)

return self.keyormouse</div>

</pre></div>

</div>

</div>

Last updated on May 18, 2019.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.

Doc version v3.1.0-4-g0078324e4.

</div>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

blocking_input.html

Latest commit

History

blocking_input.html

File metadata and controls