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