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   <title>ImageMagick: Architecture</title>
   8   <meta http-equiv="Content-Language" content="en-US"/>
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  10   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  14   <meta name="Generator" content="PHP"/>
  15   <meta name="Keywords" content="architecture, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  16   <meta name="Rating" content="GENERAL"/>
  17   <meta name="Robots" content="INDEX, FOLLOW"/>
  18   <meta name="Generator" content="ImageMagick Studio LLC"/>
  19   <meta name="Author" content="ImageMagick Studio LLC"/>
  20   <meta name="Revisit-after" content="2 DAYS"/>
  21   <meta name="Resource-type" content="document"/>
  22   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../images/wand.png"  sizes="32x32"/>
  25   <link rel="shortcut icon" href="../images/wand.ico"  type="images/x-icon"/>
  26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  27   <style type="text/css" media="all">\r
  28     @import url("../www/magick.css");\r
  29   </style>\r
  30 </head>\r
  31 \r
  32 <body id="www-imagemagick-org">\r
  33 <div class="titlebar">\r
  34 <a href="../index.html">\r
  35   <img src="../images/script.png" alt="[ImageMagick]"\r
  36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  37 <a href="http://www.networkredux.com">\r
  38   <img src="../images/networkredux.png" alt="[sponsor]"\r
  39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  40 <a href="http://www.imagemagick.org/discourse-server/">\r
  41   <img src="../images/logo.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 <a href="../index.html">\r
  44   <img src="../images/sprite.jpg" alt=""\r
  45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  46 </div>\r
  47 \r
  48 <div class="westbar">\r
  49 \r
  50 <div class="menu">
  51   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  52 </div>
  53 <div class="sep"></div>\r
  54 <div class="menu">
  55   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
  62 </div>
  63 <div class="sub">
  64     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
  65 </div>
  66 <div class="sep"></div>\r
  67 <div class="menu">
  68   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  78 </div>
  79 <div class="menu">
  80   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
  93 </div>
  94 <div class="sep"></div>\r
  95 <div  class="menu">
  96    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
 103  </div>
 104 <div class="menu">
 105   <a title="Resources" href="../www/resources.html">Resources</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Architecture" href="../www/architecture.html">Architecture</a>
 109 </div>
 110 <div class="menu">
 111   <a title="Download" href="../www/download.html">Download</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div class="menu">
 119   <a title="Site Map" href="../www/sitemap.html">Site Map</a>
 120 </div>
 121 <div  class="sub">
 122   <a title="Site Map: Links" href="../www/links.html">Links</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126   <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 127
 128 <div class="sponsbox">
 129 <div  class="sponsor">
 130    <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011040100025 gabi.schulze-->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 143 </div>
 144 <div  class="sponsor">
 145   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 146 </div>
 147 <div  class="sponsor">
 148   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 149 </div>
 150 </div>
 151 </div>
 152 </div>\r
 153 \r
 154 <div class="eastbar">\r
 155   <script type="text/javascript">\r
 156   <!--\r
 157     google_ad_client = "pub-3129977114552745";\r
 158     google_ad_slot = "0574824969";\r
 159     google_ad_width = 160;\r
 160     google_ad_height = 600;\r
 161   //-->\r
 162   </script>\r
 163   <script type="text/javascript"\r
 164     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 165   </script>\r
 166 </div>\r
 167 \r
 168 <div class="main">\r
 169 \r
 170 \r
 171 \r
 172 <h1>ImageMagick Architecture</h1>
 173 <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>
 174
 175
 176 <div class="doc-section">
 177 <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>
 178 </div>
 179
 180 <h2><a name="overview"></a>Architecture Overview</h2>
 181 <div class="doc-section">
 182
 183 <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>
 184
 185 <ul>
 186   <li>colorspace (e.g RGB, CMYK, YUV, Lab, etc.)</li>
 187   <li>bit depth (.e.g 1, 4, 8, 12, 16, etc.)</li>
 188   <li>storage format (e.g. unsigned, signed, float, double, etc.)</li>
 189   <li>compression (e.g. uncompressed, RLE, Zip, BZip, etc.)</li>
 190   <li>orientation (i.e. top-to-bottom, right-to-left, etc.),</li>
 191   <li>layout (.e.g. raw, interspersed with opcodes, etc.)</li>
 192 </ul>
 193
 194 <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>
 195
 196 <p>An efficient implementation of an image processing algorithm may require we get or set:</p>
 197
 198 <ul>
 199   <li>one pixel a time (e.g. pixel at location 10,3)</li>
 200   <li>a single scanline (e.g. all pixels from row 4)</li>
 201   <li>a few scanlines at once (e.g. pixel rows 4-7)</li>
 202   <li>a single column or columns of pixels (e.g. all pixels from column 11)</li>
 203   <li>an arbitrary region of pixels from the image (e.g. pixels defined at 10,7 to 10,19)</li>
 204   <li>a pixel in random order (e.g. pixel at 14,15 and 640,480)</li>
 205   <li>pixels from two different images (e.g. pixel at 5,1 from image 1 and pixel at 5,1 from image 2)</li>
 206   <li>pixels outside the boundaries of the image (e.g. pixel at -1,-3)</li>
 207   <li>a pixel component that is unsigned or in a floating-point representation (e.g. 0.17836)</li>
 208   <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>
 209   <li>one or more pixels simultaneously in different threads of execution</li>
 210   <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>
 211 </ul>
 212
 213 <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>
 214
 215 <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>
 216
 217 <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>
 218
 219 <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>
 220
 221 </div>
 222
 223 <h2><a name="cache"></a>The Pixel Cache</h2>
 224 <div class="doc-section">
 225
 226 <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 only when you signal your intention to update any of the pixels.</p>
 227
 228 <h3>Create the Pixel Cache</h3>
 229 <div class="doc-section">
 230
 231 <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>
 232
 233 <h4>Create an image canvas initialized to the background color:</h4>
 234 <p class="code">
 235   image=AllocateImage(image_info);
 236   if (SetImageExtent(image,640,480) == MagickFalse)
 237     { /* an exception was thrown */ }
 238   (void) QueryMagickColor("red",&amp;image-&gt;background_color,&amp;image-&gt;exception);
 239   SetImageBackgroundColor(image);
 240 </p>
 241
 242 <h4>Create an image from a JPEG image on disk:</h4>
 243 <p class="code">  (void) strcpy(image_info-&gt;filename,"image.jpg"):
 244   image=ReadImage(image_info,exception);
 245   if (image == (Image *) NULL)
 246     { /* an exception was thrown */ }
 247 </p>
 248 <h4>Create an image from a memory based image:</h4>
 249 <p class="code">
 250   image=BlobToImage(blob_info,blob,extent,exception);
 251   if (image == (Image *) NULL)
 252     { /* an exception was thrown */ }
 253 </p>
 254
 255 <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>
 256
 257 <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>
 258
 259 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -version</span><span class='crtout'>Version: ImageMagick 6.6.6-7 2010-12-25 Q16 http://www.imagemagick.org</span></p>
 260 <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>
 261 </div>
 262
 263 <h3><a name="authentic-pixels"></a>Access the Pixel Cache</h3>
 264 <div class="doc-section">
 265
 266 <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>
 267 <ul>
 268   <li><a href="../www/api/cache.html#GetVirtualPixels">GetVirtualPixels()</a> gets pixels that you do not intend to modify or pixels that lie outside the image region (e.g. pixel @ -1,-3)</li>
 269   <li><a href="../www/api/cache.html#GetAuthenticPixels">GetAuthenticPixels()</a> gets pixels that you intend to modify</li>
 270   <li><a href="../www/api/cache.html#QueueAuthenticPixels">QueueAuthenticPixels()</a> queue pixels that you intend to modify</li>
 271   <li><a href="../www/api/cache.html#SyncAuthenticPixels">SyncAuthenticPixels()</a> update the pixel cache with any modified pixels</li>
 272 </ul>
 273
 274 <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>
 275
 276 <div class="viewport">
 277 <pre class="code">
 278   const PixelPacket
 279     *p;
 280
 281   PixelPacket
 282     *q;
 283
 284   ssize_t
 285     x,
 286     y;
 287
 288   destination=CloneImage(source,source->columns,source->rows,MagickTrue,
 289     exception);
 290   if (destination  == (Image *) NULL)
 291     { /* an exception was thrown */ }
 292   for (y=0; y &lt; (ssize_t) source-&gt;rows; y++)
 293   {
 294     p=GetVirtualPixels(source,0,y,source-&gt;columns,1,exception);
 295     q=GetAuthenticPixels(destination,0,y,destination-&gt;columns,1,exception);
 296     if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL)
 297       break;
 298     for (x=0; x &lt; (ssize_t) source-&gt;columns; x++)
 299     {
 300       q-&gt;red=90*p-&gt;red/100;
 301       q-&gt;green=90*p-&gt;green/100;
 302       q-&gt;blue=90*p-&gt;blue/100;
 303       q-&gt;opacity=90*p-&gt;opacity/100;
 304       p++;
 305       q++;
 306     }
 307     if (SyncAuthenticPixels(destination,exception) == MagickFalse)
 308       break;
 309   }
 310   if (y &lt; (ssize_t) source-&gt;rows)
 311     { /* an exception was thrown */ }
 312 </pre>
 313 </div>
 314
 315 <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.  You could use GetAuthenticPixels() to set pixel values but it is slightly more efficient to use QueueAuthenticPixels() instead. Finally, use <a href="../www/api/cache.html#SyncAuthenticPixels">SyncAuthenticPixels()</a> to ensure any updated pixels are pushed to the pixel cache.</p>
 316
 317 <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>
 318
 319 <pre class="code">
 320   const IndexPacket
 321     *indexes;
 322
 323   for (y=0; y &lt; (ssize_t) source-&gt;rows; y++)
 324   {
 325     p=GetVirtualPixels(source,0,y,source-&gt;columns,1);
 326     if (p == (const PixelPacket *) NULL)
 327       break;
 328     indexes=GetVirtualIndexes(source);
 329     for (x=0; x &lt; (ssize_t) source-&gt;columns; x++)
 330       (void) printf("%d\n",indexes[x];
 331   }
 332   if (y &lt; (ssize_t) source-&gt;rows)
 333     /* an exception was thrown */
 334 </pre>
 335
 336 <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>
 337
 338 <pre class="code">
 339   p=GetVirtualPixels(source,-3,-3,source-&gt;columns+3,6,exception);
 340 </pre>
 341
 342 <p>gives you the pixels you asked for without complaint, even though some are not within the confines of the image region.</p>
 343 </div>
 344
 345 <h3><a name="virtual-pixels"></a>Virtual Pixels</h3>
 346 <div class="doc-section">
 347
 348 <p>There are a plethora of image processing algorithms that require a neighborhood of pixels about a pixel of interest.  The algorithm typically includes 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>
 349  <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>
 350
 351 <pre class="text" style="font-size: 90%;">
 352   background:           the area surrounding the image is the background color
 353   black:                the area surrounding the image is black
 354   checker-tile:         alternate squares with image and background color
 355   dither:               non-random 32x32 dithered pattern
 356   edge:                 extend the edge pixel toward infinity (default)
 357   gray:                 the area surrounding the image is gray
 358   horizontal-tile:      horizontally tile the image, background color above/below
 359   horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
 360   mirror:               mirror tile the image
 361   random:               choose a random pixel from the image
 362   tile:                 tile the image
 363   transparent:          the area surrounding the image is transparent blackness
 364   vertical-tile:        vertically tile the image, sides are background color
 365   vertical-tile-edge:   vertically tile the image and replicate the side edge pixels
 366   white:                the area surrounding the image is white
 367 </pre>
 368
 369 </div>
 370
 371 <h3>Cache Storage and Resource Requirements</h3>
 372 <div class="doc-section">
 373
 374 <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>
 375
 376 <dl class="doc">
 377   <dt class="doc">files</dt>
 378   <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 without a speed penalty due to repeated open/close calls.</dd>
 379   <dt class="doc">area</dt>
 380   <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>
 381   <dt class="doc">memory</dt>
 382   <dd>maximum amount of memory in bytes to allocate for the pixel cache from the anonymous mapped memory or the heap.</dd>
 383   <dt class="doc">map</dt>
 384   <dd>maximum amount of memory map in bytes to allocate for the pixel cache.</dd>
 385   <dt class="doc">disk</dt>
 386   <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>
 387   <dt class="doc">thread</dt>
 388   <dd>maximum number of threads that are permitted to run in parallel.</dd>
 389   <dt class="doc">time</dt>
 390   <dd>maximum number of seconds that the process is permitted to execute.  When this limit is exceeded, an exception is thrown and processing stops.</dd>
 391 </dl>
 392
 393 <p>To determine the current setting of these limits, use this command:</p>
 394
 395 <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
 396 -------------------------------------------------------------------------------
 397  768     1.0386GB    3.8692GiB    7.7384GiB    unlimited         4    unlimited
 398 </pre
 399 ></span></p>
 400 <p>You can set these limits either as a <a href="../www/resources.html#configure">policy</a> (see <a href="../www/source/policy.xml">policy.xml</a>), with an <a href="../www/resources.html#environment">environment variable</a>, with the <a href="../www/command-line-options.html#limit">-limit</a> command line option, or with 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>
 401
 402 <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>
 403 </div>
 404
 405 <h3>Cache Views</h3>
 406 <div class="doc-section">
 407
 408 <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>
 409
 410 <pre class="code">
 411   CacheView
 412     *view_1,
 413     *view_2;
 414
 415   view_1=OpenCacheView(source);
 416   view_2=OpenCacheView(source);
 417   for (y=0; y &lt; (ssize_t) source-&gt;rows; y++)
 418   {
 419     u=GetCacheViewVirtualPixels(view_1,0,y,source-&gt;columns,1,exception);
 420     v=GetCacheViewVirtualPixels(view_2,0,source-&gt;rows-y-1,source-&gt;columns,1,
 421       exception);
 422     if ((u == (const PixelPacket *) NULL) || (v == (const PixelPacket *) NULL))
 423       break;
 424     for (x=0; x &lt; (ssize_t) source-&gt;columns; x++)
 425     {
 426       /* do something with u &amp; v here */
 427     }
 428   }
 429   view_1=CloseCacheView(view_1);
 430   view_2=CloseCacheView(view_2);
 431   if (y &lt; (ssize_t) source-&gt;rows)
 432     { /* an exception was thrown */ }
 433 </pre>
 434 </div>
 435
 436 <h3>Magick Persistent Cache Format</h3>
 437 <div class="doc-section">
 438
 439 <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>
 440 <p>The most efficient use of MPC image files is a write-once, read-many-times pattern.  For example, your workflow requires extracting random blocks of pixels from the source image.  Rather than re-reading and possibly decompressing the source image each time, we use MPC and map the image directly to memory.</p>
 441 </div>
 442
 443 <h3>Best Practices</h3>
 444 <div class="doc-section">
 445
 446 <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>
 447
 448 <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>
 449
 450 <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>
 451
 452 <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>
 453
 454 <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>
 455
 456 <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>
 457
 458 <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>
 459
 460 <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>
 461
 462 <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>
 463
 464 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>export MAGICK_TEMPORARY_PATH=/data/magick</span></p>
 465
 466 <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>
 467
 468 <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>
 469 <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>
 470 </div>
 471
 472 </div>
 473
 474 <h2><a name="stream"></a>Streaming Pixels</h2>
 475 <div class="doc-section">
 476
 477 <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>
 478
 479 <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>
 480
 481 <pre class="code">
 482 static size_t StreamHandler(const Image *image,const void *pixels,
 483   const size_t columns)
 484 {
 485   /* process pixels here */
 486   return(columns);
 487 }
 488
 489 ...
 490 /* invoke the pixel stream here */
 491 image=ReadStream(image_info,&amp;StreamHandler,exception);
 492 </pre>
 493
 494 <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>
 495
 496 </div>
 497
 498 <h2><a name="properties"></a>Image Properties and Profiles</h2>
 499 <div class="doc-section">
 500
 501 <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>
 502
 503 <pre class="code">
 504   (void) printf("image width: %lu, height: %lu\n",image-&gt;columns,image-&gt;rows);
 505 </pre>
 506
 507 <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>
 508
 509 <pre class="code">
 510   const char
 511     *comment;
 512
 513   (void) SetImageProperty(image,"comment","This space for rent");
 514   comment=GetImageProperty(image,"comment");
 515   if (comment == (const char *) NULL)
 516     (void) printf("Image comment: %s\n",comment);
 517 </pre>
 518
 519 <p>ImageMagick supports artifacts with the GetImageArtifact() and SetImageArtifact() methods.  Artifacts are stealth properties that are not exported to image formats (e.g. PNG).</p>
 520
 521 <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>
 522
 523 <pre class="code">
 524   StringInfo
 525     *profile;
 526
 527   profile=AcquireStringInfo(length);
 528   SetStringInfoDatum(profile,my_exif_profile);
 529   (void) SetImageProfile(image,"EXIF",profile);
 530   DestroyStringInfo(profile);
 531   profile=GetImageProfile(image,"EXIF");
 532   if (profile != (StringInfo *) NULL)
 533     (void) PrintStringInfo(stdout,"EXIF",profile);
 534 </pre>
 535
 536 </div>
 537
 538 <h2><a name="tera-pixel"></a>Large Image Support</h2>
 539 <div class="doc-section">
 540 <p>ImageMagick can read, process, or write mega-, giga-, or tera-pixel image sizes.  An image width or height can range from 1 to 2 giga-pixels on a 32 bit OS and up to 9 exa-pixels on a 64-bit OS.  Note, that some image formats have restrictions on image size.  For example, Photoshop images are limited to 300,000 pixels for width or height.  Here we resize an image to a quarter million pixels square:</p>
 541
 542 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -resize 250000x250000 logo.miff</span></p>
 543 <p>For large images, ImageMagick will 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>
 544
 545 <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>
 546 <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>
 547
 548 <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>
 549 <p>Here we force all image pixels to disk:</p>
 550
 551 <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>
 552 <p>Caching pixels to disk is about 1000 times slower than memory.  Expect long run times when processing large images on disk with ImageMagick.  You can monitor progress with this command:</p>
 553
 554 <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>
 555
 556 <h2><a name="threads"></a>Threads of Execution</h2>
 557 <div class="doc-section">
 558
 559 <p>Many of ImageMagick's internal algorithms are threaded to take advantage of speed-ups offered by the multicore processor chips. 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 with the exception of an OpenMP parallel section.  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>
 560
 561 <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>
 562
 563 <div class="viewport">
 564 <pre class="code">
 565 {
 566   CacheView
 567     *image_view;
 568
 569   MagickBooleanType
 570     status;
 571
 572   ssize_t
 573     y;
 574
 575   status=MagickTrue;
 576   image_view=AcquireCacheView(image);
 577   #pragma omp parallel for schedule(dynamic,4) shared(status)
 578   for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
 579   {
 580     register IndexPacket
 581       *indexes;
 582
 583     register PixelPacket
 584       *q;
 585
 586     register ssize_t
 587       x;
 588
 589     if (status == MagickFalse)
 590       continue;
 591     q=GetCacheViewAuthenticPixels(image_view,0,y,image-&gt;columns,1,exception);
 592     if (q == (PixelPacket *) NULL)
 593       {
 594         status=MagickFalse;
 595         continue;
 596       }
 597     indexes=GetCacheViewAuthenticIndexQueue(image_view);
 598     for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
 599     {
 600       q-&gt;red= ...
 601       q-&gt;green= ...
 602       q-&gt;blue= ...
 603       q-&gt;opacity= ...
 604       if (indexes != (IndexPacket *) NULL)
 605         indexes[x]= ...
 606       q++;
 607     }
 608     if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
 609       status=MagickFalse;
 610   }
 611   image_view=DestroyCacheView(image_view);
 612   if (status == MagickFalse)
 613     perror("something went wrong");
 614 }
 615 </pre>
 616 </div>
 617
 618
 619 <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>
 620
 621 <p><a href="../www/api/wand-view.html">MagickWand</a> supports wand views.  A view iterates over the entire, or portion, of the image in parallel and for each row of pixels, it invokes a callback method you provide.  This limits most of your parallel programming activity to just that one module.  There are similar methods in <a href="../www/api/image-view.html">MagickCore</a>.  For an example, see the same sigmoidal contrast algorithm implemented in both <a href="../www/magick-wand.html#wand-view">MagickWand</a> and <a href="../www/magick-core.html#image-view">MagickCore</a>.</p>
 622
 623 <p>In most circumstances, the default number of threads is set to the number of processor cores on your system for optimal performance.  However, if your system is hyperthreaded or if you are running on a virtual host and only a subset of the processors are available to your server instance, you might get an increase in performance by setting the thread <a href="../www/resources.html#configure">policy</a> or the <a href="../www/resources.html#environment">MAGICK_THREAD_LIMIT</a> environment variable.  For example, your virtual host has 8 processors but only 2 are assigned to your server instance.  The default of 8 threads can cause severe performance problems.  One solution is to limit the number of threads to the available processors in your <a href="../www/source/policy.xml">policy.xml</a> configuration file:</p>
 624
 625 <pre class="text">
 626   &lt;policy domain="resource" name="thread" value="2"/>
 627 </pre>
 628
 629 <p>Or suppose your 12 core hyperthreaded computer defaults to 24 threads.  Set the MAGICK_THREAD_LIMIT environment variable and you will likely get improved performance:</p>
 630
 631 <pre class="text">
 632   export MAGICK_THREAD_LIMIT=12
 633 </pre>
 634
 635 <p>The OpenMP committee has not defined the behavior of mixing OpenMP with other threading models such as Posix threads.  However, using modern releases of Linux, OpenMP and Posix threads appear to interoperate without complaint.  If you want to use Posix threads from a program module that calls one of the ImageMagick application programming interfaces (e.g. MagickCore, MagickWand, Magick++, etc.) from Mac OS X or an older Linux release, you may need to disable OpenMP support within ImageMagick.  Add the <kbd>--disable-openmp</kbd> option to the configure script command line and rebuild and reinstall ImageMagick.</p>
 636
 637 </div>
 638
 639 <h2><a name="distributed"></a>Heterogeneous Distributed Processing</h2>
 640 <div class="doc-section">
 641 <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>
 642
 643 <p>First verify that your version of ImageMagick includes support for the OpenCL feature:</p>
 644
 645 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -version</span><span class='crtout'>Features: OpenMP OpenCL</span></p>
 646 <p>If so, run this command to realize a significant speed-up for image convolution:</p>
 647
 648 <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>
 649 <p>If an accelerator is not available or if the accelerator fails to respond, ImageMagick reverts to the non-accelerated convolution algorithm.</p>
 650
 651 <p>Here is an example OpenCL kernel that convolves an image:</p>
 652
 653 <div class="viewport">
 654 <pre class="code">
 655 static inline long ClampToCanvas(const long offset,const ulong range)
 656 {
 657   if (offset &lt; 0L)
 658     return(0L);
 659   if (offset >= range)
 660     return((long) (range-1L));
 661   return(offset);
 662 }
 663
 664 static inline CLQuantum ClampToQuantum(const double value)
 665 {
 666   if (value &lt; 0.0)
 667     return((CLQuantum) 0);
 668   if (value >= (double) QuantumRange)
 669     return((CLQuantum) QuantumRange);
 670   return((CLQuantum) (value+0.5));
 671 }
 672
 673 __kernel void Convolve(const __global CLPixelType *source,__constant double *filter,
 674   const ulong width,const ulong height,__global CLPixelType *destination)
 675 {
 676   const ulong columns = get_global_size(0);
 677   const ulong rows = get_global_size(1);
 678
 679   const long x = get_global_id(0);
 680   const long y = get_global_id(1);
 681
 682   const double scale = (1.0/QuantumRange);
 683   const long mid_width = (width-1)/2;
 684   const long mid_height = (height-1)/2;
 685   double4 sum = { 0.0, 0.0, 0.0, 0.0 };
 686   double gamma = 0.0;
 687   register ulong i = 0;
 688
 689   for (long v=(-mid_height); v &lt;= mid_height; v++)
 690   {
 691     for (long u=(-mid_width); u &lt;= mid_width; u++)
 692     {
 693       register const ulong index=ClampToCanvas(y+v,rows)*columns+ClampToCanvas(x+u,
 694         columns);
 695       const double alpha=scale*(QuantumRange-source[index].w);
 696       sum.x+=alpha*filter[i]*source[index].x;
 697       sum.y+=alpha*filter[i]*source[index].y;
 698       sum.z+=alpha*filter[i]*source[index].z;
 699       sum.w+=filter[i]*source[index].w;
 700       gamma+=alpha*filter[i];
 701       i++;
 702     }
 703   }
 704
 705   gamma=1.0/(fabs(gamma) &lt;= MagickEpsilon ? 1.0 : gamma);
 706   const ulong index=y*columns+x;
 707   destination[index].x=ClampToQuantum(gamma*sum.x);
 708   destination[index].y=ClampToQuantum(gamma*sum.y);
 709   destination[index].z=ClampToQuantum(gamma*sum.z);
 710   destination[index].w=ClampToQuantum(sum.w);
 711 };
 712 </pre>
 713 </div>
 714
 715 <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>
 716
 717 </div>
 718
 719 <h2><a name="coders"></a>Custom Image Coders</h2>
 720 <div class="doc-section">
 721
 722 <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>
 723
 724 <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>
 725
 726 <div class="viewport">
 727 <pre class="code">
 728 /*
 729   Include declarations.
 730 */
 731 #include "magick/studio.h"
 732 #include "magick/blob.h"
 733 #include "magick/blob-private.h"
 734 #include "magick/colorspace.h"
 735 #include "magick/exception.h"
 736 #include "magick/exception-private.h"
 737 #include "magick/image.h"
 738 #include "magick/image-private.h"
 739 #include "magick/list.h"
 740 #include "magick/magick.h"
 741 #include "magick/memory_.h"
 742 #include "magick/monitor.h"
 743 #include "magick/monitor-private.h"
 744 #include "magick/quantum-private.h"
 745 #include "magick/static.h"
 746 #include "magick/string_.h"
 747 #include "magick/module.h"
 748
 749 /*
 750   Forward declarations.
 751 */
 752 static MagickBooleanType
 753   WriteMGKImage(const ImageInfo *,Image *);
 754
 755 /*
 756 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 757 %                                                                             %
 758 %                                                                             %
 759 %                                                                             %
 760 %   I s M G K                                                                 %
 761 %                                                                             %
 762 %                                                                             %
 763 %                                                                             %
 764 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 765 %
 766 %  IsMGK() returns MagickTrue if the image format type, identified by the
 767 %  magick string, is MGK.
 768 %
 769 %  The format of the IsMGK method is:
 770 %
 771 %      MagickBooleanType IsMGK(const unsigned char *magick,const size_t length)
 772 %
 773 %  A description of each parameter follows:
 774 %
 775 %    o magick: This string is generally the first few bytes of an image file
 776 %      or blob.
 777 %
 778 %    o length: Specifies the length of the magick string.
 779 %
 780 */
 781 static MagickBooleanType IsMGK(const unsigned char *magick,const size_t length)
 782 {
 783   if (length &lt; 7)
 784     return(MagickFalse);
 785   if (LocaleNCompare((char *) magick,"id=mgk",7) == 0)
 786     return(MagickTrue);
 787   return(MagickFalse);
 788 }
 789
 790 /*
 791 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 792 %                                                                             %
 793 %                                                                             %
 794 %                                                                             %
 795 %   R e a d M G K I m a g e                                                   %
 796 %                                                                             %
 797 %                                                                             %
 798 %                                                                             %
 799 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 800 %
 801 %  ReadMGKImage() reads a MGK image file and returns it.  It allocates
 802 %  the memory necessary for the new Image structure and returns a pointer to
 803 %  the new image.
 804 %
 805 %  The format of the ReadMGKImage method is:
 806 %
 807 %      Image *ReadMGKImage(const ImageInfo *image_info,ExceptionInfo *exception)
 808 %
 809 %  A description of each parameter follows:
 810 %
 811 %    o image_info: the image info.
 812 %
 813 %    o exception: return any errors or warnings in this structure.
 814 %
 815 */
 816 static Image *ReadMGKImage(const ImageInfo *image_info,
 817   ExceptionInfo *exception)
 818 {
 819   char
 820     buffer[MaxTextExtent];
 821
 822   Image
 823     *image;
 824
 825   MagickBooleanType
 826     status;
 827
 828   register PixelPacket
 829     *q;
 830
 831   register size_t
 832     x;
 833
 834   register unsigned char
 835     *p;
 836
 837   ssize_t
 838     count,
 839     y;
 840
 841   unsigned char
 842     *pixels;
 843
 844   unsigned long
 845     columns,
 846     rows;
 847
 848   /*
 849     Open image file.
 850   */
 851   assert(image_info != (const ImageInfo *) NULL);
 852   assert(image_info-&gt;signature == MagickSignature);
 853   if (image_info-&gt;debug != MagickFalse)
 854     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image_info-&gt;filename);
 855   assert(exception != (ExceptionInfo *) NULL);
 856   assert(exception-&gt;signature == MagickSignature);
 857   image=AcquireImage(image_info);
 858   status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
 859   if (status == MagickFalse)
 860     {
 861       image=DestroyImageList(image);
 862       return((Image *) NULL);
 863     }
 864   /*
 865     Read MGK image.
 866   */
 867   (void) ReadBlobString(image,buffer);  /* read magic number */
 868   if (IsMGK(buffer,7) == MagickFalse)
 869     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
 870   (void) ReadBlobString(image,buffer);
 871   count=(ssize_t) sscanf(buffer,"%lu %lu\n",&amp;columns,&amp;rows);
 872   if (count &lt;= 0)
 873     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
 874   do
 875   {
 876     /*
 877       Initialize image structure.
 878     */
 879     image-&gt;columns=columns;
 880     image-&gt;rows=rows;
 881     image-&gt;depth=8;
 882     if ((image_info-&gt;ping != MagickFalse) &amp;&amp; (image_info-&gt;number_scenes != 0))
 883       if (image-&gt;scene >= (image_info-&gt;scene+image_info-&gt;number_scenes-1))
 884         break;
 885     /*
 886       Convert MGK raster image to pixel packets.
 887     */
 888     if (SetImageExtent(image,0,0) == MagickFalse)
 889       {
 890         InheritException(exception,&amp;image-&gt;exception);
 891         return(DestroyImageList(image));
 892       }
 893     pixels=(unsigned char *) AcquireQuantumMemory((size_t) image-&gt;columns,3UL*sizeof(*pixels));
 894     if (pixels == (unsigned char *) NULL)
 895       ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
 896     for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
 897     {
 898       count=(ssize_t) ReadBlob(image,(size_t) (3*image-&gt;columns),pixels);
 899       if (count != (ssize_t) (3*image-&gt;columns))
 900         ThrowReaderException(CorruptImageError,"UnableToReadImageData");
 901       p=pixels;
 902       q=QueueAuthenticPixels(image,0,y,image-&gt;columns,1,exception);
 903       if (q == (PixelPacket *) NULL)
 904         break;
 905       for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
 906       {
 907         q-&gt;red=ScaleCharToQuantum(*p++);
 908         q-&gt;green=ScaleCharToQuantum(*p++);
 909         q-&gt;blue=ScaleCharToQuantum(*p++);
 910         q++;
 911       }
 912       if (SyncAuthenticPixels(image,exception) == MagickFalse)
 913         break;
 914       if ((image-&gt;previous == (Image *) NULL) &&
 915           (SetImageProgress(image,LoadImageTag,y,image&gt;>rows) == MagickFalse))
 916         break;
 917     }
 918     pixels=(unsigned char *) RelinquishMagickMemory(pixels);
 919     if (EOFBlob(image) != MagickFalse)
 920       {
 921         ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",image-&gt;filename);
 922         break;
 923       }
 924     /*
 925       Proceed to next image.
 926     */
 927     if (image_info-&gt;number_scenes != 0)
 928       if (image-&gt;scene >= (image_info-&gt;scene+image_info-&gt;number_scenes-1))
 929         break;
 930     *buffer='\0';
 931     (void) ReadBlobString(image,buffer);
 932     count=(ssize_t) sscanf(buffer,"%lu %lu\n",&amp;columns,&amp;rows);
 933     if (count != 0)
 934       {
 935         /*
 936           Allocate next image structure.
 937         */
 938         AcquireNextImage(image_info,image);
 939         if (GetNextImageInList(image) == (Image *) NULL)
 940           {
 941             image=DestroyImageList(image);
 942             return((Image *) NULL);
 943           }
 944         image=SyncNextImageInList(image);
 945         status=SetImageProgress(image,LoadImageTag,TellBlob(image),GetBlobSize(image));
 946         if (status == MagickFalse)
 947           break;
 948       }
 949   } while (count != 0);
 950   (void) CloseBlob(image);
 951   return(GetFirstImageInList(image));
 952 }
 953
 954 /*
 955 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 956 %                                                                             %
 957 %                                                                             %
 958 %                                                                             %
 959 %   R e g i s t e r M G K I m a g e                                           %
 960 %                                                                             %
 961 %                                                                             %
 962 %                                                                             %
 963 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 964 %
 965 %  RegisterMGKImage() adds attributes for the MGK image format to
 966 %  the list of supported formats.  The attributes include the image format
 967 %  tag, a method to read and/or write the format, whether the format
 968 %  supports the saving of more than one frame to the same file or blob,
 969 %  whether the format supports native in-memory I/O, and a brief
 970 %  description of the format.
 971 %
 972 %  The format of the RegisterMGKImage method is:
 973 %
 974 %      unsigned long RegisterMGKImage(void)
 975 %
 976 */
 977 ModuleExport unsigned long RegisterMGKImage(void)
 978 {
 979   MagickInfo
 980     *entry;
 981
 982   entry=SetMagickInfo("MGK");
 983   entry-&gt;decoder=(DecodeImageHandler *) ReadMGKImage;
 984   entry-&gt;encoder=(EncodeImageHandler *) WriteMGKImage;
 985   entry-&gt;magick=(IsImageFormatHandler *) IsMGK;
 986   entry-&gt;description=ConstantString("MGK");
 987   entry-&gt;module=ConstantString("MGK");
 988   (void) RegisterMagickInfo(entry);
 989   return(MagickImageCoderSignature);
 990 }
 991
 992 /*
 993 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 994 %                                                                             %
 995 %                                                                             %
 996 %                                                                             %
 997 %   U n r e g i s t e r M G K I m a g e                                       %
 998 %                                                                             %
 999 %                                                                             %
1000 %                                                                             %
1001 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1002 %
1003 %  UnregisterMGKImage() removes format registrations made by the
1004 %  MGK module from the list of supported formats.
1005 %
1006 %  The format of the UnregisterMGKImage method is:
1007 %
1008 %      UnregisterMGKImage(void)
1009 %
1010 */
1011 ModuleExport void UnregisterMGKImage(void)
1012 {
1013   (void) UnregisterMagickInfo("MGK");
1014 }
1015
1016 /*
1017 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1018 %                                                                             %
1019 %                                                                             %
1020 %                                                                             %
1021 %   W r i t e M G K I m a g e                                                 %
1022 %                                                                             %
1023 %                                                                             %
1024 %                                                                             %
1025 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1026 %
1027 %  WriteMGKImage() writes an image to a file in red, green, and blue
1028 %  MGK rasterfile format.
1029 %
1030 %  The format of the WriteMGKImage method is:
1031 %
1032 %      MagickBooleanType WriteMGKImage(const ImageInfo *image_info,Image *image)
1033 %
1034 %  A description of each parameter follows.
1035 %
1036 %    o image_info: the image info.
1037 %
1038 %    o image:  The image.
1039 %
1040 */
1041 static MagickBooleanType WriteMGKImage(const ImageInfo *image_info,Image *image)
1042 {
1043   char
1044     buffer[MaxTextExtent];
1045
1046   MagickBooleanType
1047     status;
1048
1049   MagickOffsetType
1050     scene;
1051
1052   register const PixelPacket
1053     *p;
1054
1055   register ssize_t
1056     x;
1057
1058   register unsigned char
1059     *q;
1060
1061   ssize_t
1062     y;
1063
1064   unsigned char
1065     *pixels;
1066
1067   /*
1068     Open output image file.
1069   */
1070   assert(image_info != (const ImageInfo *) NULL);
1071   assert(image_info-&gt;signature == MagickSignature);
1072   assert(image != (Image *) NULL);
1073   assert(image-&gt;signature == MagickSignature);
1074   if (image-&gt;debug != MagickFalse)
1075     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image-&gt;filename);
1076   status=OpenBlob(image_info,image,WriteBinaryBlobMode,&amp;image-&gt;exception);
1077   if (status == MagickFalse)
1078     return(status);
1079   scene=0;
1080   do
1081   {
1082     /*
1083       Allocate memory for pixels.
1084     */
1085     if (image-&gt;colorspace != RGBColorspace)
1086       (void) SetImageColorspace(image,RGBColorspace);
1087     pixels=(unsigned char *) AcquireQuantumMemory((size_t) image-&gt;columns,
1088       3UL*sizeof(*pixels));
1089     if (pixels == (unsigned char *) NULL)
1090       ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
1091     /*
1092       Initialize raster file header.
1093     */
1094     (void) WriteBlobString(image,"id=mgk\n");
1095     (void) FormatMagickString(buffer,MaxTextExtent,"%lu %lu\n",
1096       image-&gt;columns,image-&gt;rows);
1097     (void) WriteBlobString(image,buffer);
1098     for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
1099     {
1100       p=GetVirtualPixels(image,0,y,image-&gt;columns,1,&amp;image-&gt;exception);
1101       if (p == (const PixelPacket *) NULL)
1102         break;
1103       q=pixels;
1104       for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
1105       {
1106         *q++=ScaleQuantumToChar(p-&gt;red);
1107         *q++=ScaleQuantumToChar(p-&gt;green);
1108         *q++=ScaleQuantumToChar(p-&gt;blue);
1109         p++;
1110       }
1111       (void) WriteBlob(image,(size_t) (q-pixels),pixels);
1112       if ((image-&gt;previous == (Image *) NULL) &&
1113           (SetImageProgress(image,SaveImageTag,y,image-&gt;rows) == MagickFalse))
1114         break;
1115     }
1116     pixels=(unsigned char *) RelinquishMagickMemory(pixels);
1117     if (GetNextImageInList(image) == (Image *) NULL)
1118       break;
1119     image=SyncNextImageInList(image);
1120     status=SetImageProgress(image,SaveImagesTag,scene,
1121       GetImageListLength(image));
1122     if (status == MagickFalse)
1123       break;
1124     scene++;
1125   } while (image_info-&gt;adjoin != MagickFalse);
1126   (void) CloseBlob(image);
1127   return(MagickTrue);
1128 }
1129 </pre>
1130 </div>
1131
1132 <p>To invoke the custom coder from the command line, use these commands:</p>
1133
1134 <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>
1135 <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>
1136
1137 </div>
1138
1139 <h2><a name="filters"></a>Custom Image Filters</h2>
1140 <div class="doc-section">
1141
1142 <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>
1143
1144 <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>
1145
1146 <div class="viewport">
1147 <pre class="code">
1148 #include &lt;stdio.h&gt;
1149 #include &lt;stdlib.h&gt;
1150 #include &lt;string.h&gt;
1151 #include &lt;time.h&gt;
1152 #include &lt;assert.h&gt;
1153 #include &lt;math.h&gt;
1154 #include "magick/MagickCore.h"
1155 \f
1156 /*
1157 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1158 %                                                                             %
1159 %                                                                             %
1160 %                                                                             %
1161 %   a n a l y z e I m a g e                                                   %
1162 %                                                                             %
1163 %                                                                             %
1164 %                                                                             %
1165 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1166 %
1167 %  analyzeImage() computes the brightness and saturation mean,  standard
1168 %  deviation, kurtosis and skewness and stores these values as attributes
1169 %  of the image.
1170 %
1171 %  The format of the analyzeImage method is:
1172 %
1173 %      unsigned long analyzeImage(Image *images,const int argc,
1174 %        char **argv,ExceptionInfo *exception)
1175 %
1176 %  A description of each parameter follows:
1177 %
1178 %    o image: the address of a structure of type Image.
1179 %
1180 %    o argc: Specifies a pointer to an integer describing the number of
1181 %      elements in the argument vector.
1182 %
1183 %    o argv: Specifies a pointer to a text array containing the command line
1184 %      arguments.
1185 %
1186 %    o exception: return any errors or warnings in this structure.
1187 %
1188 */
1189 ModuleExport unsigned long analyzeImage(Image **images,const int argc,
1190   const char **argv,ExceptionInfo *exception)
1191 {
1192   char
1193     text[MaxTextExtent];
1194
1195   double
1196     area,
1197     brightness,
1198     brightness_mean,
1199     brightness_standard_deviation,
1200     brightness_kurtosis,
1201     brightness_skewness,
1202     brightness_sum_x,
1203     brightness_sum_x2,
1204     brightness_sum_x3,
1205     brightness_sum_x4,
1206     hue,
1207     saturation,
1208     saturation_mean,
1209     saturation_standard_deviation,
1210     saturation_kurtosis,
1211     saturation_skewness,
1212     saturation_sum_x,
1213     saturation_sum_x2,
1214     saturation_sum_x3,
1215     saturation_sum_x4;
1216
1217   Image
1218     *image;
1219
1220   assert(images != (Image **) NULL);
1221   assert(*images != (Image *) NULL);
1222   assert((*images)-&gt;signature == MagickSignature);
1223   (void) argc;
1224   (void) argv;
1225   image=(*images);
1226   for ( ; image != (Image *) NULL; image=GetNextImageInList(image))
1227   {
1228     CacheView
1229       *image_view;
1230
1231     MagickBooleanType
1232       status;
1233
1234     ssize_t
1235       y;
1236
1237     brightness_sum_x=0.0;
1238     brightness_sum_x2=0.0;
1239     brightness_sum_x3=0.0;
1240     brightness_sum_x4=0.0;
1241     brightness_mean=0.0;
1242     brightness_standard_deviation=0.0;
1243     brightness_kurtosis=0.0;
1244     brightness_skewness=0.0;
1245     saturation_sum_x=0.0;
1246     saturation_sum_x2=0.0;
1247     saturation_sum_x3=0.0;
1248     saturation_sum_x4=0.0;
1249     saturation_mean=0.0;
1250     saturation_standard_deviation=0.0;
1251     saturation_kurtosis=0.0;
1252     saturation_skewness=0.0;
1253     area=0.0;
1254     status=MagickTrue;
1255     image_view=AcquireCacheView(image);
1256 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1257     #pragma omp parallel for schedule(dynamic,4) shared(status)
1258 #endif
1259     for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
1260     {
1261       register const PixelPacket
1262         *p;
1263
1264       register ssize_t
1265         x;
1266
1267       if (status == MagickFalse)
1268         continue;
1269       p=GetCacheViewVirtualPixels(image_view,0,y,image-&gt;columns,1,exception);
1270       if (p == (const PixelPacket *) NULL)
1271         {
1272           status=MagickFalse;
1273           continue;
1274         }
1275       for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
1276       {
1277         ConvertRGBToHSB(p-&gt;red,p-&gt;green,p-&gt;blue,&amp;hue,&amp;saturation,&amp;brightness);
1278         brightness*=QuantumRange;
1279         brightness_sum_x+=brightness;
1280         brightness_sum_x2+=brightness*brightness;
1281         brightness_sum_x3+=brightness*brightness*brightness;
1282         brightness_sum_x4+=brightness*brightness*brightness*brightness;
1283         saturation*=QuantumRange;
1284         saturation_sum_x+=saturation;
1285         saturation_sum_x2+=saturation*saturation;
1286         saturation_sum_x3+=saturation*saturation*saturation;
1287         saturation_sum_x4+=saturation*saturation*saturation*saturation;
1288         area++;
1289         p++;
1290       }
1291     }
1292     image_view=DestroyCacheView(image_view);
1293     if (area &lt;= 0.0)
1294       break;
1295     brightness_mean=brightness_sum_x/area;
1296     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_mean);
1297     (void) SetImageProperty(image,"filter:brightness:mean",text);
1298     brightness_standard_deviation=sqrt(brightness_sum_x2/area-(brightness_sum_x/
1299       area*brightness_sum_x/area));
1300     (void) FormatMagickString(text,MaxTextExtent,"%g",
1301       brightness_standard_deviation);
1302     (void) SetImageProperty(image,"filter:brightness:standard-deviation",text);
1303     if (brightness_standard_deviation != 0)
1304       brightness_kurtosis=(brightness_sum_x4/area-4.0*brightness_mean*
1305         brightness_sum_x3/area+6.0*brightness_mean*brightness_mean*
1306         brightness_sum_x2/area-3.0*brightness_mean*brightness_mean*
1307         brightness_mean*brightness_mean)/(brightness_standard_deviation*
1308         brightness_standard_deviation*brightness_standard_deviation*
1309         brightness_standard_deviation)-3.0;
1310     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_kurtosis);
1311     (void) SetImageProperty(image,"filter:brightness:kurtosis",text);
1312     if (brightness_standard_deviation != 0)
1313       brightness_skewness=(brightness_sum_x3/area-3.0*brightness_mean*
1314         brightness_sum_x2/area+2.0*brightness_mean*brightness_mean*
1315         brightness_mean)/(brightness_standard_deviation*
1316         brightness_standard_deviation*brightness_standard_deviation);
1317     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_skewness);
1318     (void) SetImageProperty(image,"filter:brightness:skewness",text);
1319     saturation_mean=saturation_sum_x/area;
1320     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_mean);
1321     (void) SetImageProperty(image,"filter:saturation:mean",text);
1322     saturation_standard_deviation=sqrt(saturation_sum_x2/area-(saturation_sum_x/
1323       area*saturation_sum_x/area));
1324     (void) FormatMagickString(text,MaxTextExtent,"%g",
1325       saturation_standard_deviation);
1326     (void) SetImageProperty(image,"filter:saturation:standard-deviation",text);
1327     if (saturation_standard_deviation != 0)
1328       saturation_kurtosis=(saturation_sum_x4/area-4.0*saturation_mean*
1329         saturation_sum_x3/area+6.0*saturation_mean*saturation_mean*
1330         saturation_sum_x2/area-3.0*saturation_mean*saturation_mean*
1331         saturation_mean*saturation_mean)/(saturation_standard_deviation*
1332         saturation_standard_deviation*saturation_standard_deviation*
1333         saturation_standard_deviation)-3.0;
1334     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_kurtosis);
1335     (void) SetImageProperty(image,"filter:saturation:kurtosis",text);
1336     if (saturation_standard_deviation != 0)
1337       saturation_skewness=(saturation_sum_x3/area-3.0*saturation_mean*
1338         saturation_sum_x2/area+2.0*saturation_mean*saturation_mean*
1339         saturation_mean)/(saturation_standard_deviation*
1340         saturation_standard_deviation*saturation_standard_deviation);
1341     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_skewness);
1342     (void) SetImageProperty(image,"filter:saturation:skewness",text);
1343   }
1344   return(MagickImageFilterSignature);
1345 }
1346 </pre>
1347 </div>
1348
1349 <p>To invoke the custom filter from the command line, use this command:</p>
1350
1351 <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/>
1352     Format: LOGO (ImageMagick Logo)  <br/>
1353     Class: PseudoClass  <br/>
1354     Geometry: 640x480  <br/>
1355     ...  <br/>
1356     filter:brightness:kurtosis: 8.98864 <br/>
1357     filter:brightness:mean: 238.096 <br/>
1358     filter:brightness:skewness: -3.04519 <br/>
1359     filter:brightness:standard-deviation: 46.3286 <br/>
1360     filter:saturation:kurtosis: 5.9137 <br/>
1361     filter:saturation:mean: 23.4635 <br/>
1362     filter:saturation:skewness: 2.71874 <br/>
1363     filter:saturation:standard-deviation: 64.7734</span></p>
1364
1365 <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>
1366
1367 </div>
1368 \r
1369 </div>\r
1370 \r
1371 <div id="linkbar">\r
1372     <span id="linkbar-west">&nbsp;</span>\r
1373     <span id="linkbar-center">\r
1374       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
1375       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
1376     </span>\r
1377     <span id="linkbar-east">&nbsp;</span>\r
1378   </div>\r
1379   <div class="footer">\r
1380     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
1381     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
1382   </div>\r
1383   <div style="clear: both; margin: 0; width: 100%; "></div>\r
1384   <script type="text/javascript">\r
1385     var _gaq = _gaq || [];\r
1386     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
1387     _gaq.push(['_trackPageview']);\r
1388 \r
1389     (function() {\r
1390       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
1391       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
1392       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
1393     })();\r
1394   </script>\r
1395 </body>\r
1396 </html>\r