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