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