granicus.if.org Git - imagemagick/blob - www/architecture.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   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="all">\r
   9     @import url("../www/magick.css");\r
  10   </style>\r
  11   <link rel="shortcut icon" href="../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: Architecture</title>
  13   <meta http-equiv="Content-Language" content="en-US"/>
  14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="Generator" content="PHP"/>
  17   <meta name="Keywords" content="architecture, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  18   <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."/>
  19   <meta name="Rating" content="GENERAL"/>
  20   <meta name="Robots" content="INDEX, FOLLOW"/>
  21   <meta name="Generator" content="ImageMagick Studio LLC"/>
  22   <meta name="Author" content="ImageMagick Studio LLC"/>
  23   <meta name="Revisit-after" content="2 DAYS"/>
  24   <meta name="Resource-type" content="document"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../index.html">\r
  32   <img src="../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../index.html">\r
  41   <img src="../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a title="Architecture" href="../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a title="Resources" href="../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a title="Download" href="../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Site Map"href="../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a title="Site Map: Links"href="../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Lampe Berger" href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 155 \r
 156 \r
 157 <p class="navigation-index">[<a href="#overview">Architecture Overview</a> &bull; <a href="#cache">The Pixel Cache</a> &bull; <a href="#stream">Streaming Pixels</a> &bull; <a href="#properties">Image Properties and Profiles</a> &bull; <a href="#tera-pixel">Large Image Support</a> &bull; <a href="#threads">Threads of Execution</a> &bull; <a href="#distributed">Heterogeneous Distributed Processing</a> &bull; <a href="#coders">Custom Image Coders</a> &bull; <a href="#filters">Custom Image Filters</a>]</p>
 158
 159 <div class="doc-section">
 160 <p>The citizens of Oz were quite content with their benefactor, the all-powerful Wizard.  They accepted his wisdom and benevolence without ever questioning the who, why, and where of his power.  Like the citizens of Oz, if you feel comfortable that ImageMagick can help you convert, edit, or compose your images without knowing what goes on behind the curtain, feel free to skip this section.  However, if you want to know more about the software and algorithms behind ImageMagick, read on.  To fully benefit from this discussion, you should be comfortable with image nomenclature and be familiar with computer programming.</p>
 161 </div>
 162
 163 <h2><a name="overview"></a>Architecture Overview</h2>
 164 <div class="doc-section">
 165
 166 <p>An image typically consists of a rectangular region of pixels and metadata.  To convert, edit, or compose an image in an efficient manner we need convenient access to any pixel anywhere within the region (and sometimes outside the region).  And in the case of an image sequence, we need access to any pixel of any region of any image in the sequence.  However, there are hundreds of image formats such JPEG, TIFF, PNG, GIF, etc., that makes it difficult to access pixels on demand.  Within these formats we find differences in:</p>
 167
 168 <ul>
 169   <li>colorspace (e.g RGB, CMYK, YUV, Lab, etc.)</li>
 170   <li>bit depth (.e.g 1, 4, 8, 12, 16, etc.)</li>
 171   <li>storage format (e.g. unsigned, signed, float, double, etc.)</li>
 172   <li>compression (e.g. uncompressed, RLE, Zip, BZip, etc.)</li>
 173   <li>orientation (i.e. top-to-bottom, right-to-left, etc.),</li>
 174   <li>layout (.e.g. raw, interspersed with opcodes, etc.)</li>
 175 </ul>
 176
 177 <p>In addition, some image pixels may require attenuation, some formats permit more than one frame, and some formats contain vector graphics that must first be rasterized (converted from vector to pixels).</p>
 178
 179 <p>An efficient implementation of an image processing algorithm may require we get or set:</p>
 180
 181 <ul>
 182   <li>one pixel a time (e.g. pixel at location 10,3)</li>
 183   <li>a single scanline (e.g. all pixels from row 4)</li>
 184   <li>a few scanlines at once (e.g. pixel rows 4-7)</li>
 185   <li>a single column or columns of pixels (e.g. all pixels from column 11)</li>
 186   <li>an arbitrary region of pixels from the image (e.g. pixels defined at 10,7 to 10,19)</li>
 187   <li>a pixel in random order (e.g. pixel at 14,15 and 640,480)</li>
 188   <li>pixels from two different images (e.g. pixel at 5,1 from image 1 and pixel at 5,1 from image 2)</li>
 189   <li>pixels outside the boundaries of the image (e.g. pixel at -1,-3)</li>
 190   <li>a pixel component that is unsigned or in a floating-point representation (e.g. 0.17836)</li>
 191   <li>a high-dynamic range pixel that can include negative values as well as values that exceed the quantum depth (e.g. -0.00716)</li>
 192   <li>one or more pixels simultaneously in different threads of execution</li>
 193   <li>all the pixels in memory to take advantage of speed-ups offered by executing in concert across heterogeneous platforms consisting of CPUs, GPUs, and other processors</li>
 194 </ul>
 195
 196 <p>In addition, some images include a clip mask that define which pixels are eligible to be updated.  Pixels outside the area defined by the clip mask remain untouched.</p>
 197
 198 <p>Given the varied image formats and image processing requirements, we implemented the ImageMagick <a href="#cache">pixel cache</a> to provide convenient sequential or parallel access to any pixel on demand anywhere inside the image region (we call these <a href="#authentic-pixels">authentic pixels</a>)  and from any image in a sequence.  In addition, the pixel cache permits access to pixels outside the boundaries defined by the image (we call these <a href="#virtual-pixels">virtual pixels</a>).</p>
 199
 200 <p>In addition to pixels, images have a plethora of <a href="#properties">image properties and profiles</a>.  Properties include the well known attributes such as width, height, depth, and colorspace.  An image may have optional properties which might include the image author, a comment, a create date, and others.  Some images also include profiles for color management, or EXIF, IPTC, 8BIM, or XMP informational profiles.  ImageMagick provides command line options and programming methods to get, set, or view image properties or profiles or apply profiles.</p>
 201
 202 <p>ImageMagick consists of more than 400,000 lines of C code and optionally depends on several million lines of code in dependent libraries (e.g. JPEG, PNG, TIFF libraries).  Given that, one might expect a huge architecture document.  However, a great majority of image processing is simply accessing pixels and its metadata and our simple and elegant implementation makes this easy for the ImageMagick developer.  We discuss the implementation of the pixel cache and getting and setting image properties and profiles in the next few sections. Next, we discuss using ImageMagick within a <a href="#threads">thread</a> of execution.  In the final sections, we discuss <a href="#coders">image coders</a> to read or write a particular image format followed by a few words on creating a <a href="#filters">filter</a> to access or update pixels based on your custom requirements.</p>
 203
 204 </div>
 205
 206 <h2><a name="cache"></a>The Pixel Cache</h2>
 207 <div class="doc-section">
 208
 209 <p>The ImageMagick pixel cache is a repository for image pixels with up to 5 channels.  The first 4 channels are stored contiguously and an optional second area follows with 1 channel.  The channels are at the depth specified when ImageMagick was built.  The channel depths are 8 bits-per-pixel component for the Q8 version of ImageMagick, 16 bits-per-pixel component for the Q16 version, and 32 bits-per-pixel component for the Q32 version.  By default pixel components are unsigned quantities, however, if you use the <a href="../www/high-dynamic-range.html">high dynamic-range</a> version of ImageMagick, the components are 32-bit floating point. The primary 4 channels can hold any value but typically contain red, green, blue, and alpha intensities or cyan, magenta, yellow, and alpha intensities.  The optional fifth channel contains the colormap indexes for colormapped images or the black channel for CMYK images.  The pixel cache storage may be heap memory, anonymous memory mapped memory, disk-backed memory mapped, or on disk.  The pixel cache is reference-counted.  Only the cache properties are copied when the cache is cloned.  The cache pixels are subsequently copied when you signal your intention to update any of the pixels.</p>
 210
 211 <h3>Create the Pixel Cache</h3>
 212 <div class="doc-section">
 213
 214 <p>The pixel cache is associated with an image when it is created and it is initialized when you try to get or put pixels.  Here are three common methods to associate a pixel cache with an image:</p>
 215
 216 <h4>Create an image canvas initialized to the background color:</h4>
 217 <p class="code">
 218   image=AllocateImage(image_info);
 219   if (SetImageExtent(image,640,480) == MagickFalse)
 220     { /* an exception was thrown */ }
 221   (void) QueryMagickColor("red",&amp;image-&gt;background_color,&amp;image-&gt;exception);
 222   SetImageBackgroundColor(image);
 223 </p>
 224
 225 <h4>Create an image from a JPEG image on disk:</h4>
 226 <p class="code">  (void) strcpy(image_info-&gt;filename,"image.jpg"):
 227   image=ReadImage(image_info,exception);
 228   if (image == (Image *) NULL)
 229     { /* an exception was thrown */ }
 230 </p>
 231 <h4>Create an image from a memory based image:</h4>
 232 <p class="code">
 233   image=BlobToImage(blob_info,blob,extent,exception);
 234   if (image == (Image *) NULL)
 235     { /* an exception was thrown */ }
 236 </p>
 237
 238 <p>In our discussion of the pixel cache, we use the <a href="../www/magick-core.html">MagickCore API</a> to illustrate our points, however, the principles are the same for other program interfaces to ImageMagick.</p>
 239
 240 <p>When the pixel cache is initialized, pixels are scaled from whatever bit depth they originated from to that required by the pixel cache.  For example, a 1-channel 1-bit monochrome PBM image is scaled to a 4 channel 8-bit RGBA image, if you are using the Q8 version of ImageMagick, and 16-bit RGBA for the Q16 version.  You can determine which version you have with the <a href="../www/command-line-options.html#version">&#x2011;version</a> option: </p>
 241
 242 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -version</span><span class='crtout'>Version: ImageMagick 6.6.1-7 2010-04-15 Q16 http://www.imagemagick.org</span></p>
 243 <p>As you can see, the convenience of the pixel cache sometimes comes with a trade-off in storage (e.g. storing a 1-bit monochrome image as 16-bit RGBA is wasteful) and speed (i.e. storing the entire image in memory is generally slower than accessing one scanline of pixels at a time).  In most cases, the benefits of the pixel cache typically outweigh any disadvantages.</p>
 244 </div>
 245
 246 <h3><a name="authentic-pixels"></a>Access the Pixel Cache</h3>
 247 <div class="doc-section">
 248
 249 <p>Once the pixel cache is associated with an image, you typically want to get, update, or put pixels into it.  We refer to pixels inside the image region as <em>authentic pixels</em> and outside the region as <em>virtual pixels</em>.  Use these methods to access the pixels in the cache:</p>
 250 <ul>
 251   <li><a href="../www/api/cache.html#GetVirtualPixels">GetVirtualPixels()</a> gets pixels that you do not intend to modify</li>
 252   <li><a href="../www/api/cache.html#GetAuthenticPixels">GetAuthenticPixels()</a> gets pixels that you intend to modify</li>
 253   <li><a href="../www/api/cache.html#QueueAuthenticPixels">QueueAuthenticPixels()</a> queue pixels that you intend to modify</li>
 254   <li><a href="../www/api/cache.html#SyncAuthenticPixels">SyncAuthenticPixels()</a> update the pixel cache with any modified pixels</li>
 255 </ul>
 256
 257 <p>Here is a typical <a href="../www/magick-core.html">MagickCore</a> code snippet for manipulating pixels in the pixel cache.  In our example, we copy pixels from the input image to the output image and decrease the intensity by 10%:</p>
 258
 259 <div class="viewport">
 260 <pre class="code">
 261   long
 262     x,
 263     y;
 264
 265   const PixelPacket
 266     *p;
 267
 268   PixelPacket
 269     *q;
 270
 271   destination=CloneImage(source,source->columns,source->rows,MagickTrue,exception);
 272   if (destination  == (Image *) NULL)
 273     { /* an exception was thrown */ }
 274   for (y=0; y &lt; (long) source-&gt;rows; y++)
 275   {
 276     p=GetVirtualPixels(source,0,y,source-&gt;columns,1,exception);
 277     q=GetAuthenticPixels(destination,0,y,destination-&gt;columns,1,exception);
 278     if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL)
 279       break;
 280     for (x=0; x &lt; (long) source-&gt;columns; x++)
 281     {
 282       q-&gt;red=90*p-&gt;red/100;
 283       q-&gt;green=90*p-&gt;green/100;
 284       q-&gt;blue=90*p-&gt;blue/100;
 285       q-&gt;opacity=90*p-&gt;opacity/100;
 286       p++;
 287       q++;
 288     }
 289     if (SyncAuthenticPixels(destination,exception) == MagickFalse)
 290       break;
 291   }
 292   if (y &lt; (long) source-&gt;rows)
 293     { /* an exception was thrown */ }
 294 </pre>
 295 </div>
 296
 297 <p>When we first create the destination image by cloning the source image, the pixel cache pixels are not copied.  They are only copied when you signal your intentions to modify the pixel cache by calling <a href="../www/api/cache.html#GetAuthenticPixels">GetAuthenticPixels()</a> or <a href="../www/api/cache.html#QueueAuthenticPixels">QueueAuthenticPixels()</a>. Use <a href="../www/api/cache.html#QueueAuthenticPixels">QueueAuthenticPixels()</a> if you want to set new pixel values rather than update existing ones.  Finally, use <a href="../www/api/cache.html#SyncAuthenticPixels">SyncAuthenticPixels()</a> to ensure any updated pixels are pushed to the pixel cache.</p>
 298
 299 <p>Recall how we mentioned that the indexes of a colormapped image or the black channel of a CMYK image are stored separately.  Use  <a href="../www/api/cache.html#GetVirtualIndexes">GetVirtualIndexes()</a> (to read the indexes) or <a href="../www/api/cache.html#GetAuthenticIndexes">GetAuthenticIndexes()</a> (to update the indexes) to gain access to this channel.  For example, to print the colormap indexes, use:</p>
 300
 301 <pre class="code">
 302   const IndexPacket
 303     *indexes;
 304
 305   for (y=0; y &lt; (long) source-&gt;rows; y++)
 306   {
 307     p=GetVirtualPixels(source,0,y,source-&gt;columns,1);
 308     if (p == (const PixelPacket *) NULL)
 309       break;
 310     indexes=GetVirtualIndexes(source);
 311     for (x=0; x &lt; (long) source-&gt;columns; x++)
 312       (void) printf("%d\n",indexes[x];
 313   }
 314   if (y &lt; (long) source-&gt;rows)
 315     /* an exception was thrown */
 316 </pre>
 317
 318 <p>The pixel cache manager decides whether to give you direct or indirect access to the image pixels.  In some cases the pixels are staged to an intermediate buffer-- and that is why you must call SyncAuthenticPixels() to ensure this buffer is <em>pushed</em> out to the pixel cache to guarantee the corresponding pixels in the cache are updated.  For this reason we recommend that you only read or update a scanline or a few scanlines of pixels at a time.  However, you can get any rectangular region of pixels you want.  GetAuthenticPixels() requires that the region you request is within the bounds of the image area.  For a 640 by 480 image, you can get a scanline of 640 pixels at row 479 but if you ask for a scanline at row 480, an exception is returned (rows are numbered starting at 0).  GetVirtualPixels() does not have this constraint.  For example,</p>
 319
 320 <pre class="code">
 321   p=GetVirtualPixels(source,-3,3,source-&gt;columns+7,7,exception);
 322 </pre>
 323
 324 <p>gives you the pixels you asked for without complaint, even though some are not within the confines of the image region.</p>
 325 </div>
 326
 327 <h3><a name="virtual-pixels"></a>Virtual Pixels</h3>
 328 <div class="doc-section">
 329
 330  <p>Access to the virtual pixels are controlled by the <a href="../www/api/cache.html#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod()</a> method from the MagickCore API or the <a href="../www/command-line-options.html#virtual-pixel">&#x2011;virtual&#x2011;pixel</a> option from the command line.  The methods include:</p>
 331
 332 <pre class="text">
 333   background:           the area surrounding the image is the background color
 334   black:                the area surrounding the image is black
 335   checker-tile:         alternate squares with image and background color
 336   dither:               non-random 32x32 dithered pattern
 337   edge:                 extend the edge pixel toward infinity
 338   gray:                 the area surrounding the image is gray
 339   horizontal-tile:      horizontally tile the image, background color above/below
 340   horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
 341   mirror:               mirror tile the image
 342   random:               choose a random pixel from the image
 343   tile:                 tile the image (default)
 344   transparent:          the area surrounding the image is transparent blackness
 345   vertical-tile:        vertically tile the image, sides are background color
 346   vertical-tile-edge:   vertically tile the image and replicate the side edge pixels
 347   white:                the area surrounding the image is white
 348 </pre>
 349
 350 <p>There is a plethora of image processing algorithms that require a neighborhood of pixels about a pixel of interest.  There is typically a caveat concerning how to handle pixels around the image boundaries, known as edge pixels.  With virtual pixels, you do not need to concern yourself about special edge processing other than choosing  which virtual pixel method is most appropriate for your algorithm.</p>
 351 </div>
 352
 353 <h3>Cache Storage and Resource Requirements</h3>
 354 <div class="doc-section">
 355
 356 <p>Recall that this simple and elegant design of the ImageMagick pixel cache comes at a cost in terms of storage and processing speed.  The pixel cache storage requirements scales with the area of the image and the bit depth of the pixel components.  For example, if we have a 640 by 480 image and we are using the Q16 version of ImageMagick, the pixel cache consumes image <em>width * height * bit-depth / 8 * channels</em> bytes or approximately 2.3 mebibytes (i.e. 640 * 480 * 2 * 4).  Not too bad, but what if your image is 25000 by 25000 pixels?  The pixel cache requires approximately 4.7 gibibytes of storage.  Ouch.  ImageMagick accounts for possible huge storage requirements by caching large images to disk rather than memory.  Typically the pixel cache is stored in memory using heap memory. If heap memory is exhausted, pixels are stored in in an anonymous map; if the anonymous memory map is exhausted, we create the pixel cache on disk and attempt to memory-map it; and if memory-map memory is exhausted, we simply use standard disk I/O.  Disk storage is cheap but it is also very slow, upwards of 1000 times slower than memory.  We can get some speed improvements, up to 5 times, if we use memory mapping to the disk-based cache.  These decisions about storage are made <em>automagically</em> by the pixel cache manager negotiating with the operating system.  However, you can influence how the pixel cache manager allocates the pixel cache with <em>cache resource limits</em>.  The limits include:</p>
 357
 358 <dl class="doc">
 359   <dt class="doc">files</dt>
 360   <dd>maximum number of open pixel cache files.  When this limit is exceeded, any subsequent pixels cached to disk are closed and reopened on demand. This behavior permits a large number of images to be accessed simultaneously on disk, but with a speed penalty due to repeated open/close calls.</dd>
 361   <dt class="doc">area</dt>
 362   <dd>maximum area in bytes of any one image that can reside in the pixel cache memory.  If this limit is exceeded, the image is automagically cached to disk.</dd>
 363   <dt class="doc">memory</dt>
 364   <dd>maximum amount of memory in bytes to allocate for the pixel cache from the anonymous mapped memory or the heap.</dd>
 365   <dt class="doc">map</dt>
 366   <dd>maximum amount of memory map in bytes to allocate for the pixel cache.</dd>
 367   <dt class="doc">disk</dt>
 368   <dd>maximum amount of disk space in bytes permitted for use by the pixel cache.  If this limit is exceeded, the pixel cache is not created and a fatal exception is thrown.</dd>
 369 </dl>
 370
 371 <p>To determine the current setting of these limits, use this command:</p>
 372
 373 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list resource</span><span class='crtout'><pre>File         Area       Memory          Map         Disk    Thread         Time
 374 -------------------------------------------------------------------------------
 375  768     12.443GB    8.6917GiB    23.178GiB  18.446744EB         8    unlimited</pre></span></p>
 376 <p>You can set these limits either with  <a href="../www/resources.html#environment">environment variables</a>, the <a href="../www/command-line-options.html#limit">-limit</a> command line option, or the <a href="../www/api/resource.html#SetMagickResourceLimit">SetMagickResourceLimit()</a> MagickCore API method. As an example, our online web interface to ImageMagick, <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">ImageMagick Studio</a>, has an area limit of 64 megabytes, a memory limit of 128 mebibytes and a map limit of 256 mebibytes and a disk limit of 1 gigabytes.  Since we process multiple simultaneous sessions, we don't want any one session consuming all the available memory.  Instead large images are cached to disk.  If the image is too large and exceeds the pixel cache disk limit, the program exits.  In addition, we place a 60 second time limit to prevent any run-away processing tasks.</p>
 377
 378 <p>Note, the cache limits are global, meaning if you create several images, the combined resource requirements are compared to the limit to determine the pixel cache storage disposition.</p>
 379 </div>
 380
 381 <h3>Cache Views</h3>
 382 <div class="doc-section">
 383
 384 <p>GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels(), and SyncAuthenticPixels() from the MagickCore API can only deal with one pixel cache area per image at a time.  Suppose you want to access the first and last scanline from the same image at the same time?  The solution is to use a <em>cache view</em>.  A cache view permits you to access as many areas simultaneously in the pixel cache as you require.  The cache view <a href="../www/api/cache-view.html">methods</a> behave like the previous methods except you must first open a view and close it when you are finished with it. Here is a snippet of MagickCore code that permits us to access two areas of an image simultaneously:</p>
 385
 386 <pre class="code">
 387   CacheView
 388     *view_1,
 389     *view_2;
 390
 391   view_1=OpenCacheView(source);
 392   view_2=OpenCacheView(source);
 393   for (y=0; y &lt; (long) source-&gt;rows; y++)
 394   {
 395     u=GetCacheViewVirtualPixels(view_1,0,y,source-&gt;columns,1,exception);
 396     v=GetCacheViewVirtualPixels(view_2,0,source-&gt;rows-y-1,source-&gt;columns,1,exception);
 397     if ((u == (const PixelPacket *) NULL) || (v == (const PixelPacket *) NULL))
 398       break;
 399     for (x=0; x &lt; (long) source-&gt;columns; x++)
 400     {
 401       /* do something with u &amp; v here */
 402     }
 403   }
 404   view_1=CloseCacheView(view_1);
 405   view_2=CloseCacheView(view_2);
 406   if (y &lt; (long) source-&gt;rows)
 407     { /* an exception was thrown */ }
 408 </pre>
 409 </div>
 410
 411 <h3>Magick Persistent Cache Format</h3>
 412 <div class="doc-section">
 413
 414 <p>Recall that each image format is decoded by ImageMagick and the pixels are deposited in the pixel cache.  If you write an image, the pixels are read from the pixel cache and encoded as required by the format you are writing (e.g. GIF, PNG, etc.).  The Magick Persistent Cache (MPC) format is designed to eliminate the overhead of decoding and encoding pixels to and from an image format.  MPC writes two files.  One, with the extension <kbd>.mpc</kbd>, retains all the properties associated with the image or image sequence (e.g. width, height, colorspace, etc.) and the second, with the extension <kbd>.cache</kbd>, is the pixel cache in the native raw format.  When reading an MPC image file, ImageMagick reads the image properties and memory maps the pixel cache on disk eliminating the need for decoding the image pixels.  The tradeoff is in disk space.  MPC is generally larger in file size than most other image formats.</p>
 415 </div>
 416
 417 <h3>Best Practices</h3>
 418 <div class="doc-section">
 419
 420 <p>Although you can request any pixel from the pixel cache, any block of pixels, any scanline, multiple scanlines, any row, or multiple rows with the GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels, GetCacheViewVirtualPixels(), GetCacheViewAuthenticPixels(), and QueueCacheViewAuthenticPixels() methods, ImageMagick is optimized to return a few pixels or a few pixels rows at time.  There are additional optimizations if you request a single scanline or a few scanlines at a time.  These methods also permit random access to the pixel cache, however, ImageMagick is optimized for sequential access.</p>
 421
 422 <p>If you update pixels returned from GetAuthenticPixels() or GetCacheViewAuthenticPixels(), don't forget to call SyncAuthenticPixels() or SyncCacheViewAuthenticPixels() respectively to ensure your changes are synchronized with the pixel cache.</p>
 423
 424 <p>Use QueueAuthenticPixels() or QueueCacheViewAuthenticPixels() if you are setting an initial pixel value.  The GetAuthenticPixels() or GetCacheViewAuthenticPixels() method reads pixels from the cache and if you are setting an initial pixel value, this read is unnecessary. Don't forget to call SyncAuthenticPixels() or SyncCacheViewAuthenticPixels() respectively to push your updates to the pixel cache.</p>
 425
 426 <p>GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels(), and SyncAuthenticPixels() are slightly more efficient than their cache view counter-parts.  However, cache views are required if you need access to more than one region of the image simultaneously or if more than one <a href="#threads">thread of execution</a> is accessing the image.</p>
 427
 428 <p>You can request pixels outside the bounds of the image with GetVirtualPixels() or GetCacheViewVirtualPixels(), however, it is more efficient to request pixels within the confines of the image region.</p>
 429
 430 <p>Although you can force the pixel cache to disk using appropriate resource limits, disk access can be upwards of 1000 times slower than memory access.  For fast, efficient, access to the pixel cache, try to keep the pixel cache in heap memory or anonymous mapped memory.</p>
 431
 432 <p>The ImageMagick Q16 version of ImageMagick permits you to read and write 16 bit images without scaling but the pixel cache consumes twice as much resources as the Q8 version.  If your system has constrained memory or disk resources, consider the Q8 version of ImageMagick.  In addition, the Q8 version typically executes faster than the Q16 version.</p>
 433
 434 <p>A great majority of image formats and algorithms restrict themselves to a fixed range of pixel values from 0 to some maximum value, for example, the Q16 version of ImageMagick permit intensities from 0 to 65535.  High dynamic-range imaging (HDRI), however, permits a far greater dynamic range of exposures (i.e. a large difference between light and dark areas) than standard digital imaging techniques. HDRI accurately represents the wide range of intensity levels found in real scenes ranging from the brightest direct sunlight to the deepest darkest shadows.  Enable <a href="../www/high-dynamic-range.html">HDRI</a> at ImageMagick build time to deal with high dynamic-range images, but be mindful that each pixel component is a 32-bit floating point value. In addition, pixel values are not clamped by default so some algorithms may perform differently than the non-HDRI version.</p>
 435
 436 <p>If you are dealing with large images, make sure the pixel cache is written to a disk area with plenty of free space.  Under Unix, this is typically <kbd>/tmp</kbd> and for Windows, <kbd>c:/temp</kbd>.  You can tell ImageMagick to write the pixel cache to an alternate location with the MAGICK_TEMPORARY_PATH environment variable.  For example,</p>
 437
 438 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>export MAGICK_TEMPORARY_PATH=/data/magick</span></p>
 439
 440 <p>If you plan on processing the same image many times, consider the MPC format.  Reading a MPC image has near-zero overhead because its in the native pixel cache format eliminating the need for decoding the image pixels.  Here is an example:</p>
 441
 442 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.tif image.mpc</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.mpc -crop 100x100+0+0 +repage 1.png</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.mpc -crop 100x100+100+0 +repage 2.png</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.mpc -crop 100x100+200+0 +repage 3.png</span></p>
 443 <p>MPC is ideal for web sites.  It reduces the overhead of reading and writing an image.  We use it exclusively at our <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">online image studio</a>.</p>
 444 </div>
 445
 446 </div>
 447
 448 <h2><a name="stream"></a>Streaming Pixels</h2>
 449 <div class="doc-section">
 450
 451 <p>ImageMagick provides for streaming pixels as they are read from or written to an image.  This has several advantages over the pixel cache.  The time and resources consumed by the pixel cache scale with the area of an image, whereas the pixel stream resources scale with the width of an image.  The disadvantage is the pixels must be consumed as they are streamed so there is no persistence.</p>
 452
 453 <p>Use <a href="../www/api/stream.html#ReadStream">ReadStream()</a> or <a href="../www/api/stream.html#WriteStream">WriteStream()</a> with an appropriate callback method in your MagickCore program to consume the pixels as they are streaming.  Here's an abbreviated example of using ReadStream:</p>
 454
 455 <pre class="code">
 456 static size_t StreamHandler(const Image *image,const void *pixels,
 457   const size_t columns)
 458 {
 459   /* process pixels here */
 460   return(columns);
 461 }
 462
 463 ...
 464 /* invoke the pixel stream here */
 465 image=ReadStream(image_info,&amp;StreamHandler,exception);
 466 </pre>
 467
 468 <p>We also provide a lightweight tool, <a name="stream"></a><a href="../www/stream.html">stream</a>, to stream one or more pixel components of the image or portion of the image to your choice of storage formats.  It writes the pixel components as they are read from the input image a row at a time making <a name="stream"></a><a href="../www/stream.html">stream</a> desirable when working with large images or when you require raw pixel components.</p>
 469
 470 </div>
 471
 472 <h2><a name="properties"></a>Image Properties and Profiles</h2>
 473 <div class="doc-section">
 474
 475 <p>Images have metadata associated with them in the form of properties (e.g. width, height, description, etc.) and profiles (e.g. EXIF, IPTC, color management).  ImageMagick provides convenient methods to get, set, or update image properties and get, set, update, or apply profiles.  Some of the more popular image properties are associated with the Image structure in the MagickCore API.  For example:</p>
 476
 477 <pre class="code">
 478   (void) printf("image width: %lu, height: %lu\n",image-&gt;columns,image-&gt;rows);
 479 </pre>
 480
 481 <p>For a great majority of image properties, such as an image comment or description, we use the <a href="../www/api/property.html#GetImageProperty">GetImageProperty()</a> and <a href="../www/api/property.html#SetImageProperty">SetImageProperty()</a> methods.  Here we set a property and fetch it right back:</p>
 482
 483 <pre class="code">
 484   const char
 485     *comment;
 486
 487   (void) SetImageProperty(image,"comment","This space for rent");
 488   comment=GetImageProperty(image,"comment");
 489   if (comment == (const char *) NULL)
 490     (void) printf("Image comment: %s\n",comment);
 491 </pre>
 492
 493 <p>ImageMagick supports artifacts with the GetImageArtifact() and SetImageArtifact() methods.  Artifacts are stealth properties that are not exported to image formats (e.g. PNG) and they do not display when identifying an image.</p>
 494
 495 <p>Image profiles are handled with <a href="../www/api/profile.html#GetImageProfile">GetImageProfile()</a>, <a href="../www/api/profile.html#SetImageProfile">SetImageProfile()</a>, and <a href="../www/api/profile.html#ProfileImage">ProfileImage()</a> methods.  Here we set a profile and fetch it right back:</p>
 496
 497 <pre class="code">
 498   StringInfo
 499     *profile;
 500
 501   profile=AcquireStringInfo(length);
 502   SetStringInfoDatum(profile,my_exif_profile);
 503   (void) SetImageProfile(image,"EXIF",profile);
 504   DestroyStringInfo(profile);
 505   profile=GetImageProfile(image,"EXIF");
 506   if (profile != (StringInfo *) NULL)
 507     (void) PrintStringInfo(stdout,"EXIF",profile);
 508 </pre>
 509
 510 </div>
 511
 512 <h2><a name="tera-pixel"></a>Large Image Support</h2>
 513 <div class="doc-section">
 514 <p>ImageMagick can read, process, or write mega-, giga-, or tera-pixel image sizes.  For example, here we resize an image to a quarter million pixels square:</p>
 515
 516 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -resize 250000x250000 logo.miff</span></p>
 517 <p>For large images, ImageMagick will more than likely create a pixel cache on disk.  Make sure you have plenty of temporary disk space.  If your default temporary disk partition is too small, tell ImageMagick to use another partition with plenty of free space.  For example:</p>
 518
 519 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -define registry:temporary-path=/data/tmp logo:  \ <br/> -resize 250000x250000 logo.miff</span></p>
 520 <p>To ensure large images do not consume all the memory on your system, force the image pixels to memory-mapped disk with resource limits:</p>
 521
 522 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -define registry:temporary-path=/data/tmp -limit memory 16mb  \ <br/> logo: -resize 250000x250000 logo.miff</span></p>
 523 <p>Here we force all image pixels to disk:</p>
 524
 525 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -define registry:temporary-path=/data/tmp -limit area 0  \ <br/> logo: -resize 250000x250000 logo.miff</span></p>
 526 <p>Caching pixels to disk is about 1000 times slower than memory.  Expect long run times when processing large images with ImageMagick.  You can monitor progress with this command:</p>
 527
 528 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -monitor -define registry:temporary-path=/data/tmp -limit area 0  \ <br/> logo: -resize 250000x250000 logo.miff</span></p></div>
 529
 530 <h2><a name="threads"></a>Threads of Execution</h2>
 531 <div class="doc-section">
 532
 533 <p>Many of ImageMagick's internal algorithms are threaded to take advantage of speed-ups offered by the dual and quad-core processor technologies. However, you are welcome to use ImageMagick algorithms in your threads of execution with the exception of the MagickCore's GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels(), or SyncAuthenticPixels() pixel cache methods.  These methods are intended for one thread of execution only. To access the pixel cache with more than one thread of execution, use a cache view.  We do this for the <a href="../www/api/composite.html#CompositeImage">CompositeImage()</a> method, for example.  Suppose we want to composite a single image over a different image in each thread of execution.  If we use GetVirtualPixels(), the results are unpredictable because multiple threads would likely be asking for different areas of the pixel cache simultaneously.  Instead we use GetCacheViewVirtualPixels() which creates a unique view for each thread of execution ensuring our program behaves properly regardless of how many threads are invoked.  The other program interfaces, such as the <a href="../www/magick-wand.html">MagickWand API</a>, are completely thread safe so there are no special precautions for threads of execution.</p>
 534
 535 <p>Here is an example of how ImageMagick can take advantage of threads of execution with the <a href="http://en.wikipedia.org/wiki/OpenMP">OpenMP</a> programming paradigm:</p>
 536
 537 <div class="viewport">
 538 <pre class="code">
 539 {
 540   CacheView
 541     *image_view;
 542
 543   long
 544     y;
 545
 546   MagickBooleanType
 547     status;
 548
 549   status=MagickTrue;
 550   image_view=AcquireCacheView(image);
 551   #pragma omp parallel for schedule(dynamic,4) shared(status)
 552   for (y=0; y &lt; (long) image-&gt;rows; y++)
 553   {
 554     register IndexPacket
 555       *indexes;
 556
 557     register long
 558       x;
 559
 560     register PixelPacket
 561       *q;
 562
 563     if (status == MagickFalse)
 564       continue;
 565     q=GetCacheViewAuthenticPixels(image_view,0,y,image-&gt;columns,1,exception);
 566     if (q == (PixelPacket *) NULL)
 567       {
 568         status=MagickFalse;
 569         continue;
 570       }
 571     indexes=GetCacheViewAuthenticIndexQueue(image_view);
 572     for (x=0; x &lt; (long) image-&gt;columns; x++)
 573     {
 574       q-&gt;red= ...
 575       q-&gt;green= ...
 576       q-&gt;blue= ...
 577       q-&gt;opacity= ...
 578       if (indexes != (IndexPacket *) NULL)
 579         indexes[x]= ...
 580       q++;
 581     }
 582     if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
 583       status=MagickFalse;
 584   }
 585   image_view=DestroyCacheView(image_view);
 586   if (status == MagickFalse)
 587     perror("something went wrong");
 588 }
 589 </pre>
 590 </div>
 591
 592 <p>If you call the ImageMagick API from your OpenMP-enabled application and you intend to dynamically increase the number of threads available in subsequent parallel regions, be sure to perform the increase <em>before</em> you call the API otherwise ImageMagick may fault.</p>
 593
 594 </div>
 595
 596 <h2><a name="distributed"></a>Heterogeneous Distributed Processing</h2>
 597 <div class="doc-section">
 598 <p>ImageMagick includes support for heterogeneous distributed processing with the <a href="http://en.wikipedia.org/wiki/OpenCL">OpenCL</a> framework.  OpenCL kernels within ImageMagick permit image processing algorithms to execute across heterogeneous platforms consisting of CPUs, GPUs, and other processors.  Depending on your platform, speed-ups can be an order of magnitude faster than the traditional single CPU.</p>
 599
 600 <p>First verify that your version of ImageMagick includes support for the OpenCL feature:</p>
 601
 602 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -version</span><span class='crtout'>Features: OpenMP OpenCL</span></p>
 603 <p>If so, run this command to realize a significant speed-up for image convolution:</p>
 604
 605 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png convolve '-1, -1, -1, -1, 9, -1, -1, -1, -1'  \ <br/> convolve.png</span></p>
 606 <p>If an accelerator is not available or if the accelerator fails to respond, ImageMagick reverts to the non-accelerated convolution algorithm.</p>
 607
 608 <p>Here is an example OpenCL kernel that convolves an image:</p>
 609
 610 <div class="viewport">
 611 <pre class="code">
 612 static inline long ClampToCanvas(const long offset,const ulong range)
 613 {
 614   if (offset &lt; 0L)
 615     return(0L);
 616   if (offset >= range)
 617     return((long) (range-1L));
 618   return(offset);
 619 }
 620
 621 static inline CLQuantum ClampToQuantum(const double value)
 622 {
 623   if (value &lt; 0.0)
 624     return((CLQuantum) 0);
 625   if (value >= (double) QuantumRange)
 626     return((CLQuantum) QuantumRange);
 627   return((CLQuantum) (value+0.5));
 628 }
 629
 630 __kernel void Convolve(const __global CLPixelType *source,__constant double *filter,
 631   const ulong width,const ulong height,__global CLPixelType *destination)
 632 {
 633   const ulong columns = get_global_size(0);
 634   const ulong rows = get_global_size(1);
 635
 636   const long x = get_global_id(0);
 637   const long y = get_global_id(1);
 638
 639   const double scale = (1.0/QuantumRange);
 640   const long mid_width = (width-1)/2;
 641   const long mid_height = (height-1)/2;
 642   double4 sum = { 0.0, 0.0, 0.0, 0.0 };
 643   double gamma = 0.0;
 644   register ulong i = 0;
 645
 646   for (long v=(-mid_height); v &lt;= mid_height; v++)
 647   {
 648     for (long u=(-mid_width); u &lt;= mid_width; u++)
 649     {
 650       register const ulong index=ClampToCanvas(y+v,rows)*columns+ClampToCanvas(x+u,columns);
 651       const double alpha=scale*(QuantumRange-source[index].w);
 652       sum.x+=alpha*filter[i]*source[index].x;
 653       sum.y+=alpha*filter[i]*source[index].y;
 654       sum.z+=alpha*filter[i]*source[index].z;
 655       sum.w+=filter[i]*source[index].w;
 656       gamma+=alpha*filter[i];
 657       i++;
 658     }
 659   }
 660
 661   gamma=1.0/(fabs(gamma) &lt;= MagickEpsilon ? 1.0 : gamma);
 662   const ulong index=y*columns+x;
 663   destination[index].x=ClampToQuantum(gamma*sum.x);
 664   destination[index].y=ClampToQuantum(gamma*sum.y);
 665   destination[index].z=ClampToQuantum(gamma*sum.z);
 666   destination[index].w=ClampToQuantum(sum.w);
 667 };
 668 </pre>
 669 </div>
 670
 671 <p>See <a href="http://trac.imagemagick.org/browser/ImageMagick/trunk/magick/accelerate.c">magick/accelerate.c</a> for a complete implementation of image convolution with an OpenCL kernel.</p>
 672
 673 </div>
 674
 675 <h2><a name="coders"></a>Custom Image Coders</h2>
 676 <div class="doc-section">
 677
 678 <p>An image coder (i.e. encoder / decoder) is responsible for registering, optionally classifying, optionally reading, optionally writing, and unregistering one image format (e.g.  PNG, GIF, JPEG, etc.).  Registering an image coder alerts ImageMagick a particular format is available to read or write.  While unregistering tells ImageMagick the format is no longer available.  The classifying method looks at the first few bytes of an image and determines if the image is in the expected format.  The reader sets the image size, colorspace, and other properties and loads the pixel cache with the pixels.  The reader returns a single image or an image sequence (if the format supports multiple images per file), or if an error occurs, an exception and a null image.  The writer does the reverse.  It takes the image properties and unloads the pixel cache and writes them as required by the image format.</p>
 679
 680 <p>Here is a listing of a sample <a href="../www/source/mgk.c">custom coder</a>.  It reads and writes images in the MGK image format which is simply an ID followed by the image width and height followed by the RGB pixel values.</p>
 681
 682 <div class="viewport">
 683 <pre class="code">
 684 /*
 685   Include declarations.
 686 */
 687 #include "magick/studio.h"
 688 #include "magick/blob.h"
 689 #include "magick/blob-private.h"
 690 #include "magick/colorspace.h"
 691 #include "magick/exception.h"
 692 #include "magick/exception-private.h"
 693 #include "magick/image.h"
 694 #include "magick/image-private.h"
 695 #include "magick/list.h"
 696 #include "magick/magick.h"
 697 #include "magick/memory_.h"
 698 #include "magick/monitor.h"
 699 #include "magick/monitor-private.h"
 700 #include "magick/quantum-private.h"
 701 #include "magick/static.h"
 702 #include "magick/string_.h"
 703 #include "magick/module.h"
 704
 705 /*
 706   Forward declarations.
 707 */
 708 static MagickBooleanType
 709   WriteMGKImage(const ImageInfo *,Image *);
 710
 711 /*
 712 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 713 %                                                                             %
 714 %                                                                             %
 715 %                                                                             %
 716 %   I s M G K                                                                 %
 717 %                                                                             %
 718 %                                                                             %
 719 %                                                                             %
 720 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 721 %
 722 %  IsMGK() returns MagickTrue if the image format type, identified by the
 723 %  magick string, is MGK.
 724 %
 725 %  The format of the IsMGK method is:
 726 %
 727 %      MagickBooleanType IsMGK(const unsigned char *magick,const size_t length)
 728 %
 729 %  A description of each parameter follows:
 730 %
 731 %    o magick: This string is generally the first few bytes of an image file
 732 %      or blob.
 733 %
 734 %    o length: Specifies the length of the magick string.
 735 %
 736 */
 737 static MagickBooleanType IsMGK(const unsigned char *magick,const size_t length)
 738 {
 739   if (length &lt; 7)
 740     return(MagickFalse);
 741   if (LocaleNCompare((char *) magick,"id=mgk",7) == 0)
 742     return(MagickTrue);
 743   return(MagickFalse);
 744 }
 745
 746 /*
 747 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 748 %                                                                             %
 749 %                                                                             %
 750 %                                                                             %
 751 %   R e a d M G K I m a g e                                                   %
 752 %                                                                             %
 753 %                                                                             %
 754 %                                                                             %
 755 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 756 %
 757 %  ReadMGKImage() reads a MGK image file and returns it.  It allocates
 758 %  the memory necessary for the new Image structure and returns a pointer to
 759 %  the new image.
 760 %
 761 %  The format of the ReadMGKImage method is:
 762 %
 763 %      Image *ReadMGKImage(const ImageInfo *image_info,ExceptionInfo *exception)
 764 %
 765 %  A description of each parameter follows:
 766 %
 767 %    o image_info: the image info.
 768 %
 769 %    o exception: return any errors or warnings in this structure.
 770 %
 771 */
 772 static Image *ReadMGKImage(const ImageInfo *image_info,
 773   ExceptionInfo *exception)
 774 {
 775   char
 776     buffer[MaxTextExtent];
 777
 778   Image
 779     *image;
 780
 781   long
 782     y;
 783
 784   MagickBooleanType
 785     status;
 786
 787   register long
 788     x;
 789
 790   register PixelPacket
 791     *q;
 792
 793   register unsigned char
 794     *p;
 795
 796   ssize_t
 797     count;
 798
 799   unsigned char
 800     *pixels;
 801
 802   unsigned long
 803     columns,
 804     rows;
 805
 806   /*
 807     Open image file.
 808   */
 809   assert(image_info != (const ImageInfo *) NULL);
 810   assert(image_info-&gt;signature == MagickSignature);
 811   if (image_info-&gt;debug != MagickFalse)
 812     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image_info-&gt;filename);
 813   assert(exception != (ExceptionInfo *) NULL);
 814   assert(exception-&gt;signature == MagickSignature);
 815   image=AcquireImage(image_info);
 816   status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
 817   if (status == MagickFalse)
 818     {
 819       image=DestroyImageList(image);
 820       return((Image *) NULL);
 821     }
 822   /*
 823     Read MGK image.
 824   */
 825   (void) ReadBlobString(image,buffer);  /* read magic number */
 826   if (IsMGK(buffer,7) == MagickFalse)
 827     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
 828   (void) ReadBlobString(image,buffer);
 829   count=(ssize_t) sscanf(buffer,"%lu %lu\n",&amp;columns,&amp;rows);
 830   if (count &lt;= 0)
 831     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
 832   do
 833   {
 834     /*
 835       Initialize image structure.
 836     */
 837     image-&gt;columns=columns;
 838     image-&gt;rows=rows;
 839     image-&gt;depth=8;
 840     if ((image_info-&gt;ping != MagickFalse) &amp;&amp; (image_info-&gt;number_scenes != 0))
 841       if (image-&gt;scene >= (image_info-&gt;scene+image_info-&gt;number_scenes-1))
 842         break;
 843     /*
 844       Convert MGK raster image to pixel packets.
 845     */
 846     if (SetImageExtent(image,0,0) == MagickFalse)
 847       {
 848         InheritException(exception,&amp;image-&gt;exception);
 849         return(DestroyImageList(image));
 850       }
 851     pixels=(unsigned char *) AcquireQuantumMemory((size_t) image-&gt;columns,3UL*sizeof(*pixels));
 852     if (pixels == (unsigned char *) NULL)
 853       ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
 854     for (y=0; y &lt; (long) image-&gt;rows; y++)
 855     {
 856       count=(ssize_t) ReadBlob(image,(size_t) (3*image-&gt;columns),pixels);
 857       if (count != (ssize_t) (3*image-&gt;columns))
 858         ThrowReaderException(CorruptImageError,"UnableToReadImageData");
 859       p=pixels;
 860       q=QueueAuthenticPixels(image,0,y,image-&gt;columns,1,exception);
 861       if (q == (PixelPacket *) NULL)
 862         break;
 863       for (x=0; x &lt; (long) image-&gt;columns; x++)
 864       {
 865         q-&gt;red=ScaleCharToQuantum(*p++);
 866         q-&gt;green=ScaleCharToQuantum(*p++);
 867         q-&gt;blue=ScaleCharToQuantum(*p++);
 868         q++;
 869       }
 870       if (SyncAuthenticPixels(image,exception) == MagickFalse)
 871         break;
 872       if ((image-&gt;previous == (Image *) NULL) &&
 873           (SetImageProgress(image,LoadImageTag,y,image&gt;>rows) == MagickFalse))
 874         break;
 875     }
 876     pixels=(unsigned char *) RelinquishMagickMemory(pixels);
 877     if (EOFBlob(image) != MagickFalse)
 878       {
 879         ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",image-&gt;filename);
 880         break;
 881       }
 882     /*
 883       Proceed to next image.
 884     */
 885     if (image_info-&gt;number_scenes != 0)
 886       if (image-&gt;scene >= (image_info-&gt;scene+image_info-&gt;number_scenes-1))
 887         break;
 888     *buffer='\0';
 889     (void) ReadBlobString(image,buffer);
 890     count=(ssize_t) sscanf(buffer,"%lu %lu\n",&amp;columns,&amp;rows);
 891     if (count != 0)
 892       {
 893         /*
 894           Allocate next image structure.
 895         */
 896         AcquireNextImage(image_info,image);
 897         if (GetNextImageInList(image) == (Image *) NULL)
 898           {
 899             image=DestroyImageList(image);
 900             return((Image *) NULL);
 901           }
 902         image=SyncNextImageInList(image);
 903         status=SetImageProgress(image,LoadImageTag,TellBlob(image),GetBlobSize(image));
 904         if (status == MagickFalse)
 905           break;
 906       }
 907   } while (count != 0);
 908   (void) CloseBlob(image);
 909   return(GetFirstImageInList(image));
 910 }
 911
 912 /*
 913 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 914 %                                                                             %
 915 %                                                                             %
 916 %                                                                             %
 917 %   R e g i s t e r M G K I m a g e                                           %
 918 %                                                                             %
 919 %                                                                             %
 920 %                                                                             %
 921 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 922 %
 923 %  RegisterMGKImage() adds attributes for the MGK image format to
 924 %  the list of supported formats.  The attributes include the image format
 925 %  tag, a method to read and/or write the format, whether the format
 926 %  supports the saving of more than one frame to the same file or blob,
 927 %  whether the format supports native in-memory I/O, and a brief
 928 %  description of the format.
 929 %
 930 %  The format of the RegisterMGKImage method is:
 931 %
 932 %      unsigned long RegisterMGKImage(void)
 933 %
 934 */
 935 ModuleExport unsigned long RegisterMGKImage(void)
 936 {
 937   MagickInfo
 938     *entry;
 939
 940   entry=SetMagickInfo("MGK");
 941   entry-&gt;decoder=(DecodeImageHandler *) ReadMGKImage;
 942   entry-&gt;encoder=(EncodeImageHandler *) WriteMGKImage;
 943   entry-&gt;magick=(IsImageFormatHandler *) IsMGK;
 944   entry-&gt;description=ConstantString("MGK");
 945   entry-&gt;module=ConstantString("MGK");
 946   (void) RegisterMagickInfo(entry);
 947   return(MagickImageCoderSignature);
 948 }
 949
 950 /*
 951 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 952 %                                                                             %
 953 %                                                                             %
 954 %                                                                             %
 955 %   U n r e g i s t e r M G K I m a g e                                       %
 956 %                                                                             %
 957 %                                                                             %
 958 %                                                                             %
 959 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 960 %
 961 %  UnregisterMGKImage() removes format registrations made by the
 962 %  MGK module from the list of supported formats.
 963 %
 964 %  The format of the UnregisterMGKImage method is:
 965 %
 966 %      UnregisterMGKImage(void)
 967 %
 968 */
 969 ModuleExport void UnregisterMGKImage(void)
 970 {
 971   (void) UnregisterMagickInfo("MGK");
 972 }
 973
 974 /*
 975 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 976 %                                                                             %
 977 %                                                                             %
 978 %                                                                             %
 979 %   W r i t e M G K I m a g e                                                 %
 980 %                                                                             %
 981 %                                                                             %
 982 %                                                                             %
 983 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 984 %
 985 %  WriteMGKImage() writes an image to a file in red, green, and blue
 986 %  MGK rasterfile format.
 987 %
 988 %  The format of the WriteMGKImage method is:
 989 %
 990 %      MagickBooleanType WriteMGKImage(const ImageInfo *image_info,Image *image)
 991 %
 992 %  A description of each parameter follows.
 993 %
 994 %    o image_info: the image info.
 995 %
 996 %    o image:  The image.
 997 %
 998 */
 999 static MagickBooleanType WriteMGKImage(const ImageInfo *image_info,Image *image)
