Repository navigation
Expand file tree
/
Copy patharrayfire.image.html
More file actions
1668 lines (1611 loc) · 70.2 KB
/
Copy patharrayfire.image.html
File metadata and controls
1668 lines (1611 loc) · 70.2 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
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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.image 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.image">
<span id="arrayfire-image-module"></span><h1>arrayfire.image module<a class="headerlink" href="#module-arrayfire.image" title="Permalink to this headline">¶</a></h1>
<p>Image processing functions.</p>
<dl class="function">
<dt id="arrayfire.image.bilateral">
<code class="descclassname">arrayfire.image.</code><code class="descname">bilateral</code><span class="sig-paren">(</span><em>image</em>, <em>s_sigma</em>, <em>c_sigma</em>, <em>is_color=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#bilateral"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.bilateral" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply bilateral filter to the 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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>s_sigma</strong> : scalar.</p>
<blockquote>
<div><ul class="simple">
<li>Sigma value for the co-ordinate space.</li>
</ul>
</div></blockquote>
<p><strong>c_sigma</strong> : scalar.</p>
<blockquote>
<div><ul class="simple">
<li>Sigma value for the color space.</li>
</ul>
</div></blockquote>
<p><strong>is_color</strong> : optional: bool. default: False.</p>
<blockquote>
<div><ul class="simple">
<li>Specifies if the third dimension is 3rd channel (if True) or a batch (if False).</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>The image after the application of the bilateral filter.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.color_space">
<code class="descclassname">arrayfire.image.</code><code class="descname">color_space</code><span class="sig-paren">(</span><em>image</em>, <em>to_type</em>, <em>from_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#color_space"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.color_space" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert an image from one color space to another.</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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A multi dimensional array representing batch of images in <cite>from_type</cite> color space.</li>
</ul>
</div></blockquote>
<p><strong>to_type</strong> : af.CSPACE</p>
<blockquote>
<div><ul class="simple">
<li>An enum for the destination color space.</li>
</ul>
</div></blockquote>
<p><strong>from_type</strong> : af.CSPACE</p>
<blockquote>
<div><ul class="simple">
<li>An enum for the source color space.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>An image in the <cite>to_type</cite> color space.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.dilate">
<code class="descclassname">arrayfire.image.</code><code class="descname">dilate</code><span class="sig-paren">(</span><em>image</em>, <em>mask=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#dilate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.dilate" title="Permalink to this definition">¶</a></dt>
<dd><p>Run image dilate on the 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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>mask</strong> : optional: af.Array. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>Specifies the neighborhood of a pixel.</li>
<li>When None, a [3, 3] array of all ones is used.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>The dilated image.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.dilate3">
<code class="descclassname">arrayfire.image.</code><code class="descname">dilate3</code><span class="sig-paren">(</span><em>volume</em>, <em>mask=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#dilate3"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.dilate3" title="Permalink to this definition">¶</a></dt>
<dd><p>Run volume dilate on a volume.</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>volume</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 3 D arrayfire array representing a volume, or</li>
<li>A multi dimensional array representing batch of volumes.</li>
</ul>
</div></blockquote>
<p><strong>mask</strong> : optional: af.Array. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>Specifies the neighborhood of a pixel.</li>
<li>When None, a [3, 3, 3] array of all ones is used.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>The dilated volume.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.erode">
<code class="descclassname">arrayfire.image.</code><code class="descname">erode</code><span class="sig-paren">(</span><em>image</em>, <em>mask=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#erode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.erode" title="Permalink to this definition">¶</a></dt>
<dd><p>Run image erode on the 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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>mask</strong> : optional: af.Array. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>Specifies the neighborhood of a pixel.</li>
<li>When None, a [3, 3] array of all ones is used.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>The eroded image.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.erode3">
<code class="descclassname">arrayfire.image.</code><code class="descname">erode3</code><span class="sig-paren">(</span><em>volume</em>, <em>mask=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#erode3"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.erode3" title="Permalink to this definition">¶</a></dt>
<dd><p>Run volume erode on the volume.</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>volume</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 3 D arrayfire array representing an volume, or</li>
<li>A multi dimensional array representing batch of volumes.</li>
</ul>
</div></blockquote>
<p><strong>mask</strong> : optional: af.Array. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>Specifies the neighborhood of a pixel.</li>
<li>When None, a [3, 3, 3] array of all ones is used.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>The eroded volume.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.gaussian_kernel">
<code class="descclassname">arrayfire.image.</code><code class="descname">gaussian_kernel</code><span class="sig-paren">(</span><em>rows</em>, <em>cols</em>, <em>sigma_r=None</em>, <em>sigma_c=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#gaussian_kernel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.gaussian_kernel" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a gaussian kernel with the given parameters.</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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>rows</strong> : int</p>
<blockquote>
<div><ul class="simple">
<li>The number of rows in the gaussian kernel.</li>
</ul>
</div></blockquote>
<p><strong>cols</strong> : int</p>
<blockquote>
<div><ul class="simple">
<li>The number of columns in the gaussian kernel.</li>
</ul>
</div></blockquote>
<p><strong>sigma_r</strong> : optional: number. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>The sigma value along rows</li>
<li>If None, calculated as (0.25 * rows + 0.75)</li>
</ul>
</div></blockquote>
<p><strong>sigma_c</strong> : optional: number. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>The sigma value along columns</li>
<li>If None, calculated as (0.25 * cols + 0.75)</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>A gaussian kernel of size (rows, cols)</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.gradient">
<code class="descclassname">arrayfire.image.</code><code class="descname">gradient</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#gradient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.gradient" title="Permalink to this definition">¶</a></dt>
<dd><p>Find the horizontal and vertical gradients.</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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>(dx, dy)</strong> : Tuple of af.Array.</p>
<blockquote class="last">
<div><ul class="simple">
<li><cite>dx</cite> containing the horizontal gradients of <cite>image</cite>.</li>
<li><cite>dy</cite> containing the vertical gradients of <cite>image</cite>.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.gray2rgb">
<code class="descclassname">arrayfire.image.</code><code class="descname">gray2rgb</code><span class="sig-paren">(</span><em>image</em>, <em>r_factor=1.0</em>, <em>g_factor=1.0</em>, <em>b_factor=1.0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#gray2rgb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.gray2rgb" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert Grayscale image to an RGB 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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>r_factor</strong> : optional: scalar. default: 1.0.</p>
<blockquote>
<div><ul class="simple">
<li>Scale factor for the red channel.</li>
</ul>
</div></blockquote>
<p><strong>g_factor</strong> : optional: scalar. default: 1.0.</p>
<blockquote>
<div><ul class="simple">
<li>Scale factor for the green channel.</li>
</ul>
</div></blockquote>
<p><strong>b_factor</strong> : optional: scalar. default: 1.0</p>
<blockquote>
<div><ul class="simple">
<li>Scale factor for the blue channel.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>An RGB image.</li>
<li>The channels are not coalesced, i.e. they appear along the third dimension.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.hist_equal">
<code class="descclassname">arrayfire.image.</code><code class="descname">hist_equal</code><span class="sig-paren">(</span><em>image</em>, <em>hist</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#hist_equal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.hist_equal" title="Permalink to this definition">¶</a></dt>
<dd><p>Equalize an image based on a histogram.</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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>hist</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>Containing the histogram of an image.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>The equalized image.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.histogram">
<code class="descclassname">arrayfire.image.</code><code class="descname">histogram</code><span class="sig-paren">(</span><em>image</em>, <em>nbins</em>, <em>min_val=None</em>, <em>max_val=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#histogram"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.histogram" title="Permalink to this definition">¶</a></dt>
<dd><p>Find the histogram of 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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>nbins</strong> : int.</p>
<blockquote>
<div><ul class="simple">
<li>Number of bins in the histogram.</li>
</ul>
</div></blockquote>
<p><strong>min_val</strong> : optional: scalar. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>The lower bound for the bin values.</li>
<li>If None, <cite>af.min(image)</cite> is used.</li>
</ul>
</div></blockquote>
<p><strong>max_val</strong> : optional: scalar. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>The upper bound for the bin values.</li>
<li>If None, <cite>af.max(image)</cite> is used.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>hist</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>Containing the histogram of the image.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.hsv2rgb">
<code class="descclassname">arrayfire.image.</code><code class="descname">hsv2rgb</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#hsv2rgb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.hsv2rgb" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert HSV image to RGB.</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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 3 D arrayfire array representing an 3 channel image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>A HSV image.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.is_image_io_available">
<code class="descclassname">arrayfire.image.</code><code class="descname">is_image_io_available</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#is_image_io_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.is_image_io_available" title="Permalink to this definition">¶</a></dt>
<dd><p>Function to check if the arrayfire library was built with Image IO support.</p>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.load_image">
<code class="descclassname">arrayfire.image.</code><code class="descname">load_image</code><span class="sig-paren">(</span><em>file_name</em>, <em>is_color=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#load_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.load_image" title="Permalink to this definition">¶</a></dt>
<dd><p>Load an image on the disk as an array.</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>file_name: str</strong></p>
<blockquote>
<div><ul class="simple">
<li>Full path of the file name on disk.</li>
</ul>
</div></blockquote>
<p><strong>is_color</strong> : optional: bool. default: False.</p>
<blockquote>
<div><ul class="simple">
<li>Specifies if the image is loaded as 1 channel (if False) or 3 channel image (if True).</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">image - af.Array</p>
<blockquote class="last">
<div><p>A 2 dimensional (1 channel) or 3 dimensional (3 channel) array containing the image.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.load_image_native">
<code class="descclassname">arrayfire.image.</code><code class="descname">load_image_native</code><span class="sig-paren">(</span><em>file_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#load_image_native"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.load_image_native" title="Permalink to this definition">¶</a></dt>
<dd><p>Load an image on the disk as an array in native format.</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>file_name: str</strong></p>
<blockquote>
<div><ul class="simple">
<li>Full path of the file name on disk.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">image - af.Array</p>
<blockquote class="last">
<div><p>A 2 dimensional (1 channel) or 3 dimensional (3 or 4 channel) array containing the image.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.maxfilt">
<code class="descclassname">arrayfire.image.</code><code class="descname">maxfilt</code><span class="sig-paren">(</span><em>image</em>, <em>w_len=3</em>, <em>w_wid=3</em>, <em>edge_pad=<PAD.ZERO: 0></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#maxfilt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.maxfilt" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply max filter for the 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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>w0</strong> : optional: int. default: 3.</p>
<blockquote>
<div><ul class="simple">
<li>The length of the filter along the first dimension.</li>
</ul>
</div></blockquote>
<p><strong>w1</strong> : optional: int. default: 3.</p>
<blockquote>
<div><ul class="simple">
<li>The length of the filter along the second dimension.</li>
</ul>
</div></blockquote>
<p><strong>edge_pad</strong> : optional: af.PAD. default: af.PAD.ZERO</p>
<blockquote>
<div><ul class="simple">
<li>Flag specifying how the max at the edge should be treated.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>The image after max filter is applied.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.mean_shift">
<code class="descclassname">arrayfire.image.</code><code class="descname">mean_shift</code><span class="sig-paren">(</span><em>image</em>, <em>s_sigma</em>, <em>c_sigma</em>, <em>n_iter</em>, <em>is_color=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#mean_shift"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.mean_shift" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply mean shift to the 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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>s_sigma</strong> : scalar.</p>
<blockquote>
<div><ul class="simple">
<li>Sigma value for the co-ordinate space.</li>
</ul>
</div></blockquote>
<p><strong>c_sigma</strong> : scalar.</p>
<blockquote>
<div><ul class="simple">
<li>Sigma value for the color space.</li>
</ul>
</div></blockquote>
<p><strong>n_iter</strong> : int.</p>
<blockquote>
<div><ul class="simple">
<li>Number of mean shift iterations.</li>
</ul>
</div></blockquote>
<p><strong>is_color</strong> : optional: bool. default: False.</p>
<blockquote>
<div><ul class="simple">
<li>Specifies if the third dimension is 3rd channel (if True) or a batch (if False).</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>The image after the application of the meanshift.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.minfilt">
<code class="descclassname">arrayfire.image.</code><code class="descname">minfilt</code><span class="sig-paren">(</span><em>image</em>, <em>w_len=3</em>, <em>w_wid=3</em>, <em>edge_pad=<PAD.ZERO: 0></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#minfilt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.minfilt" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply min filter for the 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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>w0</strong> : optional: int. default: 3.</p>
<blockquote>
<div><ul class="simple">
<li>The length of the filter along the first dimension.</li>
</ul>
</div></blockquote>
<p><strong>w1</strong> : optional: int. default: 3.</p>
<blockquote>
<div><ul class="simple">
<li>The length of the filter along the second dimension.</li>
</ul>
</div></blockquote>
<p><strong>edge_pad</strong> : optional: af.PAD. default: af.PAD.ZERO</p>
<blockquote>
<div><ul class="simple">
<li>Flag specifying how the min at the edge should be treated.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>The image after min filter is applied.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.moments">
<code class="descclassname">arrayfire.image.</code><code class="descname">moments</code><span class="sig-paren">(</span><em>image</em>, <em>moment=<MOMENT.FIRST_ORDER: 15></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#moments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.moments" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate image moments.</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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>moment</strong> : optional: af.MOMENT. default: af.MOMENT.FIRST_ORDER.</p>
<blockquote>
<div><p>Moment(s) to calculate. Can be one of:
- af.MOMENT.M00
- af.MOMENT.M01
- af.MOMENT.M10
- af.MOMENT.M11
- af.MOMENT.FIRST_ORDER</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>array containing requested moment(s) of each image</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.regions">
<code class="descclassname">arrayfire.image.</code><code class="descname">regions</code><span class="sig-paren">(</span><em>image</em>, <em>conn=<CONNECTIVITY.FOUR: 4></em>, <em>out_type=<Dtype.f32: 0></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#regions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.regions" title="Permalink to this definition">¶</a></dt>
<dd><p>Find the connected components in the 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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image.</li>
</ul>
</div></blockquote>
<p><strong>conn</strong> : optional: af.CONNECTIVITY. default: af.CONNECTIVITY.FOUR.</p>
<blockquote>
<div><ul class="simple">
<li>Specifies the connectivity of the pixels.</li>
</ul>
</div></blockquote>
<p><strong>out_type</strong> : optional: af.Dtype. default: af.Dtype.f32.</p>
<blockquote>
<div><ul class="simple">
<li>Specifies the type for the output.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>An array where each pixel is labeled with its component number.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.resize">
<code class="descclassname">arrayfire.image.</code><code class="descname">resize</code><span class="sig-paren">(</span><em>image</em>, <em>scale=None</em>, <em>odim0=None</em>, <em>odim1=None</em>, <em>method=<INTERP.NEAREST: 0></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#resize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.resize" title="Permalink to this definition">¶</a></dt>
<dd><p>Resize 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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>scale</strong> : optional: scalar. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>Scale factor for the image resizing.</li>
</ul>
</div></blockquote>
<p><strong>odim0</strong> : optional: int. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>Size of the first dimension of the output.</li>
</ul>
</div></blockquote>
<p><strong>odim1</strong> : optional: int. default: None.</p>
<blockquote>
<div><ul class="simple">
<li>Size of the second dimension of the output.</li>
</ul>
</div></blockquote>
<p><strong>method</strong> : optional: af.INTERP. default: af.INTERP.NEAREST.</p>
<blockquote>
<div><ul class="simple">
<li>Interpolation method used for resizing.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>Output image after resizing.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.rgb2gray">
<code class="descclassname">arrayfire.image.</code><code class="descname">rgb2gray</code><span class="sig-paren">(</span><em>image</em>, <em>r_factor=0.2126</em>, <em>g_factor=0.7152</em>, <em>b_factor=0.0722</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#rgb2gray"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.rgb2gray" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert RGB image to Grayscale.</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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 3 D arrayfire array representing an 3 channel image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>r_factor</strong> : optional: scalar. default: 0.2126.</p>
<blockquote>
<div><ul class="simple">
<li>Weight for the red channel.</li>
</ul>
</div></blockquote>
<p><strong>g_factor</strong> : optional: scalar. default: 0.7152.</p>
<blockquote>
<div><ul class="simple">
<li>Weight for the green channel.</li>
</ul>
</div></blockquote>
<p><strong>b_factor</strong> : optional: scalar. default: 0.0722.</p>
<blockquote>
<div><ul class="simple">
<li>Weight for the blue channel.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>A grayscale image.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.rgb2hsv">
<code class="descclassname">arrayfire.image.</code><code class="descname">rgb2hsv</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#rgb2hsv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.rgb2hsv" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert RGB image to HSV.</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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 3 D arrayfire array representing an 3 channel image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>output</strong> : af.Array</p>
<blockquote class="last">
<div><ul class="simple">
<li>A RGB image.</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.rgb2ycbcr">
<code class="descclassname">arrayfire.image.</code><code class="descname">rgb2ycbcr</code><span class="sig-paren">(</span><em>image</em>, <em>standard=<YCC_STD.BT_601: 601></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#rgb2ycbcr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.rgb2ycbcr" title="Permalink to this definition">¶</a></dt>
<dd><p>RGB to YCbCr colorspace conversion.</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>image</strong> : af.Array</p>
<blockquote>
<div><p>A multi dimensional array containing an image or batch of images in RGB format.</p>
</div></blockquote>
<p><strong>standard: YCC_STD. optional. default: YCC_STD.BT_601</strong></p>
<blockquote>
<div><ul class="simple">
<li>Specifies the YCbCr format.</li>
<li>Can be one of YCC_STD.BT_601, YCC_STD.BT_709, and YCC_STD.BT_2020.</li>
</ul>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>out</strong> : af.Array</p>
<blockquote class="last">
<div><p>A multi dimensional array containing an image or batch of images in YCbCr format</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.image.rotate">
<code class="descclassname">arrayfire.image.</code><code class="descname">rotate</code><span class="sig-paren">(</span><em>image</em>, <em>theta</em>, <em>is_crop=True</em>, <em>method=<INTERP.NEAREST: 0></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/image.html#rotate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.image.rotate" title="Permalink to this definition">¶</a></dt>
<dd><p>Rotate 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>image</strong> : af.Array</p>
<blockquote>
<div><ul class="simple">
<li>A 2 D arrayfire array representing an image, or</li>
<li>A multi dimensional array representing batch of images.</li>
</ul>
</div></blockquote>
<p><strong>theta</strong> : scalar</p>
<blockquote>
<div><ul class="simple">
<li>The angle to rotate in radians.</li>
</ul>
</div></blockquote>
<p><strong>is_crop</strong> : optional: bool. default: True.</p>
<blockquote>
<div><ul class="simple">
<li>Specifies if the output should be cropped to the input size.</li>
</ul>
</div></blockquote>
<p><strong>method</strong> : optional: af.INTERP. default: af.INTERP.NEAREST.</p>