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">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" value="application/xhtml+xml" />\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="screen,projection"><!--\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 href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 146 </div>
 147 <div  class="sponsor">
 148   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 149 </div>
 150 </div>
 151 </div>
 152 \r
 153 \r
 154 </div>\r
 155 \r
 156 <div class="main">\r
 157 \r
 158 <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>
 159
 160 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 161 _8c.html" target="source" name="GetImageHistogram">GetImageHistogram</a></h2>
 162 <div class="doc-section">
 163
 164 <p>GetImageHistogram() returns the unique colors in an image.</p></ol>
 165
 166 <p>The format of the GetImageHistogram method is:</p>
 167
 168 <pre class="code">
 169   unsigned long GetImageHistogram(const Image *image,
 170     unsigned long *number_colors,ExceptionInfo *exception)
 171 </pre>
 172
 173 <p>A description of each parameter follows.</p></ol>
 174
 175 <h5>image</h5>
 176 <ol><p>the image.</p></ol>
 177
 178 <h5>file</h5>
 179 <ol><p>Write a histogram of the color distribution to this file handle.</p></ol>
 180
 181 <h5>exception</h5>
 182 <ol><p>return any errors or warnings in this structure.</p></ol>
 183
 184  </div>
 185 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 186 _8c.html" target="source" name="IsHistogramImage">IsHistogramImage</a></h2>
 187 <div class="doc-section">
 188
 189 <p>IsHistogramImage() returns MagickTrue if the image has 1024 unique colors or less.</p></ol>
 190
 191 <p>The format of the IsHistogramImage method is:</p>
 192
 193 <pre class="code">
 194   MagickBooleanType IsHistogramImage(const Image *image,
 195     ExceptionInfo *exception)
 196 </pre>
 197
 198 <p>A description of each parameter follows.</p></ol>
 199
 200 <h5>image</h5>
 201 <ol><p>the image.</p></ol>
 202
 203 <h5>exception</h5>
 204 <ol><p>return any errors or warnings in this structure.</p></ol>
 205
 206  </div>
 207 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 208 _8c.html" target="source" name="IsPaletteImage">IsPaletteImage</a></h2>
 209 <div class="doc-section">
 210
 211 <p>IsPaletteImage() returns MagickTrue if the image is PseudoClass and has 256 unique colors or less.</p></ol>
 212
 213 <p>The format of the IsPaletteImage method is:</p>
 214
 215 <pre class="code">
 216   MagickBooleanType IsPaletteImage(const Image *image,
 217     ExceptionInfo *exception)
 218 </pre>
 219
 220 <p>A description of each parameter follows.</p></ol>
 221
 222 <h5>image</h5>
 223 <ol><p>the image.</p></ol>
 224
 225 <h5>exception</h5>
 226 <ol><p>return any errors or warnings in this structure.</p></ol>
 227
 228  </div>
 229 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 230 _8c.html" target="source" name="MinMaxStretchImage">MinMaxStretchImage</a></h2>
 231 <div class="doc-section">
 232
 233 <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>
 234
 235 <p>If the adjustment values are both zero this function is equivelent to a perfect normalization (or autolevel) of the image.</p></ol>
 236
 237 <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>
 238
 239 <p>The 'SyncChannels' is turned on in the 'DefaultChannels' setting by default.</p></ol>
 240
 241 <p>The format of the MinMaxStretchImage method is:</p>
 242
 243 <pre class="code">
 244   MagickBooleanType MinMaxStretchImage(Image *image,
 245     const ChannelType channel, const double black_adjust,
 246     const double white_adjust)
 247 </pre>
 248
 249 <p>A description of each parameter follows:</p></ol>
 250
 251 <h5>image</h5>
 252 <ol><p>The image to auto-level</p></ol>
 253
 254 <h5>channel</h5>
 255 <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>
 256
 257 <h5>black_adjust, white_adjust</h5>
 258 <ol><p>Move the Black/White Point inward from the minimum and maximum points by this color value.</p></ol>
 259
 260  </div>
 261 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 262 _8c.html" target="source" name="GetNumberColors">GetNumberColors</a></h2>
 263 <div class="doc-section">
 264
 265 <p>GetNumberColors() returns the number of unique colors in an image.</p></ol>
 266
 267 <p>The format of the GetNumberColors method is:</p>
 268
 269 <pre class="code">
 270   unsigned long GetNumberColors(const Image *image,FILE *file,
 271     ExceptionInfo *exception)
 272 </pre>
 273
 274 <p>A description of each parameter follows.</p></ol>
 275
 276 <h5>image</h5>
 277 <ol><p>the image.</p></ol>
 278
 279 <h5>file</h5>
 280 <ol><p>Write a histogram of the color distribution to this file handle.</p></ol>
 281
 282 <h5>exception</h5>
 283 <ol><p>return any errors or warnings in this structure.</p></ol>
 284
 285  </div>
 286 <h2><a href="http://www.imagemagick.org/api/MagickCore/histogram
 287 _8c.html" target="source" name="UniqueImageColors">UniqueImageColors</a></h2>
 288 <div class="doc-section">
 289
 290 <p>UniqueImageColors() returns the unique colors of an image.</p></ol>
 291
 292 <p>The format of the UniqueImageColors method is:</p>
 293
 294 <pre class="code">
 295   Image *UniqueImageColors(const Image *image,ExceptionInfo *exception)
 296 </pre>
 297
 298 <p>A description of each parameter follows.</p></ol>
 299
 300 <h5>image</h5>
 301 <ol><p>the image.</p></ol>
 302
 303 <h5>exception</h5>
 304 <ol><p>return any errors or warnings in this structure.</p></ol>
 305
 306  </div>
 307 \r
 308 </div>\r
 309 \r
 310 <div id="linkbar">\r
 311  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 312     <span id="linkbar-center">\r
 313       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 314     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 315     </span>\r
 316     <span id="linkbar-east">&nbsp;</span>\r
 317   </div>\r
 318   <div class="footer">\r
 319     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 320     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 321   </div>\r
 322   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 323 </body>\r
 324 </html>\r