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