devdocs/tutorials/03_advanced/path_tutorial.html at first_commit · matplotlib/devdocs

History

558 lines (485 loc) · 45.8 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

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

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

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

<head>

<title>Path Tutorial — Matplotlib 2.0.2.post4416.dev0+g1df513f documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../',

VERSION: '2.0.2.post4416.dev0+g1df513f',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.0.2.post4416.dev0+g1df513f documentation"

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

</head>

<body>

</map>

</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="../index.html">tutorials</a>| </li>

<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>

</ul>

</div>

</a>

</a>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

<h3><a href="../../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">Path Tutorial</a><ul>

<li><a class="reference internal" href="#bezier-example">Bézier example</a></li>

<li><a class="reference internal" href="#compound-paths">Compound paths</a></li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

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

</ul></li>

</ul>

</div>

<li><a href="../../_sources/tutorials/03_advanced/path_tutorial.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<h1>Path Tutorial<a class="headerlink" href="#path-tutorial" title="Permalink to this headline">¶</a></h1>

Defining paths in your Matplotlib visualization.

The object underlying all of the <code class="xref py py-mod docutils literal">matplotlib.patch</code> objects is

the <a class="reference internal" href="../../api/path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal">Path</code></a>, which supports the standard set of

moveto, lineto, curveto commands to draw simple and compound outlines

consisting of line segments and splines. The <code class="docutils literal">Path</code> is instantiated

with a (N,2) array of (x,y) vertices, and a N-length array of path

codes. For example to draw the unit rectangle from (0,0) to (1,1), we

could use this code

<div class="highlight-python"><div class="highlight"><pre>import matplotlib.pyplot as plt

from matplotlib.path import <a href="../../api/path_api.html#matplotlib.path.Path" title="View documentation for matplotlib.path.Path">Path</a>

import matplotlib.patches as patches

verts = [

(0., 0.), # left, bottom

(0., 1.), # left, top

(1., 1.), # right, top

(1., 0.), # right, bottom

(0., 0.), # ignored

]

codes = [

<a href="../../api/path_api.html#matplotlib.path.Path.MOVETO" title="View documentation for matplotlib.path.Path.MOVETO">Path.MOVETO</a>,

<a href="../../api/path_api.html#matplotlib.path.Path.LINETO" title="View documentation for matplotlib.path.Path.LINETO">Path.LINETO</a>,

<a href="../../api/path_api.html#matplotlib.path.Path.CLOSEPOLY" title="View documentation for matplotlib.path.Path.CLOSEPOLY">Path.CLOSEPOLY</a>,

]

<a href="../../api/path_api.html#matplotlib.path" title="View documentation for matplotlib.path">path</a> = <a href="../../api/path_api.html#matplotlib.path.Path" title="View documentation for matplotlib.path.Path">Path</a>(verts, codes)

fig = <a href="../../api/_as_gen/matplotlib.figure.figaspect.html#matplotlib.figure" title="View documentation for matplotlib.pyplot.figure">plt.figure</a>()

ax = fig.add_subplot(111)

patch = <a href="../../api/_as_gen/matplotlib.patches.PathPatch.html#matplotlib.patches.PathPatch" title="View documentation for matplotlib.patches.PathPatch">patches.PathPatch</a>(<a href="../../api/path_api.html#matplotlib.path" title="View documentation for matplotlib.path">path</a>, facecolor='orange', lw=2)

ax.add_patch(patch)

ax.set_xlim(-2, 2)

ax.set_ylim(-2, 2)

<a href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="View documentation for matplotlib.pyplot.show">plt.show</a>()

</pre></div>

</div>

The following path codes are recognized

</colgroup>

<th class="head">Vertices</th>

<th class="head">Description</th>

</tr>

</thead>

<td>1 (ignored)</td>

<td>A marker for the end of the entire path (currently not required and ignored)</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal">MOVETO</code></td>

<td>Pick up the pen and move to the given vertex.</td>

</tr>

<tr class="row-even"><td><code class="docutils literal">LINETO</code></td>

<td>Draw a line from the current position to the given vertex.</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal">CURVE3</code></td>

