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