granicus.if.org Git - imagemagick/blob - www/api/histogram.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   8 <head>\r
   9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
  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="Application-name" content="ImageMagick"/>
  16   <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images."/>
  17   <meta name="Application-url" content="http://www.imagemagick.org"/>
  18   <meta name="Generator" content="PHP"/>
  19   <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"/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28   <link rel="icon" href="../../images/wand.png"/>
  29   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  32   <style type="text/css" media="all">\r
  33     @import url("../../www/magick.css");\r
  34   </style>\r
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  38   <script type="text/javascript">\r
  39     $(document).ready(function() {\r
  40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  41         'transitionIn'  : 'elastic',\r
  42         'transitionOut' : 'elastic',\r
  43         'overlayShow'   : false,\r
  44         'opacity'       : true\r
  45       });\r
  46     });\r
  47   </script>\r
  48 </head>\r
  49 \r
  50 <body id="www-imagemagick-org">\r
  51 <div class="titlebar">\r
  52 <div style="margin: 17px auto; float: left;">\r
  53   <script type="text/javascript">\r
  54   <!--\r
  55     google_ad_client = "pub-3129977114552745";\r
  56     google_ad_slot = "5439289906";\r
  57     google_ad_width = 728;\r
  58     google_ad_height = 90;\r
  59   //-->\r
  60   </script>\r
  61   <script type="text/javascript"\r
  62     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  63   </script>\r
  64 </div>\r
  65 <a href="http://www.imagemagick.org/discourse-server/">\r
  66   <img src="../../images/logo.jpg"\r
  67   alt="ImageMagick Logo"\r
  68   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  69 <a href="../../index.html">\r
  70   <img src="../../images/sprite.jpg"\r
  71   alt="ImageMagick Sprite"\r
  72   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  73 </div>\r
  74 \r
  75 <div class="westbar">\r
  76 \r
  77 <div class="menu">
  78   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div class="menu">
  82   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  83 </div>
  84 <div class="sub">
  85     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  89 </div>
  90 <div class="sub">
  91     <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  95 </div>
  96 <div class="sep"></div>\r
  97 <div class="menu">
  98   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 105 </div>
 106 <div class="sub">
 107     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 108 </div>
 109 <div class="menu">
 110   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 111 </div>
 112 <div class="sub">
 113     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 114 </div>
 115 <div class="sub">
 116     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 117 </div>
 118 <div class="sub">
 119     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 133  </div>
 134 <div class="menu">
 135   <a title="Resources" href="../../www/resources.html">Resources</a>
 136 </div>
 137 <div class="menu">
 138   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 139 </div>
 140 <div class="menu">
 141   <a title="Download" href="../../www/download.html">Download</a>
 142 </div>
 143 <div class="sep"></div>\r
 144 <div class="menu">
 145   <a title="Search" href="../../www/search.html">Search</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div class="menu">
 149   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 150 </div>
 151 <div  class="sub">
 152   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 153 </div>
 154 <div class="sep"></div>\r
 155 <div  class="menu">
 156   <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 157
 158 <a href="http://www.networkredux.com">
 159   <img src="../../images/networkredux.png" alt="[sponsor]"
 160   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 161 <div class="sponsbox">
 162 <div  class="sponsor">
 163   <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
 164 </div>
 165 <div  class="sponsor">
 166   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 167 </div>
 168 <div  class="sponsor">
 169   <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
 170 </div>
 171 <div  class="sponsor">
 172   <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 173 </div>
 174 <div  class="sponsor">
 175   <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 176 </div>
 177 <div  class="sponsor">
 178   <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 179 </div>
 180 <div  class="sponsor">
 181   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
 182 </div>
 183 <div  class="sponsor">
 184   <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 185 </div>
 186 <div  class="sponsor">
 187   <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 188 </div>
 189 <div  class="sponsor">
 190    <a rel="follow" title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
 191 </div>
 192 </div>
 193 </div>
 194 </div>\r
 195 \r
 196 <div class="eastbar">\r
 197 \r
 198 </div>\r
 199 \r
 200 <div class="main">\r
 201 \r
 202 <h1>Module histogram Methods</h1>
 203 <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>
 204
 205 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="GetImageHistogram">GetImageHistogram</a></h2>
 206 <div class="doc-section">
 207
 208 <p>GetImageHistogram() returns the unique colors in an image.</p>
 209
 210 <p>The format of the GetImageHistogram method is:</p>
 211
 212 <pre class="code">
 213   size_t GetImageHistogram(const Image *image,
 214     size_t *number_colors,ExceptionInfo *exception)
 215 </pre>
 216
 217 <p>A description of each parameter follows.</p>
 218
 219 <h5>image</h5>
 220 <p>the image.</p>
 221
 222 <h5>file</h5>
 223 <p>Write a histogram of the color distribution to this file handle.</p>
 224
 225 <h5>exception</h5>
 226 <p>return any errors or warnings in this structure.</p>
 227
 228  </div>
 229 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="IsHistogramImage">IsHistogramImage</a></h2>
 230 <div class="doc-section">
 231
 232 <p>IsHistogramImage() returns MagickTrue if the image has 1024 unique colors or less.</p>
 233
 234 <p>The format of the IsHistogramImage method is:</p>
 235
 236 <pre class="code">
 237   MagickBooleanType IsHistogramImage(const Image *image,
 238     ExceptionInfo *exception)
 239 </pre>
 240
 241 <p>A description of each parameter follows.</p>
 242
 243 <h5>image</h5>
 244 <p>the image.</p>
 245
 246 <h5>exception</h5>
 247 <p>return any errors or warnings in this structure.</p>
 248
 249  </div>
 250 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="IsPaletteImage">IsPaletteImage</a></h2>
 251 <div class="doc-section">
 252
 253 <p>IsPaletteImage() returns MagickTrue if the image is PseudoClass and has 256 unique colors or less.</p>
 254
 255 <p>The format of the IsPaletteImage method is:</p>
 256
 257 <pre class="code">
 258   MagickBooleanType IsPaletteImage(const Image *image,
 259     ExceptionInfo *exception)
 260 </pre>
 261
 262 <p>A description of each parameter follows.</p>
 263
 264 <h5>image</h5>
 265 <p>the image.</p>
 266
 267 <h5>exception</h5>
 268 <p>return any errors or warnings in this structure.</p>
 269
 270  </div>
 271 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="MinMaxStretchImage">MinMaxStretchImage</a></h2>
 272 <div class="doc-section">
 273
 274 <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>
 275
 276 <p>If the adjustment values are both zero this function is equivalent to a perfect normalization (or autolevel) of the image.</p>
 277
 278 <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>
 279
 280 <p>In the special case that only ONE value is found in a channel of the image that value is not stretched, that value is left as is.</p>
 281
 282 <p>The 'SyncChannels' is turned on in the 'DefaultChannels' setting by default.</p>
 283
 284 <p>The format of the MinMaxStretchImage method is:</p>
 285
 286 <pre class="code">
 287   MagickBooleanType MinMaxStretchImage(Image *image,
 288     const ChannelType channel, const double black_adjust,
 289     const double white_adjust)
 290 </pre>
 291
 292 <p>A description of each parameter follows:</p>
 293
 294 <h5>image</h5>
 295 <p>The image to auto-level</p>
 296
 297 <h5>channel</h5>
 298 <p>The channels to auto-level.  If the special 'SyncChannels' flag is set, all the given channels are stretched by the same amount.</p>
 299
 300 <h5>black_adjust, white_adjust</h5>
 301 <p>Move the Black/White Point inward from the minimum and maximum points by this color value.</p>
 302
 303  </div>
 304 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="GetNumberColors">GetNumberColors</a></h2>
 305 <div class="doc-section">
 306
 307 <p>GetNumberColors() returns the number of unique colors in an image.</p>
 308
 309 <p>The format of the GetNumberColors method is:</p>
 310
 311 <pre class="code">
 312   size_t GetNumberColors(const Image *image,FILE *file,
 313     ExceptionInfo *exception)
 314 </pre>
 315
 316 <p>A description of each parameter follows.</p>
 317
 318 <h5>image</h5>
 319 <p>the image.</p>
 320
 321 <h5>file</h5>
 322 <p>Write a histogram of the color distribution to this file handle.</p>
 323
 324 <h5>exception</h5>
 325 <p>return any errors or warnings in this structure.</p>
 326
 327  </div>
 328 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram_8c.html" id="UniqueImageColors">UniqueImageColors</a></h2>
 329 <div class="doc-section">
 330
 331 <p>UniqueImageColors() returns the unique colors of an image.</p>
 332
 333 <p>The format of the UniqueImageColors method is:</p>
 334
 335 <pre class="code">
 336   Image *UniqueImageColors(const Image *image,ExceptionInfo *exception)
 337 </pre>
 338
 339 <p>A description of each parameter follows.</p>
 340
 341 <h5>image</h5>
 342 <p>the image.</p>
 343
 344 <h5>exception</h5>
 345 <p>return any errors or warnings in this structure.</p>
 346
 347  </div>
 348 \r
 349 </div>\r
 350 \r
 351 <div id="linkbar">\r
 352     <span id="linkbar-west">&nbsp;</span>\r
 353     <span id="linkbar-center">\r
 354       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 355       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 356     </span>\r
 357     <span id="linkbar-east">&nbsp;</span>\r
 358   </div>\r
 359   <div class="footer">\r
 360     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 361     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 362   </div>\r
 363   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 364   <script type="text/javascript">\r
 365     var _gaq = _gaq || [];\r
 366     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 367     _gaq.push(['_trackPageview']);\r
 368 \r
 369     (function() {\r
 370       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 371       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 372       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 373     })();\r
 374   </script>\r
 375 </body>\r
 376 </html>\r