]> granicus.if.org Git - imagemagick/blob - www/compare.html
(no commit message)
[imagemagick] / 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   <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, 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."/>
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-2010 ImageMagick Studio LLC"/>
24   <meta name="Distribution" content="Global"/>
25   <link rel="icon" href="../images/wand.png"  sizes="32x32"/>
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   <style type="text/css" media="all">\r
29     @import url("../www/magick.css");\r
30   </style>\r
31 </head>\r
32 \r
33 <body id="www-imagemagick-org">\r
34 <div class="titlebar">\r
35 <a href="../index.html">\r
36   <img src="../images/script.png" alt="[ImageMagick]"\r
37   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
38 <a href="http://www.networkredux.com">\r
39   <img src="../images/networkredux.png" alt="[sponsor]"\r
40   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
41 <a href="http://www.imagemagick.org/discourse-server/">\r
42   <img src="../images/logo.jpg" alt=""\r
43   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
44 <a href="../index.html">\r
45   <img src="../images/sprite.jpg" alt=""\r
46   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
47 </div>\r
48 \r
49 <div class="westbar">\r
50 \r
51 <div class="menu">
52   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
53 </div>
54 <div class="sep"></div>\r
55 <div class="menu">
56   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
57 </div>
58 <div class="sub">
59     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
60 </div>
61 <div class="sub">
62     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
63 </div>
64 <div class="sub">
65     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
66 </div>
67 <div class="sep"></div>\r
68 <div class="menu">
69   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
70 </div>
71 <div class="sub">
72     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
73 </div>
74 <div class="sub">
75     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
76 </div>
77 <div class="sub">
78     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
79 </div>
80 <div class="menu">
81   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
82 </div>
83 <div class="sub">
84     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
85 </div>
86 <div class="sub">
87     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
88 </div>
89 <div class="sub">
90     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
91 </div>
92 <div class="sub">
93     <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
94 </div>
95 <div class="sep"></div>\r
96 <div  class="menu">
97    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
98 </div>
99 <div class="sub">
100     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
101 </div>
102 <div class="sub">
103     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
104  </div>
105 <div class="menu">
106   <a title="Resources" href="../www/resources.html">Resources</a>
107 </div>
108 <div class="menu">
109   <a title="Architecture" href="../www/architecture.html">Architecture</a>
110 </div>
111 <div class="menu">
112   <a title="Download" href="../www/download.html">Download</a>
113 </div>
114 <div class="sep"></div>\r
115 <div class="menu">
116   <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
117 </div>
118 <div class="sep"></div>\r
119 <div class="menu">
120   <a title="Site Map"href="../www/sitemap.html">Site Map</a>
121 </div>
122 <div  class="sub">
123     <a title="Site Map: Links"href="../www/links.html">Links</a>
124 </div>
125 <div class="sep"></div>\r
126 <div  class="menu">
127   <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
128
129 <div class="sponsbox">
130 <div  class="sponsor">
131    <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
132 </div>
133 <div  class="sponsor">
134   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
135 </div>
136 <div  class="sponsor">
137   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
138 </div>
139 <div  class="sponsor">
140   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
141 </div>
142 <div  class="sponsor">
143   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
144 </div>
145 <div  class="sponsor">
146   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
147 </div>
148 <div  class="sponsor">
149   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
150 </div>
151 <div  class="sponsor">
152    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
153 </div>
154 </div>
155 </div>
156 </div>\r
157 \r
158 <div class="eastbar">\r
159   <script type="text/javascript">\r
160   <!--\r
161     google_ad_client = "pub-3129977114552745";\r
162     google_ad_slot = "0574824969";\r
163     google_ad_width = 160;\r
164     google_ad_height = 600;\r
165   //-->\r
166   </script>\r
167   <script type="text/javascript"\r
168     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
169   </script>\r
170 </div>\r
171 \r
172 <div class="main">\r
173 \r
174 <p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
175
176 <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>
177
178 <div style="margin: auto;">
179   <h2><a name="usage"></a>Example Usage</h2>
180 </div>
181
182 <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>
183
184 <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>
185 <div class="image">
186 <p>
187   <a href="../images/rose.jpg"><img src="../images/rose.jpg" width="70" height="46" alt="rose" /></a>
188   <a href="../images/reconstruct.jpg"><img src="../images/reconstruct.jpg" width="70" height="46" alt="rose" /></a>
189   <img style="margin:13px 0;" src="../images/right.gif" width="20" height="20" alt="==>" />
190   <a href="../images/difference.png"><img src="../images/difference.png" width="70" height="46" alt="rose" /></a>
191 </p>
192 </div>
193
194 <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>
195
196 <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>
197
198 <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/>
199     Channel distortion: MAE     <br/>
200       red: 2282.91 (0.034835)     <br/>
201       green: 1853.99 (0.0282901)     <br/>
202       blue: 2008.67 (0.0306503)     <br/>
203       all: 1536.39 (0.0234439)     <br/></span></p><p>Or, if you just want the red channel distortion, use this command:</p>
204
205 <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>
206 <p>Or, if you just want the overall image distortion, use this command:</p>
207
208 <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>
209 <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>
210
211 <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>
212 <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>
213
214 <div style="margin: auto;">
215   <h2><a name="options"></a>Option Summary</h2>
216 </div>
217
218 <p>The <kbd>compare</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
219
220 <table class="doc">
221   <tbody>
222   <tr>
223     <th align="left">Option</th>
224     <th align="left">Description</th>
225   </tr>
226
227   <tr>
228     <td valign="top"><a href="../www/command-line-options.html#alpha">-alpha</a></td>
229     <td valign="top">on, activate, off, deactivate, set, opaque, copy",
230 transparent, extract, background, or shape the alpha channel</td>
231   </tr>
232
233   <tr>
234     <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
235     <td valign="top">decrypt image with this password</td>
236   </tr>
237
238   <tr>
239     <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
240     <td valign="top">apply option to select image channels</td>
241   </tr>
242
243   <tr>
244     <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
245     <td valign="top">set image colorspace</td>
246   </tr>
247
248   <tr>
249     <td valign="top"><a href="../www/command-line-options.html#compose">-compose <em class="option">operator</em></a></td>
250     <td valign="top">set image composite operator</td>
251   </tr>
252
253   <tr>
254     <td valign="top"><a href="../www/command-line-options.html#decipher">-decipher <em class="option">filename</em></a></td>
255     <td valign="top">convert cipher pixels to plain</td>
256   </tr>
257
258   <tr>
259     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
260     <td valign="top">display copious debugging information</td>
261   </tr>
262
263   <tr>
264     <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
265     <td valign="top">define one or more image format options</td>
266   </tr>
267
268   <tr>
269     <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
270     <td valign="top">horizontal and vertical density of the image</td>
271   </tr>
272
273   <tr>
274     <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
275     <td valign="top">image depth</td>
276   </tr>
277
278   <tr>
279     <td valign="top"><a href="../www/command-line-options.html#disimilarity-threshold">-disimilarity-threshold <em class="option">value</em></a></td>
280     <td valign="top">maximum RMSE for (sub)image match (default 0.2)</td>
281   </tr>
282
283   <tr>
284     <td valign="top"><a href="../www/command-line-options.html#encipher">-encipher <em class="option">filename</em></a></td>
285     <td valign="top">convert plain pixels to cipher pixels</td>
286   </tr>
287
288   <tr>
289     <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
290     <td valign="top">extract area from image</td>
291   </tr>
292
293   <tr>
294     <td valign="top"><a href="../www/command-line-options.html#fuzz">-fuzz <em class="option">distance</em></a></td>
295     <td valign="top">colors within this distance are considered equal</td>
296   </tr>
297
298   <tr>
299     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
300     <td valign="top">print program options</td>
301   </tr>
302
303   <tr>
304     <td valign="top"><a href="../www/command-line-options.html#highlight-color">-highlight-color <em class="option">color</em></a></td>
305     <td valign="top">emphasize pixel differences with this color</td>
306   </tr>
307
308   <tr>
309     <td valign="top"><a href="../www/command-line-options.html#identify">-identify</a></td>
310     <td valign="top">identify the format and characteristics of the image</td>
311   </tr>
312
313   <tr>
314     <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
315     <td valign="top">type of image interlacing scheme</td>
316   </tr>
317
318   <tr>
319     <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
320     <td valign="top">pixel cache resource limit</td>
321   </tr>
322
323   <tr>
324     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
325     <td valign="top">format of debugging information</td>
326   </tr>
327
328   <tr>
329     <td valign="top"><a href="../www/command-line-options.html#lowlight-color">-lowlight-color <em class="option">color</em></a></td>
330     <td valign="top">de-emphasize pixel differences with this color</td>
331   </tr>
332
333   <tr>
334     <td valign="top"><a href="../www/command-line-options.html#metric">-metric <em class="option">type</em></a></td>
335     <td valign="top">measure differences between images with this metric</td>
336   </tr>
337
338   <tr>
339     <td valign="top"><a href="../www/command-line-options.html#profile">-profile <em class="option">filename</em></a></td>
340     <td valign="top">add, delete, or apply an image profile</td>
341   </tr>
342
343   <tr>
344     <td valign="top"><a href="../www/command-line-options.html#quality">-quality <em class="option">value</em></a></td>
345     <td valign="top">JPEG/MIFF/PNG compression level</td>
346   </tr>
347
348   <tr>
349     <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
350     <td valign="top">reduce image colors in this colorspace</td>
351   </tr>
352
353   <tr>
354     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
355     <td valign="top">suppress all warning messages</td>
356   </tr>
357
358   <tr>
359     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
360     <td valign="top">pay attention to warning messages.</td>
361   </tr>
362
363   <tr>
364     <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
365     <td valign="top">settings remain in effect until parenthesis boundary.</td>
366   </tr>
367
368   <tr>
369     <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
370     <td valign="top">horizontal and vertical sampling factor</td>
371   </tr>
372
373   <tr>
374     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
375     <td valign="top">seed a new sequence of pseudo-random numbers</td>
376   </tr>
377
378   <tr>
379     <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
380     <td valign="top">set an image attribute</td>
381   </tr>
382
383   <tr>
384     <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
385     <td valign="top">width and height of image</td>
386   </tr>
387
388   <tr>
389     <td valign="top"><a href="../www/command-line-options.html#version">-subimage-search</a></td>
390     <td valign="top">search for subimage</td>
391   </tr>
392
393   <tr>
394     <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
395     <td valign="top">transparent color</td>
396   </tr>
397
398   <tr>
399     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
400     <td valign="top">print detailed information about the image</td>
401   </tr>
402
403   <tr>
404     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
405     <td valign="top">print version information</td>
406   </tr>
407
408   <tr>
409     <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
410     <td valign="top">access method for pixels outside the boundaries of the image</td>
411   </tr>
412
413   </tbody>
414 </table>
415 \r
416 </div>\r
417 \r
418 <div id="linkbar">\r
419     <span id="linkbar-west">&nbsp;</span>\r
420     <span id="linkbar-center">\r
421       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
422       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
423     </span>\r
424     <span id="linkbar-east">&nbsp;</span>\r
425   </div>\r
426   <div class="footer">\r
427     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
428     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
429   </div>\r
430   <div style="clear: both; margin: 0; width: 100%; "></div>\r
431   <script type="text/javascript">\r
432     var _gaq = _gaq || [];\r
433     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
434     _gaq.push(['_trackPageview']);\r
435 \r
436     (function() {\r
437       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
438       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
439       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
440     })();\r
441   </script>\r
442 </body>\r
443 </html>\r