-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathpath_api.html
More file actions
817 lines (749 loc) · 50.7 KB
/
path_api.html
File metadata and controls
817 lines (749 loc) · 50.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>path — Matplotlib 1.3.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.3.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 1.3.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.3.0 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="pyplot" href="pyplot_api.html" />
<link rel="prev" title="mlab" href="mlab_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/path_api.html" />
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v1.3.0). 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>
<!-- Piwik -->
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
}
</script>
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
piwik_action_name = '';
piwik_idsite = 1;
piwik_url = pkBaseURL + "piwik.php";
piwik_log(piwik_action_name, piwik_idsite, piwik_url);
document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));
}
</script>
<!-- End Piwik Tag -->
<link rel="shortcut icon" href="_static/favicon.ico">
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.png" border="0" alt="matplotlib"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyplot_api.html" title="pyplot"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="mlab_api.html" title="mlab"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">path</a><ul>
<li><a class="reference internal" href="#module-matplotlib.path"><tt class="docutils literal"><span class="pre">matplotlib.path</span></tt></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="mlab_api.html"
title="previous chapter">mlab</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pyplot_api.html"
title="next chapter">pyplot</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/path_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="path">
<h1>path<a class="headerlink" href="#path" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.path">
<span id="matplotlib-path"></span><h2><a class="reference internal" href="#module-matplotlib.path" title="matplotlib.path"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.path</span></tt></a><a class="headerlink" href="#module-matplotlib.path" title="Permalink to this headline">¶</a></h2>
<p>A module for dealing with the polylines used throughout matplotlib.</p>
<p>The primary class for polyline handling in matplotlib is <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a>.
Almost all vector drawing makes use of Paths somewhere in the drawing
pipeline.</p>
<p>Whilst a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> instance itself cannot be drawn, there exists
<a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">Artist</span></tt></a> subclasses which can be used for
convenient Path visualisation - the two most frequently used of these are
<a class="reference internal" href="artist_api.html#matplotlib.patches.PathPatch" title="matplotlib.patches.PathPatch"><tt class="xref py py-class docutils literal"><span class="pre">PathPatch</span></tt></a> and
<a class="reference internal" href="collections_api.html#matplotlib.collections.PathCollection" title="matplotlib.collections.PathCollection"><tt class="xref py py-class docutils literal"><span class="pre">PathCollection</span></tt></a>.</p>
<dl class="class">
<dt id="matplotlib.path.Path">
<em class="property">class </em><tt class="descclassname">matplotlib.path.</tt><tt class="descname">Path</tt><big>(</big><em>vertices</em>, <em>codes=None</em>, <em>_interpolation_steps=1</em>, <em>closed=False</em>, <em>readonly=False</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p><a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> represents a series of possibly disconnected,
possibly closed, line and curve segments.</p>
<dl class="docutils">
<dt>The underlying storage is made up of two parallel numpy arrays:</dt>
<dd><ul class="first last simple">
<li><em>vertices</em>: an Nx2 float array of vertices</li>
<li><em>codes</em>: an N-length uint8 array of vertex types</li>
</ul>
</dd>
</dl>
<p>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 <tt class="docutils literal"><span class="pre">CURVE3</span></tt>.</p>
<p>The code types are:</p>
<blockquote>
<div><ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">STOP</span></tt> <span class="classifier-delimiter">:</span> <span class="classifier">1 vertex (ignored)</span></dt>
<dd><p class="first last">A marker for the end of the entire path (currently not
required and ignored)</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">MOVETO</span></tt> <span class="classifier-delimiter">:</span> <span class="classifier">1 vertex</span></dt>
<dd><p class="first last">Pick up the pen and move to the given vertex.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">LINETO</span></tt> <span class="classifier-delimiter">:</span> <span class="classifier">1 vertex</span></dt>
<dd><p class="first last">Draw a line from the current position to the given vertex.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">CURVE3</span></tt> <span class="classifier-delimiter">:</span> <span class="classifier">1 control point, 1 endpoint</span></dt>
<dd><p class="first last">Draw a quadratic Bezier curve from the current position,
with the given control point, to the given end point.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">CURVE4</span></tt> <span class="classifier-delimiter">:</span> <span class="classifier">2 control points, 1 endpoint</span></dt>
<dd><p class="first last">Draw a cubic Bezier curve from the current position, with
the given control points, to the given end point.</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">CLOSEPOLY</span></tt> <span class="classifier-delimiter">:</span> <span class="classifier">1 vertex (ignored)</span></dt>
<dd><p class="first last">Draw a line segment to the start point of the current
polyline.</p>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
<p>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"><tt class="xref py py-meth docutils literal"><span class="pre">iter_segments()</span></tt></a>
or <a class="reference internal" href="#matplotlib.path.Path.cleaned" title="matplotlib.path.Path.cleaned"><tt class="xref py py-meth docutils literal"><span class="pre">cleaned()</span></tt></a> to get the vertex/code pairs. This is important,
since many <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> objects, as an optimization, do not store a
<em>codes</em> at all, but have a default one provided for them by
<a class="reference internal" href="#matplotlib.path.Path.iter_segments" title="matplotlib.path.Path.iter_segments"><tt class="xref py py-meth docutils literal"><span class="pre">iter_segments()</span></tt></a>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">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.</p>
</div>
<p>Create a new path with the given vertices and codes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters :</th><td class="field-body"><p class="first"><strong>vertices</strong> : array_like</p>
<blockquote>
<div><p>The <tt class="docutils literal"><span class="pre">(n,</span> <span class="pre">2)</span></tt> float array, masked array or sequence of pairs
representing the vertices of the path.</p>
<p>If <em>vertices</em> 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"><tt class="xref py py-meth docutils literal"><span class="pre">iter_segments()</span></tt></a>.</p>
</div></blockquote>
<p><strong>codes</strong> : {None, array_like}, optional</p>
<blockquote>
<div><p>n-length array integers representing the codes of the path.
If not None, codes must be the same length as vertices.
If None, <em>vertices</em> will be treated as a series of line segments.</p>
</div></blockquote>
<p><strong>_interpolation_steps</strong> : int, optional</p>
<blockquote>
<div><p>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.</p>
</div></blockquote>
<p><strong>closed</strong> : bool, optional</p>
<blockquote>
<div><p>If <em>codes</em> is None and closed is True, vertices will be treated as
line segments of a closed polygon.</p>
</div></blockquote>
<p><strong>readonly</strong> : bool, optional</p>
<blockquote class="last">
<div><p>Makes the path behave in an immutable way and sets the vertices
and codes as read-only arrays.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="matplotlib.path.Path.CLOSEPOLY">
<tt class="descname">CLOSEPOLY</tt><em class="property"> = 79</em><a class="headerlink" href="#matplotlib.path.Path.CLOSEPOLY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.CURVE3">
<tt class="descname">CURVE3</tt><em class="property"> = 3</em><a class="headerlink" href="#matplotlib.path.Path.CURVE3" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.CURVE4">
<tt class="descname">CURVE4</tt><em class="property"> = 4</em><a class="headerlink" href="#matplotlib.path.Path.CURVE4" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.LINETO">
<tt class="descname">LINETO</tt><em class="property"> = 2</em><a class="headerlink" href="#matplotlib.path.Path.LINETO" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.MOVETO">
<tt class="descname">MOVETO</tt><em class="property"> = 1</em><a class="headerlink" href="#matplotlib.path.Path.MOVETO" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.NUM_VERTICES_FOR_CODE">
<tt class="descname">NUM_VERTICES_FOR_CODE</tt><em class="property"> = {0: 1, 1: 1, 2: 1, 3: 2, 4: 3, 79: 1}</em><a class="headerlink" href="#matplotlib.path.Path.NUM_VERTICES_FOR_CODE" title="Permalink to this definition">¶</a></dt>
<dd><p>A dictionary mapping Path codes to the number of vertices that the
code expects.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.STOP">
<tt class="descname">STOP</tt><em class="property"> = 0</em><a class="headerlink" href="#matplotlib.path.Path.STOP" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="matplotlib.path.Path.arc">
<em class="property">classmethod </em><tt class="descname">arc</tt><big>(</big><em>theta1</em>, <em>theta2</em>, <em>n=None</em>, <em>is_wedge=False</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.arc" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an arc on the unit circle from angle
<em>theta1</em> to angle <em>theta2</em> (in degrees).</p>
<p>If <em>n</em> is provided, it is the number of spline segments to make.
If <em>n</em> is not provided, the number of spline segments is
determined based on the delta between <em>theta1</em> and <em>theta2</em>.</p>
<blockquote>
<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>
<dl class="method">
<dt id="matplotlib.path.Path.cleaned">
<tt class="descname">cleaned</tt><big>(</big><em>transform=None</em>, <em>remove_nans=False</em>, <em>clip=None</em>, <em>quantize=False</em>, <em>simplify=False</em>, <em>curves=False</em>, <em>stroke_width=1.0</em>, <em>snap=False</em>, <em>sketch=None</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.cleaned" title="Permalink to this definition">¶</a></dt>
<dd><p>Cleans up the path according to the parameters returning a new
Path instance.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">See <a class="reference internal" href="#matplotlib.path.Path.iter_segments" title="matplotlib.path.Path.iter_segments"><tt class="xref py py-meth docutils literal"><span class="pre">iter_segments()</span></tt></a> for details of the keyword arguments.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns :</th><td class="field-body"><strong>Path instance with cleaned up vertices and codes.</strong> :</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.clip_to_bbox">
<tt class="descname">clip_to_bbox</tt><big>(</big><em>bbox</em>, <em>inside=True</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.clip_to_bbox" title="Permalink to this definition">¶</a></dt>
<dd><p>Clip the path to the given bounding box.</p>
<p>The path must be made up of one or more closed polygons. This
algorithm will not behave correctly for unclosed paths.</p>
<p>If <em>inside</em> is <tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt>, clip to the inside of the box, otherwise
to the outside of the box.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.code_type">
<tt class="descname">code_type</tt><a class="headerlink" href="#matplotlib.path.Path.code_type" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">uint8</span></tt></p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.codes">
<tt class="descname">codes</tt><a class="headerlink" href="#matplotlib.path.Path.codes" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of codes in the <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-obj docutils literal"><span class="pre">Path</span></tt></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"><tt class="xref py py-obj docutils literal"><span class="pre">STOP</span></tt></a>, <a class="reference internal" href="#matplotlib.path.Path.MOVETO" title="matplotlib.path.Path.MOVETO"><tt class="xref py py-obj docutils literal"><span class="pre">MOVETO</span></tt></a>, <a class="reference internal" href="#matplotlib.path.Path.LINETO" title="matplotlib.path.Path.LINETO"><tt class="xref py py-obj docutils literal"><span class="pre">LINETO</span></tt></a>, <a class="reference internal" href="#matplotlib.path.Path.CURVE3" title="matplotlib.path.Path.CURVE3"><tt class="xref py py-obj docutils literal"><span class="pre">CURVE3</span></tt></a>, <a class="reference internal" href="#matplotlib.path.Path.CURVE4" title="matplotlib.path.Path.CURVE4"><tt class="xref py py-obj docutils literal"><span class="pre">CURVE4</span></tt></a>
or <a class="reference internal" href="#matplotlib.path.Path.CLOSEPOLY" title="matplotlib.path.Path.CLOSEPOLY"><tt class="xref py py-obj docutils literal"><span class="pre">CLOSEPOLY</span></tt></a>. For codes that correspond to more than one
vertex (<a class="reference internal" href="#matplotlib.path.Path.CURVE3" title="matplotlib.path.Path.CURVE3"><tt class="xref py py-obj docutils literal"><span class="pre">CURVE3</span></tt></a> and <a class="reference internal" href="#matplotlib.path.Path.CURVE4" title="matplotlib.path.Path.CURVE4"><tt class="xref py py-obj docutils literal"><span class="pre">CURVE4</span></tt></a>), that code will be repeated so
that the length of <tt class="xref py py-obj docutils literal"><span class="pre">self.vertices</span></tt> and <tt class="xref py py-obj docutils literal"><span class="pre">self.codes</span></tt> is always
the same.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.contains_path">
<tt class="descname">contains_path</tt><big>(</big><em>path</em>, <em>transform=None</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.contains_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns <em>True</em> if this path completely contains the given path.</p>
<p>If <em>transform</em> is not <em>None</em>, the path will be transformed
before performing the test.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.contains_point">
<tt class="descname">contains_point</tt><big>(</big><em>point</em>, <em>transform=None</em>, <em>radius=0.0</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.contains_point" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns <em>True</em> if the path contains the given point.</p>
<p>If <em>transform</em> is not <em>None</em>, the path will be transformed
before performing the test.</p>
<p><em>radius</em> allows the path to be made slightly larger or
smaller.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.contains_points">
<tt class="descname">contains_points</tt><big>(</big><em>points</em>, <em>transform=None</em>, <em>radius=0.0</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.contains_points" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a bool array which is <em>True</em> if the path contains the
corresponding point.</p>
<p>If <em>transform</em> is not <em>None</em>, the path will be transformed
before performing the test.</p>
<p><em>radius</em> allows the path to be made slightly larger or
smaller.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.copy">
<tt class="descname">copy</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.path.Path.copy" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a shallow copy of the <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-obj docutils literal"><span class="pre">Path</span></tt></a>, which will share the
vertices and codes with the source <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-obj docutils literal"><span class="pre">Path</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.deepcopy">
<tt class="descname">deepcopy</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.path.Path.deepcopy" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a deepcopy of the <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-obj docutils literal"><span class="pre">Path</span></tt></a>. The <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-obj docutils literal"><span class="pre">Path</span></tt></a> will not be
readonly, even if the source <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-obj docutils literal"><span class="pre">Path</span></tt></a> is.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.get_extents">
<tt class="descname">get_extents</tt><big>(</big><em>transform=None</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.get_extents" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the extents (<em>xmin</em>, <em>ymin</em>, <em>xmax</em>, <em>ymax</em>) of the
path.</p>
<p>Unlike computing the extents on the <em>vertices</em> alone, this
algorithm will take into account the curves and deal with
control points appropriately.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.has_nonfinite">
<tt class="descname">has_nonfinite</tt><a class="headerlink" href="#matplotlib.path.Path.has_nonfinite" title="Permalink to this definition">¶</a></dt>
<dd><p><tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt> if the vertices array has nonfinite values.</p>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.path.Path.hatch">
<em class="property">classmethod </em><tt class="descname">hatch</tt><big>(</big><em>hatchpattern</em>, <em>density=6</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.hatch" title="Permalink to this definition">¶</a></dt>
<dd><p>Given a hatch specifier, <em>hatchpattern</em>, generates a Path that
can be used in a repeated hatching pattern. <em>density</em> is the
number of lines per unit square.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.interpolated">
<tt class="descname">interpolated</tt><big>(</big><em>steps</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.interpolated" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a new path resampled to length N x steps. Does not
currently handle interpolating curves.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.intersects_bbox">
<tt class="descname">intersects_bbox</tt><big>(</big><em>bbox</em>, <em>filled=True</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.intersects_bbox" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns <em>True</em> if this path intersects a given
<a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><tt class="xref py py-class docutils literal"><span class="pre">Bbox</span></tt></a>.</p>
<p><em>filled</em>, when True, treats the path as if it was filled.
That is, if one path completely encloses the other,
<a class="reference internal" href="#matplotlib.path.Path.intersects_path" title="matplotlib.path.Path.intersects_path"><tt class="xref py py-meth docutils literal"><span class="pre">intersects_path()</span></tt></a> will return True.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.intersects_path">
<tt class="descname">intersects_path</tt><big>(</big><em>other</em>, <em>filled=True</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.intersects_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns <em>True</em> if this path intersects another given path.</p>
<p><em>filled</em>, when True, treats the paths as if they were filled.
That is, if one path completely encloses the other,
<a class="reference internal" href="#matplotlib.path.Path.intersects_path" title="matplotlib.path.Path.intersects_path"><tt class="xref py py-meth docutils literal"><span class="pre">intersects_path()</span></tt></a> will return True.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.iter_segments">
<tt class="descname">iter_segments</tt><big>(</big><em>transform=None</em>, <em>remove_nans=True</em>, <em>clip=None</em>, <em>snap=False</em>, <em>stroke_width=1.0</em>, <em>simplify=None</em>, <em>curves=True</em>, <em>sketch=None</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.iter_segments" title="Permalink to this definition">¶</a></dt>
<dd><p>Iterates over all of the curve segments in the path. Each
iteration returns a 2-tuple (<em>vertices</em>, <em>code</em>), where
<em>vertices</em> is a sequence of 1 - 3 coordinate pairs, and <em>code</em> is
one of the <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> codes.</p>
<p>Additionally, this method can provide a number of standard
cleanups and conversions to the path.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters :</th><td class="field-body"><p class="first"><strong>transform</strong> : None or <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a> instance</p>
<blockquote>
<div><p>If not None, the given affine transformation will
be applied to the path.</p>
</div></blockquote>
<p><strong>remove_nans</strong> : {False, True}, optional</p>
<blockquote>
<div><p>If True, will remove all NaNs from the path and
insert MOVETO commands to skip over them.</p>
</div></blockquote>
<p><strong>clip</strong> : None or sequence, optional</p>
<blockquote>
<div><p>If not None, must be a four-tuple (x1, y1, x2, y2)
defining a rectangle in which to clip the path.</p>
</div></blockquote>
<p><strong>snap</strong> : None or bool, optional</p>
<blockquote>
<div><p>If None, auto-snap to pixels, to reduce
fuzziness of rectilinear lines. If True, force snapping, and
if False, don’t snap.</p>
</div></blockquote>
<p><strong>stroke_width</strong> : float, optional</p>
<blockquote>
<div><dl class="docutils">
<dt>The width of the stroke being drawn. Needed</dt>
<dd><p class="first last">as a hint for the snapping algorithm.</p>
</dd>
</dl>
</div></blockquote>
<p><strong>simplify</strong> : None or bool, optional</p>
<blockquote>
<div><dl class="docutils">
<dt>If True, perform simplification, to remove</dt>
<dd><p class="first last">vertices that do not affect the appearance of the path. If
False, perform no simplification. If None, use the
should_simplify member variable.</p>
</dd>
</dl>
</div></blockquote>
<p><strong>curves</strong> : {True, False}, optional</p>
<blockquote>
<div><p>If True, curve segments will be returned as curve
segments. If False, all curves will be converted to line
segments.</p>
</div></blockquote>
<p><strong>sketch</strong> : None or sequence, optional</p>
<blockquote class="last">
<div><p>If not None, must be a 3-tuple of the form
(scale, length, randomness), representing the sketch
parameters.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.path.Path.make_compound_path">
<em class="property">classmethod </em><tt class="descname">make_compound_path</tt><big>(</big><em>*args</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.make_compound_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Make a compound path from a list of Path objects.</p>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.path.Path.make_compound_path_from_polys">
<em class="property">classmethod </em><tt class="descname">make_compound_path_from_polys</tt><big>(</big><em>XY</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.make_compound_path_from_polys" title="Permalink to this definition">¶</a></dt>
<dd><p>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 internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a></p>
<p>(<a class="reference external" href="../mpl_examples/api/histogram_path_demo.py">Source code</a>, <a class="reference external" href="../mpl_examples/api/histogram_path_demo.png">png</a>, <a class="reference external" href="../mpl_examples/api/histogram_path_demo.hires.png">hires.png</a>, <a class="reference external" href="../mpl_examples/api/histogram_path_demo.pdf">pdf</a>)</p>
<div class="figure">
<img alt="../_images/histogram_path_demo.png" src="../_images/histogram_path_demo.png" />
</div>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.readonly">
<tt class="descname">readonly</tt><a class="headerlink" href="#matplotlib.path.Path.readonly" title="Permalink to this definition">¶</a></dt>
<dd><p><tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt> if the <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-obj docutils literal"><span class="pre">Path</span></tt></a> is read-only.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.should_simplify">
<tt class="descname">should_simplify</tt><a class="headerlink" href="#matplotlib.path.Path.should_simplify" title="Permalink to this definition">¶</a></dt>
<dd><p><tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt> if the vertices array should be simplified.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.simplify_threshold">
<tt class="descname">simplify_threshold</tt><a class="headerlink" href="#matplotlib.path.Path.simplify_threshold" title="Permalink to this definition">¶</a></dt>
<dd><p>The fraction of a pixel difference below which vertices will
be simplified out.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.to_polygons">
<tt class="descname">to_polygons</tt><big>(</big><em>transform=None</em>, <em>width=0</em>, <em>height=0</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.to_polygons" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert this path to a list of polygons. Each polygon is an
Nx2 array of vertices. In other words, each polygon has no
<tt class="docutils literal"><span class="pre">MOVETO</span></tt> instructions or curves. This is useful for
displaying in backends that do not support compound paths or
Bezier curves, such as GDK.</p>
<p>If <em>width</em> and <em>height</em> are both non-zero then the lines will
be simplified so that vertices outside of (0, 0), (width,
height) will be clipped.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.path.Path.transformed">
<tt class="descname">transformed</tt><big>(</big><em>transform</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.transformed" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a transformed copy of the path.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.TransformedPath" title="matplotlib.transforms.TransformedPath"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.TransformedPath</span></tt></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>
<dl class="classmethod">
<dt id="matplotlib.path.Path.unit_circle">
<em class="property">classmethod </em><tt class="descname">unit_circle</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.path.Path.unit_circle" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> of the unit circle.
The circle is approximated using cubic Bezier curves. This
uses 8 splines around the circle using the approach presented
here:</p>
<blockquote>
<div>Lancaster, Don. <a class="reference external" href="http://www.tinaja.com/glib/ellipse4.pdf">Approximating a Circle or an Ellipse Using Four
Bezier Cubic Splines</a>.</div></blockquote>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.path.Path.unit_circle_righthalf">
<em class="property">classmethod </em><tt class="descname">unit_circle_righthalf</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.path.Path.unit_circle_righthalf" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> of the right half
of a unit circle. The circle is approximated using cubic Bezier
curves. This uses 4 splines around the circle using the approach
presented here:</p>
<blockquote>
<div>Lancaster, Don. <a class="reference external" href="http://www.tinaja.com/glib/ellipse4.pdf">Approximating a Circle or an Ellipse Using Four
Bezier Cubic Splines</a>.</div></blockquote>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.path.Path.unit_rectangle">
<em class="property">classmethod </em><tt class="descname">unit_rectangle</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.path.Path.unit_rectangle" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> instance of the unit rectangle
from (0, 0) to (1, 1).</p>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.path.Path.unit_regular_asterisk">
<em class="property">classmethod </em><tt class="descname">unit_regular_asterisk</tt><big>(</big><em>numVertices</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.unit_regular_asterisk" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> for a unit regular
asterisk with the given numVertices and radius of 1.0,
centered at (0, 0).</p>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.path.Path.unit_regular_polygon">
<em class="property">classmethod </em><tt class="descname">unit_regular_polygon</tt><big>(</big><em>numVertices</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.unit_regular_polygon" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> instance for a unit regular
polygon with the given <em>numVertices</em> and radius of 1.0,
centered at (0, 0).</p>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.path.Path.unit_regular_star">
<em class="property">classmethod </em><tt class="descname">unit_regular_star</tt><big>(</big><em>numVertices</em>, <em>innerCircle=0.5</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.unit_regular_star" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> for a unit regular star
with the given numVertices and radius of 1.0, centered at (0,
0).</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.path.Path.vertices">
<tt class="descname">vertices</tt><a class="headerlink" href="#matplotlib.path.Path.vertices" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of vertices in the <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-obj docutils literal"><span class="pre">Path</span></tt></a> as an Nx2 numpy array.</p>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.path.Path.wedge">
<em class="property">classmethod </em><tt class="descname">wedge</tt><big>(</big><em>theta1</em>, <em>theta2</em>, <em>n=None</em><big>)</big><a class="headerlink" href="#matplotlib.path.Path.wedge" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a wedge of the unit circle from angle
<em>theta1</em> to angle <em>theta2</em> (in degrees).</p>
<p>If <em>n</em> is provided, it is the number of spline segments to make.
If <em>n</em> is not provided, the number of spline segments is
determined based on the delta between <em>theta1</em> and <em>theta2</em>.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.path.cleanup_path">
<tt class="descclassname">matplotlib.path.</tt><tt class="descname">cleanup_path</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.path.cleanup_path" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span>Deprecated since version 1.3: </span>The cleanup_path function was deprecated in version 1.3. Use path.Path.cleaned instead.</p>
</div>
<p>cleanup_path(path, trans, remove_nans, clip, snap, simplify, curves, sketch_params)</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.path.clip_path_to_rect">
<tt class="descclassname">matplotlib.path.</tt><tt class="descname">clip_path_to_rect</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.path.clip_path_to_rect" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span>Deprecated since version 1.3: </span>The clip_path_to_rect function was deprecated in version 1.3. Use path.Path.clip_to_bbox instead.</p>
</div>
<p>clip_path_to_rect(path, bbox, inside)</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.path.convert_path_to_polygons">
<tt class="descclassname">matplotlib.path.</tt><tt class="descname">convert_path_to_polygons</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.path.convert_path_to_polygons" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span>Deprecated since version 1.3: </span>The convert_path_to_polygons function was deprecated in version 1.3. Use path.Path.to_polygons instead.</p>
</div>
<p>convert_path_to_polygons(path, trans, width, height)</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.path.get_path_collection_extents">
<tt class="descclassname">matplotlib.path.</tt><tt class="descname">get_path_collection_extents</tt><big>(</big><em>master_transform</em>, <em>paths</em>, <em>transforms</em>, <em>offsets</em>, <em>offset_transform</em><big>)</big><a class="headerlink" href="#matplotlib.path.get_path_collection_extents" title="Permalink to this definition">¶</a></dt>
<dd><p>Given a sequence of <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> objects,
<a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a> objects and offsets, as
found in a <a class="reference internal" href="collections_api.html#matplotlib.collections.PathCollection" title="matplotlib.collections.PathCollection"><tt class="xref py py-class docutils literal"><span class="pre">PathCollection</span></tt></a>,
returns the bounding box that encapsulates all of them.</p>
<p><em>master_transform</em> is a global transformation to apply to all paths</p>
<p><em>paths</em> is a sequence of <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> instances.</p>
<p><em>transforms</em> is a sequence of
<a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Affine2D" title="matplotlib.transforms.Affine2D"><tt class="xref py py-class docutils literal"><span class="pre">Affine2D</span></tt></a> instances.</p>
<p><em>offsets</em> is a sequence of (x, y) offsets (or an Nx2 array)</p>
<p><em>offset_transform</em> is a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Affine2D" title="matplotlib.transforms.Affine2D"><tt class="xref py py-class docutils literal"><span class="pre">Affine2D</span></tt></a>
to apply to the offsets before applying the offset to the path.</p>
<p>The way that <em>paths</em>, <em>transforms</em> and <em>offsets</em> 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:</p>
<blockquote>
<div>(A, A, A), (B, B, A), (C, A, A)</div></blockquote>
</dd></dl>
<dl class="function">
<dt id="matplotlib.path.get_path_extents">
<tt class="descclassname">matplotlib.path.</tt><tt class="descname">get_path_extents</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.path.get_path_extents" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span>Deprecated since version 1.3: </span>The get_path_extents function was deprecated in version 1.3. Use path.Path.get_extents instead.</p>
</div>
<p>get_path_extents(path, trans)</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.path.get_paths_extents">
<tt class="descclassname">matplotlib.path.</tt><tt class="descname">get_paths_extents</tt><big>(</big><em>paths</em>, <em>transforms=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#matplotlib.path.get_paths_extents" title="Permalink to this definition">¶</a></dt>
<dd><p>Given a sequence of <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> objects and optional
<a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a> objects, returns the
bounding box that encapsulates all of them.</p>
<p><em>paths</em> is a sequence of <a class="reference internal" href="#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> instances.</p>
<p><em>transforms</em> is an optional sequence of
<a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Affine2D" title="matplotlib.transforms.Affine2D"><tt class="xref py py-class docutils literal"><span class="pre">Affine2D</span></tt></a> instances to apply to
each path.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.path.path_in_path">
<tt class="descclassname">matplotlib.path.</tt><tt class="descname">path_in_path</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.path.path_in_path" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span>Deprecated since version 1.3: </span>The path_in_path function was deprecated in version 1.3. Use path.Path.contains_path instead.</p>
</div>
<p>path_in_path(a, atrans, b, btrans)</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.path.path_intersects_path">
<tt class="descclassname">matplotlib.path.</tt><tt class="descname">path_intersects_path</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.path.path_intersects_path" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span>Deprecated since version 1.3: </span>The path_intersects_path function was deprecated in version 1.3. Use path.Path.intersects_path instead.</p>
</div>
<p>path_intersects_path(p1, p2)</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.path.point_in_path">
<tt class="descclassname">matplotlib.path.</tt><tt class="descname">point_in_path</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.path.point_in_path" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span>Deprecated since version 1.3: </span>The point_in_path function was deprecated in version 1.3. Use path.Path.contains_point instead.</p>
</div>
<p>point_in_path(x, y, path, trans)</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.path.point_in_path_collection">
<tt class="descclassname">matplotlib.path.</tt><tt class="descname">point_in_path_collection</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.path.point_in_path_collection" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span>Deprecated since version 1.3: </span>The point_in_path_collection function was deprecated in version 1.3. Use collection.Collection.contains instead.</p>
</div>
<p>point_in_path_collection(x, y, r, trans, paths, transforms, offsets, offsetTrans, filled)</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.path.points_in_path">
<tt class="descclassname">matplotlib.path.</tt><tt class="descname">points_in_path</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.path.points_in_path" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span>Deprecated since version 1.3: </span>The points_in_path function was deprecated in version 1.3. Use path.Path.contains_points instead.</p>
</div>
<p>points_in_path(points, path, trans)</p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyplot_api.html" title="pyplot"
>next</a> |</li>
<li class="right" >
<a href="mlab_api.html" title="mlab"
>previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" >The Matplotlib API</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the matplotlib development team; 2012 - 2013 The matplotlib development team.
Last updated on Jul 31, 2013.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
</div>
</body>
</html>