granicus.if.org Git - imagemagick/blob - www/api/statistic.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   8 <head>\r
   9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Image Statistics</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Application-name" content="ImageMagick"/>
  16   <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images."/>
  17   <meta name="Application-url" content="http://www.imagemagick.org"/>
  18   <meta name="Generator" content="PHP"/>
  19   <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"/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28   <link rel="icon" href="../../images/wand.png"/>
  29   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  32   <style type="text/css" media="all">\r
  33     @import url("../../www/magick.css");\r
  34   </style>\r
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  38   <script type="text/javascript">\r
  39     $(document).ready(function() {\r
  40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  41         'transitionIn'  : 'elastic',\r
  42         'transitionOut' : 'elastic',\r
  43         'overlayShow'   : false,\r
  44         'opacity'       : true\r
  45       });\r
  46     });\r
  47   </script>\r
  48 </head>\r
  49 \r
  50 <body id="www-imagemagick-org">\r
  51 <div class="titlebar">\r
  52 <div style="margin: 17px auto; float: left;">\r
  53   <script type="text/javascript">\r
  54   <!--\r
  55     google_ad_client = "pub-3129977114552745";\r
  56     google_ad_slot = "5439289906";\r
  57     google_ad_width = 728;\r
  58     google_ad_height = 90;\r
  59   //-->\r
  60   </script>\r
  61   <script type="text/javascript"\r
  62     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  63   </script>\r
  64 </div>\r
  65 <a href="http://www.imagemagick.org/discourse-server/">\r
  66   <img src="../../images/logo.jpg"\r
  67   alt="ImageMagick Logo"\r
  68   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  69 <a href="../../index.html">\r
  70   <img src="../../images/sprite.jpg"\r
  71   alt="ImageMagick Sprite"\r
  72   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  73 </div>\r
  74 \r
  75 <div class="westbar">\r
  76 \r
  77 <div class="menu">
  78   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div class="menu">
  82   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  83 </div>
  84 <div class="sub">
  85     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  89 </div>
  90 <div class="sub">
  91     <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  95 </div>
  96 <div class="sep"></div>\r
  97 <div class="menu">
  98   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 105 </div>
 106 <div class="sub">
 107     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 108 </div>
 109 <div class="menu">
 110   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 111 </div>
 112 <div class="sub">
 113     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 114 </div>
 115 <div class="sub">
 116     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 117 </div>
 118 <div class="sub">
 119     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 133  </div>
 134 <div class="menu">
 135   <a title="Resources" href="../../www/resources.html">Resources</a>
 136 </div>
 137 <div class="menu">
 138   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 139 </div>
 140 <div class="menu">
 141   <a title="Download" href="../../www/download.html">Download</a>
 142 </div>
 143 <div class="sep"></div>\r
 144 <div class="menu">
 145   <a title="Search" href="../../www/search.html">Search</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div class="menu">
 149   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 150 </div>
 151 <div  class="sub">
 152   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 153 </div>
 154 <div class="sep"></div>\r
 155 <div  class="menu">
 156   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 157
 158 <a href="http://www.networkredux.com">
 159   <img src="../../images/networkredux.png" alt="[sponsor]"
 160   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 161 <div class="sponsbox">
 162 <div  class="sponsor">
 163   <a title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
 164 </div>
 165 <div  class="sponsor">
 166   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 167 </div>
 168 <div  class="sponsor">
 169   <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 170 </div>
 171 <div  class="sponsor">
 172   <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201107010090 alexanian media -->
 173 </div>
 174 <div  class="sponsor">
 175   <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 176 </div>
 177 <div  class="sponsor">
 178   <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 179 </div>
 180 <div  class="sponsor">
 181   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 182 </div>
 183 <div  class="sponsor">
 184   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 185 </div>
 186 <div  class="sponsor">
 187    <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011060100025 gabi.schulze-->
 188 </div>
 189 </div>
 190 </div>
 191 </div>\r
 192 \r
 193 <div class="eastbar">\r
 194 \r
 195 </div>\r
 196 \r
 197 <div class="main">\r
 198 \r
 199 <h1>Module statistic Methods</h1>
 200 <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>
 201
 202 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic_8c.html" id="EvaluateImage">EvaluateImage</a></h2>
 203 <div class="doc-section">
 204
 205 <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>
 206
 207 <p>The format of the EvaluateImageChannel method is:</p>
 208
 209 <pre class="code">
 210   MagickBooleanType EvaluateImage(Image *image,
 211     const MagickEvaluateOperator op,const double value,
 212     ExceptionInfo *exception)
 213   MagickBooleanType EvaluateImages(Image *images,
 214     const MagickEvaluateOperator op,const double value,
 215     ExceptionInfo *exception)
 216   MagickBooleanType EvaluateImageChannel(Image *image,
 217     const ChannelType channel,const MagickEvaluateOperator op,
 218     const double value,ExceptionInfo *exception)
 219 </pre>
 220
 221 <p>A description of each parameter follows:</p>
 222
 223 <h5>image</h5>
 224 <p>the image.</p>
 225
 226 <h5>channel</h5>
 227 <p>the channel.</p>
 228
 229 <h5>op</h5>
 230 <p>A channel op.</p>
 231
 232 <h5>value</h5>
 233 <p>A value value.</p>
 234
 235 <h5>exception</h5>
 236 <p>return any errors or warnings in this structure.</p>
 237
 238  </div>
 239 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic_8c.html" id="FunctionImage">FunctionImage</a></h2>
 240 <div class="doc-section">
 241
 242 <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>
 243
 244 <p>The format of the FunctionImageChannel method is:</p>
 245
 246 <pre class="code">
 247   MagickBooleanType FunctionImage(Image *image,
 248     const MagickFunction function,const ssize_t number_parameters,
 249     const double *parameters,ExceptionInfo *exception)
 250   MagickBooleanType FunctionImageChannel(Image *image,
 251     const ChannelType channel,const MagickFunction function,
 252     const ssize_t number_parameters,const double *argument,
 253     ExceptionInfo *exception)
 254 </pre>
 255
 256 <p>A description of each parameter follows:</p>
 257
 258 <h5>image</h5>
 259 <p>the image.</p>
 260
 261 <h5>channel</h5>
 262 <p>the channel.</p>
 263
 264 <h5>function</h5>
 265 <p>A channel function.</p>
 266
 267 <h5>parameters</h5>
 268 <p>one or more parameters.</p>
 269
 270 <h5>exception</h5>
 271 <p>return any errors or warnings in this structure.</p>
 272
 273  </div>
 274 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic_8c.html" id="GetImageChannelMean">GetImageChannelMean</a></h2>
 275 <div class="doc-section">
 276
 277 <p>GetImageChannelMean() returns the mean and standard deviation of one or more image channels.</p>
 278
 279 <p>The format of the GetImageChannelMean method is:</p>
 280
 281 <pre class="code">
 282   MagickBooleanType GetImageChannelMean(const Image *image,
 283     const ChannelType channel,double *mean,double *standard_deviation,
 284     ExceptionInfo *exception)
 285 </pre>
 286
 287 <p>A description of each parameter follows:</p>
 288
 289 <h5>image</h5>
 290 <p>the image.</p>
 291
 292 <h5>channel</h5>
 293 <p>the channel.</p>
 294
 295 <h5>mean</h5>
 296 <p>the average value in the channel.</p>
 297
 298 <h5>standard_deviation</h5>
 299 <p>the standard deviation of the channel.</p>
 300
 301 <h5>exception</h5>
 302 <p>return any errors or warnings in this structure.</p>
 303
 304  </div>
 305 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic_8c.html" id="GetImageChannelKurtosis">GetImageChannelKurtosis</a></h2>
 306 <div class="doc-section">
 307
 308 <p>GetImageChannelKurtosis() returns the kurtosis and skewness of one or more image channels.</p>
 309
 310 <p>The format of the GetImageChannelKurtosis method is:</p>
 311
 312 <pre class="code">
 313   MagickBooleanType GetImageChannelKurtosis(const Image *image,
 314     const ChannelType channel,double *kurtosis,double *skewness,
 315     ExceptionInfo *exception)
 316 </pre>
 317
 318 <p>A description of each parameter follows:</p>
 319
 320 <h5>image</h5>
 321 <p>the image.</p>
 322
 323 <h5>channel</h5>
 324 <p>the channel.</p>
 325
 326 <h5>kurtosis</h5>
 327 <p>the kurtosis of the channel.</p>
 328
 329 <h5>skewness</h5>
 330 <p>the skewness of the channel.</p>
 331
 332 <h5>exception</h5>
 333 <p>return any errors or warnings in this structure.</p>
 334
 335  </div>
 336 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic_8c.html" id="GetImageChannelRange">GetImageChannelRange</a></h2>
 337 <div class="doc-section">
 338
 339 <p>GetImageChannelRange() returns the range of one or more image channels.</p>
 340
 341 <p>The format of the GetImageChannelRange method is:</p>
 342
 343 <pre class="code">
 344   MagickBooleanType GetImageChannelRange(const Image *image,
 345     const ChannelType channel,double *minima,double *maxima,
 346     ExceptionInfo *exception)
 347 </pre>
 348
 349 <p>A description of each parameter follows:</p>
 350
 351 <h5>image</h5>
 352 <p>the image.</p>
 353
 354 <h5>channel</h5>
 355 <p>the channel.</p>
 356
 357 <h5>minima</h5>
 358 <p>the minimum value in the channel.</p>
 359
 360 <h5>maxima</h5>
 361 <p>the maximum value in the channel.</p>
 362
 363 <h5>exception</h5>
 364 <p>return any errors or warnings in this structure.</p>
 365
 366  </div>
 367 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic_8c.html" id="GetImageChannelStatistics">GetImageChannelStatistics</a></h2>
 368 <div class="doc-section">
 369
 370 <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>
 371
 372 <pre class="text">
 373   channel_statistics=GetImageChannelStatistics(image,exception);
 374   red_mean=channel_statistics[RedChannel].mean;
 375 </pre>
 376
 377 <p>Use MagickRelinquishMemory() to free the statistics buffer.</p>
 378
 379 <p>The format of the GetImageChannelStatistics method is:</p>
 380
 381 <pre class="code">
 382   ChannelStatistics *GetImageChannelStatistics(const Image *image,
 383     ExceptionInfo *exception)
 384 </pre>
 385
 386 <p>A description of each parameter follows:</p>
 387
 388 <h5>image</h5>
 389 <p>the image.</p>
 390
 391 <h5>exception</h5>
 392 <p>return any errors or warnings in this structure.</p>
 393
 394  </div>
 395 \r
 396 </div>\r
 397 \r
 398 <div id="linkbar">\r
 399     <span id="linkbar-west">&nbsp;</span>\r
 400     <span id="linkbar-center">\r
 401       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 402       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 403     </span>\r
 404     <span id="linkbar-east">&nbsp;</span>\r
 405   </div>\r
 406   <div class="footer">\r
 407     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 408     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 409   </div>\r
 410   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 411   <script type="text/javascript">\r
 412     var _gaq = _gaq || [];\r
 413     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 414     _gaq.push(['_trackPageview']);\r
 415 \r
 416     (function() {\r
 417       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 418       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 419       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 420     })();\r
 421   </script>\r
 422 </body>\r
 423 </html>\r