granicus.if.org Git - imagemagick/blob - www/api/compare.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="all">\r
   9     @import url("../../www/magick.css");\r
  10   </style>\r
  11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: MagickCore, C API for ImageMagick: Compare an Image to a Reconstructed Image</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:, 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"/>
  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"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="westbar">\r
  46 \r
  47 <div class="menu">
  48   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  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>\r
  64 <div class="menu">
  65   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  66 </div>
  67 <div class="sub">
  68     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  75 </div>
  76 <div class="menu">
  77   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  78 </div>
  79 <div class="sub">
  80     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  90 </div>
  91 <div class="sep"></div>\r
  92 <div  class="menu">
  93    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 100  </div>
 101 <div class="menu">
 102   <a title="Resources" href="../../www/resources.html">Resources</a>
 103 </div>
 104 <div class="menu">
 105   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Download" href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
 146 </div>
 147 </div>
 148 </div>
 149 </div>\r
 150 \r
 151 <div class="eastbar">\r
 152   <script type="text/javascript">\r
 153   <!--\r
 154     google_ad_client = "pub-3129977114552745";\r
 155     google_ad_slot = "0574824969";\r
 156     google_ad_width = 160;\r
 157     google_ad_height = 600;\r
 158   //-->\r
 159   </script>\r
 160   <script type="text/javascript"\r
 161     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 162   </script>\r
 163 </div>\r
 164 \r
 165 <div class="main">\r
 166 \r
 167 <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>
 168
 169 <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
 170 _8c.html" target="source" name="CompareImageChannels">CompareImageChannels</a></h2>
 171 <div class="doc-section">
 172
 173 <p>CompareImageChannels() compares one or more image channels of an image to a reconstructed image and returns the difference image.</p></ol>
 174
 175 <p>The format of the CompareImageChannels method is:</p>
 176
 177 <pre class="code">
 178   Image *CompareImageChannels(const Image *image,
 179     const Image *reconstruct_image,const ChannelType channel,
 180     const MetricType metric,double *distortion,ExceptionInfo *exception)
 181 </pre>
 182
 183 <p>A description of each parameter follows:</p></ol>
 184
 185 <h5>image</h5>
 186 <ol><p>the image.</p></ol>
 187
 188 <h5>reconstruct_image</h5>
 189 <ol><p>the reconstruct image.</p></ol>
 190
 191 <h5>channel</h5>
 192 <ol><p>the channel.</p></ol>
 193
 194 <h5>metric</h5>
 195 <ol><p>the metric.</p></ol>
 196
 197 <h5>distortion</h5>
 198 <ol><p>the computed distortion between the images.</p></ol>
 199
 200 <h5>exception</h5>
 201 <ol><p>return any errors or warnings in this structure.</p></ol>
 202
 203  </div>
 204 <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
 205 _8c.html" target="source" name="GetImageChannelDistortion">GetImageChannelDistortion</a></h2>
 206 <div class="doc-section">
 207
 208 <p>GetImageChannelDistortion() compares one or more image channels of an image to a reconstructed image and returns the specified distortion metric.</p></ol>
 209
 210 <p>The format of the CompareImageChannels method is:</p>
 211
 212 <pre class="code">
 213   MagickBooleanType GetImageChannelDistortion(const Image *image,
 214     const Image *reconstruct_image,const ChannelType channel,
 215     const MetricType metric,double *distortion,ExceptionInfo *exception)
 216 </pre>
 217
 218 <p>A description of each parameter follows:</p></ol>
 219
 220 <h5>image</h5>
 221 <ol><p>the image.</p></ol>
 222
 223 <h5>reconstruct_image</h5>
 224 <ol><p>the reconstruct image.</p></ol>
 225
 226 <h5>channel</h5>
 227 <ol><p>the channel.</p></ol>
 228
 229 <h5>metric</h5>
 230 <ol><p>the metric.</p></ol>
 231
 232 <h5>distortion</h5>
 233 <ol><p>the computed distortion between the images.</p></ol>
 234
 235 <h5>exception</h5>
 236 <ol><p>return any errors or warnings in this structure.</p></ol>
 237
 238  </div>
 239 <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
 240 _8c.html" target="source" name="GetImageChannelDistrortion">GetImageChannelDistrortion</a></h2>
 241 <div class="doc-section">
 242
 243 <p>GetImageChannelDistrortion() compares the image channels of an image to a reconstructed image and returns the specified distortion metric for each channel.</p></ol>
 244
 245 <p>The format of the CompareImageChannels method is:</p>
 246
 247 <pre class="code">
 248   double *GetImageChannelDistortions(const Image *image,
 249     const Image *reconstruct_image,const MetricType metric,
 250     ExceptionInfo *exception)
 251 </pre>
 252
 253 <p>A description of each parameter follows:</p></ol>
 254
 255 <h5>image</h5>
 256 <ol><p>the image.</p></ol>
 257
 258 <h5>reconstruct_image</h5>
 259 <ol><p>the reconstruct image.</p></ol>
 260
 261 <h5>metric</h5>
 262 <ol><p>the metric.</p></ol>
 263
 264 <h5>exception</h5>
 265 <ol><p>return any errors or warnings in this structure.</p></ol>
 266
 267  </div>
 268 <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
 269 _8c.html" target="source" name="IsImagesEqual">IsImagesEqual</a></h2>
 270 <div class="doc-section">
 271
 272 <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>
 273
 274 <pre class="text">
 275       o mean_error_per_pixel:  The mean error for any single pixel in
 276   the image.
 277 </pre>
 278
 279 <h5>normalized_mean_error</h5>
 280 <ol><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></ol>
 281
 282 <h5>normalized_maximum_error</h5>
 283 <ol><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></ol>
 284
 285 <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></ol>
 286
 287 <p>The format of the IsImagesEqual method is:</p>
 288
 289 <pre class="code">
 290   MagickBooleanType IsImagesEqual(Image *image,
 291     const Image *reconstruct_image)
 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>reconstruct_image</h5>
 300 <ol><p>the reconstruct image.</p></ol>
 301
 302  </div>
 303 <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
 304 _8c.html" target="source" name="SimilarityImage">SimilarityImage</a></h2>
 305 <div class="doc-section">
 306
 307 <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></ol>
 308
 309 <p>The format of the SimilarityImageImage method is:</p>
 310
 311 <pre class="code">
 312   Image *SimilarityImage(const Image *image,const Image *reference,
 313     RectangleInfo *offset,double *similarity,ExceptionInfo *exception)
 314 </pre>
 315
 316 <p>A description of each parameter follows:</p></ol>
 317
 318 <h5>image</h5>
 319 <ol><p>the image.</p></ol>
 320
 321 <h5>reference</h5>
 322 <ol><p>find an area of the image that closely resembles this image.</p></ol>
 323
 324 <p>o the best match offset of the reference image within the image.</p></ol>
 325
 326 <h5>similarity</h5>
 327 <ol><p>the computed similarity between the images.</p></ol>
 328
 329 <h5>exception</h5>
 330 <ol><p>return any errors or warnings in this structure.</p></ol>
 331
 332  </div>
 333 \r
 334 </div>\r
 335 \r
 336 <div id="linkbar">\r
 337     <span id="linkbar-west">&nbsp;</span>\r
 338     <span id="linkbar-center">\r
 339       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 340       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 341     </span>\r
 342     <span id="linkbar-east">&nbsp;</span>\r
 343   </div>\r
 344   <div class="footer">\r
 345     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 346     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 347   </div>\r
 348   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 349   <script type="text/javascript">\r
 350     var _gaq = _gaq || [];\r
 351     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 352     _gaq.push(['_trackPageview']);\r
 353 \r
 354     (function() {\r
 355       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 356       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 357       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 358     })();\r
 359   </script>\r
 360 </body>\r
 361 </html>\r