matplotlib.github.com/3.3.1/api/path_api.html at main · matplotlib/matplotlib.github.com

History

762 lines (699 loc) · 63.2 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

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

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

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

<head>

<title>matplotlib.path — Matplotlib 3.3.1 documentation</title>

title="Search within Matplotlib 3.3.1 documentation"

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

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.1). For the latest version see <a href="https://matplotlib.org/stable/api/path_api.html">https://matplotlib.org/stable/api/path_api.html</a></div>

<!--

</div>

-->

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

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

</div>

<ul>

<li><a href="../users/installing.html">Installation</a></li>

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

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

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

<li><a href="../devel/index.html">Contributing</a></li>

</form>

</li>

</ul>

</nav>

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

<a href="patheffects_api.html" title="matplotlib.patheffects"

accesskey="N">next</a> |</li>

<a href="_as_gen/matplotlib.patches.draw_bbox.html" title="matplotlib.patches.draw_bbox"

accesskey="P">previous</a> |</li>

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

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>

<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate">matplotlib.path</code></a></li>

</ul>

</div>

<h3>Related Topics</h3>

<ul>

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

<li><a href="index.html">API Overview</a><ul>

<li>Previous: <a href="_as_gen/matplotlib.patches.draw_bbox.html" title="previous chapter">matplotlib.patches.draw_bbox</a></li>

<li>Next: <a href="patheffects_api.html" title="next chapter"><code class="docutils literal notranslate">matplotlib.patheffects</code></a></li>

</ul></li>

</ul>

</div>

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../_sources/api/path_api.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

<h1><code class="docutils literal notranslate">matplotlib.path</code><a class="headerlink" href="#module-matplotlib.path" title="Permalink to this headline">¶</a></h1>

A module for dealing with the polylines used throughout Matplotlib.

The primary class for polyline handling in Matplotlib is <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a>. Almost all

vector drawing makes use of <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a>s somewhere in the drawing pipeline.

Whilst a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> instance itself cannot be drawn, some <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate">Artist</code></a> subclasses,

such as <a class="reference internal" href="_as_gen/matplotlib.patches.PathPatch.html#matplotlib.patches.PathPatch" title="matplotlib.patches.PathPatch"><code class="xref py py-obj docutils literal notranslate">PathPatch</code></a> and <a class="reference internal" href="collections_api.html#matplotlib.collections.PathCollection" title="matplotlib.collections.PathCollection"><code class="xref py py-obj docutils literal notranslate">PathCollection</code></a>, can be used for convenient <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a>

visualisation.

class <code class="descclassname">matplotlib.path.</code><code class="descname">Path</code>(vertices, codes=None, _interpolation_steps=1, closed=False, readonly=False)<a class="reference internal" href="../_modules/matplotlib/path.html#Path">[source]</a><a class="headerlink" href="#matplotlib.path.Path" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate">object</code></a>

A series of possibly disconnected, possibly closed, line and curve

segments.

The underlying storage is made up of two parallel numpy arrays:

<li>vertices: an Nx2 float array of vertices</li>

<li>codes: an N-length uint8 array of vertex types, or None</li>

</ul>

These two arrays always have the same length in the first

dimension. For example, to represent a cubic curve, you must

provide three vertices as well as three codes <code class="docutils literal notranslate">CURVE3</code>.

The code types are:

<dt><code class="docutils literal notranslate">STOP</code>1 vertex (ignored)</dt><dd>A marker for the end of the entire path (currently not required and

ignored)</dd>

</dl>

</li>

<dt><code class="docutils literal notranslate">MOVETO</code>1 vertex</dt><dd>Pick up the pen and move to the given vertex.</dd>

</dl>

</li>

<dt><code class="docutils literal notranslate">LINETO</code>1 vertex</dt><dd>Draw a line from the current position to the given vertex.</dd>

</dl>

</li>

<dt><code class="docutils literal notranslate">CURVE3</code>1 control point, 1 endpoint</dt><dd>Draw a quadratic Bezier curve from the current position, with the given

