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