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