blob: 4cc281fc74201e19a2edf7785b5a90ba81b7bdda [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">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../../www/magick.css");
10 --></style>
cristy3749be42010-02-02 02:46:51 +000011 <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"/>
cristy3eaa0ef2010-03-06 20:35:26 +000027</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
cristy3749be42010-02-02 02:46:51 +000047<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
cristy3eaa0ef2010-03-06 20:35:26 +000050<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +000051<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>
cristy3eaa0ef2010-03-06 20:35:26 +000081<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +000082<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>
cristy3eaa0ef2010-03-06 20:35:26 +0000106<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000115<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>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristy63fed272010-03-07 19:08:45 +0000127 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
128</div>
129<div class="sponsor">
cristy8f900122010-03-05 15:26:31 +0000130 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
131</div>
132<div class="sponsor">
cristy3749be42010-02-02 02:46:51 +0000133 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
134</div>
135<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000136 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy3749be42010-02-02 02:46:51 +0000137</div>
138<div class="sponsor">
139 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
140</div>
141<div class="sponsor">
142 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
143</div>
144<div class="sponsor">
145 <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
146</div>
147<div class="sponsor">
148 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
149</div>
cristy3749be42010-02-02 02:46:51 +0000150</div>
151</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000152
153
154</div>
155
156<div class="main">
157
cristy63fed272010-03-07 19:08:45 +0000158<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 +0000159
160<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
cristy63fed272010-03-07 19:08:45 +0000161_8c.html" target="source" name="EvaluateImage">EvaluateImage</a></h2>
cristy3749be42010-02-02 02:46:51 +0000162<div class="doc-section">
163
cristy63fed272010-03-07 19:08:45 +0000164<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 +0000165
cristy63fed272010-03-07 19:08:45 +0000166<p>The format of the EvaluateImageChannel method is:</p>
cristy3749be42010-02-02 02:46:51 +0000167
168<pre class="code">
cristy63fed272010-03-07 19:08:45 +0000169 MagickBooleanType EvaluateImage(Image *image,
170 const MagickEvaluateOperator op,const double value,
171 ExceptionInfo *exception)
172 MagickBooleanType EvaluateImages(Image *images,
173 const MagickEvaluateOperator op,const double value,
174 ExceptionInfo *exception)
175 MagickBooleanType EvaluateImageChannel(Image *image,
176 const ChannelType channel,const MagickEvaluateOperator op,
177 const double value,ExceptionInfo *exception)
cristy3749be42010-02-02 02:46:51 +0000178</pre>
179
180<p>A description of each parameter follows:</p></ol>
181
182<h5>image</h5>
cristy63fed272010-03-07 19:08:45 +0000183<ol><p>the image.</p></ol>
184
185<h5>channel</h5>
186<ol><p>the channel.</p></ol>
187
188<h5>op</h5>
189<ol><p>A channel op.</p></ol>
190
191<h5>value</h5>
192<ol><p>A value value.</p></ol>
193
194<h5>exception</h5>
195<ol><p>return any errors or warnings in this structure.</p></ol>
196
197 </div>
198<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
199_8c.html" target="source" name="FunctionImage">FunctionImage</a></h2>
200<div class="doc-section">
201
202<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>
203
204<p>The format of the FunctionImageChannel method is:</p>
205
206<pre class="code">
207 MagickBooleanType FunctionImage(Image *image,
208 const MagickFunction function,const long number_parameters,
209 const double *parameters,ExceptionInfo *exception)
210 MagickBooleanType FunctionImageChannel(Image *image,
211 const ChannelType channel,const MagickFunction function,
212 const long number_parameters,const double *argument,
213 ExceptionInfo *exception)
214</pre>
215
216<p>A description of each parameter follows:</p></ol>
217
218<h5>image</h5>
219<ol><p>the image.</p></ol>
220
221<h5>channel</h5>
222<ol><p>the channel.</p></ol>
223
224<h5>function</h5>
225<ol><p>A channel function.</p></ol>
226
227<h5>parameters</h5>
228<ol><p>one or more parameters.</p></ol>
cristy3749be42010-02-02 02:46:51 +0000229
230<h5>exception</h5>
231<ol><p>return any errors or warnings in this structure.</p></ol>
232
233 </div>
234<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
235_8c.html" target="source" name="GetImageChannelMean">GetImageChannelMean</a></h2>
236<div class="doc-section">
237
238<p>GetImageChannelMean() returns the mean and standard deviation of one or more image channels.</p></ol>
239
240<p>The format of the GetImageChannelMean method is:</p>
241
242<pre class="code">
243 MagickBooleanType GetImageChannelMean(const Image *image,
244 const ChannelType channel,double *mean,double *standard_deviation,
245 ExceptionInfo *exception)
246</pre>
247
248<p>A description of each parameter follows:</p></ol>
249
250<h5>image</h5>
251<ol><p>the image.</p></ol>
252
253<h5>channel</h5>
254<ol><p>the channel.</p></ol>
255
256<h5>mean</h5>
257<ol><p>the average value in the channel.</p></ol>
258
259<h5>standard_deviation</h5>
260<ol><p>the standard deviation of the channel.</p></ol>
261
262<h5>exception</h5>
263<ol><p>return any errors or warnings in this structure.</p></ol>
264
265 </div>
266<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
267_8c.html" target="source" name="GetImageChannelKurtosis">GetImageChannelKurtosis</a></h2>
268<div class="doc-section">
269
270<p>GetImageChannelKurtosis() returns the kurtosis and skewness of one or more image channels.</p></ol>
271
272<p>The format of the GetImageChannelKurtosis method is:</p>
273
274<pre class="code">
275 MagickBooleanType GetImageChannelKurtosis(const Image *image,
276 const ChannelType channel,double *kurtosis,double *skewness,
277 ExceptionInfo *exception)
278</pre>
279
280<p>A description of each parameter follows:</p></ol>
281
282<h5>image</h5>
283<ol><p>the image.</p></ol>
284
285<h5>channel</h5>
286<ol><p>the channel.</p></ol>
287
288<h5>kurtosis</h5>
289<ol><p>the kurtosis of the channel.</p></ol>
290
291<h5>skewness</h5>
292<ol><p>the skewness of the channel.</p></ol>
293
294<h5>exception</h5>
295<ol><p>return any errors or warnings in this structure.</p></ol>
296
297 </div>
298<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
299_8c.html" target="source" name="GetImageChannelRange">GetImageChannelRange</a></h2>
300<div class="doc-section">
301
302<p>GetImageChannelRange() returns the range of one or more image channels.</p></ol>
303
304<p>The format of the GetImageChannelRange method is:</p>
305
306<pre class="code">
307 MagickBooleanType GetImageChannelRange(const Image *image,
308 const ChannelType channel,double *minima,double *maxima,
309 ExceptionInfo *exception)
310</pre>
311
312<p>A description of each parameter follows:</p></ol>
313
314<h5>image</h5>
315<ol><p>the image.</p></ol>
316
317<h5>channel</h5>
318<ol><p>the channel.</p></ol>
319
320<h5>minima</h5>
321<ol><p>the minimum value in the channel.</p></ol>
322
323<h5>maxima</h5>
324<ol><p>the maximum value in the channel.</p></ol>
325
326<h5>exception</h5>
327<ol><p>return any errors or warnings in this structure.</p></ol>
328
329 </div>
330<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
331_8c.html" target="source" name="GetImageChannelStatistics">GetImageChannelStatistics</a></h2>
332<div class="doc-section">
333
334<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>
335
336<pre class="text">
337 channel_statistics=GetImageChannelStatistics(image,excepton);
338 red_mean=channel_statistics[RedChannel].mean;
339</pre>
340
341<p>Use MagickRelinquishMemory() to free the statistics buffer.</p></ol>
342
343<p>The format of the GetImageChannelStatistics method is:</p>
344
345<pre class="code">
346 ChannelStatistics *GetImageChannelStatistics(const Image *image,
347 ExceptionInfo *exception)
348</pre>
349
350<p>A description of each parameter follows:</p></ol>
351
352<h5>image</h5>
353<ol><p>the image.</p></ol>
354
355<h5>exception</h5>
356<ol><p>return any errors or warnings in this structure.</p></ol>
357
358 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000359
360</div>
361
362<div id="linkbar">
363 <!-- <span id="linkbar-west">&nbsp;</span> -->
364 <span id="linkbar-center">
365 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristy63fed272010-03-07 19:08:45 +0000366 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000367 </span>
368 <span id="linkbar-east">&nbsp;</span>
369 </div>
370 <div class="footer">
371 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
372 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
373 </div>
374 <div style="clear: both; margin: 0; width: 100%; "></div>
375</body>
376</html>