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