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>
 145 </div>
 146 \r
 147 \r
 148 </div>\r
 149 \r
 150 <div class="main">\r
 151 \r
 152 <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>
 153
 154 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 155 _8c.html" target="source" name="GetImageHistogram">GetImageHistogram</a></h2>
 156 <div class="doc-section">
 157
 158 <p>GetImageHistogram() returns the unique colors in an image.</p></ol>
 159
 160 <p>The format of the GetImageHistogram method is:</p>
 161
 162 <pre class="code">
 163   size_t GetImageHistogram(const Image *image,
 164     size_t *number_colors,ExceptionInfo *exception)
 165 </pre>
 166
 167 <p>A description of each parameter follows.</p></ol>
 168
 169 <h5>image</h5>
 170 <ol><p>the image.</p></ol>
 171
 172 <h5>file</h5>
 173 <ol><p>Write a histogram of the color distribution to this file handle.</p></ol>
 174
 175 <h5>exception</h5>
 176 <ol><p>return any errors or warnings in this structure.</p></ol>
 177
 178  </div>
 179 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 180 _8c.html" target="source" name="IsHistogramImage">IsHistogramImage</a></h2>
 181 <div class="doc-section">
 182
 183 <p>IsHistogramImage() returns MagickTrue if the image has 1024 unique colors or less.</p></ol>
 184
 185 <p>The format of the IsHistogramImage method is:</p>
 186
 187 <pre class="code">
 188   MagickBooleanType IsHistogramImage(const Image *image,
 189     ExceptionInfo *exception)
 190 </pre>
 191
 192 <p>A description of each parameter follows.</p></ol>
 193
 194 <h5>image</h5>
 195 <ol><p>the image.</p></ol>
 196
 197 <h5>exception</h5>
 198 <ol><p>return any errors or warnings in this structure.</p></ol>
 199
 200  </div>
 201 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 202 _8c.html" target="source" name="IsPaletteImage">IsPaletteImage</a></h2>
 203 <div class="doc-section">
 204
 205 <p>IsPaletteImage() returns MagickTrue if the image is PseudoClass and has 256 unique colors or less.</p></ol>
 206
 207 <p>The format of the IsPaletteImage method is:</p>
 208
 209 <pre class="code">
 210   MagickBooleanType IsPaletteImage(const Image *image,
 211     ExceptionInfo *exception)
 212 </pre>
 213
 214 <p>A description of each parameter follows.</p></ol>
 215
 216 <h5>image</h5>
 217 <ol><p>the image.</p></ol>
 218
 219 <h5>exception</h5>
 220 <ol><p>return any errors or warnings in this structure.</p></ol>
 221
 222  </div>
 223 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 224 _8c.html" target="source" name="MinMaxStretchImage">MinMaxStretchImage</a></h2>
 225 <div class="doc-section">
 226
 227 <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>
 228
 229 <p>If the adjustment values are both zero this function is equivelent to a perfect normalization (or autolevel) of the image.</p></ol>
 230
 231 <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>
 232
 233 <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>
 234
 235 <p>The 'SyncChannels' is turned on in the 'DefaultChannels' setting by default.</p></ol>
 236
 237 <p>The format of the MinMaxStretchImage method is:</p>
 238
 239 <pre class="code">
 240   MagickBooleanType MinMaxStretchImage(Image *image,
 241     const ChannelType channel, const double black_adjust,
 242     const double white_adjust)
 243 </pre>
 244
 245 <p>A description of each parameter follows:</p></ol>
 246
 247 <h5>image</h5>
 248 <ol><p>The image to auto-level</p></ol>
 249
 250 <h5>channel</h5>
 251 <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>
 252
 253 <h5>black_adjust, white_adjust</h5>
 254 <ol><p>Move the Black/White Point inward from the minimum and maximum points by this color value.</p></ol>
 255
 256  </div>
 257 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 258 _8c.html" target="source" name="GetNumberColors">GetNumberColors</a></h2>
 259 <div class="doc-section">
 260
 261 <p>GetNumberColors() returns the number of unique colors in an image.</p></ol>
 262
 263 <p>The format of the GetNumberColors method is:</p>
 264
 265 <pre class="code">
 266   size_t GetNumberColors(const Image *image,FILE *file,
 267     ExceptionInfo *exception)
 268 </pre>
 269
 270 <p>A description of each parameter follows.</p></ol>
 271
 272 <h5>image</h5>
 273 <ol><p>the image.</p></ol>
 274
 275 <h5>file</h5>
 276 <ol><p>Write a histogram of the color distribution to this file handle.</p></ol>
 277
 278 <h5>exception</h5>
 279 <ol><p>return any errors or warnings in this structure.</p></ol>
 280
 281  </div>
 282 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 283 _8c.html" target="source" name="UniqueImageColors">UniqueImageColors</a></h2>
 284 <div class="doc-section">
 285
 286 <p>UniqueImageColors() returns the unique colors of an image.</p></ol>
 287
 288 <p>The format of the UniqueImageColors method is:</p>
 289
 290 <pre class="code">
 291   Image *UniqueImageColors(const Image *image,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>exception</h5>
 300 <ol><p>return any errors or warnings in this structure.</p></ol>
 301
 302  </div>
 303 \r
 304 </div>\r
 305 \r
 306 <div id="linkbar">\r
 307  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 308     <span id="linkbar-center">\r
 309       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 310     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 311     </span>\r
 312     <span id="linkbar-east">&nbsp;</span>\r
 313   </div>\r
 314   <div class="footer">\r
 315     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 316     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 317   </div>\r
 318   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 319 </body>\r
 320 </html>\r