/usr/share/doc/ruby-rmagick-doc/html/info.html is in ruby-rmagick-doc 2.16.0-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://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 Image::Info - Optional method
arguments</title>
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<meta name="GENERATOR" content="Quanta Plus" />
<meta name="Copyright" content=
"Copyright (C) 2006 by Timothy P. Hunter" />
<link rel="stylesheet" type="text/css" href="css/doc.css" />
<script type="text/javascript" src="scripts/doc.js">
</script>
<style type="text/css">
/*<![CDATA[*/
/* Styles local to this page. */
h2 {
margin-top: 1em;
margin-bottom: 1em;
padding-left: .3em;
padding-right: .3em;
padding-bottom: .5em;
padding-top: .5em;
background-color: #545454;
color: white;
}
#intro h2 {
clear: both;
}
#compression_notes li {
font-style: italic;
}
/*]]>*/
</style>
</head>
<body>
<h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
<div class="nav">
« <a href="struct.html">Prev</a> | <a href=
"index.html">Contents</a> | <a href=
"constants.html">Next</a> »
</div>
<h1>class Image::Info - Optional method arguments</h1>
<div id="toc">
<h2>Table of Contents</h2>
<h3>instance methods</h3>
<ul>
<li><a href="#aset">[]=</a></li>
<li><a href="#aref">[]</a></li>
<li><a href="#channel">channel</a></li>
<li><a href="#define">define</a></li>
<li><a href="#undefine">undefine</a></li>
</ul>
<h3>attribute methods</h3>
<div class="toccol">
<ul>
<li><a href="#antialias">antialias</a></li>
<li><a href="#attenuate">attenuate</a></li>
<li><a href="#authenticate">authenticate</a></li>
<li><a href="#background_color">background_color</a></li>
<li><a href="#border_color">border_color</a></li>
<li><a href="#caption">caption</a></li>
<li><a href="#colorspace">colorspace</a></li>
<li><a href="#comment">comment</a></li>
<li><a href="#compression">compression</a></li>
<li><a href="#delay">delay</a></li>
<li><a href="#density">density</a></li>
<li><a href="#depth">depth</a></li>
<li><a href="#dispose">dispose</a></li>
<li><a href="#dither">dither</a></li>
<li><a href="#endian">endian</a></li>
</ul>
</div>
<div class="toccol">
<ul>
<li><a href="#extract">extract</a></li>
<li><a href="#filename">filename</a></li>
<li><a href="#fill">fill</a></li>
<li><a href="#font">font</a></li>
<li><a href="#format">format</a></li>
<li><a href="#fuzz">fuzz</a></li>
<li><a href="#gravity">gravity</a></li>
<li><a href="#image_type">image_type</a></li>
<li><a href="#interlace">interlace</a></li>
<li><a href="#label">label</a></li>
<li><a href="#matte_color">matte_color</a></li>
<li><a href="#monitor">monitor</a></li>
<li><a href="#monochrome">monochrome</a></li>
<li><a href="#orientation">orientation</a></li>
<li><a href="#origin">origin</a></li>
</ul>
</div>
<div class="toccol">
<ul>
<li><a href="#page">page</a></li>
<li><a href="#pointsize">pointsize</a></li>
<li><a href="#quality">quality</a></li>
<li><a href="#sampling_factor">sampling_factor</a></li>
<li><a href="#scene">scene</a></li>
<li><a href="#server_name">server_name</a></li>
<li><a href="#size">size</a></li>
<li><a href="#stroke">stroke</a></li>
<li><a href="#stroke_width">stroke_width</a></li>
<li><a href="#tile_offset">tile_offset</a></li>
<li><a href="#texture">texture</a></li>
<li><a href="#transparent_color">transparent_color</a></li>
<li><a href="#undercolor">undercolor</a></li>
<li><a href="#units">units</a></li>
<li><a href="#view">view</a></li>
</ul>
</div>
</div>
<div id="intro">
<h2>The Image::Info class</h2>
<p>Some <code>Image</code> and <code>ImageList</code> methods,
such as <code>read</code> and <code>write</code>, accept an
"optional arguments" block in which you can set attributes that
modify the method's output. These attributes belong to the
<code>Image::Info</code> class. The <code>Image::Info</code>
class exists only to accept optional arguments for those
<code>Image</code> and <code>ImageList</code> methods.</p>
<p>This page explains the methods defined in the
<code>Image::Info</code> class. Generally, each
<code>Image</code> or <code>ImageList</code> method that uses
the <code>Image::Info</code> class to get optional arguments
will only accept some of the attributes listed on this page,
that is, only those attributes that are meaningful for the
particular method. Any other attributes that you set are
ignored. Also, some attributes are only used by a subset of the
image formats. See the ImageMagick documentation for more
information.</p>
<p>Remember, you do not ever need to create an
<code>Image::Info</code> object. The object is created for you
before the optional arguments block is entered and destroyed
after the block is exited.</p>
<p>All the attributes in the <code>Image::Info</code> class are
read/write. For simplicity, and because usually you only set
these attributes, this page only describes the setter version
of each attribute method.</p>
</div>
<h2 class="methods">instance methods</h2>
<div class="sig">
<h3 id="aset">[]=</h3>
<p><span class="arg">self</span>[<span class=
"arg">format</span>, <span class="arg">key</span>] =
<span class="arg">value</span> -> <span class=
"arg">self</span><br />
<span class="arg">self</span>[<span class="arg">key</span>] =
<span class="arg">value</span> -> <span class=
"arg">self</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Define an option. An alternative to <a href=
"#define">define</a>, below. Use this method to set options for
reading or writing certain image formats. The list of supported
options changes from release to release. For a list of the
valid image formats, keys, and values, refer to the
documentation for the -define option for the release of
ImageMagick installed on your system.</p>
<h4>Arguments</h4>
<dl>
<dt>format</dt>
<dd>An image format name such as "ps" or "tiff". (Depending
on the key, this argument may be omitted.)</dd>
<dt>key</dt>
<dd>A string that identifies the option.</dd>
<dt>value</dt>
<dd>The value of the option. <span class="arg">Value</span>
can be any object that responds to <code>to_s</code>. Use
<code>nil</code> to set the key to a null value.</dd>
</dl>
<h4 id="user_option">The "user" option</h4>
<p>The "user" option is unique to RMagick. It may be set to any
string. If this option is used when creating an image via one
of the methods listed below then the new image gets the value
assigned as a property as if <code>img["user"]</code> had been
used. In addition, the value is displayed in the string
returned by <code>Image#inspect</code>. The "user" property can
be used to help distinguish otherwise similar images when
debugging.</p>
<p>For example,</p>
<pre>
img = Magick::Image.new(10,10) do
self['user'] = __FILE__ + ':' + __LINE__.to_s
end » 10x10 DirectClass 16-bit user:test.rb:3
</pre>
<p>These methods propogate the value of the "user" option to
new image(s): <code>Image.new, ImageList.new,
ImageList.new_image, Image.capture, Image.from_blob,
ImageList.from_blob, Image.read, ImageList.read,
Image.read_inline, and Image.ping</code>.</p>
<h4>Returns</h4>
<p>self</p>
<h4>Example</h4>
<pre>
self["tiff", "bits-per-sample"] = 2
</pre>
<h4>Magick API</h4>
<p>SetImageOption</p>
</div>
<div class="sig">
<h3 id="aref">[]</h3>
<p><span class="arg">self</span>[<span class=
"arg">format</span>, <span class="arg">key</span>] ->
<em>value</em><br />
<span class="arg">self</span>[<span class="arg">key</span>]
-> <em>value</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Returns the value of the specified option for the specified
format.</p>
<h4>Arguments</h4>
<dl>
<dt>format</dt>
<dd>An image format name such as "ps" or "tiff". (Depending
on the key, this argument may be omitted.)</dd>
<dt>key</dt>
<dd>A string that identifies the option.</dd>
</dl>
<h4>Returns</h4>
<p>The value of the option. Always a string.</p>
<h4>Example</h4>
<pre>
self["tiff", "bits-per-sample"] » 2
</pre>
<h4>Magick API</h4>
<p>GetImageOption</p>
</div>
<div class="sig">
<h3 id="channel">channel</h3>
<p><span class="arg">self</span>.channel([<span class=
"arg">channel</span> [, <span class=
"arg">channel</span>...]])</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Restrict the method to the specified channel(s). This
attribute is set-only.</p>
<h4>Argument</h4>
<p>The arguments may be any <a href=
"constants.html#ChannelType">ChannelType</a> values.</p>
<h4>Notes</h4>
<p>If you call <code>channel</code> with no arguments,
<em>all</em> channels are included. If you do not call
<code>channel</code> at all, the channels used do not include
the alpha channel.</p>
</div>
<div class="sig">
<h3 id="define">define</h3>
<p><span class="arg">self</span>.define(<span class=
"arg">format</span>, <span class="arg">key</span>[,
<span class="arg">value</span>])</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Define a format-specific option. See <a href=
"#aset">[]=</a>, above.</p>
<h4>Arguments</h4>
<dl>
<dt>format</dt>
<dd>An image format name such as "ps" or "tiff".</dd>
<dt>key</dt>
<dd>A string that identifies the option.</dd>
<dt>value</dt>
<dd>The value of the option. <span class="arg">Value</span>
can be any object that responds to <code>to_s</code>. If
omitted, the key is simply defined to an null value.</dd>
</dl>
<h4>Returns</h4>
<p>self</p>
<h4>Example</h4>
<pre>
self.define("tiff", "bits-per-sample", 2)
</pre>
<h4>Magick API</h4>
<p>SetImageOption</p>
</div>
<div class="sig">
<h3 id="undefine">undefine</h3>
<p><span class="arg">self</span>.undefine(<span class=
"arg">format</span>, <span class="arg">key</span>)</p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Delete an option definition set by <a href="#aset">[]=</a>
or <a href="#define">define</a>. This is not the same as
setting the option to a null value. The <code>undefine</code>
method removes the option name from the list of options for the
specified format.</p>
<h4>Arguments</h4>
<dl>
<dt>format</dt>
<dd>An image format name such as "ps" or "tiff".</dd>
<dt>key</dt>
<dd>A string that identifies the option.</dd>
</dl>
<h4>Returns</h4>
<p>self</p>
<h4>Example</h4>
<pre>
self.undefine("tiff", "bits-per-sample")
</pre>
</div>
<h2 class="methods">attribute methods</h2>
<div class="sig">
<h3 id="antialias">antialias</h3>
<p><span class="arg">self.</span>antialias= <span class=
"arg"><code>true</code></span> or <span class=
"arg"><code>false</code></span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p><span class="imquote">Control antialiasing of rendered
Postscript and Postscript or TrueType fonts.</span> The default
is <code>true</code>.</p>
</div>
<div class="sig">
<h3 id="attenuate">attenuate</h3>
<p><span class="arg">self</span>.attenuate= <span class=
"arg">number</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p class="imquote">Lessen (or intensify) when adding noise to
an image.</p>
</div>
<div class="sig">
<h3 id="authenticate">authenticate</h3>
<p><span class="arg">self.</span>authenticate= <span class=
"arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p class="imquote">Decrypt an image with this password.</p>
<p>This attribute can be used to specify the password to be
used when reading an image or image sequence that is in an
encrypted format, such as PDF.</p>
</div>
<div class="sig">
<h3 id="background_color">background_color</h3>
<p><span class="arg">self.</span>background_color= <span class=
"arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the image background color. The default is "white".</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
<a href="struct.html#Pixel">Pixel</a>.</p>
</div>
<div class="sig">
<h3 id="border_color">border_color</h3>
<p><span class="arg">self.</span>border_color= <span class=
"arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the image border color. The default is "#dfdfdf".</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
<a href="struct.html#Pixel">Pixel</a>.</p>
</div>
<div class="sig">
<h3 id="caption">caption</h3>
<p><span class="arg">self.</span>caption= <span class=
"arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>When used with <a href="image1.html#read">Image.read</a>,
assigns a caption to an image. The caption is an image
property:</p>
<pre>
img = Magick::Image.read("xc:white") do
self.caption = "a new caption"
self.size = "20x20"
end
p img.first.properties » {"caption"=>"a new caption"}
p img.first['caption'] » "a new caption"
</pre>
<h4>Arguments</h4>
<p>A string.</p>
</div>
<div class="sig">
<h3 id="colorspace">colorspace</h3>
<p><span class="arg">self.</span>colorspace= <span class=
"arg">colorspace</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specifies the image pixel interpretation.</p>
<h4>Arguments</h4>A <a href=
"constants.html#ColorspaceType">ColorspaceType</a> constant.
</div>
<div class="sig">
<h3 id="comment">comment</h3>
<p><span class="arg">self.</span>comment= <span class=
"arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p class="imquote">Use this option to assign a specific comment
to the image, when writing to an image format that supports
comments.</p>
<h4>Arguments</h4>
<p class="imquote">You can include the image filename, type,
width, height, or other image attribute by embedding special
format characters listed under the <a href=
"draw.html#annotate">annotate</a> method.</p>
</div>
<div class="sig">
<h3 id="compression">compression</h3>
<p><span class="arg">self.</span>compression= <span class=
"arg">type</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specifies the type of compression used when writing the
image. Only some image formats support compression. For those
that do, only some compression types are supported. If you
specify an compression type that is not supported, the default
compression type (usually NoCompression) is used instead.</p>
<p>Some compression types support varying levels of
compression. See the <a href=
"#quality"><code>quality</code></a> attribute.</p>
<p>The following table shows the image formats that support
compression. For each format, the right-hand column shows the
supported compression types. The default compression type is
shown in <strong>bold</strong>.</p>
<table class="simple_table" summary=
"supported compression types by image format">
<caption>
Supported Compression Types
</caption>
<tr>
<th>Format</th>
<th>Compression Types</th>
</tr>
<tr>
<td>BMP</td>
<td><strong>NoCompression</strong>, RLECompression</td>
</tr>
<tr>
<td>DIB</td>
<td><strong>NoCompression</strong>, RLECompression</td>
</tr>
<tr>
<td>FPX</td>
<td><strong>NoCompression</strong>, JPEGCompression</td>
</tr>
<tr>
<td>GIF</td>
<td><strong>LZWCompression</strong></td>
</tr>
<tr>
<td>JNG</td>
<td><strong>NoCompression</strong>, JPEGCompression</td>
</tr>
<tr>
<td>JP2</td>
<td><strong>JPEGCompression</strong>,
LosslessJPEGCompression</td>
</tr>
<tr>
<td>JPG</td>
<td><strong>JPEGCompression</strong>,
LosslessJPEGCompression</td>
</tr>
<tr>
<td>MIFF</td>
<td><strong>NoCompression</strong>, RLECompression</td>
</tr>
<tr>
<td>MNG</td>
<td><strong>NoCompression</strong>, JPEGCompression</td>
</tr>
<tr>
<td>PALM</td>
<td><strong>NoCompression</strong>, FaxCompression,
RLECompression</td>
</tr>
<tr>
<td>PDB</td>
<td><strong>NoCompression</strong>, RLECompression</td>
</tr>
<tr>
<td>PDF</td>
<td><strong>NoCompression</strong>, JPEGCompression,
LZWCompression, ZipCompression</td>
</tr>
<tr>
<td>PICT</td>
<td><strong>NoCompression</strong>, JPEGCompression</td>
</tr>
<tr>
<td>PNG</td>
<td><strong>NoCompression</strong>, ZIPCompression</td>
</tr>
<tr>
<td>PS</td>
<td><strong>NoCompression</strong>, RLECompression</td>
</tr>
<tr>
<td>PS2</td>
<td><strong>RLECompression</strong>, FaxCompression,
JPEGCompression, LZWCompression, NoCompression</td>
</tr>
<tr>
<td>PS3</td>
<td><strong>FaxCompression</strong>, JPEGCompression,
LZWCompression, NoCompression, RLECompression,
ZipCompression</td>
</tr>
<tr>
<td>TIFF</td>
<td><strong>NoCompression</strong>, FaxCompression,
Group4Compression, JPEGCompression, LZWCompression,
RLECompression, ZipCompression</td>
</tr>
</table>
<h5>Notes</h5>
<ol id="compression_notes">
<li>NoCompression is accepted for all image formats. Except
as noted in the table, it is the default.</li>
<li>This table is based on my examination of the ImageMagick
source code. It is not necessarily complete and it may
contain mistakes. If you need an authoritative list, you
should consult the ImageMagick developers.</li>
</ol>
<h4>Arguments</h4>A <a href=
"constants.html#CompressionType">CompressionType</a> constant.
</div>
<div class="sig">
<h3 id="density">density</h3>
<p><span class="arg">self.</span>density= <span class=
"arg">string</span> or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specifies the vertical and horizontal resolution in pixels.
The default density is "72.0x72.0". This attribute can be used
when writing JBIG, PCL, PS, PS2, and PS3 format images.</p>
<p>This attribute can also be used to specify the width and
height of HISTOGRAM format images. For HISTOGRAM, the default
is 256x200.</p>
<h4>Arguments</h4>
<p>The argument can be either a string in the form "XxY" where
"X" is the horizontal resolution and "Y" is the vertical
resolution, or a <a href="struct.html#Geometry">Geometry</a>
object where <code>width</code> is the horizontal resolution
and <code>height</code> is the vertical resolution.</p>
</div>
<div class="sig">
<h3 id="delay">delay</h3>
<p><span class="arg">self.</span>delay= <span class=
"arg">integer</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p class="imquote">This attribute is useful for regulating the
animation of image sequences. <em>delay</em>/100 seconds must
expire before the display of the next image. The default is no
delay between each showing of the image sequence. The maximum
delay is 65535.</p>
</div>
<div class="sig">
<h3 id="depth">depth</h3>
<p><span class="arg">self.</span>depth= <span class=
"arg">integer</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specifies the image depth.</p>
<h4>Arguments</h4>
<p>Either 8, 16, or 32. You can specify 16 and 32 only when
ImageMagick was compiled with a QuantumDepth that allows these
depth values.</p>
<p>Use <code>depth</code> to specify the depth of CMYK, GRAY,
RGB, RGBA, MAP, and XC format images. See also <a href=
"#size"><code>size</code></a>.</p>
</div>
<div class="sig">
<h3 id="dispose">dispose</h3>
<p><span class="arg">self.</span>dispose= <span class=
"arg">type</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p class="imquote">The argument indicates the way in which the
graphic is to be treated after being displayed.</p>
<h4>Argument</h4>
<p>A <a href="constants.html#DisposeType">DisposeType</a>
constant.</p>
</div>
<div class="sig">
<h3 id="dither">dither</h3>
<p><span class="arg">self.</span>dither= <span class=
"arg"><code>true</code></span> or <span class=
"arg"><code>false</code></span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>This attribute can be used when writing GIF images.</p>
<p class="imquote">Apply Floyd/Steinberg error diffusion to the
image. The basic strategy of dithering is to trade intensity
resolution for spatial resolution by averaging the intensities
of several neighboring pixels. Images which suffer from severe
contouring when reducing colors can be improved with this
option.</p>
</div>
<div class="sig">
<h3 id="endian">endian</h3>
<p><span class="arg">self</span>.endian= <span class=
"arg">type</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specify the endianess of the image when reading the image
file.</p>
<h4>Argument</h4>
<p>One of the following Magick::EndianType enum values:</p>
<ul>
<li>MSBEndian</li>
<li>LSBEndian</li>
</ul>
</div>
<div class="sig">
<h3 id="extract">extract</h3>
<p><span class="arg"><em>self.</em></span>extract= <span class=
"arg">string</span> or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specifies a portion of an image to be extracted when the
image is constituted. This attribute can be used to identify a
subset of an image that is otherwise too large to keep in
memory.</p>
<h4>Arguments</h4>
<p>Either a geometry string or a <a href=
"struct.html#Geometry">Geometry</a> object. For example:
<code>self.extract = "200x200+100+100"</code>.</p>
</div>
<div class="sig">
<h3 id="filename">filename</h3>
<p><span class="arg">self.</span>filename= <span class=
"arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>See <a href="image1.html#capture">capture</a>.</p>
</div>
<div class="sig">
<h3 id="fill">fill</h3>
<p><span class="arg">self.</span>fill= <span class=
"arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specifies the fill color to use when creating an image with
the "caption:" format..</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
<a href="struct.html#Pixel">pixel</a>.</p>
</div>
<div class="sig">
<h3 id="font">font</h3>
<p><span class="arg">self.</span>font= <span class=
"arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the text rendering font.</p>
</div>
<div class="sig">
<h3 id="format">format</h3>
<p><span class="arg">self.</span>format= <span class=
"arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the image format, "GIF" or "JPG" for example.</p>
<h4>Arguments</h4>
<p>See <a href=
"http://www.imagemagick.org/script/formats.php">File
Formats</a>.</p>
</div>
<div class="sig">
<h3 id="fuzz">fuzz</h3>
<p><span class="arg">self.</span>fuzz= <span class=
"arg">number</span> or <span class="arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the level of "fuzziness" for comparing pixels. By
default the pixels must be identical to be considered equal.
The larger the <code>fuzz</code> value the more difference is
tolerated. See <a href=
"imageattrs.html#fuzz">Image#fuzz</a>.</p>
<h4>Arguments</h4>
<p>The argument may be a numeric value or a string in the form
"NN%". In the second case, the argument is computed as a
percentage of <a href=
"constants.html#Miscellaneous_constants">QuantumRange</a>. For
example, a value of '5%' sets <code>fuzz</code> to
0.05*QuantumRange.</p>
</div>
<div class="sig">
<h3 id="gravity">gravity</h3>
<p><span class="arg">self.</span>gravity= <span class=
"arg">gravity</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p class="imquote">The direction text gravitates to when
annotating the image.</p>
<p class="imquote">The direction you choose specifies where to
position the text when annotating the image. For example, a
gravity of <code>CenterGravity</code> forces the text to be
centered within the image. By default, the image gravity is
<code>NorthWestGravity</code>.</p>
<p>This attribute can be used to position the text when
creating an image with the "caption:" format.</p>
<h4>Arguments</h4>
<p>A <a href="constants.html#GravityType">GravityType</a>
constant.</p>
</div>
<div class="sig">
<h3 id="image_type">image_type</h3>
<p><span class="arg">self.</span>image_type= <span class=
"arg">image_type</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>The image type classification. For example, GrayscaleType.
Don't confuse this attribute with the <a href=
"#format">format</a> such as "GIF" or "JPG".</p>
<h4>Arguments</h4>
<p>An <a href="constants.html#ImageType">ImageType</a>
constant.</p>
</div>
<div class="sig">
<h3 id="interlace">interlace</h3>
<p><span class="arg">self.</span>interlace= <span class=
"arg">type</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p><span class="imquote">[S]pecify the type of interlacing
scheme for raw image formats such as RGB or YUV. NoInterlace
means do not interlace, LineInterlace uses scanline
interlacing, and PlaneInterlace uses plane interlacing.
PartitionInterlace is like PlaneInterlace except the different
planes are saved to individual files (e.g. image.R, image.G,
and image.B). Use LineInterlace or PlaneInterlace to create an
interlaced GIF or progressive JPEG image.</span> The default is
NoInterlace.</p>
<h4>Arguments</h4>
<p>An <a href="constants.html#InterlaceType">InterlaceType</a>
constant.</p>
</div>
<div class="sig">
<h3 id="label">label</h3>
<p><span class="arg">self.</span>label= <span class=
"arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p><span class="imquote">Use this option to assign a specific
label to the image, when writing to an image format that
supports labels, such as TIFF, PNG, MIFF, or PostScript. You
can include the the image filename, type, width, height, or
other image attribute by embedding special format
characters.</span> See <a href=
"draw.html#annotate">annotate</a> for details.</p>
</div>
<div class="sig">
<h3 id="matte_color">matte_color</h3>
<p><span class="arg">self.</span>matte_color= <span class=
"arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the image transparent color. The default is
"#bdbdbd".</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
<a href="struct.html#Pixel">pixel</a>.</p>
</div>
<div class="sig">
<h3 id="monitor">monitor</h3>
<p><span class="arg">self.</span>monitor= <span class=
"arg">proc</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set a <code>Proc</code> object as a progress monitor. This
proc can be used to monitor the progress of methods that accept
optional arguments such as <code>read</code> and
<code>write</code>. To stop monitoring, set the monitor to
<code>nil</code>. See <a href=
"imageattrs.html#monitor">Image#monitor</a> for more
information about the proc. This attribute is set-only.</p>
<p>If you assign a monitor to an image with
<code>self.monitor=</code> when the image is created, the image
object inherits the monitor. Any methods applied to the new
image will be monitored as well.</p>
<p>This method supercedes the <code>Magick.set_monitor</code>
method.</p>
</div>
<div class="sig">
<h3 id="monochrome">monochrome</h3>
<p><span class="arg">self.</span>monochrome= <span class=
"arg"><code>true</code></span> or <span class=
"arg"><code>false</code></span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Transform the image to black and white on input. Only the
EPT, PDF, and PS formats respect this attribute.</p>
</div>
<div class="sig">
<h3 id="orientation">orientation</h3>
<p><span class="arg">self</span>.orientation=<span class=
"arg">type</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specifies the orientation of the image pixels.</p>
<h4>Argument</h4>
<p>An <a href=
"constants.html#OrientationType">OrientationType</a> value.</p>
</div>
<div class="sig">
<h3 id="origin">origin</h3>
<p><span class="arg">self</span>.origin=<span class=
"arg">string</span> or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the image origin.</p>
<h4>Argument</h4>
<p>A <a href="imusage.html#geometry">geometry string</a> of the
form <code>+x+y</code> (a "-" may be used instead of "+" to
indicate a negative offset) or a <a href=
"struct.html#Geometry">Geometry</a> object.</p>
</div>
<div class="sig">
<h3 id="page">page</h3>
<p><span class="arg">self.</span>page= <span class=
"arg">string</span> or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the equivalent size of the Postscript page. The default
is "612x792>".</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#geometry">geometry string</a> or a
<a href="struct.html#Geometry">Geometry</a> object.</p>
</div>
<div class="sig">
<h3 id="pointsize">pointsize</h3>
<p><span class="arg">self.</span>pointsize= <span class=
"arg">number</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the font size in points. Useful when creating "caption:"
format images, for example.</p>
</div>
<div class="sig">
<h3 id="quality">quality</h3>
<p><span class="arg">self.</span>quality= <span class=
"arg">integer</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>The compression level for JPEG, MPEG, JPEG-2000, MIFF, MNG,
and PNG image format. Corresponds to ImageMagick's -quality
option. The default is 75. See <em><a href=
"comtasks.html#compressing">Compressing image
files</a></em>.</p>
</div>
<div class="sig">
<h3 id="sampling_factor">sampling_factor</h3>
<p><span class="arg">self.</span>sampling_factor= <span class=
"arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p class="imquote">sampling factors used by JPEG or MPEG-2
encoder and YUV decoder/encoder.</p>
<p class="imquote">This attribute specifies the sampling
factors to be used by the JPEG encoder for chroma downsampling.
If this attribute is omitted, the JPEG library will use its own
default values. When reading or writing the YUV format and when
writing the M2V (MPEG-2) format, use sampling-factor="2x1" to
specify the 4:2:2 downsampling method.</p>
<h4>Argument</h4>
<p>A string in the form
"<em>horizontal-factor</em><strong>x</strong><em>vertical-factor</em>"</p>
</div>
<div class="sig">
<h3 id="scene">scene</h3>
<p><span class="arg">self</span>.scene= <span class=
"arg">number</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the scene number of an image or the first image in a
sequence.</p>
</div>
<div class="sig">
<h3 id="server_name">server_name</h3>
<p><span class="arg">self.</span>server_name= <span class=
"arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the X11 display to obtain fonts from.</p>
</div>
<div class="sig">
<h3 id="size">size</h3>
<p><span class="arg"><em>self.</em>size= <em>string</em></span>
or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set the width and height of the image when reading a
<a href="imusage.html#builtin_formats">built-in image
format</a> that does not have an inherent size, or when reading
an image from a multi-resolution file format such as Photo CD,
JBIG, or JPEG.</p>
<p>Use <code>size</code> to specify the width and height of
images in the CMYK, DIB, EMF, GRAY, RGB, RGBA, UYVY, YUV, or XC
formats, the width and height of some <a href=
"imusage.html#builtin_formats">built in formats</a>, or the
subimage size of PTIF-format images.</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#geometry">geometry string</a> or a
<a href="struct.html#Geometry">Geometry</a> object.</p>
</div>
<div class="sig">
<h3 id="stroke">stroke</h3>
<p><span class="arg">self.</span>stroke= <span class=
"arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specifies the stroke color to use when creating an image
with the "caption:" format..</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
<a href="struct.html#Pixel">pixel</a>.</p>
</div>
<div class="sig">
<h3 id="stroke_width">stroke_width</h3>
<p><span class="arg">self.</span>stroke_width=
<em>number</em></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specifies the stroke width to use when creating an image
with the "caption:" format..</p>
<h4>Arguments</h4>
<p>The stroke width.</p>
</div>
<div class="sig">
<h3 id="texture">texture</h3>
<p><span class="arg">self</span>.texture= <span class=
"arg">image</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set a texture to tile onto the image background. Corresponds
to the -texture option to ImageMagick's convert and mogrify
commands. This attribute is set-only.</p>
<h4>Argument</h4>
<p>An image</p>
</div>
<div class="sig">
<h3 id="transparent_color">transparent_color</h3>
<p><span class="arg">self</span>.transparent_color=
<span class="arg">string</span> or <span class=
"arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p class="imquote">The transparent color. Sometimes used for
saving to image formats such as GIF and PNG8 which uses this
color to represent boolean transparency. This does not make a
color transparent, just defines what color the transparent
color will be in the color pallette of the saved image.</p>
<p class="imquote">This attribute allows you to have both a
opaque visible color as well as a transparent color of the same
color value without conflict. That is you can use the same
color for both the transparent and opaque color areas within an
image. This in turn frees to you to select a transparenct color
that is appropriate when a image is displayed by application
that does not handle a transparent color index, while allowing
RMagick to correctly handle images of this type.</p>
</div>
<div class="sig">
<h3 id="tile_offset">tile_offset</h3>
<p><span class="arg">self</span>.tile_offset= <span class=
"arg">string</span> or <span class="arg">geometry</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p class="imquote">Specifies the offset for tile images,
relative to the background image it will be tiled on.</p>
<p>This attribute is useful with the "tile:" and "pattern:"
image formats.</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#geometry">geometry string</a> or a
<a href="struct.html#Geometry">Geometry</a> object.</p>
</div>
<div class="sig">
<h3 id="undercolor">undercolor</h3>
<p><span class="arg">self.</span>undercolor= <span class=
"arg">string</span> or <span class="arg">pixel</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specifies the undercolor color to use when creating an image
with the "caption:" format..</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
<a href="struct.html#Pixel">pixel</a>.</p>
</div>
<div class="sig">
<h3 id="units">units</h3>
<p><span class="arg">self.</span>units= <span class=
"arg">unit</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Specifies the units of image resolution.</p>
<h4>Arguments</h4>
<p>A <a href="constants.html#ResolutionType">ResolutionType</a>
constant.</p>
</div>
<div class="sig">
<h3 id="view">view</h3>
<p><span class="arg">self.</span>view= <span class=
"arg">string</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>FlashPix viewing parameters.</p>
</div>
<p class="spacer"> </p>
<div class="nav">
« <a href="struct.html">Prev</a> | <a href=
"index.html">Contents</a> | <a href=
"constants.html">Next</a> »
</div>
</body>
</html>
|