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