forked from arrayfire/arrayfire-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy patharrayfire.graphics.html
More file actions
730 lines (690 loc) · 34 KB
/
arrayfire.graphics.html
File metadata and controls
730 lines (690 loc) · 34 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
<!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>arrayfire.graphics module — ArrayFire Python documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '3.4.20160925',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="top" title="ArrayFire Python documentation" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-arrayfire.graphics">
<span id="arrayfire-graphics-module"></span><h1>arrayfire.graphics module<a class="headerlink" href="#module-arrayfire.graphics" title="Permalink to this headline">¶</a></h1>
<p>Graphics functions (plot, image, etc).</p>
<dl class="class">
<dt id="arrayfire.graphics.Window">
<em class="property">class </em><code class="descclassname">arrayfire.graphics.</code><code class="descname">Window</code><span class="sig-paren">(</span><em>width=1280</em>, <em>height=720</em>, <em>title='ArrayFire'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Class to create the Window object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>width: optional: int. default: 1280.</strong></p>
<blockquote>
<div><ul class="simple">
<li>Specifies the width of the window in pixels.</li>
</ul>
</div></blockquote>
<p><strong>height: optional: int. default: 720.</strong></p>
<blockquote>
<div><ul class="simple">
<li>Specifies the height of the window in pixels.</li>
</ul>
</div></blockquote>
<p><strong>title: optional: str. default: “ArrayFire”.</strong></p>
<blockquote class="last">
<div><ul class="simple">
<li>Specifies the title used for the window.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Methods</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.graphics.Window.close" title="arrayfire.graphics.Window.close"><code class="xref py py-obj docutils literal"><span class="pre">close</span></code></a>()</td>
<td>Close the window.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#arrayfire.graphics.Window.grid" title="arrayfire.graphics.Window.grid"><code class="xref py py-obj docutils literal"><span class="pre">grid</span></code></a>(rows, cols)</td>
<td>Create a grid for sub plotting within the window.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.graphics.Window.hist" title="arrayfire.graphics.Window.hist"><code class="xref py py-obj docutils literal"><span class="pre">hist</span></code></a>(X, min_val, max_val[, title])</td>
<td>Display a histogram Plot.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#arrayfire.graphics.Window.image" title="arrayfire.graphics.Window.image"><code class="xref py py-obj docutils literal"><span class="pre">image</span></code></a>(img[, title])</td>
<td>Display an arrayfire array as an image.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.graphics.Window.plot" title="arrayfire.graphics.Window.plot"><code class="xref py py-obj docutils literal"><span class="pre">plot</span></code></a>(X, Y[, Z, line, title])</td>
<td>Display a 2D or 3D Plot.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#arrayfire.graphics.Window.plot2" title="arrayfire.graphics.Window.plot2"><code class="xref py py-obj docutils literal"><span class="pre">plot2</span></code></a>(line[, title])</td>
<td>Display a 2D Plot.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.graphics.Window.plot3" title="arrayfire.graphics.Window.plot3"><code class="xref py py-obj docutils literal"><span class="pre">plot3</span></code></a>([X, Y, Z, line, title])</td>
<td>Display a 3D Plot.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#arrayfire.graphics.Window.scatter" title="arrayfire.graphics.Window.scatter"><code class="xref py py-obj docutils literal"><span class="pre">scatter</span></code></a>(X, Y[, Z, points, marker, title])</td>
<td>Renders input arrays as 2D or 3D scatter plot.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.graphics.Window.scatter2" title="arrayfire.graphics.Window.scatter2"><code class="xref py py-obj docutils literal"><span class="pre">scatter2</span></code></a>(points[, marker, title])</td>
<td>Renders the input array as a 2D Scatter plot.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#arrayfire.graphics.Window.scatter3" title="arrayfire.graphics.Window.scatter3"><code class="xref py py-obj docutils literal"><span class="pre">scatter3</span></code></a>(points[, marker, title])</td>
<td>Renders the input array as a 3D Scatter plot.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.graphics.Window.set_axes_limits" title="arrayfire.graphics.Window.set_axes_limits"><code class="xref py py-obj docutils literal"><span class="pre">set_axes_limits</span></code></a>(xmin, xmax, ymin, ymax[, ...])</td>
<td>Set axis limits.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#arrayfire.graphics.Window.set_colormap" title="arrayfire.graphics.Window.set_colormap"><code class="xref py py-obj docutils literal"><span class="pre">set_colormap</span></code></a>(cmap)</td>
<td>Set the colormap for the window.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.graphics.Window.set_pos" title="arrayfire.graphics.Window.set_pos"><code class="xref py py-obj docutils literal"><span class="pre">set_pos</span></code></a>(x, y)</td>
<td>Set the position of window on the screen.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#arrayfire.graphics.Window.set_size" title="arrayfire.graphics.Window.set_size"><code class="xref py py-obj docutils literal"><span class="pre">set_size</span></code></a>(w, h)</td>
<td>Set the windo height and width.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.graphics.Window.set_title" title="arrayfire.graphics.Window.set_title"><code class="xref py py-obj docutils literal"><span class="pre">set_title</span></code></a>(title)</td>
<td>Set the title of the window</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#arrayfire.graphics.Window.set_visibility" title="arrayfire.graphics.Window.set_visibility"><code class="xref py py-obj docutils literal"><span class="pre">set_visibility</span></code></a>(is_visible)</td>
<td>A flag that shows or hides the window as requested.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.graphics.Window.show" title="arrayfire.graphics.Window.show"><code class="xref py py-obj docutils literal"><span class="pre">show</span></code></a>()</td>
<td>Force the window to display the contents.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#arrayfire.graphics.Window.surface" title="arrayfire.graphics.Window.surface"><code class="xref py py-obj docutils literal"><span class="pre">surface</span></code></a>(x_vals, y_vals, z_vals[, title])</td>
<td>Renders the input array as a 3D surface plot.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#arrayfire.graphics.Window.vector_field" title="arrayfire.graphics.Window.vector_field"><code class="xref py py-obj docutils literal"><span class="pre">vector_field</span></code></a>(xpoints, xdirs, ypoints, ydirs)</td>
<td>Display a 2D or 3D Vector_Field.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="arrayfire.graphics.Window.close">
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Close the window.</p>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.grid">
<code class="descname">grid</code><span class="sig-paren">(</span><em>rows</em>, <em>cols</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.grid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.grid" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a grid for sub plotting within the window.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>rows: int.</strong></p>
<blockquote>
<div><p>Number of rows in the grid.</p>
</div></blockquote>
<p><strong>cols: int.</strong></p>
<blockquote class="last">
<div><p>Number of columns in the grid.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.hist">
<code class="descname">hist</code><span class="sig-paren">(</span><em>X</em>, <em>min_val</em>, <em>max_val</em>, <em>title=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.hist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.hist" title="Permalink to this definition">¶</a></dt>
<dd><p>Display a histogram Plot.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>X: af.Array.</strong></p>
<blockquote>
<div><p>A 1 dimensional array containing the histogram.</p>
</div></blockquote>
<p><strong>min_val: scalar.</strong></p>
<blockquote>
<div><p>A scalar value specifying the lower bound of the histogram.</p>
</div></blockquote>
<p><strong>max_val: scalar.</strong></p>
<blockquote>
<div><p>A scalar value specifying the upper bound of the histogram.</p>
</div></blockquote>
<p><strong>title: str.</strong></p>
<blockquote class="last">
<div><p>Title used for the histogram.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.image">
<code class="descname">image</code><span class="sig-paren">(</span><em>img</em>, <em>title=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.image" title="Permalink to this definition">¶</a></dt>
<dd><p>Display an arrayfire array as an image.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>img: af.Array.</strong></p>
<blockquote>
<div><p>A 2 dimensional array for single channel image.
A 3 dimensional array for 3 channel image.</p>
</div></blockquote>
<p><strong>title: str.</strong></p>
<blockquote class="last">
<div><p>Title used for the image.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.plot">
<code class="descname">plot</code><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z=None</em>, <em>line=None</em>, <em>title=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.plot" title="Permalink to this definition">¶</a></dt>
<dd><p>Display a 2D or 3D Plot.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>X: af.Array.</strong></p>
<blockquote>
<div><ul class="simple">
<li>A 1 dimensional array containing X co-ordinates.</li>
<li>Not used if line is not None</li>
</ul>
</div></blockquote>
<p><strong>Y: af.Array.</strong></p>
<blockquote>
<div><ul class="simple">
<li>A 1 dimensional array containing Y co-ordinates.</li>
<li>Not used if line is not None</li>
</ul>
</div></blockquote>
<p><strong>Z: optional: af.Array. default: None.</strong></p>
<blockquote>
<div><ul class="simple">
<li>A 1 dimensional array containing Z co-ordinates.</li>
<li>Not used if line is not None</li>
</ul>
</div></blockquote>
<p><strong>line: optional: af.Array. default: None.</strong></p>
<blockquote>
<div><ul class="simple">
<li>A 2 dimensional array of size [n 2]. Each column denotes X and Y co-ordinates for plotting 2D lines.</li>
<li>A 3 dimensional array of size [n 3]. Each column denotes X, Y, and Z co-ordinates for plotting 3D lines.</li>
</ul>
</div></blockquote>
<p><strong>title: str.</strong></p>
<blockquote class="last">
<div><p>Title used for the plot.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.plot2">
<code class="descname">plot2</code><span class="sig-paren">(</span><em>line</em>, <em>title=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.plot2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.plot2" title="Permalink to this definition">¶</a></dt>
<dd><p>Display a 2D Plot.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>line: af.Array.</strong></p>
<blockquote>
<div><ul class="simple">
<li>A 2 dimensional array of size [n 2]. Each column denotes X, and Y co-ordinates for plotting 2D lines.</li>
</ul>
</div></blockquote>
<p><strong>title: str.</strong></p>
<blockquote class="last">
<div><p>Title used for the plot.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.plot3">
<code class="descname">plot3</code><span class="sig-paren">(</span><em>X=None</em>, <em>Y=None</em>, <em>Z=None</em>, <em>line=None</em>, <em>title=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.plot3"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.plot3" title="Permalink to this definition">¶</a></dt>
<dd><p>Display a 3D Plot.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>line: af.Array.</strong></p>
<blockquote>
<div><ul class="simple">
<li>A 3 dimensional array of size [n 3]. Each column denotes X, Y, and Z co-ordinates for plotting 3D lines.</li>
</ul>
</div></blockquote>
<p><strong>title: str.</strong></p>
<blockquote class="last">
<div><p>Title used for the plot.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.scatter">
<code class="descname">scatter</code><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z=None</em>, <em>points=None</em>, <em>marker=<MARKER.POINT: 1></em>, <em>title=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.scatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.scatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Renders input arrays as 2D or 3D scatter plot.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>X: af.Array.</strong></p>
<blockquote>
<div><p>A 1 dimensional array containing X co-ordinates.</p>
</div></blockquote>
<p><strong>Y: af.Array.</strong></p>
<blockquote>
<div><p>A 1 dimensional array containing Y co-ordinates.</p>
</div></blockquote>
<p><strong>Z: optional: af.Array. default: None.</strong></p>
<blockquote>
<div><ul class="simple">
<li>A 1 dimensional array containing Z co-ordinates.</li>
<li>Not used if line is not None</li>
</ul>
</div></blockquote>
<p><strong>points: optional: af.Array. default: None.</strong></p>
<blockquote>
<div><ul class="simple">
<li>A 2 dimensional array of size [n 2]. Each column denotes X and Y co-ordinates for 2D scatter plot.</li>
<li>A 3 dimensional array of size [n 3]. Each column denotes X, Y, and Z co-ordinates for 3D scatter plot.</li>
</ul>
</div></blockquote>
<p><strong>marker: af.MARKER</strong></p>
<blockquote>
<div><p>Specifies how the points look</p>
</div></blockquote>
<p><strong>title: str.</strong></p>
<blockquote class="last">
<div><p>Title used for the plot.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.scatter2">
<code class="descname">scatter2</code><span class="sig-paren">(</span><em>points</em>, <em>marker=<MARKER.POINT: 1></em>, <em>title=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.scatter2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.scatter2" title="Permalink to this definition">¶</a></dt>
<dd><p>Renders the input array as a 2D Scatter plot.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>points: af.Array.</strong></p>
<blockquote>
<div><p>A 2 dimensional array containing (X,Y) co-ordinates.</p>
</div></blockquote>
<p><strong>marker: af.MARKER</strong></p>
<blockquote>
<div><p>Specifies how the points look</p>
</div></blockquote>
<p><strong>title: str.</strong></p>
<blockquote class="last">
<div><p>Title used for the plot.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.scatter3">
<code class="descname">scatter3</code><span class="sig-paren">(</span><em>points</em>, <em>marker=<MARKER.POINT: 1></em>, <em>title=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.scatter3"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.scatter3" title="Permalink to this definition">¶</a></dt>
<dd><p>Renders the input array as a 3D Scatter plot.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>points: af.Array.</strong></p>
<blockquote>
<div><p>A 2 dimensional array containing (X,Y,Z) co-ordinates.</p>
</div></blockquote>
<p><strong>marker: af.MARKER</strong></p>
<blockquote>
<div><p>Specifies how the points look</p>
</div></blockquote>
<p><strong>title: str.</strong></p>
<blockquote class="last">
<div><p>Title used for the plot.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.set_axes_limits">
<code class="descname">set_axes_limits</code><span class="sig-paren">(</span><em>xmin</em>, <em>xmax</em>, <em>ymin</em>, <em>ymax</em>, <em>zmin=None</em>, <em>zmax=None</em>, <em>exact=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.set_axes_limits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.set_axes_limits" title="Permalink to this definition">¶</a></dt>
<dd><p>Set axis limits.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>xmin</strong> : af.Array.</p>
<blockquote>
<div><ul class="simple">
<li>lower limit of the x axis.</li>
</ul>
</div></blockquote>
<p><strong>xmax</strong> : af.Array.</p>
<blockquote>
<div><ul class="simple">
<li>upper limit of the x axis.</li>
</ul>
</div></blockquote>
<p><strong>ymin</strong> : af.Array.</p>
<blockquote>
<div><ul class="simple">
<li>lower limit of the y axis.</li>
</ul>
</div></blockquote>
<p><strong>ymax</strong> : af.Array.</p>
<blockquote>
<div><ul class="simple">
<li>upper limit of the y axis.</li>
</ul>
</div></blockquote>
<p><strong>zmin</strong> : optional: af.Array. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>lower limit of the z axis.</li>
</ul>
</div></blockquote>
<p><strong>zmax</strong> : optional: af.Array. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>upper limit of the z axis.</li>
</ul>
</div></blockquote>
<p><strong>title</strong> : str.</p>
<blockquote class="last">
<div><p>Title used for the plot.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.set_colormap">
<code class="descname">set_colormap</code><span class="sig-paren">(</span><em>cmap</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.set_colormap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.set_colormap" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the colormap for the window.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>cmap</strong> : af.COLORMAP.</p>
<blockquote class="last">
<div><p>Set the colormap for the window.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.set_pos">
<code class="descname">set_pos</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.set_pos"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.set_pos" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the position of window on the screen.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>x</strong> : int.</p>
<blockquote>
<div><p>Pixel offset from left.</p>
</div></blockquote>
<p><strong>y</strong> : int.</p>
<blockquote class="last">
<div><p>Pixel offset from top</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.set_size">
<code class="descname">set_size</code><span class="sig-paren">(</span><em>w</em>, <em>h</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.set_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.set_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the windo height and width.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>w</strong> : int</p>
<blockquote>
<div><p>Width if window.</p>
</div></blockquote>
<p><strong>h</strong> : int</p>
<blockquote class="last">
<div><p>Height of window.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.set_title">
<code class="descname">set_title</code><span class="sig-paren">(</span><em>title</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.set_title"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.set_title" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the title of the window</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>title</strong> : str.</p>
<blockquote class="last">
<div><p>Title used for the current window.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.set_visibility">
<code class="descname">set_visibility</code><span class="sig-paren">(</span><em>is_visible</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.set_visibility"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.set_visibility" title="Permalink to this definition">¶</a></dt>
<dd><p>A flag that shows or hides the window as requested.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>is_visible: Flag specifying the visibility of the flag.</strong></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.show">
<code class="descname">show</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.show"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.show" title="Permalink to this definition">¶</a></dt>
<dd><p>Force the window to display the contents.</p>
<p>Note: This is only needed when using the window as a grid.</p>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.surface">
<code class="descname">surface</code><span class="sig-paren">(</span><em>x_vals</em>, <em>y_vals</em>, <em>z_vals</em>, <em>title=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.surface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.surface" title="Permalink to this definition">¶</a></dt>
<dd><p>Renders the input array as a 3D surface plot.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>x_vals: af.Array.</strong></p>
<blockquote>
<div><p>A 1 dimensional array containing X co-ordinates.</p>
</div></blockquote>
<p><strong>y_vals: af.Array.</strong></p>
<blockquote>
<div><p>A 1 dimensional array containing Y co-ordinates.</p>
</div></blockquote>
<p><strong>z_vals: af.Array.</strong></p>
<blockquote>
<div><p>A 1 dimensional array containing Z co-ordinates.</p>
</div></blockquote>
<p><strong>title: str.</strong></p>
<blockquote class="last">
<div><p>Title used for the plot.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="arrayfire.graphics.Window.vector_field">
<code class="descname">vector_field</code><span class="sig-paren">(</span><em>xpoints</em>, <em>xdirs</em>, <em>ypoints</em>, <em>ydirs</em>, <em>zpoints=None</em>, <em>zdirs=None</em>, <em>points=None</em>, <em>dirs=None</em>, <em>title=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/graphics.html#Window.vector_field"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.graphics.Window.vector_field" title="Permalink to this definition">¶</a></dt>
<dd><p>Display a 2D or 3D Vector_Field.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>xpoints</strong> : af.Array.</p>
<blockquote>
<div><ul class="simple">
<li>A 1 dimensional array containing X co-ordinates.</li>
<li>Not used if points is not None</li>
</ul>
</div></blockquote>
<p><strong>xdirs</strong> : af.Array.</p>
<blockquote>
<div><ul class="simple">
<li>A 1 dimensional array specifying direction at current location.</li>
<li>Not used if dirs is not None</li>
</ul>
</div></blockquote>
<p><strong>ypoints</strong> : af.Array.</p>
<blockquote>
<div><ul class="simple">
<li>A 1 dimensional array containing Y co-ordinates.</li>
<li>Not used if points is not None</li>
</ul>
</div></blockquote>
<p><strong>ydirs</strong> : af.Array.</p>
<blockquote>
<div><ul class="simple">
<li>A 1 dimensional array specifying direction at current location.</li>
<li>Not used if dirs is not None</li>
</ul>
</div></blockquote>
<p><strong>zpoints</strong> : optional: af.Array. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>A 1 dimensional array containing Z co-ordinates.</li>
<li>Not used if points is not None</li>
</ul>
</div></blockquote>
<p><strong>zdirs</strong> : optional: af.Array. default: none.</p>
<blockquote>
<div><ul class="simple">
<li>A 1 dimensional array specifying direction at current location.</li>
<li>Not used if dirs is not None</li>
</ul>
</div></blockquote>
<p><strong>points</strong> : optional: af.Array. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>A 2 dimensional array of size [n 2]. Each column denotes X and Y co-ordinates for plotting 2D lines.</li>
<li>A 3 dimensional array of size [n 3]. Each column denotes X, Y, and Z co-ordinates for plotting 3D lines.</li>
</ul>
</div></blockquote>
<p><strong>dirs</strong> : optional: af.Array. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>A 2 dimensional array of size [n 2]. Each column denotes X and Y directions for plotting 2D lines.</li>
<li>A 3 dimensional array of size [n 3]. Each column denotes X, Y, and Z directions for plotting 3D lines.</li>
</ul>
</div></blockquote>
<p><strong>title</strong> : str.</p>
<blockquote class="last">
<div><p>Title used for the plot.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/arrayfire_logo_symbol.png" alt="Logo"/>
</a></p><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/arrayfire.graphics.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2016, Pavan Yalamanchili.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
|
<a href="_sources/arrayfire.graphics.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>