control point, to the given end point.</dd>

</dl>

</li>

<dt><code class="docutils literal notranslate">CURVE4</code>2 control points, 1 endpoint</dt><dd>Draw a cubic Bezier curve from the current position, with the given

control points, to the given end point.</dd>

</dl>

</li>

<dt><code class="docutils literal notranslate">CLOSEPOLY</code>1 vertex (ignored)</dt><dd>Draw a line segment to the start point of the current polyline.</dd>

</dl>

</li>

</ul>

If codes is None, it is interpreted as a <code class="docutils literal notranslate">MOVETO</code> followed by a series

of <code class="docutils literal notranslate">LINETO</code>.

Users of Path objects should not access the vertices and codes arrays

directly. Instead, they should use <a class="reference internal" href="#matplotlib.path.Path.iter_segments" title="matplotlib.path.Path.iter_segments"><code class="xref py py-obj docutils literal notranslate">iter_segments</code></a> or <a class="reference internal" href="#matplotlib.path.Path.cleaned" title="matplotlib.path.Path.cleaned"><code class="xref py py-obj docutils literal notranslate">cleaned</code></a> to get the

vertex/code pairs. This helps, in particular, to consistently handle the

case of codes being None.

Some behavior of Path objects can be controlled by rcParams. See the

rcParams whose keys start with 'path.'.

Note

The vertices and codes arrays should be treated as

immutable -- there are a number of optimizations and assumptions

made up front in the constructor that will not change when the

data changes.

</div>

Create a new path with the given vertices and codes.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>verticesarray-like</dt><dd>The <code class="docutils literal notranslate">(N, 2)</code> float array, masked array or sequence of pairs

representing the vertices of the path.

If vertices contains masked values, they will be converted

to NaNs which are then handled correctly by the Agg

PathIterator and other consumers of path data, such as

<a class="reference internal" href="#matplotlib.path.Path.iter_segments" title="matplotlib.path.Path.iter_segments"><code class="xref py py-meth docutils literal notranslate">iter_segments()</code></a>.

</dd>

<dt>codesarray-like or None, optional</dt><dd>n-length array integers representing the codes of the path.

If not None, codes must be the same length as vertices.

If None, vertices will be treated as a series of line segments.

</dd>

<dt>_interpolation_stepsint, optional</dt><dd>Used as a hint to certain projections, such as Polar, that this

path should be linearly interpolated immediately before drawing.

This attribute is primarily an implementation detail and is not

intended for public use.

</dd>

<dt>closedbool, optional</dt><dd>If codes is None and closed is True, vertices will be treated as

line segments of a closed polygon. Note that the last vertex will

then be ignored (as the corresponding code will be set to

CLOSEPOLY).

</dd>

<dt>readonlybool, optional</dt><dd>Makes the path behave in an immutable way and sets the vertices

and codes as read-only arrays.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

<code class="descname">CLOSEPOLY</code> = 79<a class="headerlink" href="#matplotlib.path.Path.CLOSEPOLY" title="Permalink to this definition">¶</a></dt>

<code class="descname">CURVE3</code> = 3<a class="headerlink" href="#matplotlib.path.Path.CURVE3" title="Permalink to this definition">¶</a></dt>

<code class="descname">CURVE4</code> = 4<a class="headerlink" href="#matplotlib.path.Path.CURVE4" title="Permalink to this definition">¶</a></dt>

<code class="descname">LINETO</code> = 2<a class="headerlink" href="#matplotlib.path.Path.LINETO" title="Permalink to this definition">¶</a></dt>

<code class="descname">MOVETO</code> = 1<a class="headerlink" href="#matplotlib.path.Path.MOVETO" title="Permalink to this definition">¶</a></dt>

<code class="descname">NUM_VERTICES_FOR_CODE</code> = {0: 1, 1: 1, 2: 1, 3: 2, 4: 3, 79: 1}<a class="headerlink" href="#matplotlib.path.Path.NUM_VERTICES_FOR_CODE" title="Permalink to this definition">¶</a></dt>

