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

   1 \r
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   3   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">\r
   5 <head>\r
   6   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
   7   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
   8   <title>ImageMagick: Command-line Tools: Compare</title>
   9   <meta http-equiv="Content-Language" content="en-US"/>
  10   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  11   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  12   <meta name="Application-name" content="ImageMagick"/>
  13   <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."/>
  14   <meta name="Application-url" content="http://www.imagemagick.org"/>
  15   <meta name="Generator" content="PHP"/>
  16   <meta name="Keywords" content="command-line, tools:, compare, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  17   <meta name="Rating" content="GENERAL"/>
  18   <meta name="Robots" content="INDEX, FOLLOW"/>
  19   <meta name="Generator" content="ImageMagick Studio LLC"/>
  20   <meta name="Author" content="ImageMagick Studio LLC"/>
  21   <meta name="Revisit-after" content="2 DAYS"/>
  22   <meta name="Resource-type" content="document"/>
  23   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  24   <meta name="Distribution" content="Global"/>
  25   <link rel="icon" href="../images/wand.png"/>
  26   <link rel="shortcut icon" href="../images/wand.ico"  type="images/x-icon"/>
  27   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  28   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  29   <style type="text/css" media="all">\r
  30     @import url("../www/magick.css");\r
  31   </style>\r
  32   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  33   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  34   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  35   <script type="text/javascript">\r
  36     $(document).ready(function() {\r
  37       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  38         'transitionIn'  : 'elastic',\r
  39         'transitionOut' : 'elastic',\r
  40         'overlayShow'   : false,\r
  41         'opacity'       : true\r
  42       });\r
  43     });\r
  44   </script>\r
  45 </head>\r
  46 \r
  47 <body id="www-imagemagick-org">\r
  48 <div class="titlebar">\r
  49 <a href="../index.html">\r
  50   <img src="../images/script.png" alt="[ImageMagick]"\r
  51   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  52 <a href="http://www.networkredux.com">\r
  53   <img src="../images/networkredux.png" alt="[sponsor]"\r
  54   style="margin-top: 42px; border: 0px; float: left;" /></a>\r
  55 <a href="http://www.imagemagick.org/discourse-server/">\r
  56   <img src="../images/logo.jpg" alt=""\r
  57   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  58 <a href="../index.html">\r
  59   <img src="../images/sprite.jpg" alt=""\r
  60   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  61 </div>\r
  62 \r
  63 <div class="westbar">\r
  64 \r
  65 <div class="menu">
  66   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  67 </div>
  68 <div class="sep"></div>\r
  69 <div class="menu">
  70   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
  71 </div>
  72 <div class="sub">
  73     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
  74 </div>
  75 <div class="sub">
  76     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
  77 </div>
  78 <div class="sub">
  79     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div class="menu">
  83   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  93 </div>
  94 <div class="menu">
  95   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
 105 </div>
 106 <div class="sub">
 107     <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div  class="menu">
 111    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
 112 </div>
 113 <div class="sub">
 114     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
 115 </div>
 116 <div class="sub">
 117     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
 118  </div>
 119 <div class="menu">
 120   <a title="Resources" href="../www/resources.html">Resources</a>
 121 </div>
 122 <div class="menu">
 123   <a title="Architecture" href="../www/architecture.html">Architecture</a>
 124 </div>
 125 <div class="menu">
 126   <a title="Download" href="../www/download.html">Download</a>
 127 </div>
 128 <div class="sep"></div>\r
 129 <div class="menu">
 130   <a title="Search" href="../www/search.html">Search</a>
 131 </div>
 132 <div class="sep"></div>\r
 133 <div class="menu">
 134   <a title="Site Map" href="../www/sitemap.html">Site Map</a>
 135 </div>
 136 <div  class="sub">
 137   <a title="Site Map: Links" href="../www/links.html">Links</a>
 138 </div>
 139 <div class="sep"></div>\r
 140 <div  class="menu">
 141   <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 142
 143 <div class="sponsbox">
 144 <div  class="sponsor">
 145   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
 146 </div>
 147 <div class="sponsor">
 148   <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
 149 </div>
 150 <div  class="sponsor">
 151   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 152 </div>
 153 <div  class="sponsor">
 154   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 155 </div>
 156 <div  class="sponsor">
 157   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 158 </div>
 159 <div  class="sponsor">
 160    <a title="Sponsor: Custom T-Shirts" href="http://www.ooshirts.com">Custom T-Shirts</a><!-- 2011050100030 ooshirts.com-->
 161 </div>
 162 </div>
 163 </div>
 164 </div>\r
 165 \r
 166 <div class="eastbar">\r
 167   <script type="text/javascript">\r
 168   <!--\r
 169     google_ad_client = "pub-3129977114552745";\r
 170     google_ad_slot = "0574824969";\r
 171     google_ad_width = 160;\r
 172     google_ad_height = 600;\r
 173   //-->\r
 174   </script>\r
 175   <script type="text/javascript"\r
 176     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 177   </script>\r
 178 </div>\r
 179 \r
 180 <div class="main">\r
 181 \r
 182 <h1>ImageMagick Compare Command-line Tool</h1>
 183 <p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
 184
 185 <p>Use the <kbd>compare</kbd> program to mathematically and visually annotate the difference between an image and its reconstruction.  See <a href="../www/command-line-processing.html">Command Line Processing</a> for advice on how to structure your <kbd>compare</kbd> command or see below for example usages of the command.</p>
 186
 187 <div style="margin: auto;">
 188   <h2><a id="usage"></a>Example Usage</h2>
 189 </div>
 190
 191 <p>We list a few examples of the <kbd>compare</kbd> command here to illustrate its usefulness and ease of use. To get started, lets compare an image to one thats been sharpened:</p>
 192
 193 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose.jpg -sharpen 0x1 reconstruct.jpg</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>compare rose.jpg reconstruct.jpg difference.png</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>compare -compose src rose.jpg reconstruct.jpg difference.png</span></p>
 194 <div class="image">
 195 <p>
 196   <a href="../images/rose.jpg"><img src="../images/rose.jpg" width="70" height="46" alt="rose" /></a>
 197   <a href="../images/reconstruct.jpg"><img src="../images/reconstruct.jpg" width="70" height="46" alt="rose" /></a>
 198   <img style="margin:13px 0;" src="../images/right.gif" width="20" height="20" alt="==>" />
 199   <a href="../images/difference.png"><img src="../images/difference.png" width="70" height="46" alt="rose" /></a>
 200 </p>
 201 </div>
 202
 203 <p>The red areas of the difference image emphasizes (highlight) pixels that are affected by the image sharpening, whereas white de-emphasizes (lowlight) pixels that are untouched by the sharpening process.</p>
 204
 205 <p>In addition to the visual interpretation of the difference in an image and its reconstruction, we report a mathematical measure of the difference:</p>
 206
 207 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>compare -verbose -metric mae rose.jpg reconstruct.jpg difference.png</span><span class='crtout'>Image: rose.jpg     <br/>
 208     Channel distortion: MAE     <br/>
 209       red: 2282.91 (0.034835)     <br/>
 210       green: 1853.99 (0.0282901)     <br/>
 211       blue: 2008.67 (0.0306503)     <br/>
 212       all: 1536.39 (0.0234439)     <br/></span></p><p>Or, if you just want the red channel distortion, use this command:</p>
 213
 214 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>compare -channel red -metric PSNR rose.jpg reconstruct.jpg difference.png</span><span class='crtout'>19.63</span></p>
 215 <p>Or, if you just want the overall image distortion, use this command:</p>
 216
 217 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>compare -metric PSNR rose.jpg reconstruct.jpg difference.png</span><span class='crtout'>28.31</span></p>
 218 <p>If the reconstructed image is a subimage of the image, the compare program 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>
 219
 220 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>compare -metric RMSE -subimage-search logo.png wizard.jpg similarity.gif</span><span class='crtout'>85.05 (0.00129778) @ 353,157</span></p>
 221 <p>You can find additional examples of using <kbd>compare</kbd> in <a href="http://www-106.ibm.com/developerworks/library/l-graf/?ca=dnt-428">Graphics from the Command Line</a>.  Further discussion is available in <a href="http://www-106.ibm.com/developerworks/library/l-graf2/?ca=dgr-lnxw15GraphicsLine">More Graphics from the Command Line</a> and <a href="http://www.imagemagick.org/Usage/">Examples of ImageMagick Usage</a>.</p>
 222
 223 <div style="margin: auto;">
 224   <h2><a id="options"></a>Option Summary</h2>
 225 </div>
 226
 227 <p>The <kbd>compare</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 228
 229 <table class="doc">
 230   <tbody>
 231   <tr>
 232     <th align="left">Option</th>
 233     <th align="left">Description</th>
 234   </tr>
 235
 236   <tr>
 237     <td valign="top"><a href="../www/command-line-options.html#alpha">-alpha</a></td>
 238     <td valign="top">on, activate, off, deactivate, set, opaque, copy",
 239 transparent, extract, background, or shape the alpha channel</td>
 240   </tr>
 241
 242   <tr>
 243     <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
 244     <td valign="top">decrypt image with this password</td>
 245   </tr>
 246
 247   <tr>
 248     <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
 249     <td valign="top">apply option to select image channels</td>
 250   </tr>
 251
 252   <tr>
 253     <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
 254     <td valign="top">set image colorspace</td>
 255   </tr>
 256
 257   <tr>
 258     <td valign="top"><a href="../www/command-line-options.html#compose">-compose <em class="option">operator</em></a></td>
 259     <td valign="top">set image composite operator</td>
 260   </tr>
 261
 262   <tr>
 263     <td valign="top"><a href="../www/command-line-options.html#decipher">-decipher <em class="option">filename</em></a></td>
 264     <td valign="top">convert cipher pixels to plain</td>
 265   </tr>
 266
 267   <tr>
 268     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 269     <td valign="top">display copious debugging information</td>
 270   </tr>
 271
 272   <tr>
 273     <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
 274     <td valign="top">define one or more image format options</td>
 275   </tr>
 276
 277   <tr>
 278     <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
 279     <td valign="top">horizontal and vertical density of the image</td>
 280   </tr>
 281
 282   <tr>
 283     <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
 284     <td valign="top">image depth</td>
 285   </tr>
 286
 287   <tr>
 288     <td valign="top"><a href="../www/command-line-options.html#disimilarity-threshold">-disimilarity-threshold <em class="option">value</em></a></td>
 289     <td valign="top">maximum distortion for (sub)image match (default 0.2)</td>
 290   </tr>
 291
 292   <tr>
 293     <td valign="top"><a href="../www/command-line-options.html#encipher">-encipher <em class="option">filename</em></a></td>
 294     <td valign="top">convert plain pixels to cipher pixels</td>
 295   </tr>
 296
 297   <tr>
 298     <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
 299     <td valign="top">extract area from image</td>
 300   </tr>
 301
 302   <tr>
 303     <td valign="top"><a href="../www/command-line-options.html#fuzz">-fuzz <em class="option">distance</em></a></td>
 304     <td valign="top">colors within this distance are considered equal</td>
 305   </tr>
 306
 307   <tr>
 308     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
 309     <td valign="top">print program options</td>
 310   </tr>
 311
 312   <tr>
 313     <td valign="top"><a href="../www/command-line-options.html#highlight-color">-highlight-color <em class="option">color</em></a></td>
 314     <td valign="top">emphasize pixel differences with this color</td>
 315   </tr>
 316
 317   <tr>
 318     <td valign="top"><a href="../www/command-line-options.html#identify">-identify</a></td>
 319     <td valign="top">identify the format and characteristics of the image</td>
 320   </tr>
 321
 322   <tr>
 323     <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
 324     <td valign="top">type of image interlacing scheme</td>
 325   </tr>
 326
 327   <tr>
 328     <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
 329     <td valign="top">pixel cache resource limit</td>
 330   </tr>
 331
 332   <tr>
 333     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
 334     <td valign="top">format of debugging information</td>
 335   </tr>
 336
 337   <tr>
 338     <td valign="top"><a href="../www/command-line-options.html#lowlight-color">-lowlight-color <em class="option">color</em></a></td>
 339     <td valign="top">de-emphasize pixel differences with this color</td>
 340   </tr>
 341
 342   <tr>
 343     <td valign="top"><a href="../www/command-line-options.html#metric">-metric <em class="option">type</em></a></td>
 344     <td valign="top">measure differences between images with this metric</td>
 345   </tr>
 346
 347   <tr>
 348     <td valign="top"><a href="../www/command-line-options.html#profile">-profile <em class="option">filename</em></a></td>
 349     <td valign="top">add, delete, or apply an image profile</td>
 350   </tr>
 351
 352   <tr>
 353     <td valign="top"><a href="../www/command-line-options.html#quality">-quality <em class="option">value</em></a></td>
 354     <td valign="top">JPEG/MIFF/PNG compression level</td>
 355   </tr>
 356
 357   <tr>
 358     <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
 359     <td valign="top">reduce image colors in this colorspace</td>
 360   </tr>
 361
 362   <tr>
 363     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
 364     <td valign="top">suppress all warning messages</td>
 365   </tr>
 366
 367   <tr>
 368     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
 369     <td valign="top">pay attention to warning messages.</td>
 370   </tr>
 371
 372   <tr>
 373     <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
 374     <td valign="top">settings remain in effect until parenthesis boundary.</td>
 375   </tr>
 376
 377   <tr>
 378     <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
 379     <td valign="top">horizontal and vertical sampling factor</td>
 380   </tr>
 381
 382   <tr>
 383     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 384     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 385   </tr>
 386
 387   <tr>
 388     <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
 389     <td valign="top">set an image attribute</td>
 390   </tr>
 391
 392   <tr>
 393     <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
 394     <td valign="top">width and height of image</td>
 395   </tr>
 396
 397   <tr>
 398     <td valign="top"><a href="../www/command-line-options.html#subimage-search">-subimage-search</a></td>
 399     <td valign="top">search for subimage</td>
 400   </tr>
 401
 402   <tr>
 403     <td valign="top"><a href="../www/command-line-options.html#synchronize">-synchronize</a></td>
 404     <td valign="top">synchronize image to storage device</td>
 405   </tr>
 406
 407   <tr>
 408     <td valign="top"><a href="../www/command-line-options.html#taint">-taint</a></td>
 409     <td valign="top">mark the image as modified</td>
 410   </tr>
 411
 412   <tr>
 413     <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
 414     <td valign="top">transparent color</td>
 415   </tr>
 416
 417   <tr>
 418     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
 419     <td valign="top">print detailed information about the image</td>
 420   </tr>
 421
 422   <tr>
 423     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
 424     <td valign="top">print version information</td>
 425   </tr>
 426
 427   <tr>
 428     <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
 429     <td valign="top">access method for pixels outside the boundaries of the image</td>
 430   </tr>
 431
 432   </tbody>
 433 </table>
 434 \r
 435 </div>\r
 436 \r
 437 <div id="linkbar">\r
 438     <span id="linkbar-west">&nbsp;</span>\r
 439     <span id="linkbar-center">\r
 440       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 441       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 442     </span>\r
 443     <span id="linkbar-east">&nbsp;</span>\r
 444   </div>\r
 445   <div class="footer">\r
 446     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 447     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 448   </div>\r
 449   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 450   <script type="text/javascript">\r
 451     var _gaq = _gaq || [];\r
 452     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 453     _gaq.push(['_trackPageview']);\r
 454 \r
 455     (function() {\r
 456       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 457       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 458       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 459     })();\r
 460   </script>\r
 461 </body>\r
 462 </html>\r