granicus.if.org Git - imagemagick/blob - www/api/statistic.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 Statistics</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, 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."/>
  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, statistics, 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-2010 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: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 146 </div>
 147 <div  class="sponsor">
 148    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 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 <p class="navigation-index">[<a href="#EvaluateImage">EvaluateImage</a> &bull; <a href="#FunctionImage">FunctionImage</a> &bull; <a href="#GetImageChannelMean">GetImageChannelMean</a> &bull; <a href="#GetImageChannelKurtosis">GetImageChannelKurtosis</a> &bull; <a href="#GetImageChannelRange">GetImageChannelRange</a> &bull; <a href="#GetImageChannelStatistics">GetImageChannelStatistics</a>]</p>
 171
 172 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 173 _8c.html" target="source" name="EvaluateImage">EvaluateImage</a></h2>
 174 <div class="doc-section">
 175
 176 <p>EvaluateImage() applies a value to the image with an arithmetic, relational, or logical operator to an image. Use these operations to lighten or darken an image, to increase or decrease contrast in an image, or to produce the "negative" of an image.</p></ol>
 177
 178 <p>The format of the EvaluateImageChannel method is:</p>
 179
 180 <pre class="code">
 181   MagickBooleanType EvaluateImage(Image *image,
 182     const MagickEvaluateOperator op,const double value,
 183     ExceptionInfo *exception)
 184   MagickBooleanType EvaluateImages(Image *images,
 185     const MagickEvaluateOperator op,const double value,
 186     ExceptionInfo *exception)
 187   MagickBooleanType EvaluateImageChannel(Image *image,
 188     const ChannelType channel,const MagickEvaluateOperator op,
 189     const double value,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>channel</h5>
 198 <ol><p>the channel.</p></ol>
 199
 200 <h5>op</h5>
 201 <ol><p>A channel op.</p></ol>
 202
 203 <h5>value</h5>
 204 <ol><p>A value value.</p></ol>
 205
 206 <h5>exception</h5>
 207 <ol><p>return any errors or warnings in this structure.</p></ol>
 208
 209  </div>
 210 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 211 _8c.html" target="source" name="FunctionImage">FunctionImage</a></h2>
 212 <div class="doc-section">
 213
 214 <p>FunctionImage() applies a value to the image with an arithmetic, relational, or logical operator to an image. Use these operations to lighten or darken an image, to increase or decrease contrast in an image, or to produce the "negative" of an image.</p></ol>
 215
 216 <p>The format of the FunctionImageChannel method is:</p>
 217
 218 <pre class="code">
 219   MagickBooleanType FunctionImage(Image *image,
 220     const MagickFunction function,const ssize_t number_parameters,
 221     const double *parameters,ExceptionInfo *exception)
 222   MagickBooleanType FunctionImageChannel(Image *image,
 223     const ChannelType channel,const MagickFunction function,
 224     const ssize_t number_parameters,const double *argument,
 225     ExceptionInfo *exception)
 226 </pre>
 227
 228 <p>A description of each parameter follows:</p></ol>
 229
 230 <h5>image</h5>
 231 <ol><p>the image.</p></ol>
 232
 233 <h5>channel</h5>
 234 <ol><p>the channel.</p></ol>
 235
 236 <h5>function</h5>
 237 <ol><p>A channel function.</p></ol>
 238
 239 <h5>parameters</h5>
 240 <ol><p>one or more parameters.</p></ol>
 241
 242 <h5>exception</h5>
 243 <ol><p>return any errors or warnings in this structure.</p></ol>
 244
 245  </div>
 246 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 247 _8c.html" target="source" name="GetImageChannelMean">GetImageChannelMean</a></h2>
 248 <div class="doc-section">
 249
 250 <p>GetImageChannelMean() returns the mean and standard deviation of one or more image channels.</p></ol>
 251
 252 <p>The format of the GetImageChannelMean method is:</p>
 253
 254 <pre class="code">
 255   MagickBooleanType GetImageChannelMean(const Image *image,
 256     const ChannelType channel,double *mean,double *standard_deviation,
 257     ExceptionInfo *exception)
 258 </pre>
 259
 260 <p>A description of each parameter follows:</p></ol>
 261
 262 <h5>image</h5>
 263 <ol><p>the image.</p></ol>
 264
 265 <h5>channel</h5>
 266 <ol><p>the channel.</p></ol>
 267
 268 <h5>mean</h5>
 269 <ol><p>the average value in the channel.</p></ol>
 270
 271 <h5>standard_deviation</h5>
 272 <ol><p>the standard deviation of the channel.</p></ol>
 273
 274 <h5>exception</h5>
 275 <ol><p>return any errors or warnings in this structure.</p></ol>
 276
 277  </div>
 278 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 279 _8c.html" target="source" name="GetImageChannelKurtosis">GetImageChannelKurtosis</a></h2>
 280 <div class="doc-section">
 281
 282 <p>GetImageChannelKurtosis() returns the kurtosis and skewness of one or more image channels.</p></ol>
 283
 284 <p>The format of the GetImageChannelKurtosis method is:</p>
 285
 286 <pre class="code">
 287   MagickBooleanType GetImageChannelKurtosis(const Image *image,
 288     const ChannelType channel,double *kurtosis,double *skewness,
 289     ExceptionInfo *exception)
 290 </pre>
 291
 292 <p>A description of each parameter follows:</p></ol>
 293
 294 <h5>image</h5>
 295 <ol><p>the image.</p></ol>
 296
 297 <h5>channel</h5>
 298 <ol><p>the channel.</p></ol>
 299
 300 <h5>kurtosis</h5>
 301 <ol><p>the kurtosis of the channel.</p></ol>
 302
 303 <h5>skewness</h5>
 304 <ol><p>the skewness of the channel.</p></ol>
 305
 306 <h5>exception</h5>
 307 <ol><p>return any errors or warnings in this structure.</p></ol>
 308
 309  </div>
 310 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 311 _8c.html" target="source" name="GetImageChannelRange">GetImageChannelRange</a></h2>
 312 <div class="doc-section">
 313
 314 <p>GetImageChannelRange() returns the range of one or more image channels.</p></ol>
 315
 316 <p>The format of the GetImageChannelRange method is:</p>
 317
 318 <pre class="code">
 319   MagickBooleanType GetImageChannelRange(const Image *image,
 320     const ChannelType channel,double *minima,double *maxima,
 321     ExceptionInfo *exception)
 322 </pre>
 323
 324 <p>A description of each parameter follows:</p></ol>
 325
 326 <h5>image</h5>
 327 <ol><p>the image.</p></ol>
 328
 329 <h5>channel</h5>
 330 <ol><p>the channel.</p></ol>
 331
 332 <h5>minima</h5>
 333 <ol><p>the minimum value in the channel.</p></ol>
 334
 335 <h5>maxima</h5>
 336 <ol><p>the maximum value in the channel.</p></ol>
 337
 338 <h5>exception</h5>
 339 <ol><p>return any errors or warnings in this structure.</p></ol>
 340
 341  </div>
 342 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 343 _8c.html" target="source" name="GetImageChannelStatistics">GetImageChannelStatistics</a></h2>
 344 <div class="doc-section">
 345
 346 <p>GetImageChannelStatistics() returns statistics for each channel in the image.  The statistics include the channel depth, its minima, maxima, mean, standard deviation, kurtosis and skewness.  You can access the red channel mean, for example, like this:</p>
 347
 348 <pre class="text">
 349   channel_statistics=GetImageChannelStatistics(image,excepton);
 350   red_mean=channel_statistics[RedChannel].mean;
 351 </pre>
 352
 353 <p>Use MagickRelinquishMemory() to free the statistics buffer.</p></ol>
 354
 355 <p>The format of the GetImageChannelStatistics method is:</p>
 356
 357 <pre class="code">
 358   ChannelStatistics *GetImageChannelStatistics(const Image *image,
 359     ExceptionInfo *exception)
 360 </pre>
 361
 362 <p>A description of each parameter follows:</p></ol>
 363
 364 <h5>image</h5>
 365 <ol><p>the image.</p></ol>
 366
 367 <h5>exception</h5>
 368 <ol><p>return any errors or warnings in this structure.</p></ol>
 369
 370  </div>
 371 \r
 372 </div>\r
 373 \r
 374 <div id="linkbar">\r
 375     <span id="linkbar-west">&nbsp;</span>\r
 376     <span id="linkbar-center">\r
 377       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 378       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 379     </span>\r
 380     <span id="linkbar-east">&nbsp;</span>\r
 381   </div>\r
 382   <div class="footer">\r
 383     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 384     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 385   </div>\r
 386   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 387   <script type="text/javascript">\r
 388     var _gaq = _gaq || [];\r
 389     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 390     _gaq.push(['_trackPageview']);\r
 391 \r
 392     (function() {\r
 393       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 394       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 395       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 396     })();\r
 397   </script>\r
 398 </body>\r
 399 </html>\r