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   <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 Statistics</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, statistics, 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="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a title="Resources" href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 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: Online-Magazin" href="http://www.unkostenbeitrag.de/" title="Online-Magazin">Online-Magazin</a><!-- 20101101000200 -->
 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="#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>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 158 _8c.html" target="source" name="EvaluateImage">EvaluateImage</a></h2>
 159 <div class="doc-section">
 160
 161 <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>
 162
 163 <p>The format of the EvaluateImageChannel method is:</p>
 164
 165 <pre class="code">
 166   MagickBooleanType EvaluateImage(Image *image,
 167     const MagickEvaluateOperator op,const double value,
 168     ExceptionInfo *exception)
 169   MagickBooleanType EvaluateImages(Image *images,
 170     const MagickEvaluateOperator op,const double value,
 171     ExceptionInfo *exception)
 172   MagickBooleanType EvaluateImageChannel(Image *image,
 173     const ChannelType channel,const MagickEvaluateOperator op,
 174     const double value,ExceptionInfo *exception)
 175 </pre>
 176
 177 <p>A description of each parameter follows:</p></ol>
 178
 179 <h5>image</h5>
 180 <ol><p>the image.</p></ol>
 181
 182 <h5>channel</h5>
 183 <ol><p>the channel.</p></ol>
 184
 185 <h5>op</h5>
 186 <ol><p>A channel op.</p></ol>
 187
 188 <h5>value</h5>
 189 <ol><p>A value value.</p></ol>
 190
 191 <h5>exception</h5>
 192 <ol><p>return any errors or warnings in this structure.</p></ol>
 193
 194  </div>
 195 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 196 _8c.html" target="source" name="FunctionImage">FunctionImage</a></h2>
 197 <div class="doc-section">
 198
 199 <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>
 200
 201 <p>The format of the FunctionImageChannel method is:</p>
 202
 203 <pre class="code">
 204   MagickBooleanType FunctionImage(Image *image,
 205     const MagickFunction function,const long number_parameters,
 206     const double *parameters,ExceptionInfo *exception)
 207   MagickBooleanType FunctionImageChannel(Image *image,
 208     const ChannelType channel,const MagickFunction function,
 209     const long number_parameters,const double *argument,
 210     ExceptionInfo *exception)
 211 </pre>
 212
 213 <p>A description of each parameter follows:</p></ol>
 214
 215 <h5>image</h5>
 216 <ol><p>the image.</p></ol>
 217
 218 <h5>channel</h5>
 219 <ol><p>the channel.</p></ol>
 220
 221 <h5>function</h5>
 222 <ol><p>A channel function.</p></ol>
 223
 224 <h5>parameters</h5>
 225 <ol><p>one or more parameters.</p></ol>
 226
 227 <h5>exception</h5>
 228 <ol><p>return any errors or warnings in this structure.</p></ol>
 229
 230  </div>
 231 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 232 _8c.html" target="source" name="GetImageChannelMean">GetImageChannelMean</a></h2>
 233 <div class="doc-section">
 234
 235 <p>GetImageChannelMean() returns the mean and standard deviation of one or more image channels.</p></ol>
 236
 237 <p>The format of the GetImageChannelMean method is:</p>
 238
 239 <pre class="code">
 240   MagickBooleanType GetImageChannelMean(const Image *image,
 241     const ChannelType channel,double *mean,double *standard_deviation,
 242     ExceptionInfo *exception)
 243 </pre>
 244
 245 <p>A description of each parameter follows:</p></ol>
 246
 247 <h5>image</h5>
 248 <ol><p>the image.</p></ol>
 249
 250 <h5>channel</h5>
 251 <ol><p>the channel.</p></ol>
 252
 253 <h5>mean</h5>
 254 <ol><p>the average value in the channel.</p></ol>
 255
 256 <h5>standard_deviation</h5>
 257 <ol><p>the standard deviation of the channel.</p></ol>
 258
 259 <h5>exception</h5>
 260 <ol><p>return any errors or warnings in this structure.</p></ol>
 261
 262  </div>
 263 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 264 _8c.html" target="source" name="GetImageChannelKurtosis">GetImageChannelKurtosis</a></h2>
 265 <div class="doc-section">
 266
 267 <p>GetImageChannelKurtosis() returns the kurtosis and skewness of one or more image channels.</p></ol>
 268
 269 <p>The format of the GetImageChannelKurtosis method is:</p>
 270
 271 <pre class="code">
 272   MagickBooleanType GetImageChannelKurtosis(const Image *image,
 273     const ChannelType channel,double *kurtosis,double *skewness,
 274     ExceptionInfo *exception)
 275 </pre>
 276
 277 <p>A description of each parameter follows:</p></ol>
 278
 279 <h5>image</h5>
 280 <ol><p>the image.</p></ol>
 281
 282 <h5>channel</h5>
 283 <ol><p>the channel.</p></ol>
 284
 285 <h5>kurtosis</h5>
 286 <ol><p>the kurtosis of the channel.</p></ol>
 287
 288 <h5>skewness</h5>
 289 <ol><p>the skewness of the channel.</p></ol>
 290
 291 <h5>exception</h5>
 292 <ol><p>return any errors or warnings in this structure.</p></ol>
 293
 294  </div>
 295 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 296 _8c.html" target="source" name="GetImageChannelRange">GetImageChannelRange</a></h2>
 297 <div class="doc-section">
 298
 299 <p>GetImageChannelRange() returns the range of one or more image channels.</p></ol>
 300
 301 <p>The format of the GetImageChannelRange method is:</p>
 302
 303 <pre class="code">
 304   MagickBooleanType GetImageChannelRange(const Image *image,
 305     const ChannelType channel,double *minima,double *maxima,
 306     ExceptionInfo *exception)
 307 </pre>
 308
 309 <p>A description of each parameter follows:</p></ol>
 310
 311 <h5>image</h5>
 312 <ol><p>the image.</p></ol>
 313
 314 <h5>channel</h5>
 315 <ol><p>the channel.</p></ol>
 316
 317 <h5>minima</h5>
 318 <ol><p>the minimum value in the channel.</p></ol>
 319
 320 <h5>maxima</h5>
 321 <ol><p>the maximum value in the channel.</p></ol>
 322
 323 <h5>exception</h5>
 324 <ol><p>return any errors or warnings in this structure.</p></ol>
 325
 326  </div>
 327 <h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
 328 _8c.html" target="source" name="GetImageChannelStatistics">GetImageChannelStatistics</a></h2>
 329 <div class="doc-section">
 330
 331 <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>
 332
 333 <pre class="text">
 334   channel_statistics=GetImageChannelStatistics(image,excepton);
 335   red_mean=channel_statistics[RedChannel].mean;
 336 </pre>
 337
 338 <p>Use MagickRelinquishMemory() to free the statistics buffer.</p></ol>
 339
 340 <p>The format of the GetImageChannelStatistics method is:</p>
 341
 342 <pre class="code">
 343   ChannelStatistics *GetImageChannelStatistics(const Image *image,
 344     ExceptionInfo *exception)
 345 </pre>
 346
 347 <p>A description of each parameter follows:</p></ol>
 348
 349 <h5>image</h5>
 350 <ol><p>the image.</p></ol>
 351
 352 <h5>exception</h5>
 353 <ol><p>return any errors or warnings in this structure.</p></ol>
 354
 355  </div>
 356 \r
 357 </div>\r
 358 \r
 359 <div id="linkbar">\r
 360  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 361     <span id="linkbar-center">\r
 362       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 363     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 364     </span>\r
 365     <span id="linkbar-east">&nbsp;</span>\r
 366   </div>\r
 367   <div class="footer">\r
 368     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 369     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 370   </div>\r
 371   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 372 </body>\r
 373 </html>\r