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="eastbar">\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: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 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/" title="Webdesign">Webdesign</a><!-- 20111001000240 -->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 155 <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>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
 158 _8c.html" target="source" name="CompareImageChannels">CompareImageChannels</a></h2>
 159 <div class="doc-section">
 160
 161 <p>CompareImageChannels() compares one or more image channels of an image to a reconstructed image and returns the difference image.</p></ol>
 162
 163 <p>The format of the CompareImageChannels method is:</p>
 164
 165 <pre class="code">
 166   Image *CompareImageChannels(const Image *image,
 167     const Image *reconstruct_image,const ChannelType channel,
 168     const MetricType metric,double *distortion,ExceptionInfo *exception)
 169 </pre>
 170
 171 <p>A description of each parameter follows:</p></ol>
 172
 173 <h5>image</h5>
 174 <ol><p>the image.</p></ol>
 175
 176 <h5>reconstruct_image</h5>
 177 <ol><p>the reconstruct image.</p></ol>
 178
 179 <h5>channel</h5>
 180 <ol><p>the channel.</p></ol>
 181
 182 <h5>metric</h5>
 183 <ol><p>the metric.</p></ol>
 184
 185 <h5>distortion</h5>
 186 <ol><p>the computed distortion between the images.</p></ol>
 187
 188 <h5>exception</h5>
 189 <ol><p>return any errors or warnings in this structure.</p></ol>
 190
 191  </div>
 192 <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
 193 _8c.html" target="source" name="GetImageChannelDistortion">GetImageChannelDistortion</a></h2>
 194 <div class="doc-section">
 195
 196 <p>GetImageChannelDistortion() compares one or more image channels of an image to a reconstructed image and returns the specified distortion metric.</p></ol>
 197
 198 <p>The format of the CompareImageChannels method is:</p>
 199
 200 <pre class="code">
 201   MagickBooleanType GetImageChannelDistortion(const Image *image,
 202     const Image *reconstruct_image,const ChannelType channel,
 203     const MetricType metric,double *distortion,ExceptionInfo *exception)
 204 </pre>
 205
 206 <p>A description of each parameter follows:</p></ol>
 207
 208 <h5>image</h5>
 209 <ol><p>the image.</p></ol>
 210
 211 <h5>reconstruct_image</h5>
 212 <ol><p>the reconstruct image.</p></ol>
 213
 214 <h5>channel</h5>
 215 <ol><p>the channel.</p></ol>
 216
 217 <h5>metric</h5>
 218 <ol><p>the metric.</p></ol>
 219
 220 <h5>distortion</h5>
 221 <ol><p>the computed distortion between the images.</p></ol>
 222
 223 <h5>exception</h5>
 224 <ol><p>return any errors or warnings in this structure.</p></ol>
 225
 226  </div>
 227 <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
 228 _8c.html" target="source" name="GetImageChannelDistrortion">GetImageChannelDistrortion</a></h2>
 229 <div class="doc-section">
 230
 231 <p>GetImageChannelDistrortion() compares the image channels of an image to a reconstructed image and returns the specified distortion metric for each channel.</p></ol>
 232
 233 <p>The format of the CompareImageChannels method is:</p>
 234
 235 <pre class="code">
 236   double *GetImageChannelDistortions(const Image *image,
 237     const Image *reconstruct_image,const MetricType metric,
 238     ExceptionInfo *exception)
 239 </pre>
 240
 241 <p>A description of each parameter follows:</p></ol>
 242
 243 <h5>image</h5>
 244 <ol><p>the image.</p></ol>
 245
 246 <h5>reconstruct_image</h5>
 247 <ol><p>the reconstruct image.</p></ol>
 248
 249 <h5>metric</h5>
 250 <ol><p>the metric.</p></ol>
 251
 252 <h5>exception</h5>
 253 <ol><p>return any errors or warnings in this structure.</p></ol>
 254
 255  </div>
 256 <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
 257 _8c.html" target="source" name="IsImagesEqual">IsImagesEqual</a></h2>
 258 <div class="doc-section">
 259
 260 <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>
 261
 262 <pre class="text">
 263       o mean_error_per_pixel:  The mean error for any single pixel in
 264   the image.
 265 </pre>
 266
 267 <h5>normalized_mean_error</h5>
 268 <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>
 269
 270 <h5>normalized_maximum_error</h5>
 271 <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>
 272
 273 <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>
 274
 275 <p>The format of the IsImagesEqual method is:</p>
 276
 277 <pre class="code">
 278   MagickBooleanType IsImagesEqual(Image *image,
 279     const Image *reconstruct_image)
 280 </pre>
 281
 282 <p>A description of each parameter follows.</p></ol>
 283
 284 <h5>image</h5>
 285 <ol><p>the image.</p></ol>
 286
 287 <h5>reconstruct_image</h5>
 288 <ol><p>the reconstruct image.</p></ol>
 289
 290  </div>
 291 <h2><a href="http://www.imagemagick.org/api/MagickCore/compare
 292 _8c.html" target="source" name="SimilarityImage">SimilarityImage</a></h2>
 293 <div class="doc-section">
 294
 295 <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>
 296
 297 <p>The format of the SimilarityImageImage method is:</p>
 298
 299 <pre class="code">
 300   Image *SimilarityImage(const Image *image,const Image *reference,
 301     RectangleInfo *offset,double *similarity,ExceptionInfo *exception)
 302 </pre>
 303
 304 <p>A description of each parameter follows:</p></ol>
 305
 306 <h5>image</h5>
 307 <ol><p>the image.</p></ol>
 308
 309 <h5>reference</h5>
 310 <ol><p>find an area of the image that closely resembles this image.</p></ol>
 311
 312 <p>o the best match offset of the reference image within the image.</p></ol>
 313
 314 <h5>similarity</h5>
 315 <ol><p>the computed similarity between the images.</p></ol>
 316
 317 <h5>exception</h5>
 318 <ol><p>return any errors or warnings in this structure.</p></ol>
 319
 320  </div>
 321 \r
 322 </div>\r
 323 \r
 324 <div id="linkbar">\r
 325  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 326     <span id="linkbar-center">\r
 327       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 328     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 329     </span>\r
 330     <span id="linkbar-east">&nbsp;</span>\r
 331   </div>\r
 332   <div class="footer">\r
 333     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 334     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 335   </div>\r
 336   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 337 </body>\r
 338 </html>\r