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