Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / b52981c56e906a958920792461cb15d707fbf8da / . / www / api / effect.html
blob: 4e98632b85d424a9fb84cc0a6e42d513a801d2da [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]3<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]8<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickCore, C API for ImageMagick: Add an Effect</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]15 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]16 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]18 <meta name="Generator" content="PHP"/>
19 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, add, an, effect, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]20 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]31 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]32 <style type="text/css" media="all">
33 @import url("../../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]35 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]36 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]48</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame^]52<div style="margin: 17px auto; float: left;">
53 <script type="text/javascript">
54 <!--
55 google_ad_client = "pub-3129977114552745";
56 google_ad_slot = "5439289906";
57 google_ad_width = 728;
58 google_ad_height = 90;
59 //-->
60 </script>
61 <script type="text/javascript"
62 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
63 </script>
64</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]66 <img src="../../images/logo.jpg"
67 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]68 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]70 <img src="../../images/sprite.jpg"
71 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]72 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
73</div>
74
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]75<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]76
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]77<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]78 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]82 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
83</div>
84<div class="sub">
85 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
89</div>
90<div class="sub">
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]91 <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
92</div>
93<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]94 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
95</div>
96<div class="sep"></div>
97<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]98 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]99</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]101 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]102</div>
103<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]104 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]105</div>
106<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]107 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]108</div>
109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]122 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
128<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]129 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
131<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]132 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133 </div>
134<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]135 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]137<div class="menu">
138 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
139</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]141 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]143<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]145 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]149 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]152 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]153</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]154<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]156 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame^]158<a href="http://www.networkredux.com">
159 <img src="../../images/networkredux.png" alt="[sponsor]"
160 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]162<div class="sponsor">
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]163 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
164</div>
165<div class="sponsor">
cristybe3c5be2011-03-05 17:35:07 +0000[diff] [blame]166 <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
167</div>
168<div class="sponsor">
169 <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201106010090 alexanian media -->
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]170</div>
171<div class="sponsor">
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]172 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]173</div>
174<div class="sponsor">
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]175 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
176</div>
177<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]178 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
179</div>
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]180<div class="sponsor">
181 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
182</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]183<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]184 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
185</div>
186<div class="sponsor">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame^]187 <a title="Sponsor: Custom T-Shirts" href="http://www.ooshirts.com">Custom T-Shirts</a><!-- 2011050100030 ooshirts.com-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]188</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]189</div>
190</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]191</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]192
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]193<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame^]194
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]195</div>
196
197<div class="main">
198
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]199<h1>Module effect Methods</h1>
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame^]200<p class="navigation-index">[<a href="#AdaptiveBlurImage">AdaptiveBlurImage</a> &bull; <a href="#AdaptiveSharpenImage">AdaptiveSharpenImage</a> &bull; <a href="#BlurImage">BlurImage</a> &bull; <a href="#ConvolveImage">ConvolveImage</a> &bull; <a href="#DespeckleImage">DespeckleImage</a> &bull; <a href="#EdgeImage">EdgeImage</a> &bull; <a href="#EmbossImage">EmbossImage</a> &bull; <a href="#FilterImage">FilterImage</a> &bull; <a href="#GaussianBlurImage">GaussianBlurImage</a> &bull; <a href="#MotionBlurImage">MotionBlurImage</a> &bull; <a href="#PreviewImage">PreviewImage</a> &bull; <a href="#RadialBlurImage">RadialBlurImage</a> &bull; <a href="#SelectiveBlurImage">SelectiveBlurImage</a> &bull; <a href="#ShadeImage">ShadeImage</a> &bull; <a href="#SharpenImage">SharpenImage</a> &bull; <a href="#SpreadImage">SpreadImage</a> &bull; <a href="#StatisticImage">StatisticImage</a> &bull; <a href="#UnsharpMaskImage">UnsharpMaskImage</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]201
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]202<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="AdaptiveBlurImage">AdaptiveBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]203<div class="doc-section">
204
205<p>AdaptiveBlurImage() adaptively blurs the image by blurring less intensely near image edges and more intensely far from edges. We blur the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and AdaptiveBlurImage() selects a suitable radius for you.</p>
206
207<p>The format of the AdaptiveBlurImage method is:</p>
208
209<pre class="code">
210 Image *AdaptiveBlurImage(const Image *image,const double radius,
211 const double sigma,ExceptionInfo *exception)
212 Image *AdaptiveBlurImageChannel(const Image *image,
213 const ChannelType channel,double radius,const double sigma,
214 ExceptionInfo *exception)
215</pre>
216
217<p>A description of each parameter follows:</p>
218
219<h5>image</h5>
220<p>the image.</p>
221
222<h5>channel</h5>
223<p>the channel type.</p>
224
225<h5>radius</h5>
226<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
227
228<h5>sigma</h5>
229<p>the standard deviation of the Laplacian, in pixels.</p>
230
231<h5>exception</h5>
232<p>return any errors or warnings in this structure.</p>
233
234 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]235<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="AdaptiveSharpenImage">AdaptiveSharpenImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]236<div class="doc-section">
237
238<p>AdaptiveSharpenImage() adaptively sharpens the image by sharpening more intensely near image edges and less intensely far from edges. We sharpen the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and AdaptiveSharpenImage() selects a suitable radius for you.</p>
239
240<p>The format of the AdaptiveSharpenImage method is:</p>
241
242<pre class="code">
243 Image *AdaptiveSharpenImage(const Image *image,const double radius,
244 const double sigma,ExceptionInfo *exception)
245 Image *AdaptiveSharpenImageChannel(const Image *image,
246 const ChannelType channel,double radius,const double sigma,
247 ExceptionInfo *exception)
248</pre>
249
250<p>A description of each parameter follows:</p>
251
252<h5>image</h5>
253<p>the image.</p>
254
255<h5>channel</h5>
256<p>the channel type.</p>
257
258<h5>radius</h5>
259<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
260
261<h5>sigma</h5>
262<p>the standard deviation of the Laplacian, in pixels.</p>
263
264<h5>exception</h5>
265<p>return any errors or warnings in this structure.</p>
266
267 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]268<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="BlurImage">BlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]269<div class="doc-section">
270
271<p>BlurImage() blurs an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and BlurImage() selects a suitable radius for you.</p>
272
273<p>BlurImage() differs from GaussianBlurImage() in that it uses a separable kernel which is faster but mathematically equivalent to the non-separable kernel.</p>
274
275<p>The format of the BlurImage method is:</p>
276
277<pre class="code">
278 Image *BlurImage(const Image *image,const double radius,
279 const double sigma,ExceptionInfo *exception)
280 Image *BlurImageChannel(const Image *image,const ChannelType channel,
281 const double radius,const double sigma,ExceptionInfo *exception)
282</pre>
283
284<p>A description of each parameter follows:</p>
285
286<h5>image</h5>
287<p>the image.</p>
288
289<h5>channel</h5>
290<p>the channel type.</p>
291
292<h5>radius</h5>
293<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
294
295<h5>sigma</h5>
296<p>the standard deviation of the Gaussian, in pixels.</p>
297
298<h5>exception</h5>
299<p>return any errors or warnings in this structure.</p>
300
301 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]302<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="ConvolveImage">ConvolveImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]303<div class="doc-section">
304
305<p>ConvolveImage() applies a custom convolution kernel to the image.</p>
306
307<p>The format of the ConvolveImage method is:</p>
308
309<pre class="code">
310 Image *ConvolveImage(const Image *image,const size_t order,
311 const double *kernel,ExceptionInfo *exception)
312 Image *ConvolveImageChannel(const Image *image,const ChannelType channel,
313 const size_t order,const double *kernel,ExceptionInfo *exception)
314</pre>
315
316<p>A description of each parameter follows:</p>
317
318<h5>image</h5>
319<p>the image.</p>
320
321<h5>channel</h5>
322<p>the channel type.</p>
323
324<h5>order</h5>
325<p>the number of columns and rows in the filter kernel.</p>
326
327<h5>kernel</h5>
328<p>An array of double representing the convolution kernel.</p>
329
330<h5>exception</h5>
331<p>return any errors or warnings in this structure.</p>
332
333 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]334<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="DespeckleImage">DespeckleImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]335<div class="doc-section">
336
337<p>DespeckleImage() reduces the speckle noise in an image while perserving the edges of the original image.</p>
338
339<p>The format of the DespeckleImage method is:</p>
340
341<pre class="code">
342 Image *DespeckleImage(const Image *image,ExceptionInfo *exception)
343</pre>
344
345<p>A description of each parameter follows:</p>
346
347<h5>image</h5>
348<p>the image.</p>
349
350<h5>exception</h5>
351<p>return any errors or warnings in this structure.</p>
352
353 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]354<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="EdgeImage">EdgeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]355<div class="doc-section">
356
357<p>EdgeImage() finds edges in an image. Radius defines the radius of the convolution filter. Use a radius of 0 and EdgeImage() selects a suitable radius for you.</p>
358
359<p>The format of the EdgeImage method is:</p>
360
361<pre class="code">
362 Image *EdgeImage(const Image *image,const double radius,
363 ExceptionInfo *exception)
364</pre>
365
366<p>A description of each parameter follows:</p>
367
368<h5>image</h5>
369<p>the image.</p>
370
371<h5>radius</h5>
372<p>the radius of the pixel neighborhood.</p>
373
374<h5>exception</h5>
375<p>return any errors or warnings in this structure.</p>
376
377 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]378<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="EmbossImage">EmbossImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]379<div class="doc-section">
380
381<p>EmbossImage() returns a grayscale image with a three-dimensional effect. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and Emboss() selects a suitable radius for you.</p>
382
383<p>The format of the EmbossImage method is:</p>
384
385<pre class="code">
386 Image *EmbossImage(const Image *image,const double radius,
387 const double sigma,ExceptionInfo *exception)
388</pre>
389
390<p>A description of each parameter follows:</p>
391
392<h5>image</h5>
393<p>the image.</p>
394
395<h5>radius</h5>
396<p>the radius of the pixel neighborhood.</p>
397
398<h5>sigma</h5>
399<p>the standard deviation of the Gaussian, in pixels.</p>
400
401<h5>exception</h5>
402<p>return any errors or warnings in this structure.</p>
403
404 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]405<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="FilterImage">FilterImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]406<div class="doc-section">
407
408<p>FilterImage() applies a custom convolution kernel to the image.</p>
409
410<p>The format of the FilterImage method is:</p>
411
412<pre class="code">
413 Image *FilterImage(const Image *image,const KernelInfo *kernel,
414 ExceptionInfo *exception)
415 Image *FilterImageChannel(const Image *image,const ChannelType channel,
416 const KernelInfo *kernel,ExceptionInfo *exception)
417</pre>
418
419<p>A description of each parameter follows:</p>
420
421<h5>image</h5>
422<p>the image.</p>
423
424<h5>channel</h5>
425<p>the channel type.</p>
426
427<h5>kernel</h5>
428<p>the filtering kernel.</p>
429
430<h5>exception</h5>
431<p>return any errors or warnings in this structure.</p>
432
433 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]434<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="GaussianBlurImage">GaussianBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]435<div class="doc-section">
436
437<p>GaussianBlurImage() blurs an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and GaussianBlurImage() selects a suitable radius for you</p>
438
439<p>The format of the GaussianBlurImage method is:</p>
440
441<pre class="code">
442 Image *GaussianBlurImage(const Image *image,onst double radius,
443 const double sigma,ExceptionInfo *exception)
444 Image *GaussianBlurImageChannel(const Image *image,
445 const ChannelType channel,const double radius,const double sigma,
446 ExceptionInfo *exception)
447</pre>
448
449<p>A description of each parameter follows:</p>
450
451<h5>image</h5>
452<p>the image.</p>
453
454<h5>channel</h5>
455<p>the channel type.</p>
456
457<h5>radius</h5>
458<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
459
460<h5>sigma</h5>
461<p>the standard deviation of the Gaussian, in pixels.</p>
462
463<h5>exception</h5>
464<p>return any errors or warnings in this structure.</p>
465
466 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]467<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="MotionBlurImage">MotionBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]468<div class="doc-section">
469
470<p>MotionBlurImage() simulates motion blur. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and MotionBlurImage() selects a suitable radius for you. Angle gives the angle of the blurring motion.</p>
471
472<p>Andrew Protano contributed this effect.</p>
473
474<p>The format of the MotionBlurImage method is:</p>
475
476<pre class="code">
477 Image *MotionBlurImage(const Image *image,const double radius,
478 const double sigma,const double angle,ExceptionInfo *exception)
479 Image *MotionBlurImageChannel(const Image *image,const ChannelType channel,
480 const double radius,const double sigma,const double angle,
481 ExceptionInfo *exception)
482</pre>
483
484<p>A description of each parameter follows:</p>
485
486<h5>image</h5>
487<p>the image.</p>
488
489<h5>channel</h5>
490<p>the channel type.</p>
491
492<h5>radius</h5>
493<p>the radius of the Gaussian, in pixels, not counting the center</p>
494<h5>radius</h5>
495<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
496
497<h5>sigma</h5>
498<p>the standard deviation of the Gaussian, in pixels.</p>
499
500<h5>angle</h5>
501<p>Apply the effect along this angle.</p>
502
503<h5>exception</h5>
504<p>return any errors or warnings in this structure.</p>
505
506 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]507<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="PreviewImage">PreviewImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]508<div class="doc-section">
509
510<p>PreviewImage() tiles 9 thumbnails of the specified image with an image processing operation applied with varying parameters. This may be helpful pin-pointing an appropriate parameter for a particular image processing operation.</p>
511
512<p>The format of the PreviewImages method is:</p>
513
514<pre class="code">
515 Image *PreviewImages(const Image *image,const PreviewType preview,
516 ExceptionInfo *exception)
517</pre>
518
519<p>A description of each parameter follows:</p>
520
521<h5>image</h5>
522<p>the image.</p>
523
524<h5>preview</h5>
525<p>the image processing operation.</p>
526
527<h5>exception</h5>
528<p>return any errors or warnings in this structure.</p>
529
530 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]531<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="RadialBlurImage">RadialBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]532<div class="doc-section">
533
534<p>RadialBlurImage() applies a radial blur to the image.</p>
535
536<p>Andrew Protano contributed this effect.</p>
537
538<p>The format of the RadialBlurImage method is:</p>
539
540<pre class="code">
541 Image *RadialBlurImage(const Image *image,const double angle,
542 ExceptionInfo *exception)
543 Image *RadialBlurImageChannel(const Image *image,const ChannelType channel,
544 const double angle,ExceptionInfo *exception)
545</pre>
546
547<p>A description of each parameter follows:</p>
548
549<h5>image</h5>
550<p>the image.</p>
551
552<h5>channel</h5>
553<p>the channel type.</p>
554
555<h5>angle</h5>
556<p>the angle of the radial blur.</p>
557
558<h5>exception</h5>
559<p>return any errors or warnings in this structure.</p>
560
561 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]562<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="SelectiveBlurImage">SelectiveBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]563<div class="doc-section">
564
565<p>SelectiveBlurImage() selectively blur pixels within a contrast threshold. It is similar to the unsharpen mask that sharpens everything with contrast above a certain threshold.</p>
566
567<p>The format of the SelectiveBlurImage method is:</p>
568
569<pre class="code">
570 Image *SelectiveBlurImage(const Image *image,const double radius,
571 const double sigma,const double threshold,ExceptionInfo *exception)
572 Image *SelectiveBlurImageChannel(const Image *image,
573 const ChannelType channel,const double radius,const double sigma,
574 const double threshold,ExceptionInfo *exception)
575</pre>
576
577<p>A description of each parameter follows:</p>
578
579<h5>image</h5>
580<p>the image.</p>
581
582<h5>channel</h5>
583<p>the channel type.</p>
584
585<h5>radius</h5>
586<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
587
588<h5>sigma</h5>
589<p>the standard deviation of the Gaussian, in pixels.</p>
590
591<h5>threshold</h5>
592<p>only pixels within this contrast threshold are included in the blur operation.</p>
593
594<h5>exception</h5>
595<p>return any errors or warnings in this structure.</p>
596
597 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]598<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="ShadeImage">ShadeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]599<div class="doc-section">
600
601<p>ShadeImage() shines a distant light on an image to create a three-dimensional effect. You control the positioning of the light with azimuth and elevation; azimuth is measured in degrees off the x axis and elevation is measured in pixels above the Z axis.</p>
602
603<p>The format of the ShadeImage method is:</p>
604
605<pre class="code">
606 Image *ShadeImage(const Image *image,const MagickBooleanType gray,
607 const double azimuth,const double elevation,ExceptionInfo *exception)
608</pre>
609
610<p>A description of each parameter follows:</p>
611
612<h5>image</h5>
613<p>the image.</p>
614
615<h5>gray</h5>
616<p>A value other than zero shades the intensity of each pixel.</p>
617
618<h5>azimuth, elevation</h5>
619<p>Define the light source direction.</p>
620
621<h5>exception</h5>
622<p>return any errors or warnings in this structure.</p>
623
624 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]625<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="SharpenImage">SharpenImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]626<div class="doc-section">
627
628<p>SharpenImage() sharpens the image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and SharpenImage() selects a suitable radius for you.</p>
629
630<p>Using a separable kernel would be faster, but the negative weights cancel out on the corners of the kernel producing often undesirable ringing in the filtered result; this can be avoided by using a 2D gaussian shaped image sharpening kernel instead.</p>
631
632<p>The format of the SharpenImage method is:</p>
633
634<pre class="code">
635 Image *SharpenImage(const Image *image,const double radius,
636 const double sigma,ExceptionInfo *exception)
637 Image *SharpenImageChannel(const Image *image,const ChannelType channel,
638 const double radius,const double sigma,ExceptionInfo *exception)
639</pre>
640
641<p>A description of each parameter follows:</p>
642
643<h5>image</h5>
644<p>the image.</p>
645
646<h5>channel</h5>
647<p>the channel type.</p>
648
649<h5>radius</h5>
650<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
651
652<h5>sigma</h5>
653<p>the standard deviation of the Laplacian, in pixels.</p>
654
655<h5>exception</h5>
656<p>return any errors or warnings in this structure.</p>
657
658 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]659<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="SpreadImage">SpreadImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]660<div class="doc-section">
661
662<p>SpreadImage() is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.</p>
663
664<p>The format of the SpreadImage method is:</p>
665
666<pre class="code">
667 Image *SpreadImage(const Image *image,const double radius,
668 ExceptionInfo *exception)
669</pre>
670
671<p>A description of each parameter follows:</p>
672
673<h5>image</h5>
674<p>the image.</p>
675
676<h5>radius</h5>
677<p>Choose a random pixel in a neighborhood of this extent.</p>
678
679<h5>exception</h5>
680<p>return any errors or warnings in this structure.</p>
681
682 </div>
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame^]683<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="StatisticImage">StatisticImage</a></h2>
684<div class="doc-section">
685
686<p>StatisticImage() makes each pixel the min / max / median / mode / etc. of the neighborhood of the specified width and height.</p>
687
688<p>The format of the StatisticImage method is:</p>
689
690<pre class="code">
691 Image *StatisticImage(const Image *image,const StatisticType type,
692 const size_t width,const size_t height,ExceptionInfo *exception)
693 Image *StatisticImageChannel(const Image *image,
694 const ChannelType channel,const StatisticType type,
695 const size_t width,const size_t height,ExceptionInfo *exception)
696</pre>
697
698<p>A description of each parameter follows:</p>
699
700<h5>image</h5>
701<p>the image.</p>
702
703<h5>channel</h5>
704<p>the image channel.</p>
705
706<h5>type</h5>
707<p>the statistic type (median, mode, etc.).</p>
708
709<h5>width</h5>
710<p>the width of the pixel neighborhood.</p>
711
712<h5>height</h5>
713<p>the height of the pixel neighborhood.</p>
714
715<h5>exception</h5>
716<p>return any errors or warnings in this structure.</p>
717
718 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]719<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="UnsharpMaskImage">UnsharpMaskImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]720<div class="doc-section">
721
722<p>UnsharpMaskImage() sharpens one or more image channels. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and UnsharpMaskImage() selects a suitable radius for you.</p>
723
724<p>The format of the UnsharpMaskImage method is:</p>
725
726<pre class="code">
727 Image *UnsharpMaskImage(const Image *image,const double radius,
728 const double sigma,const double amount,const double threshold,
729 ExceptionInfo *exception)
730 Image *UnsharpMaskImageChannel(const Image *image,
731 const ChannelType channel,const double radius,const double sigma,
732 const double amount,const double threshold,ExceptionInfo *exception)
733</pre>
734
735<p>A description of each parameter follows:</p>
736
737<h5>image</h5>
738<p>the image.</p>
739
740<h5>channel</h5>
741<p>the channel type.</p>
742
743<h5>radius</h5>
744<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
745
746<h5>sigma</h5>
747<p>the standard deviation of the Gaussian, in pixels.</p>
748
749<h5>amount</h5>
750<p>the percentage of the difference between the original and the blur image that is added back into the original.</p>
751
752<h5>threshold</h5>
753<p>the threshold in pixels needed to apply the diffence amount.</p>
754
755<h5>exception</h5>
756<p>return any errors or warnings in this structure.</p>
757
758 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]759
760</div>
761
762<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]763 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]764 <span id="linkbar-center">
765 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]766 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]767 </span>
768 <span id="linkbar-east">&nbsp;</span>
769 </div>
770 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]771 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]772 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
773 </div>
774 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]775 <script type="text/javascript">
776 var _gaq = _gaq || [];
777 _gaq.push(['_setAccount', 'UA-17690367-1']);
778 _gaq.push(['_trackPageview']);
779
780 (function() {
781 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
782 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
783 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
784 })();
785 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]786</body>
787</html>