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

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