<dd>A dictionary mapping Path codes to the number of vertices that the

code expects.

</dd></dl>

classmethod <code class="descname">arc</code>(theta1, theta2, n=None, is_wedge=False)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.arc">[source]</a><a class="headerlink" href="#matplotlib.path.Path.arc" title="Permalink to this definition">¶</a></dt>

<dd>Return the unit circle arc from angles theta1 to theta2 (in

degrees).

theta2 is unwrapped to produce the shortest arc within 360 degrees.

That is, if theta2 > theta1 + 360, the arc will be from theta1 to

theta2 - 360 and not a full circle plus some extra overlap.

If n is provided, it is the number of spline segments to make.

If n is not provided, the number of spline segments is

determined based on the delta between theta1 and theta2.

<div>Masionobe, L. 2003. <a class="reference external" href="http://www.spaceroots.org/documents/ellipse/index.html">Drawing an elliptical arc using

polylines, quadratic or cubic Bezier curves</a>.</div></blockquote>

</dd></dl>

classmethod <code class="descname">circle</code>(center=0.0, 0.0, radius=1.0, readonly=False)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.circle">[source]</a><a class="headerlink" href="#matplotlib.path.Path.circle" title="Permalink to this definition">¶</a></dt>

<dd>Return a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> representing a circle of a given radius and center.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>center(float, float), default: (0, 0)</dt><dd>The center of the circle.

</dd>

<dt>radiusfloat, default: 1</dt><dd>The radius of the circle.

</dd>

<dt>readonlybool</dt><dd>Whether the created path should have the "readonly" argument

set when creating the Path instance.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

The circle is approximated using 8 cubic Bezier curves, as described in

<div>Lancaster, Don. <a class="reference external" href="https://www.tinaja.com/glib/ellipse4.pdf">Approximating a Circle or an Ellipse Using Four

Bezier Cubic Splines</a>.</div></blockquote>

</dd></dl>

<code class="descname">cleaned</code>(self, transform=None, remove_nans=False, clip=None, quantize=<deprecated parameter>, simplify=False, curves=False, stroke_width=1.0, snap=False, sketch=None)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.cleaned">[source]</a><a class="headerlink" href="#matplotlib.path.Path.cleaned" title="Permalink to this definition">¶</a></dt>

<dd>Return a new Path with vertices and codes cleaned according to the

parameters.

See also

<dt><a class="reference internal" href="#matplotlib.path.Path.iter_segments" title="matplotlib.path.Path.iter_segments"><code class="xref py py-obj docutils literal notranslate">Path.iter_segments</code></a></dt><dd>for details of the keyword arguments.</dd>

</dl>

</div>

</dd></dl>

<code class="descname">clip_to_bbox</code>(self, bbox, inside=True)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.clip_to_bbox">[source]</a><a class="headerlink" href="#matplotlib.path.Path.clip_to_bbox" title="Permalink to this definition">¶</a></dt>

<dd>Clip the path to the given bounding box.

The path must be made up of one or more closed polygons. This

algorithm will not behave correctly for unclosed paths.

If inside is <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate">True</code></a>, clip to the inside of the box, otherwise

to the outside of the box.

</dd></dl>

<dd>alias of <code class="xref py py-class docutils literal notranslate">numpy.uint8</code>

</dd></dl>

property <code class="descname">codes</code><a class="headerlink" href="#matplotlib.path.Path.codes" title="Permalink to this definition">¶</a></dt>

<dd>The list of codes in the <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> as a 1-D numpy array. Each