<td>2 (1 control point, 1 endpoint)</td>

<td>Draw a quadratic Bézier curve from the current position, with the given control point, to the given end point.</td>

</tr>

<tr class="row-even"><td><code class="docutils literal">CURVE4</code></td>

<td>3 (2 control points, 1 endpoint)</td>

<td>Draw a cubic Bézier curve from the current position, with the given control points, to the given end point.</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal">CLOSEPOLY</code></td>

<td>1 (point itself is ignored)</td>

<td>Draw a line segment to the start point of the current polyline.</td>

</tr>

</tbody>

</table>

<h2>Bézier example<a class="headerlink" href="#bezier-example" title="Permalink to this headline">¶</a></h2>

Some of the path components require multiple vertices to specify them:

for example CURVE 3 is a <a class="reference external" href="https://en.wikipedia.org/wiki/B%C3%A9zier_curve">bézier</a> curve with one

control point and one end point, and CURVE4 has three vertices for the

two control points and the end point. The example below shows a

CURVE4 Bézier spline – the bézier curve will be contained in the

convex hull of the start point, the two control points, and the end

point

<div class="highlight-python"><div class="highlight"><pre>verts = [

(0., 0.), # P0

(0.2, 1.), # P1

(1., 0.8), # P2

(0.8, 0.), # P3

]

codes = [

<a href="../../api/path_api.html#matplotlib.path.Path.CURVE4" title="View documentation for matplotlib.path.Path.CURVE4">Path.CURVE4</a>,

]

patch = <a href="../../api/_as_gen/matplotlib.patches.PathPatch.html#matplotlib.patches.PathPatch" title="View documentation for matplotlib.patches.PathPatch">patches.PathPatch</a>(<a href="../../api/path_api.html#matplotlib.path" title="View documentation for matplotlib.path">path</a>, facecolor='none', lw=2)

ax.add_patch(patch)

xs, ys = zip(*verts)

ax.plot(xs, ys, 'x--', lw=2, color='black', ms=10)

ax.text(-0.05, -0.05, 'P0')

ax.text(0.15, 1.05, 'P1')

ax.text(1.05, 0.85, 'P2')

ax.text(0.85, -0.05, 'P3')

ax.set_xlim(-0.1, 1.1)

ax.set_ylim(-0.1, 1.1)

</pre></div>

</div>

</div>

<h2>Compound paths<a class="headerlink" href="#compound-paths" title="Permalink to this headline">¶</a></h2>

All of the simple patch primitives in matplotlib, Rectangle, Circle,

Polygon, etc, are implemented with simple path. Plotting functions

like <a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.hist.html#matplotlib.axes.Axes.hist" title="matplotlib.axes.Axes.hist"><code class="xref py py-meth docutils literal">hist()</code></a> and

<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.bar.html#matplotlib.axes.Axes.bar" title="matplotlib.axes.Axes.bar"><code class="xref py py-meth docutils literal">bar()</code></a>, which create a number of

primitives, e.g., a bunch of Rectangles, can usually be implemented more

efficiently using a compound path. The reason <code class="docutils literal">bar</code> creates a list

of rectangles and not a compound path is largely historical: the

<a class="reference internal" href="../../api/path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal">Path</code></a> code is comparatively new and <code class="docutils literal">bar</code>

predates it. While we could change it now, it would break old code,

so here we will cover how to create compound paths, replacing the

functionality in bar, in case you need to do so in your own code for

efficiency reasons, e.g., you are creating an animated bar plot.

We will make the histogram chart by creating a series of rectangles

for each histogram bar: the rectangle width is the bin width and the

rectangle height is the number of datapoints in that bin. First we’ll

create some random normally distributed data and compute the

histogram. Because numpy returns the bin edges and not centers, the

length of <code class="docutils literal">bins</code> is 1 greater than the length of <code class="docutils literal">n</code> in the

example below:

<div class="highlight-default"><div class="highlight"><pre># histogram our data with numpy

data = np.random.randn(1000)

n, bins = np.histogram(data, 100)

</pre></div>

