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