code is one of <a class="reference internal" href="#matplotlib.path.Path.STOP" title="matplotlib.path.Path.STOP"><code class="xref py py-obj docutils literal notranslate">STOP</code></a>, <a class="reference internal" href="#matplotlib.path.Path.MOVETO" title="matplotlib.path.Path.MOVETO"><code class="xref py py-obj docutils literal notranslate">MOVETO</code></a>, <a class="reference internal" href="#matplotlib.path.Path.LINETO" title="matplotlib.path.Path.LINETO"><code class="xref py py-obj docutils literal notranslate">LINETO</code></a>, <a class="reference internal" href="#matplotlib.path.Path.CURVE3" title="matplotlib.path.Path.CURVE3"><code class="xref py py-obj docutils literal notranslate">CURVE3</code></a>, <a class="reference internal" href="#matplotlib.path.Path.CURVE4" title="matplotlib.path.Path.CURVE4"><code class="xref py py-obj docutils literal notranslate">CURVE4</code></a>

or <a class="reference internal" href="#matplotlib.path.Path.CLOSEPOLY" title="matplotlib.path.Path.CLOSEPOLY"><code class="xref py py-obj docutils literal notranslate">CLOSEPOLY</code></a>. For codes that correspond to more than one

vertex (<a class="reference internal" href="#matplotlib.path.Path.CURVE3" title="matplotlib.path.Path.CURVE3"><code class="xref py py-obj docutils literal notranslate">CURVE3</code></a> and <a class="reference internal" href="#matplotlib.path.Path.CURVE4" title="matplotlib.path.Path.CURVE4"><code class="xref py py-obj docutils literal notranslate">CURVE4</code></a>), that code will be repeated so

that the length of <code class="xref py py-obj docutils literal notranslate">self.vertices</code> and <code class="xref py py-obj docutils literal notranslate">self.codes</code> is always

the same.

</dd></dl>

<code class="descname">contains_path</code>(self, path, transform=None)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.contains_path">[source]</a><a class="headerlink" href="#matplotlib.path.Path.contains_path" title="Permalink to this definition">¶</a></dt>

<dd>Return whether this (closed) path completely contains the given path.

If transform is not <code class="docutils literal notranslate">None</code>, the path will be transformed before

checking for containment.

</dd></dl>

<code class="descname">contains_point</code>(self, point, transform=None, radius=0.0)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.contains_point">[source]</a><a class="headerlink" href="#matplotlib.path.Path.contains_point" title="Permalink to this definition">¶</a></dt>

<dd>Return whether the (closed) path contains the given point.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>point(float, float)</dt><dd>The point (x, y) to check.

</dd>

<dt>transform<a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate">matplotlib.transforms.Transform</code></a>, optional</dt><dd>If not <code class="docutils literal notranslate">None</code>, point will be compared to <code class="docutils literal notranslate">self</code> transformed

by transform; i.e. for a correct check, transform should

transform the path into the coordinate system of point.

</dd>

<dt>radiusfloat, default: 0</dt><dd>Add an additional margin on the path in coordinates of point.

The path is extended tangentially by radius/2; i.e. if you would

draw the path with a linewidth of radius, all points on the line

would still be considered to be contained in the area. Conversely,

negative values shrink the area: Points on the imaginary line

will be considered outside the area.

</dd>

</dl>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">contains_points</code>(self, points, transform=None, radius=0.0)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.contains_points">[source]</a><a class="headerlink" href="#matplotlib.path.Path.contains_points" title="Permalink to this definition">¶</a></dt>

<dd>Return whether the (closed) path contains the given point.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>points(N, 2) array</dt><dd>The points to check. Columns contain x and y values.

</dd>

<dt>transform<a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate">matplotlib.transforms.Transform</code></a>, optional</dt><dd>If not <code class="docutils literal notranslate">None</code>, points will be compared to <code class="docutils literal notranslate">self</code> transformed

by transform; i.e. for a correct check, transform should

transform the path into the coordinate system of points.

</dd>

<dt>radiusfloat, default: 0.</dt><dd>Add an additional margin on the path in coordinates of points.

The path is extended tangentially by radius/2; i.e. if you would

draw the path with a linewidth of radius, all points on the line

would still be considered to be contained in the area. Conversely,

negative values shrink the area: Points on the imaginary line

