Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 6f77f6996510a6f454a688320ba2095c1df56b82 / . / www / api / effect.html
blob: 0c6a026a7cd4b1904a2cf697343c87681b29e730 [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">
84 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
85</div>
86<div class="sep"></div>
87<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</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: Options" href="../../www/command-line-options.html">Options</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: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</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: MagickCore" href="../../www/magick-core.html">MagickCore</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: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110</div>
111<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]112 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Install from Source" href="../../www/install-source.html">Install from Source</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="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</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: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123 </div>
124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]127<div class="menu">
128 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
129</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]131 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]135 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]137<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]138<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]139 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140</div>
141<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]142 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]146 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147
148<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]149<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]150 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
151</div>
152<div class="sponsor">
153 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
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>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]158<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]159 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
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">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]165 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
166</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]167<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]168 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
169</div>
170<div class="sponsor">
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame^]171 <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]172</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]173</div>
174</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]175</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]176
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]177<div class="eastbar">
178 <script type="text/javascript">
179 <!--
180 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]181 google_ad_slot = "0574824969";
182 google_ad_width = 160;
183 google_ad_height = 600;
184 //-->
185 </script>
186 <script type="text/javascript"
187 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
188 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]189</div>
190
191<div class="main">
192
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame^]193<h1>Module effect
194 Methods</h1>
195<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]196
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame^]197<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
198_8c.html" id="AdaptiveBlurImage">AdaptiveBlurImage</a></h2>
199<div class="doc-section">
200
201<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>
202
203<p>The format of the AdaptiveBlurImage method is:</p>
204
205<pre class="code">
206 Image *AdaptiveBlurImage(const Image *image,const double radius,
207 const double sigma,ExceptionInfo *exception)
208 Image *AdaptiveBlurImageChannel(const Image *image,
209 const ChannelType channel,double radius,const double sigma,
210 ExceptionInfo *exception)
211</pre>
212
213<p>A description of each parameter follows:</p>
214
215<h5>image</h5>
216<p>the image.</p>
217
218<h5>channel</h5>
219<p>the channel type.</p>
220
221<h5>radius</h5>
222<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
223
224<h5>sigma</h5>
225<p>the standard deviation of the Laplacian, in pixels.</p>
226
227<h5>exception</h5>
228<p>return any errors or warnings in this structure.</p>
229
230 </div>
231<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
232_8c.html" id="AdaptiveSharpenImage">AdaptiveSharpenImage</a></h2>
233<div class="doc-section">
234
235<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>
236
237<p>The format of the AdaptiveSharpenImage method is:</p>
238
239<pre class="code">
240 Image *AdaptiveSharpenImage(const Image *image,const double radius,
241 const double sigma,ExceptionInfo *exception)
242 Image *AdaptiveSharpenImageChannel(const Image *image,
243 const ChannelType channel,double radius,const double sigma,
244 ExceptionInfo *exception)
245</pre>
246
247<p>A description of each parameter follows:</p>
248
249<h5>image</h5>
250<p>the image.</p>
251
252<h5>channel</h5>
253<p>the channel type.</p>
254
255<h5>radius</h5>
256<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
257
258<h5>sigma</h5>
259<p>the standard deviation of the Laplacian, in pixels.</p>
260
261<h5>exception</h5>
262<p>return any errors or warnings in this structure.</p>
263
264 </div>
265<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
266_8c.html" id="BlurImage">BlurImage</a></h2>
267<div class="doc-section">
268
269<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>
270
271<p>BlurImage() differs from GaussianBlurImage() in that it uses a separable kernel which is faster but mathematically equivalent to the non-separable kernel.</p>
272
273<p>The format of the BlurImage method is:</p>
274
275<pre class="code">
276 Image *BlurImage(const Image *image,const double radius,
277 const double sigma,ExceptionInfo *exception)
278 Image *BlurImageChannel(const Image *image,const ChannelType channel,
279 const double radius,const double sigma,ExceptionInfo *exception)
280</pre>
281
282<p>A description of each parameter follows:</p>
283
284<h5>image</h5>
285<p>the image.</p>
286
287<h5>channel</h5>
288<p>the channel type.</p>
289
290<h5>radius</h5>
291<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
292
293<h5>sigma</h5>
294<p>the standard deviation of the Gaussian, in pixels.</p>
295
296<h5>exception</h5>
297<p>return any errors or warnings in this structure.</p>
298
299 </div>
300<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
301_8c.html" id="ConvolveImage">ConvolveImage</a></h2>
302<div class="doc-section">
303
304<p>ConvolveImage() applies a custom convolution kernel to the image.</p>
305
306<p>The format of the ConvolveImage method is:</p>
307
308<pre class="code">
309 Image *ConvolveImage(const Image *image,const size_t order,
310 const double *kernel,ExceptionInfo *exception)
311 Image *ConvolveImageChannel(const Image *image,const ChannelType channel,
312 const size_t order,const double *kernel,ExceptionInfo *exception)
313</pre>
314
315<p>A description of each parameter follows:</p>
316
317<h5>image</h5>
318<p>the image.</p>
319
320<h5>channel</h5>
321<p>the channel type.</p>
322
323<h5>order</h5>
324<p>the number of columns and rows in the filter kernel.</p>
325
326<h5>kernel</h5>
327<p>An array of double representing the convolution kernel.</p>
328
329<h5>exception</h5>
330<p>return any errors or warnings in this structure.</p>
331
332 </div>
333<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
334_8c.html" id="DespeckleImage">DespeckleImage</a></h2>
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>
354<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
355_8c.html" id="EdgeImage">EdgeImage</a></h2>
356<div class="doc-section">
357
358<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>
359
360<p>The format of the EdgeImage method is:</p>
361
362<pre class="code">
363 Image *EdgeImage(const Image *image,const double radius,
364 ExceptionInfo *exception)
365</pre>
366
367<p>A description of each parameter follows:</p>
368
369<h5>image</h5>
370<p>the image.</p>
371
372<h5>radius</h5>
373<p>the radius of the pixel neighborhood.</p>
374
375<h5>exception</h5>
376<p>return any errors or warnings in this structure.</p>
377
378 </div>
379<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
380_8c.html" id="EmbossImage">EmbossImage</a></h2>
381<div class="doc-section">
382
383<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>
384
385<p>The format of the EmbossImage method is:</p>
386
387<pre class="code">
388 Image *EmbossImage(const Image *image,const double radius,
389 const double sigma,ExceptionInfo *exception)
390</pre>
391
392<p>A description of each parameter follows:</p>
393
394<h5>image</h5>
395<p>the image.</p>
396
397<h5>radius</h5>
398<p>the radius of the pixel neighborhood.</p>
399
400<h5>sigma</h5>
401<p>the standard deviation of the Gaussian, in pixels.</p>
402
403<h5>exception</h5>
404<p>return any errors or warnings in this structure.</p>
405
406 </div>
407<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
408_8c.html" id="FilterImage">FilterImage</a></h2>
409<div class="doc-section">
410
411<p>FilterImage() applies a custom convolution kernel to the image.</p>
412
413<p>The format of the FilterImage method is:</p>
414
415<pre class="code">
416 Image *FilterImage(const Image *image,const KernelInfo *kernel,
417 ExceptionInfo *exception)
418 Image *FilterImageChannel(const Image *image,const ChannelType channel,
419 const KernelInfo *kernel,ExceptionInfo *exception)
420</pre>
421
422<p>A description of each parameter follows:</p>
423
424<h5>image</h5>
425<p>the image.</p>
426
427<h5>channel</h5>
428<p>the channel type.</p>
429
430<h5>kernel</h5>
431<p>the filtering kernel.</p>
432
433<h5>exception</h5>
434<p>return any errors or warnings in this structure.</p>
435
436 </div>
437<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
438_8c.html" id="GaussianBlurImage">GaussianBlurImage</a></h2>
439<div class="doc-section">
440
441<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>
442
443<p>The format of the GaussianBlurImage method is:</p>
444
445<pre class="code">
446 Image *GaussianBlurImage(const Image *image,onst double radius,
447 const double sigma,ExceptionInfo *exception)
448 Image *GaussianBlurImageChannel(const Image *image,
449 const ChannelType channel,const double radius,const double sigma,
450 ExceptionInfo *exception)
451</pre>
452
453<p>A description of each parameter follows:</p>
454
455<h5>image</h5>
456<p>the image.</p>
457
458<h5>channel</h5>
459<p>the channel type.</p>
460
461<h5>radius</h5>
462<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
463
464<h5>sigma</h5>
465<p>the standard deviation of the Gaussian, in pixels.</p>
466
467<h5>exception</h5>
468<p>return any errors or warnings in this structure.</p>
469
470 </div>
471<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
472_8c.html" id="MedianFilterImage">MedianFilterImage</a></h2>
473<div class="doc-section">
474
475<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>
476
477<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>
478
479<p>The format of the MedianFilterImage method is:</p>
480
481<pre class="code">
482 Image *MedianFilterImage(const Image *image,const double radius,
483 ExceptionInfo *exception)
484</pre>
485
486<p>A description of each parameter follows:</p>
487
488<h5>image</h5>
489<p>the image.</p>
490
491<h5>radius</h5>
492<p>the radius of the pixel neighborhood.</p>
493
494<h5>exception</h5>
495<p>return any errors or warnings in this structure.</p>
496
497 </div>
498<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
499_8c.html" id="MotionBlurImage">MotionBlurImage</a></h2>
500<div class="doc-section">
501
502<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>
503
504<p>Andrew Protano contributed this effect.</p>
505
506<p>The format of the MotionBlurImage method is:</p>
507
508<pre class="code">
509 Image *MotionBlurImage(const Image *image,const double radius,
510 const double sigma,const double angle,ExceptionInfo *exception)
511 Image *MotionBlurImageChannel(const Image *image,const ChannelType channel,
512 const double radius,const double sigma,const double angle,
513 ExceptionInfo *exception)
514</pre>
515
516<p>A description of each parameter follows:</p>
517
518<h5>image</h5>
519<p>the image.</p>
520
521<h5>channel</h5>
522<p>the channel type.</p>
523
524<h5>radius</h5>
525<p>the radius of the Gaussian, in pixels, not counting the center</p>
526<h5>radius</h5>
527<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
528
529<h5>sigma</h5>
530<p>the standard deviation of the Gaussian, in pixels.</p>
531
532<h5>angle</h5>
533<p>Apply the effect along this angle.</p>
534
535<h5>exception</h5>
536<p>return any errors or warnings in this structure.</p>
537
538 </div>
539<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
540_8c.html" id="PreviewImage">PreviewImage</a></h2>
541<div class="doc-section">
542
543<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>
544
545<p>The format of the PreviewImages method is:</p>
546
547<pre class="code">
548 Image *PreviewImages(const Image *image,const PreviewType preview,
549 ExceptionInfo *exception)
550</pre>
551
552<p>A description of each parameter follows:</p>
553
554<h5>image</h5>
555<p>the image.</p>
556
557<h5>preview</h5>
558<p>the image processing operation.</p>
559
560<h5>exception</h5>
561<p>return any errors or warnings in this structure.</p>
562
563 </div>
564<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
565_8c.html" id="RadialBlurImage">RadialBlurImage</a></h2>
566<div class="doc-section">
567
568<p>RadialBlurImage() applies a radial blur to the image.</p>
569
570<p>Andrew Protano contributed this effect.</p>
571
572<p>The format of the RadialBlurImage method is:</p>
573
574<pre class="code">
575 Image *RadialBlurImage(const Image *image,const double angle,
576 ExceptionInfo *exception)
577 Image *RadialBlurImageChannel(const Image *image,const ChannelType channel,
578 const double angle,ExceptionInfo *exception)
579</pre>
580
581<p>A description of each parameter follows:</p>
582
583<h5>image</h5>
584<p>the image.</p>
585
586<h5>channel</h5>
587<p>the channel type.</p>
588
589<h5>angle</h5>
590<p>the angle of the radial blur.</p>
591
592<h5>exception</h5>
593<p>return any errors or warnings in this structure.</p>
594
595 </div>
596<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
597_8c.html" id="ReduceNoiseImage">ReduceNoiseImage</a></h2>
598<div class="doc-section">
599
600<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>
601
602<p>The format of the ReduceNoiseImage method is:</p>
603
604<pre class="code">
605 Image *ReduceNoiseImage(const Image *image,const double radius,
606 ExceptionInfo *exception)
607</pre>
608
609<p>A description of each parameter follows:</p>
610
611<h5>image</h5>
612<p>the image.</p>
613
614<h5>radius</h5>
615<p>the radius of the pixel neighborhood.</p>
616
617<h5>exception</h5>
618<p>return any errors or warnings in this structure.</p>
619
620 </div>
621<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
622_8c.html" id="SelectiveBlurImage">SelectiveBlurImage</a></h2>
623<div class="doc-section">
624
625<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>
626
627<p>The format of the SelectiveBlurImage method is:</p>
628
629<pre class="code">
630 Image *SelectiveBlurImage(const Image *image,const double radius,
631 const double sigma,const double threshold,ExceptionInfo *exception)
632 Image *SelectiveBlurImageChannel(const Image *image,
633 const ChannelType channel,const double radius,const double sigma,
634 const double threshold,ExceptionInfo *exception)
635</pre>
636
637<p>A description of each parameter follows:</p>
638
639<h5>image</h5>
640<p>the image.</p>
641
642<h5>channel</h5>
643<p>the channel type.</p>
644
645<h5>radius</h5>
646<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
647
648<h5>sigma</h5>
649<p>the standard deviation of the Gaussian, in pixels.</p>
650
651<h5>threshold</h5>
652<p>only pixels within this contrast threshold are included in the blur operation.</p>
653
654<h5>exception</h5>
655<p>return any errors or warnings in this structure.</p>
656
657 </div>
658<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
659_8c.html" id="ShadeImage">ShadeImage</a></h2>
660<div class="doc-section">
661
662<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>
663
664<p>The format of the ShadeImage method is:</p>
665
666<pre class="code">
667 Image *ShadeImage(const Image *image,const MagickBooleanType gray,
668 const double azimuth,const double elevation,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>gray</h5>
677<p>A value other than zero shades the intensity of each pixel.</p>
678
679<h5>azimuth, elevation</h5>
680<p>Define the light source direction.</p>
681
682<h5>exception</h5>
683<p>return any errors or warnings in this structure.</p>
684
685 </div>
686<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
687_8c.html" id="SharpenImage">SharpenImage</a></h2>
688<div class="doc-section">
689
690<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>
691
692<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>
693
694<p>The format of the SharpenImage method is:</p>
695
696<pre class="code">
697 Image *SharpenImage(const Image *image,const double radius,
698 const double sigma,ExceptionInfo *exception)
699 Image *SharpenImageChannel(const Image *image,const ChannelType channel,
700 const double radius,const double sigma,ExceptionInfo *exception)
701</pre>
702
703<p>A description of each parameter follows:</p>
704
705<h5>image</h5>
706<p>the image.</p>
707
708<h5>channel</h5>
709<p>the channel type.</p>
710
711<h5>radius</h5>
712<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
713
714<h5>sigma</h5>
715<p>the standard deviation of the Laplacian, in pixels.</p>
716
717<h5>exception</h5>
718<p>return any errors or warnings in this structure.</p>
719
720 </div>
721<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
722_8c.html" id="SpreadImage">SpreadImage</a></h2>
723<div class="doc-section">
724
725<p>SpreadImage() is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.</p>
726
727<p>The format of the SpreadImage method is:</p>
728
729<pre class="code">
730 Image *SpreadImage(const Image *image,const double radius,
731 ExceptionInfo *exception)
732</pre>
733
734<p>A description of each parameter follows:</p>
735
736<h5>image</h5>
737<p>the image.</p>
738
739<h5>radius</h5>
740<p>Choose a random pixel in a neighborhood of this extent.</p>
741
742<h5>exception</h5>
743<p>return any errors or warnings in this structure.</p>
744
745 </div>
746<h2><a href="http://www.imagemagick.org/api/MagickCore/effect
747_8c.html" id="UnsharpMaskImage">UnsharpMaskImage</a></h2>
748<div class="doc-section">
749
750<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>
751
752<p>The format of the UnsharpMaskImage method is:</p>
753
754<pre class="code">
755 Image *UnsharpMaskImage(const Image *image,const double radius,
756 const double sigma,const double amount,const double threshold,
757 ExceptionInfo *exception)
758 Image *UnsharpMaskImageChannel(const Image *image,
759 const ChannelType channel,const double radius,const double sigma,
760 const double amount,const double threshold,ExceptionInfo *exception)
761</pre>
762
763<p>A description of each parameter follows:</p>
764
765<h5>image</h5>
766<p>the image.</p>
767
768<h5>channel</h5>
769<p>the channel type.</p>
770
771<h5>radius</h5>
772<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
773
774<h5>sigma</h5>
775<p>the standard deviation of the Gaussian, in pixels.</p>
776
777<h5>amount</h5>
778<p>the percentage of the difference between the original and the blur image that is added back into the original.</p>
779
780<h5>threshold</h5>
781<p>the threshold in pixels needed to apply the diffence amount.</p>
782
783<h5>exception</h5>
784<p>return any errors or warnings in this structure.</p>
785
786 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]787
788</div>
789
790<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]791 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]792 <span id="linkbar-center">
793 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]794 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]795 </span>
796 <span id="linkbar-east">&nbsp;</span>
797 </div>
798 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]799 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]800 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
801 </div>
802 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]803 <script type="text/javascript">
804 var _gaq = _gaq || [];
805 _gaq.push(['_setAccount', 'UA-17690367-1']);
806 _gaq.push(['_trackPageview']);
807
808 (function() {
809 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
810 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
811 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
812 })();
813 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]814</body>
815</html>