1000 {
1001   char
1002     buffer[MaxTextExtent];
1003
1004   long
1005     y;
1006
1007   MagickBooleanType
1008     status;
1009
1010   MagickOffsetType
1011     scene;
1012
1013   register const PixelPacket
1014     *p;
1015
1016   register long
1017     x;
1018
1019   register unsigned char
1020     *q;
1021
1022   unsigned char
1023     *pixels;
1024
1025   /*
1026     Open output image file.
1027   */
1028   assert(image_info != (const ImageInfo *) NULL);
1029   assert(image_info-&gt;signature == MagickSignature);
1030   assert(image != (Image *) NULL);
1031   assert(image-&gt;signature == MagickSignature);
1032   if (image-&gt;debug != MagickFalse)
1033     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image-&gt;filename);
1034   status=OpenBlob(image_info,image,WriteBinaryBlobMode,&amp;image-&gt;exception);
1035   if (status == MagickFalse)
1036     return(status);
1037   scene=0;
1038   do
1039   {
1040     /*
1041       Allocate memory for pixels.
1042     */
1043     if (image-&gt;colorspace != RGBColorspace)
1044       (void) SetImageColorspace(image,RGBColorspace);
1045     pixels=(unsigned char *) AcquireQuantumMemory((size_t) image-&gt;columns,
1046       3UL*sizeof(*pixels));
1047     if (pixels == (unsigned char *) NULL)
1048       ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
1049     /*
1050       Initialize raster file header.
1051     */
1052     (void) WriteBlobString(image,"id=mgk\n");
1053     (void) FormatMagickString(buffer,MaxTextExtent,"%lu %lu\n",
1054       image-&gt;columns,image-&gt;rows);
1055     (void) WriteBlobString(image,buffer);
1056     for (y=0; y &lt; (long) image-&gt;rows; y++)
1057     {
1058       p=GetVirtualPixels(image,0,y,image-&gt;columns,1,&amp;image-&gt;exception);
1059       if (p == (const PixelPacket *) NULL)
1060         break;
1061       q=pixels;
1062       for (x=0; x &lt; (long) image-&gt;columns; x++)
1063       {
1064         *q++=ScaleQuantumToChar(p-&gt;red);
1065         *q++=ScaleQuantumToChar(p-&gt;green);
1066         *q++=ScaleQuantumToChar(p-&gt;blue);
1067         p++;
1068       }
1069       (void) WriteBlob(image,(size_t) (q-pixels),pixels);
1070       if ((image-&gt;previous == (Image *) NULL) &&
1071           (SetImageProgress(image,SaveImageTag,y,image-&gt;rows) == MagickFalse))
1072         break;
1073     }
1074     pixels=(unsigned char *) RelinquishMagickMemory(pixels);
1075     if (GetNextImageInList(image) == (Image *) NULL)
1076       break;
1077     image=SyncNextImageInList(image);
1078     status=SetImageProgress(image,SaveImagesTag,scene,
1079       GetImageListLength(image));
1080     if (status == MagickFalse)
1081       break;
1082     scene++;
1083   } while (image_info-&gt;adjoin != MagickFalse);
1084   (void) CloseBlob(image);
1085   return(MagickTrue);
1086 }
1087 </pre>
1088 </div>
1089
1090 <p>To invoke the custom coder from the command line, use these commands:</p>
1091
1092 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: logo.mgk</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>display logo.mgk</span></p>
1093 <p>We provide the <a href="ftp://ftp.imagemagick.org/pub/ImageMagick/kits/MagickCoderKit-1.0.0.tar.gz">Magick Coder Kit</a> to help you get started writing your own custom coder.</p>
1094
1095 </div>
1096
1097 <h2><a name="filters"></a>Custom Image Filters</h2>
1098 <div class="doc-section">
1099
1100 <p>ImageMagick provides a convenient mechanism for adding your own custom image processing algorithms.  We call these image filters and they are invoked from the command line with the <a href="../www/command-line-options.html#process">-process</a> option or from the MagickCore API method <a href="../www/api/module.html#ExecuteModuleProcess">ExecuteModuleProcess()</a>.</p>
1101
1102 <p>Here is a listing of a sample <a href="../www/source/analyze.c">custom image filter</a>.  It computes a few statistics such as the pixel brightness and saturation mean and standard-deviation.</p>
1103
1104 <div class="viewport">
1105 <pre class="code">
1106 #include &lt;stdio.h&gt;
1107 #include &lt;stdlib.h&gt;
1108 #include &lt;string.h&gt;
1109 #include &lt;time.h&gt;
1110 #include &lt;assert.h&gt;
1111 #include &lt;math.h&gt;
1112 #include "magick/MagickCore.h"
1113 \f
1114 /*
1115 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1116 %                                                                             %
1117 %                                                                             %
1118 %                                                                             %
1119 %   a n a l y z e I m a g e                                                   %
1120 %                                                                             %
1121 %                                                                             %
1122 %                                                                             %
1123 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1124 %
1125 %  analyzeImage() computes the brightness and saturation mean,  standard
1126 %  deviation, kurtosis and skewness and stores these values as attributes
1127 %  of the image.
1128 %
1129 %  The format of the analyzeImage method is:
1130 %
1131 %      unsigned long analyzeImage(Image *images,const int argc,
1132 %        char **argv,ExceptionInfo *exception)
1133 %
1134 %  A description of each parameter follows:
1135 %
1136 %    o image: the address of a structure of type Image.
1137 %
1138 %    o argc: Specifies a pointer to an integer describing the number of
1139 %      elements in the argument vector.
1140 %
1141 %    o argv: Specifies a pointer to a text array containing the command line
1142 %      arguments.
1143 %
1144 %    o exception: return any errors or warnings in this structure.
1145 %
1146 */
1147 ModuleExport unsigned long analyzeImage(Image **images,const int argc,
1148   const char **argv,ExceptionInfo *exception)
1149 {
1150   char
1151     text[MaxTextExtent];
1152
1153   double
1154     area,
1155     brightness,
1156     brightness_mean,
1157     brightness_standard_deviation,
1158     brightness_kurtosis,
1159     brightness_skewness,
1160     brightness_sum_x,
1161     brightness_sum_x2,
1162     brightness_sum_x3,
1163     brightness_sum_x4,
1164     hue,
1165     saturation,
1166     saturation_mean,
1167     saturation_standard_deviation,
1168     saturation_kurtosis,
1169     saturation_skewness,
1170     saturation_sum_x,
1171     saturation_sum_x2,
1172     saturation_sum_x3,
1173     saturation_sum_x4;
1174
1175   Image
1176     *image;
1177
1178   assert(images != (Image **) NULL);
1179   assert(*images != (Image *) NULL);
1180   assert((*images)-&gt;signature == MagickSignature);
1181   (void) argc;
1182   (void) argv;
1183   image=(*images);
1184   for ( ; image != (Image *) NULL; image=GetNextImageInList(image))
1185   {
1186     CacheView
1187       *image_view;
1188
1189     long
1190       y;
1191
1192     MagickBooleanType
1193       status;
1194
1195     brightness_sum_x=0.0;
1196     brightness_sum_x2=0.0;
1197     brightness_sum_x3=0.0;
1198     brightness_sum_x4=0.0;
1199     brightness_mean=0.0;
1200     brightness_standard_deviation=0.0;
1201     brightness_kurtosis=0.0;
1202     brightness_skewness=0.0;
1203     saturation_sum_x=0.0;
1204     saturation_sum_x2=0.0;
1205     saturation_sum_x3=0.0;
1206     saturation_sum_x4=0.0;
1207     saturation_mean=0.0;
1208     saturation_standard_deviation=0.0;
1209     saturation_kurtosis=0.0;
1210     saturation_skewness=0.0;
1211     area=0.0;
1212     status=MagickTrue;
1213     image_view=AcquireCacheView(image);
1214 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1215     #pragma omp parallel for schedule(dynamic,4) shared(status)
1216 #endif
1217     for (y=0; y &lt; (long) image-&gt;rows; y++)
1218     {
1219       register const PixelPacket
1220         *p;
1221
1222       register long
1223         x;
1224
1225       if (status == MagickFalse)
1226         continue;
1227       p=GetCacheViewVirtualPixels(image_view,0,y,image-&gt;columns,1,exception);
1228       if (p == (const PixelPacket *) NULL)
1229         {
1230           status=MagickFalse;
1231           continue;
1232         }
1233       for (x=0; x &lt; (long) image-&gt;columns; x++)
1234       {
1235         ConvertRGBToHSB(p-&gt;red,p-&gt;green,p-&gt;blue,&amp;hue,&amp;saturation,&amp;brightness);
1236         brightness*=QuantumRange;
1237         brightness_sum_x+=brightness;
1238         brightness_sum_x2+=brightness*brightness;
1239         brightness_sum_x3+=brightness*brightness*brightness;
1240         brightness_sum_x4+=brightness*brightness*brightness*brightness;
1241         saturation*=QuantumRange;
1242         saturation_sum_x+=saturation;
1243         saturation_sum_x2+=saturation*saturation;
1244         saturation_sum_x3+=saturation*saturation*saturation;
1245         saturation_sum_x4+=saturation*saturation*saturation*saturation;
1246         area++;
1247         p++;
1248       }
1249     }
1250     image_view=DestroyCacheView(image_view);
1251     if (area &lt;= 0.0)
1252       break;
1253     brightness_mean=brightness_sum_x/area;
1254     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_mean);
1255     (void) SetImageProperty(image,"filter:brightness:mean",text);
1256     brightness_standard_deviation=sqrt(brightness_sum_x2/area-(brightness_sum_x/
1257       area*brightness_sum_x/area));
1258     (void) FormatMagickString(text,MaxTextExtent,"%g",
1259       brightness_standard_deviation);
1260     (void) SetImageProperty(image,"filter:brightness:standard-deviation",text);
1261     if (brightness_standard_deviation != 0)
1262       brightness_kurtosis=(brightness_sum_x4/area-4.0*brightness_mean*
1263         brightness_sum_x3/area+6.0*brightness_mean*brightness_mean*
1264         brightness_sum_x2/area-3.0*brightness_mean*brightness_mean*
1265         brightness_mean*brightness_mean)/(brightness_standard_deviation*
1266         brightness_standard_deviation*brightness_standard_deviation*
1267         brightness_standard_deviation)-3.0;
1268     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_kurtosis);
1269     (void) SetImageProperty(image,"filter:brightness:kurtosis",text);
1270     if (brightness_standard_deviation != 0)
1271       brightness_skewness=(brightness_sum_x3/area-3.0*brightness_mean*
1272         brightness_sum_x2/area+2.0*brightness_mean*brightness_mean*
1273         brightness_mean)/(brightness_standard_deviation*
1274         brightness_standard_deviation*brightness_standard_deviation);
1275     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_skewness);
1276     (void) SetImageProperty(image,"filter:brightness:skewness",text);
1277     saturation_mean=saturation_sum_x/area;
1278     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_mean);
1279     (void) SetImageProperty(image,"filter:saturation:mean",text);
1280     saturation_standard_deviation=sqrt(saturation_sum_x2/area-(saturation_sum_x/
1281       area*saturation_sum_x/area));
1282     (void) FormatMagickString(text,MaxTextExtent,"%g",
1283       saturation_standard_deviation);
1284     (void) SetImageProperty(image,"filter:saturation:standard-deviation",text);
1285     if (saturation_standard_deviation != 0)
1286       saturation_kurtosis=(saturation_sum_x4/area-4.0*saturation_mean*
1287         saturation_sum_x3/area+6.0*saturation_mean*saturation_mean*
1288         saturation_sum_x2/area-3.0*saturation_mean*saturation_mean*
1289         saturation_mean*saturation_mean)/(saturation_standard_deviation*
1290         saturation_standard_deviation*saturation_standard_deviation*
1291         saturation_standard_deviation)-3.0;
1292     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_kurtosis);
1293     (void) SetImageProperty(image,"filter:saturation:kurtosis",text);
1294     if (saturation_standard_deviation != 0)
1295       saturation_skewness=(saturation_sum_x3/area-3.0*saturation_mean*
1296         saturation_sum_x2/area+2.0*saturation_mean*saturation_mean*
1297         saturation_mean)/(saturation_standard_deviation*
1298         saturation_standard_deviation*saturation_standard_deviation);
1299     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_skewness);
1300     (void) SetImageProperty(image,"filter:saturation:skewness",text);
1301   }
1302   return(MagickImageFilterSignature);
1303 }
1304 </pre>
1305 </div>
1306
1307 <p>To invoke the custom filter from the command line, use this command:</p>
1308
1309 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -process analyze -verbose info:</span><span class='crtout'>Image: logo: <br/>
1310     Format: LOGO (ImageMagick Logo)  <br/>
1311     Class: PseudoClass  <br/>
1312     Geometry: 640x480  <br/>
1313     ...  <br/>
1314     filter:brightness:kurtosis: 8.98864 <br/>
1315     filter:brightness:mean: 238.096 <br/>
1316     filter:brightness:skewness: -3.04519 <br/>
1317     filter:brightness:standard-deviation: 46.3286 <br/>
1318     filter:saturation:kurtosis: 5.9137 <br/>
1319     filter:saturation:mean: 23.4635 <br/>
1320     filter:saturation:skewness: 2.71874 <br/>
1321     filter:saturation:standard-deviation: 64.7734</span></p>
1322
1323 <p>We provide the <a href="ftp://ftp.imagemagick.org/pub/ImageMagick/kits/MagickFilterKit-1.0.0.tar.gz">Magick Filter Kit</a> to help you get started writing your own custom image filter.</p>
1324
1325 </div>
1326 \r
1327 </div>\r
1328 \r
1329 <div id="linkbar">\r
1330  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
1331     <span id="linkbar-center">\r
1332       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
1333     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
1334     </span>\r
1335     <span id="linkbar-east">&nbsp;</span>\r
1336   </div>\r
1337   <div class="footer">\r
1338     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
1339     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
1340   </div>\r
1341   <div style="clear: both; margin: 0; width: 100%; "></div>\r
1342 </body>\r
1343 </html>\r