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