]> granicus.if.org Git - imagemagick/blob - www/perl-magick.html
(no commit message)
[imagemagick] / www / perl-magick.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
4 <head>\r
5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
7   <style type="text/css" media="screen,projection"><!--\r
8     @import url("../www/magick.css");\r
9   --></style>\r
10   <link rel="shortcut icon" href="../images/wand.ico"  type="images/vnd.microsoft.icon"/>
11   <title>ImageMagick: PerlMagick, Perl API for ImageMagick</title>
12   <meta http-equiv="Content-Language" content="en-US"/>
13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
15   <meta name="Generator" content="PHP"/>
16   <meta name="Keywords" content="perlmagick, perl, api, for, imagemagick, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
17   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
18   <meta name="Rating" content="GENERAL"/>
19   <meta name="Robots" content="INDEX, FOLLOW"/>
20   <meta name="Generator" content="ImageMagick Studio LLC"/>
21   <meta name="Author" content="ImageMagick Studio LLC"/>
22   <meta name="Revisit-after" content="2 DAYS"/>
23   <meta name="Resource-type" content="document"/>
24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25   <meta name="Distribution" content="Global"/>
26 </head>\r
27 \r
28 <body id="www-imagemagick-org">\r
29 <div class="titlebar">\r
30 <a href="../index.html">\r
31   <img src="../images/script.png" alt="[ImageMagick]"\r
32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
33 <a href="http://www.networkredux.com">\r
34   <img src="../images/networkredux.png" alt="[sponsor]"\r
35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
36 <a href="http://www.imagemagick.org/discourse-server/">\r
37   <img src="../images/logo.jpg" alt=""\r
38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
39 <a href="../index.html">\r
40   <img src="../images/sprite.jpg" alt=""\r
41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
42 </div>\r
43 \r
44 <div class="eastbar">\r
45 \r
46 <div class="menu">
47   <a href="../index.html">About ImageMagick</a>
48 </div>
49 <div class="sep"></div>\r
50 <div class="menu">
51   <a href="../www/command-line-tools.html">Command-line Tools</a>
52 </div>
53 <div class="sub">
54     <a href="../www/command-line-processing.html">Processing</a>
55 </div>
56 <div class="sub">
57     <a href="../www/command-line-options.html">Options</a>
58 </div>
59 <div class="sub">
60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
61 </div>
62 <div class="menu">
63   <a href="../www/api.html">Program Interfaces</a>
64 </div>
65 <div class="sub">
66     <a href="../www/magick-wand.html">MagickWand</a>
67 </div>
68 <div class="sub">
69     <a href="../www/magick-core.html">MagickCore</a>
70 </div>
71 <div class="sub">
72     <a href="../www/perl-magick.html">PerlMagick</a>
73 </div>
74 <div class="sub">
75     <a href="../Magick++/">Magick++</a>
76 </div>
77 <div class="menu">
78   <a href="../www/architecture.html">Architecture</a>
79 </div>
80 <div class="sep"></div>\r
81 <div  class="menu">
82    <a href="../www/install-source.html">Install from Source</a>
83 </div>
84 <div class="sub">
85     <a href="../www/install-source.html#unix">Unix</a>
86 </div>
87 <div class="sub">
88     <a href="../www/install-source.html#windows">Windows</a>
89  </div>
90 <div class="menu">
91   <a href="../www/binary-releases.html">Binary Releases</a>
92 </div>
93 <div class="sub">
94     <a href="../www/binary-releases.html#unix">Unix</a>
95 </div>
96 <div class="sub">
97     <a href="../www/binary-releases.html#macosx">Mac OS X</a>
98 </div>
99 <div class="sub">
100     <a href="../www/binary-releases.html#windows">Windows</a>
101 </div>
102 <div class="menu">
103   <a href="../www/resources.html">Resources</a>
104 </div>
105 <div class="sep"></div>\r
106 <div class="menu">
107   <a href="../www/download.html">Download</a>
108 </div>
109 <div class="sep"></div>\r
110 <div class="menu">
111   <a href="http://www.imagemagick.org/script/search.php">Search</a>
112 </div>
113 <div class="sep"></div>\r
114 <div class="menu">
115   <a href="../www/sitemap.html">Site Map</a>
116 </div>
117 <div  class="sub">
118     <a href="../www/links.html">Links</a>
119 </div>
120 <div class="sep"></div>\r
121 <div  class="menu">
122   <a href="../www/sponsors.html">Sponsors:</a>
123
124 <div class="sponsbox">
125 <div  class="sponsor">
126    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
127 </div>
128 <div  class="sponsor">
129   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
130 </div>
131 <div  class="sponsor">
132   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
133 </div>
134 <div  class="sponsor">
135   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
136 </div>
137 <div  class="sponsor">
138   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
139 </div>
140 </div>
141 </div>
142 \r
143 \r
144 </div>\r
145 \r
146 <div class="main">\r
147 \r
148 \r
149 <p class="navigation-index">[<a href="#installation">Installation</a> &bull; <a href="#overview">Overview</a> &bull; <a href="#example">Example Script</a> &bull; <a href="#read">Read or Write an Image</a> &bull; <a href="#manipulate">Manipulate an Image</a> &bull; <a href="#set-attribute">Set an Image Attribute</a> &bull; <a href="#get-attribute">Get an Image Attribute</a> &bull; <a href="#compare">Compare an Image to its Reconstruction</a> &bull; <a href="#montage">Create an Image Montage</a> &bull; <a href="#blobs">Working with Blobs</a> &bull; <a href="#direct-access">Direct-access to Image Pixels</a> &bull; <a href="#miscellaneous">Miscellaneous Methods</a> &bull; <a href="#exceptions">Handling Exceptions</a>&bull; <a href="#constants">Constant</a> ]</p>
150
151 <div class="doc-section">
152 <a name="introduction"></a>
153 <p><a href="../www/download.html">PerlMagick</a> is an objected-oriented <a href="http://www.perl.com/perl/">Perl</a> interface to ImageMagick. Use the module to read, manipulate, or write an image or image sequence from within a Perl script. This makes it very suitable for Web CGI scripts. You must have ImageMagick 6.2.0 or above and Perl version 5.005_02 or greater installed on your system for either of these utilities to work.</p>
154
155 <p>There are a number of useful scripts available to show you the value of PerlMagick. You can do Web based image manipulation and conversion with <a href="http://www.imagemagick.org/download/perl">MagickStudio</a>, or use <a href="https://www.imagemagick.org/subversion/ImageMagick/trunk/PerlMagick/demo/">L-systems</a> to create images of plants using mathematical constructs, and finally navigate through collections of thumbnail images and select the image to view with the <a href="http://webmagick.sourceforge.net/">WebMagick Image Navigator</a>.</p>
156
157 <p>You can try PerlMagick from your Web browser at the <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">ImageMagick Studio</a>. Or, you can see <a href="../www/examples.html">examples</a> of select PerlMagick functions.</p>
158 </div>
159
160 <h2><a name="installation"></a>Installation</h2>
161 <div class="doc-section">
162
163 <p><b>UNIX</b></p>
164
165 <p>The following instructions for Unix apply only to the unbundled PerlMagick as obtained from CPAN. PerlMagick is included as a subdirectory (PerlMagick) of the ImageMagick source distribution, and may be configured and built using the instructions provided in the ImageMagick distribution's README.txt file. It is usually most convenient to install PerlMagick as part of the ImageMagick distribution.</p>
166
167 <p>ImageMagick must already be installed on your system. Next, get
168 the <a href="../www/download.html">PerlMagick</a> distribution corresponding to the installed ImageMagick distribution
169 (e.g., PerlMagick 6.55 for
170 ImageMagick 6.5.5) and unpack it as shown below:</p>
171
172 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>tar xvfz PerlMagick-6.55.tar.gz</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>cd PerlMagick</span></p>
173 <p>Next, edit <kbd>Makefile.PL</kbd> and change LIBS and INC to include the appropriate path information to the required <kbd>libMagick</kbd> library. You will also need paths to JPEG, PNG, TIFF, etc.  delegates if they were included with your installed version of ImageMagick. Build and install it like this:</p>
174
175 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>perl Makefile.PL</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>make</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>make install</span></p>
176 <p>For Unix, you typically need to be <kbd>root</kbd> to install the software. There are ways around this. Consult the Perl manual pages for more information.</p>
177
178 <p><b>Windows XP / Windows 2000</b></p>
179
180 <p>ImageMagick must already be installed on your system. Also, the ImageMagick source distribution for <a href="../www/download.html">Windows 2000</a> is required. You must also have the <kbd>nmake</kbd> from the Visual C++ or J++ development environment. Copy <kbd>\bin\IMagick.dll</kbd> and <kbd>\bin\X11.dll</kbd> to a directory in your dynamic load path such as <kbd>c:\perl\site\5.00502</kbd>.</p>
181
182 <p>Next, type</p>
183
184 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>cd PerlMagick</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>perl Makefile.nt</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>nmake</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>nmake install</span></p>
185 <p>See the <a href="http://www.dylanbeattie.net/magick/">PerlMagick Windows HowTo</a> page for further installation instructions.</p>
186
187 <p><b>Running the Regression Tests</b></p>
188
189 <p>To verify a correct installation, type</p>
190
191 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>make test</span></p>
192 <p>Use <kbd>nmake test</kbd> under Windows. There are a few demonstration scripts available to exercise many of the functions PerlMagick can perform. Type</p>
193
194 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>cd demo</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>make</span></p>
195 <p>You are now ready to utilize the PerlMagick methods from within your Perl scripts.</p>
196
197 </div>
198
199 <h2><a name="overview"></a>Overview</h2>
200 <div class="doc-section">
201
202 <p>Any script that wants to use PerlMagick methods must first define the methods within its namespace and instantiate an image object. Do this with:</p>
203
204 <pre class="code">
205   use Image::Magick;
206
207   $image=Image::Magick-&gt;new;
208 </pre>
209
210 <p>The new() method takes the same parameters as <a href="#set-attribute">SetAttribute</a> . For example,</p>
211
212 <pre class="code">
213   $image=Image::Magick-&gt;new(size=&gt;'384x256');
214 </pre>
215
216 <p>Next you will want to read an image or image sequence, manipulate it, and then display or write it. The input and output methods for PerlMagick are defined in <a href="#read">Read or Write an Image</a>. See <a href="#set-attribute">Set an Image Attribute</a> for methods that affect the way an image is read or written. Refer to <a href="#manipulate">Manipulate an Image</a> for a list of methods to transform an image. <a href="#get-attribute">Get an Image Attribute</a> describes how to retrieve an attribute for an image. Refer to <a href="#montage">Create an Image Montage</a> for details about tiling your images as thumbnails on a background. Finally, some methods do not neatly fit into any of the categories just mentioned. Review <a href="#misc">Miscellaneous Methods</a> for a list of these methods.</p>
217
218 <p>Once you are finished with a PerlMagick object you should consider destroying it. Each image in an image sequence is stored in virtual memory. This can potentially add up to mega-bytes of memory. Upon destroying a PerlMagick object, the memory is returned for use by other Perl methods. The recommended way to destroy an object is with <kbd>undef</kbd>:</p>
219
220 <pre class="code">
221   undef $image;
222 </pre>
223
224 <p>To delete all the images but retain the <kbd>Image::Magick</kbd> object use</p>
225
226 <pre class="code">
227   @$image = ();
228 </pre>
229
230 <p>and finally, to delete a single image from a multi-image sequence, use</p>
231
232 <pre class="code">
233   undef $image-&gt;[$x];
234 </pre>
235
236 <p>The next section illustrates how to use various PerlMagick methods to manipulate an image sequence.</p>
237
238 <p>Some of the PerlMagick methods require external programs such as <a href="http://www.cs.wisc.edu/~ghost/">Ghostscript</a>. This may require an explicit path in your PATH environment variable to work properly. For example (in Unix),</p>
239
240 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>$ENV{PATH}='/../bin:/usr/bin:/usr/local/bin';</span></p>
241 <div style="margin: auto;">
242 <h2><a name="example"></a>Example Script</h2>
243 </div>
244
245 <p>Here is an example script to get you started:</p>
246
247 <pre class="code">
248   #!/usr/local/bin/perl
249   use Image::Magick;<br />
250   my($image, $x);<br />
251   $image = Image::Magick-&gt;new;
252   $x = $image-&gt;Read('girl.png', 'logo.png', 'rose.png');
253   warn "$x" if "$x";<br />
254   $x = $image-&gt;Crop(geometry=&gt;'100x100+100+100');
255   warn "$x" if "$x";<br />
256   $x = $image-&gt;Write('x.png');
257   warn "$x" if "$x";
258 </pre>
259
260 <p>The script reads three images, crops them, and writes a single image as a GIF animation sequence. In many cases you may want to access individual images of a sequence. The next example illustrates how this done:</p>
261
262 <pre class="code">
263   #!/usr/local/bin/perl
264   use Image::Magick;<br />
265   my($image, $p, $q);<br />
266   $image = new Image::Magick;
267   $image-&gt;Read('x1.png');
268   $image-&gt;Read('j*.jpg');
269   $image-&gt;Read('k.miff[1, 5, 3]');
270   $image-&gt;Contrast();
271   for ($x = 0; $image-&gt;[$x]; $x++)
272   {
273     $image-&gt;[$x]-&gt;Frame('100x200') if $image-&gt;[$x]-&gt;Get('magick') eq 'GIF';
274     undef $image-&gt;[$x] if $image-&gt;[$x]-&gt;Get('columns') &lt; 100;
275   }
276   $p = $image-&gt;[1];
277   $p-&gt;Draw(stroke=&gt;'red', primitive=&gt;'rectangle', points=&gt;20,20 100,100');
278   $q = $p-&gt;Montage();
279   undef $image;
280   $q-&gt;Write('x.miff');
281 </pre>
282
283 <p>Suppose you want to start out with a 100 by 100 pixel white canvas with a red pixel in the center. Try</p>
284
285 <pre class="code">
286   $image = Image::Magick-&gt;new;
287   $image-&gt;Set(size=&gt;'100x100');
288   $image-&gt;ReadImage('xc:white');
289   $image-&gt;Set('pixel[49,49]'=&gt;'red');
290 </pre>
291
292 <p>Here we reduce the intensity of the red component at (1,1) by half:</p>
293
294 <pre class="code">
295   @pixels = $image-&gt;GetPixel(x=&gt;1,y=&gt;1);
296   $pixels[0]*=0.5;
297   $image-&gt;SetPixel(x=&gt;1,y=&gt;1,color=&gt;\@pixels);
298 </pre>
299
300 <p>Or suppose you want to convert your color image to grayscale:</p>
301
302 <pre class="code">
303   $image-&gt;Quantize(colorspace=&gt;'gray');
304 </pre>
305
306 <p>Let's annotate an image with a Taipai TrueType font:</p>
307
308 <pre class="code">
309   $text = 'Works like magick!';
310   $image-&gt;Annotate(font=&gt;'kai.ttf', pointsize=&gt;40, fill=&gt;'green', text=&gt;$text);
311 </pre>
312
313 <p>Perhaps you want to extract all the pixel intensities from an image and write them to STDOUT:</p>
314
315 <pre class="code">
316   @pixels = $image-&gt;GetPixels(map=&gt;'I', height=&gt;$height, width=&gt;$width, normalize=&gt;true);
317   binmode STDOUT;
318   print pack('B*',join('',@pixels));
319 </pre>
320
321 <p>Other clever things you can do with a PerlMagick objects include</p>
322
323 <pre  class="code">
324   $i = $#$p"+1";   # return the number of images associated with object p
325   push(@$q, @$p);  # push the images from object p onto object q
326   @$p = ();        # delete the images but not the object p
327   $p-&gt;Convolve([1, 2, 1, 2, 4, 2, 1, 2, 1]);   # 3x3 Gaussian kernel
328 </pre>
329
330 <div style="margin: auto;">
331   <h2><a name="read"></a>Read or Write an Image</h2>
332 </div>
333
334 <p>Use the methods listed below to either read, write, or display an image or image sequence:</p>
335
336 <table class="doc">
337 <caption>Read or Write Methods</caption>
338 <colgroup>
339   <col width="20%"></col>
340   <col width="20%"></col>
341   <col width="20%"></col>
342   <col width="40%"></col>
343 </colgroup>
344 <tbody>
345
346   <tr>
347     <th>Method</th>
348     <th>Parameters</th>
349     <th>Return Value</th>
350     <th>Description</th>
351   </tr>
352
353   <tr>
354     <td valign="top">Read</td>
355     <td valign="top">one or more filenames</td>
356     <td valign="top">the number of images read</td>
357     <td valign="top">read an image or image sequence</td>
358   </tr>
359
360   <tr>
361     <td valign="top">Write</td>
362     <td valign="top">filename</td>
363     <td valign="top">the number of images written</td>
364     <td valign="top">write an image or image sequence</td>
365   </tr>
366
367   <tr>
368     <td valign="top">Display</td>
369     <td valign="top">server name</td>
370     <td valign="top">the number of images displayed</td>
371     <td valign="top">display the image or image sequence to an X server</td>
372   </tr>
373
374   <tr>
375     <td valign="top">Animate</td>
376     <td valign="top">server name</td>
377     <td valign="top">the number of images animated</td>
378     <td valign="top">animate image sequence to an X server</td>
379   </tr>
380 </tbody>
381 </table>
382
383 <p>For convenience, methods Write(), Display(), and Animate() can take any parameter that <a href="#set-attribute">SetAttribute</a> knows about. For example,</p>
384
385 <pre class="code">
386   $image-&gt;Write(filename=&gt;'image.png', compression=&gt;'None');
387 </pre>
388
389 <p>Use <kbd>-</kbd> as the filename to method Read() to read from standard in or to method Write() to write to standard out:</p>
390
391 <pre class="code">
392   binmode STDOUT;
393   $image-&gt;Write('png:-');
394 </pre>
395
396 <p>To read an image in the GIF format from a PERL filehandle, use:</p>
397
398 <pre class="code">
399   $image = Image::Magick-&gt;new;
400   open(IMAGE, 'image.gif');
401   $image-&gt;Read(file=&gt;\*IMAGE);
402   close(IMAGE);
403 </pre>
404
405 <p>To write an image in the PNG format to a PERL filehandle, use:</p>
406
407 <pre class="code">
408   $filename = "image.png";
409   open(IMAGE, ">$filename");
410   $image-&gt;Write(file=&gt;\*IMAGE, filename=&gt;$filename);
411   close(IMAGE);
412 </pre>
413
414 <p>If <kbd>%0Nd, %0No, or %0Nx</kbd> appears in the filename, it is interpreted as a printf format specification and the specification is replaced with the specified decimal, octal, or hexadecimal encoding of the scene number. For example,</p>
415
416 <pre class="text">
417   image%03d.miff
418 </pre>
419
420 <p>converts files image000.miff, image001.miff, etc.</p>
421
422 <p>You can optionally add <i>Image</i> to any method name. For example, ReadImage() is an alias for method Read().</p>
423
424 </div>
425
426 <h2><a name="manipulate"></a>Manipulate an Image</h2>
427 <div class="doc-section">
428
429 <p>Once you create an image with, for example, method ReadImage() you may want to operate on it. Below is a list of all the image manipulations methods available to you with PerlMagick.  There are <a href="../www/examples.html">examples</a> of select PerlMagick methods. Here is an example call to an image manipulation method:</p>
430
431 <pre class="code">
432   $image-&gt;Crop(geometry=&gt;'100x100+10+20');
433   $image-&gt;[$x]-&gt;Frame("100x200");
434 </pre>
435
436 <p>And here is a list of other image manipulation methods you can call:</p>
437
438 <table class="doc">
439 <caption>Image Manipulation Methods</caption>
440 <tbody>
441   <tr>
442     <th>Method</th>
443     <th style="width: 40%">Parameters</th>
444     <th style="width: 40%">Description</th>
445   </tr>
446
447   <tr>
448     <td valign="top">AdaptiveBlur</td>
449     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
450     <td valign="top">adaptively blur the image with a Gaussian operator of the given radius and standard deviation (sigma).  Decrease the effect near edges.</td>
451   </tr>
452
453   <tr>
454     <td valign="top">AdaptiveResize</td>
455     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, filter=&gt;{Point, Box, Triangle, Hermite, Hanning, Hamming, Blackman, Gaussian, Quadratic, Cubic, Catrom, Mitchell, Lanczos, Bessel, Sinc}, support=&gt;<i>double</i>, blur=&gt;<i>double</i></td>
456     <td valign="top">adaptively resize image using data dependant triangulation. Specify <kbd>blur</kbd> &gt; 1 for blurry or &lt; 1 for sharp</td>
457   </tr>
458
459   <tr>
460     <td valign="top">AdaptiveSharpen</td>
461     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
462     <td valign="top">adaptively sharpen the image with a Gaussian operator of the given radius and standard deviation (sigma).  Increase the effect near edges.</td>
463   </tr>
464
465   <tr>
466     <td valign="top">AdaptiveThreshold</td>
467     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, offset=&gt;<i>integer</i></td>
468     <td valign="top">local adaptive thresholding.</td>
469   </tr>
470
471   <tr>
472     <td valign="top">AddNoise</td>
473     <td valign="top">noise=&gt;{Uniform, Gaussian, Multiplicative, Impulse, Laplacian, Poisson}, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
474     <td valign="top">add noise to an image</td>
475   </tr>
476
477   <tr>
478     <td valign="top">AffineTransform</td>
479     <td valign="top">affine=&gt;<i>array of float values</i>, translate=&gt;<i>float, float</i>, scale=&gt; <i>float, float</i>, rotate=&gt;<i>float</i>, skewX=&gt;<i>float</i>, skewY=&gt;<i>float</i>, interpolate={Average, Bicubic, Bilinear, Filter, Integer, Mesh, NearestNeighbor}, background=&gt;<i><a href="../www/color.html">color name</a></i></td>
480     <td valign="top">affine transform image</td>
481   </tr>
482
483   <tr>
484     <td valign="top">Affinity</td>
485     <td valign="top">image=&gt;<i>image-handle</i>, method=&gt;{None, FloydSteinberg, Riemersma}</td>
486     <td valign="top">choose a particular set of colors from this image</td>
487   </tr>
488
489   <tr>
490     <td valign="top">Annotate</td>
491     <td valign="top">text=&gt;<i>string</i>, font=&gt;<i>string</i>, family=&gt;<i>string</i>, style=&gt;{Normal, Italic, Oblique, Any}, stretch=&gt;{Normal, UltraCondensed, ExtraCondensed, Condensed, SemiCondensed, SemiExpanded, Expanded, ExtraExpanded, UltraExpanded}, weight=&gt;<i>integer</i>, pointsize=&gt;<i>integer</i>, density=&gt;<i>geometry</i>, stroke=&gt;<i><a href="../www/color.html">color name</a></i>, strokewidth=&gt;<i>integer</i>, fill=&gt;<i><a href="../www/color.html">color name</a></i>, undercolor=&gt;<i><a href="../www/color.html">color name</a></i>, kerning=&gt;<i>float</i>, geometry=&gt;<i>geometry</i>, gravity=&gt;{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}, antialias=&gt;{true, false}, x=&gt;<i>integer</i>, y=&gt;<i>integer</i>, affine=&gt;<i>array of float values</i>, translate=&gt;<i>float, float</i>, scale=&gt;<i>float, float</i>, rotate=&gt;<i>float</i>. skewX=&gt;<i>float</i>, skewY=&gt; <i>float</i>, align=&gt;{Left, Center, Right}, encoding=&gt;{UTF-8}</td>
492     <td valign="top">annotate an image with text. See <a href="#misc">QueryFontMetrics</a> to get font metrics without rendering any text.</td>
493   </tr>
494
495   <tr>
496     <td valign="top">AutoGamma</td>
497     <td valign="top">channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
498     <td valign="top">automagically adjust gamma level of image</td>
499   </tr>
500
501   <tr>
502     <td valign="top">AutoLevel</td>
503     <td valign="top">channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
504     <td valign="top">automagically adjust color levels of image</td>
505   </tr>
506
507   <tr>
508     <td valign="top">AutoOrient</td>
509     <td valign="top"><br /></td>
510     <td valign="top">automagically orient the image</td>
511   </tr>
512
513   <tr>
514     <td valign="top">BlackThreshold</td>
515     <td valign="top">threshold=&gt;<i>string</i></td>
516     <td valign="top">force all pixels below the threshold intensity into black</td>
517   </tr>
518
519   <tr>
520     <td valign="top">BlueShift</td>
521     <td valign="top">factor=&gt;<i>double</i>,</td>
522     <td valign="top">simulate a scene at nighttime in the moonlight.  Start with a factor of 1.5.</td>
523   </tr>
524
525   <tr>
526     <td valign="top">Blur</td>
527     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
528     <td valign="top">reduce image noise and reduce detail levels with a Gaussian operator of the given radius and standard deviation (sigma).</td>
529   </tr>
530
531   <tr>
532     <td valign="top">Border</td>
533     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, bordercolor=&gt;<i><a href="../www/color.html">color name</a></i>,  compose=&gt;{Undefined, Add, Atop, Blend, Bumpmap, Clear, ColorBurn, ColorDodge, Colorize, CopyBlack, CopyBlue, CopyCMYK, Cyan, CopyGreen, Copy, CopyMagenta, CopyOpacity, CopyRed, RGB, CopyYellow, Darken, Dst, Difference, Displace, Dissolve, DstAtop, DstIn, DstOut, DstOver, Dst, Exclusion, HardLight, Hue, In, Lighten, Luminize, Minus, Modulate, Multiply, None, Out, Overlay, Over, Plus, ReplaceCompositeOp, Saturate, Screen, SoftLight, Src, SrcAtop, SrcIn, SrcOut, SrcOver, Src, Subtract, Threshold, Xor },</td>
534     <td valign="top">surround the image with a border of color</td>
535   </tr>
536
537   <tr>
538     <td valign="top">Charcoal</td>
539     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i></td>
540     <td valign="top">simulate a charcoal drawing</td>
541   </tr>
542
543   <tr>
544     <td valign="top">Chop</td>
545     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i></td>
546     <td valign="top">chop an image</td>
547   </tr>
548
549   <tr>
550     <td valign="top">Clip</td>
551     <td valign="top">id=&gt;<i>name</i>, inside=&gt;<i>{true, false}</i>,</td>
552     <td valign="top">apply along a named path from the 8BIM profile.</td>
553   </tr>
554
555   <tr>
556     <td valign="top">ClipMask</td>
557     <td valign="top">mask=&gt;<i>image-handle</i></td>
558     <td valign="top">clip image as defined by the image mask</td>
559   </tr>
560
561   <tr>
562     <td valign="top">Clut</td>
563     <td valign="top">image=&gt;<i>image-handle</i>,  channel=&gt;{Red, RGB, CMYK, Cyan, Green, Magenta, Blue, Yellow, Opacity, Black, or All}</td>
564     <td valign="top">apply a color lookup table to an image sequence</td>
565   </tr>
566
567   <tr>
568     <td valign="top">Coalesce</td>
569     <td valign="top"><br /></td>
570     <td valign="top">merge a sequence of images</td>
571   </tr>
572
573   <tr>
574     <td valign="top">ColorDecisionList</td>
575     <td valign="top">filename=&gt;<i>string</i>,</td>
576     <td valign="top">color correct with a color decision list.</td>
577   </tr>
578
579   <tr>
580     <td valign="top">Colorize</td>
581     <td valign="top">fill=&gt;<i><a href="../www/color.html">color name</a></i>, opacity=&gt;<i>string</i></td>
582     <td valign="top">colorize the image with the fill color</td>
583   </tr>
584
585   <tr>
586     <td valign="top">Comment</td>
587     <td valign="top">string</td>
588     <td valign="top">add a comment to your image</td>
589   </tr>
590
591   <tr>
592     <td valign="top">CompareLayers</td>
593     <td valign="top">method=&gt;{any, clear, overlay}</td>
594     <td valign="top">compares each image with the next in a sequence and returns the minimum bounding region of any pixel differences it discovers.  Images do not have to be the same size, though it is best that all the images are coalesced (images are all the same size, on a flattened canvas, so as to represent exactly how a specific frame should look).</td>
595   </tr>
596
597   <tr>
598     <td valign="top">Composite</td>
599     <td valign="top">image=&gt;<i>image-handle</i>, compose=&gt;{Undefined, Add, Atop, Blend, Bumpmap, Clear, ColorBurn, ColorDodge, Colorize, CopyBlack, CopyBlue, CopyCMYK, Cyan, CopyGreen, Copy, CopyMagenta, CopyOpacity, CopyRed, RGB, CopyYellow, Darken, Dst, Difference, Displace, Dissolve, DstAtop, DstIn, DstOut, DstOver, Dst, Exclusion, HardLight, Hue, In, Lighten, Luminize, Minus, Modulate, Multiply, None, Out, Overlay, Over, Plus, ReplaceCompositeOp, Saturate, Screen, SoftLight, Src, SrcAtop, SrcIn, SrcOut, SrcOver, Src, Subtract, Threshold, Xor }, mask=&gt;<i>image-handle</i>, geometry=&gt;<i>geometry</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i>, gravity=&gt;{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}, opacity=&gt;<i>integer</i>, tile=&gt;{True, False}, rotate=&gt;<i>double</i>, color=&gt;<i><a href="../www/color.html">color name</a></i>, blend=&gt;<i>geometry</i>, interpolate=&gt;{undefined, average, bicubic, bilinear, filter, integer, mesh, nearest-neighbor, spline}</td>
600     <td valign="top">composite one image onto another.  Use the rotate parameter in concert with the tile parameter.</td>
601   </tr>
602
603   <tr>
604     <td valign="top">Contrast</td>
605     <td valign="top">sharpen=&gt;{True, False}</td>
606     <td valign="top">enhance or reduce the image contrast</td>
607   </tr>
608
609   <tr>
610     <td valign="top">ContrastStretch</td>
611     <td valign="top">levels=&gt;<i>string</i>, 'black-point'=&gt;<i>double</i>, 'white-point'=&gt;<i>double</i>, channel=&gt;{Red, RGB, CMYK, Cyan, Green, Magenta, Blue, Yellow, Opacity, Black, or All}</td>
612     <td valign="top">improve the contrast in an image by `stretching' the range of intensity values</td>
613   </tr>
614
615   <tr>
616     <td valign="top">Convolve</td>
617     <td valign="top">coefficients=&gt;<i>array of float values</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}, bias=&gt;;<i>double</i></td>
618     <td valign="top">apply a convolution kernel to the image. Given a kernel <i>order</i> , you would supply <i>order*order</i> float values (e.g. 3x3 implies 9 values).</td>
619   </tr>
620
621   <tr>
622     <td valign="top">Crop</td>
623     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i>, fuzz=&gt;<i>double</i></td>
624     <td valign="top">crop an image</td>
625   </tr>
626
627   <tr>
628     <td valign="top">CycleColormap</td>
629     <td valign="top">amount=&gt;<i>integer</i></td>
630     <td valign="top">displace image colormap by amount</td>
631   </tr>
632
633   <tr>
634     <td valign="top">Decipher</td>
635     <td valign="top">passphrase=&gt;<i>string</i></td>
636     <td valign="top">convert cipher pixels to plain pixels</td>
637   </tr>
638
639   <tr>
640     <td valign="top">Deconstruct</td>
641     <td valign="top"><br /></td>
642     <td valign="top">break down an image sequence into constituent parts</td>
643   </tr>
644
645   <tr>
646     <td valign="top">Deskew</td>
647     <td valign="top">geometry=&gt;<i>string</i>,threshold=&gt;<i>double</i></td>
648     <td valign="top">straighten the image</td>
649   </tr>
650
651   <tr>
652     <td valign="top">Despeckle</td>
653     <td valign="top">&nbsp;</td>
654     <td valign="top">reduce the speckles within an image</td>
655   </tr>
656
657   <tr>
658     <td valign="top">Difference</td>
659     <td valign="top">image=&gt;<i>image-handle</i></td>
660     <td valign="top">compute the difference metrics between two images </td>
661   </tr>
662
663   <tr>
664     <td valign="top">Distort</td>
665     <td valign="top">points=&gt;<i>array of float values</i>, method=&gt;{Affine, AffineProjection, Bilinear, Perspective, ScaleRotateTranslate}, virtual-pixel=&gt;{Background Black Constant Dither Edge Gray Mirror Random Tile Transparent White}, best-fit=&gt;{True, False}</td>
666     <td valign="top">distort image</td>
667   </tr>
668
669   <tr>
670     <td valign="top">Draw</td>
671     <td valign="top">primitive=&gt;{point, line, rectangle, arc, ellipse, circle, path, polyline, polygon, bezier, color, matte, text, @<i>filename</i>}, points=&gt;<i>string</i> , method=&gt;<i>{Point, Replace, Floodfill, FillToBorder, Reset}</i>, stroke=&gt;<i><a href="../www/color.html">color name</a></i>, fill=&gt;<i><a href="../www/color.html">color name</a></i>, font=&gt;<i>string</i>, pointsize=&gt;<i>integer</i>, strokewidth=&gt;<i>float</i>, antialias=&gt;{true, false}, bordercolor=&gt;<i><a href="../www/color.html">color name</a></i>, x=&gt;<i>float</i>, y=&gt;<i>float</i>, dash-offset=&gt;<i>float</i>, dash-pattern=&gt;<i>array of float values</i>, affine=&gt;<i>array of float values</i>, translate=&gt;<i>float, float</i>, scale=&gt;<i>float, float</i>, rotate=&gt;<i>float</i>,  skewX=&gt;<i>float</i>, skewY=&gt;<i>float</i>, interpolate=&gt;{undefined, average, bicubic, bilinear, mesh, nearest-neighbor, spline}, kerning=&gt;<i>float</i>, text=&gt;<i>string</i>, vector-graphics=&gt;<i>string</i></td>
672     <td valign="top">annotate an image with one or more graphic primitives.</td>
673   </tr>
674
675   <tr>
676     <td valign="top">Encipher</td>
677     <td valign="top">passphrase=&gt;<i>string</i></td>
678     <td valign="top">convert plain pixels to cipher pixels</td>
679   </tr>
680
681   <tr>
682     <td valign="top">Edge</td>
683     <td valign="top">radius=&gt;<i>double</i></td>
684     <td valign="top">enhance edges within the image with a convolution filter of the given radius.</td>
685   </tr>
686
687   <tr>
688     <td valign="top">Emboss</td>
689     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i></td>
690     <td valign="top">emboss the image with a convolution filter of the given radius and standard deviation (sigma).</td>
691   </tr>
692
693   <tr>
694     <td valign="top">Enhance</td>
695     <td valign="top"><br /></td>
696     <td valign="top">apply a digital filter to enhance a noisy image</td>
697   </tr>
698
699   <tr>
700     <td valign="top">Equalize</td>
701     <td valign="top">channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}<br /></td>
702     <td valign="top">perform histogram equalization to the image</td>
703   </tr>
704
705   <tr>
706     <td valign="top">Extent</td>
707     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i>, fuzz=&gt;<i>double</i>, background=&gt;<i><a href="../www/color.html">color name</a></i>, gravity=&gt;{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}</td>
708     <td valign="top">set the image size</td>
709   </tr>
710
711   <tr>
712     <td valign="top">Evaluate</td>
713     <td valign="top">value=&gt;<i>double</i>, operator=&gt;<i>{Add, And, Divide, LeftShift, Max, Min, Multiply, Or, Rightshift, Subtract, Xor}</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow} </td>
714     <td valign="top">apply an arithmetic, relational, or logical expression to the image</td>
715   </tr>
716
717   <tr>
718     <td valign="top">Flip</td>
719     <td valign="top"><br /></td>
720     <td valign="top">reflect the image scanlines in the vertical direction</td>
721   </tr>
722
723   <tr>
724     <td valign="top">Flop</td>
725     <td valign="top"><br /></td>
726     <td valign="top">reflect the image scanlines in the horizontal direction</td>
727   </tr>
728
729   <tr>
730     <td valign="top">FloodfillPaint</td>
731     <td valign="top">geometry=&gt;<i>geometry</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}, x=&gt;<i>integer</i>, y=&gt;<i>integer</i> , fill=&gt;<i><a href="../www/color.html">color name</a></i>, bordercolor=&gt;<i><a href="../www/color.html">color name</a></i>, fuzz=&gt;<i>double</i>, invert=&gt;{True, False}</td>
732     <td valign="top">changes the color value of any pixel that matches the color of the target pixel and is a neighbor. If you specify a border color, the color value is changed for any neighbor pixel that is not that color.</td>
733   </tr>
734
735   <tr>
736     <td valign="top">ForwardFourierTransform</td>
737     <td valign="top">magnitude=&gt;{True, False}</td>
738     <td valign="top">implements the forward discrete Fourier transform (DFT)</td>
739   </tr>
740
741   <tr>
742     <td valign="top">Frame</td>
743     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, inner=&gt;<i>integer</i>, outer=&gt;<i>integer</i>, fill=&gt;<i><a href="../www/color.html">color name</a></i>,  compose=&gt;{Undefined, Add, Atop, Blend, Bumpmap, Clear, ColorBurn, ColorDodge, Colorize, CopyBlack, CopyBlue, CopyCMYK, Cyan, CopyGreen, Copy, CopyMagenta, CopyOpacity, CopyRed, RGB, CopyYellow, Darken, Dst, Difference, Displace, Dissolve, DstAtop, DstIn, DstOut, DstOver, Dst, Exclusion, HardLight, Hue, In, Lighten, Luminize, Minus, Modulate, Multiply, None, Out, Overlay, Over, Plus, ReplaceCompositeOp, Saturate, Screen, SoftLight, Src, SrcAtop, SrcIn, SrcOut, SrcOver, Src, Subtract, Threshold, Xor },</td>
744     <td valign="top">surround the image with an ornamental border</td>
745   </tr>
746
747   <tr>
748     <td valign="top">Function</td>
749     <td valign="top">parameters=&gt;<i>array of float values</i>, function=&gt;{Sin}, virtual-pixel=&gt;{Background Black Constant Dither Edge Gray Mirror Random Tile Transparent White}</td>
750     <td valign="top">apply a function to the image</td>
751   </tr>
752
753   <tr>
754     <td valign="top">Gamma</td>
755     <td valign="top">gamma=&gt;<i>string</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
756     <td valign="top">gamma correct the image</td>
757   </tr>
758
759   <tr>
760     <td valign="top">GaussianBlur</td>
761     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
762     <td valign="top">reduce image noise and reduce detail levels with a Gaussian operator of the given radius and standard deviation (sigma).</td>
763   </tr>
764
765   <tr>
766     <td valign="top">GetPixel</td>
767     <td valign="top">geometry=&gt;<i>geometry</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}, normalize=&gt;{true, false}, x=&gt;<i>integer</i>, y=&gt;<i>integer</i></td>
768     <td valign="top">get a single pixel. By default normalized pixel values are returned.</td>
769   </tr>
770
771   <tr>
772     <td valign="top">GetPixels</td>
773     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i>, map=&gt;<i>string</i>, normalize=&gt;{true, false}</td>
774     <td valign="top">get image pixels as defined by the map (e.g. "RGB", "RGBA", etc.).  By default non-normalized pixel values are returned.</td>
775   </tr>
776
777   <tr>
778     <td valign="top">HaldClut</td>
779     <td valign="top">image=&gt;<i>image-handle</i>,  channel=&gt;{Red, RGB, CMYK, Cyan, Green, Magenta, Blue, Yellow, Opacity, Black, or All}</td>
780     <td valign="top">apply a Hald color lookup table to an image sequence</td>
781   </tr>
782
783   <tr>
784     <td valign="top">Identify</td>
785     <td valign="top">file=&gt;<i>file</i></td>
786     <td valign="top">identify the attributes of an image</td>
787   </tr>
788
789   <tr>
790     <td valign="top">Implode</td>
791     <td valign="top">amount=&gt;<i>double</i>, interpolate=&gt;{undefined, average, bicubic, bilinear, mesh, nearest-neighbor, spline}</td>
792     <td valign="top">implode image pixels about the center</td>
793   </tr>
794
795   <tr>
796     <td valign="top">InverseDiscreteFourierTransform</td>
797     <td valign="top">magnitude=&gt;{True, False}</td>
798     <td valign="top">implements the inverse discrete Fourier transform (DFT)</td>
799   </tr>
800
801   <tr>
802     <td valign="top">Label</td>
803     <td valign="top">string</td>
804     <td valign="top">assign a label to an image</td>
805   </tr>
806
807   <tr>
808     <td valign="top">Layers</td>
809     <td valign="top">method=&gt;{coalesce, compare-any, compare-clear, compare-over, composite, dispose, flatten, merge, mosaic, optimize, optimize-image, optimize-plus, optimize-trans, remove-dups, remove-zero},  compose=&gt;{Undefined, Add, Atop, Blend, Bumpmap, Clear, ColorBurn, ColorDodge, Colorize, CopyBlack, CopyBlue, CopyCMYK, Cyan, CopyGreen, Copy, CopyMagenta, CopyOpacity, CopyRed, RGB, CopyYellow, Darken, Dst, Difference, Displace, Dissolve, DstAtop, DstIn, DstOut, DstOver, Dst, Exclusion, HardLight, Hue, In, Lighten, LinearLight, Luminize, Minus, Modulate, Multiply, None, Out, Overlay, Over, Plus, ReplaceCompositeOp, Saturate, Screen, SoftLight, Src, SrcAtop, SrcIn, SrcOut, SrcOver, Src, Subtract, Threshold, Xor }, dither=&gt;{true, false}</td>
810     <td valign="top">compare each image the GIF disposed forms of the previous image in the sequence.  From this, attempt to select the smallest cropped image to replace each frame, while preserving the results of the animation.</td>
811   </tr>
812
813   <tr>
814     <td valign="top">Level</td>
815     <td valign="top">levels=&gt;<i>string</i>, 'black-point'=&gt;<i>double</i>, 'gamma'=&gt;<i>double</i>, 'white-point'=&gt;<i>double</i>, channel=&gt;{Red, RGB, CMYK, Cyan, Green, Magenta, Blue, Yellow, Opacity, Black, or All}</td>
816     <td valign="top">adjust the level of image contrast</td>
817   </tr>
818
819   <tr>
820     <td valign="top">LinearStretch</td>
821     <td valign="top">levels=&gt;<i>string</i>, 'black-point'=&gt;<i>double</i>, 'white-point'=&gt;<i>double</i></td>
822     <td valign="top">linear with saturation stretch</td>
823   </tr>
824
825   <tr>
826     <td valign="top">LiquidResize</td>
827     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, delta-x=&gt;<i>double</i>, rigidity=&gt;<i>double</i></td>
828     <td valign="top">rescale image with seam-carving.</td>
829   </tr>
830
831   <tr>
832     <td valign="top">Magnify</td>
833     <td valign="top"><br /></td>
834     <td valign="top">double the size of an image</td>
835   </tr>
836
837   <tr>
838     <td valign="top">Mask</td>
839     <td valign="top">mask=&gt;<i>image-handle</i></td>
840     <td valign="top">composite image pixels as defined by the mask</td>
841   </tr>
842
843   <tr>
844     <td valign="top">MatteFloodfill</td>
845     <td valign="top">geometry=&gt;<i>geometry</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i> , matte=&gt;<i>integer</i>, bordercolor=&gt;<i><a href="../www/color.html">color name</a></i>, fuzz=&gt;<i>double</i>, invert=&gt;{True, False}</td>
846     <td valign="top">changes the matte value of any pixel that matches the color of the target pixel and is a neighbor. If you specify a border color, the matte value is changed for any neighbor pixel that is not that color.</td>
847   </tr>
848
849   <tr>
850     <td valign="top">MedianFilter</td>
851     <td valign="top">radius=&gt;<i>double</i></td>
852     <td valign="top">replace each pixel with the median intensity pixel of a neighborhood.</td>
853   </tr>
854
855   <tr>
856     <td valign="top">Minify</td>
857     <td valign="top"><br /></td>
858     <td valign="top">half the size of an image</td>
859   </tr>
860
861   <tr>
862     <td valign="top">Modulate</td>
863     <td valign="top">brightness=&gt;<i>double</i>, saturation=&gt;<i>double</i>, hue=&gt;<i>double</i>, lightness=&gt;<i>double</i>, whiteness=&gt;<i>double</i>, blackness=&gt;<i>double</i> </td>
864     <td valign="top">vary the brightness, saturation, and hue of an image by the specified percentage</td>
865   </tr>
866
867   <tr>
868     <td valign="top">MotionBlur</td>
869     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i>, angle=&gt;<i>double</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
870     <td valign="top">reduce image noise and reduce detail levels with a Gaussian operator of the given radius and standard deviation (sigma) at the given angle to simulate the effect of motion</td>
871   </tr>
872
873   <tr>
874     <td valign="top">Negate</td>
875     <td valign="top">gray=&gt;{True, False}, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
876     <td valign="top">replace every pixel with its complementary color (white becomes black, yellow becomes blue, etc.)</td>
877   </tr>
878
879   <tr>
880     <td valign="top">Normalize</td>
881     <td valign="top">channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}<br /></td>
882     <td valign="top">transform image to span the full range of color values</td>
883   </tr>
884
885   <tr>
886     <td valign="top">OilPaint</td>
887     <td valign="top">radius=&gt;<i>integer</i></td>
888     <td valign="top">simulate an oil painting</td>
889   </tr>
890
891   <tr>
892     <td valign="top">Opaque</td>
893     <td valign="top">color=&gt;<i><a href="../www/color.html">color name</a></i>,
894 fill=&gt;<i><a href="../www/color.html">color name</a></i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}, invert=&gt;{True, False}</td>
895     <td valign="top">change this color to the fill color within the image</td>
896   </tr>
897
898   <tr>
899     <td valign="top">OrderedDither</td>
900     <td valign="top">threshold=&gt;{threshold, checks, o2x2, o3x3, o4x4, o8x8, h4x4a, h6x6a, h8x8a, h4x4o, h6x6o, h8x8o, h16x16o, hlines6x4}, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
901     <td valign="top">order dither image</td>
902   </tr>
903
904   <tr>
905     <td valign="top">Polaroid</td>
906     <td valign="top">caption=&gt;<i>string</i>, angle=&gt;<i>double</i>, pointsize=&gt;<i>double</i>, font=&gt;<i>string</i>, stroke=&gt; <i><a href="../www/color.html">color name</a></i>, strokewidth=&gt;<i>integer</i>, fill=&gt;<i><a href="../www/color.html">color name</a></i>, gravity=&gt;{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast},  background=&gt;<i><a href="../www/color.html">color name</a></i></td>
907     <td valign="top">simulate a Polaroid picture.</td>
908   </tr>
909
910   <tr>
911     <td valign="top">Posterize</td>
912     <td valign="top">levels=&gt;<i>integer</i>, dither=&gt;{True, False}</td>
913     <td valign="top">reduce the image to a limited number of color level</td>
914   </tr>
915
916   <tr>
917     <td valign="top">Profile</td>
918     <td valign="top">name=&gt;<i>string</i>, profile=&gt;<i>blob</i>, rendering-intent=&gt;{Undefined, Saturation, Perceptual, Absolute, Relative}, black-point-compensation=&gt;{True, False}</td>
919     <td valign="top">add or remove ICC or IPTC image profile; name is formal name (e.g. ICC or filename; set profile to <kbd>''</kbd> to remove profile</td>
920   </tr>
921
922   <tr>
923     <td valign="top">Quantize</td>
924     <td valign="top">colors=&gt;<i>integer</i>, colorspace=&gt;{RGB, Gray, Transparent, OHTA, XYZ, YCbCr, YIQ, YPbPr, YUV, CMYK, sRGB, HSL, HSB}, treedepth=&gt; <i>integer</i>, dither=&gt;{True, False}, dither-method=&gt;{Riemersma, Floyd-Steinberg}, measure_error=&gt;{True, False}, global_colormap=&gt;{True, False}, transparent-color=&gt;<i>color</i></td>
925     <td valign="top">preferred number of colors in the image</td>
926   </tr>
927
928   <tr>
929     <td valign="top">RadialBlur</td>
930     <td valign="top">angle=&gt;<i>double</i></td>
931     <td valign="top">radial blur the image.</td>
932   </tr>
933
934   <tr>
935     <td valign="top">Raise</td>
936     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i>, raise=&gt;{True, False}</td>
937     <td valign="top">lighten or darken image edges to create a 3-D effect</td>
938   </tr>
939
940   <tr>
941     <td valign="top">Recolor</td>
942     <td valign="top">matrix=&gt;<i>array of float values</i></td>
943     <td valign="top">translate, scale, shear, or rotate image colors.  Although you can use variable sized matrices, typically you use a 5 x 5 for an RGBA image and a 6x6 for CMYKA.  Populate the last row with normalized values to translate.</td>
944   </tr>
945
946   <tr>
947     <td valign="top">ReduceNoise</td>
948     <td valign="top">radius=&gt;<i>double</i></td>
949     <td valign="top">reduce noise in the image with a noise peak elimination filter</td>
950   </tr>
951
952   <tr>
953     <td valign="top">Remap</td>
954     <td valign="top">image=&gt;<i>image-handle</i>,  dither-method=&gt;{Riemersma, Floyd-Steinberg}</td>
955     <td valign="top">replace the colors of an image with the closest color from a reference image.</td>
956   </tr>
957
958   <tr>
959     <td valign="top">Resample</td>
960     <td valign="top">density=&gt;<i>geometry</i>, x=&gt;<i>double</i>, y=&gt;<i>double</i>, filter=&gt;{Point, Box, Triangle, Hermite, Hanning, Hamming, Blackman, Gaussian, Quadratic, Cubic, Catrom, Mitchell, Lanczos, Bessel, Sinc}, support=&gt;<i>double</i></td>
961     <td valign="top">resample image to desired resolution. Specify <kbd>blur</kbd> &gt; 1 for blurry or &lt; 1 for sharp</td>
962   </tr>
963
964   <tr>
965     <td valign="top">Resize</td>
966     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, filter=&gt;{Point, Box, Triangle, Hermite, Hanning, Hamming, Blackman, Gaussian, Quadratic, Cubic, Catrom, Mitchell, Lanczos, Bessel, Sinc}, support=&gt;<i>double</i>, blur=&gt;<i>double</i></td>
967     <td valign="top">scale image to desired size. Specify <kbd>blur</kbd> &gt; 1 for blurry or &lt; 1 for sharp</td>
968   </tr>
969
970   <tr>
971     <td valign="top">Roll</td>
972     <td valign="top">geometry=&gt;<i>geometry</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i></td>
973     <td valign="top">roll an image vertically or horizontally</td>
974   </tr>
975
976   <tr>
977     <td valign="top">Rotate</td>
978     <td valign="top">degrees=&gt;<i>double</i>, background=&gt;<i><a href="../www/color.html">color name</a></i></td>
979     <td valign="top">rotate an image</td>
980   </tr>
981
982   <tr>
983     <td valign="top">Sample</td>
984     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i></td>
985     <td valign="top">scale image with pixel sampling.</td>
986   </tr>
987
988   <tr>
989     <td valign="top">Scale</td>
990     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i></td>
991     <td valign="top">scale image to desired size</td>
992   </tr>
993
994   <tr>
995     <td valign="top">Segment</td>
996     <td valign="top">colorspace=&gt;{RGB, Gray, Transparent, OHTA, XYZ, YCbCr, YCC, YIQ, YPbPr, YUV, CMYK}, verbose={True, False}, cluster-threshold=&gt;<i>double</i>, smoothing-threshold=<i>double</i></td>
997     <td valign="top">segment an image by analyzing the histograms of the color components and identifying units that are homogeneous</td>
998   </tr>
999
1000   <tr>
1001     <td valign="top">SelectiveBlur</td>
1002     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i>, threshold=&gt;<i>double</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
1003     <td valign="top">selectively blur pixels within a contrast threshold.</td>
1004   </tr>
1005   <tr>
1006     <td valign="top">Separate</td>
1007     <td valign="top">channel=&gt;{Red, RGB, CMYK, Cyan, Green, Magenta, Blue, Yellow, Opacity, Black, or All}</td>
1008     <td valign="top">separate a channel from the image into a grayscale image</td>
1009   </tr>
1010
1011   <tr>
1012     <td valign="top">Shade</td>
1013     <td valign="top">geometry=&gt;<i>geometry</i>, azimuth=&gt;<i>double</i>, elevation=&gt;<i>double</i>, gray=&gt;{true, false}</td>
1014     <td valign="top">shade the image using a distant light source</td>
1015   </tr>
1016
1017   <tr>
1018     <td valign="top">SetPixel</td>
1019     <td valign="top">geometry=&gt;<i>geometry</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}, color=&gt;<i>array of float values</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i>, color=&gt;<i>array of float values</i></td>
1020     <td valign="top">set a single pixel.  By default normalized pixel values are expected.</td>
1021   </tr>
1022
1023   <tr>
1024     <td valign="top">Shadow</td>
1025     <td valign="top">geometry=&gt;<i>geometry</i>, opacity=&gt;<i>double</i>, sigma=&gt;<i>double</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i></td>
1026     <td valign="top">simulate an image shadow</td>
1027   </tr>
1028
1029   <tr>
1030     <td valign="top">Sharpen</td>
1031     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
1032     <td valign="top">sharpen the image with a Gaussian operator of the given radius and standard deviation (sigma).</td>
1033   </tr>
1034
1035   <tr>
1036     <td valign="top">Shave</td>
1037     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i></td>
1038     <td valign="top">shave pixels from the image edges</td>
1039   </tr>
1040
1041   <tr>
1042     <td valign="top">Shear</td>
1043     <td valign="top">geometry=&gt;<i>geometry</i>, x=&gt;<i>double</i>, y=&gt;<i>double</i> fill=&gt;<i><a href="../www/color.html">color name</a></i></td>
1044     <td valign="top">shear the image along the X or Y axis by a positive or negative shear angle</td>
1045   </tr>
1046
1047   <tr>
1048     <td valign="top">SigmoidalContrast</td>
1049     <td valign="top">geometry=&gt;<i>string</i>, 'contrast'=&gt;<i>double</i>, 'mid-point'=&gt;<i>double</i> channel=&gt;{Red, RGB, CMYK, Cyan, Green, Magenta, Blue, Yellow, Opacity, Black, or All}, sharpen=&gt;{True, False}</td>
1050     <td valign="top">sigmoidal non-lineraity contrast control.  Increase the contrast of the image using a sigmoidal transfer function without saturating highlights or shadows. <em class="option">Contrast</em> indicates how much to increase the contrast (0 is none; 3 is typical; 20 is a lot);  <em class="option">mid-point</em> indicates where midtones fall in the resultant image (0 is white; 50% is middle-gray; 100% is black). To decrease contrast, set sharpen to False.</td>
1051   </tr>
1052
1053   <tr>
1054     <td valign="top">Signature</td>
1055     <td valign="top"><br /></td>
1056     <td valign="top">generate an SHA-256 message digest for the image pixel stream</td>
1057   </tr>
1058
1059   <tr>
1060     <td valign="top">Sketch</td>
1061     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i>, angle=&gt;<i>double</i></td>
1062     <td valign="top">sketch the image with a Gaussian operator of the given radius and standard deviation (sigma) at the given angle</td>
1063   </tr>
1064
1065   <tr>
1066     <td valign="top">Solarize</td>
1067     <td valign="top">geometry=&gt;<i>string</i>,threshold=&gt;<i>double</i></td>
1068     <td valign="top">negate all pixels above the threshold level</td>
1069   </tr>
1070
1071   <tr>
1072     <td valign="top">SparseColor</td>
1073     <td valign="top">points=&gt;<i>array of float values</i>, method=&gt;{Barycentric, Bilinear, Shepards, Voronoi}, virtual-pixel=&gt;{Background Black Constant Dither Edge Gray Mirror Random Tile Transparent White}</td>
1074     <td valign="top">interpolate the image colors around the supplied points</td>
1075   </tr>
1076
1077   <tr>
1078     <td valign="top">Splice</td>
1079     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i>, fuzz=&gt;<i>double</i>, background=&gt;<i><a href="../www/color.html">color name</a></i>, gravity=&gt;{NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}</td>
1080     <td valign="top">splice an image</td>
1081   </tr>
1082
1083   <tr>
1084     <td valign="top">Spread</td>
1085     <td valign="top">radius=&gt;<i>double</i></td>
1086     <td valign="top">displace image pixels by a random amount</td>
1087   </tr>
1088
1089   <tr>
1090     <td valign="top">Stegano</td>
1091     <td valign="top">image=&gt;<i>image-handle</i>, offset=&gt;<i>integer</i></td>
1092     <td valign="top">hide a digital watermark within the image</td>
1093   </tr>
1094
1095   <tr>
1096     <td valign="top">Stereo</td>
1097     <td valign="top">image=&gt;<i>image-handle</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i></td>
1098     <td valign="top">composites two images and produces a single image that is the composite of a left and right image of a stereo pair</td>
1099   </tr>
1100
1101   <tr>
1102     <td valign="top">Strip</td>
1103     <td valign="top"><br /></td>
1104     <td valign="top">strip an image of all profiles and comments.</td>
1105   </tr>
1106
1107   <tr>
1108     <td valign="top">Swirl</td>
1109     <td valign="top">degrees=&gt;<i>double</i>, interpolate=&gt;{undefined, average, bicubic, bilinear, mesh, nearest-neighbor, spline}</td>
1110     <td valign="top">swirl image pixels about the center</td>
1111   </tr>
1112
1113   <tr>
1114     <td valign="top">Texture</td>
1115     <td valign="top">texture=&gt;<i>image-handle</i></td>
1116     <td valign="top">name of texture to tile onto the image background</td>
1117   </tr>
1118
1119   <tr>
1120     <td valign="top">Thumbnail</td>
1121     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i></td>
1122     <td valign="top">changes the size of an image to the given dimensions and removes any associated profiles.</td>
1123   </tr>
1124
1125   <tr>
1126     <td valign="top">Threshold</td>
1127     <td valign="top">threshold=&gt;<i>string</i>, channel=&gt;{All, Default, Alpha, Black, Blue, CMYK, Cyan, Gray, Green, Index, Magenta, Opacity, Red, RGB, Yellow}</td>
1128     <td valign="top">threshold the image</td>
1129   </tr>
1130
1131   <tr>
1132     <td valign="top">Tint</td>
1133     <td valign="top">fill=&gt;<i><a href="../www/color.html">color name</a></i>, opacity=&gt;<i>string</i></td>
1134     <td valign="top">tint the image with the fill color.</td>
1135   </tr>
1136
1137   <tr>
1138     <td valign="top">Transparent</td>
1139     <td valign="top">color=&gt;<i><a href="../www/color.html">color name</a></i>, invert=&gt;{True, False}</td>
1140     <td valign="top">make this color transparent within the image</td>
1141   </tr>
1142
1143   <tr>
1144     <td valign="top">Transpose</td>
1145     <td valign="top"><br /></td>
1146     <td valign="top">flip image in the vertical direction and rotate 90 degrees</td>
1147   </tr>
1148
1149   <tr>
1150     <td valign="top">Transverse</td>
1151     <td valign="top"><br /></td>
1152     <td valign="top">flop image in the horizontal direction and rotate 270 degrees</td>
1153   </tr>
1154
1155   <tr>
1156     <td valign="top">Trim</td>
1157     <td valign="top"><br /></td>
1158     <td valign="top">remove edges that are the background color from the image</td>
1159   </tr>
1160
1161   <tr>
1162     <td valign="top">UnsharpMask</td>
1163     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i>, amount=&gt;<i>double</i>, threshold=&gt;<i>double</i></td>
1164     <td valign="top">sharpen the image with the unsharp mask algorithm.</td>
1165   </tr>
1166
1167   <tr>
1168     <td valign="top">Vignette</td>
1169     <td valign="top">geometry=&gt;<i>geometry</i>, radius=&gt;<i>double</i>, sigma=&gt;<i>double</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i>, background=&gt;<i><a href="../www/color.html">color name</a></i></td>
1170     <td valign="top">offset the edges of the image in vignette style</td>
1171   </tr>
1172
1173   <tr>
1174     <td valign="top">Wave</td>
1175     <td valign="top">geometry=&gt;<i>geometry</i>, amplitude=&gt;<i>double</i>, wavelength=&gt;<i>double</i>, interpolate=&gt;{undefined, average, bicubic, bilinear, mesh, nearest-neighbor, spline}</td>
1176     <td valign="top">alter an image along a sine wave</td>
1177   </tr>
1178
1179   <tr>
1180     <td valign="top">WhiteThreshold</td>
1181     <td valign="top">threshold=&gt;<i>string</i></td>
1182     <td valign="top">force all pixels above the threshold intensity into white</td>
1183   </tr>
1184 </tbody>
1185 </table>
1186
1187 <p>Note, that the <kbd>geometry</kbd> parameter is a short cut for the <kbd>width</kbd> and <kbd>height</kbd> parameters (e.g.  <kbd>geometry=&gt;'106x80'</kbd> is equivalent to <kbd>width=&gt;106, height=&gt;80</kbd> ).</p>
1188
1189 <p>You can specify <kbd>@filename</kbd> in both Annotate() and Draw(). This reads the text or graphic primitive instructions from a file on disk. For example,</p>
1190
1191 <pre class="code">
1192    $image-&gt;Draw(fill=&gt;'red', primitive=&gt;'rectangle',
1193      points=&gt;'20,20 100,100  40,40 200,200  60,60 300,300');
1194 </pre>
1195
1196 <p>Is equivalent to</p>
1197
1198 <pre class="code">
1199    $image-&gt;Draw(fill=&gt;'red', primitive=&gt;'@draw.txt');
1200 </pre>
1201
1202 <p>Where <kbd>draw.txt</kbd> is a file on disk that contains this:</p>
1203
1204 <pre class="text">
1205   rectangle 20, 20 100, 100
1206   rectangle 40, 40 200, 200
1207   rectangle 60, 60 300, 300
1208 </pre>
1209
1210 <p>The <i>text</i> parameter for methods, Annotate(), Comment(), Draw(), and Label() can include the image filename, type, width, height, or other image attribute by embedding these special format characters:</p>
1211
1212 <pre class="text">
1213    %b   file size
1214    %c   comment
1215    %d   directory
1216    %e   filename extension
1217    %f   filename
1218    %g   page geometry
1219    %h   height
1220    %i   input filename
1221    %k   number of unique colors
1222    %l   label
1223    %m   magick
1224    %n   number of scenes
1225    %o   output filename
1226    %p   page number
1227    %q   quantum depth
1228    %r   image class and colorspace
1229    %s   scene number
1230    %t   top of filename
1231    %u   unique temporary filename
1232    %w   width
1233    %x   x resolution
1234    %y   y resolution
1235    %z   image depth
1236    %C   image compression type
1237    %D   image dispose method
1238    %H   page height
1239    %Q   image compression quality
1240    %T   image delay
1241    %W   page width
1242    %X   page x offset
1243    %Y   page y offset
1244    %@   bounding box
1245    %#   signature
1246    %%   a percent sign
1247    \n   newline
1248    \r   carriage return
1249 </pre>
1250
1251 <p>For example,</p>
1252
1253 <pre class="code">
1254   text=&gt;"%m:%f %wx%h"
1255 </pre>
1256
1257 <p>produces an annotation of <b>MIFF:bird.miff 512x480</b> for an image titled <b>bird.miff</b> and whose width is 512 and height is 480.</p>
1258
1259 <p>You can optionally add <i>Image</i> to any method name. For example, TrimImage() is an alias for method Trim().</p>
1260
1261 <p>Most of the attributes listed above have an analog in <a href="../www/convert.html">convert</a>. See the documentation for a more detailed description of these attributes.</p>
1262
1263 </div>
1264
1265 <h2><a name="set-attribute"></a>Set an Image Attribute</h2>
1266 <div class="doc-section">
1267
1268 <p>Use method Set() to set an image attribute. For example,</p>
1269
1270 <pre class="code">
1271   $image-&gt;Set(dither=&gt;'True');
1272   $image-&gt;[$x]-&gt;Set(delay=&gt;3);
1273 </pre>
1274
1275 <p>Where this example uses 'True' and this document says '{True, False}',
1276 you can use the case-insensitive strings 'True' and 'False', or you
1277 can use the integers 1 and 0.</p>
1278
1279 <p>When you call Get() on a Boolean attribute, Image::Magick returns 1 or 0, not a string.</p>
1280
1281 <p>And here is a list of all the image attributes you can set:</p>
1282
1283 <table class="doc">
1284   <caption>Image Attributes</caption>
1285   <tbody>
1286   <tr>
1287     <th>Attribute</th>
1288     <th style="width: 40%">Values</th>
1289     <th style="width: 40%">Description</th>
1290   </tr>
1291
1292   <tr>
1293     <td valign="top">adjoin</td>
1294     <td valign="top">{True, False}</td>
1295     <td valign="top">join images into a single multi-image file</td>
1296   </tr>
1297
1298   <tr>
1299     <td valign="top">alpha</td>
1300     <td valign="top">{On, Off, Opaque, Transparent, Copy, Extract, Set}</td>
1301     <td valign="top">control of and special operations involving the alpha/matte channel</td>
1302   </tr>
1303
1304   <tr>
1305     <td valign="top">antialias</td>
1306     <td valign="top">{True, False}</td>
1307     <td valign="top">remove pixel aliasing</td>
1308   </tr>
1309
1310   <tr>
1311     <td valign="top">area-limit</td>
1312     <td valign="top"><i>integer</i></td>
1313     <td valign="top">set pixel area resource limit in megabytes.</td>
1314   </tr>
1315
1316   <tr>
1317     <td valign="top">attenuate</td>
1318     <td valign="top"><i>double</i></td>
1319     <td valign="top">lessen (or intensify) when adding noise to an image.</td>
1320   </tr>
1321
1322   <tr>
1323     <td valign="top">authenticate</td>
1324     <td valign="top"><i>string</i></td>
1325     <td valign="top">decrypt image with this password.</td>
1326   </tr>
1327
1328   <tr>
1329     <td valign="top">background</td>
1330     <td valign="top"><i><a href="../www/color.html">color name</a></i></td>
1331     <td valign="top">image background color</td>
1332   </tr>
1333
1334   <tr>
1335     <td valign="top">blue-primary</td>
1336     <td valign="top"><i>x-value</i>, <i>y-value</i></td>
1337     <td valign="top">chromaticity blue primary point (e.g. 0.15, 0.06)</td>
1338   </tr>
1339
1340   <tr>
1341     <td valign="top">bordercolor</td>
1342     <td valign="top"><i><a href="../www/color.html">color name</a></i></td>
1343     <td valign="top">set the image border color</td>
1344   </tr>
1345
1346   <tr>
1347     <td valign="top">clip-mask</td>
1348     <td valign="top"><i>image</i></td>
1349     <td valign="top">associate a clip mask with the image.</td>
1350   </tr>
1351
1352   <tr>
1353     <td valign="top">colormap[<i>i</i>]</td>
1354     <td valign="top"><i><a href="../www/color.html">color name</a></i></td>
1355     <td valign="top">color name (e.g. red) or hex value (e.g. #ccc) at position
1356 <i>i</i></td>
1357   </tr>
1358
1359   <tr>
1360     <td valign="top">comment</td>
1361     <td valign="top"><i>string</i></td>
1362     <td valign="top">set the image comment</td>
1363   </tr>
1364
1365   <tr>
1366     <td valign="top">compression</td>
1367     <td valign="top">{None, BZip, Fax, Group4, JPEG, JPEG2000, LosslessJPEG, LZW, RLE, Zip}</td>
1368     <td valign="top">type of image compression</td>
1369   </tr>
1370
1371   <tr>
1372     <td valign="top">debug</td>
1373     <td valign="top">{All, Annotate, Blob, Cache, Coder, Configure, Deprecate, Draw, Exception, Locale, None, Resource, Transform, X11}</td>
1374     <td valign="top">display copious debugging information</td>
1375   </tr>
1376
1377   <tr>
1378     <td valign="top">delay</td>
1379     <td valign="top"><i>integer</i></td>
1380     <td valign="top">this many 1/100ths of a second must expire before displaying the next image in a sequence</td>
1381   </tr>
1382
1383   <tr>
1384     <td valign="top">density</td>
1385     <td valign="top"><i>geometry</i></td>
1386     <td valign="top">vertical and horizontal resolution in pixels of the image</td>
1387   </tr>
1388
1389   <tr>
1390     <td valign="top">depth</td>
1391     <td valign="top"><i>integer</i></td>
1392     <td valign="top">image depth</td>
1393   </tr>
1394
1395   <tr>
1396     <td valign="top">disk-limit</td>
1397     <td valign="top"><i>integer</i></td>
1398     <td valign="top">set disk resource limit in megabytes</td>
1399   </tr>
1400
1401   <tr>
1402     <td valign="top">dispose</td>
1403     <td valign="top"><i>{Undefined, None, Background, Previous}</i></td>
1404     <td valign="top">layer disposal method</td>
1405   </tr>
1406
1407   <tr>
1408     <td valign="top">dither</td>
1409     <td valign="top">{True, False}</td>
1410     <td valign="top">apply error diffusion to the image</td>
1411   </tr>
1412
1413   <tr>
1414     <td valign="top">display</td>
1415     <td valign="top"><i>string</i></td>
1416     <td valign="top">specifies the X server to contact</td>
1417   </tr>
1418
1419   <tr>
1420     <td valign="top">extract</td>
1421     <td valign="top"><i>geometry</i></td>
1422     <td valign="top">extract area from image</td>
1423   </tr>
1424
1425   <tr>
1426     <td valign="top">file</td>
1427     <td valign="top"><i>filehandle</i></td>
1428     <td valign="top">set the image filehandle</td>
1429   </tr>
1430
1431   <tr>
1432     <td valign="top">filename</td>
1433     <td valign="top"><i>string</i></td>
1434     <td valign="top">set the image filename</td>
1435   </tr>
1436
1437   <tr>
1438     <td valign="top">fill</td>
1439     <td valign="top"><i>color</i></td>
1440     <td valign="top">The fill color paints any areas inside the outline of drawn shape.</td>
1441   </tr>
1442
1443   <tr>
1444     <td valign="top">font</td>
1445     <td valign="top"><i>string</i></td>
1446     <td valign="top">use this font when annotating the image with text</td>
1447   </tr>
1448
1449   <tr>
1450     <td valign="top">fuzz</td>
1451     <td valign="top"><i>integer</i></td>
1452     <td valign="top">colors within this distance are considered equal</td>
1453   </tr>
1454
1455   <tr>
1456     <td valign="top">gamma</td>
1457     <td valign="top"><i>double</i></td>
1458     <td valign="top">gamma level of the image</td>
1459   </tr>
1460
1461   <tr>
1462     <td valign="top">Gravity</td>
1463     <td valign="top">{Forget, NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast}</td>
1464     <td valign="top">type of image gravity</td>
1465   </tr>
1466
1467   <tr>
1468     <td valign="top">green-primary</td>
1469     <td valign="top"><i>x-value</i>, <i>y-value</i></td>
1470     <td valign="top">chromaticity green primary point (e.g. 0.3, 0.6)</td>
1471   </tr>
1472
1473   <tr>
1474     <td valign="top">index[<i>x</i>, <i>y</i>]</td>
1475     <td valign="top"><i>string</i></td>
1476     <td valign="top">colormap index at position (<i>x</i>, <i>y</i>)</td>
1477   </tr>
1478
1479   <tr>
1480     <td valign="top">interlace</td>
1481     <td valign="top">{None, Line, Plane, Partition, JPEG, GIF, PNG}</td>
1482     <td valign="top">the type of interlacing scheme</td>
1483   </tr>
1484
1485   <tr>
1486     <td valign="top">iterations</td>
1487     <td valign="top"><i>integer</i></td>
1488     <td valign="top">add Netscape loop extension to your GIF animation</td>
1489   </tr>
1490
1491   <tr>
1492     <td valign="top">label</td>
1493     <td valign="top"><i>string</i></td>
1494     <td valign="top">set the image label</td>
1495   </tr>
1496
1497   <tr>
1498     <td valign="top">loop</td>
1499     <td valign="top"><i>integer</i></td>
1500     <td valign="top">add Netscape loop extension to your GIF animation</td>
1501   </tr>
1502
1503   <tr>
1504     <td valign="top">magick</td>
1505     <td valign="top"><i>string</i></td>
1506     <td valign="top">set the image format</td>
1507   </tr>
1508
1509   <tr>
1510     <td valign="top">map-limit</td>
1511     <td valign="top"><i>integer</i></td>
1512     <td valign="top">set map resource limit in megabytes</td>
1513   </tr>
1514
1515   <tr>
1516     <td valign="top">mask</td>
1517     <td valign="top"><i>image</i></td>
1518     <td valign="top">associate a mask with the image.</td>
1519   </tr>
1520
1521   <tr>
1522     <td valign="top">matte</td>
1523     <td valign="top">{True, False}</td>
1524     <td valign="top">enable the image matte channel</td>
1525   </tr>
1526
1527   <tr>
1528     <td valign="top">mattecolor</td>
1529     <td valign="top"><i><a href="../www/color.html">color name</a></i></td>
1530     <td valign="top">set the image matte color</td>
1531   </tr>
1532
1533   <tr>
1534     <td valign="top">memory-limit</td>
1535     <td valign="top"><i>integer</i></td>
1536     <td valign="top">set memory resource limit in megabytes</td>
1537   </tr>
1538
1539   <tr>
1540     <td valign="top">monochrome</td>
1541     <td valign="top">{True, False}</td>
1542     <td valign="top">transform the image to black and white</td>
1543   </tr>
1544
1545   <tr>
1546     <td valign="top">option</td>
1547     <td valign="top"><i>string</i></td>
1548     <td valign="top">associate an option with an image format (e.g.  option=&gt;'ps:imagemask'</td>
1549   </tr>
1550
1551   <tr>
1552     <td valign="top">orientation</td>
1553     <td valign="top">{top-left, top-right, bottom-right, bottom-left, left-top, right-top, right-bottom, left-bottom}</td>
1554     <td valign="top">image orientation</td>
1555   </tr>
1556
1557   <tr>
1558     <td valign="top">page</td>
1559     <td valign="top">{ Letter, Tabloid, Ledger, Legal, Statement, Executive, A3, A4, A5, B4, B5, Folio, Quarto, 10x14} or <i>geometry</i></td>
1560     <td valign="top">preferred size and location of an image canvas</td>
1561   </tr>
1562
1563   <tr>
1564     <td valign="top">pixel[<i>x</i>, <i>y</i>]</td>
1565     <td valign="top"><i>string</i></td>
1566     <td valign="top">hex value (e.g. #ccc) at position (<i>x</i>, <i>y</i>)</td>
1567   </tr>
1568
1569   <tr>
1570     <td valign="top">pointsize</td>
1571     <td valign="top"><i>integer</i></td>
1572     <td valign="top">pointsize of the Postscript or TrueType font</td>
1573   </tr>
1574
1575   <tr>
1576     <td valign="top">quality</td>
1577     <td valign="top"><i>integer</i></td>
1578     <td valign="top">JPEG/MIFF/PNG compression level</td>
1579   </tr>
1580
1581   <tr>
1582     <td valign="top">red-primary</td>
1583     <td valign="top"><i>x-value</i>, <i>y-value</i></td>
1584     <td valign="top">chromaticity red primary point (e.g. 0.64, 0.33)</td>
1585   </tr>
1586
1587   <tr>
1588     <td valign="top">sampling-factor</td>
1589     <td valign="top"><i>geometry</i></td>
1590     <td valign="top">horizontal and vertical sampling factor</td>
1591   </tr>
1592
1593   <tr>
1594     <td valign="top">scene</td>
1595     <td valign="top"><i>integer</i></td>
1596     <td valign="top">image scene number</td>
1597   </tr>
1598
1599   <tr>
1600     <td valign="top">server</td>
1601     <td valign="top"><i>string</i></td>
1602     <td valign="top">specifies the X server to contact</td>
1603   </tr>
1604
1605   <tr>
1606     <td valign="top">size</td>
1607     <td valign="top"><i>string</i></td>
1608     <td valign="top">width and height of a raw image</td>
1609   </tr>
1610
1611   <tr>
1612     <td valign="top">stroke</td>
1613     <td valign="top"><i>color</i></td>
1614     <td valign="top">The stroke color paints along the outline of a shape.</td>
1615   </tr>
1616
1617   <tr>
1618     <td valign="top">texture</td>
1619     <td valign="top"><i>string</i></td>
1620     <td valign="top">name of texture to tile onto the image background</td>
1621   </tr>
1622
1623   <tr>
1624     <td valign="top">tile-offset</td>
1625     <td valign="top"><i>geometry</i></td>
1626     <td valign="top">image tile offset</td>
1627   </tr>
1628
1629   <tr>
1630     <td valign="top">time-limit</td>
1631     <td valign="top"><i>integer</i></td>
1632     <td valign="top">set time resource limit in seconds</td>
1633   </tr>
1634
1635   <tr>
1636     <td valign="top">type</td>
1637     <td valign="top">{Bilevel, Grayscale, GrayscaleMatte, Palette, PaletteMatte, TrueColor, TrueColorMatte, ColorSeparation, ColorSeparationMatte, Optimize }</td>
1638     <td valign="top">image type</td>
1639   </tr>
1640
1641   <tr>
1642     <td valign="top">units</td>
1643     <td valign="top">{ Undefined, PixelsPerInch, PixelsPerCentimeter}</td>
1644     <td valign="top">units of image resolution</td>
1645   </tr>
1646
1647   <tr>
1648     <td valign="top">verbose</td>
1649     <td valign="top">{True, False}</td>
1650     <td valign="top">print detailed information about the image</td>
1651   </tr>
1652
1653   <tr>
1654     <td valign="top">virtual-pixel</td>
1655     <td valign="top">{Background Black Constant Dither Edge Gray Mirror Random Tile Transparent White}</td>
1656     <td valign="top">the virtual pixel method</td>
1657   </tr>
1658
1659   <tr>
1660     <td valign="top">white-point</td>
1661     <td valign="top"><i>x-value</i>, <i>y-value</i></td>
1662     <td valign="top">chromaticity white point (e.g. 0.3127, 0.329)</td>
1663   </tr>
1664   </tbody>
1665 </table>
1666
1667 <p>Note, that the <kbd>geometry</kbd> parameter is a short cut for the <kbd>width</kbd> and <kbd>height</kbd> parameters (e.g.  <kbd>geometry=&gt;'106x80'</kbd> is equivalent to <kbd>width=&gt;106, height=&gt;80</kbd>).</p>
1668
1669 <p>SetAttribute() is an alias for method Set().</p>
1670
1671 <p>Most of the attributes listed above have an analog in
1672 <a href="../www/convert.html">convert</a>. See the documentation for a more detailed description of these attributes.</p>
1673
1674 </div>
1675
1676 <h2><a name="get-attribute"></a>Get an Image Attribute</h2>
1677 <div class="doc-section">
1678
1679 <p>Use method Get() to get an image attribute. For example,</p>
1680
1681 <pre class="code">
1682   ($a, $b, $c) = $image-&gt;Get('colorspace', 'magick', 'adjoin');
1683   $width = $image-&gt;[3]-&gt;Get('columns');
1684 </pre>
1685
1686 <p>In addition to all the attributes listed in <a href="#set-attribute">Set an Image Attribute</a> , you can get these additional attributes:</p>
1687
1688 <table class="doc">
1689   <caption>Image Attributes</caption>
1690   <tbody>
1691   <tr>
1692     <th>Attribute</th>
1693     <th>Values</th>
1694     <th style="width: 60%">Description</th>
1695   </tr>
1696
1697   <tr>
1698     <td valign="top">area</td>
1699     <td valign="top"><i>integer</i></td>
1700     <td valign="top">current area resource consumed</td>
1701   </tr>
1702
1703   <tr>
1704     <td valign="top">base-columns</td>
1705     <td valign="top"><i>integer</i></td>
1706     <td valign="top">base image width (before transformations)</td>
1707   </tr>
1708
1709   <tr>
1710     <td valign="top">base-filename</td>
1711     <td valign="top"><i>string</i></td>
1712     <td valign="top">base image filename (before transformations)</td>
1713   </tr>
1714
1715   <tr>
1716     <td valign="top">base-rows</td>
1717     <td valign="top"><i>integer</i></td>
1718     <td valign="top">base image height (before transformations)</td>
1719   </tr>
1720
1721   <tr>
1722     <td valign="top">class</td>
1723     <td valign="top">{Direct, Pseudo}</td>
1724     <td valign="top">image class</td>
1725   </tr>
1726
1727   <tr>
1728     <td valign="top">colors</td>
1729     <td valign="top"><i>integer</i></td>
1730     <td valign="top">number of unique colors in the image</td>
1731   </tr>
1732
1733   <tr>
1734     <td valign="top">columns</td>
1735     <td valign="top"><i>integer</i></td>
1736     <td valign="top">image width</td>
1737   </tr>
1738
1739   <tr>
1740     <td valign="top">copyright</td>
1741     <td valign="top"><i>string</i></td>
1742     <td valign="top">get PerlMagick's copyright</td>
1743   </tr>
1744
1745   <tr>
1746     <td valign="top">directory</td>
1747     <td valign="top"><i>string</i></td>
1748     <td valign="top">tile names from within an image montage</td>
1749   </tr>
1750
1751   <tr>
1752     <td valign="top">elapsed-time</td>
1753     <td valign="top"><i>double</i></td>
1754     <td valign="top">elapsed time in seconds since the image was created</td>
1755   </tr>
1756
1757   <tr>
1758     <td valign="top">error</td>
1759     <td valign="top"><i>double</i></td>
1760     <td valign="top">the mean error per pixel computed with methods Compare() or Quantize()</td>
1761   </tr>
1762
1763   <tr>
1764     <td valign="top">bounding-box</td>
1765     <td valign="top"><i>string</i></td>
1766     <td valign="top">image bounding box</td>
1767   </tr>
1768
1769   <tr>
1770     <td valign="top">disk</td>
1771     <td valign="top"><i>integer</i></td>
1772     <td valign="top">current disk resource consumed</td>
1773   </tr>
1774
1775   <tr>
1776     <td valign="top">filesize</td>
1777     <td valign="top"><i>integer</i></td>
1778     <td valign="top">number of bytes of the image on disk</td>
1779   </tr>
1780
1781   <tr>
1782     <td valign="top">format</td>
1783     <td valign="top"><i>string</i></td>
1784     <td valign="top">get the descriptive image format</td>
1785   </tr>
1786
1787   <tr>
1788     <td valign="top">geometry</td>
1789     <td valign="top"><i>string</i></td>
1790     <td valign="top">image geometry</td>
1791   </tr>
1792
1793   <tr>
1794     <td valign="top">height</td>
1795     <td valign="top"><i>integer</i></td>
1796     <td valign="top">the number of rows or height of an image</td>
1797   </tr>
1798
1799   <tr>
1800     <td valign="top">id</td>
1801     <td valign="top"><i>integer</i></td>
1802     <td valign="top">ImageMagick registry id</td>
1803   </tr>
1804
1805   <tr>
1806     <td valign="top">mean-error</td>
1807     <td valign="top"><i>double</i></td>
1808     <td valign="top">the normalized mean error per pixel computed with methods Compare() or Quantize()</td>
1809   </tr>
1810
1811   <tr>
1812     <td valign="top">map</td>
1813     <td valign="top"><i>integer</i></td>
1814     <td valign="top">current memory-mapped resource consumed</td>
1815   </tr>
1816
1817   <tr>
1818     <td valign="top">matte</td>
1819     <td valign="top">{True, False}</td>
1820     <td valign="top">whether or not the image has a matte channel</td>
1821   </tr>
1822
1823   <tr>
1824     <td valign="top">maximum-error</td>
1825     <td valign="top"><i>double</i></td>
1826     <td valign="top">the normalized max error per pixel computed with methods Compare() or Quantize()</td>
1827   </tr>
1828
1829   <tr>
1830     <td valign="top">memory</td>
1831     <td valign="top"><i>integer</i></td>
1832     <td valign="top">current memory resource consumed</td>
1833   </tr>
1834
1835   <tr>
1836     <td valign="top">mime</td>
1837     <td valign="top"><i>string</i></td>
1838     <td valign="top">MIME of the image format</td>
1839   </tr>
1840
1841   <tr>
1842     <td valign="top">montage</td>
1843     <td valign="top"><i>geometry</i></td>
1844     <td valign="top">tile size and offset within an image montage</td>
1845   </tr>
1846
1847   <tr>
1848     <td valign="top">page.x</td>
1849     <td valign="top"><i>integer</i></td>
1850     <td valign="top">x offset of image virtual canvas</td>
1851   </tr>
1852
1853   <tr>
1854     <td valign="top">page.y</td>
1855     <td valign="top"><i>integer</i></td>
1856     <td valign="top">y offset of image virtual canvas</td>
1857   </tr>
1858
1859   <tr>
1860     <td valign="top">rows</td>
1861     <td valign="top"><i>integer</i></td>
1862     <td valign="top">the number of rows or height of an image</td>
1863   </tr>
1864
1865   <tr>
1866     <td valign="top">signature</td>
1867     <td valign="top"><i>string</i></td>
1868     <td valign="top">SHA-256 message digest associated with the image pixel stream</td>
1869   </tr>
1870
1871   <tr>
1872     <td valign="top">taint</td>
1873     <td valign="top">{True, False}</td>
1874     <td valign="top">True if the image has been modified</td>
1875   </tr>
1876
1877   <tr>
1878     <td valign="top">total-ink-density</td>
1879     <td valign="top"><i>double</i></td>
1880     <td valign="top">returns the total ink density for a CMYK image</td>
1881   </tr>
1882
1883   <tr>
1884     <td valign="top">transparent-color</td>
1885     <td valign="top"><i><a href="../www/color.html">color name</a></i></td>
1886     <td valign="top">set the image transparent color</td>
1887   </tr>
1888
1889   <tr>
1890     <td valign="top">user-time</td>
1891     <td valign="top"><i>double</i></td>
1892     <td valign="top">user time in seconds since the image was created</td>
1893   </tr>
1894
1895   <tr>
1896     <td valign="top">version</td>
1897     <td valign="top"><i>string</i></td>
1898     <td valign="top">get PerlMagick's version</td>
1899   </tr>
1900
1901   <tr>
1902     <td valign="top">width</td>
1903     <td valign="top"><i>integer</i></td>
1904     <td valign="top">the number of columns or width of an image</td>
1905   </tr>
1906
1907   <tr>
1908     <td valign="top">x-resolution</td>
1909     <td valign="top"><i>integer</i></td>
1910     <td valign="top">x resolution of the image</td>
1911   </tr>
1912
1913   <tr>
1914     <td valign="top">y-resolution</td>
1915     <td valign="top"><i>integer</i></td>
1916     <td valign="top">y resolution of the image</td>
1917   </tr>
1918   </tbody>
1919 </table>
1920
1921 <p>GetAttribute() is an alias for method Get().</p>
1922
1923 <p>Most of the attributes listed above have an analog in
1924 <a href="../www/convert.html">convert</a>. See the documentation for a more detailed description of these attributes.</p>
1925
1926 </div>
1927
1928 <h2><a name="compare"></a>Compare an Image to its Reconstruction</h2>
1929 <div class="doc-section">
1930 </div>
1931
1932 <p>Mathematically and visually annotate the difference between an image and its reconstruction with the Compare() method.  The method supports these parameters:</p>
1933
1934 <table class="doc">
1935   <caption>Compare Parameters</caption>
1936   <tbody>
1937   <tr>
1938     <th>Parameter</th>
1939     <th style="width: 40%">Values</th>
1940     <th style="width: 40%">Description</th>
1941   </tr>
1942
1943   <tr>
1944     <td valign="top">channel</td>
1945     <td valign="top"><i>double</i></td>
1946     <td valign="top">select image channels, the default is all channels except alpha.</td>
1947   </tr>
1948
1949   <tr>
1950     <td valign="top">fuzz</td>
1951     <td valign="top"><i>double</i></td>
1952     <td valign="top">colors within this distance are considered equal</td>
1953   </tr>
1954
1955   <tr>
1956     <td valign="top">image</td>
1957     <td valign="top"><i>image-reference</i></td>
1958     <td valign="top">the image reconstruction</td>
1959   </tr>
1960
1961   <tr>
1962     <td valign="top">metric</td>
1963     <td valign="top">AE, MAE, MEPP, MSE, PAE, PSNR, RMSE</td>
1964     <td valign="top">measure differences between images with this metric</td>
1965   </tr>
1966   </tbody>
1967 </table>
1968
1969 <p>In this example, we compare the ImageMagick logo to a sharpened reconstruction:</p>
1970
1971 <pre class="code">
1972   use Image::Magick;
1973
1974   $logo=Image::Magick->New();
1975   $logo->Read('logo:');
1976   $sharp=Image::Magick->New();
1977   $sharp->Read('logo:');
1978   $sharp->Sharpen('0x1');
1979   $difference=$logo->Compare(image=>$sharp, metric=>'rmse');
1980   print $difference->Get('error'), "\n";
1981   $difference->Display();
1982 </pre>
1983
1984 <p>In addition to the reported root mean squared error of around 0.024, a difference image is displayed so you can visually identify the difference between the images.</p>
1985
1986 <h2><a name="montage"></a>Create an Image Montage</h2>
1987 <div class="doc-section">
1988
1989 <p>Use method Montage() to create a composite image by combining several separate images. The images are tiled on the composite image with the name of the image optionally appearing just below the individual tile. For example,</p>
1990
1991 <pre class="code">
1992   $image-&gt;Montage(geometry=&gt;'160x160', tile=&gt;'2x2', texture=&gt;'granite:');
1993 </pre>
1994
1995 <p>And here is a list of Montage() parameters you can set:</p>
1996
1997 <table class="doc">
1998   <caption>Montage Parameters</caption>
1999   <tbody>
2000   <tr>
2001     <th>Parameter</th>
2002     <th style="width: 40%">Values</th>
2003     <th style="width: 40%">Description</th>
2004   </tr>
2005
2006   <tr>
2007     <td valign="top">background</td>
2008     <td valign="top"><i><a href="../www/color.html">color name</a></i></td>
2009     <td valign="top">background color name</td>
2010   </tr>
2011
2012   <tr>
2013     <td valign="top">border</td>
2014     <td valign="top"><i>integer</i></td>
2015     <td valign="top">image border width</td>
2016   </tr>
2017
2018   <tr>
2019     <td valign="top">filename</td>
2020     <td valign="top"><i>string</i></td>
2021     <td valign="top">name of montage image</td>
2022   </tr>
2023
2024   <tr>
2025     <td valign="top">fill</td>
2026     <td valign="top"><a href="../www/color.html">color name</a></td>
2027     <td valign="top">fill color for annotations</td>
2028   </tr>
2029
2030   <tr>
2031     <td valign="top">font</td>
2032     <td valign="top"><i>string</i></td>
2033     <td valign="top">X11 font name</td>
2034   </tr>
2035
2036   <tr>
2037     <td valign="top">frame</td>
2038     <td valign="top"><i>geometry</i></td>
2039     <td valign="top">surround the image with an ornamental border</td>
2040   </tr>
2041
2042   <tr>
2043     <td valign="top">geometry</td>
2044     <td valign="top"><i>geometry</i></td>
2045     <td valign="top">preferred tile and border size of each tile of the composite
2046 image (e.g. 120x120+4+3>)</td>
2047   </tr>
2048
2049   <tr>
2050     <td valign="top">gravity</td>
2051     <td valign="top">NorthWest, North, NorthEast, West, Center, East, SouthWest,
2052 South, SouthEast</td>
2053     <td valign="top">direction image gravitates to within a tile</td>
2054   </tr>
2055
2056   <tr>
2057     <td valign="top">label</td>
2058     <td valign="top"><i>string</i></td>
2059     <td valign="top">assign a label to an image</td>
2060   </tr>
2061
2062   <tr>
2063     <td valign="top">mode</td>
2064     <td valign="top">Frame, Unframe, Concatenate</td>
2065     <td valign="top">thumbnail framing options</td>
2066   </tr>
2067
2068   <tr>
2069     <td valign="top">pointsize</td>
2070     <td valign="top"><i>integer</i></td>
2071     <td valign="top">pointsize of the Postscript or TrueType font</td>
2072   </tr>
2073
2074   <tr>
2075     <td valign="top">shadow</td>
2076     <td valign="top">{True, False}</td>
2077     <td valign="top">add a shadow beneath a tile to simulate depth</td>
2078   </tr>
2079
2080   <tr>
2081     <td valign="top">stroke</td>
2082     <td valign="top"><a href="../www/color.html">color name</a></td>
2083     <td valign="top">stroke color for annotations</td>
2084   </tr>
2085
2086   <tr>
2087     <td valign="top">texture</td>
2088     <td valign="top"><i>string</i></td>
2089     <td valign="top">name of texture to tile onto the image background</td>
2090   </tr>
2091
2092   <tr>
2093     <td valign="top">tile</td>
2094     <td valign="top"><i>geometry</i></td>
2095     <td valign="top">the number of tiles per row and page (e.g. 6x4)</td>
2096   </tr>
2097
2098   <tr>
2099     <td valign="top">title</td>
2100     <td valign="top">string</td>
2101     <td valign="top">assign a title to the image montage</td>
2102   </tr>
2103
2104   <tr>
2105     <td valign="top">transparent</td>
2106     <td valign="top"><i>string</i></td>
2107     <td valign="top">make this color transparent within the image</td>
2108   </tr>
2109   </tbody>
2110 </table>
2111
2112 <p>Note, that the <kbd>geometry</kbd> parameter is a short cut for the <kbd>width</kbd> and <kbd>height</kbd> parameters (e.g.  <kbd>geometry=&gt;'106x80'</kbd> is equivalent to <kbd>width=&gt;106, height=&gt;80</kbd>).</p>
2113
2114 <p>MontageImage() is an alias for method Montage().</p>
2115
2116 <p>Most of the attributes listed above have an analog in <a href="../www/montage.html">montage</a>. See the documentation for a more detailed description of these attributes.</p>
2117
2118 </div>
2119
2120 <h2><a name="blobs"></a>Working with Blobs</h2>
2121 <div class="doc-section">
2122
2123 <p>A blob contains data that directly represent a particular image
2124 format in memory instead of on disk. PerlMagick supports
2125 blobs in any of these image <a href="../www/formats.html">formats</a> and provides methods to convert a blob to or from a particular image format.</p>
2126
2127 <table class="doc">
2128   <caption>Blob Methods</caption>
2129   <tbody>
2130   <tr>
2131     <th>Method</th>
2132     <th>Parameters</th>
2133     <th>Return Value</th>
2134     <th>Description</th>
2135   </tr>
2136
2137   <tr>
2138     <td valign="top">ImageToBlob</td>
2139     <td valign="top">any image <a href="#set-attribute">attribute</a></td>
2140     <td valign="top">an array of image data in the respective image format</td>
2141     <td valign="top">convert an image or image sequence to an array of blobs</td>
2142   </tr>
2143
2144   <tr>
2145     <td valign="top">BlobToImage</td>
2146     <td valign="top">one or more blobs</td>
2147     <td valign="top">the number of blobs converted to an image</td>
2148     <td valign="top">convert one or more blobs to an image</td>
2149   </tr>
2150   </tbody>
2151 </table>
2152
2153 <p>ImageToBlob() returns the image data in their respective formats. You can then print it, save it to an ODBC database, write it to a file, or pipe it to a display program:</p>
2154
2155 <pre class="code">
2156   @blobs = $image-&gt;ImageToBlob();
2157   open(DISPLAY,"| display -") || die;
2158   binmode DISPLAY;
2159   print DISPLAY $blobs[0];
2160   close DISPLAY;
2161 </pre>
2162
2163 <p>Method BlobToImage() returns an image or image sequence converted from the supplied blob:</p>
2164
2165 <pre class="code">
2166   @blob=$db-&gt;GetImage();
2167   $image=Image::Magick-&gt;new(magick=&gt;'jpg');
2168   $image-&gt;BlobToImage(@blob);
2169 </pre>
2170
2171 </div>
2172
2173 <h2><a name="direct-access"></a>Direct-access to Image Pixels</h2>
2174 <div class="doc-section">
2175
2176 <p>Use these methods to obtain direct access to the image pixels:</p>
2177
2178 <table class="doc">
2179 <caption>Direct-access to Image Pixels</caption>
2180 <tbody>
2181   <tr>
2182     <th>Method</th>
2183     <th>Parameters</th>
2184     <th style="width: 50%">Description</th>
2185   </tr>
2186
2187   <tr>
2188     <td valign="top">GetAuthenticPixels</td>
2189     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i></td>
2190     <td valign="top">return image pixels as a C pointer</td>
2191   </tr>
2192
2193   <tr>
2194     <td valign="top">GetVirtualPixels</td>
2195     <td valign="top">geometry=&gt;<i>geometry</i>, width=&gt;<i>integer</i>, height=&gt;<i>integer</i>, x=&gt;<i>integer</i>, y=&gt;<i>integer</i></td>
2196     <td valign="top">return image pixels as a const C pointer</td>
2197   </tr>
2198
2199   <tr>
2200     <td valign="top">GetAuthenticIndexQueue</td>
2201     <td valign="top">return image indexes as a C pointer</td>
2202   </tr>
2203
2204   <tr>
2205     <td valign="top">GetVirtualIndexQueue</td>
2206     <td valign="top">return image indexes as a const C pointer</td>
2207   </tr>
2208
2209   <tr>
2210     <td valign="top">SyncAuthenticPixels</td>
2211     <td valign="top"></td>
2212     <td valign="top">sync image pixels to pixel cache</td>
2213   </tr>
2214
2215 </tbody>
2216 </table>
2217
2218 </div>
2219
2220 <h2><a name="miscellaneous"></a>Miscellaneous Methods</h2>
2221 <div class="doc-section">
2222
2223 <p>The Append() method append a set of images. For example,</p>
2224
2225 <pre class="code">
2226   $p = $image-&gt;Append(stack=&gt;{true,false});
2227 </pre>
2228
2229 <p>appends all the images associated with object <kbd>$image</kbd>. By default, images are stacked left-to-right. Set <kbd>stack</kbd> to True to stack them top-to-bottom.</p>
2230
2231 <p>The Average() method averages a set of images. For example,</p>
2232
2233 <pre class="code">
2234   $p = $image-&gt;Average();
2235 </pre>
2236
2237 <p>averages all the images associated with object <kbd>$image</kbd>.</p>
2238
2239 <p>The Clone() method copies a set of images. For example,</p>
2240
2241 <pre class="code">
2242   $q = $p-&gt;Clone();
2243 </pre>
2244
2245 <p>copies all the images from object <kbd>$p</kbd> to <kbd>$q</kbd>. You can use this method for single or multi-image sequences.</p>
2246
2247 <p>The Flatten() method flattens a set of images and returns it. For example,</p>
2248
2249 <pre class="code">
2250   $p = $images-&gt;Flatten(background=&gt;'none');
2251   $p-&gt;Write('flatten.png');
2252 </pre>
2253
2254 <p>The sequence of images is replaced by a single image created by composing each image after the first over the first image.</p>
2255
2256 <p>The Fx() method applies a mathematical expression to a set of images and returns the results. For example,</p>
2257
2258 <pre class="code">
2259   $p = $image-&gt;Fx(expression=&gt;'(g+b)/2.0',channel=&gt;'red');
2260   $p-&gt;Write('fx.miff');
2261 </pre>
2262
2263 <p>replaces the red channel with the average of the green and blue channels.</p>
2264
2265 <p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this method.</p>
2266
2267 <p>Histogram() returns the unique colors in the image and a count for each one. The returned values are an array of red, green, blue, opacity, and count values.</p>
2268
2269 <p>The Morph() method morphs a set of images. Both the image pixels and size are linearly interpolated to give the appearance of a meta-morphosis from one image to the next:</p>
2270
2271 <pre class="code">
2272   $p = $image-&gt;Morph(frames=&gt;<i>integer</i>);
2273 </pre>
2274
2275 <p>where <i>frames</i> is the number of in-between images to generate.  The default is 1.</p>
2276
2277 <p>Mosaic() creates an mosaic from an image sequence.</p>
2278
2279 <p>Method Mogrify() is a single entry point for the image manipulation methods (<a href="#manipulate">Manipulate an Image</a>). The parameters are the name of a method followed by any parameters the method may require. For example, these calls are equivalent:</p>
2280
2281 <pre class="code">
2282   $image-&gt;Crop('340x256+0+0');
2283   $image-&gt;Mogrify('crop', '340x256+0+0');
2284 </pre>
2285
2286 <p>Method MogrifyRegion() applies a transform to a region of the image. It is similar to Mogrify() but begins with the region geometry. For example, suppose you want to brighten a 100x100 region of your image at location (40, 50):</p>
2287
2288 <pre class="code">
2289   $image-&gt;MogrifyRegion('100x100+40+50', 'modulate', brightness=&gt;50);
2290 </pre>
2291
2292 <p>Ping() is a convenience method that returns information about an image without having to read the image into memory. It returns the width, height, file size in bytes, and the file format of the image. You can specify more than one filename but only one filehandle:</p>
2293
2294 <pre class="code">
2295   ($width, $height, $size, $format) = $image-&gt;Ping('logo.png');
2296   ($width, $height, $size, $format) = $image-&gt;Ping(file=&gt;\*IMAGE);
2297   ($width, $height, $size, $format) = $image-&gt;Ping(blob=&gt;$blob);
2298 </pre>
2299
2300 <p>This a more efficient and less memory intensive way to query if an image exists and what its characteristics are.  <kbd>PreviewImage()</kbd> tiles 9 thumbnails of the specified image with an image processing operation applied at varying strengths. This may be helpful pin-pointing an appropriate parameter for a particular image processing operation. Choose from these operations: <kbd>Rotate, Shear, Roll, Hue, Saturation, Brightness, Gamma, Spiff, Dull, Grayscale, Quantize, Despeckle, ReduceNoise, AddNoise, Sharpen, Blur, Threshold, EdgeDetect, Spread, Solarize, Shade, Raise, Segment, Swirl, Implode, Wave, OilPaint, CharcoalDrawing, JPEG</kbd>. Here is an example:</p>
2301
2302 <pre class="code">
2303   $preview = $image-&gt;Preview('Gamma');
2304   $preview-&gt;Display();
2305 </pre>
2306
2307 <p>To have full control over text positioning you need font metric information. Use</p>
2308
2309 <pre class="code">
2310   ($x_ppem, $y_ppem, $ascender, $descender, $width, $height, $max_advance)
2311          = $image-&gt;QueryFontMetrics(<i>parameters</i>);
2312 </pre>
2313
2314 <p>Where <i>parameters</i> is any parameter of the <a href="#manipulate">Annotate</a> method. The return values are:</p>
2315
2316 <ul>
2317   <li>character width</li>
2318   <li>character height</li>
2319   <li>ascender</li>
2320   <li>descender</li>
2321   <li>text width</li>
2322   <li>text height</li>
2323   <li>maximum horizontal advance</li>
2324   <li>bounds: x1</li>
2325   <li>bounds: y1</li>
2326   <li>bounds: x2</li>
2327   <li>bounds: y2</li>
2328   <li>origin: x</li>
2329   <li>origin: y</li>
2330 </ul>
2331
2332 <p>Use QueryMultilineFontMetrics() to get the maximum text width and height for multiple lines of text.</p>
2333
2334 <p>Call QueryColor() with no parameters to return a list of known colors names or specify one or more color names to get these attributes: red, green, blue, and opacity value.</p>
2335
2336 <pre class="code">
2337   @colors = $image-&gt;QueryColor();
2338   ($red, $green, $blue, $opacity) = $image-&gt;QueryColor('cyan');
2339   ($red, $green, $blue, $opacity) = $image-&gt;QueryColor('#716bae');
2340 </pre>
2341
2342 <p>QueryColorname() accepts a color value and returns its respective name or hex value;</p>
2343
2344 <pre class="code">
2345     $name = $image-&gt;QueryColorname('rgba(80,60,0,0)');
2346 </pre>
2347
2348 <p>Call QueryFont() with no parameters to return a list of known fonts or specify one or more font names to get these attributes: font name, description, family, style, stretch, weight, encoding, foundry, format, metrics, and glyphs values.</p>
2349
2350 <pre class="code">
2351   @fonts = $image-&gt;QueryFont();
2352   $weight = ($image-&gt;QueryFont('Helvetica'))[5];
2353 </pre>
2354
2355 <p>Call QueryFormat() with no parameters to return a list of known image formats or specify one or more format names to get these attributes: adjoin, blob support, raw, decoder, encoder, description, and module.</p>
2356
2357 <pre class="code">
2358   @formats = $image-&gt;QueryFormat();
2359   ($adjoin, $blob_support, $raw, $decoder, $encoder, $description, $module)
2360             = $image-&gt;QueryFormat('gif');
2361 </pre>
2362
2363 <p>Call MagickToMime() with the image format name to get its MIME type such as <kbd>images/tiff</kbd> from <kbd>tif</kbd>.</p>
2364
2365 <pre class="code">
2366   $mime = $image-&gt;MagickToMime('tif');
2367 </pre>
2368
2369 <p>Use RemoteCommand() to send a command to an already running <a href="../www/display.html">display</a> or <a href="../www/animate.html">animate</a> application. The only parameter is the name of the image file to display or animate.</p>
2370
2371 <pre class="code">
2372   $image-&gt;RemoteCommand('image.jpg');
2373 </pre>
2374
2375 <p>Statistics() returns the image statistics for each channel in the image. The returned values are an array of depth, minima, maxima, mean, standard deviation, kurtosis, and skewness values in RGB, CMYK, RGBA, or CMYKA order (depending on the image type).</p>
2376
2377 <pre class="code">
2378   @statistics = $image-&gt;Statistics();
2379 </pre>
2380
2381 <p>Finally, the Transform() method accepts a fully-qualified geometry specification for cropping or resizing one or more images.  For example,</p>
2382
2383 <pre class="code">
2384   $p = $image-&gt;Transform(crop=&gt;'100x100+0+0', gravity=&gt;'Center');
2385 </pre>
2386
2387 <p>You can optionally add <i>Image</i> to any method name above. For example, PingImage() is an alias for method Ping().</p>
2388
2389 </div>
2390
2391 <h2><a name="exceptions"></a>Handling Exceptions</h2>
2392 <div class="doc-section">
2393
2394 <p>All PerlMagick methods return an undefined string context upon success. If any problems occur, the error is returned as a string with an embedded numeric status code. A status code less than 400 is a warning. This means that the operation did not complete but was recoverable to some degree. A numeric code greater or equal to 400 is an error and indicates the operation failed completely. Here is how exceptions are returned for the different methods:</p>
2395
2396 <p>Methods which return a number (e.g. Read(), Write()):</p>
2397
2398 <pre class="code">
2399   $x = $image-&gt;Read(...);
2400   warn "$x" if "$x";      # print the error message
2401   $x =~ /(\d+)/;
2402   print $1;               # print the error number
2403   print 0+$x;             # print the number of images read
2404 </pre>
2405
2406 <p>Methods which operate on an image (e.g. Resize(), Crop()):</p>
2407
2408 <pre class="code">
2409   $x = $image-&gt;Crop(...);
2410   warn "$x" if "$x";      # print the error message
2411   $x =~ /(\d+)/;
2412   print $1;               # print the error number
2413 </pre>
2414
2415 <p>Methods which return images (Average(), Montage(), Clone()) should be checked for errors this way:</p>
2416
2417 <pre class="code">
2418   $x = $image-&gt;Montage(...);
2419   warn "$x" if !ref($x);  # print the error message
2420   $x =~ /(\d+)/;
2421   print $1;               # print the error number
2422 </pre>
2423
2424 <p>Here is an example error message:</p>
2425
2426 <pre class="code">
2427   Error 400: Memory allocation failed
2428 </pre>
2429
2430 <p>Review the complete list of <a href="../www/exception.html">error and warning codes</a>.</p>
2431
2432 <p>The following illustrates how you can use a numeric status code:</p>
2433
2434 <pre class="code">
2435   $x = $image-&gt;Read('rose.png');
2436   $x =~ /(\d+)/;
2437   die "unable to continue" if ($1 == ResourceLimitError);
2438 </pre>
2439
2440 </div>
2441
2442 <h2><a name="constants"></a>Constants</h2>
2443 <div class="doc-section">
2444
2445 <p>PerlMagick includes these constants:</p>
2446
2447 <pre class="text">
2448   BlobError
2449   BlobWarning
2450   CacheError
2451   CacheWarning
2452   CoderError
2453   CoderWarning
2454   ConfigureError
2455   ConfigureWarning
2456   CorruptImageError
2457   CorruptImageWarning
2458   DelegateError
2459   DelegateWarning
2460   DrawError
2461   DrawWarning
2462   ErrorException
2463   FatalErrorException
2464   FileOpenError
2465   FileOpenWarning
2466   ImageError
2467   ImageWarning
2468   MissingDelegateError
2469   MissingDelegateWarning
2470   ModuleError
2471   ModuleWarning
2472   Opaque
2473   OptionError
2474   OptionWarning
2475   QuantumDepth
2476   QuantumRange
2477   RegistryError
2478   RegistryWarning
2479   ResourceLimitError
2480   ResourceLimitWarning
2481   StreamError
2482   StreamWarning
2483   Success
2484   Transparent
2485   TypeError
2486   TypeWarning
2487   WarningException
2488   XServerError
2489   XServerWarning
2490 </pre>
2491
2492 <p>You can access them like this:</p>
2493
2494 <pre class="code">
2495   Image::Magick-&gt;QuantumDepth
2496 </pre>
2497
2498 </div>
2499 \r
2500 </div>\r
2501 \r
2502 <div id="linkbar">\r
2503  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
2504     <span id="linkbar-center">\r
2505       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
2506       <a href="../www/mailing-list.html">Mailing Lists</a> &bull;\r
2507     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
2508     </span>\r
2509     <span id="linkbar-east">&nbsp;</span>\r
2510   </div>\r
2511   <div class="footer">\r
2512     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
2513     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
2514   </div>\r
2515   <div style="clear: both; margin: 0; width: 100%; "></div>\r
2516 </body>\r
2517 </html>\r