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