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