blob: d106066b6b0ba51611f721f7f43210f638d00ad4 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickCore, C API for ImageMagick: Image Statistics</title>
cristy3749be42010-02-02 02:46:51 +00008 <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"/>
cristy3c98a4f2010-08-13 20:09:41 +000011 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +000012 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000013 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3749be42010-02-02 02:46:51 +000014 <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"/>
cristy3749be42010-02-02 02:46:51 +000016 <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"/>
cristy4103d562010-12-10 01:38:54 +000022 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3749be42010-02-02 02:46:51 +000023 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +000024 <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"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +000030</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +000048<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000049
cristy3749be42010-02-02 02:46:51 +000050<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000051 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3749be42010-02-02 02:46:51 +000052</div>
cristy3eaa0ef2010-03-06 20:35:26 +000053<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +000054<div class="menu">
cristybb503372010-05-27 20:51:26 +000055 <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>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3749be42010-02-02 02:46:51 +000069</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3749be42010-02-02 02:46:51 +000072</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000074 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3749be42010-02-02 02:46:51 +000075</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3749be42010-02-02 02:46:51 +000078</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3749be42010-02-02 02:46:51 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3749be42010-02-02 02:46:51 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3749be42010-02-02 02:46:51 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3749be42010-02-02 02:46:51 +000090</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000092 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3749be42010-02-02 02:46:51 +000093</div>
cristy3eaa0ef2010-03-06 20:35:26 +000094<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +000095<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3749be42010-02-02 02:46:51 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3749be42010-02-02 02:46:51 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3749be42010-02-02 02:46:51 +0000103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3749be42010-02-02 02:46:51 +0000106</div>
cristybb503372010-05-27 20:51:26 +0000107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3749be42010-02-02 02:46:51 +0000110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Download" href="../../www/download.html">Download</a>
cristy3749be42010-02-02 02:46:51 +0000112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000113<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3749be42010-02-02 02:46:51 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3749be42010-02-02 02:46:51 +0000120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3749be42010-02-02 02:46:51 +0000123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000124<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3749be42010-02-02 02:46:51 +0000127
128<div class="sponsbox">
129<div class="sponsor">
cristy307ba182010-12-25 01:00:34 +0000130 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011040100025 atlas.multimedia-->
cristy7d52cd62010-10-01 17:26:59 +0000131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy320dd6e2010-04-16 20:11:40 +0000143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy3749be42010-02-02 02:46:51 +0000149</div>
cristy3749be42010-02-02 02:46:51 +0000150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000153
cristyce69bb02010-07-27 19:49:46 +0000154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000166</div>
167
168<div class="main">
169
cristy307ba182010-12-25 01:00:34 +0000170<h1>Module statistic
171 Methods</h1>
cristy63fed272010-03-07 19:08:45 +0000172<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>
cristy3749be42010-02-02 02:46:51 +0000173
174<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
cristy63fed272010-03-07 19:08:45 +0000175_8c.html" target="source" name="EvaluateImage">EvaluateImage</a></h2>
cristy3749be42010-02-02 02:46:51 +0000176<div class="doc-section">
177
cristy63fed272010-03-07 19:08:45 +0000178<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>
cristy3749be42010-02-02 02:46:51 +0000179
cristy63fed272010-03-07 19:08:45 +0000180<p>The format of the EvaluateImageChannel method is:</p>
cristy3749be42010-02-02 02:46:51 +0000181
182<pre class="code">
cristy63fed272010-03-07 19:08:45 +0000183 MagickBooleanType EvaluateImage(Image *image,
184 const MagickEvaluateOperator op,const double value,
185 ExceptionInfo *exception)
186 MagickBooleanType EvaluateImages(Image *images,
187 const MagickEvaluateOperator op,const double value,
188 ExceptionInfo *exception)
189 MagickBooleanType EvaluateImageChannel(Image *image,
190 const ChannelType channel,const MagickEvaluateOperator op,
191 const double value,ExceptionInfo *exception)
cristy3749be42010-02-02 02:46:51 +0000192</pre>
193
194<p>A description of each parameter follows:</p></ol>
195
196<h5>image</h5>
cristy63fed272010-03-07 19:08:45 +0000197<ol><p>the image.</p></ol>
198
199<h5>channel</h5>
200<ol><p>the channel.</p></ol>
201
202<h5>op</h5>
203<ol><p>A channel op.</p></ol>
204
205<h5>value</h5>
206<ol><p>A value value.</p></ol>
207
208<h5>exception</h5>
209<ol><p>return any errors or warnings in this structure.</p></ol>
210
211 </div>
212<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
213_8c.html" target="source" name="FunctionImage">FunctionImage</a></h2>
214<div class="doc-section">
215
216<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>
217
218<p>The format of the FunctionImageChannel method is:</p>
219
220<pre class="code">
221 MagickBooleanType FunctionImage(Image *image,
cristybb503372010-05-27 20:51:26 +0000222 const MagickFunction function,const ssize_t number_parameters,
cristy63fed272010-03-07 19:08:45 +0000223 const double *parameters,ExceptionInfo *exception)
224 MagickBooleanType FunctionImageChannel(Image *image,
225 const ChannelType channel,const MagickFunction function,
cristybb503372010-05-27 20:51:26 +0000226 const ssize_t number_parameters,const double *argument,
cristy63fed272010-03-07 19:08:45 +0000227 ExceptionInfo *exception)
228</pre>
229
230<p>A description of each parameter follows:</p></ol>
231
232<h5>image</h5>
233<ol><p>the image.</p></ol>
234
235<h5>channel</h5>
236<ol><p>the channel.</p></ol>
237
238<h5>function</h5>
239<ol><p>A channel function.</p></ol>
240
241<h5>parameters</h5>
242<ol><p>one or more parameters.</p></ol>
cristy3749be42010-02-02 02:46:51 +0000243
244<h5>exception</h5>
245<ol><p>return any errors or warnings in this structure.</p></ol>
246
247 </div>
248<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
249_8c.html" target="source" name="GetImageChannelMean">GetImageChannelMean</a></h2>
250<div class="doc-section">
251
252<p>GetImageChannelMean() returns the mean and standard deviation of one or more image channels.</p></ol>
253
254<p>The format of the GetImageChannelMean method is:</p>
255
256<pre class="code">
257 MagickBooleanType GetImageChannelMean(const Image *image,
258 const ChannelType channel,double *mean,double *standard_deviation,
259 ExceptionInfo *exception)
260</pre>
261
262<p>A description of each parameter follows:</p></ol>
263
264<h5>image</h5>
265<ol><p>the image.</p></ol>
266
267<h5>channel</h5>
268<ol><p>the channel.</p></ol>
269
270<h5>mean</h5>
271<ol><p>the average value in the channel.</p></ol>
272
273<h5>standard_deviation</h5>
274<ol><p>the standard deviation of the channel.</p></ol>
275
276<h5>exception</h5>
277<ol><p>return any errors or warnings in this structure.</p></ol>
278
279 </div>
280<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
281_8c.html" target="source" name="GetImageChannelKurtosis">GetImageChannelKurtosis</a></h2>
282<div class="doc-section">
283
284<p>GetImageChannelKurtosis() returns the kurtosis and skewness of one or more image channels.</p></ol>
285
286<p>The format of the GetImageChannelKurtosis method is:</p>
287
288<pre class="code">
289 MagickBooleanType GetImageChannelKurtosis(const Image *image,
290 const ChannelType channel,double *kurtosis,double *skewness,
291 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>channel</h5>
300<ol><p>the channel.</p></ol>
301
302<h5>kurtosis</h5>
303<ol><p>the kurtosis of the channel.</p></ol>
304
305<h5>skewness</h5>
306<ol><p>the skewness of the channel.</p></ol>
307
308<h5>exception</h5>
309<ol><p>return any errors or warnings in this structure.</p></ol>
310
311 </div>
312<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
313_8c.html" target="source" name="GetImageChannelRange">GetImageChannelRange</a></h2>
314<div class="doc-section">
315
316<p>GetImageChannelRange() returns the range of one or more image channels.</p></ol>
317
318<p>The format of the GetImageChannelRange method is:</p>
319
320<pre class="code">
321 MagickBooleanType GetImageChannelRange(const Image *image,
322 const ChannelType channel,double *minima,double *maxima,
323 ExceptionInfo *exception)
324</pre>
325
326<p>A description of each parameter follows:</p></ol>
327
328<h5>image</h5>
329<ol><p>the image.</p></ol>
330
331<h5>channel</h5>
332<ol><p>the channel.</p></ol>
333
334<h5>minima</h5>
335<ol><p>the minimum value in the channel.</p></ol>
336
337<h5>maxima</h5>
338<ol><p>the maximum value in the channel.</p></ol>
339
340<h5>exception</h5>
341<ol><p>return any errors or warnings in this structure.</p></ol>
342
343 </div>
344<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
345_8c.html" target="source" name="GetImageChannelStatistics">GetImageChannelStatistics</a></h2>
346<div class="doc-section">
347
348<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>
349
350<pre class="text">
351 channel_statistics=GetImageChannelStatistics(image,excepton);
352 red_mean=channel_statistics[RedChannel].mean;
353</pre>
354
355<p>Use MagickRelinquishMemory() to free the statistics buffer.</p></ol>
356
357<p>The format of the GetImageChannelStatistics method is:</p>
358
359<pre class="code">
360 ChannelStatistics *GetImageChannelStatistics(const Image *image,
361 ExceptionInfo *exception)
362</pre>
363
364<p>A description of each parameter follows:</p></ol>
365
366<h5>image</h5>
367<ol><p>the image.</p></ol>
368
369<h5>exception</h5>
370<ol><p>return any errors or warnings in this structure.</p></ol>
371
372 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000373
374</div>
375
376<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000377 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000378 <span id="linkbar-center">
379 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000380 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000381 </span>
382 <span id="linkbar-east">&nbsp;</span>
383 </div>
384 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000385 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000386 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
387 </div>
388 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000389 <script type="text/javascript">
390 var _gaq = _gaq || [];
391 _gaq.push(['_setAccount', 'UA-17690367-1']);
392 _gaq.push(['_trackPageview']);
393
394 (function() {
395 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
396 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
397 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
398 })();
399 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000400</body>
401</html>