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