blob: b82325aae82508b0e8f86015cb005a0885ae8756 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +00001<!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 +00003<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 +00008<head>
cristy3c98a4f2010-08-13 20:09:41 +00009 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +000011 <title>ImageMagick: MagickCore, C API for ImageMagick: Add an Effect</title>
cristy3ed852e2009-09-05 21:47:34 +000012 <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 +000015 <meta name="Application-name" content="ImageMagick"/>
cristye6e84152011-06-06 14:16:49 +000016 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images automagically."/>
cristy3c98a4f2010-08-13 20:09:41 +000017 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000018 <meta name="Generator" content="PHP"/>
cristye6e84152011-06-06 14:16:49 +000019 <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, Image, Processing, Automagically"/>
cristy3ed852e2009-09-05 21:47:34 +000020 <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 +000026 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000027 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000028 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000029 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
cristy29c5c992011-06-25 13:58:49 +000030 <link rel="canonical" href="http://www.imagemagick.org" />
cristy3c98a4f2010-08-13 20:09:41 +000031 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +000032 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy29c5c992011-06-25 13:58:49 +000033 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
cristy3c98a4f2010-08-13 20:09:41 +000034 <style type="text/css" media="all">
35 @import url("../../www/magick.css");
36 </style>
cristy29c5c992011-06-25 13:58:49 +000037 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
cristydcca3fa2010-12-29 21:50:07 +000038 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000039 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
cristy361f4662010-12-31 23:02:52 +000040 <script type="text/javascript">
41 $(document).ready(function() {
42 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
43 'transitionIn' : 'elastic',
44 'transitionOut' : 'elastic',
45 'overlayShow' : false,
46 'opacity' : true
47 });
48 });
49 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000050</head>
51
52<body id="www-imagemagick-org">
53<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +000054<div style="margin: 17px auto; float: left;">
55 <script type="text/javascript">
56 <!--
57 google_ad_client = "pub-3129977114552745";
58 google_ad_slot = "5439289906";
59 google_ad_width = 728;
60 google_ad_height = 90;
61 //-->
62 </script>
63 <script type="text/javascript"
64 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
65 </script>
66</div>
cristy3eaa0ef2010-03-06 20:35:26 +000067<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000068 <img src="../../images/logo.jpg"
69 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000070 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000071<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +000072 <img src="../../images/sprite.jpg"
73 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000074 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
75</div>
76
cristyce69bb02010-07-27 19:49:46 +000077<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000078
cristy3ed852e2009-09-05 21:47:34 +000079<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
cristy3ed852e2009-09-05 21:47:34 +000082<div class="menu">
cristybb503372010-05-27 20:51:26 +000083 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
84</div>
85<div class="sub">
86 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
90</div>
91<div class="sub">
cristye6e84152011-06-06 14:16:49 +000092 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +000093</div>
94<div class="sub">
cristybb503372010-05-27 20:51:26 +000095 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
96</div>
97<div class="sep"></div>
98<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
107<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000108 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
113<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000114 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000115</div>
116<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000117 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000118</div>
119<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000120 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000121</div>
122<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000123 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000124</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000125<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000128</div>
129<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000131</div>
132<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000133 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000134 </div>
135<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000136 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
cristybb503372010-05-27 20:51:26 +0000138<div class="menu">
139 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
140</div>
cristy3ed852e2009-09-05 21:47:34 +0000141<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000145<div class="menu">
cristy52923442011-01-15 22:54:31 +0000146 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000147</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000148<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000149<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000150 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000151</div>
152<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000153 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000154</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000155<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000156<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000157 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000158
cristyb52981c2011-03-19 17:09:31 +0000159<a href="http://www.networkredux.com">
160 <img src="../../images/networkredux.png" alt="[sponsor]"
161 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000162<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000163<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000164 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
165</div>
166<div class="sponsor">
cristy84134182011-06-15 22:59:00 +0000167 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
168</div>
169<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000170 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
171</div>
172<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000173 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
174</div>
175<div class="sponsor">
176 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
177</div>
178<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000179 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
cristy45dbd322011-03-27 16:40:38 +0000180</div>
181<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000182 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000183</div>
184<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000185 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000186</div>
187<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000188 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristyaf8d6652011-02-04 21:57:45 +0000189</div>
190<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000191 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000192</div>
193<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000194 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000195</div>
196<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000197 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000198</div>
199<div class="sponsor">
cristy0f7728a2011-07-08 16:51:28 +0000200 <a rel="follow" title="Sponsor: Autoteile Online Shop" href="http://www.autoteile-carparts.de">Autoteile Online Shop</a><!-- 2011080100030 autoteile-Carparts-->
cristyec6b4752011-01-08 03:16:23 +0000201</div>
cristy3ed852e2009-09-05 21:47:34 +0000202</div>
203</div>
cristyce69bb02010-07-27 19:49:46 +0000204</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000205
cristyce69bb02010-07-27 19:49:46 +0000206<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000207<div style="margin: 9pt 9pt 9pt 9pt;">
208 <div class="g-plusone" data-size="standard" data-count="false"></div>
209</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000210</div>
211
212<div class="main">
213
cristy350dea42011-02-15 17:31:04 +0000214<h1>Module effect Methods</h1>
cristyb52981c2011-03-19 17:09:31 +0000215<p class="navigation-index">[<a href="#AdaptiveBlurImage">AdaptiveBlurImage</a> &bull; <a href="#AdaptiveSharpenImage">AdaptiveSharpenImage</a> &bull; <a href="#BlurImage">BlurImage</a> &bull; <a href="#ConvolveImage">ConvolveImage</a> &bull; <a href="#DespeckleImage">DespeckleImage</a> &bull; <a href="#EdgeImage">EdgeImage</a> &bull; <a href="#EmbossImage">EmbossImage</a> &bull; <a href="#FilterImage">FilterImage</a> &bull; <a href="#GaussianBlurImage">GaussianBlurImage</a> &bull; <a href="#MotionBlurImage">MotionBlurImage</a> &bull; <a href="#PreviewImage">PreviewImage</a> &bull; <a href="#RadialBlurImage">RadialBlurImage</a> &bull; <a href="#SelectiveBlurImage">SelectiveBlurImage</a> &bull; <a href="#ShadeImage">ShadeImage</a> &bull; <a href="#SharpenImage">SharpenImage</a> &bull; <a href="#SpreadImage">SpreadImage</a> &bull; <a href="#StatisticImage">StatisticImage</a> &bull; <a href="#UnsharpMaskImage">UnsharpMaskImage</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000216
cristy350dea42011-02-15 17:31:04 +0000217<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="AdaptiveBlurImage">AdaptiveBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000218<div class="doc-section">
219
220<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>
221
222<p>The format of the AdaptiveBlurImage method is:</p>
223
224<pre class="code">
225 Image *AdaptiveBlurImage(const Image *image,const double radius,
226 const double sigma,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000227</pre>
228
229<p>A description of each parameter follows:</p>
230
231<h5>image</h5>
232<p>the image.</p>
233
cristy6f77f692011-02-15 15:31:39 +0000234<h5>radius</h5>
235<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
236
237<h5>sigma</h5>
238<p>the standard deviation of the Laplacian, in pixels.</p>
239
240<h5>exception</h5>
241<p>return any errors or warnings in this structure.</p>
242
243 </div>
cristy350dea42011-02-15 17:31:04 +0000244<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="AdaptiveSharpenImage">AdaptiveSharpenImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000245<div class="doc-section">
246
247<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>
248
249<p>The format of the AdaptiveSharpenImage method is:</p>
250
251<pre class="code">
252 Image *AdaptiveSharpenImage(const Image *image,const double radius,
253 const double sigma,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000254</pre>
255
256<p>A description of each parameter follows:</p>
257
258<h5>image</h5>
259<p>the image.</p>
260
cristy6f77f692011-02-15 15:31:39 +0000261<h5>radius</h5>
262<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
263
264<h5>sigma</h5>
265<p>the standard deviation of the Laplacian, in pixels.</p>
266
267<h5>exception</h5>
268<p>return any errors or warnings in this structure.</p>
269
270 </div>
cristy350dea42011-02-15 17:31:04 +0000271<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="BlurImage">BlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000272<div class="doc-section">
273
274<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>
275
276<p>BlurImage() differs from GaussianBlurImage() in that it uses a separable kernel which is faster but mathematically equivalent to the non-separable kernel.</p>
277
278<p>The format of the BlurImage method is:</p>
279
280<pre class="code">
281 Image *BlurImage(const Image *image,const double radius,
282 const double sigma,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000283</pre>
284
285<p>A description of each parameter follows:</p>
286
287<h5>image</h5>
288<p>the image.</p>
289
cristy6f77f692011-02-15 15:31:39 +0000290<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>
cristy350dea42011-02-15 17:31:04 +0000300<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="ConvolveImage">ConvolveImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000301<div class="doc-section">
302
303<p>ConvolveImage() applies a custom convolution kernel to the image.</p>
304
305<p>The format of the ConvolveImage method is:</p>
306
307<pre class="code">
308 Image *ConvolveImage(const Image *image,const size_t order,
309 const double *kernel,ExceptionInfo *exception)
cristy0f7728a2011-07-08 16:51:28 +0000310 A description of each parameter follows:
cristy6f77f692011-02-15 15:31:39 +0000311</pre>
312
cristy6f77f692011-02-15 15:31:39 +0000313<h5>image</h5>
314<p>the image.</p>
315
cristy6f77f692011-02-15 15:31:39 +0000316<h5>order</h5>
317<p>the number of columns and rows in the filter kernel.</p>
318
319<h5>kernel</h5>
320<p>An array of double representing the convolution kernel.</p>
321
322<h5>exception</h5>
323<p>return any errors or warnings in this structure.</p>
324
325 </div>
cristy350dea42011-02-15 17:31:04 +0000326<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="DespeckleImage">DespeckleImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000327<div class="doc-section">
328
329<p>DespeckleImage() reduces the speckle noise in an image while perserving the edges of the original image.</p>
330
331<p>The format of the DespeckleImage method is:</p>
332
333<pre class="code">
334 Image *DespeckleImage(const Image *image,ExceptionInfo *exception)
335</pre>
336
337<p>A description of each parameter follows:</p>
338
339<h5>image</h5>
340<p>the image.</p>
341
342<h5>exception</h5>
343<p>return any errors or warnings in this structure.</p>
344
345 </div>
cristy350dea42011-02-15 17:31:04 +0000346<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="EdgeImage">EdgeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000347<div class="doc-section">
348
349<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>
350
351<p>The format of the EdgeImage method is:</p>
352
353<pre class="code">
354 Image *EdgeImage(const Image *image,const double radius,
355 ExceptionInfo *exception)
356</pre>
357
358<p>A description of each parameter follows:</p>
359
360<h5>image</h5>
361<p>the image.</p>
362
363<h5>radius</h5>
364<p>the radius of the pixel neighborhood.</p>
365
366<h5>exception</h5>
367<p>return any errors or warnings in this structure.</p>
368
369 </div>
cristy350dea42011-02-15 17:31:04 +0000370<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="EmbossImage">EmbossImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000371<div class="doc-section">
372
373<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>
374
375<p>The format of the EmbossImage method is:</p>
376
377<pre class="code">
378 Image *EmbossImage(const Image *image,const double radius,
379 const double sigma,ExceptionInfo *exception)
380</pre>
381
382<p>A description of each parameter follows:</p>
383
384<h5>image</h5>
385<p>the image.</p>
386
387<h5>radius</h5>
388<p>the radius of the pixel neighborhood.</p>
389
390<h5>sigma</h5>
391<p>the standard deviation of the Gaussian, in pixels.</p>
392
393<h5>exception</h5>
394<p>return any errors or warnings in this structure.</p>
395
396 </div>
cristy350dea42011-02-15 17:31:04 +0000397<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="FilterImage">FilterImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000398<div class="doc-section">
399
400<p>FilterImage() applies a custom convolution kernel to the image.</p>
401
402<p>The format of the FilterImage method is:</p>
403
404<pre class="code">
405 Image *FilterImage(const Image *image,const KernelInfo *kernel,
406 ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000407</pre>
408
409<p>A description of each parameter follows:</p>
410
411<h5>image</h5>
412<p>the image.</p>
413
cristy6f77f692011-02-15 15:31:39 +0000414<h5>kernel</h5>
415<p>the filtering kernel.</p>
416
417<h5>exception</h5>
418<p>return any errors or warnings in this structure.</p>
419
420 </div>
cristy350dea42011-02-15 17:31:04 +0000421<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="GaussianBlurImage">GaussianBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000422<div class="doc-section">
423
424<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>
425
426<p>The format of the GaussianBlurImage method is:</p>
427
428<pre class="code">
429 Image *GaussianBlurImage(const Image *image,onst double radius,
430 const double sigma,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000431</pre>
432
433<p>A description of each parameter follows:</p>
434
435<h5>image</h5>
436<p>the image.</p>
437
cristy6f77f692011-02-15 15:31:39 +0000438<h5>radius</h5>
439<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
440
441<h5>sigma</h5>
442<p>the standard deviation of the Gaussian, in pixels.</p>
443
444<h5>exception</h5>
445<p>return any errors or warnings in this structure.</p>
446
447 </div>
cristy350dea42011-02-15 17:31:04 +0000448<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="MotionBlurImage">MotionBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000449<div class="doc-section">
450
451<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>
452
453<p>Andrew Protano contributed this effect.</p>
454
455<p>The format of the MotionBlurImage method is:</p>
456
457<pre class="code">
458 Image *MotionBlurImage(const Image *image,const double radius,
459 const double sigma,const double angle,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000460</pre>
461
462<p>A description of each parameter follows:</p>
463
464<h5>image</h5>
465<p>the image.</p>
466
cristy6f77f692011-02-15 15:31:39 +0000467<h5>radius</h5>
468<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
469
470<h5>sigma</h5>
471<p>the standard deviation of the Gaussian, in pixels.</p>
472
473<h5>angle</h5>
474<p>Apply the effect along this angle.</p>
475
476<h5>exception</h5>
477<p>return any errors or warnings in this structure.</p>
478
479 </div>
cristy350dea42011-02-15 17:31:04 +0000480<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="PreviewImage">PreviewImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000481<div class="doc-section">
482
483<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>
484
485<p>The format of the PreviewImages method is:</p>
486
487<pre class="code">
488 Image *PreviewImages(const Image *image,const PreviewType preview,
489 ExceptionInfo *exception)
490</pre>
491
492<p>A description of each parameter follows:</p>
493
494<h5>image</h5>
495<p>the image.</p>
496
497<h5>preview</h5>
498<p>the image processing operation.</p>
499
500<h5>exception</h5>
501<p>return any errors or warnings in this structure.</p>
502
503 </div>
cristy350dea42011-02-15 17:31:04 +0000504<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="RadialBlurImage">RadialBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000505<div class="doc-section">
506
507<p>RadialBlurImage() applies a radial blur to the image.</p>
508
509<p>Andrew Protano contributed this effect.</p>
510
511<p>The format of the RadialBlurImage method is:</p>
512
513<pre class="code">
514 Image *RadialBlurImage(const Image *image,const double angle,
515 ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000516</pre>
517
518<p>A description of each parameter follows:</p>
519
520<h5>image</h5>
521<p>the image.</p>
522
cristy6f77f692011-02-15 15:31:39 +0000523<h5>angle</h5>
524<p>the angle of the radial blur.</p>
525
526<h5>exception</h5>
527<p>return any errors or warnings in this structure.</p>
528
529 </div>
cristy350dea42011-02-15 17:31:04 +0000530<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="SelectiveBlurImage">SelectiveBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000531<div class="doc-section">
532
533<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>
534
535<p>The format of the SelectiveBlurImage method is:</p>
536
537<pre class="code">
538 Image *SelectiveBlurImage(const Image *image,const double radius,
539 const double sigma,const double threshold,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000540</pre>
541
542<p>A description of each parameter follows:</p>
543
544<h5>image</h5>
545<p>the image.</p>
546
cristy6f77f692011-02-15 15:31:39 +0000547<h5>radius</h5>
548<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
549
550<h5>sigma</h5>
551<p>the standard deviation of the Gaussian, in pixels.</p>
552
553<h5>threshold</h5>
554<p>only pixels within this contrast threshold are included in the blur operation.</p>
555
556<h5>exception</h5>
557<p>return any errors or warnings in this structure.</p>
558
559 </div>
cristy350dea42011-02-15 17:31:04 +0000560<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="ShadeImage">ShadeImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000561<div class="doc-section">
562
563<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>
564
565<p>The format of the ShadeImage method is:</p>
566
567<pre class="code">
568 Image *ShadeImage(const Image *image,const MagickBooleanType gray,
569 const double azimuth,const double elevation,ExceptionInfo *exception)
570</pre>
571
572<p>A description of each parameter follows:</p>
573
574<h5>image</h5>
575<p>the image.</p>
576
577<h5>gray</h5>
578<p>A value other than zero shades the intensity of each pixel.</p>
579
580<h5>azimuth, elevation</h5>
581<p>Define the light source direction.</p>
582
583<h5>exception</h5>
584<p>return any errors or warnings in this structure.</p>
585
586 </div>
cristy350dea42011-02-15 17:31:04 +0000587<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="SharpenImage">SharpenImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000588<div class="doc-section">
589
590<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>
591
592<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>
593
594<p>The format of the SharpenImage method is:</p>
595
596<pre class="code">
597 Image *SharpenImage(const Image *image,const double radius,
598 const double sigma,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000599</pre>
600
601<p>A description of each parameter follows:</p>
602
603<h5>image</h5>
604<p>the image.</p>
605
cristy6f77f692011-02-15 15:31:39 +0000606<h5>radius</h5>
607<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
608
609<h5>sigma</h5>
610<p>the standard deviation of the Laplacian, in pixels.</p>
611
612<h5>exception</h5>
613<p>return any errors or warnings in this structure.</p>
614
615 </div>
cristy350dea42011-02-15 17:31:04 +0000616<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="SpreadImage">SpreadImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000617<div class="doc-section">
618
619<p>SpreadImage() is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.</p>
620
621<p>The format of the SpreadImage method is:</p>
622
623<pre class="code">
624 Image *SpreadImage(const Image *image,const double radius,
625 ExceptionInfo *exception)
626</pre>
627
628<p>A description of each parameter follows:</p>
629
630<h5>image</h5>
631<p>the image.</p>
632
633<h5>radius</h5>
634<p>Choose a random pixel in a neighborhood of this extent.</p>
635
636<h5>exception</h5>
637<p>return any errors or warnings in this structure.</p>
638
639 </div>
cristyb52981c2011-03-19 17:09:31 +0000640<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="StatisticImage">StatisticImage</a></h2>
641<div class="doc-section">
642
643<p>StatisticImage() makes each pixel the min / max / median / mode / etc. of the neighborhood of the specified width and height.</p>
644
645<p>The format of the StatisticImage method is:</p>
646
647<pre class="code">
648 Image *StatisticImage(const Image *image,const StatisticType type,
649 const size_t width,const size_t height,ExceptionInfo *exception)
cristyb52981c2011-03-19 17:09:31 +0000650</pre>
651
652<p>A description of each parameter follows:</p>
653
654<h5>image</h5>
655<p>the image.</p>
656
cristyb52981c2011-03-19 17:09:31 +0000657<h5>type</h5>
658<p>the statistic type (median, mode, etc.).</p>
659
660<h5>width</h5>
661<p>the width of the pixel neighborhood.</p>
662
663<h5>height</h5>
664<p>the height of the pixel neighborhood.</p>
665
666<h5>exception</h5>
667<p>return any errors or warnings in this structure.</p>
668
669 </div>
cristy350dea42011-02-15 17:31:04 +0000670<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="UnsharpMaskImage">UnsharpMaskImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000671<div class="doc-section">
672
673<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>
674
675<p>The format of the UnsharpMaskImage method is:</p>
676
677<pre class="code">
678 Image *UnsharpMaskImage(const Image *image,const double radius,
679 const double sigma,const double amount,const double threshold,
680 ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000681</pre>
682
683<p>A description of each parameter follows:</p>
684
685<h5>image</h5>
686<p>the image.</p>
687
cristy6f77f692011-02-15 15:31:39 +0000688<h5>radius</h5>
689<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
690
691<h5>sigma</h5>
692<p>the standard deviation of the Gaussian, in pixels.</p>
693
694<h5>amount</h5>
695<p>the percentage of the difference between the original and the blur image that is added back into the original.</p>
696
697<h5>threshold</h5>
698<p>the threshold in pixels needed to apply the diffence amount.</p>
699
700<h5>exception</h5>
701<p>return any errors or warnings in this structure.</p>
702
703 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000704
705</div>
706
707<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000708 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000709 <span id="linkbar-center">
710 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000711 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000712 </span>
713 <span id="linkbar-east">&nbsp;</span>
714 </div>
715 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000716 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000717 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
718 </div>
719 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000720 <script type="text/javascript">
721 var _gaq = _gaq || [];
722 _gaq.push(['_setAccount', 'UA-17690367-1']);
723 _gaq.push(['_trackPageview']);
724
725 (function() {
726 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
727 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
728 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
729 })();
730 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000731</body>
732</html>