granicus.if.org Git - imagemagick/blob - www/api/histogram.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">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Image Histograms</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Generator" content="PHP"/>
  16   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, image, histograms, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  17   <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."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.hygi.de">Reinigungsmittel</a><!-- 201002000400+ -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 139 </div>
 140 <div  class="sponsor">
 141    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <p class="navigation-index">[<a href="#GetImageHistogram">GetImageHistogram</a> &bull; <a href="#IsHistogramImage">IsHistogramImage</a> &bull; <a href="#IsPaletteImage">IsPaletteImage</a> &bull; <a href="#MinMaxStretchImage">MinMaxStretchImage</a> &bull; <a href="#GetNumberColors">GetNumberColors</a> &bull; <a href="#UniqueImageColors">UniqueImageColors</a>]</p>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 157 _8c.html" target="source" name="GetImageHistogram">GetImageHistogram</a></h2>
 158 <div class="doc-section">
 159
 160 <p>GetImageHistogram() returns the unique colors in an image.</p></ol>
 161
 162 <p>The format of the GetImageHistogram method is:</p>
 163
 164 <pre class="code">
 165   unsigned long GetImageHistogram(const Image *image,
 166     unsigned long *number_colors,ExceptionInfo *exception)
 167 </pre>
 168
 169 <p>A description of each parameter follows.</p></ol>
 170
 171 <h5>image</h5>
 172 <ol><p>the image.</p></ol>
 173
 174 <h5>file</h5>
 175 <ol><p>Write a histogram of the color distribution to this file handle.</p></ol>
 176
 177 <h5>exception</h5>
 178 <ol><p>return any errors or warnings in this structure.</p></ol>
 179
 180  </div>
 181 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 182 _8c.html" target="source" name="IsHistogramImage">IsHistogramImage</a></h2>
 183 <div class="doc-section">
 184
 185 <p>IsHistogramImage() returns MagickTrue if the image has 1024 unique colors or less.</p></ol>
 186
 187 <p>The format of the IsHistogramImage method is:</p>
 188
 189 <pre class="code">
 190   MagickBooleanType IsHistogramImage(const Image *image,
 191     ExceptionInfo *exception)
 192 </pre>
 193
 194 <p>A description of each parameter follows.</p></ol>
 195
 196 <h5>image</h5>
 197 <ol><p>the image.</p></ol>
 198
 199 <h5>exception</h5>
 200 <ol><p>return any errors or warnings in this structure.</p></ol>
 201
 202  </div>
 203 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 204 _8c.html" target="source" name="IsPaletteImage">IsPaletteImage</a></h2>
 205 <div class="doc-section">
 206
 207 <p>IsPaletteImage() returns MagickTrue if the image is PseudoClass and has 256 unique colors or less.</p></ol>
 208
 209 <p>The format of the IsPaletteImage method is:</p>
 210
 211 <pre class="code">
 212   MagickBooleanType IsPaletteImage(const Image *image,
 213     ExceptionInfo *exception)
 214 </pre>
 215
 216 <p>A description of each parameter follows.</p></ol>
 217
 218 <h5>image</h5>
 219 <ol><p>the image.</p></ol>
 220
 221 <h5>exception</h5>
 222 <ol><p>return any errors or warnings in this structure.</p></ol>
 223
 224  </div>
 225 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 226 _8c.html" target="source" name="MinMaxStretchImage">MinMaxStretchImage</a></h2>
 227 <div class="doc-section">
 228
 229 <p>MinMaxStretchImage() uses the exact minimum and maximum values found in each of the channels given, as the BlackPoint and WhitePoint to linearly stretch the colors (and histogram) of the image.  The stretch points are also moved further inward by the adjustment values given.</p></ol>
 230
 231 <p>If the adjustment values are both zero this function is equivelent to a perfect normalization (or autolevel) of the image.</p></ol>
 232
 233 <p>Each channel is stretched independantally of each other (producing color distortion) unless the special 'SyncChannels' flag is also provided in the channels setting. If this flag is present the minimum and maximum point will be extracted from all the given channels, and those channels will be stretched by exactly the same amount (preventing color distortion).</p></ol>
 234
 235 <p>The 'SyncChannels' is turned on in the 'DefaultChannels' setting by default.</p></ol>
 236
 237 <p>The format of the MinMaxStretchImage method is:</p>
 238
 239 <pre class="code">
 240   MagickBooleanType MinMaxStretchImage(Image *image,
 241     const ChannelType channel, const double black_adjust,
 242     const double white_adjust)
 243 </pre>
 244
 245 <p>A description of each parameter follows:</p></ol>
 246
 247 <h5>image</h5>
 248 <ol><p>The image to auto-level</p></ol>
 249
 250 <h5>channel</h5>
 251 <ol><p>The channels to auto-level.  If the special 'SyncChannels' flag is set, all the given channels are stretched by the same amount.</p></ol>
 252
 253 <h5>black_adjust, white_adjust</h5>
 254 <ol><p>Move the Black/White Point inward from the minimum and maximum points by this color value.</p></ol>
 255
 256  </div>
 257 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 258 _8c.html" target="source" name="GetNumberColors">GetNumberColors</a></h2>
 259 <div class="doc-section">
 260
 261 <p>GetNumberColors() returns the number of unique colors in an image.</p></ol>
 262
 263 <p>The format of the GetNumberColors method is:</p>
 264
 265 <pre class="code">
 266   unsigned long GetNumberColors(const Image *image,FILE *file,
 267     ExceptionInfo *exception)
 268 </pre>
 269
 270 <p>A description of each parameter follows.</p></ol>
 271
 272 <h5>image</h5>
 273 <ol><p>the image.</p></ol>
 274
 275 <h5>file</h5>
 276 <ol><p>Write a histogram of the color distribution to this file handle.</p></ol>
 277
 278 <h5>exception</h5>
 279 <ol><p>return any errors or warnings in this structure.</p></ol>
 280
 281  </div>
 282 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 283 _8c.html" target="source" name="UniqueImageColors">UniqueImageColors</a></h2>
 284 <div class="doc-section">
 285
 286 <p>UniqueImageColors() returns the unique colors of an image.</p></ol>
 287
 288 <p>The format of the UniqueImageColors method is:</p>
 289
 290 <pre class="code">
 291   Image *UniqueImageColors(const Image *image,ExceptionInfo *exception)
 292 </pre>
 293
 294 <p>A description of each parameter follows.</p></ol>
 295
 296 <h5>image</h5>
 297 <ol><p>the image.</p></ol>
 298
 299 <h5>exception</h5>
 300 <ol><p>return any errors or warnings in this structure.</p></ol>
 301
 302  </div>
 303 \r
 304 </div>\r
 305 \r
 306 <div id="linkbar">\r
 307  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 308     <span id="linkbar-center">\r
 309       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 310       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 311     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 312     </span>\r
 313     <span id="linkbar-east">&nbsp;</span>\r
 314   </div>\r
 315   <div class="footer">\r
 316     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 317     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 318   </div>\r
 319   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 320 </body>\r
 321 </html>\r