blob: 1050def06e17654544e284ebfa70a150ddd63f11 [file] [log] [blame]
Cristy594d2772015-11-15 10:47:42 -05001
2
3
4
cristy29dc8652015-05-12 16:26:21 +00005<!DOCTYPE html>
cristyd2432012015-05-04 23:15:15 +00006<html lang="en">
cristyad41c0c2012-10-31 00:49:28 +00007<head>
Cristy912a9222016-06-17 15:37:28 -04008 <meta charset="utf-8" />
Cristy3b0b58d2016-11-06 07:40:23 -05009 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
10 <meta http-equiv="x-ua-compatible" content="ie=edge" />
Cristy6549abb2016-11-10 08:25:55 -050011 <title>Command-line Tools: Compare @ ImageMagick</title>
Cristy594d2772015-11-15 10:47:42 -050012 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
13 <meta name="application-name" content="ImageMagick"/>
14 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves."/>
Cristy364a72f2016-11-04 22:38:41 -040015 <meta name="application-url" content="https://www.imagemagick.org"/>
Cristy594d2772015-11-15 10:47:42 -050016 <meta name="generator" content="PHP"/>
17 <meta name="keywords" content="command-line, tools:, compare, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/>
18 <meta name="rating" content="GENERAL"/>
19 <meta name="robots" content="INDEX, FOLLOW"/>
20 <meta name="generator" content="ImageMagick Studio LLC"/>
21 <meta name="author" content="ImageMagick Studio LLC"/>
22 <meta name="revisit-after" content="2 DAYS"/>
23 <meta name="resource-type" content="document"/>
Cristy912a9222016-06-17 15:37:28 -040024 <meta name="copyright" content="Copyright (c) 1999-2016 ImageMagick Studio LLC"/>
Cristy594d2772015-11-15 10:47:42 -050025 <meta name="distribution" content="Global"/>
26 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/>
Cristy912a9222016-06-17 15:37:28 -040027 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
Cristy6549abb2016-11-10 08:25:55 -050028 <link rel="canonical" href="https://www.imagemagick.org/script/compare.html"/>
Cristy594d2772015-11-15 10:47:42 -050029 <link rel="icon" href="../images/wand.png"/>
30 <link rel="shortcut icon" href="../images/wand.ico"/>
Cristybc232422016-11-22 07:46:18 -050031 <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Roboto:900,400,400italic,700,700italic,300,300italic|Open+Sans:300italic,400italic,700italic,300,400,600,700" />
Cristyce4a3552015-12-14 13:53:35 -050032 <link rel="stylesheet" href="css/magick.css"/>
cristyad41c0c2012-10-31 00:49:28 +000033</head>
cristyd2432012015-05-04 23:15:15 +000034<body>
cristyad41c0c2012-10-31 00:49:28 +000035<div class="main">
cristyd2432012015-05-04 23:15:15 +000036<div class="magick-masthead">
37 <div class="container">
Cristy6549abb2016-11-10 08:25:55 -050038 <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle"
Cristy594d2772015-11-15 10:47:42 -050039 style="display:block"
40 data-ad-client="ca-pub-3129977114552745"
41 data-ad-slot="6345125851"
42 data-ad-format="auto"></ins>
cristy29f2c972015-07-28 13:37:46 +000043 <script>
Cristy542697a2015-10-12 20:10:32 -040044 (adsbygoogle = window.adsbygoogle || []).push({});
cristyd2432012015-05-04 23:15:15 +000045 </script>
cristyd2432012015-05-04 23:15:15 +000046 <nav class="magick-nav">
cristy44443b92015-05-05 00:06:07 +000047 <a class="magick-nav-item " href="../index.html">Home</a>
cristyea2793e2015-05-31 16:52:26 +000048 <a class="magick-nav-item " href="binary-releases.html">Download</a>
cristyd2432012015-05-04 23:15:15 +000049 <a class="magick-nav-item " href="command-line-tools.html">Tools</a>
Cristye93be682015-11-26 09:07:51 -050050 <a class="magick-nav-item " href="command-line-processing.html">Command-line</a>
cristyea2793e2015-05-31 16:52:26 +000051 <a class="magick-nav-item " href="resources.html">Resources</a>
52 <a class="magick-nav-item " href="api.html">Develop</a>
Cristy6549abb2016-11-10 08:25:55 -050053 <a class="magick-nav-item " href="https://www.imagemagick.org/script/search.php">Search</a>
54 <a class="magick-nav-item pull-right" href="https://www.imagemagick.org/discourse-server/">Community</a>
cristyd2432012015-05-04 23:15:15 +000055 </nav>
56 </div>
cristy3ed852e2009-09-05 21:47:34 +000057</div>
cristyd2432012015-05-04 23:15:15 +000058<div class="container">
59<div class="magick-header">
60<p class="text-center"><a href="compare.html#usage">Example Usage</a><a href="compare.html#options">Option Summary</a></p>
cristy3ed852e2009-09-05 21:47:34 +000061
Cristyce4a3552015-12-14 13:53:35 -050062<p class="lead magick-description">Use the <code>compare</code> program to mathematically and visually annotate the difference between an image and its reconstruction. See <a href="command-line-processing.html">Command Line Processing</a> for advice on how to structure your <code>compare</code> command or see below for example usages of the command.</p>
cristyd2432012015-05-04 23:15:15 +000063
64<h2 class="magick-header"><a id="usage"></a>Example Usage</h2>
cristy751980d2012-06-03 23:18:35 +000065
cristy8ee7f242013-06-20 16:08:44 +000066<p>We list a few examples of the <code>compare</code> command here to illustrate its usefulness and ease of use. To get started, lets compare an image to one thats been sharpened:</p>
cristy3ed852e2009-09-05 21:47:34 +000067
cristyd2432012015-05-04 23:15:15 +000068<pre>
69convert rose.jpg -sharpen 0x1 reconstruct.jpg
70compare rose.jpg reconstruct.jpg difference.png
71compare -compose src rose.jpg reconstruct.jpg difference.png
72</pre>
73
74<ul>
Cristy594d2772015-11-15 10:47:42 -050075 <a href="../images/rose.jpg"><img src="../images/rose.jpg" width="70" height="46" alt="rose" /></a>
76 <a href="../images/reconstruct.jpg"><img src="../images/reconstruct.jpg" width="70" height="46" alt="rose" /></a>
77 <img style="margin:13px 0;" src="../images/right.gif" width="20" height="20" alt="==>" />
78 <a href="../images/difference.png"><img src="../images/difference.png" width="70" height="46" alt="rose" /></a>
cristyd2432012015-05-04 23:15:15 +000079</ul>
cristy3ed852e2009-09-05 21:47:34 +000080
81<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>
82
83<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>
84
cristyd2432012015-05-04 23:15:15 +000085<pre>
Cristy594d2772015-11-15 10:47:42 -050086-> compare -verbose -metric mae rose.jpg reconstruct.jpg difference.png
cristyd2432012015-05-04 23:15:15 +000087Image: rose.jpg
88 Channel distortion: MAE
89 red: 2282.91 (0.034835)
90 green: 1853.99 (0.0282901)
91 blue: 2008.67 (0.0306503)
92 all: 1536.39 (0.0234439)
93</pre>
94<p>Or, if you just want the red channel distortion, use this command:</p>
cristy3ed852e2009-09-05 21:47:34 +000095
cristyd2432012015-05-04 23:15:15 +000096<pre>
Cristy594d2772015-11-15 10:47:42 -050097-> compare -channel red -metric PSNR rose.jpg reconstruct.jpg difference.png
cristyd2432012015-05-04 23:15:15 +00009819.63
99</pre>
100
cristy3ed852e2009-09-05 21:47:34 +0000101<p>Or, if you just want the overall image distortion, use this command:</p>
102
cristyd2432012015-05-04 23:15:15 +0000103<pre>
Cristy594d2772015-11-15 10:47:42 -0500104-> compare -metric PSNR rose.jpg reconstruct.jpg difference.png
cristyd2432012015-05-04 23:15:15 +000010528.31
106</pre>
107
cristy3ed852e2009-09-05 21:47:34 +0000108<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>
109
cristyd2432012015-05-04 23:15:15 +0000110<pre>
Cristy594d2772015-11-15 10:47:42 -0500111-> compare -metric RMSE -subimage-search logo.png wizard.jpg similarity.gif
cristyd2432012015-05-04 23:15:15 +000011285.05 (0.00129778) @ 353,157
113</pre>
114
Cristy364a72f2016-11-04 22:38:41 -0400115<p>You can find additional examples of using <code>compare</code> in <a href="http://www.ibm.com/developerworks/library/l-graf/?ca=dnt-428">Graphics from the Command Line</a>. Further discussion is available in <a href="http://www.ibm.com/developerworks/library/l-graf2/?ca=dgr-lnxw15GraphicsLine">More Graphics from the Command Line</a> and <a href="https://www.imagemagick.org/Usage/">Examples of ImageMagick Usage</a>.</p>
cristyf1b8a092014-02-20 15:46:11 +0000116
117<p>The compare program returns 2 on error otherwise 0 if the images are similar or 1 if they are dissimilar.</p>
cristy3ed852e2009-09-05 21:47:34 +0000118
cristyd2432012015-05-04 23:15:15 +0000119<h2 class="magick-header"><a id="options"></a>Option Summary</h2>
cristy751980d2012-06-03 23:18:35 +0000120
cristy8ee7f242013-06-20 16:08:44 +0000121<p>The <code>compare</code> command recognizes these options. Click on an option to get more details about how that option works.</p>
cristy3ed852e2009-09-05 21:47:34 +0000122
cristyd2432012015-05-04 23:15:15 +0000123<table class="table table-condensed table-striped">
cristy3ed852e2009-09-05 21:47:34 +0000124 <tbody>
125 <tr>
126 <th align="left">Option</th>
127 <th align="left">Description</th>
128 </tr>
129
130 <tr>
cristyd2432012015-05-04 23:15:15 +0000131 <td><a href="command-line-options.html#alpha">-alpha</a></td>
132 <td>on, activate, off, deactivate, set, opaque, copy",
cristy3ed852e2009-09-05 21:47:34 +0000133transparent, extract, background, or shape the alpha channel</td>
134 </tr>
135
136 <tr>
cristyd2432012015-05-04 23:15:15 +0000137 <td><a href="command-line-options.html#authenticate">-authenticate <var>value</var></a></td>
138 <td>decrypt image with this password</td>
cristy3ed852e2009-09-05 21:47:34 +0000139 </tr>
140
141 <tr>
cristyd2432012015-05-04 23:15:15 +0000142 <td><a href="command-line-options.html#channel">-channel <var>type</var></a></td>
143 <td>apply option to select image channels</td>
cristy3ed852e2009-09-05 21:47:34 +0000144 </tr>
145
146 <tr>
cristyd2432012015-05-04 23:15:15 +0000147 <td><a href="command-line-options.html#colorspace">-colorspace <var>type</var></a></td>
148 <td>set image colorspace</td>
cristy3ed852e2009-09-05 21:47:34 +0000149 </tr>
150
151 <tr>
cristyd2432012015-05-04 23:15:15 +0000152 <td><a href="command-line-options.html#compose">-compose <var>operator</var></a></td>
153 <td>set image composite operator</td>
cristy3ed852e2009-09-05 21:47:34 +0000154 </tr>
155
156 <tr>
cristyd2432012015-05-04 23:15:15 +0000157 <td><a href="command-line-options.html#decipher">-decipher <var>filename</var></a></td>
158 <td>convert cipher pixels to plain</td>
cristy3ed852e2009-09-05 21:47:34 +0000159 </tr>
160
161 <tr>
cristyd2432012015-05-04 23:15:15 +0000162 <td><a href="command-line-options.html#debug">-debug <var>events</var></a></td>
163 <td>display copious debugging information</td>
cristy3ed852e2009-09-05 21:47:34 +0000164 </tr>
165
166 <tr>
cristyd2432012015-05-04 23:15:15 +0000167 <td><a href="command-line-options.html#define">-define <var>format:option</var></a></td>
168 <td>define one or more image format options</td>
cristy3ed852e2009-09-05 21:47:34 +0000169 </tr>
170
171 <tr>
cristyd2432012015-05-04 23:15:15 +0000172 <td><a href="command-line-options.html#density">-density <var>geometry</var></a></td>
173 <td>horizontal and vertical density of the image</td>
cristy3ed852e2009-09-05 21:47:34 +0000174 </tr>
175
176 <tr>
cristyd2432012015-05-04 23:15:15 +0000177 <td><a href="command-line-options.html#depth">-depth <var>value</var></a></td>
178 <td>image depth</td>
cristy3ed852e2009-09-05 21:47:34 +0000179 </tr>
180
181 <tr>
cristyd2432012015-05-04 23:15:15 +0000182 <td><a href="command-line-options.html#dissimilarity-threshold">-dissimilarity-threshold <var>value</var></a></td>
183 <td>maximum distortion for (sub)image match (default 0.2)</td>
cristy3ed852e2009-09-05 21:47:34 +0000184 </tr>
185
186 <tr>
cristyd2432012015-05-04 23:15:15 +0000187 <td><a href="command-line-options.html#encipher">-encipher <var>filename</var></a></td>
188 <td>convert plain pixels to cipher pixels</td>
cristy3ed852e2009-09-05 21:47:34 +0000189 </tr>
190
191 <tr>
cristyd2432012015-05-04 23:15:15 +0000192 <td><a href="command-line-options.html#extract">-extract <var>geometry</var></a></td>
193 <td>extract area from image</td>
cristy3ed852e2009-09-05 21:47:34 +0000194 </tr>
195
196 <tr>
cristyd2432012015-05-04 23:15:15 +0000197 <td><a href="command-line-options.html#fuzz">-fuzz <var>distance</var></a></td>
198 <td>colors within this distance are considered equal</td>
cristy3ed852e2009-09-05 21:47:34 +0000199 </tr>
200
201 <tr>
cristyd2432012015-05-04 23:15:15 +0000202 <td><a href="command-line-options.html#help">-help</a></td>
203 <td>print program options</td>
cristy3ed852e2009-09-05 21:47:34 +0000204 </tr>
205
206 <tr>
cristyd2432012015-05-04 23:15:15 +0000207 <td><a href="command-line-options.html#highlight-color">-highlight-color <var>color</var></a></td>
208 <td>emphasize pixel differences with this color</td>
cristy3ed852e2009-09-05 21:47:34 +0000209 </tr>
210
211 <tr>
cristyd2432012015-05-04 23:15:15 +0000212 <td><a href="command-line-options.html#identify">-identify</a></td>
213 <td>identify the format and characteristics of the image</td>
cristy3ed852e2009-09-05 21:47:34 +0000214 </tr>
215
216 <tr>
cristyd2432012015-05-04 23:15:15 +0000217 <td><a href="command-line-options.html#interlace">-interlace <var>type</var></a></td>
218 <td>type of image interlacing scheme</td>
cristy3ed852e2009-09-05 21:47:34 +0000219 </tr>
220
221 <tr>
cristyd2432012015-05-04 23:15:15 +0000222 <td><a href="command-line-options.html#limit">-limit <var>type value</var></a></td>
223 <td>pixel cache resource limit</td>
cristy3ed852e2009-09-05 21:47:34 +0000224 </tr>
225
226 <tr>
cristyd2432012015-05-04 23:15:15 +0000227 <td><a href="command-line-options.html#log">-log <var>format</var></a></td>
228 <td>format of debugging information</td>
cristy3ed852e2009-09-05 21:47:34 +0000229 </tr>
230
231 <tr>
cristyd2432012015-05-04 23:15:15 +0000232 <td><a href="command-line-options.html#lowlight-color">-lowlight-color <var>color</var></a></td>
233 <td>de-emphasize pixel differences with this color</td>
cristy3ed852e2009-09-05 21:47:34 +0000234 </tr>
235
236 <tr>
cristyd2432012015-05-04 23:15:15 +0000237 <td><a href="command-line-options.html#metric">-metric <var>type</var></a></td>
238 <td>measure differences between images with this metric</td>
cristy3ed852e2009-09-05 21:47:34 +0000239 </tr>
240
241 <tr>
cristyd2432012015-05-04 23:15:15 +0000242 <td><a href="command-line-options.html#profile">-profile <var>filename</var></a></td>
243 <td>add, delete, or apply an image profile</td>
cristy3ed852e2009-09-05 21:47:34 +0000244 </tr>
245
246 <tr>
cristyd2432012015-05-04 23:15:15 +0000247 <td><a href="command-line-options.html#quality">-quality <var>value</var></a></td>
248 <td>JPEG/MIFF/PNG compression level</td>
cristy3ed852e2009-09-05 21:47:34 +0000249 </tr>
250
251 <tr>
cristyd2432012015-05-04 23:15:15 +0000252 <td><a href="command-line-options.html#quantize">-quantize <var>colorspace</var></a></td>
253 <td>reduce image colors in this colorspace</td>
cristy3ed852e2009-09-05 21:47:34 +0000254 </tr>
255
256 <tr>
cristyd2432012015-05-04 23:15:15 +0000257 <td><a href="command-line-options.html#quiet">-quiet</a></td>
258 <td>suppress all warning messages</td>
cristy3ed852e2009-09-05 21:47:34 +0000259 </tr>
260
261 <tr>
cristyd2432012015-05-04 23:15:15 +0000262 <td><a href="command-line-options.html#regard-warnings">-regard-warnings</a></td>
263 <td>pay attention to warning messages.</td>
cristy3ed852e2009-09-05 21:47:34 +0000264 </tr>
265
266 <tr>
cristyd2432012015-05-04 23:15:15 +0000267 <td><a href="command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
268 <td>settings remain in effect until parenthesis boundary.</td>
cristy3ed852e2009-09-05 21:47:34 +0000269 </tr>
270
271 <tr>
cristyd2432012015-05-04 23:15:15 +0000272 <td><a href="command-line-options.html#sampling-factor">-sampling-factor <var>geometry</var></a></td>
273 <td>horizontal and vertical sampling factor</td>
cristy3ed852e2009-09-05 21:47:34 +0000274 </tr>
275
276 <tr>
cristyd2432012015-05-04 23:15:15 +0000277 <td><a href="command-line-options.html#seed">-seed <var>value</var></a></td>
278 <td>seed a new sequence of pseudo-random numbers</td>
cristy3ed852e2009-09-05 21:47:34 +0000279 </tr>
280
281 <tr>
cristyd2432012015-05-04 23:15:15 +0000282 <td><a href="command-line-options.html#set">-set <var>attribute value</var></a></td>
283 <td>set an image attribute</td>
cristy3ed852e2009-09-05 21:47:34 +0000284 </tr>
285
286 <tr>
cristyd2432012015-05-04 23:15:15 +0000287 <td><a href="command-line-options.html#similarity-threshold">-similarity-threshold <var>value</var></a></td>
288 <td>minimum distortion for (sub)image match (default 0.0)</td>
cristy8ee7f242013-06-20 16:08:44 +0000289 </tr>
290
291 <tr>
cristyd2432012015-05-04 23:15:15 +0000292 <td><a href="command-line-options.html#size">-size <var>geometry</var></a></td>
293 <td>width and height of image</td>
cristy3ed852e2009-09-05 21:47:34 +0000294 </tr>
295
296 <tr>
cristyd2432012015-05-04 23:15:15 +0000297 <td><a href="command-line-options.html#subimage-search">-subimage-search</a></td>
298 <td>search for subimage</td>
cristyae6203d2010-08-09 01:12:14 +0000299 </tr>
300
301 <tr>
cristyd2432012015-05-04 23:15:15 +0000302 <td><a href="command-line-options.html#synchronize">-synchronize</a></td>
303 <td>synchronize image to storage device</td>
cristy5063d812010-10-19 16:28:10 +0000304 </tr>
305
306 <tr>
cristyd2432012015-05-04 23:15:15 +0000307 <td><a href="command-line-options.html#taint">-taint</a></td>
308 <td>mark the image as modified</td>
cristy5063d812010-10-19 16:28:10 +0000309 </tr>
310
311 <tr>
cristyd2432012015-05-04 23:15:15 +0000312 <td><a href="command-line-options.html#transparent-color">-transparent-color <var>color</var></a></td>
313 <td>transparent color</td>
cristy3ed852e2009-09-05 21:47:34 +0000314 </tr>
315
316 <tr>
cristyd2432012015-05-04 23:15:15 +0000317 <td><a href="command-line-options.html#verbose">-verbose</a></td>
318 <td>print detailed information about the image</td>
cristy3ed852e2009-09-05 21:47:34 +0000319 </tr>
320
321 <tr>
cristyd2432012015-05-04 23:15:15 +0000322 <td><a href="command-line-options.html#version">-version</a></td>
323 <td>print version information</td>
cristy3ed852e2009-09-05 21:47:34 +0000324 </tr>
325
326 <tr>
cristyd2432012015-05-04 23:15:15 +0000327 <td><a href="command-line-options.html#virtual-pixel">-virtual-pixel <var>method</var></a></td>
328 <td>access method for pixels outside the boundaries of the image</td>
cristy3ed852e2009-09-05 21:47:34 +0000329 </tr>
330
331 </tbody>
332</table>
cristy751980d2012-06-03 23:18:35 +0000333</div>
cristyd2432012015-05-04 23:15:15 +0000334 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +0000335 <p><a href="support.html">Donate</a>
336 <a href="sitemap.html">Sitemap</a>
cristyd2432012015-05-04 23:15:15 +0000337 <a href="links.html">Related</a>
Cristye0779712016-07-30 17:25:22 -0400338 <a href="security-policy.html">Security</a>
cristy29f2c972015-07-28 13:37:46 +0000339 <a href="architecture.html">Architecture</a>
cristyd2432012015-05-04 23:15:15 +0000340</p>
341 <p><a href="compare.html#">Back to top</a>
cristyea2793e2015-05-31 16:52:26 +0000342 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
Cristy6549abb2016-11-10 08:25:55 -0500343 <a href="https://www.imagemagick.org/script/contact.php">Contact Us</a></p>
Cristyde27d762016-01-02 12:56:44 -0500344 <p><small>© 1999-2016 ImageMagick Studio LLC</small></p>
cristyd2432012015-05-04 23:15:15 +0000345 </footer>
346</div><!-- /.container -->
cristyad41c0c2012-10-31 00:49:28 +0000347
Cristy542697a2015-10-12 20:10:32 -0400348 <script src="https://localhost/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
Cristy1f1f3a02016-06-01 07:25:42 -0400349 <script src="../js/magick.html"></script>
cristyad41c0c2012-10-31 00:49:28 +0000350</div>
cristyad41c0c2012-10-31 00:49:28 +0000351</body>
cristy5a367e42015-05-05 12:39:18 +0000352</html>
Cristybc232422016-11-22 07:46:18 -0500353<!-- Magick Cache 22nd November 2016 07:36 -->