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