will be considered outside the area.

</dd>

</dl>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt>length-N bool array</dt><dd></dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<dd>Return a shallow copy of the <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a>, which will share the

vertices and codes with the source <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a>.

</dd></dl>

<code class="descname">deepcopy</code>(self, memo=None)<a class="headerlink" href="#matplotlib.path.Path.deepcopy" title="Permalink to this definition">¶</a></dt>

<dd>Return a deepcopy of the <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a>. The <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> will not be

readonly, even if the source <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> is.

</dd></dl>

<code class="descname">get_extents</code>(self, transform=None, **kwargs)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.get_extents">[source]</a><a class="headerlink" href="#matplotlib.path.Path.get_extents" title="Permalink to this definition">¶</a></dt>

<dd>Get Bbox of the path.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>transformmatplotlib.transforms.Transform, optional</dt><dd>Transform to apply to path before computing extents, if any.

</dd>

<dt>**kwargs</dt><dd>Forwarded to <a class="reference internal" href="#matplotlib.path.Path.iter_bezier" title="matplotlib.path.Path.iter_bezier"><code class="xref py py-obj docutils literal notranslate">iter_bezier</code></a>.

</dd>

</dl>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt>matplotlib.transforms.Bbox</dt><dd>The extents of the path Bbox([[xmin, ymin], [xmax, ymax]])

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

static <code class="descname">hatch</code>(hatchpattern, density=6)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.hatch">[source]</a><a class="headerlink" href="#matplotlib.path.Path.hatch" title="Permalink to this definition">¶</a></dt>

<dd>Given a hatch specifier, hatchpattern, generates a Path that

can be used in a repeated hatching pattern. density is the

number of lines per unit square.

</dd></dl>

<code class="descname">interpolated</code>(self, steps)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.interpolated">[source]</a><a class="headerlink" href="#matplotlib.path.Path.interpolated" title="Permalink to this definition">¶</a></dt>

<dd>Return a new path resampled to length N x steps.

Codes other than LINETO are not handled correctly.

</dd></dl>

<code class="descname">intersects_bbox</code>(self, bbox, filled=True)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.intersects_bbox">[source]</a><a class="headerlink" href="#matplotlib.path.Path.intersects_bbox" title="Permalink to this definition">¶</a></dt>

<dd>Return whether this path intersects a given <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate">Bbox</code></a>.

If filled is True, then this also returns True if the path completely

encloses the <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate">Bbox</code></a> (i.e., the path is treated as filled).

The bounding box is always considered filled.

</dd></dl>

<code class="descname">intersects_path</code>(self, other, filled=True)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.intersects_path">[source]</a><a class="headerlink" href="#matplotlib.path.Path.intersects_path" title="Permalink to this definition">¶</a></dt>

<dd>Return whether if this path intersects another given path.

If filled is True, then this also returns True if one path completely

encloses the other (i.e., the paths are treated as filled).

</dd></dl>

<code class="descname">iter_bezier</code>(self, **kwargs)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.iter_bezier">[source]</a><a class="headerlink" href="#matplotlib.path.Path.iter_bezier" title="Permalink to this definition">¶</a></dt>

<dd>Iterate over each bezier curve (lines included) in a Path.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>**kwargs</dt><dd>Forwarded to <a class="reference internal" href="#matplotlib.path.Path.iter_segments" title="matplotlib.path.Path.iter_segments"><code class="xref py py-obj docutils literal notranslate">iter_segments</code></a>.

</dd>

</dl>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Yields:</th><td class="field-body"><dl class="first last docutils">

<dt>Bmatplotlib.bezier.BezierSegment</dt><dd>The bezier curves that make up the current path. Note in particular

that freestanding points are bezier curves of order 0, and lines

are bezier curves of order 1 (with two control points).

</dd>

<dt>codePath.code_type</dt><dd>The code describing what kind of curve is being returned.

Path.MOVETO, Path.LINETO, Path.CURVE3, Path.CURVE4 correspond to

