forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtrifinder.html
More file actions
240 lines (198 loc) · 15.4 KB
/
trifinder.html
File metadata and controls
240 lines (198 loc) · 15.4 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
<!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>matplotlib.tri.trifinder — Matplotlib 3.1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></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>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
<script type="text/javascript" src="../../../_static/copybutton.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.1.0 documentation"
href="../../../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../../genindex.html"
/>
<link rel="search" title="Search" href="../../../search.html"
/>
<link rel="top" title="Matplotlib 3.1.0 documentation" href="../../../index.html" />
<link rel="up" title="matplotlib" href="../../matplotlib.html" />
<link rel="canonical" href="https://matplotlib.org/3.1.0/_modules/matplotlib/tri/trifinder.html" />
</head>
<body>
<div id="plotting-contest" style="padding: 6px; background-color: teal; color: white;">
<p style="margin: 0;">The 2019 SciPy John Hunter Excellence in Plotting Contest is accepting submissions!
<br />
<a href="https://docs.google.com/forms/d/e/1FAIpQLSe-_AnKvYSzeQWfNDRoXgW0vl7_8q6jj3QbLIac8eUcb9lSAA/viewform?usp=sf_link" style="font-weight: bold;">Apply by June 8th</a></p>
</div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../../../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.1.0</span></div>
<img src="../../../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</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><a href="../../../index.html">home</a>| </li>
<li><a href="../../../gallery/index.html">examples</a>| </li>
<li><a href="../../../tutorials/index.html">tutorials</a>| </li>
<li><a href="../../../api/index.html">API</a>| </li>
<li><a href="../../../contents.html">contents</a> »</li>
<li><a href="../../index.html" >Module code</a> »</li>
<li><a href="../../matplotlib.html" accesskey="U">matplotlib</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<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>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../../contents.html">Documentation overview</a><ul>
<li><a href="../../index.html">Module code</a><ul>
<li><a href="../../matplotlib.html">matplotlib</a><ul>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for matplotlib.tri.trifinder</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">from</span> <span class="nn">matplotlib.tri</span> <span class="k">import</span> <span class="n">Triangulation</span>
<div class="viewcode-block" id="TriFinder"><a class="viewcode-back" href="../../../api/tri_api.html#matplotlib.tri.TriFinder">[docs]</a><span class="k">class</span> <span class="nc">TriFinder</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Abstract base class for classes used to find the triangles of a</span>
<span class="sd"> Triangulation in which (x,y) points lie.</span>
<span class="sd"> Rather than instantiate an object of a class derived from TriFinder, it is</span>
<span class="sd"> usually better to use the function</span>
<span class="sd"> :func:`matplotlib.tri.Triangulation.get_trifinder`.</span>
<span class="sd"> Derived classes implement __call__(x,y) where x,y are array_like point</span>
<span class="sd"> coordinates of the same shape.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">triangulation</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">triangulation</span><span class="p">,</span> <span class="n">Triangulation</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Expected a Triangulation object'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_triangulation</span> <span class="o">=</span> <span class="n">triangulation</span></div>
<div class="viewcode-block" id="TrapezoidMapTriFinder"><a class="viewcode-back" href="../../../api/tri_api.html#matplotlib.tri.TrapezoidMapTriFinder">[docs]</a><span class="k">class</span> <span class="nc">TrapezoidMapTriFinder</span><span class="p">(</span><span class="n">TriFinder</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :class:`~matplotlib.tri.TriFinder` class implemented using the trapezoid</span>
<span class="sd"> map algorithm from the book "Computational Geometry, Algorithms and</span>
<span class="sd"> Applications", second edition, by M. de Berg, M. van Kreveld, M. Overmars</span>
<span class="sd"> and O. Schwarzkopf.</span>
<span class="sd"> The triangulation must be valid, i.e. it must not have duplicate points,</span>
<span class="sd"> triangles formed from colinear points, or overlapping triangles. The</span>
<span class="sd"> algorithm has some tolerance to triangles formed from colinear points, but</span>
<span class="sd"> this should not be relied upon.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">triangulation</span><span class="p">):</span>
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="k">import</span> <span class="n">_tri</span>
<span class="n">TriFinder</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">triangulation</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cpp_trifinder</span> <span class="o">=</span> <span class="n">_tri</span><span class="o">.</span><span class="n">TrapezoidMapTriFinder</span><span class="p">(</span>
<span class="n">triangulation</span><span class="o">.</span><span class="n">get_cpp_triangulation</span><span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_initialize</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return an array containing the indices of the triangles in which the</span>
<span class="sd"> specified x,y points lie, or -1 for points that do not lie within a</span>
<span class="sd"> triangle.</span>
<span class="sd"> *x*, *y* are array_like x and y coordinates of the same shape and any</span>
<span class="sd"> number of dimensions.</span>
<span class="sd"> Returns integer array with the same shape and *x* and *y*.</span>
<span class="sd"> """</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
<span class="n">y</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
<span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">shape</span> <span class="o">!=</span> <span class="n">y</span><span class="o">.</span><span class="n">shape</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"x and y must be array-like with the same shape"</span><span class="p">)</span>
<span class="c1"># C++ does the heavy lifting, and expects 1D arrays.</span>
<span class="n">indices</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cpp_trifinder</span><span class="o">.</span><span class="n">find_many</span><span class="p">(</span><span class="n">x</span><span class="o">.</span><span class="n">ravel</span><span class="p">(),</span> <span class="n">y</span><span class="o">.</span><span class="n">ravel</span><span class="p">())</span>
<span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">x</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
<span class="k">return</span> <span class="n">indices</span>
<span class="k">def</span> <span class="nf">_get_tree_stats</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return a python list containing the statistics about the node tree:</span>
<span class="sd"> 0: number of nodes (tree size)</span>
<span class="sd"> 1: number of unique nodes</span>
<span class="sd"> 2: number of trapezoids (tree leaf nodes)</span>
<span class="sd"> 3: number of unique trapezoids</span>
<span class="sd"> 4: maximum parent count (max number of times a node is repeated in</span>
<span class="sd"> tree)</span>
<span class="sd"> 5: maximum depth of tree (one more than the maximum number of</span>
<span class="sd"> comparisons needed to search through the tree)</span>
<span class="sd"> 6: mean of all trapezoid depths (one more than the average number</span>
<span class="sd"> of comparisons needed to search through the tree)</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cpp_trifinder</span><span class="o">.</span><span class="n">get_tree_stats</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Initialize the underlying C++ object. Can be called multiple times if,</span>
<span class="sd"> for example, the triangulation is modified.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cpp_trifinder</span><span class="o">.</span><span class="n">initialize</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_print_tree</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Print a text representation of the node tree, which is useful for</span>
<span class="sd"> debugging purposes.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cpp_trifinder</span><span class="o">.</span><span class="n">print_tree</span><span class="p">()</span></div>
</pre></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on May 18, 2019.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v3.1.0-4-g0078324e4.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-55954603-1', 'auto');
ga('send', 'pageview');
</script>
</body>
<footer>
</footer>
</html>