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
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content="HTML Tidy for Linux/x86 (vers 6 November 2007), see www.w3.org" />
<title>RMagick 0.0.0: class ImageList</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<meta name="GENERATOR" content="Quanta Plus" />
<meta name="Copyright" content="Copyright (C) 2005 by Timothy P. Hunter" />
<link rel="stylesheet" type="text/css" href="css/doc.css" />
<script type="text/javascript" src="scripts/doc.js"></script>
<script type="text/javascript" src="scripts/doc.js"></script>
</head>
<body>
<h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
<div class="nav">« <a href="magick.html">Prev</a> | <a href="index.html">Contents</a> | <a href="imageattrs.html">Next</a> »</div>
<h1>
class ImageList<br />
<span class="mixin">mixes in Comparable, Enumerable</span>
</h1>
<div id="toc">
<h2>Table of Contents</h2>
<h3>class methods</h3>
<ul>
<li><a href="#new">new</a></li>
</ul>
<h3>attributes</h3>
<ul>
<li><a href="#delay_eq">delay=</a></li>
<li><a href="#iterations_eq">iterations=</a></li>
<li><a href="#length">length</a></li>
<li><a href="#scene">scene, scene=</a></li>
<li><a href="#ticks_per_second_eq">ticks_per_second=</a></li>
</ul>
<h3>instance methods</h3>
<div class="toccol">
<ul>
<li><a href="#array_methods">Array methods</a></li>
<li><a href="#spaceship"><=></a></li>
<li><a href="#animate">animate</a></li>
<li><a href="#append">append</a></li>
<li><a href="#average">average</a></li>
<li><a href="#clone">clone</a></li>
<li><a href="#coalesce">coalesce</a></li>
<li><a href="#composite_layers">composite_layers</a></li>
<li><a href="#copy">copy</a></li>
<li><a href="#cur_image">cur_image</a></li>
</ul>
</div>
<div class="toccol">
<ul>
<li><a href="#deconstruct">deconstruct</a></li>
<li><a href="#dup">dup</a></li>
<li><a href="#display">display</a></li>
<li><a href="#flatten_images">flatten_images</a></li>
<li><a href="#from_blob">from_blob</a></li>
<li><a href="#fx">fx</a></li>
<li><a href="#inspect">inspect</a></li>
<li><a href="#montage">montage</a></li>
<li><a href="#morph">morph</a></li>
</ul>
</div>
<div class="toccol">
<ul>
<li><a href="#mosaic">mosaic</a></li>
<li><a href="#new_image">new_image</a></li>
<li><a href="#optimize_layers">optimize_layers</a></li>
<li><a href="#ping">ping</a></li>
<li><a href="#quantize">quantize</a></li>
<li><a href="#read">read</a></li>
<li><a href="#remap">remap</a></li>
<li><a href="#to_a">to_a</a></li>
<li><a href="#to_blob">to_blob</a></li>
<li><a href="#write">write</a></li>
</ul>
</div>
</div>
<h2 class="methods">class methods</h2>
<div class="sig">
<h3 id="new">new</h3>
<p>
Magick::ImageList.new
<span class="arg">[ { optional arguments } ]</span> -> <em>imagelist</em><br />
Magick::ImageList.new(<span class="arg">filename[, filename...]]</span>) <span class="arg">[ { optional arguments } ]</span> ->
<em>imagelist</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Creates a new imagelist. If one or more image filenames are specified, opens and reads the files, adding a new image for each image in the image
file(s). Sets the scene number to the index of the last image, or
<code>nil</code> if no filenames are specified.
</p>
<h4>Arguments</h4>
<p>
Zero or more image file names. You can also specify optional arguments to be used when reading the file(s) by setting
<a href="info.html">Image::Info</a> attributes in the optional block.
</p>
<h4>Returns</h4>
<p>
A new imagelist. The imagelist contains an Image object for each image in the specified files. A file can contain more than one image. For example, new
will create an image for each frame in an animated GIF or each layer in a multi-layer Photoshop file.
</p>
<h4>Example</h4>
<pre>
i = Magick::ImageList.new
i = Magick::ImageList.new("Button_A.gif", "Cheetah.jpg")
</pre
>
</div>
<h2 class="methods">attributes</h2>
<div class="sig">
<h3 id="delay_eq">delay=</h3>
<p><span class="arg">ilist.</span>delay=<em>n</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
In conjunction with
<a href="#ticks_per_second_eq">ticks_per_second</a> sets the length of time between each image in an animation. The <code>delay=</code> attribute
assigns the same delay to all the images in the ilist. Use <a href="imageattrs.html#delay">Image#delay=</a> to set different delay values on individual
images.
</p>
<h4>Arguments</h4>
<p>An integer value representing the number of ticks that must elapse between each image in an animation.</p>
<h4>Returns</h4>
<p>self</p>
<h4>Example</h4>
<pre>
ilist.delay = 20 # delay 1/5 of a second between images.
</pre
>
<h4>See also</h4>
<p><a href="imageattrs.html#delay">Image#delay=</a></p>
</div>
<div class="sig">
<h3 id="iterations_eq">iterations=</h3>
<p><span class="arg">ilist.</span>iterations=<em>n</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Sets the number of times an animated image should loop.</p>
<p>
The <a href="#animate">animate</a> method and the ImageMagick animate command does not respect this number. Both will repeat the animation until you
stop them. Mozilla (and presumably Netscape) do respect the value..
</p>
<h4>Arguments</h4>
<p>The number of iterations.</p>
<h4>Returns</h4>
<p>self</p>
<h4>Example</h4>
<pre>
ilist.iterations = 10
</pre
>
</div>
<div class="sig">
<h3 id="length">length</h3>
<p><span class="arg">ilist.</span>length -> <em>integer</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Returns the number of images in the imagelist.</p>
<h4>Example</h4>
<pre>
i = Magick::ImageList.new("images/Button_A.gif", "images/Button_B.gif")
i.length » 2
</pre
>
</div>
<div class="sig">
<h3 id="scene">scene, scene=</h3>
<p>
<span class="arg">ilist</span>.scene -> <em>integer</em><br />
<span class="arg">ilist</span>.scene = <em>integer</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Get/set the current <em>scene number</em>. The scene number indicates the image to which <a href="image1.html">Image</a> methods are sent.</p>
<h4>Example</h4>
<pre>
ilist.scene = 10
ilist.scene » 10
</pre
>
</div>
<div class="sig">
<h3 id="ticks_per_second_eq">ticks_per_second=</h3>
<p><span class="arg">ilist</span>.ticks_per_second = <em>integer</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Used in conjunction with <a href="#delay_eq">delay</a> to establish the elapsed time between frames in an animation. By default the number of ticks per
second is 100.
</p>
<h4>Example</h4>
<pre>
ilist.ticks_per_second = 1000
</pre
>
</div>
<h2 class="methods">instance methods</h2>
<div class="sig">
<h3 id="array_methods">Array methods</h3>
<p> </p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
<code>ImageList</code> delegates many methods to <code>Array</code>, so you can manipulate the images in an imagelist using almost all of the methods
defined in <code>Array</code>. Typically these methods also update the scene number. The scene number will never exceed the number of images in the
list, and if the imagelist contains no images the scene number will be <code>nil</code>.
</p>
<p>Array methods that would normally return an array return an ImageList.</p>
<p>
Most array methods keep the current image current. If the method moves the current image to a new position, the method updates the scene number to the
new index. If the method deletes the current image, the scene number is set to the last image in the list. The following table lists the methods that do
not follow these rules.
</p>
<table summary="array method affect on scene number" class="simple_table">
<caption>
Array method behavior
</caption>
<thead>
<tr>
<th>Array method</th>
<th>scene number will be...</th>
</tr>
</thead>
<tbody>
<tr>
<td><<</td>
<td>set to index the last image in the list</td>
</tr>
<tr>
<td>clear</td>
<td>set to <code>nil</code></td>
</tr>
<tr>
<td>concat</td>
<td>set to index the last image in the list</td>
</tr>
<tr>
<td>push</td>
<td>set to index the last image in the list</td>
</tr>
<tr>
<td>unshift</td>
<td>set to 0</td>
</tr>
</tbody>
</table>
<p>
Adding anything other than a image to an imagelist has undefined results. Most of the time RMagick will raise an ArgumentError exception. For example,
if you call <code>collect!</code> on an imagelist you should make sure that the members of the imagelist remain images. If you need to replace images in
an imagelist with non-image objects, convert the imagelist to an array with the <code>to_a</code> method, then modify the array.
</p>
<p>
The <code>assoc</code>, <code>flatten</code>, <code>flatten!</code>, <code>join</code>, <code>pack</code>, and <code>rassoc</code> methods are not
defined in the ImageList class.
</p>
<h4>Example</h4>
<p>Add noise to a model image. Append the resulting image to the imagelist in "example". (See the <code>demo.rb</code> example.)</p>
<pre>
example = Magick::ImageList.new
model = Magick::ImageList.new "model.miff"
example << model.add_noise Magick::LaplacisanNoise
</pre
>
<h4>See also</h4>
<p><a href="#scene">scene</a>, <a href="#scene">scene=</a></p>
</div>
<div class="sig">
<h3 id="spaceship"><=></h3>
<p><span class="arg">ilist</span> <=> <span class="arg">other_imagelist</span> -> -1, 0, 1</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Compares two imagelists and returns -1, 0, or 1 if the receiver is less than, equal to, or greater than the other imagelist. The comparison between the
receiver (a) and the other (b) is performed this way:
</p>
<ol>
<li>
For all images <code>n</code>, if the result of <code>a[n] <=> b[n]</code> is not 0 then that is the result of
a <=> b. Individual images are compared by comparing their <a href="image3.html#signature">signatures</a>.
</li>
<li>If <code>a.scene <=> b.scene</code> is not 0, returns the result</li>
<li>Returns <code>a.length <=> b.length</code></li>
</ol>
<p><code>ImageList</code> mixes in the <code>Comparable</code> module.</p>
<h4>See also</h4>
<p>
<a href="image1.html#spaceship">Image#<=></a>,
<a href="image3.html#signature">signature</a>
</p>
</div>
<div class="sig">
<h3 id="animate">animate</h3>
<p>
<span class="arg">ilist.</span>animate(<span class="arg">[delay]</span>) <span class="arg">[ { optional arguments } ]</span> ->
<em>self</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Animate the images to an X Window screen. By default displays to the local screen. You can specify a different screen by assigning the name to the
<code>server_name</code> attribute in the optional arguments block.
</p>
<h4>Returns</h4>
<p>self</p>
<h4>Example</h4>
<pre>
ilist.animate
ilist.animate { |options| options.server_name = "other:0.0" }
</pre
>
<h4>See also</h4>
<p><a href="#display">display</a></p>
<h4>Note</h4>
<p>The animate method is not supported on native MS Windows.</p>
<h4>Magick API</h4>
<p>AnimateImages</p>
</div>
<div class="sig">
<h3 id="append">append</h3>
<p><span class="arg">ilist.</span>append(<code>true</code> or <code>false</code>) -> <em>image</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Append all the images in the imagelist, either vertically or horizontally. If the images are not of the same width, any narrow images will be expanded
to fit using the background color.
</p>
<h4>Arguments</h4>
<p>If <code>true</code>, rectangular images are stacked top-to-bottom, otherwise left-to-right.</p>
<h4>Returns</h4>
<p>A image composed of all the images in the imagelist.</p>
<h4>Magick API</h4>
<p>AppendImages</p>
</div>
<div class="sig">
<h3 id="average">average</h3>
<p><span class="arg">ilist.</span>average -> <em>image</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Averages all the images together. Each image in the image must have the same width and height.</p>
<h4>Returns</h4>
<p>A single image representing the average of all the images in the imagelist.</p>
<h4>Example</h4>
<p class="rollover">
<a href="javascript:popup('average.rb.html')">
<!-- This img tag displays the original image when the mouse is over -->
<img
style="display: none"
id="notaveraged"
onmouseout="this.style.display='none'; averaged.style.display=''; averagedspin.style.display='';"
title="Click to see the example script"
src="ex/average_before.gif"
alt="average example" /><!--
This img tag displays the averaged image when the mouse is not over
--><img
style="display:"
id="averaged"
onmouseover="this.style.display='none'; notaveraged.style.display=''; averagedspin.style.display='none';"
src="ex/average_after.gif"
alt="average example"
/></a>
<img
src="ex/images/spin.gif"
alt=""
class="spin"
style="left: 131px; display:"
id="averagedspin"
title="Mouse over the example to see the 3 original images"
/>
</p>
<h4>Magick API</h4>
<p>AverageImages</p>
</div>
<div class="sig">
<h3 id="clone">clone</h3>
<p><span class="arg">ilist</span>.clone -> <em>other_imagelist</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Same as <a href="#dup">dup</a>, but the frozen state of the original is propagated to the copy.</p>
<h4>Returns</h4>
<p>A new imagelist</p>
<h4>See also</h4>
<p><a href="#copy">copy</a></p>
</div>
<div class="sig">
<h3 id="coalesce">coalesce</h3>
<p><span class="arg">ilist.</span>coalesce -> <em>imagelist</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Merges all the images in the imagelist into a new imagelist. Each image in the new imagelist is formed by flattening all the previous images.</p>
<p>
The length of time between images in the new image is specified by the
<a href="imageattrs.html#delay">delay</a> attribute of the input image. The position of the image on the merged images is specified by the
<a href="imageattrs.html#page">page</a> attribute of the input image.
</p>
<h4>Returns</h4>
<p>A new imagelist</p>
<h4>Example</h4>
<p>This example is an animated GIF created by coalescing 25 small images in a grid. Mouse over the image to start the animation.</p>
<p class="rollover">
<a href="javascript:popup('coalesce.rb.html')"
><img
onmouseover="this.src='ex/coalesce_anim.gif'"
onmouseout="this.src='ex/coalesce.gif'"
src="ex/coalesce.gif"
alt="coalesce example"
title="Click the image to see the example script" /></a
><img src="ex/images/spin.gif" alt="" class="spin" style="left: 165px" title="Mouse over the example to see the animation" />
</p>
<h4>See also</h4>
<p>
<a href="#flatten_images">flatten_images</a>,
<a href="#optimize_layers">optimize_layers</a>
</p>
<h4>Magick API</h4>
<p>CoalesceImages</p>
</div>
<div class="sig">
<h3 id="composite_layers">composite_layers</h3>
<p>
<span class="arg">destination_list</span>.composite_layers(<span class="arg">source_list</span>,
<span class="arg">operator</span>=<code>OverCompositeOp</code>) ->
<em>imagelist</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
An image from <span class="arg">source_list</span> is composited over an image from <span class="arg">destination_list</span> until one list is
finished. Use the <a href="imageattrs.html#geometry">geometry</a> and <a href="imageattrs.html#gravity">gravity</a> attributes of the first image in
<span class="arg">destination_list</span> to position the source images over the destination images.
<span class="imquote"
>Unlike a normal composite operation, the canvas offset is also included to the composite positioning. If one of the image lists only contains one
image, that image is applied to all the images in the other image list, regardless of which list it is. In this case it is the image meta-data of the
list which preserved.</span
>
</p>
<h4>Arguments</h4>
<p>
The optional <span class="arg">operator</span> argument specifies a <a href="constants.html#CompositeOperator">CompositeOperator</a> to use for the
compositing operations.
</p>
<h4>Returns</h4>
<p>An imagelist</p>
<h4>Example</h4>
<p>This example is an animated GIF. Mouse over the image to start the animation.</p>
<p class="rollover">
<a href="javascript:popup('composite_layers.rb.html')"
><img
onmouseover="this.src='ex/composite_layers.gif'"
onmouseout="this.src='ex/composite_layers1.gif'"
src="ex/composite_layers1.gif"
alt="composite_layers example"
title="Click the image to see the example script" /></a
><img src="ex/images/spin.gif" alt="" class="spin" style="left: 105px" title="Mouse over the example to see the animation" />
</p>
<h4>Notes</h4>
<p>
This method is equivalent to the <code>-layers Composite</code> option of ImageMagick's <code>convert</code> command. See the
<a href="https://www.imagemagick.org/Usage/anim_mods/#composite">Layers Composition</a>
section in
<a href="https://www.imagemagick.org/Usage/">Examples of ImageMagick Usage</a>
for more information.
</p>
<h4>See also</h4>
<p><a href="#optimize_layers">optimize_layers</a></p>
</div>
<div class="sig">
<h3 id="copy">copy</h3>
<p><span class="arg">ilist.</span>copy -> <em>other_imagelist</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Creates a deep copy of the imagelist. The new imagelist contains a copy of all the images in the original imagelist.</p>
<h4>Returns</h4>
<p>An imagelist</p>
<h4>Example</h4>
<pre>
imagelist2 = imagelist1.copy
</pre
>
<h4>See also</h4>
<p>
<a href="image1.html#copy">Image#copy</a>, <a href="#clone">clone</a>,
<a href="#dup">dup</a>
</p>
</div>
<div class="sig">
<h3 id="cur_image">cur_image</h3>
<p><span class="arg">ilist.</span>cur_image -> <em>image</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Retrieves the image indexed by <a href="#scene">scene</a>. Raises <code>IndexError</code> if there are no images in the list.</p>
<p>
Both the ImageList class and the Image class support the
<code>cur_image</code> method. Of course, in the Image class, <code>cur_image</code> simply returns <code>self</code>. When a method accepts either an
image or a imagelist as an argument, it sends the <code>cur_image</code> method to the argument to get the current image.
</p>
<h4>Returns</h4>
<p>An image</p>
</div>
<div class="sig">
<h3 id="deconstruct">deconstruct</h3>
<p><span class="arg">ilist.</span>deconstruct -> <em>imagelist</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
This method constructs a new imagelist containing images that include only the changed pixels between each image and its successor. The resulting
imagelist usually produces a much smaller file.
</p>
<p>
The <code>deconstruct</code> method starts by copying the first image in the list to the output imagelist. Then, for each pair of images,
<code>deconstruct</code> computes the smallest rectangle that encompasses all the changes between the first and second image and stores just the changed
rectangle of the second image, along with the offset of the rectangle relative to the boundary of the first image.
</p>
<h4>Returns</h4>
<p>A new imagelist</p>
<h4>Magick API</h4>
<p>DeconstructImages</p>
<h4>See also</h4>
<p><a href="#optimize_layers">optimize_layers</a></p>
</div>
<div class="sig">
<h3 id="dup">dup</h3>
<p><span class="arg">ilist</span>.dup -> <em>other_imagelist</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Makes a <em>shallow</em> copy of the receiver. The image elements in the new imagelist are references to the image elements in the original imagelist,
not copies.
</p>
<h4>See also</h4>
<p><a href="#copy">copy</a>, <a href="#clone">clone</a></p>
</div>
<div class="sig">
<h3 id="display">display</h3>
<p>
<span class="arg">ilist.</span>display <span class="arg">[ { optional arguments } ]</span> ->
<em>self</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Displays the images in the imagelist to any X Window screen. By default displays to the local screen. You can specify a different screen by assigning
the name to the <code>server_name</code> attribute in the optional arguments block.
</p>
<h4>Returns</h4>
<p>self</p>
<h4>See also</h4>
<p>
<a href="#animate">animate</a>,
<a href="image1.html#display">Image#display</a>
</p>
<h4>Note</h4>
<p>The display method is not supported on native MS Windows.</p>
<h4>Magick API</h4>
<p>DisplayImages</p>
</div>
<div class="sig">
<h3 id="flatten_images">flatten_images</h3>
<p><span class="arg">ilist.</span>flatten_images -> <em>image</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Combines all the images in the imagelist into a single image by overlaying each successive image onto the preceding images. If a image has transparent
areas, the underlying image will show through. Use the
<a href="imageattrs.html#page">page</a> attribute to specify the position of each image with respect to the preceding images.
</p>
<p class="imquote">This is useful for combining Photoshop layers into a single image.</p>
<h4>Returns</h4>
<p>An image</p>
<h4>Example</h4>
<p>
<a href="javascript:popup('flatten_images.rb.html')"
><img alt="flatten_images example" src="ex/flatten_images.gif" title="Click to see the example script"
/></a>
</p>
<h4>See also</h4>
<p>
<a href="#coalesce">coalesce</a>,
<a href="#optimize_layers">optimize_layers</a>
</p>
<h4>Magick API</h4>
<p>MergeImageLayers with the FlattenLayer method.</p>
</div>
<div class="sig">
<h3 id="from_blob">from_blob</h3>
<p>
<span class="arg">ilist.</span>from_blob(blob<span class="arg">[, blob...]</span>) <span class="arg">[ { optional arguments } ]</span> ->
<em>self</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Creates images from the blob (<em>B</em>inary <em>L</em>arge <em>O</em>bjects) arguments and appends the images to the imagelist.</p>
<h4>Arguments</h4>
<p>
A <em>blob</em> can be a string containing an image file such as a JPEG or GIF. The string can contain a multi-image file such as an animated GIF or a
Photoshop image with multiple layers. A blob can also be one of the strings produced by <a href="#to_blob">to_blob</a>. Control how the image(s) are
created by setting additional <a href="info.html">Image::Info</a> attributes in the optional block argument. Useful attributes include
<a href="info.html#scene">scene</a>, <a href="info.html#number_scenes">number_scenes</a>, and <a href="info.html#extract">extract</a>.
</p>
<h4>Returns</h4>
<p>
An image created from the blob argument(s). The
<code>scene</code> attribute is set to the last image in the imagelist.
</p>
<h4>Example</h4>
<pre>
require "rmagick"
f = File.open('Cheetah.jpg')
blob = f.read
ilist = Magick::ImageList.new
ilist.from_blob(blob)
ilist.display
</pre
>
<h4>See also</h4>
<a href="#to_blob">to_blob</a>, <a href="image3.html#to_blob">Image#to_blob</a>,
<a href="image1.html#from_blob">Image.from_blob</a>
<h4>Magick API</h4>
<p>BlobToImageList</p>
</div>
<div class="sig">
<h3 id="fx">fx</h3>
<p><span class="arg">ilist</span> .fx(<span class="arg">expression</span> [, <span class="arg">channel</span>...]) -> <em>image</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Applies the specified mathematical expression to the input images. This method corresponds to ImageMagick's
<a href="https://imagemagick.org/script/fx.php">-fx</a> operator.
</p>
<h4>Arguments</h4>
<dl>
<dt>expression</dt>
<dd>A mathematical expression of the form accepted by the -fx operator..</dd>
<dt>channel...</dt>
<dd>
0 or more
<a href="constants.html#ChannelType">ChannelType</a> arguments. Specify the output channels. If no channels are specified the result is set over all
channels except the opacity channel.
</dd>
</dl>
<h4>Notes</h4>
<ul>
<li>
Fx expressions are interpreted. Therefore this method can be quite slow depending on the complexity of the expression. Generally you will get better
performance by accessing the image pixels as
<a href="struct.html#Pixel">Pixel</a> objects (see <a href="image2.html#get_pixels">get_pixels</a> and <a href="image3.html#view">view</a>) and using
Ruby code to perform the mathematics.
</li>
<li>
The <code>u</code> and <code>v</code> symbols refer to the 0th and 1st image in the list. The image reference index (<code>u[2]</code> for example)
works as expected. The current <a href="#scene">scene number</a> has no meaning in the context of the <code>fx</code> method.
</li>
<li>
To specify a non-default pixel interpolation method, set the
<a href="imageattrs.html#pixel_interpolation_method">pixel_interpolation_method</a>
attribute of the last image in the list.
</li>
</ul>
<h4>Returns</h4>
<p>The image created by the expression.</p>
<h4>Example</h4>
<pre>
# Produce a navy blue image from a black image
imgl = Magick::ImageList.new
imgl << Magick::Image.new(64, 64) { |options| options.background_color = 'black'}
res = imgl.fx('1/2', Magick::BlueChannel)
</pre
>
<h4>ImageMagick API</h4>
<p>FxImageChannel</p>
<h4>See also</h4>
<p>
<a href="image2.html#get_pixels">get_pixels</a>,
<a href="image3.html#view">view</a>
</p>
</div>
<div class="sig">
<h3 id="inspect">inspect</h3>
<p><span class="arg">ilist.</span>inspect -> <em>string</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Produces a string that describes the images in the imagelist.</p>
<h4>Arguments</h4>
<h4>Returns</h4>
<p>
The returned string is a concatenation of the strings returned by
<a href="image2.html#inspect">Image#inspect</a> for all the images in the imagelist.
</p>
<h4>Example</h4>
<pre>
i = Magick::ImageList.new("images/Button_A.gif", "images/Button_B.gif")
» [images/Button_A.gif GIF 127x120+0+0 PseudoClass 256c 8-bit 18136b
images/Button_B.gif GIF 127x120+0+0 PseudoClass 256c 8-bit 5157b]
scene=1
</pre
>
<h4>See also</h4>
<p><a href="image2.html#inspect">Image#inspect</a></p>
</div>
<div class="sig">
<h3 id="montage">montage</h3>
<p>
<span class="arg">ilist.</span>montage <span class="arg">[ { optional arguments } ]</span> ->
<em>imagelist</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Creates a composite image by reducing the size of the input images and arranging them in a grid on the background color or texture of your choice. There
are many configuration options. For example, you can specify the number of columns and rows, the distance between images, and include a label with each
small image (called a <em>tile</em>).
</p>
<p>All of <code>montage</code>'s configuration options are specified by assigning values to attributes in a block associated with the method call.</p>
<p>
As you can see in the examples below, when you assign a value to a montage attribute you must specify <code>self</code> as the receiver so that Ruby can
distinguish the method call from an assignment to a local variable.
</p>
<p>You may assign a <a href="struct.html#Pixel">Pixel</a> object to any attribute that accepts a color name.</p>
<h4>Montage attributes</h4>
<dl>
<dt>background_color=</dt>
<dd>The composite image background color.</dd>
<dt>border_color=</dt>
<dd>The tile border color.</dd>
<dt>border_width=</dt>
<dd>The tile border width in pixels.</dd>
<dt>compose=</dt>
<dd>
The
<a href="constants.html#CompositeOperator">composite operator</a> to use when compositing the tile images onto the background. The default composition
operator is <code>OverCompositeOp</code>.
</dd>
<dd>
<em>Hint:</em> You can use a different composite operator for each tile by setting each image's
<a href="imageattrs.html#compose">compose=</a> attribute to the desired operator. In the optional arguments block, set <code>compose</code> to
UndefinedCompositeOp.
</dd>
<dt>fill=</dt>
<dd>If the tiles have labels, the label fill color. The default fill color is black.</dd>
<dt>font=</dt>
<dd>If the tiles have labels, the label font. The default font is Helvetica.</dd>
<dt>frame=</dt>
<dd>
The size of an ornamental frame surrounding each tile. The frame specification may be either a string or a
<a href="struct.html#Geometry">Geometry</a> object. If the argument is a string, it must have the form
<code><width>x<height>+<outer bevel width>+<inner bevel width></code>. If the argument is a Geometry object, specify the width
and height of the frame with the <code>width</code> and <code>height</code> attributes, and specify the outer bevel width and the inner bevel width
with the <code>x</code> and <code>y</code>
attributes. The values are in pixels. For example, to surround each tile with a frame 20 pixels wide by 20 pixels high and a 4-pixel inner and outer
bevel, use:
<pre>
options.frame = "20x20+4+4"
</pre
>
or
<pre>
options.frame = Magick::Geometry.new(20,20,4,4)
</pre
>
</dd>
<dd>If the tile has a label, the label is included in the frame. The default is to have no frame.</dd>
<dd>See <a href="image2.html#frame">Image#frame</a>.</dd>
<dt>geometry=</dt>
<dd>
The size of the tiles and the distance between tiles. The value can be either a <a href="imusage.html#geometry">geometry string</a> or a
<a href="struct.html#Geometry">Geometry</a> object. The geometry string has the form:
<code><tile-width>x<tile-height>+<distance-between-columns>+<distance-between-rows></code>. If you use a Geometry object,
specify the tile width and height with the <code>width</code> and <code>height</code> attributes, and the distance between rows and distance between
columns by the <code>x</code> and <code>y</code>
attributes. To create tiles that are 130 pixels wide and 194 pixels tall, with 10 pixels between each column of tiles and 5 between each row, use:
<pre>
options.geometry = "130x194+10+5"
</pre
>
or
<pre>
options.geometry = Magick::Geometry.new(130, 194, 10, 5)
</pre
>
Both the geometry string and the <code>Geometry</code> object support flags that specify additional constraints. The default geometry is
"120x120+4+3>".
</dd>
<dt>gravity=</dt>
<dd>The <a href="constants.html#GravityType">direction</a> used when adding the tile labels. (See <a href="draw.html#Draw.annotate">annotate</a>.)</dd>
<dt>matte_color=</dt>
<dd>The matte color. The default is #bdbdbd.</dd>
<dt>pointsize=</dt>
<dd>If the tiles have labels, the size of the label font in points. The default is 12 points.</dd>
<dt>shadow=</dt>
<dd>If set to <code>true</code>, adds a drop shadow to each tile. The default is <code>false</code>.</dd>
<dt>stroke=</dt>
<dd>If the tiles have labels, sets the stroke (outline) color of the label text. The default is "transparent".</dd>
<dt>texture=</dt>
<dd>
A image to be tiled on the background of the composite image. If present, this attribute overrides the background color. For example, to use
ImageMagick's built-in "granite" texture as the background, use:
<pre>
options.texture = Magick::Image.read("granite:").first
</pre
>
<p>The default is no texture.</p>
</dd>
<dt>tile=</dt>
<dd>
The number of columns and rows to use when arranging the tiles on the composite image. The value can be either a string or a
<a href="struct.html#Geometry">Geometry</a>
object. If the value is a string, it should have the form
<code>"<columns>x<rows>"</code>. If the value is a Geometry object, specify the number of columns as the <code>width</code> attribute and
the number of rows as the <code>height</code> attribute. <code>montage</code> always generates all the rows, leaving empty cells if necessary. To
arrange the tiles 4 across and 10 down, use:
<pre>
options.tile = "4x10"
</pre
>
or
<pre>
options.tile = Magick::Geometry.new(4,10)
</pre
>
<p>The default is "6x4". If there are too many tiles to fit on one composite image, <code>montage</code> creates multiple composite images.</p>
</dd>
<dt>title=</dt>
<dd>Adds a title over the whole montage.</dd>
</dl>
<h4>Tile labels</h4>
<p>
To add labels to the tiles, assign a "Label" property to each image. The
<code>montage</code> method will use the value of the property as the label. For example,
</p>
<pre>
img[2]['Label'] = "Mom's Birthday"
</pre
>
<p>See <a href="image1.html#aset">[]=</a>.</p>
<h4>Returns</h4>
<p>An imagelist that contains as many images as are required to display all the tiles.</p>
<h4>Magick API</h4>
<p>MontageImages</p>
</div>
<div class="sig">
<h3 id="morph">morph</h3>
<p>
<span class="arg">ilist.</span>morph(<span class="arg">n</span>) ->
<em>imagelist</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Transforms a image into another image by inserting
<code>n</code> in-between images. Requires at least two images. If more images are present, the 2nd image is transformed into the 3rd, the 3rd to the
4th, etc.
</p>
<h4>Arguments</h4>
<p>The number of in-between images to insert between each pair of images.</p>
<h4>Returns</h4>
<p>An imagelist containing copies of the original images plus the in-between images.</p>
<h4>Example</h4>
<p>
This animated GIF was created by reading the "0", "1", "2" and "3" images, then using <code>morph</code> to create 8 images between each original image.
Mouse over the image to start the animation.
</p>
<p class="rollover">
<a href="javascript:popup('morph.rb.html')"
><img
onmouseover="this.src='ex/morph.gif'"
onmouseout="this.src='ex/images/Button_0.gif'"
src="ex/images/Button_0.gif"
alt="morph example"
title="Click the image to see the example script" /></a
><img src="ex/images/spin.gif" alt="" class="spin" style="left: 131px" title="Mouse over the example to see the animation" />
</p>
<h4>Magick API</h4>
<p>MorphImages</p>
</div>
<div class="sig">
<h3 id="mosaic">mosaic</h3>
<p><span class="arg">ilist.</span>mosaic -> <em>image</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Composites all the images into a single new image. The location of each image is determined by the value of its
<a href="imageattrs.html#page">page</a> attribute.
</p>
<h4>Returns</h4>
<p>An image</p>
<h4>Example</h4>
<p>
<a href="javascript:popup('mosaic.rb.html')"><img src="ex/mosaic.gif" alt="mosaic example" title="Click to see the example script" /></a>
</p>
<h4>See also</h4>
<a href="#coalesce">coalesce</a>, <a href="#flatten_images">flatten_images</a>, <a href="#montage">montage</a>,
<a href="#optimize_images">optimize_images</a>
<h4>Magick API</h4>
<p>MergeImageLayers with the MosaicLayer method.</p>
</div>
<div class="sig">
<h3 id="new_image">new_image</h3>
<p>
<span class="arg">ilist.</span>new_image(<span class="arg">columns</span>, <span class="arg">rows[, fill]</span>)
<span class="arg">[ { optional arguments } ]</span>
-> <em>self</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Adds a new image to the imagelist. The image can have an optional
<a href="struct.html#fill">fill</a> applied to it.
</p>
<h4>Arguments</h4>
<p>
Creates a new image with the specified number of rows and columns. If the optional <code>fill</code> argument is used, calls the
<code>fill</code> method to fill the image. Otherwise, the image is filled with the background color.
</p>
<p>
You can set any <a href="info.html">Image::Info</a> attributes in an associated block. These attributes supply options to be used when creating the
image. For example, you can specify the <a href="imageattrs.html#background_color">background color</a> to fill the image with (see the example), the
<a href="imageattrs.html#depth">depth</a>, <a href="imageattrs.html#border_color">border color</a>, etc.
</p>
<h4>Returns</h4>
<p>self</p>
<h4>Example</h4>
<p>Create a square red image.</p>
<pre>
ilist = Magick::ImageList.new
ilist.new_image(100, 100) { |options| options.background_color = "red" }
</pre
>
</div>
<div class="sig">
<h3 id="optimize_layers">optimize_layers</h3>
<p><span class="arg">ilist</span>.optimize_layers(<span class="arg">layer_method</span>) -> <em>imagelist</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Optimizes or compares the images in the list. Equivalent to the
<code>-layers</code> option in ImageMagick's <code>mogrify</code> command.
</p>
<p>
The <code>optimize_layers</code> method corresponds to the <code>-layers</code> option on ImageMagick's <code>convert</code> and
<code>mogrify</code> commands. Anthony Thyssen's excellent
<a href="https://www.imagemagick.org/Usage/">Examples of ImageMagick Usage</a>
site has very detailed
<a href="https://www.imagemagick.org/Usage/anim_opt/">information and examples</a>
of the <code>-layers</code> option and and the optimization methods .
</p>
<h4>Arguments</h4>
<p>One of the following ImageLayerMethod enum values:</p>
<dl>
<dt>CoalesceLayer</dt>
<dd class="imquote">
Equivalent to [<a href="#coalesce">coalesce</a>]. Apply the GIF disposal methods set in the current image sequence to form a fully defined animation
sequence without, as it should be displayed. Effectively converting a GIF animation into a 'film strip' like animation.
</dd>
<dt>CompareAnyLayer</dt>
<dd class="imquote">
Crop the second and later frames to the smallest rectangle that contains all the differences between the two images. No GIF disposal methods are taken
into account. This is exactly the same as [<a href="#deconstruct">deconstruct</a>], and does not preserve a animation's normal working, especially
when a animation used GIF disposal methods such as 'Previous' or 'Background'.
</dd>
<dt>CompareClearLayer</dt>
<dd class="imquote">
As [CompareAnyLayer] but crop to the bounds of any opaque pixels which become transparent in the second frame. That is the smallest image needed to
mask or erase pixels for the next frame.
</dd>
<dt>CompareOverlayLayer</dt>
<dd class="imquote">
As [CompareAnyLayer] but crop to pixels that add extra color to the next image, as a result of overlaying color pixels. That is the smallest single
overlaid image to add or change colors. This can, be used with the -compose alpha composition method 'change-mask', to reduce the image to just the
pixels that need to be overlaid.
</dd>
<dt>DisposeLayer</dt>
<dd class="imquote">
This is like [CoalesceLayer] but shows the look of the animation after the GIF disposal method has been applied, before the next sub-frame image is
overlaid. That is the 'dispose' image that results from the application of the GIF disposal method. This allows you to check what is going wrong with
a particular animation you may be developing.
</dd>
<dt>FlattenLayer</dt>
<dd>
<span class="imquote"
>Create a canvas the size of the first images virtual canvas using the current background color, and compose each image in turn onto that canvas.
Images falling outside that canvas will be clipped. Final image will have a zero virtual canvas offset. This is usually used as one of the final
'image layering' operations overlaying all the prepared image layers into a final image. For a single image this method can also be used to fillout
a virtual canvas with real pixels, or to underlay a opaque color to remove transparency from an image.</span
>
This method corresponds to
<a href="#flatten_images">flatten_images</a>, above.
</dd>
<dt>MergeLayers</dt>
<dd class="imquote">
As [FlattenLayer] but merging all the given image layers into a new layer image just large enough to hold all the image without clipping or extra
space. The new image's virtual offset will prevere the position of the new layer, even if this offset is negative. the virtual canvas size of the
first image is preserved. Caution is advised when handling image layers with negative offsets as few image file formats handle them correctly.
</dd>
<dt>MosaicLayer</dt>
<dd>
<span class="imquote"
>As [FlattenLayer] but expanding the initial canvas size of the first image so as to hold all the image layers. However as a virtual canvas is
'locked' to the origin, by definition, image layers with a negative offsets will still be clipped by the top and left edges. This method is commonly
used to layout individual image using various offset but without knowing the final canvas size. The resulting image will, like FlattenLayer not have
any virtual offset, so can be saved to any image file format.</span
>
This method corresponds to <a href="#mosaic">mosaic</a>, above.
</dd>
<dt>OptimizeImageLayer</dt>
<dd class="imquote">
Optimize a coalesced animation into GIF animation by reducing the number of pixels per frame as much as possible by attempting to pick the best GIF
disposal method to use, while ensuring the result will continue to animate properly. There is no guarantee that the best optimization will be found.
But then no reasonably fast GIF optimization algorithm can do this. However this does seem to do better than most other GIF frame optimizers seen.
</dd>
<dt>OptimizeLayer</dt>
<dd class="imquote">
Optimize a coalesced animation into GIF animation using a number of general techniques. This is currently a short cut to apply both the
[OptimizeImageLayer] and [OptimizeTransLayer] methods but will expand to include other methods.
</dd>
<dt>OptimizePlusLayer</dt>
<dd class="imquote">
As [OptimizeImageLayer] but attempt to improve the overall optimization by adding extra frames to the animation, without changing the final look or
timing of the animation. The frames are added to attempt to separate the clearing of pixels from the overlaying of new additional pixels from one
animation frame to the next. If this does not improve the optimization (for the next frame only), it will fall back to the results of the previous
normal [OptimizeImageLayer] technique. There is the possibility that the change in the disposal style will result in a worsening in the optimization
of later frames, though this is unlikely. In other words there no guarantee that it is better than the normal 'optimize-frame' technique.
</dd>
<dt>OptimizeTransLayer</dt>
<dd class="imquote">
Given a GIF animation, replace any pixel in the sub-frame overlay images with transparency, if it does not change the resulting animation by more than
the current fuzz factor. This should allow a existing frame optimized GIF animation to compress into a smaller file size due to larger areas of one
(transparent) color rather than a pattern of multiple colors repeating the current disposed image of the last frame.
</dd>
<dt>RemoveDupsLayer</dt>
<dd class="imquote">
Remove (and merge time delays) of duplicate consecutive images, so as to simplify layer overlays of coalesced animations. Usually this is a result of
using a constant time delay across the whole animation, or after a larger animation was split into smaller sub-animations. The duplicate frames could
also have been used as part of some frame optimization methods.
</dd>
<dt>RemoveZeroLayer</dt>
<dd class="imquote">
Remove any image with a zero time delay, unless ALL the images have a zero time delay (and is not a proper timed animation, a warning is then issued).
In a GIF animation, such images are usually frames which provide partial intermediary updates between the frames that are actually displayed to users.
These frames are usually added for improved frame optimization in GIF animations.
</dd>
<dt>TrimBoundsLayer</dt>
<dd class="imquote">
Find the minimal bounds of all the images in the current image sequence, then adjust the offsets so all images are contained on a minimal positive
canvas. None of the image data is modified, only the virtual canvas size and offset. Then all the images will have the same canvas size, and all will
have a positive offset, at least one image will touch every edge of that canvas with actual pixel data, though that data may be transparent.
</dd>
</dl>
<p>Some of these values are not supported by older versions of ImageMagick. To see what values are available, enter the following code in irb:</p>
<pre>
Magick::ImageLayerMethod.values {|v| puts v}
</pre
>
<p>In releases of ImageMagick before 6.3.6, this type was called MagickLayerMethod, so you may need to use this instead:</p>
<pre>
Magick::MagickLayerMethod.values {|v| puts v}
</pre
>
<h4>Returns</h4>
<p>A new imagelist</p>
<h4>See also</h4>
<p><a href="#composite_layers">composite_layers</a></p>
<p><a href="#deconstruct">deconstruct</a> is an alias for <code>optimize_layers</code> with the <code>CompareAnyLayer</code> argument.</p>
<p><a href="#coalesce">coalesce</a> is an alias for <code>optimize_layers</code> with the <code>CoalesceLayer</code> argument.</p>
<h4>Magick API</h4>
<p>OptimizeImageLayers, CompareImageLayers</p>
</div>
<div class="sig">
<h3 id="ping">ping</h3>
<p>
<span class="arg">ilist.</span>ping(<span class="arg">filename</span>[, <span class="arg">filename</span>...]) -> <em>self</em><br />
<span class="arg">ilist.</span>ping(<span class="arg">file</span>[, <span class="arg">file</span>...]) -> <em>self</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Reads the image files and creates one or more images that contain all the image attributes but without the pixel data. If all you need is the image
attributes, the <code>ping</code> method is much faster and consumes less memory than <a href="#read"><code>read</code></a
>.
</p>
<h4>Arguments</h4>
<p>One or more image file names or open file objects.</p>
<h4>Returns</h4>
<p>self</p>
<h4>Example</h4>
<pre>
ilist = Magick::ImageList.new
ilist.ping "Button_A.gif"
puts "The image has #{i.columns} columns and #{i.rows} rows." »
The image has 127 columns and 120 rows.
</pre
>
<h4>See also</h4>
<a href="#read">read</a>
<h4>Magick API</h4>
<p>PingImage</p>
</div>
<div class="sig">
<h3 id="quantize">quantize</h3>
<p>
<span class="arg">ilist.</span>quantize(nc=256, colorspace=<code>RGBColorspace</code>, dither=<code>RiemersmaDitherMethod</code>, tree_depth=0,
measure_error=<code>false</code>) -> <em>imagelist</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p class="imquote">
Analyzes the colors within a set of reference images and chooses a fixed number of colors to represent the set. The goal of the algorithm is to minimize
the difference between the input and output images while minimizing the processing time.
</p>
<h4>Arguments</h4>
<dl>
<dt>nc</dt>
<dd>
The maximum number of colors to use in the output images. Must be less than or equal to
<a href="constants.html#Miscellaneous_constants">QuantumRange</a>.
</dd>
<dt>colorspace</dt>
<dd class="imquote">
The <a href="constants.html#ColorspaceType">colorspace</a> to quantize in. Color reduction, by default, takes place in the RGB color space. Empirical
evidence suggests that distances in color spaces such as YUV or YIQ correspond to perceptual color differences more closely than do distances in RGB
space. The Transparent color space behaves uniquely in that it preserves the matte channel of the image if it exists.
</dd>
<dt>dither</dt>
<dd>
A <a href="constants.html#DitherMethod">DitherMethod</a> value. See the documentation for the
<a href="https://imagemagick.org/script/command-line-options.php#dither"> ImageMagick -dither option</a>
for more information.
</dd>
<dt>tree_depth</dt>
<dd class="imquote">
Specify the tree depth to use while quantizing. The values 0 and 1 support automatic tree depth determination. The tree depth may be forced via values
ranging from two to eight. The ideal tree depth depends on the characteristics of the input image, and may be determined through experimentation.
</dd>
<dt>measure_error</dt>
<dd>
<span class="imquote">Calculate quantization errors when quantizing the image.</span>
Stores the results for each image in the imagelist
<a href="imageattrs.html#mean_error_per_pixel">mean_error_per_pixel</a>,
<a href="imageattrs.html#normalized_maximum_error">normalized_maximum_error</a>, and
<a href="imageattrs.html#normalized_mean_error">normalized_mean_error</a>
attributes. Stores the number of colors used for the image in the
<a href="imageattrs.html#total_colors">total_colors</a> attribute.
</dd>
</dl>
<h4>Returns</h4>
<p>A new imagelist containing quantized copies of the images in the original image.</p>
<h4>Example</h4>
<p>
This example shows the effect of quantizing 3 images to a set of 16 colors in the RGB colorspace. Mouse over the image to see the images before
quantizing.
</p>
<p class="rollover">
<a href="javascript:popup('quantize_m.rb.html')"
><img
src="ex/quantize_m_after.jpg"
alt="quantize example"
title="Click to see the example script"
onmouseover="this.src='ex/quantize_m_before.jpg'"
onmouseout="this.src='ex/quantize_m_after.jpg'"
/></a>
<img src="ex/images/spin.gif" alt="" class="spin" style="left: 505px" title="Mouse over the example to see the original image" />
</p>
<h4>See also</h4>
<p><a href="image3.html#quantize">Image#quantize</a></p>
<h4>Magick API</h4>
<p>QuantizeImages</p>
</div>
<div class="sig">
<h3 id="read">read</h3>
<p>
<span class="arg">ilist.</span>read(<span class="arg">filename[, filename...]</span>)
<span class="arg">[ { optional arguments } ]</span> -> <em>self</em><br />
<span class="arg">ilist.</span>read(<span class="arg">file[, file...]</span>) <span class="arg">[ { optional arguments } ]</span> ->
<em>self</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Reads one or more image files and adds the images to the imagelist. After reading all the files, sets the <a href="#scene">scene</a> number to the last
image in the list.
</p>
<p>The image files may be multi-frame (animated or layered) files. In this case <code>read</code> adds multiple images per file to the imagelist.</p>
<h4>Arguments</h4>
<p>
One or more filenames or open file objects. You can also specify optional arguments to be used when reading the file(s) by setting
<a href="info.html">Image::Info</a> attributes in the optional block.
</p>
<h4>Returns</h4>
<p>self</p>
<h4>Example</h4>
<pre>
i = Magick::ImageList.new
number = '0'
4.times do
i.read "images/Button_" + number + ".gif"
number.succ!
end
</pre
>
<p>Also see the morph.rb example and the demo.rb example.</p>
<h4>See also</h4>
<p><a href="image1.html#read">Image.read</a></p>
<h4>Magick API</h4>
<p>ReadImage</p>
<h4>Notes</h4>
<p>
You can create images using ImageMagick's built-in formats with the
<code>read</code> method. See <a href="imusage.html#builtin_formats">Built-in image formats</a>.
</p>
</div>
<div class="sig">
<h3 id="remap">remap</h3>
<p>
<span class="arg">ilist</span>.remap(<span class="arg">remap_image</span>=nil, <span class="arg">dither</span>=RiemersmaDitherMethod) ->
<em>self</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Reduce the colors used in the imagelist to the set of colors in
<span id="arg">remap_image</span>.
</p>
<h4>Arguments</h4>
<dl>
<dt>remap_image</dt>
<dd>The reference image</dd>
<dt>dither</dt>
<dd>
A <a href="constants.html#DitherMethod">DitherMethod</a> value. RiemersmaDitherMethod is the default. To disable dithering specify NoDitherMethod.
</dd>
</dl>
<h4>Returns</h4>
<p>self</p>
<h4>Example</h4>
<p>
This example shows the effect of reducing the colors used in the apple, beach scene, and leaf images to the set of colors used in the yellow rose image.
</p>
<p>
<a href="javascript:popup('remap_images.rb.html')"
><img alt="remap_images example" src="ex/remap_images.jpg" title="Click to see the example script"
/></a>
</p>
<h4>See also</h4>
<p><a href="image3.html#remap">Image#remap</a></p>
<h4>Magick API</h4>
<p>RemapImages (available in ImageMagick 6.4.3-6)</p>
</div>
<div class="sig">
<h3 id="to_blob">to_blob</h3>
<p>
<span class="arg">ilist.</span>to_blob <span class="arg">[ { optional arguments } ]</span> ->
<em>string</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
Converts the images in the imagelist to a <em>blob</em>.
<span class="imquote">A blob contains data that directly represent a particular image format in memory instead of on disk.</span>
</p>
<p>
Control the format of the blob by setting
<a href="info.html">Image::Info</a> attributes in an associated block.
</p>
<h4>Returns</h4>
<p>The blob in the form of a string</p>
<h4>Example</h4>
<pre>
i = Magick::ImageList.new "birthday.png"
s = i.to_blob » a string representing the image.
</pre
>
<h4>See also</h4>
<p>
<a href="#from_blob">from_blob</a>, <a href="image3.html#to_blob">Image#to_blob</a>,
<a href="image1.html#from_blob">Image.from_blob</a>
</p>
<h4>Magick API</h4>
<p>ImageListToBlob</p>
</div>
<div class="sig">
<h3 id="to_a">to_a</h3>
<p><span class="arg">ilist</span>.to_a -> <em>array</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Returns an array containing all the images in the list.</p>
<h4>Returns</h4>
<p>An array</p>
</div>
<div class="sig">
<h3 id="write">write</h3>
<p>
<span class="arg">ilist.</span>write(<span class="arg">filename</span>) <span class="arg">[ { optional arguments } ]</span> -> <em>self</em
><br />
<span class="arg">ilist.</span>write(<span class="arg">file</span>) <span class="arg">[ { optional arguments } ]</span> ->
<em>self</em>
</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>
If the image format
<a href="imusage.html#formats">indicated by the filename</a> supports multiple images per file (animated images), <code>write</code> writes all the
images in the imagelist to a single file. Otherwise, <code>write</code> writes each image to a separate file.
</p>
<p>Regardless of the original format, <code>write</code> converts the images to the format specified by the filename.</p>
<p>
If the imagelist contains more than one image and the output format does not support multi-frame images, each image is written to a file that has the
filename you specify followed by a period (.) and the scene number. You can change this behavior by embedding a %d, %0Nd, %o, %0No, %x, or %0Nx printf
format specification in the file name.
</p>
<h4>Arguments</h4>
<p>
A filename or open file object. Indicate the desired image
<a href="imusage.html#formats">format</a> either by the suffix (i.e. <code>.jpg</code>, <code>.png</code>) or the prefix (<code>ps:</code>) to the
filename. If the argument is an open file object, you can specify a format for each image in the list by setting its
<a href="imageattrs.html#format">format</a> attribute. (See the Notes section for <a href="image3.html#write">Image#write</a>.)
</p>
<p>
You can also specify optional arguments by setting
<a href="info.html">Image::Info</a> attributes in an associated block.
</p>
<h4>Returns</h4>
<p>self, or <code>nil</code> if the format cannot be determined.</p>
<h4>Example</h4>
<pre>
# The PNG format does not support multi-frame files,
# so each image is written to a separate file.
i = Magick::ImageList.new "animated.gif"
p i.length » 3 # contains 3 images
i.write "test.png" » test.png.0
» test.png.1
» test.png.2
# ImageMagick's MIFF format does support multi-frame
# files, so all 3 images are written to one file.
i.write "animated.miff" » animated.miff
</pre
>
<h4>See also</h4>
<p><a href="image3.html#write">Image#write</a></p>
<h4>Magick API</h4>
<p>WriteImages</p>
</div>
<p class="spacer"> </p>
<div class="nav">« <a href="magick.html">Prev</a> | <a href="index.html">Contents</a> | <a href="imageattrs.html">Next</a> »</div>
</body>
</html>
|