bezier curves with 1, 2, 3, and 4 control points (respectively).

Path.CLOSEPOLY is a Path.LINETO with the control points correctly

chosen based on the start/end points of the current stroke.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">iter_segments</code>(self, transform=None, remove_nans=True, clip=None, snap=False, stroke_width=1.0, simplify=None, curves=True, sketch=None)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.iter_segments">[source]</a><a class="headerlink" href="#matplotlib.path.Path.iter_segments" title="Permalink to this definition">¶</a></dt>

<dd>Iterate over all curve segments in the path.

Each iteration returns a pair <code class="docutils literal notranslate">(vertices, code)</code>, where <code class="docutils literal notranslate">vertices</code>

is a sequence of 1-3 coordinate pairs, and <code class="docutils literal notranslate">code</code> is a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> code.

Additionally, this method can provide a number of standard cleanups and

conversions to the path.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>transformNone or <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal notranslate">Transform</code></a></dt><dd>If not None, the given affine transformation will be applied to the

path.

</dd>

<dt>remove_nansbool, optional</dt><dd>Whether to remove all NaNs from the path and skip over them using

MOVETO commands.

</dd>

<dt>clipNone or (float, float, float, float), optional</dt><dd>If not None, must be a four-tuple (x1, y1, x2, y2)

defining a rectangle in which to clip the path.

</dd>

<dt>snapNone or bool, optional</dt><dd>If True, snap all nodes to pixels; if False, don't snap them.

If None, snap if the path contains only segments

parallel to the x or y axes, and no more than 1024 of them.

</dd>

<dt>stroke_widthfloat, optional</dt><dd>The width of the stroke being drawn (used for path snapping).

</dd>

<dt>simplifyNone or bool, optional</dt><dd>Whether to simplify the path by removing vertices

that do not affect its appearance. If None, use the

<a class="reference internal" href="#matplotlib.path.Path.should_simplify" title="matplotlib.path.Path.should_simplify"><code class="xref py py-attr docutils literal notranslate">should_simplify</code></a> attribute. See also <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=path.simplify#a-sample-matplotlibrc-file">rcParams["path.simplify"]</a></code> (default: <code class="docutils literal notranslate">True</code>)

and <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=path.simplify_threshold#a-sample-matplotlibrc-file">rcParams["path.simplify_threshold"]</a></code> (default: <code class="docutils literal notranslate">0.111111111111</code>).

</dd>

<dt>curvesbool, optional</dt><dd>If True, curve segments will be returned as curve segments.

If False, all curves will be converted to line segments.

</dd>

<dt>sketchNone or sequence, optional</dt><dd>If not None, must be a 3-tuple of the form

(scale, length, randomness), representing the sketch parameters.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

classmethod <code class="descname">make_compound_path</code>(*args)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.make_compound_path">[source]</a><a class="headerlink" href="#matplotlib.path.Path.make_compound_path" title="Permalink to this definition">¶</a></dt>

<dd>Make a compound path from a list of Path objects. Blindly removes all

Path.STOP control points.

</dd></dl>

classmethod <code class="descname">make_compound_path_from_polys</code>(XY)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.make_compound_path_from_polys">[source]</a><a class="headerlink" href="#matplotlib.path.Path.make_compound_path_from_polys" title="Permalink to this definition">¶</a></dt>

<dd>Make a compound path object to draw a number

of polygons with equal numbers of sides XY is a (numpolys x

numsides x 2) numpy array of vertices. Return object is a

(<a class="reference external" href="../gallery/misc/histogram_path.py">Source code</a>, <a class="reference external" href="../gallery/misc/histogram_path_00_00.png">png</a>, <a class="reference external" href="../gallery/misc/histogram_path_00_00.pdf">pdf</a>)

</div>

</dd></dl>

property <code class="descname">readonly</code><a class="headerlink" href="#matplotlib.path.Path.readonly" title="Permalink to this definition">¶</a></dt>

<dd><a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate">True</code></a> if the <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> is read-only.

