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" 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   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   9   <style type="text/css" media="all">\r
  10     @import url("../www/magick.css");\r
  11   </style>\r
  12   <link rel="shortcut icon" href="../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  13   <title>ImageMagick: Command-line Tools: Compare</title>
  14   <meta http-equiv="Content-Language" content="en-US"/>
  15   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  16   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  17   <meta name="Generator" content="PHP"/>
  18   <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"/>
  19   <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."/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28 </head>\r
  29 \r
  30 <body id="www-imagemagick-org">\r
  31 <div class="titlebar">\r
  32 <a href="../index.html">\r
  33   <img src="../images/script.png" alt="[ImageMagick]"\r
  34   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  35 <a href="http://www.networkredux.com">\r
  36   <img src="../images/networkredux.png" alt="[sponsor]"\r
  37   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  38 <a href="http://www.imagemagick.org/discourse-server/">\r
  39   <img src="../images/logo.jpg" alt=""\r
  40   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  41 <a href="../index.html">\r
  42   <img src="../images/sprite.jpg" alt=""\r
  43   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  44 </div>\r
  45 \r
  46 <div class="eastbar">\r
  47 \r
  48 <div class="menu">
  49   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  50 </div>
  51 <div class="sep"></div>\r
  52 <div class="menu">
  53   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
  54 </div>
  55 <div class="sub">
  56     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
  57 </div>
  58 <div class="sub">
  59     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
  60 </div>
  61 <div class="sub">
  62     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  63 </div>
  64 <div class="menu">
  65   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
  66 </div>
  67 <div class="sub">
  68     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
  78 </div>
  79 <div class="menu">
  80   <a title="Architecture" href="../www/architecture.html">Architecture</a>
  81 </div>
  82 <div class="sep"></div>\r
  83 <div  class="menu">
  84    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
  88 </div>
  89 <div class="sub">
  90     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
  91  </div>
  92 <div class="menu">
  93   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
 103 </div>
 104 <div class="menu">
 105   <a title="Resources" href="../www/resources.html">Resources</a>
 106 </div>
 107 <div class="sep"></div>\r
 108 <div class="menu">
 109   <a title="Download" href="../www/download.html">Download</a>
 110 </div>
 111 <div class="sep"></div>\r
 112 <div class="menu">
 113   <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
 114 </div>
 115 <div class="sep"></div>\r
 116 <div class="menu">
 117   <a title="Site Map"href="../www/sitemap.html">Site Map</a>
 118 </div>
 119 <div  class="sub">
 120     <a title="Site Map: Links"href="../www/links.html">Links</a>
 121 </div>
 122 <div class="sep"></div>\r
 123 <div  class="menu">
 124   <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 125
 126 <div class="sponsbox">
 127 <div  class="sponsor">
 128   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 129 </div>
 130 <div  class="sponsor">
 131   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 132 </div>
 133 <div  class="sponsor">
 134   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 135 </div>
 136 <div  class="sponsor">
 137   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 138 </div>
 139 <div  class="sponsor">
 140   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 141 </div>
 142 <div  class="sponsor">
 143    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 144 </div>
 145 <div  class="sponsor">
 146    <a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20110101000120 -->
 147 </div>
 148 </div>
 149 </div>
 150 \r
 151 \r
 152 </div>\r
 153 \r
 154 <div class="main">\r
 155 \r
 156 <p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
 157
 158 <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>
 159
 160 <div style="margin: auto;">
 161   <h2><a name="usage"></a>Example Usage</h2>
 162 </div>
 163
 164 <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>
 165
 166 <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>
 167 <div class="image">
 168 <p>
 169   <a href="../images/rose.jpg"><img src="../images/rose.jpg" width="70" height="46" alt="rose" /></a>
 170   <a href="../images/reconstruct.jpg"><img src="../images/reconstruct.jpg" width="70" height="46" alt="rose" /></a>
 171   <img style="margin:13px 0;" src="../images/right.gif" width="20" height="20" alt="==>" />
 172   <a href="../images/difference.png"><img src="../images/difference.png" width="70" height="46" alt="rose" /></a>
 173 </p>
 174 </div>
 175
 176 <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>
 177
 178 <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>
 179
 180 <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/>
 181     Channel distortion: MAE     <br/>
 182       red: 2282.91 (0.034835)     <br/>
 183       green: 1853.99 (0.0282901)     <br/>
 184       blue: 2008.67 (0.0306503)     <br/>
 185       all: 1536.39 (0.0234439)     <br/></span></p><p>Or, if you just want the red channel distortion, use this command:</p>
 186
 187 <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>
 188 <p>Or, if you just want the overall image distortion, use this command:</p>
 189
 190 <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>
 191 <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>
 192
 193 <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>
 194 <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>
 195
 196 <div style="margin: auto;">
 197   <h2><a name="options"></a>Option Summary</h2>
 198 </div>
 199
 200 <p>The <kbd>compare</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 201
 202 <table class="doc">
 203   <tbody>
 204   <tr>
 205     <th align="left">Option</th>
 206     <th align="left">Description</th>
 207   </tr>
 208
 209   <tr>
 210     <td valign="top"><a href="../www/command-line-options.html#alpha">-alpha</a></td>
 211     <td valign="top">on, activate, off, deactivate, set, opaque, copy",
 212 transparent, extract, background, or shape the alpha channel</td>
 213   </tr>
 214
 215   <tr>
 216     <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
 217     <td valign="top">decrypt image with this password</td>
 218   </tr>
 219
 220   <tr>
 221     <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
 222     <td valign="top">apply option to select image channels</td>
 223   </tr>
 224
 225   <tr>
 226     <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
 227     <td valign="top">set image colorspace</td>
 228   </tr>
 229
 230   <tr>
 231     <td valign="top"><a href="../www/command-line-options.html#compose">-compose <em class="option">operator</em></a></td>
 232     <td valign="top">set image composite operator</td>
 233   </tr>
 234
 235   <tr>
 236     <td valign="top"><a href="../www/command-line-options.html#decipher">-decipher <em class="option">filename</em></a></td>
 237     <td valign="top">convert cipher pixels to plain</td>
 238   </tr>
 239
 240   <tr>
 241     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 242     <td valign="top">display copious debugging information</td>
 243   </tr>
 244
 245   <tr>
 246     <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
 247     <td valign="top">define one or more image format options</td>
 248   </tr>
 249
 250   <tr>
 251     <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
 252     <td valign="top">horizontal and vertical density of the image</td>
 253   </tr>
 254
 255   <tr>
 256     <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
 257     <td valign="top">image depth</td>
 258   </tr>
 259
 260   <tr>
 261     <td valign="top"><a href="../www/command-line-options.html#disimilarity-threshold">-disimilarity-threshold <em class="option">value</em></a></td>
 262     <td valign="top">maximum RMSE for (sub)image match (default 0.2)</td>
 263   </tr>
 264
 265   <tr>
 266     <td valign="top"><a href="../www/command-line-options.html#encipher">-encipher <em class="option">filename</em></a></td>
 267     <td valign="top">convert plain pixels to cipher pixels</td>
 268   </tr>
 269
 270   <tr>
 271     <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
 272     <td valign="top">extract area from image</td>
 273   </tr>
 274
 275   <tr>
 276     <td valign="top"><a href="../www/command-line-options.html#fuzz">-fuzz <em class="option">distance</em></a></td>
 277     <td valign="top">colors within this distance are considered equal</td>
 278   </tr>
 279
 280   <tr>
 281     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
 282     <td valign="top">print program options</td>
 283   </tr>
 284
 285   <tr>
 286     <td valign="top"><a href="../www/command-line-options.html#highlight-color">-highlight-color <em class="option">color</em></a></td>
 287     <td valign="top">emphasize pixel differences with this color</td>
 288   </tr>
 289
 290   <tr>
 291     <td valign="top"><a href="../www/command-line-options.html#identify">-identify</a></td>
 292     <td valign="top">identify the format and characteristics of the image</td>
 293   </tr>
 294
 295   <tr>
 296     <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
 297     <td valign="top">type of image interlacing scheme</td>
 298   </tr>
 299
 300   <tr>
 301     <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
 302     <td valign="top">pixel cache resource limit</td>
 303   </tr>
 304
 305   <tr>
 306     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
 307     <td valign="top">format of debugging information</td>
 308   </tr>
 309
 310   <tr>
 311     <td valign="top"><a href="../www/command-line-options.html#lowlight-color">-lowlight-color <em class="option">color</em></a></td>
 312     <td valign="top">de-emphasize pixel differences with this color</td>
 313   </tr>
 314
 315   <tr>
 316     <td valign="top"><a href="../www/command-line-options.html#metric">-metric <em class="option">type</em></a></td>
 317     <td valign="top">measure differences between images with this metric</td>
 318   </tr>
 319
 320   <tr>
 321     <td valign="top"><a href="../www/command-line-options.html#profile">-profile <em class="option">filename</em></a></td>
 322     <td valign="top">add, delete, or apply an image profile</td>
 323   </tr>
 324
 325   <tr>
 326     <td valign="top"><a href="../www/command-line-options.html#quality">-quality <em class="option">value</em></a></td>
 327     <td valign="top">JPEG/MIFF/PNG compression level</td>
 328   </tr>
 329
 330   <tr>
 331     <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
 332     <td valign="top">reduce image colors in this colorspace</td>
 333   </tr>
 334
 335   <tr>
 336     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
 337     <td valign="top">suppress all warning messages</td>
 338   </tr>
 339
 340   <tr>
 341     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
 342     <td valign="top">pay attention to warning messages.</td>
 343   </tr>
 344
 345   <tr>
 346     <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
 347     <td valign="top">settings remain in effect until parenthesis boundary.</td>
 348   </tr>
 349
 350   <tr>
 351     <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
 352     <td valign="top">horizontal and vertical sampling factor</td>
 353   </tr>
 354
 355   <tr>
 356     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 357     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 358   </tr>
 359
 360   <tr>
 361     <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
 362     <td valign="top">set an image attribute</td>
 363   </tr>
 364
 365   <tr>
 366     <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
 367     <td valign="top">width and height of image</td>
 368   </tr>
 369
 370   <tr>
 371     <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
 372     <td valign="top">transparent color</td>
 373   </tr>
 374
 375   <tr>
 376     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
 377     <td valign="top">print detailed information about the image</td>
 378   </tr>
 379
 380   <tr>
 381     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
 382     <td valign="top">print version information</td>
 383   </tr>
 384
 385   <tr>
 386     <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
 387     <td valign="top">access method for pixels outside the boundaries of the image</td>
 388   </tr>
 389
 390   </tbody>
 391 </table>
 392 \r
 393 </div>\r
 394 \r
 395 <div id="linkbar">\r
 396  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 397     <span id="linkbar-center">\r
 398       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</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-2010 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