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