granicus.if.org Git - imagemagick/blob - www/perl-magick.html

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