Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 44cbd482f15fae6544c7382473a346af1c0b868f / . / www / api / effect.html
blob: 74d1bf3db706774f9e73e4764172b6807193284e [file] [log] [blame]
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="-//W3C//DTD XHTML 1.1//EN" xml:lang="en" xsi:schemaLocation="http://www.w3.org/1999/xhtml http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]4 <meta http-equiv="content-type" content="text/html; charset=UTF-8"></meta>
5 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"></meta>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]6 <title>ImageMagick: MagickCore, C API for ImageMagick: Add an Effect</title>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]7 <meta http-equiv="content-language" content="en-US"></meta>
8 <meta http-equiv="content-type" content="text/html; charset=utf-8"></meta>
9 <meta http-equiv="reply-to" content="magick-users@imagemagick.org"></meta>
10 <meta name="application-name" content="ImageMagick"></meta>
11 <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."></meta>
12 <meta name="application-url" content="http://www.imagemagick.org"></meta>
13 <meta name="generator" content="PHP"></meta>
14 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, add, an, effect, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"></meta>
15 <meta name="rating" content="GENERAL"></meta>
16 <meta name="robots" content="INDEX, FOLLOW"></meta>
17 <meta name="generator" content="ImageMagick Studio LLC"></meta>
18 <meta name="author" content="ImageMagick Studio LLC"></meta>
19 <meta name="revisit-after" content="2 DAYS"></meta>
20 <meta name="resource-type" content="document"></meta>
21 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"></meta>
22 <meta name="distribution" content="Global"></meta>
23 <link rel="icon" href="../../images/wand.png"></link>
24 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"></link>
25 <link rel="canonical" href="../../index.html"></link>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]27
28 <!-- Add jQuery library -->
29 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
30
31 <!-- Add mousewheel plugin (this is optional) -->
32 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
33
34 <!-- Add fancyBox -->
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]35 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]36 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
37
38 <!-- Optionally add helpers - button, thumbnail and/or media -->
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]39 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]40 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
41 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
42
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]43 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen"></link>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]44 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
45
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]46 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]47 $(document).ready(function() {
48 $(".fancybox").fancybox();
49 });
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]50 </script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]51
52 <!-- ImageMagick style -->
53 <style type="text/css" media="all">
54 @import url("../../www/magick.css");
55 </style>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]56</head>
57
58<body id="www-imagemagick-org">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]59
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]60
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]61
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]62<div class="titlebar">
63<div style="margin: 17px auto; float: left;">
64 <script type="text/javascript">
65 <!--
66 google_ad_client = "pub-3129977114552745";
67 google_ad_slot = "5439289906";
68 google_ad_width = 728;
69 google_ad_height = 90;
70 //-->
71 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]72
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]73</div>
cristy417eeb12013-07-28 18:48:22 +0000[diff] [blame]74<a href="../../discourse-server">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]75 <img src="../../images/logo.jpg" alt="ImageMagick Logo" style="width: 123px; height: 118px; border: 0px; float: right;"></img></a>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]76<a href="../../index.html">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]77 <img src="../../images/sprite.jpg" alt="ImageMagick Sprite" style="width: 114px; height: 118px; border: 0px; float: right;"></img></a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]78</div>
79
80<div class="westbar">
81
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]83 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]86 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]87</div>
88<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]89 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]90</div>
91<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]92 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]93</div>
94<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]95 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]96</div>
97<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]98 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]99</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]100<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]101<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]102 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]105 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]108 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
110<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
113<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]114 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115</div>
116<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]117 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]120 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
122<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]123 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
125<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]126 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]128<div class="sep"></div>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]129<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]130 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131</div>
132<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]133 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]136 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137 </div>
138<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]139 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]141<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]142 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]143</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]145 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristy3dfa2192013-02-24 22:46:05 +0000[diff] [blame]149 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]151<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]153 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154</div>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]155<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]156 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]158<div class="sep"></div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]159<div class="menu">
160 <a title="Support ImageMagick Development" href="../../www/support.html">Support ImageMagick Development</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]162</div>
163
164<div class="eastbar">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]165
cristy417eeb12013-07-28 18:48:22 +0000[diff] [blame]166 <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a></div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]167 <noscript>
168 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]169 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0"></img></a>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]170 </noscript>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]171
172
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]173</div>
174
175<div class="main">
176
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]177<h1>Module effect Methods</h1>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]178<p class="navigation-index">[<a href="effect.html#AdaptiveBlurImage">AdaptiveBlurImage</a> • <a href="effect.html#AdaptiveSharpenImage">AdaptiveSharpenImage</a> • <a href="effect.html#BlurImage">BlurImage</a> • <a href="effect.html#ConvolveImage">ConvolveImage</a> • <a href="effect.html#DespeckleImage">DespeckleImage</a> • <a href="effect.html#EdgeImage">EdgeImage</a> • <a href="effect.html#EmbossImage">EmbossImage</a> • <a href="effect.html#FilterImage">FilterImage</a> • <a href="effect.html#GaussianBlurImage">GaussianBlurImage</a> • <a href="effect.html#MotionBlurImage">MotionBlurImage</a> • <a href="effect.html#PreviewImage">PreviewImage</a> • <a href="effect.html#RadialBlurImage">RadialBlurImage</a> • <a href="effect.html#SelectiveBlurImage">SelectiveBlurImage</a> • <a href="effect.html#ShadeImage">ShadeImage</a> • <a href="effect.html#SharpenImage">SharpenImage</a> • <a href="effect.html#SpreadImage">SpreadImage</a> • <a href="effect.html#UnsharpMaskImage">UnsharpMaskImage</a>]</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]179
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]180<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="AdaptiveBlurImage">AdaptiveBlurImage</a></h2>
181<div class="doc-section">
182
183<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>
184
185<p>The format of the AdaptiveBlurImage method is:</p>
186
187<pre class="code">
188 Image *AdaptiveBlurImage(const Image *image,const double radius,
189 const double sigma,ExceptionInfo *exception)
190 Image *AdaptiveBlurImageChannel(const Image *image,
191 const ChannelType channel,double radius,const double sigma,
192 ExceptionInfo *exception)
193</pre>
194
195<p>A description of each parameter follows:</p>
196
197<h5>image</h5>
198<p>the image.</p>
199
200<h5>channel</h5>
201<p>the channel type.</p>
202
203<h5>radius</h5>
204<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
205
206<h5>sigma</h5>
207<p>the standard deviation of the Laplacian, in pixels.</p>
208
209<h5>exception</h5>
210<p>return any errors or warnings in this structure.</p>
211
212 </div>
213<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="AdaptiveSharpenImage">AdaptiveSharpenImage</a></h2>
214<div class="doc-section">
215
216<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>
217
218<p>The format of the AdaptiveSharpenImage method is:</p>
219
220<pre class="code">
221 Image *AdaptiveSharpenImage(const Image *image,const double radius,
222 const double sigma,ExceptionInfo *exception)
223 Image *AdaptiveSharpenImageChannel(const Image *image,
224 const ChannelType channel,double radius,const double sigma,
225 ExceptionInfo *exception)
226</pre>
227
228<p>A description of each parameter follows:</p>
229
230<h5>image</h5>
231<p>the image.</p>
232
233<h5>channel</h5>
234<p>the channel type.</p>
235
236<h5>radius</h5>
237<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
238
239<h5>sigma</h5>
240<p>the standard deviation of the Laplacian, in pixels.</p>
241
242<h5>exception</h5>
243<p>return any errors or warnings in this structure.</p>
244
245 </div>
246<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="BlurImage">BlurImage</a></h2>
247<div class="doc-section">
248
249<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>
250
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]251<p>The format of the BlurImage method is:</p>
252
253<pre class="code">
254 Image *BlurImage(const Image *image,const double radius,
255 const double sigma,ExceptionInfo *exception)
256 Image *BlurImageChannel(const Image *image,const ChannelType channel,
257 const double radius,const double sigma,ExceptionInfo *exception)
258</pre>
259
260<p>A description of each parameter follows:</p>
261
262<h5>image</h5>
263<p>the image.</p>
264
265<h5>channel</h5>
266<p>the channel type.</p>
267
268<h5>radius</h5>
269<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
270
271<h5>sigma</h5>
272<p>the standard deviation of the Gaussian, in pixels.</p>
273
274<h5>exception</h5>
275<p>return any errors or warnings in this structure.</p>
276
277 </div>
278<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="ConvolveImage">ConvolveImage</a></h2>
279<div class="doc-section">
280
281<p>ConvolveImage() applies a custom convolution kernel to the image.</p>
282
283<p>The format of the ConvolveImage method is:</p>
284
285<pre class="code">
286 Image *ConvolveImage(const Image *image,const size_t order,
287 const double *kernel,ExceptionInfo *exception)
288 Image *ConvolveImageChannel(const Image *image,const ChannelType channel,
289 const size_t order,const double *kernel,ExceptionInfo *exception)
290</pre>
291
292<p>A description of each parameter follows:</p>
293
294<h5>image</h5>
295<p>the image.</p>
296
297<h5>channel</h5>
298<p>the channel type.</p>
299
300<h5>order</h5>
301<p>the number of columns and rows in the filter kernel.</p>
302
303<h5>kernel</h5>
304<p>An array of double representing the convolution kernel.</p>
305
306<h5>exception</h5>
307<p>return any errors or warnings in this structure.</p>
308
309 </div>
310<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="DespeckleImage">DespeckleImage</a></h2>
311<div class="doc-section">
312
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]313<p>DespeckleImage() reduces the speckle noise in an image while perserving the edges of the original image. A speckle removing filter uses a complementary hulling technique (raising pixels that are darker than their surrounding neighbors, then complementarily lowering pixels that are brighter than their surrounding neighbors) to reduce the speckle index of that image (reference Crimmins speckle removal).</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]314
315<p>The format of the DespeckleImage method is:</p>
316
317<pre class="code">
318 Image *DespeckleImage(const Image *image,ExceptionInfo *exception)
319</pre>
320
321<p>A description of each parameter follows:</p>
322
323<h5>image</h5>
324<p>the image.</p>
325
326<h5>exception</h5>
327<p>return any errors or warnings in this structure.</p>
328
329 </div>
330<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="EdgeImage">EdgeImage</a></h2>
331<div class="doc-section">
332
333<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>
334
335<p>The format of the EdgeImage method is:</p>
336
337<pre class="code">
338 Image *EdgeImage(const Image *image,const double radius,
339 ExceptionInfo *exception)
340</pre>
341
342<p>A description of each parameter follows:</p>
343
344<h5>image</h5>
345<p>the image.</p>
346
347<h5>radius</h5>
348<p>the radius of the pixel neighborhood.</p>
349
350<h5>exception</h5>
351<p>return any errors or warnings in this structure.</p>
352
353 </div>
354<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="EmbossImage">EmbossImage</a></h2>
355<div class="doc-section">
356
357<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>
358
359<p>The format of the EmbossImage method is:</p>
360
361<pre class="code">
362 Image *EmbossImage(const Image *image,const double radius,
363 const double sigma,ExceptionInfo *exception)
364</pre>
365
366<p>A description of each parameter follows:</p>
367
368<h5>image</h5>
369<p>the image.</p>
370
371<h5>radius</h5>
372<p>the radius of the pixel neighborhood.</p>
373
374<h5>sigma</h5>
375<p>the standard deviation of the Gaussian, in pixels.</p>
376
377<h5>exception</h5>
378<p>return any errors or warnings in this structure.</p>
379
380 </div>
381<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="FilterImage">FilterImage</a></h2>
382<div class="doc-section">
383
384<p>FilterImage() applies a custom convolution kernel to the image.</p>
385
386<p>The format of the FilterImage method is:</p>
387
388<pre class="code">
389 Image *FilterImage(const Image *image,const KernelInfo *kernel,
390 ExceptionInfo *exception)
391 Image *FilterImageChannel(const Image *image,const ChannelType channel,
392 const KernelInfo *kernel,ExceptionInfo *exception)
393</pre>
394
395<p>A description of each parameter follows:</p>
396
397<h5>image</h5>
398<p>the image.</p>
399
400<h5>channel</h5>
401<p>the channel type.</p>
402
403<h5>kernel</h5>
404<p>the filtering kernel.</p>
405
406<h5>exception</h5>
407<p>return any errors or warnings in this structure.</p>
408
409 </div>
410<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="GaussianBlurImage">GaussianBlurImage</a></h2>
411<div class="doc-section">
412
413<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>
414
415<p>The format of the GaussianBlurImage method is:</p>
416
417<pre class="code">
418 Image *GaussianBlurImage(const Image *image,onst double radius,
419 const double sigma,ExceptionInfo *exception)
420 Image *GaussianBlurImageChannel(const Image *image,
421 const ChannelType channel,const double radius,const double sigma,
422 ExceptionInfo *exception)
423</pre>
424
425<p>A description of each parameter follows:</p>
426
427<h5>image</h5>
428<p>the image.</p>
429
430<h5>channel</h5>
431<p>the channel type.</p>
432
433<h5>radius</h5>
434<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
435
436<h5>sigma</h5>
437<p>the standard deviation of the Gaussian, in pixels.</p>
438
439<h5>exception</h5>
440<p>return any errors or warnings in this structure.</p>
441
442 </div>
443<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="MotionBlurImage">MotionBlurImage</a></h2>
444<div class="doc-section">
445
446<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>
447
448<p>Andrew Protano contributed this effect.</p>
449
450<p>The format of the MotionBlurImage method is:</p>
451
452<pre class="code">
453 Image *MotionBlurImage(const Image *image,const double radius,
454 const double sigma,const double angle,ExceptionInfo *exception)
455 Image *MotionBlurImageChannel(const Image *image,const ChannelType channel,
456 const double radius,const double sigma,const double angle,
457 ExceptionInfo *exception)
458</pre>
459
460<p>A description of each parameter follows:</p>
461
462<h5>image</h5>
463<p>the image.</p>
464
465<h5>channel</h5>
466<p>the channel type.</p>
467
468<h5>radius</h5>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]469<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
470
471<h5>sigma</h5>
472<p>the standard deviation of the Gaussian, in pixels.</p>
473
474<h5>angle</h5>
475<p>Apply the effect along this angle.</p>
476
477<h5>exception</h5>
478<p>return any errors or warnings in this structure.</p>
479
480 </div>
481<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="PreviewImage">PreviewImage</a></h2>
482<div class="doc-section">
483
484<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>
485
486<p>The format of the PreviewImages method is:</p>
487
488<pre class="code">
489 Image *PreviewImages(const Image *image,const PreviewType preview,
490 ExceptionInfo *exception)
491</pre>
492
493<p>A description of each parameter follows:</p>
494
495<h5>image</h5>
496<p>the image.</p>
497
498<h5>preview</h5>
499<p>the image processing operation.</p>
500
501<h5>exception</h5>
502<p>return any errors or warnings in this structure.</p>
503
504 </div>
505<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="RadialBlurImage">RadialBlurImage</a></h2>
506<div class="doc-section">
507
508<p>RadialBlurImage() applies a radial blur to the image.</p>
509
510<p>Andrew Protano contributed this effect.</p>
511
512<p>The format of the RadialBlurImage method is:</p>
513
514<pre class="code">
515 Image *RadialBlurImage(const Image *image,const double angle,
516 ExceptionInfo *exception)
517 Image *RadialBlurImageChannel(const Image *image,const ChannelType channel,
518 const double angle,ExceptionInfo *exception)
519</pre>
520
521<p>A description of each parameter follows:</p>
522
523<h5>image</h5>
524<p>the image.</p>
525
526<h5>channel</h5>
527<p>the channel type.</p>
528
529<h5>angle</h5>
530<p>the angle of the radial blur.</p>
531
532<h5>exception</h5>
533<p>return any errors or warnings in this structure.</p>
534
535 </div>
536<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="SelectiveBlurImage">SelectiveBlurImage</a></h2>
537<div class="doc-section">
538
539<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>
540
541<p>The format of the SelectiveBlurImage method is:</p>
542
543<pre class="code">
544 Image *SelectiveBlurImage(const Image *image,const double radius,
545 const double sigma,const double threshold,ExceptionInfo *exception)
546 Image *SelectiveBlurImageChannel(const Image *image,
547 const ChannelType channel,const double radius,const double sigma,
548 const double threshold,ExceptionInfo *exception)
549</pre>
550
551<p>A description of each parameter follows:</p>
552
553<h5>image</h5>
554<p>the image.</p>
555
556<h5>channel</h5>
557<p>the channel type.</p>
558
559<h5>radius</h5>
560<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
561
562<h5>sigma</h5>
563<p>the standard deviation of the Gaussian, in pixels.</p>
564
565<h5>threshold</h5>
566<p>only pixels within this contrast threshold are included in the blur operation.</p>
567
568<h5>exception</h5>
569<p>return any errors or warnings in this structure.</p>
570
571 </div>
572<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="ShadeImage">ShadeImage</a></h2>
573<div class="doc-section">
574
575<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>
576
577<p>The format of the ShadeImage method is:</p>
578
579<pre class="code">
580 Image *ShadeImage(const Image *image,const MagickBooleanType gray,
581 const double azimuth,const double elevation,ExceptionInfo *exception)
582</pre>
583
584<p>A description of each parameter follows:</p>
585
586<h5>image</h5>
587<p>the image.</p>
588
589<h5>gray</h5>
590<p>A value other than zero shades the intensity of each pixel.</p>
591
592<h5>azimuth, elevation</h5>
593<p>Define the light source direction.</p>
594
595<h5>exception</h5>
596<p>return any errors or warnings in this structure.</p>
597
598 </div>
599<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="SharpenImage">SharpenImage</a></h2>
600<div class="doc-section">
601
602<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>
603
604<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>
605
606<p>The format of the SharpenImage method is:</p>
607
608<pre class="code">
609 Image *SharpenImage(const Image *image,const double radius,
610 const double sigma,ExceptionInfo *exception)
611 Image *SharpenImageChannel(const Image *image,const ChannelType channel,
612 const double radius,const double sigma,ExceptionInfo *exception)
613</pre>
614
615<p>A description of each parameter follows:</p>
616
617<h5>image</h5>
618<p>the image.</p>
619
620<h5>channel</h5>
621<p>the channel type.</p>
622
623<h5>radius</h5>
624<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
625
626<h5>sigma</h5>
627<p>the standard deviation of the Laplacian, in pixels.</p>
628
629<h5>exception</h5>
630<p>return any errors or warnings in this structure.</p>
631
632 </div>
633<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="SpreadImage">SpreadImage</a></h2>
634<div class="doc-section">
635
636<p>SpreadImage() is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.</p>
637
638<p>The format of the SpreadImage method is:</p>
639
640<pre class="code">
641 Image *SpreadImage(const Image *image,const double radius,
642 ExceptionInfo *exception)
643</pre>
644
645<p>A description of each parameter follows:</p>
646
647<h5>image</h5>
648<p>the image.</p>
649
650<h5>radius</h5>
651<p>Choose a random pixel in a neighborhood of this extent.</p>
652
653<h5>exception</h5>
654<p>return any errors or warnings in this structure.</p>
655
656 </div>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]657<h2><a href="http://www.imagemagick.org/api/MagickCore/effect_8c.html" id="UnsharpMaskImage">UnsharpMaskImage</a></h2>
658<div class="doc-section">
659
660<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>
661
662<p>The format of the UnsharpMaskImage method is:</p>
663
664<pre class="code">
665 Image *UnsharpMaskImage(const Image *image,const double radius,
666 const double sigma,const double amount,const double threshold,
667 ExceptionInfo *exception)
668 Image *UnsharpMaskImageChannel(const Image *image,
669 const ChannelType channel,const double radius,const double sigma,
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]670 const double gain,const double threshold,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]671</pre>
672
673<p>A description of each parameter follows:</p>
674
675<h5>image</h5>
676<p>the image.</p>
677
678<h5>channel</h5>
679<p>the channel type.</p>
680
681<h5>radius</h5>
682<p>the radius of the Gaussian, in pixels, not counting the center pixel.</p>
683
684<h5>sigma</h5>
685<p>the standard deviation of the Gaussian, in pixels.</p>
686
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]687<h5>gain</h5>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]688<p>the percentage of the difference between the original and the blur image that is added back into the original.</p>
689
690<h5>threshold</h5>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]691<p>the threshold in pixels needed to apply the diffence gain.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]692
693<h5>exception</h5>
694<p>return any errors or warnings in this structure.</p>
695
696 </div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]697
698</div>
699
700<div id="linkbar">
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]701 <span id="linkbar-west"> </span>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]702
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]703 <span id="linkbar-center">
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]704 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
705 <a href="../../discourse-server">Discourse Server</a> •
706 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> •
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]707 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]708 </span>
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]709 <span id="linkbar-east"> </span>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame^]710</div>
711<div class="footer">
712 <span id="footer-west">© 1999-2013 ImageMagick Studio LLC</span>
713 <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
714</div>
715<div style="clear: both; margin: 0; width: 100%; "></div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]716</body>
717</html>