</div>

We’ll now extract the corners of the rectangles. Each of the

<code class="docutils literal">left</code>, <code class="docutils literal">bottom</code>, etc, arrays below is <code class="docutils literal">len(n)</code>, where <code class="docutils literal">n</code> is

the array of counts for each histogram bar:

<div class="highlight-default"><div class="highlight"><pre># get the corners of the rectangles for the histogram

left = np.array(bins[:-1])

right = np.array(bins[1:])

bottom = np.zeros(len(left))

top = bottom + n

</pre></div>

</div>

Now we have to construct our compound path, which will consist of a

series of <code class="docutils literal">MOVETO</code>, <code class="docutils literal">LINETO</code> and <code class="docutils literal">CLOSEPOLY</code> for each rectangle.

For each rectangle, we need 5 vertices: 1 for the <code class="docutils literal">MOVETO</code>, 3 for

the <code class="docutils literal">LINETO</code>, and 1 for the <code class="docutils literal">CLOSEPOLY</code>. As indicated in the

table above, the vertex for the closepoly is ignored but we still need

it to keep the codes aligned with the vertices:

<div class="highlight-default"><div class="highlight"><pre>nverts = nrects*(1+3+1)

verts = np.zeros((nverts, 2))

codes = np.ones(nverts, int) * <a href="../../api/path_api.html#matplotlib.path.Path.LINETO" title="View documentation for matplotlib.path.Path.LINETO">path.Path.LINETO</a>

codes[0::5] = <a href="../../api/path_api.html#matplotlib.path.Path.MOVETO" title="View documentation for matplotlib.path.Path.MOVETO">path.Path.MOVETO</a>

codes[4::5] = <a href="../../api/path_api.html#matplotlib.path.Path.CLOSEPOLY" title="View documentation for matplotlib.path.Path.CLOSEPOLY">path.Path.CLOSEPOLY</a>

verts[0::5,0] = left

verts[0::5,1] = bottom

verts[1::5,0] = left

verts[1::5,1] = top

verts[2::5,0] = right

verts[2::5,1] = top

verts[3::5,0] = right

verts[3::5,1] = bottom

</pre></div>

</div>

All that remains is to create the path, attach it to a

<code class="xref py py-class docutils literal">PathPatch</code>, and add it to our axes:

<div class="highlight-default"><div class="highlight"><pre>barpath = <a href="../../api/path_api.html#matplotlib.path.Path" title="View documentation for matplotlib.path.Path">path.Path</a>(verts, codes)

patch = <a href="../../api/_as_gen/matplotlib.patches.PathPatch.html#matplotlib.patches.PathPatch" title="View documentation for matplotlib.patches.PathPatch">patches.PathPatch</a>(barpath, facecolor='green',

edgecolor='yellow', alpha=0.5)

ax.add_patch(patch)

</pre></div>

</div>

<div class="highlight-python"><div class="highlight"><pre>import numpy as np

import matplotlib.patches as patches

import matplotlib.path as path

# Fixing random state for reproducibility

np.random.seed(19680801)

# histogram our data with numpy

# get the corners of the rectangles for the histogram

top = bottom + n

nrects = len(left)

nverts = nrects*(1+3+1)

verts[0::5, 0] = left

verts[0::5, 1] = bottom

verts[1::5, 0] = left

verts[1::5, 1] = top

verts[2::5, 0] = right

verts[2::5, 1] = top

verts[3::5, 0] = right

verts[3::5, 1] = bottom

barpath = <a href="../../api/path_api.html#matplotlib.path.Path" title="View documentation for matplotlib.path.Path">path.Path</a>(verts, codes)

