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" 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: MagickCore, C API for ImageMagick: Image Histograms</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="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"/>
  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: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 143 </div>
 144 <div  class="sponsor">
 145   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 146 </div>
 147 <div  class="sponsor">
 148   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 149 </div>
 150 <div  class="sponsor">
 151    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 152 </div>
 153 </div>
 154 </div>
 155 </div>\r
 156 \r
 157 <div class="eastbar">\r
 158   <script type="text/javascript">\r
 159   <!--\r
 160     google_ad_client = "pub-3129977114552745";\r
 161     google_ad_slot = "0574824969";\r
 162     google_ad_width = 160;\r
 163     google_ad_height = 600;\r
 164   //-->\r
 165   </script>\r
 166   <script type="text/javascript"\r
 167     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 168   </script>\r
 169 </div>\r
 170 \r
 171 <div class="main">\r
 172 \r
 173 <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>
 174
 175 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 176 _8c.html" target="source" name="GetImageHistogram">GetImageHistogram</a></h2>
 177 <div class="doc-section">
 178
 179 <p>GetImageHistogram() returns the unique colors in an image.</p></ol>
 180
 181 <p>The format of the GetImageHistogram method is:</p>
 182
 183 <pre class="code">
 184   size_t GetImageHistogram(const Image *image,
 185     size_t *number_colors,ExceptionInfo *exception)
 186 </pre>
 187
 188 <p>A description of each parameter follows.</p></ol>
 189
 190 <h5>image</h5>
 191 <ol><p>the image.</p></ol>
 192
 193 <h5>file</h5>
 194 <ol><p>Write a histogram of the color distribution to this file handle.</p></ol>
 195
 196 <h5>exception</h5>
 197 <ol><p>return any errors or warnings in this structure.</p></ol>
 198
 199  </div>
 200 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 201 _8c.html" target="source" name="IsHistogramImage">IsHistogramImage</a></h2>
 202 <div class="doc-section">
 203
 204 <p>IsHistogramImage() returns MagickTrue if the image has 1024 unique colors or less.</p></ol>
 205
 206 <p>The format of the IsHistogramImage method is:</p>
 207
 208 <pre class="code">
 209   MagickBooleanType IsHistogramImage(const Image *image,
 210     ExceptionInfo *exception)
 211 </pre>
 212
 213 <p>A description of each parameter follows.</p></ol>
 214
 215 <h5>image</h5>
 216 <ol><p>the image.</p></ol>
 217
 218 <h5>exception</h5>
 219 <ol><p>return any errors or warnings in this structure.</p></ol>
 220
 221  </div>
 222 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 223 _8c.html" target="source" name="IsPaletteImage">IsPaletteImage</a></h2>
 224 <div class="doc-section">
 225
 226 <p>IsPaletteImage() returns MagickTrue if the image is PseudoClass and has 256 unique colors or less.</p></ol>
 227
 228 <p>The format of the IsPaletteImage method is:</p>
 229
 230 <pre class="code">
 231   MagickBooleanType IsPaletteImage(const Image *image,
 232     ExceptionInfo *exception)
 233 </pre>
 234
 235 <p>A description of each parameter follows.</p></ol>
 236
 237 <h5>image</h5>
 238 <ol><p>the image.</p></ol>
 239
 240 <h5>exception</h5>
 241 <ol><p>return any errors or warnings in this structure.</p></ol>
 242
 243  </div>
 244 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 245 _8c.html" target="source" name="MinMaxStretchImage">MinMaxStretchImage</a></h2>
 246 <div class="doc-section">
 247
 248 <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>
 249
 250 <p>If the adjustment values are both zero this function is equivelent to a perfect normalization (or autolevel) of the image.</p></ol>
 251
 252 <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>
 253
 254 <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></ol>
 255
 256 <p>The 'SyncChannels' is turned on in the 'DefaultChannels' setting by default.</p></ol>
 257
 258 <p>The format of the MinMaxStretchImage method is:</p>
 259
 260 <pre class="code">
 261   MagickBooleanType MinMaxStretchImage(Image *image,
 262     const ChannelType channel, const double black_adjust,
 263     const double white_adjust)
 264 </pre>
 265
 266 <p>A description of each parameter follows:</p></ol>
 267
 268 <h5>image</h5>
 269 <ol><p>The image to auto-level</p></ol>
 270
 271 <h5>channel</h5>
 272 <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>
 273
 274 <h5>black_adjust, white_adjust</h5>
 275 <ol><p>Move the Black/White Point inward from the minimum and maximum points by this color value.</p></ol>
 276
 277  </div>
 278 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 279 _8c.html" target="source" name="GetNumberColors">GetNumberColors</a></h2>
 280 <div class="doc-section">
 281
 282 <p>GetNumberColors() returns the number of unique colors in an image.</p></ol>
 283
 284 <p>The format of the GetNumberColors method is:</p>
 285
 286 <pre class="code">
 287   size_t GetNumberColors(const Image *image,FILE *file,
 288     ExceptionInfo *exception)
 289 </pre>
 290
 291 <p>A description of each parameter follows.</p></ol>
 292
 293 <h5>image</h5>
 294 <ol><p>the image.</p></ol>
 295
 296 <h5>file</h5>
 297 <ol><p>Write a histogram of the color distribution to this file handle.</p></ol>
 298
 299 <h5>exception</h5>
 300 <ol><p>return any errors or warnings in this structure.</p></ol>
 301
 302  </div>
 303 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 304 _8c.html" target="source" name="UniqueImageColors">UniqueImageColors</a></h2>
 305 <div class="doc-section">
 306
 307 <p>UniqueImageColors() returns the unique colors of an image.</p></ol>
 308
 309 <p>The format of the UniqueImageColors method is:</p>
 310
 311 <pre class="code">
 312   Image *UniqueImageColors(const Image *image,ExceptionInfo *exception)
 313 </pre>
 314
 315 <p>A description of each parameter follows.</p></ol>
 316
 317 <h5>image</h5>
 318 <ol><p>the image.</p></ol>
 319
 320 <h5>exception</h5>
 321 <ol><p>return any errors or warnings in this structure.</p></ol>
 322
 323  </div>
 324 \r
 325 </div>\r
 326 \r
 327 <div id="linkbar">\r
 328     <span id="linkbar-west">&nbsp;</span>\r
 329     <span id="linkbar-center">\r
 330       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 331       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 332     </span>\r
 333     <span id="linkbar-east">&nbsp;</span>\r
 334   </div>\r
 335   <div class="footer">\r
 336     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 337     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 338   </div>\r
 339   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 340   <script type="text/javascript">\r
 341     var _gaq = _gaq || [];\r
 342     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 343     _gaq.push(['_trackPageview']);\r
 344 \r
 345     (function() {\r
 346       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 347       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 348       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 349     })();\r
 350   </script>\r
 351 </body>\r
 352 </html>\r