granicus.if.org Git - imagemagick/blob - www/api/morphology.html

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