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