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