</dd></dl>

property <code class="descname">should_simplify</code><a class="headerlink" href="#matplotlib.path.Path.should_simplify" title="Permalink to this definition">¶</a></dt>

</dd></dl>

property <code class="descname">simplify_threshold</code><a class="headerlink" href="#matplotlib.path.Path.simplify_threshold" title="Permalink to this definition">¶</a></dt>

<dd>The fraction of a pixel difference below which vertices will

be simplified out.

</dd></dl>

<code class="descname">to_polygons</code>(self, transform=None, width=0, height=0, closed_only=True)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.to_polygons">[source]</a><a class="headerlink" href="#matplotlib.path.Path.to_polygons" title="Permalink to this definition">¶</a></dt>

<dd>Convert this path to a list of polygons or polylines. Each

polygon/polyline is an Nx2 array of vertices. In other words,

each polygon has no <code class="docutils literal notranslate">MOVETO</code> instructions or curves. This

is useful for displaying in backends that do not support

compound paths or Bezier curves.

If width and height are both non-zero then the lines will

be simplified so that vertices outside of (0, 0), (width,

height) will be clipped.

If closed_only is <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate">True</code></a> (default), only closed polygons,

with the last point being the same as the first point, will be

returned. Any unclosed polylines in the path will be

explicitly closed. If closed_only is <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate">False</code></a>, any unclosed

polygons in the path will be returned as unclosed polygons,

and the closed polygons will be returned explicitly closed by

setting the last point to the same as the first point.

</dd></dl>

<code class="descname">transformed</code>(self, transform)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.transformed">[source]</a><a class="headerlink" href="#matplotlib.path.Path.transformed" title="Permalink to this definition">¶</a></dt>

<dd>Return a transformed copy of the path.

See also

<dt><a class="reference internal" href="transformations.html#matplotlib.transforms.TransformedPath" title="matplotlib.transforms.TransformedPath"><code class="xref py py-obj docutils literal notranslate">matplotlib.transforms.TransformedPath</code></a></dt><dd>A specialized path class that will cache the transformed result and automatically update when the transform changes.</dd>

</dl>

</div>

</dd></dl>

classmethod <code class="descname">unit_circle</code>()<a class="reference internal" href="../_modules/matplotlib/path.html#Path.unit_circle">[source]</a><a class="headerlink" href="#matplotlib.path.Path.unit_circle" title="Permalink to this definition">¶</a></dt>

<dd>Return the readonly <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal notranslate">Path</code></a> of the unit circle.

For most cases, <a class="reference internal" href="#matplotlib.path.Path.circle" title="matplotlib.path.Path.circle"><code class="xref py py-func docutils literal notranslate">Path.circle()</code></a> will be what you want.

</dd></dl>

classmethod <code class="descname">unit_circle_righthalf</code>()<a class="reference internal" href="../_modules/matplotlib/path.html#Path.unit_circle_righthalf">[source]</a><a class="headerlink" href="#matplotlib.path.Path.unit_circle_righthalf" title="Permalink to this definition">¶</a></dt>

See <a class="reference internal" href="#matplotlib.path.Path.circle" title="matplotlib.path.Path.circle"><code class="xref py py-obj docutils literal notranslate">Path.circle</code></a> for the reference on the approximation used.

</dd></dl>

classmethod <code class="descname">unit_rectangle</code>()<a class="reference internal" href="../_modules/matplotlib/path.html#Path.unit_rectangle">[source]</a><a class="headerlink" href="#matplotlib.path.Path.unit_rectangle" title="Permalink to this definition">¶</a></dt>

<dd>Return a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> instance of the unit rectangle from (0, 0) to (1, 1).

</dd></dl>

classmethod <code class="descname">unit_regular_asterisk</code>(numVertices)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.unit_regular_asterisk">[source]</a><a class="headerlink" href="#matplotlib.path.Path.unit_regular_asterisk" title="Permalink to this definition">¶</a></dt>

