Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 5292344af862c8d10e50c4e9300a591aad3acae5 / . / www / api / compare.html
blob: 3bd3a8205dedd3bd7b654da69aa8a1e96c7e67e3 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Compare an Image to a Reconstructed Image</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <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 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, compare, an, image, to, a, reconstructed, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]16 <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 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]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"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]27 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]28 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]31 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame^]53 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
56 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
57<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]62<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]63
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]69 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]82 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]83</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]85 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]86</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame^]129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141
142<div class="sponsbox">
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]143<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame^]144 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy5c4585b2010-11-11 00:13:57 +0000[diff] [blame]145</div>
146<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]147 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]155<div class="sponsor">
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]156 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]157</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158</div>
159</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]160</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]161
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]162<div class="eastbar">
163 <script type="text/javascript">
164 <!--
165 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]166 google_ad_slot = "0574824969";
167 google_ad_width = 160;
168 google_ad_height = 600;
169 //-->
170 </script>
171 <script type="text/javascript"
172 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
173 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]174</div>
175
176<div class="main">
177
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]178<h1>Module compare
179 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]180<p class="navigation-index">[<a href="#CompareImageChannels">CompareImageChannels</a> &bull; <a href="#GetImageChannelDistortion">GetImageChannelDistortion</a> &bull; <a href="#GetImageChannelDistrortion">GetImageChannelDistrortion</a> &bull; <a href="#IsImagesEqual">IsImagesEqual</a> &bull; <a href="#SimilarityImage">SimilarityImage</a>]</p>
181
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]182<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/compare
183_8c.html" id="CompareImageChannels">CompareImageChannels</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]184<div class="doc-section">
185
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]186<p>CompareImageChannels() compares one or more image channels of an image to a reconstructed image and returns the difference image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]187
188<p>The format of the CompareImageChannels method is:</p>
189
190<pre class="code">
191 Image *CompareImageChannels(const Image *image,
192 const Image *reconstruct_image,const ChannelType channel,
193 const MetricType metric,double *distortion,ExceptionInfo *exception)
194</pre>
195
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]196<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]197
198<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]199<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]200
201<h5>reconstruct_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]202<p>the reconstruct image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]203
204<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]205<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]206
207<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]208<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]209
210<h5>distortion</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]211<p>the computed distortion between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]212
213<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]214<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]215
216 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]217<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/compare
218_8c.html" id="GetImageChannelDistortion">GetImageChannelDistortion</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]219<div class="doc-section">
220
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]221<p>GetImageChannelDistortion() compares one or more image channels of an image to a reconstructed image and returns the specified distortion metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]222
223<p>The format of the CompareImageChannels method is:</p>
224
225<pre class="code">
226 MagickBooleanType GetImageChannelDistortion(const Image *image,
227 const Image *reconstruct_image,const ChannelType channel,
228 const MetricType metric,double *distortion,ExceptionInfo *exception)
229</pre>
230
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]231<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]232
233<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]234<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]235
236<h5>reconstruct_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]237<p>the reconstruct image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]238
239<h5>channel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]240<p>the channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]241
242<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]243<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]244
245<h5>distortion</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]246<p>the computed distortion between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]247
248<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]249<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]250
251 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]252<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/compare
253_8c.html" id="GetImageChannelDistrortion">GetImageChannelDistrortion</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]254<div class="doc-section">
255
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]256<p>GetImageChannelDistrortion() compares the image channels of an image to a reconstructed image and returns the specified distortion metric for each channel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]257
258<p>The format of the CompareImageChannels method is:</p>
259
260<pre class="code">
261 double *GetImageChannelDistortions(const Image *image,
262 const Image *reconstruct_image,const MetricType metric,
263 ExceptionInfo *exception)
264</pre>
265
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]266<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]267
268<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]269<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]270
271<h5>reconstruct_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]272<p>the reconstruct image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]273
274<h5>metric</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]275<p>the metric.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]276
277<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]278<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]279
280 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]281<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/compare
282_8c.html" id="IsImagesEqual">IsImagesEqual</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]283<div class="doc-section">
284
285<p>IsImagesEqual() measures the difference between colors at each pixel location of two images. A value other than 0 means the colors match exactly. Otherwise an error measure is computed by summing over all pixels in an image the distance squared in RGB space between each image pixel and its corresponding pixel in the reconstruct image. The error measure is assigned to these image members:</p>
286
287<pre class="text">
288 o mean_error_per_pixel: The mean error for any single pixel in
289 the image.
290</pre>
291
292<h5>normalized_mean_error</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]293<p>The normalized mean quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]294
295<h5>normalized_maximum_error</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]296<p>The normalized maximum quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in your image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]297
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]298<p>A small normalized mean square error, accessed as image->normalized_mean_error, suggests the images are very similar in spatial layout and color.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]299
300<p>The format of the IsImagesEqual method is:</p>
301
302<pre class="code">
303 MagickBooleanType IsImagesEqual(Image *image,
304 const Image *reconstruct_image)
305</pre>
306
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]307<p>A description of each parameter follows.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]308
309<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]310<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]311
312<h5>reconstruct_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]313<p>the reconstruct image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]314
315 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]316<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/compare
317_8c.html" id="SimilarityImage">SimilarityImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]318<div class="doc-section">
319
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]320<p>SimilarityImage() compares the reference image of the image and returns the best match offset. In addition, it returns a similarity image such that an exact match location is completely white and if none of the pixels match, black, otherwise some gray level in-between.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]321
322<p>The format of the SimilarityImageImage method is:</p>
323
324<pre class="code">
325 Image *SimilarityImage(const Image *image,const Image *reference,
326 RectangleInfo *offset,double *similarity,ExceptionInfo *exception)
327</pre>
328
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]329<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]330
331<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]332<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]333
334<h5>reference</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]335<p>find an area of the image that closely resembles this image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]336
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]337<p>o the best match offset of the reference image within the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]338
339<h5>similarity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]340<p>the computed similarity between the images.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]341
342<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]343<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]344
345 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]346
347</div>
348
349<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]350 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]351 <span id="linkbar-center">
352 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]353 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]354 </span>
355 <span id="linkbar-east">&nbsp;</span>
356 </div>
357 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]358 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]359 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
360 </div>
361 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]362 <script type="text/javascript">
363 var _gaq = _gaq || [];
364 _gaq.push(['_setAccount', 'UA-17690367-1']);
365 _gaq.push(['_trackPageview']);
366
367 (function() {
368 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
369 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
370 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
371 })();
372 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]373</body>
374</html>