Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 811f517641855dd51e55a1480a713ce25c084336 / . / www / api / morphology.html
blob: 2de1b515240e4720c6cf72139382ca0b96d20c5c [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Morphological Erosions, Dilations, Openings, and Closings</title>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, morphological, erosions, dilations, openings, closings, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]30</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]48<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]49
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]50<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]52</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]53<div class="sep"></div>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]54<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]75</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]78</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]90</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]93</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]94<div class="sep"></div>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]106</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Download" href="../../www/download.html">Download</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]113<div class="sep"></div>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]127
128<div class="sponsbox">
129<div class="sponsor">
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]130 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011040100025 atlas.multimedia-->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristyb36feb22010-03-26 16:54:37 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]149</div>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]153
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]166</div>
167
168<div class="main">
169
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]170<h1>Module morphology
171 Methods</h1>
cristya7cb4312010-06-26 00:47:03 +0000[diff] [blame]172<p class="navigation-index">[<a href="#** This macro IsNaN">** This macro IsNaN</a> &bull; <a href="#AcquireKernelInfo">AcquireKernelInfo</a> &bull; <a href="#AcquireKernelBuiltIn">AcquireKernelBuiltIn</a> &bull; <a href="#CloneKernelInfo">CloneKernelInfo</a> &bull; <a href="#DestroyKernelInfo">DestroyKernelInfo</a> &bull; <a href="#MorphologyApply">MorphologyApply</a> &bull; <a href="#MorphologyImageChannel">MorphologyImageChannel</a> &bull; <a href="#ScaleGeometryKernelInfo">ScaleGeometryKernelInfo</a> &bull; <a href="#ScaleKernelInfo">ScaleKernelInfo</a> &bull; <a href="#ShowKernelInfo">ShowKernelInfo</a> &bull; <a href="#UnityAddKernelInfo">UnityAddKernelInfo</a> &bull; <a href="#ZeroKernelNans">ZeroKernelNans</a>]</p>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]173
174<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]175_8c.html" target="source" name="** This macro IsNaN">** This macro IsNaN</a></h2>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]176<div class="doc-section">
177
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]178<p>** This macro IsNaN() is thus is only true if the value given is NaN. </p>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]179 </div>
180<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
181_8c.html" target="source" name="AcquireKernelInfo">AcquireKernelInfo</a></h2>
182<div class="doc-section">
183
184<p>AcquireKernelInfo() takes the given string (generally supplied by the user) and converts it into a Morphology/Convolution Kernel. This allows users to specify a kernel from a number of pre-defined kernels, or to fully specify their own kernel for a specific Convolution or Morphology Operation.</p></ol>
185
186<p>The kernel so generated can be any rectangular array of floating point values (doubles) with the 'control point' or 'pixel being affected' anywhere within that array of values.</p></ol>
187
cristya7cb4312010-06-26 00:47:03 +0000[diff] [blame]188<p>Previously IM was restricted to a square of odd size using the exact center as origin, this is no longer the case, and any rectangular kernel with any value being declared the origin. This in turn allows the use of highly asymmetrical kernels.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]189
190<p>The floating point values in the kernel can also include a special value known as 'nan' or 'not a number' to indicate that this value is not part of the kernel array. This allows you to shaped the kernel within its rectangular area. That is 'nan' values provide a 'mask' for the kernel shape. However at least one non-nan value must be provided for correct working of a kernel.</p></ol>
191
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]192<p>The returned kernel should be freed using the DestroyKernelInfo() when you are finished with it. Do not free this memory yourself.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]193
194<p>Input kernel defintion strings can consist of any of three types.</p></ol>
195
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]196<p>"name:args[[@><]" Select from one of the built in kernels, using the name and geometry arguments supplied. See AcquireKernelBuiltIn()</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]197
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]198<p>"WxH[+X+Y][@><]:num, num, num ..." a kernel of size W by H, with W*H floating point numbers following. the 'center' can be optionally be defined at +X+Y (such that +0+0 is top left corner). If not defined the pixel in the center, for odd sizes, or to the immediate top or left of center for even sizes is automatically selected.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]199
200<p>"num, num, num, num, ..." list of floating point numbers defining an 'old style' odd sized square kernel. At least 9 values should be provided for a 3x3 square kernel, 25 for a 5x5 square kernel, 49 for 7x7, etc. Values can be space or comma separated. This is not recommended.</p></ol>
201
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]202<p>You can define a 'list of kernels' which can be used by some morphology operators A list is defined as a semi-colon seperated list kernels.</p></ol>
203
204<p>" kernel ; kernel ; kernel ; "</p></ol>
205
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]206<p>Any extra ';' characters, at start, end or between kernel defintions are simply ignored.</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]207
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]208<p>The special flags will expand a single kernel, into a list of rotated kernels. A '@' flag will expand a 3x3 kernel into a list of 45-degree cyclic rotations, while a '>' will generate a list of 90-degree rotations. The '<' also exands using 90-degree rotates, but giving a 180-degree reflected kernel before the +/- 90-degree rotations, which can be important for Thinning operations.</p></ol>
209
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]210<p>Note that 'name' kernels will start with an alphabetic character while the new kernel specification has a ':' character in its specification string. If neither is the case, it is assumed an old style of a simple list of numbers generating a odd-sized square kernel has been given.</p></ol>
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]211
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]212<p>The format of the AcquireKernal method is:</p>
213
214<pre class="code">
215 KernelInfo *AcquireKernelInfo(const char *kernel_string)
216</pre>
217
218<p>A description of each parameter follows:</p></ol>
219
220<h5>kernel_string</h5>
221<ol><p>the Morphology/Convolution kernel wanted.</p></ol>
222
223 </div>
224<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
225_8c.html" target="source" name="AcquireKernelBuiltIn">AcquireKernelBuiltIn</a></h2>
226<div class="doc-section">
227
228<p>AcquireKernelBuiltIn() returned one of the 'named' built-in types of kernels used for special purposes such as gaussian blurring, skeleton pruning, and edge distance determination.</p></ol>
229
230<p>They take a KernelType, and a set of geometry style arguments, which were typically decoded from a user supplied string, or from a more complex Morphology Method that was requested.</p></ol>
231
232<p>The format of the AcquireKernalBuiltIn method is:</p>
233
234<pre class="code">
235 KernelInfo *AcquireKernelBuiltIn(const KernelInfoType type,
236 const GeometryInfo args)
237</pre>
238
239<p>A description of each parameter follows:</p></ol>
240
241<h5>type</h5>
242<ol><p>the pre-defined type of kernel wanted</p></ol>
243
244<h5>args</h5>
245<ol><p>arguments defining or modifying the kernel</p></ol>
246
247<p>Convolution Kernels</p></ol>
248
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]249<p>Unity the No-Op kernel, also requivelent to Gaussian of sigma zero. Basically a 3x3 kernel of a 1 surrounded by zeros.</p></ol>
250
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]251<p>Gaussian:{radius},{sigma} Generate a two-dimentional gaussian kernel, as used by -gaussian. The sigma for the curve is required. The resulting kernel is normalized,</p></ol>
252
253<p>If 'sigma' is zero, you get a single pixel on a field of zeros.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]254
255<p>NOTE: that the 'radius' is optional, but if provided can limit (clip) the final size of the resulting kernel to a square 2*radius+1 in size. The radius should be at least 2 times that of the sigma value, or sever clipping and aliasing may result. If not given or set to 0 the radius will be determined so as to produce the best minimal error result, which is usally much larger than is normally needed.</p></ol>
256
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]257<p>LoG:{radius},{sigma} "Laplacian of a Gaussian" or "Mexician Hat" Kernel. The supposed ideal edge detection, zero-summing kernel.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]258
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]259<p>An alturnative to this kernel is to use a "DoG" with a sigma ratio of approx 1.6 (according to wikipedia).</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]260
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]261<p>DoG:{radius},{sigma1},{sigma2} "Difference of Gaussians" Kernel. As "Gaussian" but with a gaussian produced by 'sigma2' subtracted from the gaussian produced by 'sigma1'. Typically sigma2 > sigma1. The result is a zero-summing kernel.</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]262
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]263<p>Blur:{radius},{sigma}[,{angle}] Generates a 1 dimensional or linear gaussian blur, at the angle given (current restricted to orthogonal angles). If a 'radius' is given the kernel is clipped to a width of 2*radius+1. Kernel can be rotated by a 90 degree angle.</p></ol>
264
265<p>If 'sigma' is zero, you get a single pixel on a field of zeros.</p></ol>
266
267<p>Note that two convolutions with two "Blur" kernels perpendicular to each other, is equivelent to a far larger "Gaussian" kernel with the same sigma value, However it is much faster to apply. This is how the "-blur" operator actually works.</p></ol>
268
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]269<p>Comet:{width},{sigma},{angle} Blur in one direction only, much like how a bright object leaves a comet like trail. The Kernel is actually half a gaussian curve, Adding two such blurs in opposite directions produces a Blur Kernel. Angle can be rotated in multiples of 90 degrees.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]270
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]271<p>Note that the first argument is the width of the kernel and not the radius of the kernel.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]272
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]273<p># Still to be implemented... # # Filter2D # Filter1D # Set kernel values using a resize filter, and given scale (sigma) # Cylindrical or Linear. Is this posible with an image? #</p></ol>
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]274
275<p>Named Constant Convolution Kernels</p></ol>
276
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]277<p>All these are unscaled, zero-summing kernels by default. As such for non-HDRI version of ImageMagick some form of normalization, user scaling, and biasing the results is recommended, to prevent the resulting image being 'clipped'.</p></ol>
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]278
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]279<p>The 3x3 kernels (most of these) can be circularly rotated in multiples of 45 degrees to generate the 8 angled varients of each of the kernels.</p></ol>
280
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]281<p>Laplacian:{type} Discrete Lapacian Kernels, (without normalization) Type 0 : 3x3 with center:8 surounded by -1 (8 neighbourhood) Type 1 : 3x3 with center:4 edge:-1 corner:0 (4 neighbourhood) Type 2 : 3x3 with center:4 edge:1 corner:-2 Type 3 : 3x3 with center:4 edge:-2 corner:1 Type 5 : 5x5 laplacian Type 7 : 7x7 laplacian Type 15 : 5x5 LoG (sigma approx 1.4) Type 19 : 9x9 LoG (sigma approx 1.4)</p></ol>
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]282
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]283<p>Sobel:{angle} Sobel 'Edge' convolution kernel (3x3) | -1, 0, 1 | | -2, 0,-2 | | -1, 0, 1 |</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]284
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]285<p>Sobel:{type},{angle} Type 0: default un-nomalized version shown above.</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]286
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]287<p>Type 1: As default but pre-normalized | 1, 0, -1 | | 2, 0, -2 | / 4 | 1, 0, -1 |</p></ol>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]288
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]289<p>Type 2: Diagonal version with same normalization as 1 | 1, 0, -1 | | 2, 0, -2 | / 4 | 1, 0, -1 |</p></ol>
290
291<p>Roberts:{angle} Roberts convolution kernel (3x3) | 0, 0, 0 | | -1, 1, 0 | | 0, 0, 0 |</p></ol>
292
293<p>Prewitt:{angle} Prewitt Edge convolution kernel (3x3) | -1, 0, 1 | | -1, 0, 1 | | -1, 0, 1 |</p></ol>
294
295<p>Compass:{angle} Prewitt's "Compass" convolution kernel (3x3) | -1, 1, 1 | | -1,-2, 1 | | -1, 1, 1 |</p></ol>
296
297<p>Kirsch:{angle} Kirsch's "Compass" convolution kernel (3x3) | -3,-3, 5 | | -3, 0, 5 | | -3,-3, 5 |</p></ol>
298
299<p>FreiChen:{angle} Frei-Chen Edge Detector is based on a kernel that is similar to the Sobel Kernel, but is designed to be isotropic. That is it takes into account the distance of the diagonal in the kernel.</p></ol>
300
301<p>| 1, 0, -1 | | sqrt(2), 0, -sqrt(2) | | 1, 0, -1 |</p></ol>
302
303<p>FreiChen:{type},{angle}</p></ol>
304
305<p>Frei-Chen Pre-weighted kernels...</p></ol>
306
307<p>Type 0: default un-nomalized version shown above.</p></ol>
308
309<p>Type 1: Orthogonal Kernel (same as type 11 below) | 1, 0, -1 | | sqrt(2), 0, -sqrt(2) | / 2*sqrt(2) | 1, 0, -1 |</p></ol>
310
311<p>Type 2: Diagonal form of Kernel... | 1, sqrt(2), 0 | | sqrt(2), 0, -sqrt(2) | / 2*sqrt(2) | 0, -sqrt(2) -1 |</p></ol>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]312
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]313<p>However this kernel is als at the heart of the FreiChen Edge Detection Process which uses a set of 9 specially weighted kernel. These 9 kernels not be normalized, but directly applied to the image. The results is then added together, to produce the intensity of an edge in a specific direction. The square root of the pixel value can then be taken as the cosine of the edge, and at least 2 such runs at 90 degrees from each other, both the direction and the strength of the edge can be determined.</p></ol>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]314
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]315<p>Type 10: All 9 of the following pre-weighted kernels...</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]316
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]317<p>Type 11: | 1, 0, -1 | | sqrt(2), 0, -sqrt(2) | / 2*sqrt(2) | 1, 0, -1 |</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]318
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]319<p>Type 12: | 1, sqrt(2), 1 | | 0, 0, 0 | / 2*sqrt(2) | 1, sqrt(2), 1 |</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]320
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]321<p>Type 13: | sqrt(2), -1, 0 | | -1, 0, 1 | / 2*sqrt(2) | 0, 1, -sqrt(2) |</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]322
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]323<p>Type 14: | 0, 1, -sqrt(2) | | -1, 0, 1 | / 2*sqrt(2) | sqrt(2), -1, 0 |</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]324
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]325<p>Type 15: | 0, -1, 0 | | 1, 0, 1 | / 2 | 0, -1, 0 |</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]326
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]327<p>Type 16: | 1, 0, -1 | | 0, 0, 0 | / 2 | -1, 0, 1 |</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]328
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]329<p>Type 17: | 1, -2, 1 | | -2, 4, -2 | / 6 | -1, -2, 1 |</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]330
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]331<p>Type 18: | -2, 1, -2 | | 1, 4, 1 | / 6 | -2, 1, -2 |</p></ol>
332
333<p>Type 19: | 1, 1, 1 | | 1, 1, 1 | / 3 | 1, 1, 1 |</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]334
335<p>The first 4 are for edge detection, the next 4 are for line detection and the last is to add a average component to the results.</p></ol>
336
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]337<p>Using a special type of '-1' will return all 9 pre-weighted kernels as a multi-kernel list, so that you can use them directly (without normalization) with the special "-set option:morphology:compose Plus" setting to apply the full FreiChen Edge Detection Technique.</p></ol>
338
339<p>If 'type' is large it will be taken to be an actual rotation angle for the default FreiChen (type 0) kernel. As such FreiChen:45 will look like a Sobel:45 but with 'sqrt(2)' instead of '2' values.</p></ol>
340
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]341<p>WARNING: The above was layed out as per http://www.math.tau.ac.il/~turkel/notes/edge_detectors.pdf But rotated 90 degrees so direction is from left rather than the top. I have yet to find any secondary confirmation of the above. The only other source found was actual source code at http://ltswww.epfl.ch/~courstiv/exos_labos/sol3.pdf Neigher paper defineds the kernels in a way that looks locical or correct when taken as a whole.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]342
343<p>Boolean Kernels</p></ol>
344
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]345<p>Diamond:[{radius}[,{scale}]] Generate a diamond shaped kernel with given radius to the points. Kernel size will again be radius*2+1 square and defaults to radius 1, generating a 3x3 kernel that is slightly larger than a square.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]346
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]347<p>Square:[{radius}[,{scale}]] Generate a square shaped kernel of size radius*2+1, and defaulting to a 3x3 (radius 1).</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]348
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]349<p>Note that using a larger radius for the "Square" or the "Diamond" is also equivelent to iterating the basic morphological method that many times. However iterating with the smaller radius is actually faster than using a larger kernel radius.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]350
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]351<p>Rectangle:{geometry} Simply generate a rectangle of 1's with the size given. You can also specify the location of the 'control point', otherwise the closest pixel to the center of the rectangle is selected.</p></ol>
352
353<p>Properly centered and odd sized rectangles work the best.</p></ol>
354
355<p>Disk:[{radius}[,{scale}]] Generate a binary disk of the radius given, radius may be a float. Kernel size will be ceil(radius)*2+1 square. NOTE: Here are some disk shapes of specific interest "Disk:1" => "diamond" or "cross:1" "Disk:1.5" => "square" "Disk:2" => "diamond:2" "Disk:2.5" => a general disk shape of radius 2 "Disk:2.9" => "square:2" "Disk:3.5" => default - octagonal/disk shape of radius 3 "Disk:4.2" => roughly octagonal shape of radius 4 "Disk:4.3" => a general disk shape of radius 4 After this all the kernel shape becomes more and more circular.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]356
357<p>Because a "disk" is more circular when using a larger radius, using a larger radius is preferred over iterating the morphological operation.</p></ol>
358
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]359<p>Symbol Dilation Kernels</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]360
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]361<p>These kernel is not a good general morphological kernel, but is used more for highlighting and marking any single pixels in an image using, a "Dilate" method as appropriate.</p></ol>
cristy6f6c2962010-05-14 01:39:00 +0000[diff] [blame]362
363<p>For the same reasons iterating these kernels does not produce the same result as using a larger radius for the symbol.</p></ol>
364
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]365<p>Plus:[{radius}[,{scale}]] Cross:[{radius}[,{scale}]] Generate a kernel in the shape of a 'plus' or a 'cross' with a each arm the length of the given radius (default 2).</p></ol>
366
367<p>NOTE: "plus:1" is equivelent to a "Diamond" kernel.</p></ol>
368
369<p>Ring:{radius1},{radius2}[,{scale}] A ring of the values given that falls between the two radii. Defaults to a ring of approximataly 3 radius in a 7x7 kernel. This is the 'edge' pixels of the default "Disk" kernel, More specifically, "Ring" -> "Ring:2.5,3.5,1.0"</p></ol>
370
cristy6f6c2962010-05-14 01:39:00 +0000[diff] [blame]371<p>Hit and Miss Kernels</p></ol>
372
cristy4cb39ab2010-06-07 13:59:16 +0000[diff] [blame]373<p>Peak:radius1,radius2 Find any peak larger than the pixels the fall between the two radii. The default ring of pixels is as per "Ring". Edges Find flat orthogonal edges of a binary shape Corners Find 90 degree corners of a binary shape LineEnds:type Find end points of lines (for pruning a skeletion) Two types of lines ends (default to both) can be searched for Type 0: All line ends Type 1: single kernel for 4-conneected line ends Type 2: single kernel for simple line ends LineJunctions Find three line junctions (within a skeletion) Type 0: all line junctions Type 1: Y Junction kernel Type 2: Diagonal T Junction kernel Type 3: Orthogonal T Junction kernel Type 4: Diagonal X Junction kernel Type 5: Orthogonal + Junction kernel Ridges:type Find single pixel ridges or thin lines Type 1: Fine single pixel thick lines and ridges Type 2: Find two pixel thick lines and ridges ConvexHull Octagonal thicken kernel, to generate convex hulls of 45 degrees Skeleton:type Traditional skeleton generating kernels. Type 1: Tradional Skeleton kernel (4 connected skeleton) Type 2: HIPR2 Skeleton kernel (8 connected skeleton) Type 3: Experimental Variation to try to present left-right symmetry Type 4: Experimental Variation to preserve left-right symmetry</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]374
375<p>Distance Measuring Kernels</p></ol>
376
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]377<p>Different types of distance measuring methods, which are used with the a 'Distance' morphology method for generating a gradient based on distance from an edge of a binary shape, though there is a technique for handling a anti-aliased shape.</p></ol>
378
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]379<p>See the 'Distance' Morphological Method, for information of how it is applied.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]380
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]381<p>Chebyshev:[{radius}][x{scale}[!]] Chebyshev Distance (also known as Tchebychev Distance) is a value of one to any neighbour, orthogonal or diagonal. One why of thinking of it is the number of squares a 'King' or 'Queen' in chess needs to traverse reach any other position on a chess board. It results in a 'square' like distance function, but one where diagonals are closer than expected.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]382
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]383<p>Manhattan:[{radius}][x{scale}[!]] Manhattan Distance (also known as Rectilinear Distance, or the Taxi Cab metric), is the distance needed when you can only travel in orthogonal (horizontal or vertical) only. It is the distance a 'Rook' in chess would travel. It results in a diamond like distances, where diagonals are further than expected.</p></ol>
cristyf1310b52010-05-15 16:42:04 +0000[diff] [blame]384
385<p>Euclidean:[{radius}][x{scale}[!]] Euclidean Distance is the 'direct' or 'as the crow flys distance. However by default the kernel size only has a radius of 1, which limits the distance to 'Knight' like moves, with only orthogonal and diagonal measurements being correct. As such for the default kernel you will get octagonal like distance function, which is reasonally accurate.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]386
387<p>However if you use a larger radius such as "Euclidean:4" you will get a much smoother distance gradient from the edge of the shape. Of course a larger kernel is slower to use, and generally not needed.</p></ol>
388
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]389<p>To allow the use of fractional distances that you get with diagonals the actual distance is scaled by a fixed value which the user can provide. This is not actually nessary for either ""Chebyshev" or "Manhattan" distance kernels, but is done for all three distance kernels. If no scale is provided it is set to a value of 100, allowing for a maximum distance measurement of 655 pixels using a Q16 version of IM, from any edge. However for small images this can result in quite a dark gradient.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]390
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]391 </div>
392<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
393_8c.html" target="source" name="CloneKernelInfo">CloneKernelInfo</a></h2>
394<div class="doc-section">
395
cristya7cb4312010-06-26 00:47:03 +0000[diff] [blame]396<p>CloneKernelInfo() creates a new clone of the given Kernel List so that its can be modified without effecting the original. The cloned kernel should be destroyed using DestoryKernelInfo() when no longer needed.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]397
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]398<p>The format of the CloneKernelInfo method is:</p>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]399
400<pre class="code">
401 KernelInfo *CloneKernelInfo(const KernelInfo *kernel)
402</pre>
403
404<p>A description of each parameter follows:</p></ol>
405
406<h5>kernel</h5>
407<ol><p>the Morphology/Convolution kernel to be cloned</p></ol>
408
409 </div>
410<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
411_8c.html" target="source" name="DestroyKernelInfo">DestroyKernelInfo</a></h2>
412<div class="doc-section">
413
414<p>DestroyKernelInfo() frees the memory used by a Convolution/Morphology kernel.</p></ol>
415
416<p>The format of the DestroyKernelInfo method is:</p>
417
418<pre class="code">
419 KernelInfo *DestroyKernelInfo(KernelInfo *kernel)
420</pre>
421
422<p>A description of each parameter follows:</p></ol>
423
424<h5>kernel</h5>
425<ol><p>the Morphology/Convolution kernel to be destroyed</p></ol>
426
427 </div>
428<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]429_8c.html" target="source" name="MorphologyApply">MorphologyApply</a></h2>
430<div class="doc-section">
431
432<p>MorphologyApply() applies a morphological method, multiple times using a list of multiple kernels.</p></ol>
433
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]434<p>It is basically equivelent to as MorphologyImageChannel() (see below) but without any user controls. This allows internel programs to use this function, to actually perform a specific task without posible interference by any API user supplied settings.</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]435
cristyfe0019b2010-06-07 02:23:32 +0000[diff] [blame]436<p>It is MorphologyImageChannel() task to extract any such user controls, and pass them to this function for processing.</p></ol>
437
438<p>More specifically kernels are not normalized/scaled/blended by the 'convolve:scale' Image Artifact (setting), nor is the convolve bias (-bias setting or image->bias) loooked at, but must be supplied from the function arguments.</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]439
440<p>The format of the MorphologyApply method is:</p>
441
442<pre class="code">
443 Image *MorphologyApply(const Image *image,MorphologyMethod method,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]444 const ssize_t iterations,const KernelInfo *kernel,
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]445 const CompositeMethod compose, const double bias,
446 ExceptionInfo *exception)
447</pre>
448
449<p>A description of each parameter follows:</p></ol>
450
451<h5>image</h5>
cristybac7a162010-06-15 19:57:29 +0000[diff] [blame]452<ol><p>the source image</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]453
454<h5>method</h5>
455<ol><p>the morphology method to be applied.</p></ol>
456
457<h5>iterations</h5>
458<ol><p>apply the operation this many times (or no change). A value of -1 means loop until no change found. How this is applied may depend on the morphology method. Typically this is a value of 1.</p></ol>
459
460<h5>channel</h5>
461<ol><p>the channel type.</p></ol>
462
463<h5>kernel</h5>
cristybac7a162010-06-15 19:57:29 +0000[diff] [blame]464<ol><p>An array of double representing the morphology kernel.</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]465
466<h5>compose</h5>
cristybac7a162010-06-15 19:57:29 +0000[diff] [blame]467<ol><p>How to handle or merge multi-kernel results. If 'UndefinedCompositeOp' use default for the Morphology method. If 'NoCompositeOp' force image to be re-iterated by each kernel. Otherwise merge the results using the compose method given.</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]468
469<h5>bias</h5>
470<ol><p>Convolution Output Bias.</p></ol>
471
472<h5>exception</h5>
473<ol><p>return any errors or warnings in this structure.</p></ol>
474
475 </div>
476<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]477_8c.html" target="source" name="MorphologyImageChannel">MorphologyImageChannel</a></h2>
478<div class="doc-section">
479
480<p>MorphologyImageChannel() applies a user supplied kernel to the image according to the given mophology method.</p></ol>
481
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]482<p>This function applies any and all user defined settings before calling the above internal function MorphologyApply().</p></ol>
483
484<p>User defined settings include... * Output Bias for Convolution and correlation ("-bias") * Kernel Scale/normalize settings ("-set 'option:convolve:scale'") This can also includes the addition of a scaled unity kernel. * Show Kernel being applied ("-set option:showkernel 1")</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]485
486<p>The format of the MorphologyImage method is:</p>
487
488<pre class="code">
489 Image *MorphologyImage(const Image *image,MorphologyMethod method,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]490 const ssize_t iterations,KernelInfo *kernel,ExceptionInfo *exception)
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]491</pre>
492
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]493<p>Image *MorphologyImageChannel(const Image *image, const ChannelType channel,MorphologyMethod method,const ssize_t iterations, KernelInfo *kernel,ExceptionInfo *exception)</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]494
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]495<p>A description of each parameter follows:</p></ol>
496
497<h5>image</h5>
498<ol><p>the image.</p></ol>
499
500<h5>method</h5>
501<ol><p>the morphology method to be applied.</p></ol>
502
503<h5>iterations</h5>
504<ol><p>apply the operation this many times (or no change). A value of -1 means loop until no change found. How this is applied may depend on the morphology method. Typically this is a value of 1.</p></ol>
505
506<h5>channel</h5>
507<ol><p>the channel type.</p></ol>
508
509<h5>kernel</h5>
510<ol><p>An array of double representing the morphology kernel. Warning: kernel may be normalized for the Convolve method.</p></ol>
511
512<h5>exception</h5>
513<ol><p>return any errors or warnings in this structure.</p></ol>
514
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]515 </div>
516<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
517_8c.html" target="source" name="ScaleGeometryKernelInfo">ScaleGeometryKernelInfo</a></h2>
518<div class="doc-section">
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]519
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]520<p>ScaleGeometryKernelInfo() takes a geometry argument string, typically provided as a "-set option:convolve:scale {geometry}" user setting, and modifies the kernel according to the parsed arguments of that setting.</p></ol>
521
522<p>The first argument (and any normalization flags) are passed to ScaleKernelInfo() to scale/normalize the kernel. The second argument is then passed to UnityAddKernelInfo() to add a scled unity kernel into the scaled/normalized kernel.</p></ol>
523
524<p>The format of the ScaleKernelInfo method is:</p>
525
526<pre class="code">
527 void ScaleKernelInfo(KernelInfo *kernel, const double scaling_factor,
528 const MagickStatusType normalize_flags )
529</pre>
530
531<p>A description of each parameter follows:</p></ol>
532
533<h5>kernel</h5>
534<ol><p>the Morphology/Convolution kernel to modify</p></ol>
535
536<p>o geometry:</p>
537
538<pre class="text">
539 "-set option:convolve:scale {geometry}" setting.
540</pre>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]541
542 </div>
543<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
544_8c.html" target="source" name="ScaleKernelInfo">ScaleKernelInfo</a></h2>
545<div class="doc-section">
546
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]547<p>ScaleKernelInfo() scales the given kernel list by the given amount, with or without normalization of the sum of the kernel values (as per given flags).</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]548
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]549<p>By default (no flags given) the values within the kernel is scaled directly using given scaling factor without change.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]550
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]551<p>If either of the two 'normalize_flags' are given the kernel will first be normalized and then further scaled by the scaling factor value given.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]552
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]553<p>Kernel normalization ('normalize_flags' given) is designed to ensure that any use of the kernel scaling factor with 'Convolve' or 'Correlate' morphology methods will fall into -1.0 to +1.0 range. Note that for non-HDRI versions of IM this may cause images to have any negative results clipped, unless some 'bias' is used.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]554
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]555<p>More specifically. Kernels which only contain positive values (such as a 'Gaussian' kernel) will be scaled so that those values sum to +1.0, ensuring a 0.0 to +1.0 output range for non-HDRI images.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]556
557<p>For Kernels that contain some negative values, (such as 'Sharpen' kernels) the kernel will be scaled by the absolute of the sum of kernel values, so that it will generally fall within the +/- 1.0 range.</p></ol>
558
559<p>For kernels whose values sum to zero, (such as 'Laplician' kernels) kernel will be scaled by just the sum of the postive values, so that its output range will again fall into the +/- 1.0 range.</p></ol>
560
561<p>For special kernels designed for locating shapes using 'Correlate', (often only containing +1 and -1 values, representing foreground/brackground matching) a special normalization method is provided to scale the positive values seperatally to those of the negative values, so the kernel will be forced to become a zero-sum kernel better suited to such searches.</p></ol>
562
cristyf0d1f5d2010-05-13 16:29:38 +0000[diff] [blame]563<p>WARNING: Correct normalization of the kernel assumes that the '*_range' attributes within the kernel structure have been correctly set during the kernels creation.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]564
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]565<p>NOTE: The values used for 'normalize_flags' have been selected specifically to match the use of geometry options, so that '!' means NormalizeValue, '^' means CorrelateNormalizeValue. All other GeometryFlags values are ignored.</p></ol>
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]566
567<p>The format of the ScaleKernelInfo method is:</p>
568
569<pre class="code">
570 void ScaleKernelInfo(KernelInfo *kernel, const double scaling_factor,
571 const MagickStatusType normalize_flags )
572</pre>
573
574<p>A description of each parameter follows:</p></ol>
575
576<h5>kernel</h5>
577<ol><p>the Morphology/Convolution kernel</p></ol>
578
579<p>o scaling_factor:</p>
580
581<pre class="text">
582 zero. If the kernel is normalized regardless of any flags.
583</pre>
584
585<p>o normalize_flags:</p>
586
587<pre class="text">
588 specifically: NormalizeValue, CorrelateNormalizeValue,
589 and/or PercentValue
590</pre>
591
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]592 </div>
593<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
594_8c.html" target="source" name="ShowKernelInfo">ShowKernelInfo</a></h2>
595<div class="doc-section">
596
597<p>ShowKernelInfo() outputs the details of the given kernel defination to standard error, generally due to a users 'showkernel' option request.</p></ol>
598
599<p>The format of the ShowKernel method is:</p>
600
601<pre class="code">
602 void ShowKernelInfo(KernelInfo *kernel)
603</pre>
604
605<p>A description of each parameter follows:</p></ol>
606
607<h5>kernel</h5>
608<ol><p>the Morphology/Convolution kernel</p></ol>
609
610 </div>
611<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
612_8c.html" target="source" name="UnityAddKernelInfo">UnityAddKernelInfo</a></h2>
613<div class="doc-section">
614
615<p>UnityAddKernelInfo() Adds a given amount of the 'Unity' Convolution Kernel to the given pre-scaled and normalized Kernel. This in effect adds that amount of the original image into the resulting convolution kernel. This value is usually provided by the user as a percentage value in the 'convolve:scale' setting.</p></ol>
616
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]617<p>The resulting effect is to convert the defined kernels into blended soft-blurs, unsharp kernels or into sharpening kernels.</p></ol>
cristyc4960862010-05-23 22:24:24 +0000[diff] [blame]618
619<p>The format of the UnityAdditionKernelInfo method is:</p>
620
621<pre class="code">
622 void UnityAdditionKernelInfo(KernelInfo *kernel, const double scale )
623</pre>
624
625<p>A description of each parameter follows:</p></ol>
626
627<h5>kernel</h5>
628<ol><p>the Morphology/Convolution kernel</p></ol>
629
630<p>o scale:</p>
631
632<pre class="text">
633 the given kernel.
634</pre>
635
636 </div>
637<h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
638_8c.html" target="source" name="ZeroKernelNans">ZeroKernelNans</a></h2>
639<div class="doc-section">
640
641<p>ZeroKernelNans() replaces any special 'nan' value that may be present in the kernel with a zero value. This is typically done when the kernel will be used in special hardware (GPU) convolution processors, to simply matters.</p></ol>
642
643<p>The format of the ZeroKernelNans method is:</p>
644
645<pre class="code">
646 void ZeroKernelNans (KernelInfo *kernel)
647</pre>
648
649<p>A description of each parameter follows:</p></ol>
650
651<h5>kernel</h5>
652<ol><p>the Morphology/Convolution kernel</p></ol>
653
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]654 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]655
656</div>
657
658<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]659 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]660 <span id="linkbar-center">
661 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]662 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]663 </span>
664 <span id="linkbar-east">&nbsp;</span>
665 </div>
666 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]667 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]668 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
669 </div>
670 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]671 <script type="text/javascript">
672 var _gaq = _gaq || [];
673 _gaq.push(['_setAccount', 'UA-17690367-1']);
674 _gaq.push(['_trackPageview']);
675
676 (function() {
677 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
678 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
679 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
680 })();
681 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]682</body>
683</html>