Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ed574b3c62ee0be9771e86230006d5e9541b2d45 / . / www / api / statistic.html
blob: 5e011725bea2d2ef91967834da73575f8c0c7adf [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!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 +0000[diff] [blame]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"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</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 +0000[diff] [blame]47<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]51<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 +0000[diff] [blame]81<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]82<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 +0000[diff] [blame]106<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]115<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 +0000[diff] [blame]121<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]127 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
128</div>
129<div class="sponsor">
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]130 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
131</div>
132<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000[diff] [blame]133 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]134</div>
135<div class="sponsor">
136 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
137</div>
138<div class="sponsor">
139 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
140</div>
141<div class="sponsor">
142 <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
143</div>
144<div class="sponsor">
145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
146</div>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]147</div>
148</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]149
150
151</div>
152
153<div class="main">
154
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]155<p class="navigation-index">[<a href="#AverageImages">AverageImages</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> &bull; <a href="#MaximumImages">MaximumImages</a> &bull; <a href="#MinimumImages">MinimumImages</a>]</p>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]156
157<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
158_8c.html" target="source" name="AverageImages">AverageImages</a></h2>
159<div class="doc-section">
160
161<p>AverageImages() takes a set of images and averages them together. Each image in the set must have the same width and height. AverageImages() returns a single image with each corresponding pixel component of each image averaged. On failure, a NULL image is returned and exception describes the reason for the failure.</p></ol>
162
163<p>The format of the AverageImages method is:</p>
164
165<pre class="code">
cristy8ca94182010-03-05 21:08:18 +0000[diff] [blame]166 Image *AverageImages(Image *images,ExceptionInfo *exception)
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]167</pre>
168
169<p>A description of each parameter follows:</p></ol>
170
171<h5>image</h5>
172<ol><p>the image sequence.</p></ol>
173
174<h5>exception</h5>
175<ol><p>return any errors or warnings in this structure.</p></ol>
176
177 </div>
178<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
179_8c.html" target="source" name="GetImageChannelMean">GetImageChannelMean</a></h2>
180<div class="doc-section">
181
182<p>GetImageChannelMean() returns the mean and standard deviation of one or more image channels.</p></ol>
183
184<p>The format of the GetImageChannelMean method is:</p>
185
186<pre class="code">
187 MagickBooleanType GetImageChannelMean(const Image *image,
188 const ChannelType channel,double *mean,double *standard_deviation,
189 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>mean</h5>
201<ol><p>the average value in the channel.</p></ol>
202
203<h5>standard_deviation</h5>
204<ol><p>the standard deviation of the channel.</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="GetImageChannelKurtosis">GetImageChannelKurtosis</a></h2>
212<div class="doc-section">
213
214<p>GetImageChannelKurtosis() returns the kurtosis and skewness of one or more image channels.</p></ol>
215
216<p>The format of the GetImageChannelKurtosis method is:</p>
217
218<pre class="code">
219 MagickBooleanType GetImageChannelKurtosis(const Image *image,
220 const ChannelType channel,double *kurtosis,double *skewness,
221 ExceptionInfo *exception)
222</pre>
223
224<p>A description of each parameter follows:</p></ol>
225
226<h5>image</h5>
227<ol><p>the image.</p></ol>
228
229<h5>channel</h5>
230<ol><p>the channel.</p></ol>
231
232<h5>kurtosis</h5>
233<ol><p>the kurtosis of the channel.</p></ol>
234
235<h5>skewness</h5>
236<ol><p>the skewness of the channel.</p></ol>
237
238<h5>exception</h5>
239<ol><p>return any errors or warnings in this structure.</p></ol>
240
241 </div>
242<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
243_8c.html" target="source" name="GetImageChannelRange">GetImageChannelRange</a></h2>
244<div class="doc-section">
245
246<p>GetImageChannelRange() returns the range of one or more image channels.</p></ol>
247
248<p>The format of the GetImageChannelRange method is:</p>
249
250<pre class="code">
251 MagickBooleanType GetImageChannelRange(const Image *image,
252 const ChannelType channel,double *minima,double *maxima,
253 ExceptionInfo *exception)
254</pre>
255
256<p>A description of each parameter follows:</p></ol>
257
258<h5>image</h5>
259<ol><p>the image.</p></ol>
260
261<h5>channel</h5>
262<ol><p>the channel.</p></ol>
263
264<h5>minima</h5>
265<ol><p>the minimum value in the channel.</p></ol>
266
267<h5>maxima</h5>
268<ol><p>the maximum value in the channel.</p></ol>
269
270<h5>exception</h5>
271<ol><p>return any errors or warnings in this structure.</p></ol>
272
273 </div>
274<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
275_8c.html" target="source" name="GetImageChannelStatistics">GetImageChannelStatistics</a></h2>
276<div class="doc-section">
277
278<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>
279
280<pre class="text">
281 channel_statistics=GetImageChannelStatistics(image,excepton);
282 red_mean=channel_statistics[RedChannel].mean;
283</pre>
284
285<p>Use MagickRelinquishMemory() to free the statistics buffer.</p></ol>
286
287<p>The format of the GetImageChannelStatistics method is:</p>
288
289<pre class="code">
290 ChannelStatistics *GetImageChannelStatistics(const Image *image,
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>exception</h5>
300<ol><p>return any errors or warnings in this structure.</p></ol>
301
302 </div>
cristy8ca94182010-03-05 21:08:18 +0000[diff] [blame]303<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]304_8c.html" target="source" name="MaximumImages">MaximumImages</a></h2>
cristy8ca94182010-03-05 21:08:18 +0000[diff] [blame]305<div class="doc-section">
306
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]307<p>MaximumImages() returns the maximum intensity of an image sequence.</p></ol>
cristy8ca94182010-03-05 21:08:18 +0000[diff] [blame]308
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]309<p>The format of the MaxImages method is:</p>
cristy8ca94182010-03-05 21:08:18 +0000[diff] [blame]310
311<pre class="code">
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]312 Image *MaximumImages(Image *images,ExceptionInfo *exception)
cristy8ca94182010-03-05 21:08:18 +0000[diff] [blame]313</pre>
314
315<p>A description of each parameter follows:</p></ol>
316
317<h5>images</h5>
318<ol><p>the image sequence.</p></ol>
319
cristyd2baf7d2010-03-06 04:26:44 +0000[diff] [blame]320<h5>exception</h5>
321<ol><p>return any errors or warnings in this structure.</p></ol>
322
323 </div>
324<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
325_8c.html" target="source" name="MinimumImages">MinimumImages</a></h2>
326<div class="doc-section">
327
328<p>MinimumImages() returns the minimum intensity of an image sequence.</p></ol>
329
330<p>The format of the MinimumImages method is:</p>
331
332<pre class="code">
333 Image *MinimumImages(Image *images,ExceptionInfo *exception)
334</pre>
335
336<p>A description of each parameter follows:</p></ol>
337
338<h5>images</h5>
339<ol><p>the image sequence.</p></ol>
cristy8ca94182010-03-05 21:08:18 +0000[diff] [blame]340
341<h5>exception</h5>
342<ol><p>return any errors or warnings in this structure.</p></ol>
343
344 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]345
346</div>
347
348<div id="linkbar">
349 <!-- <span id="linkbar-west">&nbsp;</span> -->
350 <span id="linkbar-center">
351 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
352 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
353 </span>
354 <span id="linkbar-east">&nbsp;</span>
355 </div>
356 <div class="footer">
357 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
358 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
359 </div>
360 <div style="clear: both; margin: 0; width: 100%; "></div>
361</body>
362</html>