Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ee742644b96b10e661554b1c1625e258d0ef7eb5 / . / www / api / effect.html
blob: bd9d95a0be50d2eda4c11210f7b451a71422d935 [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">
52<a href="../../index.html">
53 <img src="../../images/script.png" alt="[ImageMagick]"
54 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
55<a href="http://www.networkredux.com">
56 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]57 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]58<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]59 <img src="../../images/logo.jpg"
60 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]61 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]62<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]63 <img src="../../images/sprite.jpg"
64 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
66</div>
67
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]68<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]70<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]73<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]74<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]75 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
79</div>
80<div class="sub">
81 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
82</div>
83<div class="sub">
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]84 <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
85</div>
86<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]87 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
88</div>
89<div class="sep"></div>
90<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]106 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
108<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]109 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110</div>
111<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
114<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]115 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]122 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
124<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126 </div>
127<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]128 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]129</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]130<div class="menu">
131 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
132</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]134 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]135</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]136<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]138 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]140<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]142 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
144<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]145 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]149 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150
151<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]152<div class="sponsor">
cristyee742642011-02-26 02:49:59 +0000[diff] [blame^]153 <a title="Sponsor: Website Hosting" href="http://hostreviewgeeks.com">Website Hosting</a><!-- 201106010090 alexanian media -->
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]154</div>
155<div class="sponsor">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]156 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]157</div>
cristyee742642011-02-26 02:49:59 +0000[diff] [blame^]158<div class="sponsor">
159 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]160</div>
161<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]162 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
163</div>
164<div class="sponsor">
cristyee742642011-02-26 02:49:59 +0000[diff] [blame^]165 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
166</div>
167<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]168 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
169</div>
cristyee742642011-02-26 02:49:59 +0000[diff] [blame^]170<div class="sponsor">
171 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
172</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]173<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]174 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
175</div>
176<div class="sponsor">
cristyee742642011-02-26 02:49:59 +0000[diff] [blame^]177 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]178</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]179</div>
180</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]181</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]182
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]183<div class="eastbar">
184 <script type="text/javascript">
185 <!--
186 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]187 google_ad_slot = "0574824969";
188 google_ad_width = 160;
189 google_ad_height = 600;
190 //-->
191 </script>
192 <script type="text/javascript"
193 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
194 </script>
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>
cristy6f77f692011-02-15 15:31:39 +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="#MedianFilterImage">MedianFilterImage</a> &bull; <a href="#MotionBlurImage">MotionBlurImage</a> &bull; <a href="#PreviewImage">PreviewImage</a> &bull; <a href="#RadialBlurImage">RadialBlurImage</a> &bull; <a href="#ReduceNoiseImage">ReduceNoiseImage</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="#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="MedianFilterImage">MedianFilterImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]468<div class="doc-section">
469
470<p>MedianFilterImage() applies a digital filter that improves the quality of a noisy image. Each pixel is replaced by the median in a set of neighboring pixels as defined by radius.</p>
471
472<p>The algorithm was contributed by Mike Edmonds and implements an insertion sort for selecting median color-channel values. For more on this algorithm see "Skip Lists: A probabilistic Alternative to Balanced Trees" by William Pugh in the June 1990 of Communications of the ACM.</p>
473
474<p>The format of the MedianFilterImage method is:</p>
475
476<pre class="code">
477 Image *MedianFilterImage(const Image *image,const double radius,
478 ExceptionInfo *exception)
479</pre>
480
481<p>A description of each parameter follows:</p>
482
483<h5>image</h5>
484<p>the image.</p>
485
486<h5>radius</h5>
487<p>the radius of the pixel neighborhood.</p>
488
489<h5>exception</h5>
490<p>return any errors or warnings in this structure.</p>
491
492 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]493<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]494<div class="doc-section">
495
496<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>
497
498<p>Andrew Protano contributed this effect.</p>
499
500<p>The format of the MotionBlurImage method is:</p>
501
502<pre class="code">
503 Image *MotionBlurImage(const Image *image,const double radius,
504 const double sigma,const double angle,ExceptionInfo *exception)
505 Image *MotionBlurImageChannel(const Image *image,const ChannelType channel,
506 const double radius,const double sigma,const double angle,
507 ExceptionInfo *exception)
508</pre>
509
510<p>A description of each parameter follows:</p>
511
512<h5>image</h5>
513<p>the image.</p>
514
515<h5>channel</h5>
516<p>the channel type.</p>
517
518<h5>radius</h5>
519<p>the radius of the Gaussian, in pixels, not counting the center</p>
520<h5>radius</h5>
521<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
522
523<h5>sigma</h5>
524<p>the standard deviation of the Gaussian, in pixels.</p>
525
526<h5>angle</h5>
527<p>Apply the effect along this angle.</p>
528
529<h5>exception</h5>
530<p>return any errors or warnings in this structure.</p>
531
532 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]533<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]534<div class="doc-section">
535
536<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>
537
538<p>The format of the PreviewImages method is:</p>
539
540<pre class="code">
541 Image *PreviewImages(const Image *image,const PreviewType preview,
542 ExceptionInfo *exception)
543</pre>
544
545<p>A description of each parameter follows:</p>
546
547<h5>image</h5>
548<p>the image.</p>
549
550<h5>preview</h5>
551<p>the image processing operation.</p>
552
553<h5>exception</h5>
554<p>return any errors or warnings in this structure.</p>
555
556 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]557<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]558<div class="doc-section">
559
560<p>RadialBlurImage() applies a radial blur to the image.</p>
561
562<p>Andrew Protano contributed this effect.</p>
563
564<p>The format of the RadialBlurImage method is:</p>
565
566<pre class="code">
567 Image *RadialBlurImage(const Image *image,const double angle,
568 ExceptionInfo *exception)
569 Image *RadialBlurImageChannel(const Image *image,const ChannelType channel,
570 const double angle,ExceptionInfo *exception)
571</pre>
572
573<p>A description of each parameter follows:</p>
574
575<h5>image</h5>
576<p>the image.</p>
577
578<h5>channel</h5>
579<p>the channel type.</p>
580
581<h5>angle</h5>
582<p>the angle of the radial blur.</p>
583
584<h5>exception</h5>
585<p>return any errors or warnings in this structure.</p>
586
587 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]588<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="ReduceNoiseImage">ReduceNoiseImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]589<div class="doc-section">
590
591<p>ReduceNoiseImage() smooths the contours of an image while still preserving edge information. The algorithm works by replacing each pixel with its neighbor closest in value. A neighbor is defined by radius. Use a radius of 0 and ReduceNoise() selects a suitable radius for you.</p>
592
593<p>The format of the ReduceNoiseImage method is:</p>
594
595<pre class="code">
596 Image *ReduceNoiseImage(const Image *image,const double radius,
597 ExceptionInfo *exception)
598</pre>
599
600<p>A description of each parameter follows:</p>
601
602<h5>image</h5>
603<p>the image.</p>
604
605<h5>radius</h5>
606<p>the radius of the pixel neighborhood.</p>
607
608<h5>exception</h5>
609<p>return any errors or warnings in this structure.</p>
610
611 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]612<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]613<div class="doc-section">
614
615<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>
616
617<p>The format of the SelectiveBlurImage method is:</p>
618
619<pre class="code">
620 Image *SelectiveBlurImage(const Image *image,const double radius,
621 const double sigma,const double threshold,ExceptionInfo *exception)
622 Image *SelectiveBlurImageChannel(const Image *image,
623 const ChannelType channel,const double radius,const double sigma,
624 const double threshold,ExceptionInfo *exception)
625</pre>
626
627<p>A description of each parameter follows:</p>
628
629<h5>image</h5>
630<p>the image.</p>
631
632<h5>channel</h5>
633<p>the channel type.</p>
634
635<h5>radius</h5>
636<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
637
638<h5>sigma</h5>
639<p>the standard deviation of the Gaussian, in pixels.</p>
640
641<h5>threshold</h5>
642<p>only pixels within this contrast threshold are included in the blur operation.</p>
643
644<h5>exception</h5>
645<p>return any errors or warnings in this structure.</p>
646
647 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]648<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]649<div class="doc-section">
650
651<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>
652
653<p>The format of the ShadeImage method is:</p>
654
655<pre class="code">
656 Image *ShadeImage(const Image *image,const MagickBooleanType gray,
657 const double azimuth,const double elevation,ExceptionInfo *exception)
658</pre>
659
660<p>A description of each parameter follows:</p>
661
662<h5>image</h5>
663<p>the image.</p>
664
665<h5>gray</h5>
666<p>A value other than zero shades the intensity of each pixel.</p>
667
668<h5>azimuth, elevation</h5>
669<p>Define the light source direction.</p>
670
671<h5>exception</h5>
672<p>return any errors or warnings in this structure.</p>
673
674 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]675<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]676<div class="doc-section">
677
678<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>
679
680<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>
681
682<p>The format of the SharpenImage method is:</p>
683
684<pre class="code">
685 Image *SharpenImage(const Image *image,const double radius,
686 const double sigma,ExceptionInfo *exception)
687 Image *SharpenImageChannel(const Image *image,const ChannelType channel,
688 const double radius,const double sigma,ExceptionInfo *exception)
689</pre>
690
691<p>A description of each parameter follows:</p>
692
693<h5>image</h5>
694<p>the image.</p>
695
696<h5>channel</h5>
697<p>the channel type.</p>
698
699<h5>radius</h5>
700<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
701
702<h5>sigma</h5>
703<p>the standard deviation of the Laplacian, in pixels.</p>
704
705<h5>exception</h5>
706<p>return any errors or warnings in this structure.</p>
707
708 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]709<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]710<div class="doc-section">
711
712<p>SpreadImage() is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.</p>
713
714<p>The format of the SpreadImage method is:</p>
715
716<pre class="code">
717 Image *SpreadImage(const Image *image,const double radius,
718 ExceptionInfo *exception)
719</pre>
720
721<p>A description of each parameter follows:</p>
722
723<h5>image</h5>
724<p>the image.</p>
725
726<h5>radius</h5>
727<p>Choose a random pixel in a neighborhood of this extent.</p>
728
729<h5>exception</h5>
730<p>return any errors or warnings in this structure.</p>
731
732 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]733<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]734<div class="doc-section">
735
736<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>
737
738<p>The format of the UnsharpMaskImage method is:</p>
739
740<pre class="code">
741 Image *UnsharpMaskImage(const Image *image,const double radius,
742 const double sigma,const double amount,const double threshold,
743 ExceptionInfo *exception)
744 Image *UnsharpMaskImageChannel(const Image *image,
745 const ChannelType channel,const double radius,const double sigma,
746 const double amount,const double threshold,ExceptionInfo *exception)
747</pre>
748
749<p>A description of each parameter follows:</p>
750
751<h5>image</h5>
752<p>the image.</p>
753
754<h5>channel</h5>
755<p>the channel type.</p>
756
757<h5>radius</h5>
758<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
759
760<h5>sigma</h5>
761<p>the standard deviation of the Gaussian, in pixels.</p>
762
763<h5>amount</h5>
764<p>the percentage of the difference between the original and the blur image that is added back into the original.</p>
765
766<h5>threshold</h5>
767<p>the threshold in pixels needed to apply the diffence amount.</p>
768
769<h5>exception</h5>
770<p>return any errors or warnings in this structure.</p>
771
772 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]773
774</div>
775
776<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]777 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]778 <span id="linkbar-center">
779 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]780 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]781 </span>
782 <span id="linkbar-east">&nbsp;</span>
783 </div>
784 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]785 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]786 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
787 </div>
788 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]789 <script type="text/javascript">
790 var _gaq = _gaq || [];
791 _gaq.push(['_setAccount', 'UA-17690367-1']);
792 _gaq.push(['_trackPageview']);
793
794 (function() {
795 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
796 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
797 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
798 })();
799 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]800</body>
801</html>