blob: 6eb33ea6e21862c207b27f375c9accbc56c3d22e [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001
cristydcca3fa2010-12-29 21:50:07 +00002<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
cristy2bd2a982011-02-15 00:52:58 +00004<html version="-//W3C//DTD XHTML 1.1//EN"
5 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
6 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
7 xsi:schemaLocation="http://www.w3.org/1999/xhtml
8 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +00009<head>
cristy3c98a4f2010-08-13 20:09:41 +000010 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
cristy1efc1ab2011-08-01 14:47:02 +000011 <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
cristyffb69ed2010-12-25 00:06:48 +000012 <title>ImageMagick: Command-line Tools: Compare</title>
cristy3ed852e2009-09-05 21:47:34 +000013 <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"/>
cristy3c98a4f2010-08-13 20:09:41 +000016 <meta name="Application-name" content="ImageMagick"/>
cristye6e84152011-06-06 14:16:49 +000017 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images automagically."/>
cristy3c98a4f2010-08-13 20:09:41 +000018 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000019 <meta name="Generator" content="PHP"/>
cristyeed6cb62012-01-28 19:38:34 +000020 <meta name="Keywords" content="command-line, tools:, compare, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
cristy3ed852e2009-09-05 21:47:34 +000021 <meta name="Rating" content="GENERAL"/>
22 <meta name="Robots" content="INDEX, FOLLOW"/>
23 <meta name="Generator" content="ImageMagick Studio LLC"/>
24 <meta name="Author" content="ImageMagick Studio LLC"/>
25 <meta name="Revisit-after" content="2 DAYS"/>
26 <meta name="Resource-type" content="document"/>
cristy1454be72011-12-19 01:52:48 +000027 <meta name="Copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000028 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000029 <link rel="icon" href="../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000030 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
cristy29c5c992011-06-25 13:58:49 +000031 <link rel="canonical" href="http://www.imagemagick.org" />
cristy3c98a4f2010-08-13 20:09:41 +000032 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristyeed6cb62012-01-28 19:38:34 +000033 <!-- Add jQuery library -->
34 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
35
36 <!-- Optionaly include easing and/or mousewheel plugins -->
37 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
38 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
39
40 <!-- Add fancyBox -->
41 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.3" type="text/css" media="screen" />
42 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.3"></script>
43
44 <!-- Optionaly include button and/or thumbnail helpers -->
45 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.3" type="text/css" media="screen" />
46 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.3"></script>
47
48 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.3" type="text/css" media="screen" />
49 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.3"></script>
50 <script type="text/javascript">
51 $(document).ready(function() {
52 $(".fancybox").fancybox();
53 });
54 </script>
55 <!-- ImageMagick style -->
cristy7a40ba82011-01-08 20:31:18 +000056 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000057 <style type="text/css" media="all">
58 @import url("../www/magick.css");
59 </style>
cristy3eaa0ef2010-03-06 20:35:26 +000060</head>
61
62<body id="www-imagemagick-org">
63<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +000064<div style="margin: 17px auto; float: left;">
65 <script type="text/javascript">
66 <!--
67 google_ad_client = "pub-3129977114552745";
68 google_ad_slot = "5439289906";
69 google_ad_width = 728;
70 google_ad_height = 90;
71 //-->
72 </script>
73 <script type="text/javascript"
74 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
75 </script>
76</div>
cristy3eaa0ef2010-03-06 20:35:26 +000077<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000078 <img src="../images/logo.jpg"
79 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000080 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000081<a href="../index.html">
cristyaf8d6652011-02-04 21:57:45 +000082 <img src="../images/sprite.jpg"
83 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000084 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
85</div>
86
cristyce69bb02010-07-27 19:49:46 +000087<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000088
cristy3ed852e2009-09-05 21:47:34 +000089<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000090 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000091</div>
cristy3ed852e2009-09-05 21:47:34 +000092<div class="menu">
cristybb503372010-05-27 20:51:26 +000093 <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">
cristye6e84152011-06-06 14:16:49 +0000102 <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000103</div>
104<div class="sub">
cristybb503372010-05-27 20:51:26 +0000105 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
106</div>
107<div class="sep"></div>
108<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
111<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
117<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000118 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000119</div>
120<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000121 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000122</div>
123<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000124 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000125</div>
126<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000128</div>
129<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000131</div>
132<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000133 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000134</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000135<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000136<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000137 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000138</div>
139<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000140 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000141</div>
142<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000143 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000144 </div>
145<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000146 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000147</div>
cristybb503372010-05-27 20:51:26 +0000148<div class="menu">
149 <a title="Architecture" href="../www/architecture.html">Architecture</a>
150</div>
cristy3ed852e2009-09-05 21:47:34 +0000151<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000152 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000153</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000154<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000155<div class="menu">
cristy52923442011-01-15 22:54:31 +0000156 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000157</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000158<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000159<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000160 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000161</div>
162<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000163 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000164</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000165<div class="sep"></div>
cristyeed6cb62012-01-28 19:38:34 +0000166<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000167 <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000168
cristyeed6cb62012-01-28 19:38:34 +0000169 <a href="http://www.networkredux.com"> <img src="../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
170 <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201204010120 mickey@163... -->
cristy3ed852e2009-09-05 21:47:34 +0000171<div class="sponsbox">
cristyeed6cb62012-01-28 19:38:34 +0000172<div class="sponsor">
173 <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201204010120 mickey@163... -->
cristy81492d62011-06-07 16:41:42 +0000174</div>
cristyeed6cb62012-01-28 19:38:34 +0000175<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000176 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
cristy1efc1ab2011-08-01 14:47:02 +0000177</div>
cristyeed6cb62012-01-28 19:38:34 +0000178<div class="sponsor">
179 <a rel="follow" title="Sponsor: Autos Part" href="http://www.pkwteile.de/autoteile">Autos Part</a><!-- 201203010270 info@pkwte... -->
cristy84134182011-06-15 22:59:00 +0000180</div>
cristyeed6cb62012-01-28 19:38:34 +0000181<div class="sponsor">
182 <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
cristy81492d62011-06-07 16:41:42 +0000183</div>
cristyeed6cb62012-01-28 19:38:34 +0000184<div class="sponsor">
185 <a rel="follow" title="Sponsor: Tenant Check" href="http://www.rentmethod.com/">Tenant Check</a><!-- 201203010090 chris@rentm... -->
cristyba1758d2011-06-03 01:29:12 +0000186</div>
cristyeed6cb62012-01-28 19:38:34 +0000187<div class="sponsor">
188 <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201204010090 barsh@inter... -->
cristyaf894d72011-08-06 23:03:10 +0000189</div>
cristyeed6cb62012-01-28 19:38:34 +0000190<div class="sponsor">
191 <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
192</div>
193<div class="sponsor">
194 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201301010090s jen@seo lowprofilelinks -->
195</div>
196<div class="sponsor">
197 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
198</div>
199<div class="sponsor">
200 <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
201</div>
202<div class="sponsor">
203 <a rel="follow" title="Sponsor: Stock Photography" href="http://www.fotosearch.com/">Stock Photography</a><!-- 2012040100250 ... -->
204</div>
205<div class="sponsor">
206 <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540 suvalj -->
207</div>
208<div class="sponsor">
209 <a rel="follow" title="Sponsor: Royalty Free Stock Images" href="http://www.canstockphoto.com/">Royalty Free Stock Images</a><!-- 2012050100360 support@can -->
210</div>
211<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000212 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
213</div>
cristyeed6cb62012-01-28 19:38:34 +0000214<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000215 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000216</div>
cristyeed6cb62012-01-28 19:38:34 +0000217<div class="sponsor">
218 <a rel="follow" title="Sponsor: Notebook Reparatur" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur</a><!-- 2012050100300 atlas.multimedia-->
cristy4bf6e232011-05-21 01:43:33 +0000219</div>
cristyeed6cb62012-01-28 19:38:34 +0000220<div class="sponsor">
221 <a rel="follow" title="Sponsor: Brand shopping" href="http://brandport.net">Brand shopping</a><!-- 20120201000150 gyaku@gyaku... -->
cristyec6b4752011-01-08 03:16:23 +0000222</div>
cristy3ed852e2009-09-05 21:47:34 +0000223</div>
224</div>
cristyce69bb02010-07-27 19:49:46 +0000225</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000226
cristyce69bb02010-07-27 19:49:46 +0000227<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000228 <div class="g-plusone" data-size="standard" data-count="false"></div>
cristyeed6cb62012-01-28 19:38:34 +0000229 <script type="text/javascript">
230 window.___gcfg = {
231 lang: 'en-US'
232 };
233
234 (function() {
235 var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
236 po.src = 'https://apis.google.com/js/plusone.js';
237 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
238 })();
239 </script>
cristy29c5c992011-06-25 13:58:49 +0000240</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000241
242<div class="main">
243
cristydcca3fa2010-12-29 21:50:07 +0000244<h1>ImageMagick Compare Command-line Tool</h1>
cristy3ed852e2009-09-05 21:47:34 +0000245<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
246
247<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>
248
249<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000250 <h2><a id="usage"></a>Example Usage</h2>
cristy3ed852e2009-09-05 21:47:34 +0000251</div>
252
253<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>
254
cristyeed6cb62012-01-28 19:38:34 +0000255<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert rose.jpg -sharpen 0x1 reconstruct.jpg</span><span class='crtout'></span><span class="crtprompt"> $ </span><span class='crtin'>compare rose.jpg reconstruct.jpg difference.png</span><span class='crtout'></span><span class="crtprompt"> $ </span><span class='crtin'>compare -compose src rose.jpg reconstruct.jpg difference.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +0000256<div class="image">
257<p>
258 <a href="../images/rose.jpg"><img src="../images/rose.jpg" width="70" height="46" alt="rose" /></a>
259 <a href="../images/reconstruct.jpg"><img src="../images/reconstruct.jpg" width="70" height="46" alt="rose" /></a>
260 <img style="margin:13px 0;" src="../images/right.gif" width="20" height="20" alt="==>" />
261 <a href="../images/difference.png"><img src="../images/difference.png" width="70" height="46" alt="rose" /></a>
262</p>
263</div>
264
265<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>
266
267<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>
268
cristyeed6cb62012-01-28 19:38:34 +0000269<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>compare -verbose -metric mae rose.jpg reconstruct.jpg difference.png</span><span class='crtout'>Image: rose.jpg <br/>
cristy3ed852e2009-09-05 21:47:34 +0000270 Channel distortion: MAE <br/>
271 red: 2282.91 (0.034835) <br/>
272 green: 1853.99 (0.0282901) <br/>
273 blue: 2008.67 (0.0306503) <br/>
274 all: 1536.39 (0.0234439) <br/></span></p><p>Or, if you just want the red channel distortion, use this command:</p>
275
cristyeed6cb62012-01-28 19:38:34 +0000276<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>compare -channel red -metric PSNR rose.jpg reconstruct.jpg difference.png</span><span class='crtout'>19.63</span></p>
cristy3ed852e2009-09-05 21:47:34 +0000277<p>Or, if you just want the overall image distortion, use this command:</p>
278
cristyeed6cb62012-01-28 19:38:34 +0000279<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>compare -metric PSNR rose.jpg reconstruct.jpg difference.png</span><span class='crtout'>28.31</span></p>
cristy3ed852e2009-09-05 21:47:34 +0000280<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>
281
cristyeed6cb62012-01-28 19:38:34 +0000282<p class='crt'><span class="crtprompt"> $ </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>
cristy3ed852e2009-09-05 21:47:34 +0000283<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>
284
285<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000286 <h2><a id="options"></a>Option Summary</h2>
cristy3ed852e2009-09-05 21:47:34 +0000287</div>
288
289<p>The <kbd>compare</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
290
291<table class="doc">
292 <tbody>
293 <tr>
294 <th align="left">Option</th>
295 <th align="left">Description</th>
296 </tr>
297
298 <tr>
299 <td valign="top"><a href="../www/command-line-options.html#alpha">-alpha</a></td>
300 <td valign="top">on, activate, off, deactivate, set, opaque, copy",
301transparent, extract, background, or shape the alpha channel</td>
302 </tr>
303
304 <tr>
305 <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
306 <td valign="top">decrypt image with this password</td>
307 </tr>
308
309 <tr>
310 <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
311 <td valign="top">apply option to select image channels</td>
312 </tr>
313
314 <tr>
315 <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
316 <td valign="top">set image colorspace</td>
317 </tr>
318
319 <tr>
320 <td valign="top"><a href="../www/command-line-options.html#compose">-compose <em class="option">operator</em></a></td>
321 <td valign="top">set image composite operator</td>
322 </tr>
323
324 <tr>
325 <td valign="top"><a href="../www/command-line-options.html#decipher">-decipher <em class="option">filename</em></a></td>
326 <td valign="top">convert cipher pixels to plain</td>
327 </tr>
328
329 <tr>
330 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
331 <td valign="top">display copious debugging information</td>
332 </tr>
333
334 <tr>
335 <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
336 <td valign="top">define one or more image format options</td>
337 </tr>
338
339 <tr>
340 <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
341 <td valign="top">horizontal and vertical density of the image</td>
342 </tr>
343
344 <tr>
345 <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
346 <td valign="top">image depth</td>
347 </tr>
348
349 <tr>
350 <td valign="top"><a href="../www/command-line-options.html#disimilarity-threshold">-disimilarity-threshold <em class="option">value</em></a></td>
cristy771f7a72010-11-27 21:42:59 +0000351 <td valign="top">maximum distortion for (sub)image match (default 0.2)</td>
cristy3ed852e2009-09-05 21:47:34 +0000352 </tr>
353
354 <tr>
355 <td valign="top"><a href="../www/command-line-options.html#encipher">-encipher <em class="option">filename</em></a></td>
356 <td valign="top">convert plain pixels to cipher pixels</td>
357 </tr>
358
359 <tr>
360 <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
361 <td valign="top">extract area from image</td>
362 </tr>
363
364 <tr>
365 <td valign="top"><a href="../www/command-line-options.html#fuzz">-fuzz <em class="option">distance</em></a></td>
366 <td valign="top">colors within this distance are considered equal</td>
367 </tr>
368
369 <tr>
370 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
371 <td valign="top">print program options</td>
372 </tr>
373
374 <tr>
375 <td valign="top"><a href="../www/command-line-options.html#highlight-color">-highlight-color <em class="option">color</em></a></td>
376 <td valign="top">emphasize pixel differences with this color</td>
377 </tr>
378
379 <tr>
380 <td valign="top"><a href="../www/command-line-options.html#identify">-identify</a></td>
381 <td valign="top">identify the format and characteristics of the image</td>
382 </tr>
383
384 <tr>
385 <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
386 <td valign="top">type of image interlacing scheme</td>
387 </tr>
388
389 <tr>
390 <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
391 <td valign="top">pixel cache resource limit</td>
392 </tr>
393
394 <tr>
395 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
396 <td valign="top">format of debugging information</td>
397 </tr>
398
399 <tr>
400 <td valign="top"><a href="../www/command-line-options.html#lowlight-color">-lowlight-color <em class="option">color</em></a></td>
401 <td valign="top">de-emphasize pixel differences with this color</td>
402 </tr>
403
404 <tr>
405 <td valign="top"><a href="../www/command-line-options.html#metric">-metric <em class="option">type</em></a></td>
406 <td valign="top">measure differences between images with this metric</td>
407 </tr>
408
409 <tr>
410 <td valign="top"><a href="../www/command-line-options.html#profile">-profile <em class="option">filename</em></a></td>
411 <td valign="top">add, delete, or apply an image profile</td>
412 </tr>
413
414 <tr>
415 <td valign="top"><a href="../www/command-line-options.html#quality">-quality <em class="option">value</em></a></td>
416 <td valign="top">JPEG/MIFF/PNG compression level</td>
417 </tr>
418
419 <tr>
420 <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
421 <td valign="top">reduce image colors in this colorspace</td>
422 </tr>
423
424 <tr>
425 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
426 <td valign="top">suppress all warning messages</td>
427 </tr>
428
429 <tr>
430 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
431 <td valign="top">pay attention to warning messages.</td>
432 </tr>
433
434 <tr>
435 <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
436 <td valign="top">settings remain in effect until parenthesis boundary.</td>
437 </tr>
438
439 <tr>
440 <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
441 <td valign="top">horizontal and vertical sampling factor</td>
442 </tr>
443
444 <tr>
445 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
446 <td valign="top">seed a new sequence of pseudo-random numbers</td>
447 </tr>
448
449 <tr>
450 <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
451 <td valign="top">set an image attribute</td>
452 </tr>
453
454 <tr>
455 <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
456 <td valign="top">width and height of image</td>
457 </tr>
458
459 <tr>
cristy771f7a72010-11-27 21:42:59 +0000460 <td valign="top"><a href="../www/command-line-options.html#subimage-search">-subimage-search</a></td>
cristyae6203d2010-08-09 01:12:14 +0000461 <td valign="top">search for subimage</td>
462 </tr>
463
464 <tr>
cristy5063d812010-10-19 16:28:10 +0000465 <td valign="top"><a href="../www/command-line-options.html#synchronize">-synchronize</a></td>
466 <td valign="top">synchronize image to storage device</td>
467 </tr>
468
469 <tr>
470 <td valign="top"><a href="../www/command-line-options.html#taint">-taint</a></td>
471 <td valign="top">mark the image as modified</td>
472 </tr>
473
474 <tr>
cristy3ed852e2009-09-05 21:47:34 +0000475 <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
476 <td valign="top">transparent color</td>
477 </tr>
478
479 <tr>
480 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
481 <td valign="top">print detailed information about the image</td>
482 </tr>
483
484 <tr>
485 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
486 <td valign="top">print version information</td>
487 </tr>
488
489 <tr>
490 <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
491 <td valign="top">access method for pixels outside the boundaries of the image</td>
492 </tr>
493
494 </tbody>
495</table>
cristy3eaa0ef2010-03-06 20:35:26 +0000496
497</div>
498
499<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000500 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000501 <span id="linkbar-center">
502 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000503 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000504 </span>
505 <span id="linkbar-east">&nbsp;</span>
506 </div>
507 <div class="footer">
cristyeed6cb62012-01-28 19:38:34 +0000508 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000509 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
510 </div>
511 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000512 <script type="text/javascript">
513 var _gaq = _gaq || [];
514 _gaq.push(['_setAccount', 'UA-17690367-1']);
515 _gaq.push(['_trackPageview']);
516
517 (function() {
518 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
519 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
520 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
521 })();
522 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000523</body>
524</html>