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