Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 63240888c3975789a09c2494a4654b523931df96 / . / www / api / effect.html
blob: 67cee14ed444fc55936329e1828f754115fa87ed [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"/>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]10 <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
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" />
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]33 <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/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>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]38 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>
39 <script type="text/javascript" src="http://www.imagemagick.org/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">
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]167 <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
168</div>
169<div class="sponsor">
cristy84134182011-06-15 22:59:00 +0000[diff] [blame]170 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
171</div>
172<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]173 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
174</div>
175<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]176 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
177</div>
178<div class="sponsor">
179 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
180</div>
181<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]182 <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]183</div>
184<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]185 <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]186</div>
187<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame]188 <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]189</div>
190<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]191 <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]192</div>
193<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]194 <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]195</div>
196<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]197 <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]198</div>
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">
cristy222b19c2011-08-04 01:35:11 +0000[diff] [blame]203 <a rel="follow" title="Sponsor: Bildbearbeitung" href="http://www.bildschliff.de">Bildbearbeitung</a><!-- 2012060100300 strait.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 class="g-plusone" data-size="standard" data-count="false"></div>
211</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]212
213<div class="main">
214
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]215<h1>Module effect Methods</h1>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]216<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="#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]217
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]218<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]219<div class="doc-section">
220
221<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>
222
223<p>The format of the AdaptiveBlurImage method is:</p>
224
225<pre class="code">
226 Image *AdaptiveBlurImage(const Image *image,const double radius,
227 const double sigma,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]228</pre>
229
230<p>A description of each parameter follows:</p>
231
232<h5>image</h5>
233<p>the image.</p>
234
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]235<h5>radius</h5>
236<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
237
238<h5>sigma</h5>
239<p>the standard deviation of the Laplacian, in pixels.</p>
240
241<h5>exception</h5>
242<p>return any errors or warnings in this structure.</p>
243
244 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]245<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]246<div class="doc-section">
247
248<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>
249
250<p>The format of the AdaptiveSharpenImage method is:</p>
251
252<pre class="code">
253 Image *AdaptiveSharpenImage(const Image *image,const double radius,
254 const double sigma,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]255</pre>
256
257<p>A description of each parameter follows:</p>
258
259<h5>image</h5>
260<p>the image.</p>
261
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]262<h5>radius</h5>
263<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
264
265<h5>sigma</h5>
266<p>the standard deviation of the Laplacian, in pixels.</p>
267
268<h5>exception</h5>
269<p>return any errors or warnings in this structure.</p>
270
271 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]272<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]273<div class="doc-section">
274
275<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>
276
277<p>BlurImage() differs from GaussianBlurImage() in that it uses a separable kernel which is faster but mathematically equivalent to the non-separable kernel.</p>
278
279<p>The format of the BlurImage method is:</p>
280
281<pre class="code">
282 Image *BlurImage(const Image *image,const double radius,
283 const double sigma,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]284</pre>
285
286<p>A description of each parameter follows:</p>
287
288<h5>image</h5>
289<p>the image.</p>
290
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]291<h5>radius</h5>
292<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
293
294<h5>sigma</h5>
295<p>the standard deviation of the Gaussian, in pixels.</p>
296
297<h5>exception</h5>
298<p>return any errors or warnings in this structure.</p>
299
300 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]301<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]302<div class="doc-section">
303
304<p>ConvolveImage() applies a custom convolution kernel to the image.</p>
305
306<p>The format of the ConvolveImage method is:</p>
307
308<pre class="code">
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]309 Image *ConvolveImage(const Image *image,const KernelInfo *kernel,
310 ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]311</pre>
312
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]313<p>A description of each parameter follows:</p>
314
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]315<h5>image</h5>
316<p>the image.</p>
317
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]318<h5>kernel</h5>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]319<p>the filtering kernel.</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]320
321<h5>exception</h5>
322<p>return any errors or warnings in this structure.</p>
323
324 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]325<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]326<div class="doc-section">
327
328<p>DespeckleImage() reduces the speckle noise in an image while perserving the edges of the original image.</p>
329
330<p>The format of the DespeckleImage method is:</p>
331
332<pre class="code">
333 Image *DespeckleImage(const Image *image,ExceptionInfo *exception)
334</pre>
335
336<p>A description of each parameter follows:</p>
337
338<h5>image</h5>
339<p>the image.</p>
340
341<h5>exception</h5>
342<p>return any errors or warnings in this structure.</p>
343
344 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]345<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]346<div class="doc-section">
347
348<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>
349
350<p>The format of the EdgeImage method is:</p>
351
352<pre class="code">
353 Image *EdgeImage(const Image *image,const double radius,
354 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>radius</h5>
363<p>the radius of the pixel neighborhood.</p>
364
365<h5>exception</h5>
366<p>return any errors or warnings in this structure.</p>
367
368 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]369<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]370<div class="doc-section">
371
372<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>
373
374<p>The format of the EmbossImage method is:</p>
375
376<pre class="code">
377 Image *EmbossImage(const Image *image,const double radius,
378 const double sigma,ExceptionInfo *exception)
379</pre>
380
381<p>A description of each parameter follows:</p>
382
383<h5>image</h5>
384<p>the image.</p>
385
386<h5>radius</h5>
387<p>the radius of the pixel neighborhood.</p>
388
389<h5>sigma</h5>
390<p>the standard deviation of the Gaussian, in pixels.</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="GaussianBlurImage">GaussianBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]397<div class="doc-section">
398
399<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>
400
401<p>The format of the GaussianBlurImage method is:</p>
402
403<pre class="code">
404 Image *GaussianBlurImage(const Image *image,onst double radius,
405 const double sigma,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]406</pre>
407
408<p>A description of each parameter follows:</p>
409
410<h5>image</h5>
411<p>the image.</p>
412
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]413<h5>radius</h5>
414<p>the radius of the Gaussian, in pixels, not counting the center pixel.</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="MotionBlurImage">MotionBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]424<div class="doc-section">
425
426<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>
427
428<p>Andrew Protano contributed this effect.</p>
429
430<p>The format of the MotionBlurImage method is:</p>
431
432<pre class="code">
433 Image *MotionBlurImage(const Image *image,const double radius,
434 const double sigma,const double angle,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]435</pre>
436
437<p>A description of each parameter follows:</p>
438
439<h5>image</h5>
440<p>the image.</p>
441
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]442<h5>radius</h5>
443<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
444
445<h5>sigma</h5>
446<p>the standard deviation of the Gaussian, in pixels.</p>
447
448<h5>angle</h5>
449<p>Apply the effect along this angle.</p>
450
451<h5>exception</h5>
452<p>return any errors or warnings in this structure.</p>
453
454 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]455<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]456<div class="doc-section">
457
458<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>
459
460<p>The format of the PreviewImages method is:</p>
461
462<pre class="code">
463 Image *PreviewImages(const Image *image,const PreviewType preview,
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>preview</h5>
473<p>the image processing operation.</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="RadialBlurImage">RadialBlurImage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]480<div class="doc-section">
481
482<p>RadialBlurImage() applies a radial blur to the image.</p>
483
484<p>Andrew Protano contributed this effect.</p>
485
486<p>The format of the RadialBlurImage method is:</p>
487
488<pre class="code">
489 Image *RadialBlurImage(const Image *image,const double angle,
490 ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]491</pre>
492
493<p>A description of each parameter follows:</p>
494
495<h5>image</h5>
496<p>the image.</p>
497
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]498<h5>angle</h5>
499<p>the angle of the radial blur.</p>
500
501<h5>exception</h5>
502<p>return any errors or warnings in this structure.</p>
503
504 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]505<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]506<div class="doc-section">
507
508<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>
509
510<p>The format of the SelectiveBlurImage method is:</p>
511
512<pre class="code">
513 Image *SelectiveBlurImage(const Image *image,const double radius,
514 const double sigma,const double threshold,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]515</pre>
516
517<p>A description of each parameter follows:</p>
518
519<h5>image</h5>
520<p>the image.</p>
521
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]522<h5>radius</h5>
523<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
524
525<h5>sigma</h5>
526<p>the standard deviation of the Gaussian, in pixels.</p>
527
528<h5>threshold</h5>
529<p>only pixels within this contrast threshold are included in the blur operation.</p>
530
531<h5>exception</h5>
532<p>return any errors or warnings in this structure.</p>
533
534 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]535<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]536<div class="doc-section">
537
538<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>
539
540<p>The format of the ShadeImage method is:</p>
541
542<pre class="code">
543 Image *ShadeImage(const Image *image,const MagickBooleanType gray,
544 const double azimuth,const double elevation,ExceptionInfo *exception)
545</pre>
546
547<p>A description of each parameter follows:</p>
548
549<h5>image</h5>
550<p>the image.</p>
551
552<h5>gray</h5>
553<p>A value other than zero shades the intensity of each pixel.</p>
554
555<h5>azimuth, elevation</h5>
556<p>Define the light source direction.</p>
557
558<h5>exception</h5>
559<p>return any errors or warnings in this structure.</p>
560
561 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]562<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]563<div class="doc-section">
564
565<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>
566
567<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>
568
569<p>The format of the SharpenImage method is:</p>
570
571<pre class="code">
572 Image *SharpenImage(const Image *image,const double radius,
573 const double sigma,ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]574</pre>
575
576<p>A description of each parameter follows:</p>
577
578<h5>image</h5>
579<p>the image.</p>
580
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]581<h5>radius</h5>
582<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
583
584<h5>sigma</h5>
585<p>the standard deviation of the Laplacian, in pixels.</p>
586
587<h5>exception</h5>
588<p>return any errors or warnings in this structure.</p>
589
590 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]591<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]592<div class="doc-section">
593
594<p>SpreadImage() is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.</p>
595
596<p>The format of the SpreadImage method is:</p>
597
598<pre class="code">
599 Image *SpreadImage(const Image *image,const double radius,
600 ExceptionInfo *exception)
601</pre>
602
603<p>A description of each parameter follows:</p>
604
605<h5>image</h5>
606<p>the image.</p>
607
608<h5>radius</h5>
609<p>Choose a random pixel in a neighborhood of this extent.</p>
610
611<h5>exception</h5>
612<p>return any errors or warnings in this structure.</p>
613
614 </div>
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]615<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="StatisticImage">StatisticImage</a></h2>
616<div class="doc-section">
617
618<p>StatisticImage() makes each pixel the min / max / median / mode / etc. of the neighborhood of the specified width and height.</p>
619
620<p>The format of the StatisticImage method is:</p>
621
622<pre class="code">
623 Image *StatisticImage(const Image *image,const StatisticType type,
624 const size_t width,const size_t height,ExceptionInfo *exception)
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]625</pre>
626
627<p>A description of each parameter follows:</p>
628
629<h5>image</h5>
630<p>the image.</p>
631
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]632<h5>type</h5>
633<p>the statistic type (median, mode, etc.).</p>
634
635<h5>width</h5>
636<p>the width of the pixel neighborhood.</p>
637
638<h5>height</h5>
639<p>the height of the pixel neighborhood.</p>
640
641<h5>exception</h5>
642<p>return any errors or warnings in this structure.</p>
643
644 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]645<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]646<div class="doc-section">
647
648<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>
649
650<p>The format of the UnsharpMaskImage method is:</p>
651
652<pre class="code">
653 Image *UnsharpMaskImage(const Image *image,const double radius,
654 const double sigma,const double amount,const double threshold,
655 ExceptionInfo *exception)
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]656</pre>
657
658<p>A description of each parameter follows:</p>
659
660<h5>image</h5>
661<p>the image.</p>
662
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]663<h5>radius</h5>
664<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
665
666<h5>sigma</h5>
667<p>the standard deviation of the Gaussian, in pixels.</p>
668
669<h5>amount</h5>
670<p>the percentage of the difference between the original and the blur image that is added back into the original.</p>
671
672<h5>threshold</h5>
673<p>the threshold in pixels needed to apply the diffence amount.</p>
674
675<h5>exception</h5>
676<p>return any errors or warnings in this structure.</p>
677
678 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]679
680</div>
681
682<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]683 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]684 <span id="linkbar-center">
685 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]686 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]687 </span>
688 <span id="linkbar-east">&nbsp;</span>
689 </div>
690 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]691 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]692 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
693 </div>
694 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]695 <script type="text/javascript">
696 var _gaq = _gaq || [];
697 _gaq.push(['_setAccount', 'UA-17690367-1']);
698 _gaq.push(['_trackPageview']);
699
700 (function() {
701 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
702 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
703 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
704 })();
705 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]706</body>
707</html>