patch = <a href="../../api/_as_gen/matplotlib.patches.PathPatch.html#matplotlib.patches.PathPatch" title="View documentation for matplotlib.patches.PathPatch">patches.PathPatch</a>(barpath, facecolor='green',

ax.add_patch(patch)

ax.set_xlim(left[0], right[-1])

ax.set_ylim(bottom.min(), top.max())

</pre></div>

</div>

Total running time of the script: ( 0 minutes 0.073 seconds)

<a class="reference download internal" href="../../_downloads/path_tutorial.py" download=""><code class="xref download docutils literal">Download Python source code: path_tutorial.py</code></a></div>

<a class="reference download internal" href="../../_downloads/path_tutorial.ipynb" download=""><code class="xref download docutils literal">Download Jupyter notebook: path_tutorial.ipynb</code></a></div>

</div>

<a class="reference external" href="https://sphinx-gallery.readthedocs.io">Generated by Sphinx-Gallery</a>

</div>

</div>

Last updated on Jul 16, 2017.

Created using <a

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

</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>

<!--Flipcause Integration v3.0// Flipcause Integration Instructions:

Install the following code block once in the website Header (after <head> tag) -->

<style>

.fc-black_overlay{

display:none; position: fixed; z-index:1000001; top: 0%;left: 0%;width: 100%;height: 100%;

background-color: black; filter: alpha(opacity=50); cursor:pointer; opacity:0.5;

}

.fc-white_content {

opacity:1; display:none; margin-top: -320px; margin-left: -485px; width:970px; height:640px;

position:fixed; top:50%; left:50%; border: none;z-index:1000002;overflow: auto;

}

.fc-main-box{

opacity:1; display:none; margin:15px auto 0 auto; width:930px; position:relative; z-index:1000003;

}

.fc-widget_close{

opacity:1; content:url(http://i1338.photobucket.com/albums/o691/WeCause/X_zpse4a7e538.png);

position:absolute; z-index=1000004; right:-16px; top:-16px; display:block; cursor:pointer;

}

.floating_button{

display: block; margin-top: 0px; margin-left: 0px; width:auto ; height: auto;

position:fixed; z-index:999999; overflow: auto;

}

@keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-moz-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-webkit-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-o-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-ms-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; transform: translateY(20px);}

100% {opacity: 1; transform: translateY(0);}

}

@-moz-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -moz-transform: translateY(20px);}

100% {opacity: 1; -moz-transform: translateY(0);}

}

@-webkit-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -webkit-transform: translateY(20px);}

100% {opacity: 1; -webkit-transform: translateY(0);}

}

@-o-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -o-transform: translateY(20px);}

100% {opacity: 1; -o-transform: translateY(0);}

}

@-ms-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -ms-transform: translateY(20px);}

100% {opacity: 1; -ms-transform: translateY(0);}

}

</style>

function open_window(cause_id) {

var protocol=String(document.location.protocol);

var new_url;

if( /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)){

new_url="https://www.flipcause.com/widget/"+cause_id

window.open(new_url);

}

else {

document.getElementById("fc-fade").style.display = "block";

document.getElementById("fc-fade").style.webkitAnimation = "backfadesin 1s";

document.getElementById("fc-fade").style.animation = "backfadesin 1s";

document.getElementById("fc-fade").style.mozAnimation = "backfadesin 1s";

document.getElementById("fc-light").style.display = "block";

document.getElementById("fc-light").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-light").style.animation = "fadesin 1.5s";

document.getElementById("fc-light").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.display = "block";

document.getElementById("fc-main").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.animation = "fadesin 1.5s";

document.getElementById("fc-main").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.display = "block";

document.getElementById("fc-close").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.animation = "fadesin 1.5s";

document.getElementById("fc-close").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.display = "block";

document.getElementById("fc-myFrame").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.animation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").src="https://www.flipcause.com/widget/"+cause_id;

}

function close_window() {

document.getElementById("fc-fade").style.display="none";

document.getElementById("fc-light").style.display="none";

document.getElementById("fc-main").style.display="none";

document.getElementById("fc-close").style.display="none";

document.getElementById("fc-myFrame").style.display="none";

}

</script>

</div><iframe id="fc-myFrame" iframe height="580" width="925" style="border: 0;

border-radius:5px 5px 5px 5px; box-shadow:0 0 8px rgba(0, 0, 0, 0.5);" scrolling="no" src=""></iframe></div>

</div>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

path_tutorial.html

Latest commit

History

path_tutorial.html

File metadata and controls