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

   1 \r
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   3     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   5 <head>\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="screen,projection"><!--\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: Command-line Tools: Compare</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="command-line, tools:, compare, 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-2009 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 href="../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20090501000200 -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 134 </div>
 135 <div  class="sponsor">
 136    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 137 </div>
 138 <div  class="sponsor">
 139    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 140 </div>
 141 <div  class="sponsor">
 142   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 143 </div>
 144 <div  class="sponsor">
 145   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 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="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
 156
 157 <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>
 158
 159 <div style="margin: auto;">
 160   <h2><a name="usage"></a>Example Usage</h2>
 161 </div>
 162
 163 <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>
 164
 165 <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>
 166 <div class="image">
 167 <p>
 168   <a href="../images/rose.jpg"><img src="../images/rose.jpg" width="70" height="46" alt="rose" /></a>
 169   <a href="../images/reconstruct.jpg"><img src="../images/reconstruct.jpg" width="70" height="46" alt="rose" /></a>
 170   <img style="margin:13px 0;" src="../images/right.gif" width="20" height="20" alt="==>" />
 171   <a href="../images/difference.png"><img src="../images/difference.png" width="70" height="46" alt="rose" /></a>
 172 </p>
 173 </div>
 174
 175 <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>
 176
 177 <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>
 178
 179 <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/>
 180     Channel distortion: MAE     <br/>
 181       red: 2282.91 (0.034835)     <br/>
 182       green: 1853.99 (0.0282901)     <br/>
 183       blue: 2008.67 (0.0306503)     <br/>
 184       all: 1536.39 (0.0234439)     <br/></span></p><p>Or, if you just want the red channel distortion, use this command:</p>
 185
 186 <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>
 187 <p>Or, if you just want the overall image distortion, use this command:</p>
 188
 189 <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>
 190 <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>
 191
 192 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>compare -metric RMSE logo.png wizard.jpg similarity.gif</span><span class='crtout'>85.05 (0.00129778) @ 353,157</span></p>
 193 <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>
 194
 195 <div style="margin: auto;">
 196   <h2><a name="options"></a>Option Summary</h2>
 197 </div>
 198
 199 <p>The <kbd>compare</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 200
 201 <table class="doc">
 202   <tbody>
 203   <tr>
 204     <th align="left">Option</th>
 205     <th align="left">Description</th>
 206   </tr>
 207
 208   <tr>
 209     <td valign="top"><a href="../www/command-line-options.html#alpha">-alpha</a></td>
 210     <td valign="top">on, activate, off, deactivate, set, opaque, copy",
 211 transparent, extract, background, or shape the alpha channel</td>
 212   </tr>
 213
 214   <tr>
 215     <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
 216     <td valign="top">decrypt image with this password</td>
 217   </tr>
 218
 219   <tr>
 220     <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
 221     <td valign="top">apply option to select image channels</td>
 222   </tr>
 223
 224   <tr>
 225     <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
 226     <td valign="top">set image colorspace</td>
 227   </tr>
 228
 229   <tr>
 230     <td valign="top"><a href="../www/command-line-options.html#compose">-compose <em class="option">operator</em></a></td>
 231     <td valign="top">set image composite operator</td>
 232   </tr>
 233
 234   <tr>
 235     <td valign="top"><a href="../www/command-line-options.html#decipher">-decipher <em class="option">filename</em></a></td>
 236     <td valign="top">convert cipher pixels to plain</td>
 237   </tr>
 238
 239   <tr>
 240     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 241     <td valign="top">display copious debugging information</td>
 242   </tr>
 243
 244   <tr>
 245     <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
 246     <td valign="top">define one or more image format options</td>
 247   </tr>
 248
 249   <tr>
 250     <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
 251     <td valign="top">horizontal and vertical density of the image</td>
 252   </tr>
 253
 254   <tr>
 255     <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
 256     <td valign="top">image depth</td>
 257   </tr>
 258
 259   <tr>
 260     <td valign="top"><a href="../www/command-line-options.html#disimilarity-threshold">-disimilarity-threshold <em class="option">value</em></a></td>
 261     <td valign="top">maximum RMSE for (sub)image match (default 0.2)</td>
 262   </tr>
 263
 264   <tr>
 265     <td valign="top"><a href="../www/command-line-options.html#encipher">-encipher <em class="option">filename</em></a></td>
 266     <td valign="top">convert plain pixels to cipher pixels</td>
 267   </tr>
 268
 269   <tr>
 270     <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
 271     <td valign="top">extract area from image</td>
 272   </tr>
 273
 274   <tr>
 275     <td valign="top"><a href="../www/command-line-options.html#fuzz">-fuzz <em class="option">distance</em></a></td>
 276     <td valign="top">colors within this distance are considered equal</td>
 277   </tr>
 278
 279   <tr>
 280     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
 281     <td valign="top">print program options</td>
 282   </tr>
 283
 284   <tr>
 285     <td valign="top"><a href="../www/command-line-options.html#highlight-color">-highlight-color <em class="option">color</em></a></td>
 286     <td valign="top">emphasize pixel differences with this color</td>
 287   </tr>
 288
 289   <tr>
 290     <td valign="top"><a href="../www/command-line-options.html#identify">-identify</a></td>
 291     <td valign="top">identify the format and characteristics of the image</td>
 292   </tr>
 293
 294   <tr>
 295     <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
 296     <td valign="top">type of image interlacing scheme</td>
 297   </tr>
 298
 299   <tr>
 300     <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
 301     <td valign="top">pixel cache resource limit</td>
 302   </tr>
 303
 304   <tr>
 305     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
 306     <td valign="top">format of debugging information</td>
 307   </tr>
 308
 309   <tr>
 310     <td valign="top"><a href="../www/command-line-options.html#lowlight-color">-lowlight-color <em class="option">color</em></a></td>
 311     <td valign="top">de-emphasize pixel differences with this color</td>
 312   </tr>
 313
 314   <tr>
 315     <td valign="top"><a href="../www/command-line-options.html#metric">-metric <em class="option">type</em></a></td>
 316     <td valign="top">measure differences between images with this metric</td>
 317   </tr>
 318
 319   <tr>
 320     <td valign="top"><a href="../www/command-line-options.html#profile">-profile <em class="option">filename</em></a></td>
 321     <td valign="top">add, delete, or apply an image profile</td>
 322   </tr>
 323
 324   <tr>
 325     <td valign="top"><a href="../www/command-line-options.html#quality">-quality <em class="option">value</em></a></td>
 326     <td valign="top">JPEG/MIFF/PNG compression level</td>
 327   </tr>
 328
 329   <tr>
 330     <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
 331     <td valign="top">reduce image colors in this colorspace</td>
 332   </tr>
 333
 334   <tr>
 335     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
 336     <td valign="top">suppress all warning messages</td>
 337   </tr>
 338
 339   <tr>
 340     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
 341     <td valign="top">pay attention to warning messages.</td>
 342   </tr>
 343
 344   <tr>
 345     <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
 346     <td valign="top">settings remain in effect until parenthesis boundary.</td>
 347   </tr>
 348
 349   <tr>
 350     <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
 351     <td valign="top">horizontal and vertical sampling factor</td>
 352   </tr>
 353
 354   <tr>
 355     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 356     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 357   </tr>
 358
 359   <tr>
 360     <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
 361     <td valign="top">set an image attribute</td>
 362   </tr>
 363
 364   <tr>
 365     <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
 366     <td valign="top">width and height of image</td>
 367   </tr>
 368
 369   <tr>
 370     <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
 371     <td valign="top">transparent color</td>
 372   </tr>
 373
 374   <tr>
 375     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
 376     <td valign="top">print detailed information about the image</td>
 377   </tr>
 378
 379   <tr>
 380     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
 381     <td valign="top">print version information</td>
 382   </tr>
 383
 384   <tr>
 385     <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
 386     <td valign="top">access method for pixels outside the boundaries of the image</td>
 387   </tr>
 388
 389   </tbody>
 390 </table>
 391 \r
 392 </div>\r
 393 \r
 394 <div id="linkbar">\r
 395  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 396     <span id="linkbar-center">\r
 397       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 398       <a href="../www/mailing-list.html">Mailing Lists</a> &bull;\r
 399     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 400     </span>\r
 401     <span id="linkbar-east">&nbsp;</span>\r
 402   </div>\r
 403   <div class="footer">\r
 404     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 405     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 406   </div>\r
 407   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 408 </body>\r
 409 </html>\r