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 xmlns="http://www.w3.org/1999/xhtml" xml: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, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
  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-2011 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"/>
  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   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  31   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  32   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  33   <script type="text/javascript">\r
  34     $(document).ready(function() {\r
  35       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  36         'transitionIn'  : 'elastic',\r
  37         'transitionOut' : 'elastic',\r
  38         'overlayShow'   : false,\r
  39         'opacity'       : true\r
  40       });\r
  41     });\r
  42   </script>\r
  43 </head>\r
  44 \r
  45 <body id="www-imagemagick-org">\r
  46 <div class="titlebar">\r
  47 <a href="../../index.html">\r
  48   <img src="../../images/script.png" alt="[ImageMagick]"\r
  49   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  50 <a href="http://www.networkredux.com">\r
  51   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  52   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  53 <a href="http://www.imagemagick.org/discourse-server/">\r
  54   <img src="../../images/logo.jpg" alt=""\r
  55   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  56 <a href="../../index.html">\r
  57   <img src="../../images/sprite.jpg" alt=""\r
  58   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  59 </div>\r
  60 \r
  61 <div class="westbar">\r
  62 \r
  63 <div class="menu">
  64   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  65 </div>
  66 <div class="sep"></div>\r
  67 <div class="menu">
  68   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  78 </div>
  79 <div class="sep"></div>\r
  80 <div class="menu">
  81   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  82 </div>
  83 <div class="sub">
  84     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  88 </div>
  89 <div class="sub">
  90     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  91 </div>
  92 <div class="menu">
  93   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 103 </div>
 104 <div class="sub">
 105     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 106 </div>
 107 <div class="sep"></div>\r
 108 <div  class="menu">
 109    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 110 </div>
 111 <div class="sub">
 112     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 116  </div>
 117 <div class="menu">
 118   <a title="Resources" href="../../www/resources.html">Resources</a>
 119 </div>
 120 <div class="menu">
 121   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 122 </div>
 123 <div class="menu">
 124   <a title="Download" href="../../www/download.html">Download</a>
 125 </div>
 126 <div class="sep"></div>\r
 127 <div class="menu">
 128   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 129 </div>
 130 <div class="sep"></div>\r
 131 <div class="menu">
 132   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 133 </div>
 134 <div  class="sub">
 135   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 136 </div>
 137 <div class="sep"></div>\r
 138 <div  class="menu">
 139   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 140
 141 <div class="sponsbox">
 142 <div  class="sponsor">
 143    <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011040100025 gabi.schulze-->
 144 </div>
 145 <div  class="sponsor">
 146   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 147 </div>
 148 <div  class="sponsor">
 149   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 150 </div>
 151 <div  class="sponsor">
 152   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 153 </div>
 154 </div>
 155 </div>
 156 </div>\r
 157 \r
 158 <div class="eastbar">\r
 159   <script type="text/javascript">\r
 160   <!--\r
 161     google_ad_client = "pub-3129977114552745";\r
 162     google_ad_slot = "0574824969";\r
 163     google_ad_width = 160;\r
 164     google_ad_height = 600;\r
 165   //-->\r
 166   </script>\r
 167   <script type="text/javascript"\r
 168     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 169   </script>\r
 170 </div>\r
 171 \r
 172 <div class="main">\r
 173 \r
 174 <h1>Module histogram
 175  Methods</h1>
 176 <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>
 177
 178 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 179 _8c.html" target="source" name="GetImageHistogram">GetImageHistogram</a></h2>
 180 <div class="doc-section">
 181
 182 <p>GetImageHistogram() returns the unique colors in an image.</p></ol>
 183
 184 <p>The format of the GetImageHistogram method is:</p>
 185
 186 <pre class="code">
 187   size_t GetImageHistogram(const Image *image,
 188     size_t *number_colors,ExceptionInfo *exception)
 189 </pre>
 190
 191 <p>A description of each parameter follows.</p></ol>
 192
 193 <h5>image</h5>
 194 <ol><p>the image.</p></ol>
 195
 196 <h5>file</h5>
 197 <ol><p>Write a histogram of the color distribution to this file handle.</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="IsHistogramImage">IsHistogramImage</a></h2>
 205 <div class="doc-section">
 206
 207 <p>IsHistogramImage() returns MagickTrue if the image has 1024 unique colors or less.</p></ol>
 208
 209 <p>The format of the IsHistogramImage method is:</p>
 210
 211 <pre class="code">
 212   MagickBooleanType IsHistogramImage(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="IsPaletteImage">IsPaletteImage</a></h2>
 227 <div class="doc-section">
 228
 229 <p>IsPaletteImage() returns MagickTrue if the image is PseudoClass and has 256 unique colors or less.</p></ol>
 230
 231 <p>The format of the IsPaletteImage method is:</p>
 232
 233 <pre class="code">
 234   MagickBooleanType IsPaletteImage(const Image *image,
 235     ExceptionInfo *exception)
 236 </pre>
 237
 238 <p>A description of each parameter follows.</p></ol>
 239
 240 <h5>image</h5>
 241 <ol><p>the image.</p></ol>
 242
 243 <h5>exception</h5>
 244 <ol><p>return any errors or warnings in this structure.</p></ol>
 245
 246  </div>
 247 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 248 _8c.html" target="source" name="MinMaxStretchImage">MinMaxStretchImage</a></h2>
 249 <div class="doc-section">
 250
 251 <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>
 252
 253 <p>If the adjustment values are both zero this function is equivelent to a perfect normalization (or autolevel) of the image.</p></ol>
 254
 255 <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>
 256
 257 <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>
 258
 259 <p>The 'SyncChannels' is turned on in the 'DefaultChannels' setting by default.</p></ol>
 260
 261 <p>The format of the MinMaxStretchImage method is:</p>
 262
 263 <pre class="code">
 264   MagickBooleanType MinMaxStretchImage(Image *image,
 265     const ChannelType channel, const double black_adjust,
 266     const double white_adjust)
 267 </pre>
 268
 269 <p>A description of each parameter follows:</p></ol>
 270
 271 <h5>image</h5>
 272 <ol><p>The image to auto-level</p></ol>
 273
 274 <h5>channel</h5>
 275 <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>
 276
 277 <h5>black_adjust, white_adjust</h5>
 278 <ol><p>Move the Black/White Point inward from the minimum and maximum points by this color value.</p></ol>
 279
 280  </div>
 281 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 282 _8c.html" target="source" name="GetNumberColors">GetNumberColors</a></h2>
 283 <div class="doc-section">
 284
 285 <p>GetNumberColors() returns the number of unique colors in an image.</p></ol>
 286
 287 <p>The format of the GetNumberColors method is:</p>
 288
 289 <pre class="code">
 290   size_t GetNumberColors(const Image *image,FILE *file,
 291     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>file</h5>
 300 <ol><p>Write a histogram of the color distribution to this file handle.</p></ol>
 301
 302 <h5>exception</h5>
 303 <ol><p>return any errors or warnings in this structure.</p></ol>
 304
 305  </div>
 306 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 307 _8c.html" target="source" name="UniqueImageColors">UniqueImageColors</a></h2>
 308 <div class="doc-section">
 309
 310 <p>UniqueImageColors() returns the unique colors of an image.</p></ol>
 311
 312 <p>The format of the UniqueImageColors method is:</p>
 313
 314 <pre class="code">
 315   Image *UniqueImageColors(const Image *image,ExceptionInfo *exception)
 316 </pre>
 317
 318 <p>A description of each parameter follows.</p></ol>
 319
 320 <h5>image</h5>
 321 <ol><p>the image.</p></ol>
 322
 323 <h5>exception</h5>
 324 <ol><p>return any errors or warnings in this structure.</p></ol>
 325
 326  </div>
 327 \r
 328 </div>\r
 329 \r
 330 <div id="linkbar">\r
 331     <span id="linkbar-west">&nbsp;</span>\r
 332     <span id="linkbar-center">\r
 333       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 334       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 335     </span>\r
 336     <span id="linkbar-east">&nbsp;</span>\r
 337   </div>\r
 338   <div class="footer">\r
 339     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 340     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 341   </div>\r
 342   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 343   <script type="text/javascript">\r
 344     var _gaq = _gaq || [];\r
 345     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 346     _gaq.push(['_trackPageview']);\r
 347 \r
 348     (function() {\r
 349       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 350       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 351       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 352     })();\r
 353   </script>\r
 354 </body>\r
 355 </html>\r