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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
|
<!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>imtools — Phatch v0.2 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.2',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Phatch v0.2 documentation" href="index.html" />
<link rel="up" title="lib" href="lib.html" />
<link rel="next" title="linux" href="lib.linux.html" />
<link rel="prev" title="imageTable" href="lib.imageTable.html" />
</head>
<body>
<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="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="lib.linux.html" title="linux"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="lib.imageTable.html" title="imageTable"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Phatch v0.2 documentation</a> »</li>
<li><a href="lib.html" accesskey="U">lib</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-lib.imtools">
<h1>imtools<a class="headerlink" href="#module-lib.imtools" title="Permalink to this headline">¶</a></h1>
<dl class="exception">
<dt id="lib.imtools.InvalidWriteFormatError">
<em class="property">
exception </em><tt class="descclassname">lib.imtools.</tt><tt class="descname">InvalidWriteFormatError</tt><a class="headerlink" href="#lib.imtools.InvalidWriteFormatError" title="Permalink to this definition">¶</a></dt>
<dd>Bases: <tt class="xref docutils literal"><span class="pre">exceptions.Exception</span></tt></dd></dl>
<dl class="function">
<dt id="lib.imtools.add_checkboard">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">add_checkboard</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.add_checkboard" title="Permalink to this definition">¶</a></dt>
<dd><p>“If the image has a transparent mask, a RGB checkerboard will be
drawn in the background.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">In case of a thumbnail, the resulting image can not be used for
the cache, as it replaces the transparency layer with a non
transparent checkboard.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> (pil.Image) – image</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">image, with checkboard if transparant</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">pil.Image</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.auto_crop">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">auto_crop</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.auto_crop" title="Permalink to this definition">¶</a></dt>
<dd>Crops all transparent or black background from the image
:param image: input image
:type image: PIL image object
:returns: the cropped image
:rtype: PIL image object</dd></dl>
<dl class="function">
<dt id="lib.imtools.blend">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">blend</tt><big>(</big><em>im1</em>, <em>im2</em>, <em>amount</em>, <em>color=None</em><big>)</big><a class="headerlink" href="#lib.imtools.blend" title="Permalink to this definition">¶</a></dt>
<dd><p>Blend two images with each other. If the images differ in size
the color will be used for undefined pixels.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>im1</em> (pil.Image) – first image</li>
<li><em>im2</em> (pil.Image) – second image</li>
<li><em>amount</em> (int) – amount of blending</li>
<li><em>color</em> (tuple) – color of undefined pixels</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">blended image</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">pil.Image</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.calculate_location">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">calculate_location</tt><big>(</big><em>horizontal_offset</em>, <em>vertical_offset</em>, <em>horizontal_justification</em>, <em>vertical_justification</em>, <em>canvas_size</em>, <em>image_size</em><big>)</big><a class="headerlink" href="#lib.imtools.calculate_location" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate location based on offset and justification. Offsets
can be positive and negative.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>horizontal_offset</em> (int) – horizontal offset</li>
<li><em>vertical_offset</em> (int) – vertical offset</li>
<li><em>horizontal_justification</em> (string) – <tt class="docutils literal"><span class="pre">'Left'</span></tt>, <tt class="docutils literal"><span class="pre">'Middle'</span></tt>, <tt class="docutils literal"><span class="pre">'Right'</span></tt></li>
<li><em>vertical_justification</em> (string) – <tt class="docutils literal"><span class="pre">'Top'</span></tt>, <tt class="docutils literal"><span class="pre">'Middle'</span></tt>, <tt class="docutils literal"><span class="pre">'Bottom'</span></tt></li>
<li><em>canvas_size</em> (tuple of int) – size of the total canvas</li>
<li><em>image_size</em> (tuple of int) – size of the image/text which needs to be placed</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">location</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">tuple of int</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">calculate_location</span><span class="p">(</span><span class="mf">50</span><span class="p">,</span> <span class="mf">50</span><span class="p">,</span> <span class="s">'Left'</span><span class="p">,</span> <span class="s">'Middle'</span><span class="p">,</span> <span class="p">(</span><span class="mf">100</span><span class="p">,</span><span class="mf">100</span><span class="p">),</span> <span class="p">(</span><span class="mf">10</span><span class="p">,</span><span class="mf">10</span><span class="p">))</span>
<span class="go">(50, 45)</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.checkboard">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">checkboard</tt><big>(</big><em>size</em>, <em>delta=8</em>, <em>fg=(128</em>, <em>128</em>, <em>128)</em>, <em>bg=(204</em>, <em>204</em>, <em>204)</em><big>)</big><a class="headerlink" href="#lib.imtools.checkboard" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw an n x n checkboard, which is often used as background
for transparent images. The checkboards are stored in the
<tt class="docutils literal"><span class="pre">CHECKBOARD</span></tt> cache.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>delta</em> (int) – dimension of one square</li>
<li><em>fg</em> (tuple of int) – foreground color</li>
<li><em>bg</em> (tuple of int) – background color</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">checkboard image</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">pil.Image</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.convert">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">convert</tt><big>(</big><em>image</em>, <em>mode</em>, <em>*args</em>, <em>**keyw</em><big>)</big><a class="headerlink" href="#lib.imtools.convert" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a converted copy 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"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>image</em> (PIL image object) – input image</li>
<li><em>mode</em> (string) – the new mode</li>
<li><em>args</em> (tuple of values) – extra options</li>
<li><em>keyw</em> (dictionary of options) – extra keyword options</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the converted image</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">PIL image object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.convert_safe_mode">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">convert_safe_mode</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.convert_safe_mode" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts image into a processing-safe mode.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> (PIL image object) – input image</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the converted image</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">PIL image object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.convert_save_mode_by_format">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">convert_save_mode_by_format</tt><big>(</big><em>image</em>, <em>format</em><big>)</big><a class="headerlink" href="#lib.imtools.convert_save_mode_by_format" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts image into a saving-safe mode.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>image</em> (PIL image object) – input image</li>
<li><em>format</em> (string) – target format</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the converted image</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">PIL image object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.fill_background_color">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">fill_background_color</tt><big>(</big><em>image</em>, <em>color</em><big>)</big><a class="headerlink" href="#lib.imtools.fill_background_color" title="Permalink to this definition">¶</a></dt>
<dd><p>Fills given image with background color.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>image</em> (pil.Image) – source image</li>
<li><em>color</em> (tuple of int) – background color</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">filled image</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">pil.Image</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.fit_color_in_palette">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">fit_color_in_palette</tt><big>(</big><em>image</em>, <em>color</em><big>)</big><a class="headerlink" href="#lib.imtools.fit_color_in_palette" title="Permalink to this definition">¶</a></dt>
<dd><p>Fit a color into a palette. If the color exists already in the palette
return its current index, otherwise add the color to the palette if
possible. Returns -1 for color index if all colors are used already.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>image</em> (pil.Image) – image with a palette</li>
<li><em>color</em> ((r, g, b) tuple) – color to fit</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">color index, (new) palette</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">(r, g, b) tuple, sequence of (r, g, b) tuples</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.flatten">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">flatten</tt><big>(</big><em>l</em><big>)</big><a class="headerlink" href="#lib.imtools.flatten" title="Permalink to this definition">¶</a></dt>
<dd><p>Flatten a list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>l</em> (list) – list to be flattened</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">flattened list</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">list</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">flatten</span><span class="p">([[</span><span class="mf">1</span><span class="p">,</span> <span class="mf">2</span><span class="p">],</span> <span class="p">[</span><span class="mf">3</span><span class="p">]])</span>
<span class="go">[1, 2, 3]</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.generate_layer">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">generate_layer</tt><big>(</big><em>image_size</em>, <em>mark</em>, <em>method</em>, <em>horizontal_offset</em>, <em>vertical_offset</em>, <em>horizontal_justification</em>, <em>vertical_justification</em>, <em>orientation</em>, <em>opacity</em><big>)</big><a class="headerlink" href="#lib.imtools.generate_layer" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate new layer for backgrounds or watermarks on which a given
image <tt class="docutils literal"><span class="pre">mark</span></tt> can be positioned, scaled or repeated.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>image_size</em> (tuple of int) – size of the reference image</li>
<li><em>mark</em> (pil.Image) – image mark</li>
<li><em>method</em> (string) – <tt class="docutils literal"><span class="pre">'Tile'</span></tt>, <tt class="docutils literal"><span class="pre">'Scale'</span></tt>, <tt class="docutils literal"><span class="pre">'By</span> <span class="pre">Offset'</span></tt></li>
<li><em>horizontal_offset</em> (int) – horizontal offset</li>
<li><em>vertical_offset</em> (int) – vertical offset</li>
<li><em>horizontal_justification</em> (string) – <tt class="docutils literal"><span class="pre">'Left'</span></tt>, <tt class="docutils literal"><span class="pre">'Middle'</span></tt>, <tt class="docutils literal"><span class="pre">'Right'</span></tt></li>
<li><em>vertical_justification</em> (string) – <tt class="docutils literal"><span class="pre">'Top'</span></tt>, <tt class="docutils literal"><span class="pre">'Middle'</span></tt>, <tt class="docutils literal"><span class="pre">'Bottom'</span></tt></li>
<li><em>orientation</em> (string) – mark orientation (e.g. <tt class="docutils literal"><span class="pre">'ROTATE_270'</span></tt>)</li>
<li><em>opacity</em> (float) – opacity within <tt class="docutils literal"><span class="pre">[0,</span> <span class="pre">1]</span></tt></li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">generated layer</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">pil.Image</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_alpha">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_alpha</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.get_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the image alpha band. Can handles P mode images with transpareny.
Returns a band with all values set to 255 if no alpha band exists.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> (PIL image object) – input image</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">alpha as a band</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">single band image object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_exif_orientation">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_exif_orientation</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.get_exif_orientation" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the exif orientation 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"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> (pil.Image) – image</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">orientation</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_exif_transposition">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_exif_transposition</tt><big>(</big><em>orientation</em><big>)</big><a class="headerlink" href="#lib.imtools.get_exif_transposition" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the transposition methods necessary to aling the image to
its exif orientation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>orientation</em> (int) – exif orientation</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">(transposition methods, reverse transpostion methods)</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">tuple</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_format">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_format</tt><big>(</big><em>ext</em><big>)</big><a class="headerlink" href="#lib.imtools.get_format" title="Permalink to this definition">¶</a></dt>
<dd><p>Guess the image format by the file extension.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>ext</em> (string) – file extension</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">image format</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">This is only meant to check before saving files. For existing files
open the image with PIL and check its format attribute.</p>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">get_format</span><span class="p">(</span><span class="s">'jpg'</span><span class="p">)</span>
<span class="go">'JPEG'</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_format_data">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_format_data</tt><big>(</big><em>image</em>, <em>format</em><big>)</big><a class="headerlink" href="#lib.imtools.get_format_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the image in the file bytes of the image. By consequence
this byte data is different for the chosen format (<tt class="docutils literal"><span class="pre">JPEG</span></tt>,
<tt class="docutils literal"><span class="pre">TIFF</span></tt>, ...).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>image</em> – source image</li>
<li><em>format</em> (string) – image file type format</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">byte data of the image</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_format_filename">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_format_filename</tt><big>(</big><em>filename</em><big>)</big><a class="headerlink" href="#lib.imtools.get_format_filename" title="Permalink to this definition">¶</a></dt>
<dd><p>Guess the image format by the filename.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>filename</em> (string) – filename</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">image format</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">This is only meant to check before saving files. For existing files
open the image with PIL and check its format attribute.</p>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">get_format_filename</span><span class="p">(</span><span class="s">'test.tif'</span><span class="p">)</span>
<span class="go">'TIFF'</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_palette">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_palette</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.get_palette" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the palette of an image as a sequence of (r, g, b) tuples.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> – image with a palette</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">palette colors</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">a sequence of (r, g, b) tuples</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_quality">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_quality</tt><big>(</big><em>im</em>, <em>size</em>, <em>format</em>, <em>down=0</em>, <em>up=100</em>, <em>delta=1000</em>, <em>options=None</em><big>)</big><a class="headerlink" href="#lib.imtools.get_quality" title="Permalink to this definition">¶</a></dt>
<dd><p>Figure out recursively the quality save parameter to obtain a
certain image size. This mostly used for <tt class="docutils literal"><span class="pre">JPEG</span></tt> images.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>im</em> (pil.Image) – image</li>
<li><em>format</em> (string) – image file format (e.g. <tt class="docutils literal"><span class="pre">'JPEG'</span></tt>)</li>
<li><em>down</em> (int) – minimum file size in bytes</li>
<li><em>up</em> (int) – maximum file size in bytes</li>
<li><em>delta</em> (int) – fault tolerance in bytes</li>
<li><em>options</em> (dict) – image save options</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">save quality</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">int</p>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">filename</span> <span class="o">=</span> <span class="s">'/home/stani/sync/Desktop/IMGA3345.JPG'</span>
<span class="n">im</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
<span class="n">q</span> <span class="o">=</span> <span class="n">get_quality</span><span class="p">(</span><span class="n">im</span><span class="p">,</span> <span class="mf">300000</span><span class="p">,</span> <span class="s">"JPEG"</span><span class="p">)</span>
<span class="n">im</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">filename</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">'.jpg'</span><span class="p">,</span> <span class="s">'_sized.jpg'</span><span class="p">))</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_reverse_transposition">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_reverse_transposition</tt><big>(</big><em>transposition</em><big>)</big><a class="headerlink" href="#lib.imtools.get_reverse_transposition" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the reverse transposition method.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>transposition</em> – transpostion, e.g. <tt class="docutils literal"><span class="pre">Image.ROTATE_90</span></tt></td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">inverse transpostion, e.g. <tt class="docutils literal"><span class="pre">Image.ROTATE_270</span></tt></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_size">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_size</tt><big>(</big><em>im</em>, <em>format</em>, <em>**options</em><big>)</big><a class="headerlink" href="#lib.imtools.get_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the size in bytes if the image would be written to a file.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>format</em> (string) – image file format (e.g. <tt class="docutils literal"><span class="pre">'JPEG'</span></tt>)</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the file size in bytes</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_unused_palette_indices">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_unused_palette_indices</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.get_unused_palette_indices" title="Permalink to this definition">¶</a></dt>
<dd><p>Get unused color indices in an image palette.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> – image with a palette</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">unused color indices of the palette</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">set of 0-255</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_used_palette_colors">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_used_palette_colors</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.get_used_palette_colors" title="Permalink to this definition">¶</a></dt>
<dd><p>Get used colors in an image palette as a sequence of (r, g, b) tuples.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> – image with a palette</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">used colors of the palette</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">sequence of (r, g, b) tuples</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.get_used_palette_indices">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">get_used_palette_indices</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.get_used_palette_indices" title="Permalink to this definition">¶</a></dt>
<dd><p>Get used color indices in an image palette.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> – image with a palette</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">used colors of the palette</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">set of integers (0-255)</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.has_alpha">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">has_alpha</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.has_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if the image has an alpha band.
i.e. the image mode is either RGBA or LA.
The transparency in the P mode doesn’t count as an alpha band</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> (PIL image object) – the image to check</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True or False</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.has_transparency">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">has_transparency</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.has_transparency" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if the image has transparency.
The image has an alpha band or a P mode with transparency.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> (PIL image object) – the image to check</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True or False</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.identity_color">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">identity_color</tt><big>(</big><em>image</em>, <em>value=0</em><big>)</big><a class="headerlink" href="#lib.imtools.identity_color" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a color with same color component values.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">im</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="s">'RGB'</span><span class="p">,</span> <span class="p">(</span><span class="mf">1</span><span class="p">,</span><span class="mf">1</span><span class="p">))</span>
<span class="gp">>>> </span><span class="n">identity_color</span><span class="p">(</span><span class="n">im</span><span class="p">,</span> <span class="mf">2</span><span class="p">)</span>
<span class="go">(2, 2, 2)</span>
<span class="gp">>>> </span><span class="n">im</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="s">'L'</span><span class="p">,</span> <span class="p">(</span><span class="mf">1</span><span class="p">,</span><span class="mf">1</span><span class="p">))</span>
<span class="gp">>>> </span><span class="n">identity_color</span><span class="p">(</span><span class="n">im</span><span class="p">,</span> <span class="mf">7</span><span class="p">)</span>
<span class="go">7</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.open_image">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">open_image</tt><big>(</big><em>uri</em><big>)</big><a class="headerlink" href="#lib.imtools.open_image" title="Permalink to this definition">¶</a></dt>
<dd><p>Open local files or remote files over http.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>uri</em> (string) – image location</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">image</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">pil.Image</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.open_image_data">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">open_image_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#lib.imtools.open_image_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Open image from format data.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>data</em> (string) – image format data</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">image</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">pil.Image</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.open_image_exif">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">open_image_exif</tt><big>(</big><em>uri</em><big>)</big><a class="headerlink" href="#lib.imtools.open_image_exif" title="Permalink to this definition">¶</a></dt>
<dd><p>Open local files or remote files over http and transpose the
image to its exif orientation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>uri</em> (string) – image location</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">image</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">pil.Image</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.paste">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">paste</tt><big>(</big><em>destination</em>, <em>source</em>, <em>box=(0</em>, <em>0)</em>, <em>mask=None</em>, <em>force=False</em><big>)</big><a class="headerlink" href="#lib.imtools.paste" title="Permalink to this definition">¶</a></dt>
<dd><p>“Pastes the source image into the destination image while using an
alpha channel if available.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>destination</em> (PIL image object) – destination image</li>
<li><em>source</em> (PIL image object) – source image</li>
<li><em>box</em> (tuple) – The box argument is either a 2-tuple giving the upper left corner,
a 4-tuple defining the left, upper, right, and lower pixel coordinate,
or None (same as (0, 0)). If a 4-tuple is given, the size of the
pasted image must match the size of the region.</li>
<li><em>mask</em> (bool or PIL image object) – mask or None</li>
<li><em>force</em> (bool) – <p>With mask: Force the invert alpha paste or not.</p>
<p>Without mask:</p>
<ul>
<li>If <tt class="xref docutils literal"><span class="pre">True</span></tt> it will overwrite the alpha channel of the destination
with the alpha channel of the source image. So in that case the
pixels of the destination layer will be abandonned and replaced
by exactly the same pictures of the destination image. This is mostly
what you need if you paste on a transparant canvas.</li>
<li>If <tt class="xref docutils literal"><span class="pre">False</span></tt> this will use a mask when the image has an alpha
channel. In this case pixels of the destination image will appear
through where the source image is transparent.</li>
</ul>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.put_alpha">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">put_alpha</tt><big>(</big><em>image</em>, <em>alpha</em><big>)</big><a class="headerlink" href="#lib.imtools.put_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Copies the given band to the alpha layer of the given 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"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>image</em> (PIL image object) – input image</li>
<li><em>alpha</em> (single band image object) – the alpha band to copy</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.put_palette">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">put_palette</tt><big>(</big><em>image_to</em>, <em>image_from</em>, <em>palette=None</em><big>)</big><a class="headerlink" href="#lib.imtools.put_palette" title="Permalink to this definition">¶</a></dt>
<dd><p>Copies the palette and transparency of one image 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"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>image_to</em> (pil.Image) – image with a palette</li>
<li><em>image_from</em> (pil.Image) – image with a palette</li>
<li><em>palette</em> (sequence of (r, g, b) tuples or None) – image palette</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.reduce_opacity">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">reduce_opacity</tt><big>(</big><em>im</em>, <em>opacity</em><big>)</big><a class="headerlink" href="#lib.imtools.reduce_opacity" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an image with reduced opacity if opacity is
within <tt class="docutils literal"><span class="pre">[0,</span> <span class="pre">1]</span></tt>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>im</em> (pil.Image) – source image</li>
<li><em>opacity</em> (float) – opacity within <tt class="docutils literal"><span class="pre">[0,</span> <span class="pre">1]</span></tt></li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns im:</th><td class="field-body"><p class="first">image</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">pil.Image</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">im</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="s">'RGBA'</span><span class="p">,</span> <span class="p">(</span><span class="mf">1</span><span class="p">,</span> <span class="mf">1</span><span class="p">),</span> <span class="p">(</span><span class="mf">255</span><span class="p">,</span> <span class="mf">255</span><span class="p">,</span> <span class="mf">255</span><span class="p">))</span>
<span class="gp">>>> </span><span class="n">im</span> <span class="o">=</span> <span class="n">reduce_opacity</span><span class="p">(</span><span class="n">im</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">im</span><span class="o">.</span><span class="n">getpixel</span><span class="p">((</span><span class="mf">0</span><span class="p">,</span><span class="mf">0</span><span class="p">))</span>
<span class="go">(255, 255, 255, 127)</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.remove_alpha">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">remove_alpha</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.remove_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a copy of the image after removing the alpha band or
transparency</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> (PIL image object) – input image</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the input image after removing the alpha band or transparency</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">PIL image object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.save">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">save</tt><big>(</big><em>image</em>, <em>filename</em>, <em>**options</em><big>)</big><a class="headerlink" href="#lib.imtools.save" title="Permalink to this definition">¶</a></dt>
<dd><p>Saves an image with a filename and raise the specific
<tt class="docutils literal"><span class="pre">InvalidWriteFormatError</span></tt> in case of an error instead of a
<tt class="docutils literal"><span class="pre">KeyError</span></tt>. Also can hack around UnicodeEncodeError (eg for IM 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"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>image</em> (pil.Image) – image</li>
<li><em>filename</em> (string) – image filename</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.save_check_mode">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">save_check_mode</tt><big>(</big><em>image</em>, <em>filename</em>, <em>**options</em><big>)</big><a class="headerlink" href="#lib.imtools.save_check_mode" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="lib.imtools.save_safely">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">save_safely</tt><big>(</big><em>image</em>, <em>filename</em><big>)</big><a class="headerlink" href="#lib.imtools.save_safely" title="Permalink to this definition">¶</a></dt>
<dd><p>Saves an image with a filename and raise the specific
<tt class="docutils literal"><span class="pre">InvalidWriteFormatError</span></tt> in case of an error instead of a
<tt class="docutils literal"><span class="pre">KeyError</span></tt>. It can also save IM files with unicode.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>image</em> (pil.Image) – image</li>
<li><em>filename</em> (string) – image filename</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.split">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">split</tt><big>(</big><em>image</em><big>)</big><a class="headerlink" href="#lib.imtools.split" title="Permalink to this definition">¶</a></dt>
<dd><p>Work around for bug in Pil 1.1.7</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>image</em> (PIL image object) – input image</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the different color bands of the image (eg R, G, B)</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">tuple</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.transpose">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">transpose</tt><big>(</big><em>image</em>, <em>methods</em><big>)</big><a class="headerlink" href="#lib.imtools.transpose" title="Permalink to this definition">¶</a></dt>
<dd><p>Transpose with a sequence of transformations, mainly useful
for exif.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>image</em> (pil.Image) – image</li>
<li><em>methods</em> (list) – transposition methods</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">transposed image</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">pil.Image</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="lib.imtools.transpose_exif">
<tt class="descclassname">lib.imtools.</tt><tt class="descname">transpose_exif</tt><big>(</big><em>image</em>, <em>reverse=False</em><big>)</big><a class="headerlink" href="#lib.imtools.transpose_exif" title="Permalink to this definition">¶</a></dt>
<dd><p>Transpose an image to its exif orientation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>image</em> (pil.Image) – image</li>
<li><em>reverse</em> (bool) – False when opening, True when saving</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">transposed image</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">pil.Image</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="lib.imageTable.html"
title="previous chapter">imageTable</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="lib.linux.html"
title="next chapter">linux</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="lib.linux.html" title="linux"
>next</a> |</li>
<li class="right" >
<a href="lib.imageTable.html" title="imageTable"
>previous</a> |</li>
<li><a href="index.html">Phatch v0.2 documentation</a> »</li>
<li><a href="lib.html" >lib</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009, www.stani.be.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
</div>
</body>
</html>
|