<dd>Return a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal notranslate">Path</code></a> for a unit regular asterisk with the given

numVertices and radius of 1.0, centered at (0, 0).

</dd></dl>

classmethod <code class="descname">unit_regular_polygon</code>(numVertices)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.unit_regular_polygon">[source]</a><a class="headerlink" href="#matplotlib.path.Path.unit_regular_polygon" title="Permalink to this definition">¶</a></dt>

given numVertices such that the circumscribing circle has radius 1.0,

centered at (0, 0).

</dd></dl>

classmethod <code class="descname">unit_regular_star</code>(numVertices, innerCircle=0.5)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.unit_regular_star">[source]</a><a class="headerlink" href="#matplotlib.path.Path.unit_regular_star" title="Permalink to this definition">¶</a></dt>

numVertices and radius of 1.0, centered at (0, 0).

</dd></dl>

property <code class="descname">vertices</code><a class="headerlink" href="#matplotlib.path.Path.vertices" title="Permalink to this definition">¶</a></dt>

<dd>The list of vertices in the <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> as an Nx2 numpy array.

</dd></dl>

classmethod <code class="descname">wedge</code>(theta1, theta2, n=None)<a class="reference internal" href="../_modules/matplotlib/path.html#Path.wedge">[source]</a><a class="headerlink" href="#matplotlib.path.Path.wedge" title="Permalink to this definition">¶</a></dt>

<dd>Return the unit circle wedge from angles theta1 to theta2 (in

degrees).

theta2 is unwrapped to produce the shortest wedge within 360 degrees.

That is, if theta2 > theta1 + 360, the wedge will be from theta1

to theta2 - 360 and not a full circle plus some extra overlap.

If n is provided, it is the number of spline segments to make.

If n is not provided, the number of spline segments is

determined based on the delta between theta1 and theta2.

See <a class="reference internal" href="#matplotlib.path.Path.arc" title="matplotlib.path.Path.arc"><code class="xref py py-obj docutils literal notranslate">Path.arc</code></a> for the reference on the approximation used.

</dd></dl>

<code class="descclassname">matplotlib.path.</code><code class="descname">get_path_collection_extents</code>(master_transform, paths, transforms, offsets, offset_transform)<a class="reference internal" href="../_modules/matplotlib/path.html#get_path_collection_extents">[source]</a><a class="headerlink" href="#matplotlib.path.get_path_collection_extents" title="Permalink to this definition">¶</a></dt>

<dd>Given a sequence of <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a>s, <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate">Transform</code></a>s objects, and offsets, as

found in a <a class="reference internal" href="collections_api.html#matplotlib.collections.PathCollection" title="matplotlib.collections.PathCollection"><code class="xref py py-obj docutils literal notranslate">PathCollection</code></a>, returns the bounding box that encapsulates

all of them.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>master_transform<a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate">Transform</code></a></dt><dd>Global transformation applied to all paths.

</dd>

<dt>pathslist of <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a></dt><dd></dd>

<dt>transformslist of <a class="reference internal" href="transformations.html#matplotlib.transforms.Affine2D" title="matplotlib.transforms.Affine2D"><code class="xref py py-obj docutils literal notranslate">Affine2D</code></a></dt><dd></dd>

<dt>offsets(N, 2) array-like</dt><dd></dd>

<dt>offset_transform<a class="reference internal" href="transformations.html#matplotlib.transforms.Affine2D" title="matplotlib.transforms.Affine2D"><code class="xref py py-obj docutils literal notranslate">Affine2D</code></a></dt><dd>Transform applied to the offsets before offsetting the path.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

The way that paths, transforms and offsets are combined

follows the same method as for collections: Each is iterated over

independently, so if you have 3 paths, 2 transforms and 1 offset,

their combinations are as follows:

</dd></dl>

</div>

</div>

Last updated on Aug 14, 2020.

Created using

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

Doc version v3.3.1-2-ge49322daa.

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

path_api.html

Latest commit

History

path_api.html

File metadata and controls