forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathstreamplot.html
More file actions
821 lines (668 loc) · 98.3 KB
/
streamplot.html
File metadata and controls
821 lines (668 loc) · 98.3 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
818
819
820
821
<!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.streamplot — Matplotlib 3.1.1 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.1 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.1 documentation" href="../../index.html" />
<link rel="up" title="matplotlib" href="../matplotlib.html" />
<link rel="canonical" href="https://matplotlib.org/3.1.1/_modules/matplotlib/streamplot.html" />
</head>
<body>
<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.1</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.streamplot</h1><div class="highlight"><pre>
<span></span><span class="sd">"""</span>
<span class="sd">Streamline plotting for 2D vector fields.</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">matplotlib</span>
<span class="kn">import</span> <span class="nn">matplotlib.cm</span> <span class="k">as</span> <span class="nn">cm</span>
<span class="kn">import</span> <span class="nn">matplotlib.colors</span> <span class="k">as</span> <span class="nn">mcolors</span>
<span class="kn">import</span> <span class="nn">matplotlib.collections</span> <span class="k">as</span> <span class="nn">mcollections</span>
<span class="kn">import</span> <span class="nn">matplotlib.lines</span> <span class="k">as</span> <span class="nn">mlines</span>
<span class="kn">import</span> <span class="nn">matplotlib.patches</span> <span class="k">as</span> <span class="nn">patches</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'streamplot'</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">streamplot</span><span class="p">(</span><span class="n">axes</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="n">u</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">linewidth</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">cmap</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">norm</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">arrowsize</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">arrowstyle</span><span class="o">=</span><span class="s1">'-|>'</span><span class="p">,</span>
<span class="n">minlength</span><span class="o">=</span><span class="mf">0.1</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">zorder</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">start_points</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">maxlength</span><span class="o">=</span><span class="mf">4.0</span><span class="p">,</span> <span class="n">integration_direction</span><span class="o">=</span><span class="s1">'both'</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Draw streamlines of a vector flow.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> x, y : 1D arrays</span>
<span class="sd"> An evenly spaced grid.</span>
<span class="sd"> u, v : 2D arrays</span>
<span class="sd"> *x* and *y*-velocities. The number of rows and columns must match</span>
<span class="sd"> the length of *y* and *x*, respectively.</span>
<span class="sd"> density : float or (float, float)</span>
<span class="sd"> Controls the closeness of streamlines. When ``density = 1``, the domain</span>
<span class="sd"> is divided into a 30x30 grid. *density* linearly scales this grid.</span>
<span class="sd"> Each cell in the grid can have, at most, one traversing streamline.</span>
<span class="sd"> For different densities in each direction, use a tuple</span>
<span class="sd"> (density_x, density_y).</span>
<span class="sd"> linewidth : float or 2D array</span>
<span class="sd"> The width of the stream lines. With a 2D array the line width can be</span>
<span class="sd"> varied across the grid. The array must have the same shape as *u*</span>
<span class="sd"> and *v*.</span>
<span class="sd"> color : matplotlib color code, or 2D array</span>
<span class="sd"> The streamline color. If given an array, its values are converted to</span>
<span class="sd"> colors using *cmap* and *norm*. The array must have the same shape</span>
<span class="sd"> as *u* and *v*.</span>
<span class="sd"> cmap : `~matplotlib.colors.Colormap`</span>
<span class="sd"> Colormap used to plot streamlines and arrows. This is only used if</span>
<span class="sd"> *color* is an array.</span>
<span class="sd"> norm : `~matplotlib.colors.Normalize`</span>
<span class="sd"> Normalize object used to scale luminance data to 0, 1. If ``None``,</span>
<span class="sd"> stretch (min, max) to (0, 1). This is only used if *color* is an array.</span>
<span class="sd"> arrowsize : float</span>
<span class="sd"> Scaling factor for the arrow size.</span>
<span class="sd"> arrowstyle : str</span>
<span class="sd"> Arrow style specification.</span>
<span class="sd"> See `~matplotlib.patches.FancyArrowPatch`.</span>
<span class="sd"> minlength : float</span>
<span class="sd"> Minimum length of streamline in axes coordinates.</span>
<span class="sd"> start_points : Nx2 array</span>
<span class="sd"> Coordinates of starting points for the streamlines in data coordinates</span>
<span class="sd"> (the same coordinates as the *x* and *y* arrays).</span>
<span class="sd"> zorder : int</span>
<span class="sd"> The zorder of the stream lines and arrows.</span>
<span class="sd"> Artists with lower zorder values are drawn first.</span>
<span class="sd"> maxlength : float</span>
<span class="sd"> Maximum length of streamline in axes coordinates.</span>
<span class="sd"> integration_direction : {'forward', 'backward', 'both'}</span>
<span class="sd"> Integrate the streamline in forward, backward or both directions.</span>
<span class="sd"> default is ``'both'``.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> stream_container : StreamplotSet</span>
<span class="sd"> Container object with attributes</span>
<span class="sd"> - ``lines``: `.LineCollection` of streamlines</span>
<span class="sd"> - ``arrows``: `.PatchCollection` containing `.FancyArrowPatch`</span>
<span class="sd"> objects representing the arrows half-way along stream lines.</span>
<span class="sd"> This container will probably change in the future to allow changes</span>
<span class="sd"> to the colormap, alpha, etc. for both lines and arrows, but these</span>
<span class="sd"> changes should be backward compatible.</span>
<span class="sd"> """</span>
<span class="n">grid</span> <span class="o">=</span> <span class="n">Grid</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="n">mask</span> <span class="o">=</span> <span class="n">StreamMask</span><span class="p">(</span><span class="n">density</span><span class="p">)</span>
<span class="n">dmap</span> <span class="o">=</span> <span class="n">DomainMap</span><span class="p">(</span><span class="n">grid</span><span class="p">,</span> <span class="n">mask</span><span class="p">)</span>
<span class="k">if</span> <span class="n">zorder</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">zorder</span> <span class="o">=</span> <span class="n">mlines</span><span class="o">.</span><span class="n">Line2D</span><span class="o">.</span><span class="n">zorder</span>
<span class="c1"># default to data coordinates</span>
<span class="k">if</span> <span class="n">transform</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">transform</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">transData</span>
<span class="k">if</span> <span class="n">color</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">color</span> <span class="o">=</span> <span class="n">axes</span><span class="o">.</span><span class="n">_get_lines</span><span class="o">.</span><span class="n">get_next_color</span><span class="p">()</span>
<span class="k">if</span> <span class="n">linewidth</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">linewidth</span> <span class="o">=</span> <span class="n">matplotlib</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'lines.linewidth'</span><span class="p">]</span>
<span class="n">line_kw</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">arrow_kw</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">arrowstyle</span><span class="o">=</span><span class="n">arrowstyle</span><span class="p">,</span> <span class="n">mutation_scale</span><span class="o">=</span><span class="mi">10</span> <span class="o">*</span> <span class="n">arrowsize</span><span class="p">)</span>
<span class="k">if</span> <span class="n">integration_direction</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'both'</span><span class="p">,</span> <span class="s1">'forward'</span><span class="p">,</span> <span class="s1">'backward'</span><span class="p">]:</span>
<span class="n">errstr</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"Integration direction '</span><span class="si">%s</span><span class="s2">' not recognised. "</span>
<span class="s2">"Expected 'both', 'forward' or 'backward'."</span> <span class="o">%</span>
<span class="n">integration_direction</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">errstr</span><span class="p">)</span>
<span class="k">if</span> <span class="n">integration_direction</span> <span class="o">==</span> <span class="s1">'both'</span><span class="p">:</span>
<span class="n">maxlength</span> <span class="o">/=</span> <span class="mf">2.</span>
<span class="n">use_multicolor_lines</span> <span class="o">=</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">color</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">)</span>
<span class="k">if</span> <span class="n">use_multicolor_lines</span><span class="p">:</span>
<span class="k">if</span> <span class="n">color</span><span class="o">.</span><span class="n">shape</span> <span class="o">!=</span> <span class="n">grid</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">"If 'color' is given, must have the shape of 'Grid(x,y)'"</span><span class="p">)</span>
<span class="n">line_colors</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">color</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">masked_invalid</span><span class="p">(</span><span class="n">color</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">line_kw</span><span class="p">[</span><span class="s1">'color'</span><span class="p">]</span> <span class="o">=</span> <span class="n">color</span>
<span class="n">arrow_kw</span><span class="p">[</span><span class="s1">'color'</span><span class="p">]</span> <span class="o">=</span> <span class="n">color</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">linewidth</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
<span class="k">if</span> <span class="n">linewidth</span><span class="o">.</span><span class="n">shape</span> <span class="o">!=</span> <span class="n">grid</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">"If 'linewidth' is given, must have the shape of 'Grid(x,y)'"</span><span class="p">)</span>
<span class="n">line_kw</span><span class="p">[</span><span class="s1">'linewidth'</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">line_kw</span><span class="p">[</span><span class="s1">'linewidth'</span><span class="p">]</span> <span class="o">=</span> <span class="n">linewidth</span>
<span class="n">arrow_kw</span><span class="p">[</span><span class="s1">'linewidth'</span><span class="p">]</span> <span class="o">=</span> <span class="n">linewidth</span>
<span class="n">line_kw</span><span class="p">[</span><span class="s1">'zorder'</span><span class="p">]</span> <span class="o">=</span> <span class="n">zorder</span>
<span class="n">arrow_kw</span><span class="p">[</span><span class="s1">'zorder'</span><span class="p">]</span> <span class="o">=</span> <span class="n">zorder</span>
<span class="c1">## Sanity checks.</span>
<span class="k">if</span> <span class="n">u</span><span class="o">.</span><span class="n">shape</span> <span class="o">!=</span> <span class="n">grid</span><span class="o">.</span><span class="n">shape</span> <span class="ow">or</span> <span class="n">v</span><span class="o">.</span><span class="n">shape</span> <span class="o">!=</span> <span class="n">grid</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">"'u' and 'v' must be of shape 'Grid(x,y)'"</span><span class="p">)</span>
<span class="n">u</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">masked_invalid</span><span class="p">(</span><span class="n">u</span><span class="p">)</span>
<span class="n">v</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">masked_invalid</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="n">integrate</span> <span class="o">=</span> <span class="n">get_integrator</span><span class="p">(</span><span class="n">u</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">dmap</span><span class="p">,</span> <span class="n">minlength</span><span class="p">,</span> <span class="n">maxlength</span><span class="p">,</span>
<span class="n">integration_direction</span><span class="p">)</span>
<span class="n">trajectories</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">start_points</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">for</span> <span class="n">xm</span><span class="p">,</span> <span class="n">ym</span> <span class="ow">in</span> <span class="n">_gen_starting_points</span><span class="p">(</span><span class="n">mask</span><span class="o">.</span><span class="n">shape</span><span class="p">):</span>
<span class="k">if</span> <span class="n">mask</span><span class="p">[</span><span class="n">ym</span><span class="p">,</span> <span class="n">xm</span><span class="p">]</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">xg</span><span class="p">,</span> <span class="n">yg</span> <span class="o">=</span> <span class="n">dmap</span><span class="o">.</span><span class="n">mask2grid</span><span class="p">(</span><span class="n">xm</span><span class="p">,</span> <span class="n">ym</span><span class="p">)</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">integrate</span><span class="p">(</span><span class="n">xg</span><span class="p">,</span> <span class="n">yg</span><span class="p">)</span>
<span class="k">if</span> <span class="n">t</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">trajectories</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">sp2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asanyarray</span><span class="p">(</span><span class="n">start_points</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="c1"># Check if start_points are outside the data boundaries</span>
<span class="k">for</span> <span class="n">xs</span><span class="p">,</span> <span class="n">ys</span> <span class="ow">in</span> <span class="n">sp2</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">grid</span><span class="o">.</span><span class="n">x_origin</span> <span class="o"><=</span> <span class="n">xs</span> <span class="o"><=</span> <span class="n">grid</span><span class="o">.</span><span class="n">x_origin</span> <span class="o">+</span> <span class="n">grid</span><span class="o">.</span><span class="n">width</span>
<span class="ow">and</span> <span class="n">grid</span><span class="o">.</span><span class="n">y_origin</span> <span class="o"><=</span> <span class="n">ys</span> <span class="o"><=</span> <span class="n">grid</span><span class="o">.</span><span class="n">y_origin</span> <span class="o">+</span> <span class="n">grid</span><span class="o">.</span><span class="n">height</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Starting point (</span><span class="si">{}</span><span class="s2">, </span><span class="si">{}</span><span class="s2">) outside of data "</span>
<span class="s2">"boundaries"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">xs</span><span class="p">,</span> <span class="n">ys</span><span class="p">))</span>
<span class="c1"># Convert start_points from data to array coords</span>
<span class="c1"># Shift the seed points from the bottom left of the data so that</span>
<span class="c1"># data2grid works properly.</span>
<span class="n">sp2</span><span class="p">[:,</span> <span class="mi">0</span><span class="p">]</span> <span class="o">-=</span> <span class="n">grid</span><span class="o">.</span><span class="n">x_origin</span>
<span class="n">sp2</span><span class="p">[:,</span> <span class="mi">1</span><span class="p">]</span> <span class="o">-=</span> <span class="n">grid</span><span class="o">.</span><span class="n">y_origin</span>
<span class="k">for</span> <span class="n">xs</span><span class="p">,</span> <span class="n">ys</span> <span class="ow">in</span> <span class="n">sp2</span><span class="p">:</span>
<span class="n">xg</span><span class="p">,</span> <span class="n">yg</span> <span class="o">=</span> <span class="n">dmap</span><span class="o">.</span><span class="n">data2grid</span><span class="p">(</span><span class="n">xs</span><span class="p">,</span> <span class="n">ys</span><span class="p">)</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">integrate</span><span class="p">(</span><span class="n">xg</span><span class="p">,</span> <span class="n">yg</span><span class="p">)</span>
<span class="k">if</span> <span class="n">t</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">trajectories</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
<span class="k">if</span> <span class="n">use_multicolor_lines</span><span class="p">:</span>
<span class="k">if</span> <span class="n">norm</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">norm</span> <span class="o">=</span> <span class="n">mcolors</span><span class="o">.</span><span class="n">Normalize</span><span class="p">(</span><span class="n">color</span><span class="o">.</span><span class="n">min</span><span class="p">(),</span> <span class="n">color</span><span class="o">.</span><span class="n">max</span><span class="p">())</span>
<span class="k">if</span> <span class="n">cmap</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">cmap</span> <span class="o">=</span> <span class="n">cm</span><span class="o">.</span><span class="n">get_cmap</span><span class="p">(</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'image.cmap'</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">cmap</span> <span class="o">=</span> <span class="n">cm</span><span class="o">.</span><span class="n">get_cmap</span><span class="p">(</span><span class="n">cmap</span><span class="p">)</span>
<span class="n">streamlines</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">arrows</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">trajectories</span><span class="p">:</span>
<span class="n">tgx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">tgy</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">t</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="c1"># Rescale from grid-coordinates to data-coordinates.</span>
<span class="n">tx</span><span class="p">,</span> <span class="n">ty</span> <span class="o">=</span> <span class="n">dmap</span><span class="o">.</span><span class="n">grid2data</span><span class="p">(</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">t</span><span class="p">))</span>
<span class="n">tx</span> <span class="o">+=</span> <span class="n">grid</span><span class="o">.</span><span class="n">x_origin</span>
<span class="n">ty</span> <span class="o">+=</span> <span class="n">grid</span><span class="o">.</span><span class="n">y_origin</span>
<span class="n">points</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">transpose</span><span class="p">([</span><span class="n">tx</span><span class="p">,</span> <span class="n">ty</span><span class="p">])</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">streamlines</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">hstack</span><span class="p">([</span><span class="n">points</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">points</span><span class="p">[</span><span class="mi">1</span><span class="p">:]]))</span>
<span class="c1"># Add arrows half way along each trajectory.</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">cumsum</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">hypot</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">tx</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">ty</span><span class="p">)))</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">searchsorted</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">s</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">/</span> <span class="mf">2.</span><span class="p">)</span>
<span class="n">arrow_tail</span> <span class="o">=</span> <span class="p">(</span><span class="n">tx</span><span class="p">[</span><span class="n">n</span><span class="p">],</span> <span class="n">ty</span><span class="p">[</span><span class="n">n</span><span class="p">])</span>
<span class="n">arrow_head</span> <span class="o">=</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">tx</span><span class="p">[</span><span class="n">n</span><span class="p">:</span><span class="n">n</span> <span class="o">+</span> <span class="mi">2</span><span class="p">]),</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">ty</span><span class="p">[</span><span class="n">n</span><span class="p">:</span><span class="n">n</span> <span class="o">+</span> <span class="mi">2</span><span class="p">]))</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">linewidth</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
<span class="n">line_widths</span> <span class="o">=</span> <span class="n">interpgrid</span><span class="p">(</span><span class="n">linewidth</span><span class="p">,</span> <span class="n">tgx</span><span class="p">,</span> <span class="n">tgy</span><span class="p">)[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">line_kw</span><span class="p">[</span><span class="s1">'linewidth'</span><span class="p">]</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">line_widths</span><span class="p">)</span>
<span class="n">arrow_kw</span><span class="p">[</span><span class="s1">'linewidth'</span><span class="p">]</span> <span class="o">=</span> <span class="n">line_widths</span><span class="p">[</span><span class="n">n</span><span class="p">]</span>
<span class="k">if</span> <span class="n">use_multicolor_lines</span><span class="p">:</span>
<span class="n">color_values</span> <span class="o">=</span> <span class="n">interpgrid</span><span class="p">(</span><span class="n">color</span><span class="p">,</span> <span class="n">tgx</span><span class="p">,</span> <span class="n">tgy</span><span class="p">)[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">line_colors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">color_values</span><span class="p">)</span>
<span class="n">arrow_kw</span><span class="p">[</span><span class="s1">'color'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cmap</span><span class="p">(</span><span class="n">norm</span><span class="p">(</span><span class="n">color_values</span><span class="p">[</span><span class="n">n</span><span class="p">]))</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">patches</span><span class="o">.</span><span class="n">FancyArrowPatch</span><span class="p">(</span>
<span class="n">arrow_tail</span><span class="p">,</span> <span class="n">arrow_head</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">transform</span><span class="p">,</span> <span class="o">**</span><span class="n">arrow_kw</span><span class="p">)</span>
<span class="n">axes</span><span class="o">.</span><span class="n">add_patch</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
<span class="n">arrows</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
<span class="n">lc</span> <span class="o">=</span> <span class="n">mcollections</span><span class="o">.</span><span class="n">LineCollection</span><span class="p">(</span>
<span class="n">streamlines</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">transform</span><span class="p">,</span> <span class="o">**</span><span class="n">line_kw</span><span class="p">)</span>
<span class="n">lc</span><span class="o">.</span><span class="n">sticky_edges</span><span class="o">.</span><span class="n">x</span><span class="p">[:]</span> <span class="o">=</span> <span class="p">[</span><span class="n">grid</span><span class="o">.</span><span class="n">x_origin</span><span class="p">,</span> <span class="n">grid</span><span class="o">.</span><span class="n">x_origin</span> <span class="o">+</span> <span class="n">grid</span><span class="o">.</span><span class="n">width</span><span class="p">]</span>
<span class="n">lc</span><span class="o">.</span><span class="n">sticky_edges</span><span class="o">.</span><span class="n">y</span><span class="p">[:]</span> <span class="o">=</span> <span class="p">[</span><span class="n">grid</span><span class="o">.</span><span class="n">y_origin</span><span class="p">,</span> <span class="n">grid</span><span class="o">.</span><span class="n">y_origin</span> <span class="o">+</span> <span class="n">grid</span><span class="o">.</span><span class="n">height</span><span class="p">]</span>
<span class="k">if</span> <span class="n">use_multicolor_lines</span><span class="p">:</span>
<span class="n">lc</span><span class="o">.</span><span class="n">set_array</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">hstack</span><span class="p">(</span><span class="n">line_colors</span><span class="p">))</span>
<span class="n">lc</span><span class="o">.</span><span class="n">set_cmap</span><span class="p">(</span><span class="n">cmap</span><span class="p">)</span>
<span class="n">lc</span><span class="o">.</span><span class="n">set_norm</span><span class="p">(</span><span class="n">norm</span><span class="p">)</span>
<span class="n">axes</span><span class="o">.</span><span class="n">add_collection</span><span class="p">(</span><span class="n">lc</span><span class="p">)</span>
<span class="n">axes</span><span class="o">.</span><span class="n">autoscale_view</span><span class="p">()</span>
<span class="n">ac</span> <span class="o">=</span> <span class="n">matplotlib</span><span class="o">.</span><span class="n">collections</span><span class="o">.</span><span class="n">PatchCollection</span><span class="p">(</span><span class="n">arrows</span><span class="p">)</span>
<span class="n">stream_container</span> <span class="o">=</span> <span class="n">StreamplotSet</span><span class="p">(</span><span class="n">lc</span><span class="p">,</span> <span class="n">ac</span><span class="p">)</span>
<span class="k">return</span> <span class="n">stream_container</span>
<span class="k">class</span> <span class="nc">StreamplotSet</span><span class="p">(</span><span class="nb">object</span><span class="p">):</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">lines</span><span class="p">,</span> <span class="n">arrows</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">lines</span> <span class="o">=</span> <span class="n">lines</span>
<span class="bp">self</span><span class="o">.</span><span class="n">arrows</span> <span class="o">=</span> <span class="n">arrows</span>
<span class="c1"># Coordinate definitions</span>
<span class="c1"># ========================</span>
<span class="k">class</span> <span class="nc">DomainMap</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Map representing different coordinate systems.</span>
<span class="sd"> Coordinate definitions:</span>
<span class="sd"> * axes-coordinates goes from 0 to 1 in the domain.</span>
<span class="sd"> * data-coordinates are specified by the input x-y coordinates.</span>
<span class="sd"> * grid-coordinates goes from 0 to N and 0 to M for an N x M grid,</span>
<span class="sd"> where N and M match the shape of the input data.</span>
<span class="sd"> * mask-coordinates goes from 0 to N and 0 to M for an N x M mask,</span>
<span class="sd"> where N and M are user-specified to control the density of streamlines.</span>
<span class="sd"> This class also has methods for adding trajectories to the StreamMask.</span>
<span class="sd"> Before adding a trajectory, run `start_trajectory` to keep track of regions</span>
<span class="sd"> crossed by a given trajectory. Later, if you decide the trajectory is bad</span>
<span class="sd"> (e.g., if the trajectory is very short) just call `undo_trajectory`.</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">grid</span><span class="p">,</span> <span class="n">mask</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">grid</span> <span class="o">=</span> <span class="n">grid</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mask</span> <span class="o">=</span> <span class="n">mask</span>
<span class="c1"># Constants for conversion between grid- and mask-coordinates</span>
<span class="bp">self</span><span class="o">.</span><span class="n">x_grid2mask</span> <span class="o">=</span> <span class="p">(</span><span class="n">mask</span><span class="o">.</span><span class="n">nx</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">/</span> <span class="n">grid</span><span class="o">.</span><span class="n">nx</span>
<span class="bp">self</span><span class="o">.</span><span class="n">y_grid2mask</span> <span class="o">=</span> <span class="p">(</span><span class="n">mask</span><span class="o">.</span><span class="n">ny</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">/</span> <span class="n">grid</span><span class="o">.</span><span class="n">ny</span>
<span class="bp">self</span><span class="o">.</span><span class="n">x_mask2grid</span> <span class="o">=</span> <span class="mf">1.</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">x_grid2mask</span>
<span class="bp">self</span><span class="o">.</span><span class="n">y_mask2grid</span> <span class="o">=</span> <span class="mf">1.</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">y_grid2mask</span>
<span class="bp">self</span><span class="o">.</span><span class="n">x_data2grid</span> <span class="o">=</span> <span class="mf">1.</span> <span class="o">/</span> <span class="n">grid</span><span class="o">.</span><span class="n">dx</span>
<span class="bp">self</span><span class="o">.</span><span class="n">y_data2grid</span> <span class="o">=</span> <span class="mf">1.</span> <span class="o">/</span> <span class="n">grid</span><span class="o">.</span><span class="n">dy</span>
<span class="k">def</span> <span class="nf">grid2mask</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">):</span>
<span class="sd">"""Return nearest space in mask-coords from given grid-coords."""</span>
<span class="k">return</span> <span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">xi</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">x_grid2mask</span> <span class="o">+</span> <span class="mf">0.5</span><span class="p">),</span>
<span class="nb">int</span><span class="p">(</span><span class="n">yi</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">y_grid2mask</span> <span class="o">+</span> <span class="mf">0.5</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">mask2grid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xm</span><span class="p">,</span> <span class="n">ym</span><span class="p">):</span>
<span class="k">return</span> <span class="n">xm</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">x_mask2grid</span><span class="p">,</span> <span class="n">ym</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">y_mask2grid</span>
<span class="k">def</span> <span class="nf">data2grid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xd</span><span class="p">,</span> <span class="n">yd</span><span class="p">):</span>
<span class="k">return</span> <span class="n">xd</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">x_data2grid</span><span class="p">,</span> <span class="n">yd</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">y_data2grid</span>
<span class="k">def</span> <span class="nf">grid2data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xg</span><span class="p">,</span> <span class="n">yg</span><span class="p">):</span>
<span class="k">return</span> <span class="n">xg</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">x_data2grid</span><span class="p">,</span> <span class="n">yg</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">y_data2grid</span>
<span class="k">def</span> <span class="nf">start_trajectory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xg</span><span class="p">,</span> <span class="n">yg</span><span class="p">):</span>
<span class="n">xm</span><span class="p">,</span> <span class="n">ym</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">grid2mask</span><span class="p">(</span><span class="n">xg</span><span class="p">,</span> <span class="n">yg</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mask</span><span class="o">.</span><span class="n">_start_trajectory</span><span class="p">(</span><span class="n">xm</span><span class="p">,</span> <span class="n">ym</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">reset_start_point</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xg</span><span class="p">,</span> <span class="n">yg</span><span class="p">):</span>
<span class="n">xm</span><span class="p">,</span> <span class="n">ym</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">grid2mask</span><span class="p">(</span><span class="n">xg</span><span class="p">,</span> <span class="n">yg</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mask</span><span class="o">.</span><span class="n">_current_xy</span> <span class="o">=</span> <span class="p">(</span><span class="n">xm</span><span class="p">,</span> <span class="n">ym</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">update_trajectory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xg</span><span class="p">,</span> <span class="n">yg</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">within_grid</span><span class="p">(</span><span class="n">xg</span><span class="p">,</span> <span class="n">yg</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">InvalidIndexError</span>
<span class="n">xm</span><span class="p">,</span> <span class="n">ym</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">grid2mask</span><span class="p">(</span><span class="n">xg</span><span class="p">,</span> <span class="n">yg</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mask</span><span class="o">.</span><span class="n">_update_trajectory</span><span class="p">(</span><span class="n">xm</span><span class="p">,</span> <span class="n">ym</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">undo_trajectory</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mask</span><span class="o">.</span><span class="n">_undo_trajectory</span><span class="p">()</span>
<span class="k">class</span> <span class="nc">Grid</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Grid of data."""</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">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
<span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">elif</span> <span class="n">x</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">x_row</span> <span class="o">=</span> <span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="p">:]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">np</span><span class="o">.</span><span class="n">allclose</span><span class="p">(</span><span class="n">x_row</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"The rows of 'x' must be equal"</span><span class="p">)</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">x_row</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"'x' can have at maximum 2 dimensions"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">y</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">elif</span> <span class="n">y</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">y_col</span> <span class="o">=</span> <span class="n">y</span><span class="p">[:,</span> <span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">np</span><span class="o">.</span><span class="n">allclose</span><span class="p">(</span><span class="n">y_col</span><span class="p">,</span> <span class="n">y</span><span class="o">.</span><span class="n">T</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"The columns of 'y' must be equal"</span><span class="p">)</span>
<span class="n">y</span> <span class="o">=</span> <span class="n">y_col</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"'y' can have at maximum 2 dimensions"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nx</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ny</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dx</span> <span class="o">=</span> <span class="n">x</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dy</span> <span class="o">=</span> <span class="n">y</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">y</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">x_origin</span> <span class="o">=</span> <span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">y_origin</span> <span class="o">=</span> <span class="n">y</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">width</span> <span class="o">=</span> <span class="n">x</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">height</span> <span class="o">=</span> <span class="n">y</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">y</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">np</span><span class="o">.</span><span class="n">allclose</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">x</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">width</span> <span class="o">/</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">nx</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"'x' values must be equally spaced"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">np</span><span class="o">.</span><span class="n">allclose</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">y</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">height</span> <span class="o">/</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ny</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"'y' values must be equally spaced"</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">shape</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ny</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">nx</span>
<span class="k">def</span> <span class="nf">within_grid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">):</span>
<span class="sd">"""Return True if point is a valid index of grid."""</span>
<span class="c1"># Note that xi/yi can be floats; so, for example, we can't simply check</span>
<span class="c1"># `xi < self.nx` since `xi` can be `self.nx - 1 < xi < self.nx`</span>
<span class="k">return</span> <span class="n">xi</span> <span class="o">>=</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">xi</span> <span class="o"><=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nx</span> <span class="o">-</span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">yi</span> <span class="o">>=</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">yi</span> <span class="o"><=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ny</span> <span class="o">-</span> <span class="mi">1</span>
<span class="k">class</span> <span class="nc">StreamMask</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Mask to keep track of discrete regions crossed by streamlines.</span>
<span class="sd"> The resolution of this grid determines the approximate spacing between</span>
<span class="sd"> trajectories. Streamlines are only allowed to pass through zeroed cells:</span>
<span class="sd"> When a streamline enters a cell, that cell is set to 1, and no new</span>
<span class="sd"> streamlines are allowed to enter.</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">density</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nx</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">ny</span> <span class="o">=</span> <span class="p">(</span><span class="mi">30</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">broadcast_to</span><span class="p">(</span><span class="n">density</span><span class="p">,</span> <span class="mi">2</span><span class="p">))</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="nb">int</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"'density' must be a scalar or be of length 2"</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">nx</span> <span class="o"><</span> <span class="mi">0</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">ny</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"'density' must be positive"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_mask</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">ny</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">nx</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">shape</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_mask</span><span class="o">.</span><span class="n">shape</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_current_xy</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_mask</span><span class="o">.</span><span class="fm">__getitem__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_start_trajectory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xm</span><span class="p">,</span> <span class="n">ym</span><span class="p">):</span>
<span class="sd">"""Start recording streamline trajectory"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_traj</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_trajectory</span><span class="p">(</span><span class="n">xm</span><span class="p">,</span> <span class="n">ym</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_undo_trajectory</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Remove current trajectory from mask"""</span>
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_traj</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_mask</span><span class="o">.</span><span class="fm">__setitem__</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_update_trajectory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xm</span><span class="p">,</span> <span class="n">ym</span><span class="p">):</span>
<span class="sd">"""Update current trajectory position in mask.</span>
<span class="sd"> If the new position has already been filled, raise `InvalidIndexError`.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_current_xy</span> <span class="o">!=</span> <span class="p">(</span><span class="n">xm</span><span class="p">,</span> <span class="n">ym</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="p">[</span><span class="n">ym</span><span class="p">,</span> <span class="n">xm</span><span class="p">]</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_traj</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">ym</span><span class="p">,</span> <span class="n">xm</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_mask</span><span class="p">[</span><span class="n">ym</span><span class="p">,</span> <span class="n">xm</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_current_xy</span> <span class="o">=</span> <span class="p">(</span><span class="n">xm</span><span class="p">,</span> <span class="n">ym</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">InvalidIndexError</span>
<span class="k">class</span> <span class="nc">InvalidIndexError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">class</span> <span class="nc">TerminateTrajectory</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="k">pass</span>
<span class="c1"># Integrator definitions</span>
<span class="c1">#========================</span>
<span class="k">def</span> <span class="nf">get_integrator</span><span class="p">(</span><span class="n">u</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">dmap</span><span class="p">,</span> <span class="n">minlength</span><span class="p">,</span> <span class="n">maxlength</span><span class="p">,</span> <span class="n">integration_direction</span><span class="p">):</span>
<span class="c1"># rescale velocity onto grid-coordinates for integrations.</span>
<span class="n">u</span><span class="p">,</span> <span class="n">v</span> <span class="o">=</span> <span class="n">dmap</span><span class="o">.</span><span class="n">data2grid</span><span class="p">(</span><span class="n">u</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>
<span class="c1"># speed (path length) will be in axes-coordinates</span>
<span class="n">u_ax</span> <span class="o">=</span> <span class="n">u</span> <span class="o">/</span> <span class="n">dmap</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">nx</span>
<span class="n">v_ax</span> <span class="o">=</span> <span class="n">v</span> <span class="o">/</span> <span class="n">dmap</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">ny</span>
<span class="n">speed</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">u_ax</span> <span class="o">**</span> <span class="mi">2</span> <span class="o">+</span> <span class="n">v_ax</span> <span class="o">**</span> <span class="mi">2</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">forward_time</span><span class="p">(</span><span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">):</span>
<span class="n">ds_dt</span> <span class="o">=</span> <span class="n">interpgrid</span><span class="p">(</span><span class="n">speed</span><span class="p">,</span> <span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ds_dt</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">TerminateTrajectory</span><span class="p">()</span>
<span class="n">dt_ds</span> <span class="o">=</span> <span class="mf">1.</span> <span class="o">/</span> <span class="n">ds_dt</span>
<span class="n">ui</span> <span class="o">=</span> <span class="n">interpgrid</span><span class="p">(</span><span class="n">u</span><span class="p">,</span> <span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">)</span>
<span class="n">vi</span> <span class="o">=</span> <span class="n">interpgrid</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ui</span> <span class="o">*</span> <span class="n">dt_ds</span><span class="p">,</span> <span class="n">vi</span> <span class="o">*</span> <span class="n">dt_ds</span>
<span class="k">def</span> <span class="nf">backward_time</span><span class="p">(</span><span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">):</span>
<span class="n">dxi</span><span class="p">,</span> <span class="n">dyi</span> <span class="o">=</span> <span class="n">forward_time</span><span class="p">(</span><span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">)</span>
<span class="k">return</span> <span class="o">-</span><span class="n">dxi</span><span class="p">,</span> <span class="o">-</span><span class="n">dyi</span>
<span class="k">def</span> <span class="nf">integrate</span><span class="p">(</span><span class="n">x0</span><span class="p">,</span> <span class="n">y0</span><span class="p">):</span>
<span class="sd">"""Return x, y grid-coordinates of trajectory based on starting point.</span>
<span class="sd"> Integrate both forward and backward in time from starting point in</span>
<span class="sd"> grid coordinates.</span>
<span class="sd"> Integration is terminated when a trajectory reaches a domain boundary</span>
<span class="sd"> or when it crosses into an already occupied cell in the StreamMask. The</span>
<span class="sd"> resulting trajectory is None if it is shorter than `minlength`.</span>
<span class="sd"> """</span>
<span class="n">stotal</span><span class="p">,</span> <span class="n">x_traj</span><span class="p">,</span> <span class="n">y_traj</span> <span class="o">=</span> <span class="mf">0.</span><span class="p">,</span> <span class="p">[],</span> <span class="p">[]</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">dmap</span><span class="o">.</span><span class="n">start_trajectory</span><span class="p">(</span><span class="n">x0</span><span class="p">,</span> <span class="n">y0</span><span class="p">)</span>
<span class="k">except</span> <span class="n">InvalidIndexError</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">integration_direction</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'both'</span><span class="p">,</span> <span class="s1">'backward'</span><span class="p">]:</span>
<span class="n">s</span><span class="p">,</span> <span class="n">xt</span><span class="p">,</span> <span class="n">yt</span> <span class="o">=</span> <span class="n">_integrate_rk12</span><span class="p">(</span><span class="n">x0</span><span class="p">,</span> <span class="n">y0</span><span class="p">,</span> <span class="n">dmap</span><span class="p">,</span> <span class="n">backward_time</span><span class="p">,</span> <span class="n">maxlength</span><span class="p">)</span>
<span class="n">stotal</span> <span class="o">+=</span> <span class="n">s</span>
<span class="n">x_traj</span> <span class="o">+=</span> <span class="n">xt</span><span class="p">[::</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">y_traj</span> <span class="o">+=</span> <span class="n">yt</span><span class="p">[::</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="n">integration_direction</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'both'</span><span class="p">,</span> <span class="s1">'forward'</span><span class="p">]:</span>
<span class="n">dmap</span><span class="o">.</span><span class="n">reset_start_point</span><span class="p">(</span><span class="n">x0</span><span class="p">,</span> <span class="n">y0</span><span class="p">)</span>
<span class="n">s</span><span class="p">,</span> <span class="n">xt</span><span class="p">,</span> <span class="n">yt</span> <span class="o">=</span> <span class="n">_integrate_rk12</span><span class="p">(</span><span class="n">x0</span><span class="p">,</span> <span class="n">y0</span><span class="p">,</span> <span class="n">dmap</span><span class="p">,</span> <span class="n">forward_time</span><span class="p">,</span> <span class="n">maxlength</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x_traj</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="n">xt</span> <span class="o">=</span> <span class="n">xt</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">yt</span> <span class="o">=</span> <span class="n">yt</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">stotal</span> <span class="o">+=</span> <span class="n">s</span>
<span class="n">x_traj</span> <span class="o">+=</span> <span class="n">xt</span>
<span class="n">y_traj</span> <span class="o">+=</span> <span class="n">yt</span>
<span class="k">if</span> <span class="n">stotal</span> <span class="o">></span> <span class="n">minlength</span><span class="p">:</span>
<span class="k">return</span> <span class="n">x_traj</span><span class="p">,</span> <span class="n">y_traj</span>
<span class="k">else</span><span class="p">:</span> <span class="c1"># reject short trajectories</span>
<span class="n">dmap</span><span class="o">.</span><span class="n">undo_trajectory</span><span class="p">()</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">return</span> <span class="n">integrate</span>
<span class="k">def</span> <span class="nf">_integrate_rk12</span><span class="p">(</span><span class="n">x0</span><span class="p">,</span> <span class="n">y0</span><span class="p">,</span> <span class="n">dmap</span><span class="p">,</span> <span class="n">f</span><span class="p">,</span> <span class="n">maxlength</span><span class="p">):</span>
<span class="sd">"""2nd-order Runge-Kutta algorithm with adaptive step size.</span>
<span class="sd"> This method is also referred to as the improved Euler's method, or Heun's</span>
<span class="sd"> method. This method is favored over higher-order methods because:</span>
<span class="sd"> 1. To get decent looking trajectories and to sample every mask cell</span>
<span class="sd"> on the trajectory we need a small timestep, so a lower order</span>
<span class="sd"> solver doesn't hurt us unless the data is *very* high resolution.</span>
<span class="sd"> In fact, for cases where the user inputs</span>
<span class="sd"> data smaller or of similar grid size to the mask grid, the higher</span>
<span class="sd"> order corrections are negligible because of the very fast linear</span>
<span class="sd"> interpolation used in `interpgrid`.</span>
<span class="sd"> 2. For high resolution input data (i.e. beyond the mask</span>
<span class="sd"> resolution), we must reduce the timestep. Therefore, an adaptive</span>
<span class="sd"> timestep is more suited to the problem as this would be very hard</span>
<span class="sd"> to judge automatically otherwise.</span>
<span class="sd"> This integrator is about 1.5 - 2x as fast as both the RK4 and RK45</span>
<span class="sd"> solvers in most setups on my machine. I would recommend removing the</span>
<span class="sd"> other two to keep things simple.</span>
<span class="sd"> """</span>
<span class="c1"># This error is below that needed to match the RK4 integrator. It</span>
<span class="c1"># is set for visual reasons -- too low and corners start</span>
<span class="c1"># appearing ugly and jagged. Can be tuned.</span>
<span class="n">maxerror</span> <span class="o">=</span> <span class="mf">0.003</span>
<span class="c1"># This limit is important (for all integrators) to avoid the</span>
<span class="c1"># trajectory skipping some mask cells. We could relax this</span>
<span class="c1"># condition if we use the code which is commented out below to</span>
<span class="c1"># increment the location gradually. However, due to the efficient</span>
<span class="c1"># nature of the interpolation, this doesn't boost speed by much</span>
<span class="c1"># for quite a bit of complexity.</span>
<span class="n">maxds</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="mf">1.</span> <span class="o">/</span> <span class="n">dmap</span><span class="o">.</span><span class="n">mask</span><span class="o">.</span><span class="n">nx</span><span class="p">,</span> <span class="mf">1.</span> <span class="o">/</span> <span class="n">dmap</span><span class="o">.</span><span class="n">mask</span><span class="o">.</span><span class="n">ny</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">)</span>
<span class="n">ds</span> <span class="o">=</span> <span class="n">maxds</span>
<span class="n">stotal</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">xi</span> <span class="o">=</span> <span class="n">x0</span>
<span class="n">yi</span> <span class="o">=</span> <span class="n">y0</span>
<span class="n">xf_traj</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">yf_traj</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">while</span> <span class="n">dmap</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">within_grid</span><span class="p">(</span><span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">):</span>
<span class="n">xf_traj</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">xi</span><span class="p">)</span>
<span class="n">yf_traj</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">yi</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">k1x</span><span class="p">,</span> <span class="n">k1y</span> <span class="o">=</span> <span class="n">f</span><span class="p">(</span><span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">)</span>
<span class="n">k2x</span><span class="p">,</span> <span class="n">k2y</span> <span class="o">=</span> <span class="n">f</span><span class="p">(</span><span class="n">xi</span> <span class="o">+</span> <span class="n">ds</span> <span class="o">*</span> <span class="n">k1x</span><span class="p">,</span>
<span class="n">yi</span> <span class="o">+</span> <span class="n">ds</span> <span class="o">*</span> <span class="n">k1y</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
<span class="c1"># Out of the domain on one of the intermediate integration steps.</span>
<span class="c1"># Take an Euler step to the boundary to improve neatness.</span>
<span class="n">ds</span><span class="p">,</span> <span class="n">xf_traj</span><span class="p">,</span> <span class="n">yf_traj</span> <span class="o">=</span> <span class="n">_euler_step</span><span class="p">(</span><span class="n">xf_traj</span><span class="p">,</span> <span class="n">yf_traj</span><span class="p">,</span> <span class="n">dmap</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span>
<span class="n">stotal</span> <span class="o">+=</span> <span class="n">ds</span>
<span class="k">break</span>
<span class="k">except</span> <span class="n">TerminateTrajectory</span><span class="p">:</span>
<span class="k">break</span>
<span class="n">dx1</span> <span class="o">=</span> <span class="n">ds</span> <span class="o">*</span> <span class="n">k1x</span>
<span class="n">dy1</span> <span class="o">=</span> <span class="n">ds</span> <span class="o">*</span> <span class="n">k1y</span>
<span class="n">dx2</span> <span class="o">=</span> <span class="n">ds</span> <span class="o">*</span> <span class="mf">0.5</span> <span class="o">*</span> <span class="p">(</span><span class="n">k1x</span> <span class="o">+</span> <span class="n">k2x</span><span class="p">)</span>
<span class="n">dy2</span> <span class="o">=</span> <span class="n">ds</span> <span class="o">*</span> <span class="mf">0.5</span> <span class="o">*</span> <span class="p">(</span><span class="n">k1y</span> <span class="o">+</span> <span class="n">k2y</span><span class="p">)</span>
<span class="n">nx</span><span class="p">,</span> <span class="n">ny</span> <span class="o">=</span> <span class="n">dmap</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">shape</span>
<span class="c1"># Error is normalized to the axes coordinates</span>
<span class="n">error</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">hypot</span><span class="p">((</span><span class="n">dx2</span> <span class="o">-</span> <span class="n">dx1</span><span class="p">)</span> <span class="o">/</span> <span class="n">nx</span><span class="p">,</span> <span class="p">(</span><span class="n">dy2</span> <span class="o">-</span> <span class="n">dy1</span><span class="p">)</span> <span class="o">/</span> <span class="n">ny</span><span class="p">)</span>
<span class="c1"># Only save step if within error tolerance</span>
<span class="k">if</span> <span class="n">error</span> <span class="o"><</span> <span class="n">maxerror</span><span class="p">:</span>
<span class="n">xi</span> <span class="o">+=</span> <span class="n">dx2</span>
<span class="n">yi</span> <span class="o">+=</span> <span class="n">dy2</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">dmap</span><span class="o">.</span><span class="n">update_trajectory</span><span class="p">(</span><span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">)</span>
<span class="k">except</span> <span class="n">InvalidIndexError</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">if</span> <span class="n">stotal</span> <span class="o">+</span> <span class="n">ds</span> <span class="o">></span> <span class="n">maxlength</span><span class="p">:</span>
<span class="k">break</span>
<span class="n">stotal</span> <span class="o">+=</span> <span class="n">ds</span>
<span class="c1"># recalculate stepsize based on step error</span>
<span class="k">if</span> <span class="n">error</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">ds</span> <span class="o">=</span> <span class="n">maxds</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">ds</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">maxds</span><span class="p">,</span> <span class="mf">0.85</span> <span class="o">*</span> <span class="n">ds</span> <span class="o">*</span> <span class="p">(</span><span class="n">maxerror</span> <span class="o">/</span> <span class="n">error</span><span class="p">)</span> <span class="o">**</span> <span class="mf">0.5</span><span class="p">)</span>
<span class="k">return</span> <span class="n">stotal</span><span class="p">,</span> <span class="n">xf_traj</span><span class="p">,</span> <span class="n">yf_traj</span>
<span class="k">def</span> <span class="nf">_euler_step</span><span class="p">(</span><span class="n">xf_traj</span><span class="p">,</span> <span class="n">yf_traj</span><span class="p">,</span> <span class="n">dmap</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
<span class="sd">"""Simple Euler integration step that extends streamline to boundary."""</span>
<span class="n">ny</span><span class="p">,</span> <span class="n">nx</span> <span class="o">=</span> <span class="n">dmap</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">shape</span>
<span class="n">xi</span> <span class="o">=</span> <span class="n">xf_traj</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">yi</span> <span class="o">=</span> <span class="n">yf_traj</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">cx</span><span class="p">,</span> <span class="n">cy</span> <span class="o">=</span> <span class="n">f</span><span class="p">(</span><span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">)</span>
<span class="k">if</span> <span class="n">cx</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">dsx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">inf</span>
<span class="k">elif</span> <span class="n">cx</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">dsx</span> <span class="o">=</span> <span class="n">xi</span> <span class="o">/</span> <span class="o">-</span><span class="n">cx</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">dsx</span> <span class="o">=</span> <span class="p">(</span><span class="n">nx</span> <span class="o">-</span> <span class="mi">1</span> <span class="o">-</span> <span class="n">xi</span><span class="p">)</span> <span class="o">/</span> <span class="n">cx</span>
<span class="k">if</span> <span class="n">cy</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">dsy</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">inf</span>
<span class="k">elif</span> <span class="n">cy</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">dsy</span> <span class="o">=</span> <span class="n">yi</span> <span class="o">/</span> <span class="o">-</span><span class="n">cy</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">dsy</span> <span class="o">=</span> <span class="p">(</span><span class="n">ny</span> <span class="o">-</span> <span class="mi">1</span> <span class="o">-</span> <span class="n">yi</span><span class="p">)</span> <span class="o">/</span> <span class="n">cy</span>
<span class="n">ds</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">dsx</span><span class="p">,</span> <span class="n">dsy</span><span class="p">)</span>
<span class="n">xf_traj</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">xi</span> <span class="o">+</span> <span class="n">cx</span> <span class="o">*</span> <span class="n">ds</span><span class="p">)</span>
<span class="n">yf_traj</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">yi</span> <span class="o">+</span> <span class="n">cy</span> <span class="o">*</span> <span class="n">ds</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ds</span><span class="p">,</span> <span class="n">xf_traj</span><span class="p">,</span> <span class="n">yf_traj</span>
<span class="c1"># Utility functions</span>
<span class="c1"># ========================</span>
<span class="k">def</span> <span class="nf">interpgrid</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">xi</span><span class="p">,</span> <span class="n">yi</span><span class="p">):</span>
<span class="sd">"""Fast 2D, linear interpolation on an integer grid"""</span>
<span class="n">Ny</span><span class="p">,</span> <span class="n">Nx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">shape</span><span class="p">(</span><span class="n">a</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">xi</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">xi</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="nb">int</span><span class="p">)</span>
<span class="n">y</span> <span class="o">=</span> <span class="n">yi</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="nb">int</span><span class="p">)</span>
<span class="c1"># Check that xn, yn don't exceed max index</span>
<span class="n">xn</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">clip</span><span class="p">(</span><span class="n">x</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">Nx</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">yn</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">clip</span><span class="p">(</span><span class="n">y</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">Ny</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">x</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">xi</span><span class="p">)</span>
<span class="n">y</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">yi</span><span class="p">)</span>
<span class="c1"># conditional is faster than clipping for integers</span>
<span class="k">if</span> <span class="n">x</span> <span class="o">==</span> <span class="p">(</span><span class="n">Nx</span> <span class="o">-</span> <span class="mi">1</span><span class="p">):</span>
<span class="n">xn</span> <span class="o">=</span> <span class="n">x</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">xn</span> <span class="o">=</span> <span class="n">x</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">y</span> <span class="o">==</span> <span class="p">(</span><span class="n">Ny</span> <span class="o">-</span> <span class="mi">1</span><span class="p">):</span>
<span class="n">yn</span> <span class="o">=</span> <span class="n">y</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">yn</span> <span class="o">=</span> <span class="n">y</span> <span class="o">+</span> <span class="mi">1</span>
<span class="n">a00</span> <span class="o">=</span> <span class="n">a</span><span class="p">[</span><span class="n">y</span><span class="p">,</span> <span class="n">x</span><span class="p">]</span>
<span class="n">a01</span> <span class="o">=</span> <span class="n">a</span><span class="p">[</span><span class="n">y</span><span class="p">,</span> <span class="n">xn</span><span class="p">]</span>
<span class="n">a10</span> <span class="o">=</span> <span class="n">a</span><span class="p">[</span><span class="n">yn</span><span class="p">,</span> <span class="n">x</span><span class="p">]</span>
<span class="n">a11</span> <span class="o">=</span> <span class="n">a</span><span class="p">[</span><span class="n">yn</span><span class="p">,</span> <span class="n">xn</span><span class="p">]</span>
<span class="n">xt</span> <span class="o">=</span> <span class="n">xi</span> <span class="o">-</span> <span class="n">x</span>
<span class="n">yt</span> <span class="o">=</span> <span class="n">yi</span> <span class="o">-</span> <span class="n">y</span>
<span class="n">a0</span> <span class="o">=</span> <span class="n">a00</span> <span class="o">*</span> <span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="n">xt</span><span class="p">)</span> <span class="o">+</span> <span class="n">a01</span> <span class="o">*</span> <span class="n">xt</span>
<span class="n">a1</span> <span class="o">=</span> <span class="n">a10</span> <span class="o">*</span> <span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="n">xt</span><span class="p">)</span> <span class="o">+</span> <span class="n">a11</span> <span class="o">*</span> <span class="n">xt</span>
<span class="n">ai</span> <span class="o">=</span> <span class="n">a0</span> <span class="o">*</span> <span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="n">yt</span><span class="p">)</span> <span class="o">+</span> <span class="n">a1</span> <span class="o">*</span> <span class="n">yt</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">xi</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
<span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">ma</span><span class="o">.</span><span class="n">is_masked</span><span class="p">(</span><span class="n">ai</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">TerminateTrajectory</span>
<span class="k">return</span> <span class="n">ai</span>
<span class="k">def</span> <span class="nf">_gen_starting_points</span><span class="p">(</span><span class="n">shape</span><span class="p">):</span>
<span class="sd">"""Yield starting points for streamlines.</span>
<span class="sd"> Trying points on the boundary first gives higher quality streamlines.</span>
<span class="sd"> This algorithm starts with a point on the mask corner and spirals inward.</span>
<span class="sd"> This algorithm is inefficient, but fast compared to rest of streamplot.</span>
<span class="sd"> """</span>
<span class="n">ny</span><span class="p">,</span> <span class="n">nx</span> <span class="o">=</span> <span class="n">shape</span>
<span class="n">xfirst</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">yfirst</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">xlast</span> <span class="o">=</span> <span class="n">nx</span> <span class="o">-</span> <span class="mi">1</span>
<span class="n">ylast</span> <span class="o">=</span> <span class="n">ny</span> <span class="o">-</span> <span class="mi">1</span>
<span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span>
<span class="n">direction</span> <span class="o">=</span> <span class="s1">'right'</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">nx</span> <span class="o">*</span> <span class="n">ny</span><span class="p">):</span>
<span class="k">yield</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span>
<span class="k">if</span> <span class="n">direction</span> <span class="o">==</span> <span class="s1">'right'</span><span class="p">:</span>
<span class="n">x</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">x</span> <span class="o">>=</span> <span class="n">xlast</span><span class="p">:</span>
<span class="n">xlast</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="n">direction</span> <span class="o">=</span> <span class="s1">'up'</span>
<span class="k">elif</span> <span class="n">direction</span> <span class="o">==</span> <span class="s1">'up'</span><span class="p">:</span>
<span class="n">y</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">y</span> <span class="o">>=</span> <span class="n">ylast</span><span class="p">:</span>
<span class="n">ylast</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="n">direction</span> <span class="o">=</span> <span class="s1">'left'</span>
<span class="k">elif</span> <span class="n">direction</span> <span class="o">==</span> <span class="s1">'left'</span><span class="p">:</span>
<span class="n">x</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">x</span> <span class="o"><=</span> <span class="n">xfirst</span><span class="p">:</span>
<span class="n">xfirst</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">direction</span> <span class="o">=</span> <span class="s1">'down'</span>
<span class="k">elif</span> <span class="n">direction</span> <span class="o">==</span> <span class="s1">'down'</span><span class="p">:</span>
<span class="n">y</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">y</span> <span class="o"><=</span> <span class="n">yfirst</span><span class="p">:</span>
<span class="n">yfirst</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">direction</span> <span class="o">=</span> <span class="s1">'right'</span>
</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 Jul 09, 2019.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v3.1.1-9-g823365338.
</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>