]> granicus.if.org Git - imagemagick/blob - www/api/morphology.html
93c74c0f1209609b802d3143600ef830d59220d0
[imagemagick] / www / api / morphology.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">\r
4 <head>\r
5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
7   <title>ImageMagick: MagickCore, C API for ImageMagick: Morphological Erosions, Dilations, Openings, and Closings</title>
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"/>
11   <meta name="Application-name" content="ImageMagick"/>
12   <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
13   <meta name="Application-url" content="http://www.imagemagick.org"/>
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"/>
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"/>
22   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
23   <meta name="Distribution" content="Global"/>
24   <link rel="icon" href="../../images/wand.png"/>
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"/>\r
27   <style type="text/css" media="all">\r
28     @import url("../../www/magick.css");\r
29   </style>\r
30   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
31    <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
32    <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
33    <script type="text/javascript">\r
34      $(document).ready(function() {\r
35        $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
36          'transitionIn'  : 'elastic',\r
37          'transitionOut' : 'elastic',\r
38          'overlayShow'   : false,\r
39          'opacity'       : true\r
40        });\r
41      });\r
42    </script>\r
43 </head>\r
44 \r
45 <body id="www-imagemagick-org">\r
46 <div class="titlebar">\r
47 <a href="../../index.html">\r
48   <img src="../../images/script.png" alt="[ImageMagick]"\r
49   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
50 <a href="http://www.networkredux.com">\r
51   <img src="../../images/networkredux.png" alt="[sponsor]"\r
52   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
53 <a href="http://www.imagemagick.org/discourse-server/">\r
54   <img src="../../images/logo.jpg" alt=""\r
55   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
56 <a href="../../index.html">\r
57   <img src="../../images/sprite.jpg" alt=""\r
58   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
59 </div>\r
60 \r
61 <div class="westbar">\r
62 \r
63 <div class="menu">
64   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
65 </div>
66 <div class="sep"></div>\r
67 <div class="menu">
68   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
69 </div>
70 <div class="sub">
71     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
72 </div>
73 <div class="sub">
74     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
75 </div>
76 <div class="sub">
77     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
78 </div>
79 <div class="sep"></div>\r
80 <div class="menu">
81   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
82 </div>
83 <div class="sub">
84     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
85 </div>
86 <div class="sub">
87     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
88 </div>
89 <div class="sub">
90     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
91 </div>
92 <div class="menu">
93   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
94 </div>
95 <div class="sub">
96     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
97 </div>
98 <div class="sub">
99     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
100 </div>
101 <div class="sub">
102     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
103 </div>
104 <div class="sub">
105     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
106 </div>
107 <div class="sep"></div>\r
108 <div  class="menu">
109    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
110 </div>
111 <div class="sub">
112     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
113 </div>
114 <div class="sub">
115     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
116  </div>
117 <div class="menu">
118   <a title="Resources" href="../../www/resources.html">Resources</a>
119 </div>
120 <div class="menu">
121   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
122 </div>
123 <div class="menu">
124   <a title="Download" href="../../www/download.html">Download</a>
125 </div>
126 <div class="sep"></div>\r
127 <div class="menu">
128   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
129 </div>
130 <div class="sep"></div>\r
131 <div class="menu">
132   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
133 </div>
134 <div  class="sub">
135   <a title="Site Map: Links" href="../../www/links.html">Links</a>
136 </div>
137 <div class="sep"></div>\r
138 <div  class="menu">
139   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
140
141 <div class="sponsbox">
142 <div  class="sponsor">
143    <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011040100025 atlas.multimedia-->
144 </div>
145 <div  class="sponsor">
146   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
147 </div>
148 <div  class="sponsor">
149   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
150 </div>
151 <div  class="sponsor">
152   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
153 </div>
154 </div>
155 </div>
156 </div>\r
157 \r
158 <div class="eastbar">\r
159   <script type="text/javascript">\r
160   <!--\r
161     google_ad_client = "pub-3129977114552745";\r
162     google_ad_slot = "0574824969";\r
163     google_ad_width = 160;\r
164     google_ad_height = 600;\r
165   //-->\r
166   </script>\r
167   <script type="text/javascript"\r
168     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
169   </script>\r
170 </div>\r
171 \r
172 <div class="main">\r
173 \r
174 <h1>Module morphology
175  Methods</h1>
176 <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>
177
178 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
179 _8c.html" target="source" name="** This macro  IsNaN">** This macro  IsNaN</a></h2>
180 <div class="doc-section">
181
182 <p>** This macro  IsNaN() is thus is only true if the value given is NaN. </p>
183  </div>
184 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
185 _8c.html" target="source" name="AcquireKernelInfo">AcquireKernelInfo</a></h2>
186 <div class="doc-section">
187
188 <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>
189
190 <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>
191
192 <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>
193
194 <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>
195
196 <p>The returned kernel should be freed using the DestroyKernelInfo() when you are finished with it.  Do not free this memory yourself.</p></ol>
197
198 <p>Input kernel defintion strings can consist of any of three types.</p></ol>
199
200 <p>"name:args[[@><]" Select from one of the built in kernels, using the name and geometry arguments supplied.  See AcquireKernelBuiltIn()</p></ol>
201
202 <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>
203
204 <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>
205
206 <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>
207
208 <p>" kernel ; kernel ; kernel ; "</p></ol>
209
210 <p>Any extra ';' characters, at start, end or between kernel defintions are simply ignored.</p></ol>
211
212 <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>
213
214 <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>
215
216 <p>The format of the AcquireKernal method is:</p>
217
218 <pre class="code">
219   KernelInfo *AcquireKernelInfo(const char *kernel_string)
220 </pre>
221
222 <p>A description of each parameter follows:</p></ol>
223
224 <h5>kernel_string</h5>
225 <ol><p>the Morphology/Convolution kernel wanted.</p></ol>
226
227  </div>
228 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
229 _8c.html" target="source" name="AcquireKernelBuiltIn">AcquireKernelBuiltIn</a></h2>
230 <div class="doc-section">
231
232 <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>
233
234 <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>
235
236 <p>The format of the AcquireKernalBuiltIn method is:</p>
237
238 <pre class="code">
239   KernelInfo *AcquireKernelBuiltIn(const KernelInfoType type,
240        const GeometryInfo args)
241 </pre>
242
243 <p>A description of each parameter follows:</p></ol>
244
245 <h5>type</h5>
246 <ol><p>the pre-defined type of kernel wanted</p></ol>
247
248 <h5>args</h5>
249 <ol><p>arguments defining or modifying the kernel</p></ol>
250
251 <p>Convolution Kernels</p></ol>
252
253 <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>
254
255 <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>
256
257 <p>If 'sigma' is zero, you get a single pixel on a field of zeros.</p></ol>
258
259 <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>
260
261 <p>LoG:{radius},{sigma} "Laplacian of a Gaussian" or "Mexician Hat" Kernel. The supposed ideal edge detection, zero-summing kernel.</p></ol>
262
263 <p>An alturnative to this kernel is to use a "DoG" with a sigma ratio of approx 1.6 (according to wikipedia).</p></ol>
264
265 <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>
266
267 <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>
268
269 <p>If 'sigma' is zero, you get a single pixel on a field of zeros.</p></ol>
270
271 <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>
272
273 <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>
274
275 <p>Note that the first argument is the width of the kernel and not the radius of the kernel.</p></ol>
276
277 <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>
278
279 <p>Named Constant Convolution Kernels</p></ol>
280
281 <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>
282
283 <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>
284
285 <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>
286
287 <p>Sobel:{angle} Sobel 'Edge' convolution kernel (3x3) | -1, 0, 1 | | -2, 0,-2 | | -1, 0, 1 |</p></ol>
288
289 <p>Sobel:{type},{angle} Type 0:  default un-nomalized version shown above.</p></ol>
290
291 <p>Type 1:  As default but pre-normalized | 1, 0, -1 | | 2, 0, -2 |  / 4 | 1, 0, -1 |</p></ol>
292
293 <p>Type 2:  Diagonal version with same normalization as 1 | 1, 0, -1 | | 2, 0, -2 |  / 4 | 1, 0, -1 |</p></ol>
294
295 <p>Roberts:{angle} Roberts convolution kernel (3x3) |  0, 0, 0 | | -1, 1, 0 | |  0, 0, 0 |</p></ol>
296
297 <p>Prewitt:{angle} Prewitt Edge convolution kernel (3x3) | -1, 0, 1 | | -1, 0, 1 | | -1, 0, 1 |</p></ol>
298
299 <p>Compass:{angle} Prewitt's "Compass" convolution kernel (3x3) | -1, 1, 1 | | -1,-2, 1 | | -1, 1, 1 |</p></ol>
300
301 <p>Kirsch:{angle} Kirsch's "Compass" convolution kernel (3x3) | -3,-3, 5 | | -3, 0, 5 | | -3,-3, 5 |</p></ol>
302
303 <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>
304
305 <p>|   1,     0,   -1     | | sqrt(2), 0, -sqrt(2) | |   1,     0,   -1     |</p></ol>
306
307 <p>FreiChen:{type},{angle}</p></ol>
308
309 <p>Frei-Chen Pre-weighted kernels...</p></ol>
310
311 <p>Type 0:  default un-nomalized version shown above.</p></ol>
312
313 <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>
314
315 <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>
316
317 <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>
318
319 <p>Type 10: All 9 of the following pre-weighted kernels...</p></ol>
320
321 <p>Type 11: |   1,     0,   -1     | | sqrt(2), 0, -sqrt(2) | / 2*sqrt(2) |   1,     0,   -1     |</p></ol>
322
323 <p>Type 12: | 1, sqrt(2), 1 | | 0,   0,     0 | / 2*sqrt(2) | 1, sqrt(2), 1 |</p></ol>
324
325 <p>Type 13: | sqrt(2), -1,    0     | |  -1,      0,    1     | / 2*sqrt(2) |   0,      1, -sqrt(2) |</p></ol>
326
327 <p>Type 14: |    0,     1, -sqrt(2) | |   -1,     0,     1    | / 2*sqrt(2) | sqrt(2), -1,     0    |</p></ol>
328
329 <p>Type 15: | 0, -1, 0 | | 1,  0, 1 | / 2 | 0, -1, 0 |</p></ol>
330
331 <p>Type 16: |  1, 0, -1 | |  0, 0,  0 | / 2 | -1, 0,  1 |</p></ol>
332
333 <p>Type 17: |  1, -2,  1 | | -2,  4, -2 | / 6 | -1, -2,  1 |</p></ol>
334
335 <p>Type 18: | -2, 1, -2 | |  1, 4,  1 | / 6 | -2, 1, -2 |</p></ol>
336
337 <p>Type 19: | 1, 1, 1 | | 1, 1, 1 | / 3 | 1, 1, 1 |</p></ol>
338
339 <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>
340
341 <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>
342
343 <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>
344
345 <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>
346
347 <p>Boolean Kernels</p></ol>
348
349 <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>
350
351 <p>Square:[{radius}[,{scale}]] Generate a square shaped kernel of size radius*2+1, and defaulting to a 3x3 (radius 1).</p></ol>
352
353 <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>
354
355 <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>
356
357 <p>Properly centered and odd sized rectangles work the best.</p></ol>
358
359 <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>
360
361 <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>
362
363 <p>Symbol Dilation Kernels</p></ol>
364
365 <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>
366
367 <p>For the same reasons iterating these kernels does not produce the same result as using a larger radius for the symbol.</p></ol>
368
369 <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>
370
371 <p>NOTE: "plus:1" is equivelent to a "Diamond" kernel.</p></ol>
372
373 <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>
374
375 <p>Hit and Miss Kernels</p></ol>
376
377 <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>
378
379 <p>Distance Measuring Kernels</p></ol>
380
381 <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>
382
383 <p>See the 'Distance' Morphological Method, for information of how it is applied.</p></ol>
384
385 <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>
386
387 <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>
388
389 <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>
390
391 <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>
392
393 <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>
394
395  </div>
396 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
397 _8c.html" target="source" name="CloneKernelInfo">CloneKernelInfo</a></h2>
398 <div class="doc-section">
399
400 <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>
401
402 <p>The format of the CloneKernelInfo method is:</p>
403
404 <pre class="code">
405   KernelInfo *CloneKernelInfo(const KernelInfo *kernel)
406 </pre>
407
408 <p>A description of each parameter follows:</p></ol>
409
410 <h5>kernel</h5>
411 <ol><p>the Morphology/Convolution kernel to be cloned</p></ol>
412
413  </div>
414 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
415 _8c.html" target="source" name="DestroyKernelInfo">DestroyKernelInfo</a></h2>
416 <div class="doc-section">
417
418 <p>DestroyKernelInfo() frees the memory used by a Convolution/Morphology kernel.</p></ol>
419
420 <p>The format of the DestroyKernelInfo method is:</p>
421
422 <pre class="code">
423   KernelInfo *DestroyKernelInfo(KernelInfo *kernel)
424 </pre>
425
426 <p>A description of each parameter follows:</p></ol>
427
428 <h5>kernel</h5>
429 <ol><p>the Morphology/Convolution kernel to be destroyed</p></ol>
430
431  </div>
432 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
433 _8c.html" target="source" name="MorphologyApply">MorphologyApply</a></h2>
434 <div class="doc-section">
435
436 <p>MorphologyApply() applies a morphological method, multiple times using a list of multiple kernels.</p></ol>
437
438 <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>
439
440 <p>It is MorphologyImageChannel() task to extract any such user controls, and pass them to this function for processing.</p></ol>
441
442 <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>
443
444 <p>The format of the MorphologyApply method is:</p>
445
446 <pre class="code">
447   Image *MorphologyApply(const Image *image,MorphologyMethod method,
448     const ssize_t iterations,const KernelInfo *kernel,
449     const CompositeMethod compose, const double bias,
450     ExceptionInfo *exception)
451 </pre>
452
453 <p>A description of each parameter follows:</p></ol>
454
455 <h5>image</h5>
456 <ol><p>the source image</p></ol>
457
458 <h5>method</h5>
459 <ol><p>the morphology method to be applied.</p></ol>
460
461 <h5>iterations</h5>
462 <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>
463
464 <h5>channel</h5>
465 <ol><p>the channel type.</p></ol>
466
467 <h5>kernel</h5>
468 <ol><p>An array of double representing the morphology kernel.</p></ol>
469
470 <h5>compose</h5>
471 <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>
472
473 <h5>bias</h5>
474 <ol><p>Convolution Output Bias.</p></ol>
475
476 <h5>exception</h5>
477 <ol><p>return any errors or warnings in this structure.</p></ol>
478
479  </div>
480 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
481 _8c.html" target="source" name="MorphologyImageChannel">MorphologyImageChannel</a></h2>
482 <div class="doc-section">
483
484 <p>MorphologyImageChannel() applies a user supplied kernel to the image according to the given mophology method.</p></ol>
485
486 <p>This function applies any and all user defined settings before calling the above internal function MorphologyApply().</p></ol>
487
488 <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>
489
490 <p>The format of the MorphologyImage method is:</p>
491
492 <pre class="code">
493   Image *MorphologyImage(const Image *image,MorphologyMethod method,
494     const ssize_t iterations,KernelInfo *kernel,ExceptionInfo *exception)
495 </pre>
496
497 <p>Image *MorphologyImageChannel(const Image *image, const ChannelType channel,MorphologyMethod method,const ssize_t iterations, KernelInfo *kernel,ExceptionInfo *exception)</p></ol>
498
499 <p>A description of each parameter follows:</p></ol>
500
501 <h5>image</h5>
502 <ol><p>the image.</p></ol>
503
504 <h5>method</h5>
505 <ol><p>the morphology method to be applied.</p></ol>
506
507 <h5>iterations</h5>
508 <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>
509
510 <h5>channel</h5>
511 <ol><p>the channel type.</p></ol>
512
513 <h5>kernel</h5>
514 <ol><p>An array of double representing the morphology kernel. Warning: kernel may be normalized for the Convolve method.</p></ol>
515
516 <h5>exception</h5>
517 <ol><p>return any errors or warnings in this structure.</p></ol>
518
519  </div>
520 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
521 _8c.html" target="source" name="ScaleGeometryKernelInfo">ScaleGeometryKernelInfo</a></h2>
522 <div class="doc-section">
523
524 <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>
525
526 <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>
527
528 <p>The format of the ScaleKernelInfo method is:</p>
529
530 <pre class="code">
531   void ScaleKernelInfo(KernelInfo *kernel, const double scaling_factor,
532            const MagickStatusType normalize_flags )
533 </pre>
534
535 <p>A description of each parameter follows:</p></ol>
536
537 <h5>kernel</h5>
538 <ol><p>the Morphology/Convolution kernel to modify</p></ol>
539
540 <p>o geometry:</p>
541
542 <pre class="text">
543          "-set option:convolve:scale {geometry}" setting.
544 </pre>
545
546  </div>
547 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
548 _8c.html" target="source" name="ScaleKernelInfo">ScaleKernelInfo</a></h2>
549 <div class="doc-section">
550
551 <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>
552
553 <p>By default (no flags given) the values within the kernel is scaled directly using given scaling factor without change.</p></ol>
554
555 <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>
556
557 <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>
558
559 <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>
560
561 <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>
562
563 <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>
564
565 <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>
566
567 <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>
568
569 <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>
570
571 <p>The format of the ScaleKernelInfo method is:</p>
572
573 <pre class="code">
574   void ScaleKernelInfo(KernelInfo *kernel, const double scaling_factor,
575            const MagickStatusType normalize_flags )
576 </pre>
577
578 <p>A description of each parameter follows:</p></ol>
579
580 <h5>kernel</h5>
581 <ol><p>the Morphology/Convolution kernel</p></ol>
582
583 <p>o scaling_factor:</p>
584
585 <pre class="text">
586          zero.  If the kernel is normalized regardless of any flags.
587 </pre>
588
589 <p>o normalize_flags:</p>
590
591 <pre class="text">
592          specifically: NormalizeValue, CorrelateNormalizeValue,
593                        and/or PercentValue
594 </pre>
595
596  </div>
597 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
598 _8c.html" target="source" name="ShowKernelInfo">ShowKernelInfo</a></h2>
599 <div class="doc-section">
600
601 <p>ShowKernelInfo() outputs the details of the given kernel defination to standard error, generally due to a users 'showkernel' option request.</p></ol>
602
603 <p>The format of the ShowKernel method is:</p>
604
605 <pre class="code">
606   void ShowKernelInfo(KernelInfo *kernel)
607 </pre>
608
609 <p>A description of each parameter follows:</p></ol>
610
611 <h5>kernel</h5>
612 <ol><p>the Morphology/Convolution kernel</p></ol>
613
614  </div>
615 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
616 _8c.html" target="source" name="UnityAddKernelInfo">UnityAddKernelInfo</a></h2>
617 <div class="doc-section">
618
619 <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>
620
621 <p>The resulting effect is to convert the defined kernels into blended soft-blurs, unsharp kernels or into sharpening kernels.</p></ol>
622
623 <p>The format of the UnityAdditionKernelInfo method is:</p>
624
625 <pre class="code">
626   void UnityAdditionKernelInfo(KernelInfo *kernel, const double scale )
627 </pre>
628
629 <p>A description of each parameter follows:</p></ol>
630
631 <h5>kernel</h5>
632 <ol><p>the Morphology/Convolution kernel</p></ol>
633
634 <p>o scale:</p>
635
636 <pre class="text">
637          the given kernel.
638 </pre>
639
640  </div>
641 <h2><a href="http://www.imagemagick.org/api/MagickCore/morphology
642 _8c.html" target="source" name="ZeroKernelNans">ZeroKernelNans</a></h2>
643 <div class="doc-section">
644
645 <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>
646
647 <p>The format of the ZeroKernelNans method is:</p>
648
649 <pre class="code">
650   void ZeroKernelNans (KernelInfo *kernel)
651 </pre>
652
653 <p>A description of each parameter follows:</p></ol>
654
655 <h5>kernel</h5>
656 <ol><p>the Morphology/Convolution kernel</p></ol>
657
658  </div>
659 \r
660 </div>\r
661 \r
662 <div id="linkbar">\r
663     <span id="linkbar-west">&nbsp;</span>\r
664     <span id="linkbar-center">\r
665       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
666       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
667     </span>\r
668     <span id="linkbar-east">&nbsp;</span>\r
669   </div>\r
670   <div class="footer">\r
671     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
672     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
673   </div>\r
674   <div style="clear: both; margin: 0; width: 100%; "></div>\r
675   <script type="text/javascript">\r
676     var _gaq = _gaq || [];\r
677     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
678     _gaq.push(['_trackPageview']);\r
679 \r
680     (function() {\r
681       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
682       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
683       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
684     })();\r
685   </script>\r
686 </body>\r
687 </html>\r