Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / bb50337b2a8a16ca7e903cc04ab195ff0fd47ae6 / . / www / api / statistic.html
blob: eceb5678db0b10acb07821a0b201624b3722159d [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">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]8 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]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">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame^]52 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53</div>
54<div class="sub">
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62</div>
63<div class="sep"></div>
64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]66</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]75</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]78</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]90</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]91<div class="sep"></div>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]94</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]103</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame^]104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Download" href="../../www/download.html">Download</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy320dd6e2010-04-16 20:11:40 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame^]145 <a title="Sponsor: Lampe Berger" href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]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
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]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>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]156
157<h2><a href="http://www.imagemagick.org/api/MagickCore/statistic
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]158_8c.html" target="source" name="EvaluateImage">EvaluateImage</a></h2>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]159<div class="doc-section">
160
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]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>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]162
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]163<p>The format of the EvaluateImageChannel method is:</p>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]164
165<pre class="code">
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]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)
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]175</pre>
176
177<p>A description of each parameter follows:</p></ol>
178
179<h5>image</h5>
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]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,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame^]205 const MagickFunction function,const ssize_t number_parameters,
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]206 const double *parameters,ExceptionInfo *exception)
207 MagickBooleanType FunctionImageChannel(Image *image,
208 const ChannelType channel,const MagickFunction function,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame^]209 const ssize_t number_parameters,const double *argument,
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]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>
cristy3749be42010-02-02 02:46:51 +0000[diff] [blame]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>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]356
357</div>
358
359<div id="linkbar">
360 <!-- <span id="linkbar-west">&nbsp;</span> -->
361 <span id="linkbar-center">
362 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristybb503372010-05-27 20:51:26 +0000[diff] [blame^]363 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]364 </span>
365 <span id="linkbar-east">&nbsp;</span>
366 </div>
367 <div class="footer">
368 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
369 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
370 </div>
371 <div style="clear: both; margin: 0; width: 100%; "></div>
372</body>
373</html>