blob: 65615e22032e0c412b8c51461f3a728c478db65e [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickCore, C API for ImageMagick: Reduce the Number of Unique Colors in an Image</title>
cristy3ed852e2009-09-05 21:47:34 +00008 <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"/>
cristy3c98a4f2010-08-13 20:09:41 +000011 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +000012 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000013 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, reduce, the, number, of, unique, colors, in, an, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +000016 <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"/>
cristy4103d562010-12-10 01:38:54 +000022 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000024 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000025 <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"/>
cristy7a40ba82011-01-08 20:31:18 +000027 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000028 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +000031 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000032 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000044</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000053 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000054<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
cristy178edaf2011-01-23 03:42:39 +000056 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000057<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +000062<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000063
cristy3ed852e2009-09-05 21:47:34 +000064<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000065 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000066</div>
cristy3eaa0ef2010-03-06 20:35:26 +000067<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000068<div class="menu">
cristybb503372010-05-27 20:51:26 +000069 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000082 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000083</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000085 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000086</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000088 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000089</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000091 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000092</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000094 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000113 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristybb503372010-05-27 20:51:26 +0000121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000141
142<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000143<div class="sponsor">
144 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
145</div>
cristyec6b4752011-01-08 03:16:23 +0000146<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000147 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy5c4585b2010-11-11 00:13:57 +0000148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000155<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000156 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
cristyf7964272011-01-30 03:49:12 +0000159 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyec6b4752011-01-08 03:16:23 +0000160</div>
cristy3ed852e2009-09-05 21:47:34 +0000161</div>
162</div>
cristyce69bb02010-07-27 19:49:46 +0000163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000164
cristyce69bb02010-07-27 19:49:46 +0000165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000177</div>
178
179<div class="main">
180
cristy307ba182010-12-25 01:00:34 +0000181<h1>Module quantize
182 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000183<p class="navigation-index">[<a href="#QuantizeImage">QuantizeImage</a> &bull; <a href="#AcquireQuantizeInfo">AcquireQuantizeInfo</a> &bull; <a href="#CloneQuantizeInfo">CloneQuantizeInfo</a> &bull; <a href="#CompressImageColormap">CompressImageColormap</a> &bull; <a href="#DestroyQuantizeInfo">DestroyQuantizeInfo</a> &bull; <a href="#GetImageQuantizeError">GetImageQuantizeError</a> &bull; <a href="#GetQuantizeInfo">GetQuantizeInfo</a> &bull; <a href="#PosterizeImage">PosterizeImage</a> &bull; <a href="#QuantizeImage">QuantizeImage</a> &bull; <a href="#QuantizeImages">QuantizeImages</a> &bull; <a href="#RemapImage">RemapImage</a> &bull; <a href="#RemapImages">RemapImages</a> &bull; <a href="#SetGrayscaleImage">SetGrayscaleImage</a>]</p>
184
cristy7a40ba82011-01-08 20:31:18 +0000185<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
186_8c.html" id="QuantizeImage">QuantizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000187<div class="doc-section">
188
cristy7a40ba82011-01-08 20:31:18 +0000189<p>QuantizeImage() takes a standard RGB or monochrome images and quantizes them down to some fixed number of colors.</p>
cristy3ed852e2009-09-05 21:47:34 +0000190
cristy7a40ba82011-01-08 20:31:18 +0000191<p>For purposes of color allocation, an image is a set of n pixels, where each pixel is a point in RGB space. RGB space is a 3-dimensional vector space, and each pixel, Pi, is defined by an ordered triple of red, green, and blue coordinates, (Ri, Gi, Bi).</p>
cristy3ed852e2009-09-05 21:47:34 +0000192
cristy7a40ba82011-01-08 20:31:18 +0000193<p>Each primary color component (red, green, or blue) represents an intensity which varies linearly from 0 to a maximum value, Cmax, which corresponds to full saturation of that color. Color allocation is defined over a domain consisting of the cube in RGB space with opposite vertices at (0,0,0) and (Cmax, Cmax, Cmax). QUANTIZE requires Cmax = 255.</p>
cristy3ed852e2009-09-05 21:47:34 +0000194
195<p>The algorithm maps this domain onto a tree in which each node represents a cube within that domain. In the following discussion these cubes are defined by the coordinate of two opposite vertices:</p>
196
197<pre class="text">
198 the origin.
199</pre>
200
cristy7a40ba82011-01-08 20:31:18 +0000201<p>The tree's root node represents the entire domain, (0,0,0) through (Cmax,Cmax,Cmax). Each lower level in the tree is generated by subdividing one node's cube into eight smaller cubes of equal size. This corresponds to bisecting the parent cube with planes passing through the midpoints of each edge.</p>
cristy3ed852e2009-09-05 21:47:34 +0000202
cristy7a40ba82011-01-08 20:31:18 +0000203<p>The basic algorithm operates in three phases: Classification, Reduction, and Assignment. Classification builds a color description tree for the image. Reduction collapses the tree until the number it represents, at most, the number of colors desired in the output image. Assignment defines the output image's color map and sets each pixel's color by restorage_class in the reduced tree. Our goal is to minimize the numerical discrepancies between the original colors and quantized colors (quantization error).</p>
cristy3ed852e2009-09-05 21:47:34 +0000204
cristy7a40ba82011-01-08 20:31:18 +0000205<p>Classification begins by initializing a color description tree of sufficient depth to represent each possible input color in a leaf. However, it is impractical to generate a fully-formed color description tree in the storage_class phase for realistic values of Cmax. If colors components in the input image are quantized to k-bit precision, so that Cmax= 2k-1, the tree would need k levels below the root node to allow representing each possible input color in a leaf. This becomes prohibitive because the tree's total number of nodes is 1 + sum(i=1, k, 8k).</p>
cristy3ed852e2009-09-05 21:47:34 +0000206
207<p>A complete tree would require 19,173,961 nodes for k = 8, Cmax = 255.</p>
208<h5>avoid building a fully populated tree, QUANTIZE</h5>
cristy7a40ba82011-01-08 20:31:18 +0000209<p>(1) Initializes data structures for nodes only as they are needed; (2) Chooses a maximum depth for the tree as a function of the desired number of colors in the output image (currently log2(colormap size)).</p>
cristy3ed852e2009-09-05 21:47:34 +0000210
211<p>For each pixel in the input image, storage_class scans downward from the root of the color description tree. At each level of the tree it identifies the single node which represents a cube in RGB space containing the pixel's color. It updates the following data for each such node:</p>
212
213<pre class="text">
214 n1: Number of pixels whose color is contained in the RGB cube which
215 this node represents;
216</pre>
217
cristy7a40ba82011-01-08 20:31:18 +0000218<p>n2: Number of pixels whose color is not represented in a node at lower depth in the tree; initially, n2 = 0 for all nodes except leaves of the tree.</p>
cristy3ed852e2009-09-05 21:47:34 +0000219
cristy7a40ba82011-01-08 20:31:18 +0000220<p>Sr, Sg, Sb: Sums of the red, green, and blue component values for all pixels not classified at a lower depth. The combination of these sums and n2 will ultimately characterize the mean color of a set of pixels represented by this node.</p>
cristy3ed852e2009-09-05 21:47:34 +0000221
cristy7a40ba82011-01-08 20:31:18 +0000222<p>E: the distance squared in RGB space between each pixel contained within a node and the nodes' center. This represents the quantization error for a node.</p>
cristy3ed852e2009-09-05 21:47:34 +0000223
cristy7a40ba82011-01-08 20:31:18 +0000224<p>Reduction repeatedly prunes the tree until the number of nodes with n2 > 0 is less than or equal to the maximum number of colors allowed in the output image. On any given iteration over the tree, it selects those nodes whose E count is minimal for pruning and merges their color statistics upward. It uses a pruning threshold, Ep, to govern node selection as follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000225
cristy7a40ba82011-01-08 20:31:18 +0000226<p>Ep = 0 while number of nodes with (n2 > 0) > required maximum number of colors prune all nodes such that E <= Ep Set Ep to minimum E in remaining nodes</p>
cristy3ed852e2009-09-05 21:47:34 +0000227
cristy7a40ba82011-01-08 20:31:18 +0000228<p>This has the effect of minimizing any quantization error when merging two nodes together.</p>
cristy3ed852e2009-09-05 21:47:34 +0000229
cristy7a40ba82011-01-08 20:31:18 +0000230<p>When a node to be pruned has offspring, the pruning procedure invokes itself recursively in order to prune the tree from the leaves upward. n2, Sr, Sg, and Sb in a node being pruned are always added to the corresponding data in that node's parent. This retains the pruned node's color characteristics for later averaging.</p>
cristy3ed852e2009-09-05 21:47:34 +0000231
cristy7a40ba82011-01-08 20:31:18 +0000232<p>For each node, n2 pixels exist for which that node represents the smallest volume in RGB space containing those pixel's colors. When n2 > 0 the node will uniquely define a color in the output image. At the beginning of reduction, n2 = 0 for all nodes except a the leaves of the tree which represent colors present in the input image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000233
cristy7a40ba82011-01-08 20:31:18 +0000234<p>The other pixel count, n1, indicates the total number of colors within the cubic volume which the node represents. This includes n1 - n2 pixels whose colors should be defined by nodes at a lower level in the tree.</p>
cristy3ed852e2009-09-05 21:47:34 +0000235
236<p>Assignment generates the output image from the pruned tree. The output</p>
237<h5>parts</h5>
cristy7a40ba82011-01-08 20:31:18 +0000238<p>(1) A color map, which is an array of color descriptions (RGB triples) for each color present in the output image; (2) A pixel array, which represents each pixel as an index into the color map array.</p>
cristy3ed852e2009-09-05 21:47:34 +0000239
cristy7a40ba82011-01-08 20:31:18 +0000240<p>First, the assignment phase makes one pass over the pruned color description tree to establish the image's color map. For each node with n2 > 0, it divides Sr, Sg, and Sb by n2 . This produces the mean color of all pixels that classify no lower than this node. Each of these colors becomes an entry in the color map.</p>
cristy3ed852e2009-09-05 21:47:34 +0000241
cristy7a40ba82011-01-08 20:31:18 +0000242<p>Finally, the assignment phase reclassifies each pixel in the pruned tree to identify the deepest node containing the pixel's color. The pixel's value in the pixel array becomes the index of this node's mean color in the color map.</p>
cristy3ed852e2009-09-05 21:47:34 +0000243
cristy7a40ba82011-01-08 20:31:18 +0000244<p>This method is based on a similar algorithm written by Paul Raveling.</p>
cristy3ed852e2009-09-05 21:47:34 +0000245
246 </div>
cristy7a40ba82011-01-08 20:31:18 +0000247<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
248_8c.html" id="AcquireQuantizeInfo">AcquireQuantizeInfo</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000249<div class="doc-section">
250
cristy7a40ba82011-01-08 20:31:18 +0000251<p>AcquireQuantizeInfo() allocates the QuantizeInfo structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000252
253<p>The format of the AcquireQuantizeInfo method is:</p>
254
255<pre class="code">
256 QuantizeInfo *AcquireQuantizeInfo(const ImageInfo *image_info)
257</pre>
258
cristy7a40ba82011-01-08 20:31:18 +0000259<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000260
261<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000262<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000263
264 </div>
cristy7a40ba82011-01-08 20:31:18 +0000265<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
266_8c.html" id="CloneQuantizeInfo">CloneQuantizeInfo</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000267<div class="doc-section">
268
cristy7a40ba82011-01-08 20:31:18 +0000269<p>CloneQuantizeInfo() makes a duplicate of the given quantize info structure, or if quantize info is NULL, a new one.</p>
cristy3ed852e2009-09-05 21:47:34 +0000270
271<p>The format of the CloneQuantizeInfo method is:</p>
272
273<pre class="code">
274 QuantizeInfo *CloneQuantizeInfo(const QuantizeInfo *quantize_info)
275</pre>
276
cristy7a40ba82011-01-08 20:31:18 +0000277<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000278
279<h5>clone_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000280<p>Method CloneQuantizeInfo returns a duplicate of the given quantize info, or if image info is NULL a new one.</p>
cristy3ed852e2009-09-05 21:47:34 +0000281
282<h5>quantize_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000283<p>a structure of type info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000284
285 </div>
cristy7a40ba82011-01-08 20:31:18 +0000286<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
287_8c.html" id="CompressImageColormap">CompressImageColormap</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000288<div class="doc-section">
289
cristy7a40ba82011-01-08 20:31:18 +0000290<p>CompressImageColormap() compresses an image colormap by removing any duplicate or unused color entries.</p>
cristy3ed852e2009-09-05 21:47:34 +0000291
292<p>The format of the CompressImageColormap method is:</p>
293
294<pre class="code">
295 MagickBooleanType CompressImageColormap(Image *image)
296</pre>
297
cristy7a40ba82011-01-08 20:31:18 +0000298<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000299
300<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000301<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000302
303 </div>
cristy7a40ba82011-01-08 20:31:18 +0000304<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
305_8c.html" id="DestroyQuantizeInfo">DestroyQuantizeInfo</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000306<div class="doc-section">
307
cristy7a40ba82011-01-08 20:31:18 +0000308<p>DestroyQuantizeInfo() deallocates memory associated with an QuantizeInfo structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000309
310<p>The format of the DestroyQuantizeInfo method is:</p>
311
312<pre class="code">
313 QuantizeInfo *DestroyQuantizeInfo(QuantizeInfo *quantize_info)
314</pre>
315
cristy7a40ba82011-01-08 20:31:18 +0000316<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000317
318<h5>quantize_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000319<p>Specifies a pointer to an QuantizeInfo structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000320
321 </div>
cristy7a40ba82011-01-08 20:31:18 +0000322<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
323_8c.html" id="GetImageQuantizeError">GetImageQuantizeError</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000324<div class="doc-section">
325
326<p>GetImageQuantizeError() measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value. These values are computed:</p>
327
328<pre class="text">
329 o mean_error_per_pixel: This value is the mean error for any single
330 pixel in the image.
331</pre>
332
333<h5>normalized_mean_square_error</h5>
cristy7a40ba82011-01-08 20:31:18 +0000334<p>This value is the normalized mean quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000335
336<h5>normalized_maximum_square_error</h5>
cristy7a40ba82011-01-08 20:31:18 +0000337<p>Thsi value is the normalized maximum quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in your image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000338
339<p>The format of the GetImageQuantizeError method is:</p>
340
341<pre class="code">
342 MagickBooleanType GetImageQuantizeError(Image *image)
343</pre>
344
cristy7a40ba82011-01-08 20:31:18 +0000345<p>A description of each parameter follows.</p>
cristy3ed852e2009-09-05 21:47:34 +0000346
347<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000348<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000349
350 </div>
cristy7a40ba82011-01-08 20:31:18 +0000351<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
352_8c.html" id="GetQuantizeInfo">GetQuantizeInfo</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000353<div class="doc-section">
354
cristy7a40ba82011-01-08 20:31:18 +0000355<p>GetQuantizeInfo() initializes the QuantizeInfo structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000356
357<p>The format of the GetQuantizeInfo method is:</p>
358
359<pre class="code">
360 GetQuantizeInfo(QuantizeInfo *quantize_info)
361</pre>
362
cristy7a40ba82011-01-08 20:31:18 +0000363<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000364
365<h5>quantize_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000366<p>Specifies a pointer to a QuantizeInfo structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000367
368 </div>
cristy7a40ba82011-01-08 20:31:18 +0000369<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
370_8c.html" id="PosterizeImage">PosterizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000371<div class="doc-section">
372
cristy7a40ba82011-01-08 20:31:18 +0000373<p>PosterizeImage() reduces the image to a limited number of colors for a "poster" effect.</p>
cristy3ed852e2009-09-05 21:47:34 +0000374
375<p>The format of the PosterizeImage method is:</p>
376
377<pre class="code">
cristybb503372010-05-27 20:51:26 +0000378 MagickBooleanType PosterizeImage(Image *image,const size_t levels,
cristy3ed852e2009-09-05 21:47:34 +0000379 const MagickBooleanType dither)
380</pre>
381
cristy7a40ba82011-01-08 20:31:18 +0000382<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000383
384<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000385<p>Specifies a pointer to an Image structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000386
387<h5>levels</h5>
cristy7a40ba82011-01-08 20:31:18 +0000388<p>Number of color levels allowed in each channel. Very low values (2, 3, or 4) have the most visible effect.</p>
cristy3ed852e2009-09-05 21:47:34 +0000389
390<h5>dither</h5>
cristy7a40ba82011-01-08 20:31:18 +0000391<p>Set this integer value to something other than zero to dither the mapped image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000392
393 </div>
cristy7a40ba82011-01-08 20:31:18 +0000394<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
395_8c.html" id="QuantizeImage">QuantizeImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000396<div class="doc-section">
397
cristy7a40ba82011-01-08 20:31:18 +0000398<p>QuantizeImage() analyzes the colors within a reference image and chooses a fixed number of colors to represent the image. The goal of the algorithm is to minimize the color difference between the input and output image while minimizing the processing time.</p>
cristy3ed852e2009-09-05 21:47:34 +0000399
400<p>The format of the QuantizeImage method is:</p>
401
402<pre class="code">
403 MagickBooleanType QuantizeImage(const QuantizeInfo *quantize_info,
404 Image *image)
405</pre>
406
cristy7a40ba82011-01-08 20:31:18 +0000407<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000408
409<h5>quantize_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000410<p>Specifies a pointer to an QuantizeInfo structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000411
412<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000413<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000414
415 </div>
cristy7a40ba82011-01-08 20:31:18 +0000416<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
417_8c.html" id="QuantizeImages">QuantizeImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000418<div class="doc-section">
419
cristy7a40ba82011-01-08 20:31:18 +0000420<p>QuantizeImages() analyzes the colors within a set of reference images and chooses a fixed number of colors to represent the set. The goal of the algorithm is to minimize the color difference between the input and output images while minimizing the processing time.</p>
cristy3ed852e2009-09-05 21:47:34 +0000421
422<p>The format of the QuantizeImages method is:</p>
423
424<pre class="code">
425 MagickBooleanType QuantizeImages(const QuantizeInfo *quantize_info,
426 Image *images)
427</pre>
428
cristy7a40ba82011-01-08 20:31:18 +0000429<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000430
431<h5>quantize_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000432<p>Specifies a pointer to an QuantizeInfo structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000433
434<h5>images</h5>
cristy7a40ba82011-01-08 20:31:18 +0000435<p>Specifies a pointer to a list of Image structures.</p>
cristy3ed852e2009-09-05 21:47:34 +0000436
437 </div>
cristy7a40ba82011-01-08 20:31:18 +0000438<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
439_8c.html" id="RemapImage">RemapImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000440<div class="doc-section">
441
cristy7a40ba82011-01-08 20:31:18 +0000442<p>RemapImage() replaces the colors of an image with the closest color from a reference image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000443
444<p>The format of the RemapImage method is:</p>
445
446<pre class="code">
447 MagickBooleanType RemapImage(const QuantizeInfo *quantize_info,
448 Image *image,const Image *remap_image)
449</pre>
450
cristy7a40ba82011-01-08 20:31:18 +0000451<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000452
453<h5>quantize_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000454<p>Specifies a pointer to an QuantizeInfo structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000455
456<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000457<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000458
459<h5>remap_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000460<p>the reference image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000461
462 </div>
cristy7a40ba82011-01-08 20:31:18 +0000463<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
464_8c.html" id="RemapImages">RemapImages</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000465<div class="doc-section">
466
cristy7a40ba82011-01-08 20:31:18 +0000467<p>RemapImages() replaces the colors of a sequence of images with the closest color from a reference image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000468
469<p>The format of the RemapImage method is:</p>
470
471<pre class="code">
472 MagickBooleanType RemapImages(const QuantizeInfo *quantize_info,
473 Image *images,Image *remap_image)
474</pre>
475
cristy7a40ba82011-01-08 20:31:18 +0000476<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000477
478<h5>quantize_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000479<p>Specifies a pointer to an QuantizeInfo structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000480
481<h5>images</h5>
cristy7a40ba82011-01-08 20:31:18 +0000482<p>the image sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +0000483
484<h5>remap_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000485<p>the reference image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000486
487 </div>
cristy7a40ba82011-01-08 20:31:18 +0000488<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/quantize
489_8c.html" id="SetGrayscaleImage">SetGrayscaleImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000490<div class="doc-section">
491
cristy7a40ba82011-01-08 20:31:18 +0000492<p>SetGrayscaleImage() converts an image to a PseudoClass grayscale image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000493
494<p>The format of the SetGrayscaleImage method is:</p>
495
496<pre class="code">
497 MagickBooleanType SetGrayscaleImage(Image *image)
498</pre>
499
cristy7a40ba82011-01-08 20:31:18 +0000500<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000501
502<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000503<p>The image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000504
505 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000506
507</div>
508
509<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000510 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000511 <span id="linkbar-center">
512 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000513 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000514 </span>
515 <span id="linkbar-east">&nbsp;</span>
516 </div>
517 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000518 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000519 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
520 </div>
521 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000522 <script type="text/javascript">
523 var _gaq = _gaq || [];
524 _gaq.push(['_setAccount', 'UA-17690367-1']);
525 _gaq.push(['_trackPageview']);
526
527 (function() {
528 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
529 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
530 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
531 })();
532 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000533</body>
534</html>