Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 94509a29327f818953de3dc4f0ae4e70ffd1250e / . / www / compare.html
blob: 6d404fa42e59c9e3fde873d65748a047ece3217e [file] [log] [blame]
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<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">
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]9<head>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]10 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
11 <meta name=viewport content="width=device-width, initial-scale=0.3333334">
12 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]13 <title>ImageMagick: Command-line Tools: Compare</title>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]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="application-name" content="ImageMagick"/>
18 <meta name="description" content="A collection of tools and libraries to read, write, and manipulate an image in any of the more popular image formats."/>
19 <meta name="application-url" content="http://www.imagemagick.org"/>
20 <meta name="generator" content="PHP"/>
21 <meta name="keywords" content="command-line, tools:, compare, convert, edit, compose, image, pixel"/>
22 <meta name="rating" content="GENERAL"/>
23 <meta name="robots" content="INDEX, FOLLOW"/>
24 <meta name="generator" content="ImageMagick Studio LLC"/>
25 <meta name="author" content="ImageMagick Studio LLC"/>
26 <meta name="revisit-after" content="2 DAYS"/>
27 <meta name="resource-type" content="document"/>
28 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
29 <meta name="distribution" content="Global"/>
30 <link rel="icon" href="../images/wand.png"/>
31 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
32 <link rel="canonical" href="http://www.imagemagick.org" />
33 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]34
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]35 <!-- Add jQuery library -->
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]36 <script type="text/javascript" src="http://localhost/ajax/libs/jquery/2.1.0/jquery.min.js"></script>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]37
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]38 <!-- Add mousewheel plugin (this is optional) -->
39 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]40
41 <!-- Add fancyBox -->
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]42 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.1.5" type="text/css" media="screen" />
43 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.1.5"></script>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]44
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]45 <!-- Optionally add helpers - button, thumbnail and/or media -->
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]46 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.5" type="text/css" media="screen" />
47 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.5"></script>
48 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.6"></script>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]49
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]50 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=1.0.7" type="text/css" media="screen" />
51 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=1.0.7"></script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]52
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]53 <script type="text/javascript">
54 $(document).ready(function() {
55 $(".fancybox").fancybox();
56 });
57 </script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]58
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]59 <!-- ImageMagick style -->
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]60 <style type="text/css" media="all">
61 @import url("../www/magick.css");
62 </style>
63</head>
64
65<body id="www-imagemagick-org">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]66
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]67<script type="text/javascript">
68 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
69 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
70 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
71 })(window,document,'offline-script','//www.google-analytics.com/analytics.js','ga');
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]72
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]73 ga('create', 'UA-40133312-1', 'imagemagick.org');
74 ga('send', 'pageview');
75</script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]76
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]77<div class="titlebar">
78<div style="margin: 17px auto; float: left;">
79 <script type="text/javascript">
80 <!--
81 google_ad_client = "pub-3129977114552745";
82 google_ad_slot = "5439289906";
83 google_ad_width = 728;
84 google_ad_height = 90;
85 //-->
86 </script>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]87 <script type="text/javascript"
88 src="http://localhost/pagead/show_ads.js">
89 </script>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]90</div>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]91<a href="../discourse-server">
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]92 <img src="../images/logo.jpg"
93 alt="ImageMagick Logo" width="123" height="118"
94 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]95<a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]96 <img src="../images/sprite.jpg"
97 alt="ImageMagick Sprite" width="114" height="118"
98 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]99</div>
100
101<div class="westbar">
102
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103<div class="menu">
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]104 <a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]105</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]107 <a title="Binary Releases" href="binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]108</div>
109<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]110 <a title="Binary Release: Unix" href="binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]111</div>
112<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]113 <a title="Binary Release: MacOS X" href="binary-releases.html#macosx">Mac OS X</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]114</div>
115<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]116 <a title="Binary Release: iOS" href="binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]117</div>
118<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]119 <a title="Binary Release: Windows" href="binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]120</div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]121<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]122<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]123 <a title="Command-line Tools" href="command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
125<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]126 <a title="Command-line Tools: Processing" href="command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
128<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]129 <a title="Command-line Tools: Options" href="command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
131<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]132 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133</div>
134<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]135 <a title="Program Interfaces" href="api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
137<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]138 <a title="Program Interface: MagickWand" href="magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139</div>
140<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]141 <a title="Program Interface: MagickCore" href="magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142</div>
143<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]144 <a title="Program Interface: PerlMagick" href="perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145</div>
146<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]147 <a title="Program Interface: Magick++" href="magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148</div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]149<div class="sep"></div>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]150<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]151 <a title="Install from Source" href="install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152</div>
153<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]154 <a title="Install from Source: Unix" href="install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155</div>
156<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]157 <a title="Install from Source: Windows" href="install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158 </div>
159<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]160 <a title="Resources" href="resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]162<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]163 <a title="Architecture" href="architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]164</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]165<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]166 <a title="Download" href="download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]167</div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]168<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]169<div class="menu">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]170 <a title="Search" href="search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]171</div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]172<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]173<div class="menu">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]174 <a title="Site Map" href="sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]175</div>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]176<div class="sub">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]177 <a title="Site Map: Links" href="links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]178</div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]179<div class="sep"></div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]180</div>
181
182<div class="eastbar">
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]183 <script type="text/javascript">
184 /* <![CDATA[ */
185 window.___gcfg = {
186 lang: 'en-US'
187 };
188
189 (function() {
190 var po = document.createElement('offline-script');
191 po.type = 'text/javascript';
192 po.async = true;
193 po.src = 'https://apis.google.com/js/plusone.js';
194 var script = document.getElementsByTagName('offline-script')[0];
195 script.parentNode.insertBefore(po, script);
196 })();
197 var gplusone = document.getElementById("gplusone");
198 gplusone.setAttribute("data-size","medium");
199 gplusone.setAttribute("data-count","true");
200 /* ]]> */
201 </script>
202 <script type="text/javascript">
203 /* <![CDATA[ */
204 (function() {
205 var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
206 po.type = 'text/javascript';
207 po.async = true;
208 po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
209 var script = document.getElementsByTagName('offline-script')[0];
210 script.parentNode.insertBefore(po, script);
211 })();
212 /* ]]> */
213 </script>
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]214 <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a></div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]215 <noscript>
216 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]217 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]218 </noscript>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]219 <div class="g-plusone" data-size="standard" data-count="true"></div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]220</div>
221
222<div class="main">
223
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]224<h1>ImageMagick Compare Command-line Tool</h1>
cristy417eeb12013-07-28 18:48:22 +0000[diff] [blame]225<p class="navigation-index">[<a href="compare.html#usage">Example Usage</a> • <a href="compare.html#options">Option Summary</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]226
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]227<div class="doc-section">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]228<p>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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]229</div>
230
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]231<h2><a id="usage"></a>Example Usage</h2>
232<div class="doc-section">
233
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]234<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 +0000[diff] [blame]235
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]236<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]237<div class="image">
238<p>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]239 <a href="../images/rose.jpg"><img src="../images/rose.jpg" width="70" height="46" alt="rose" /></a>
240 <a href="../images/reconstruct.jpg"><img src="../images/reconstruct.jpg" width="70" height="46" alt="rose" /></a>
241 <img style="margin:13px 0;" src="../images/right.gif" width="20" height="20" alt="==>" />
242 <a href="../images/difference.png"><img src="../images/difference.png" width="70" height="46" alt="rose" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]243</p>
244</div>
245
246<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>
247
248<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>
249
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]250<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/>
251 Channel distortion: MAE <br/>
252 red: 2282.91 (0.034835) <br/>
253 green: 1853.99 (0.0282901) <br/>
254 blue: 2008.67 (0.0306503) <br/>
255 all: 1536.39 (0.0234439) <br/></span></p><p>Or, if you just want the red channel distortion, use this command:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]256
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]257<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]258<p>Or, if you just want the overall image distortion, use this command:</p>
259
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]260<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]261<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>
262
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]263<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>
264<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="http://www.imagemagick.org/Usage/">Examples of ImageMagick Usage</a>.</p>
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]265
266<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 +0000[diff] [blame]267</div>
268
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]269<h2><a id="options"></a>Option Summary</h2>
270<div class="doc-section">
271
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]272<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 +0000[diff] [blame]273
274<table class="doc">
275 <tbody>
276 <tr>
277 <th align="left">Option</th>
278 <th align="left">Description</th>
279 </tr>
280
281 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]282 <td valign="top"><a href="command-line-options.html#alpha">-alpha</a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]283 <td valign="top">on, activate, off, deactivate, set, opaque, copy",
284transparent, extract, background, or shape the alpha channel</td>
285 </tr>
286
287 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]288 <td valign="top"><a href="command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]289 <td valign="top">decrypt image with this password</td>
290 </tr>
291
292 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]293 <td valign="top"><a href="command-line-options.html#channel">-channel <em class="option">type</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]294 <td valign="top">apply option to select image channels</td>
295 </tr>
296
297 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]298 <td valign="top"><a href="command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]299 <td valign="top">set image colorspace</td>
300 </tr>
301
302 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]303 <td valign="top"><a href="command-line-options.html#compose">-compose <em class="option">operator</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]304 <td valign="top">set image composite operator</td>
305 </tr>
306
307 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]308 <td valign="top"><a href="command-line-options.html#decipher">-decipher <em class="option">filename</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]309 <td valign="top">convert cipher pixels to plain</td>
310 </tr>
311
312 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]313 <td valign="top"><a href="command-line-options.html#debug">-debug <em class="option">events</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]314 <td valign="top">display copious debugging information</td>
315 </tr>
316
317 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]318 <td valign="top"><a href="command-line-options.html#define">-define <em class="option">format:option</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]319 <td valign="top">define one or more image format options</td>
320 </tr>
321
322 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]323 <td valign="top"><a href="command-line-options.html#density">-density <em class="option">geometry</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]324 <td valign="top">horizontal and vertical density of the image</td>
325 </tr>
326
327 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]328 <td valign="top"><a href="command-line-options.html#depth">-depth <em class="option">value</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]329 <td valign="top">image depth</td>
330 </tr>
331
332 <tr>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]333 <td valign="top"><a href="command-line-options.html#dissimilarity-threshold">-dissimilarity-threshold <em class="option">value</em></a></td>
cristy771f7a72010-11-27 21:42:59 +0000[diff] [blame]334 <td valign="top">maximum distortion for (sub)image match (default 0.2)</td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]335 </tr>
336
337 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]338 <td valign="top"><a href="command-line-options.html#encipher">-encipher <em class="option">filename</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]339 <td valign="top">convert plain pixels to cipher pixels</td>
340 </tr>
341
342 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]343 <td valign="top"><a href="command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]344 <td valign="top">extract area from image</td>
345 </tr>
346
347 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]348 <td valign="top"><a href="command-line-options.html#fuzz">-fuzz <em class="option">distance</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]349 <td valign="top">colors within this distance are considered equal</td>
350 </tr>
351
352 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]353 <td valign="top"><a href="command-line-options.html#help">-help</a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]354 <td valign="top">print program options</td>
355 </tr>
356
357 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]358 <td valign="top"><a href="command-line-options.html#highlight-color">-highlight-color <em class="option">color</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]359 <td valign="top">emphasize pixel differences with this color</td>
360 </tr>
361
362 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]363 <td valign="top"><a href="command-line-options.html#identify">-identify</a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]364 <td valign="top">identify the format and characteristics of the image</td>
365 </tr>
366
367 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]368 <td valign="top"><a href="command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]369 <td valign="top">type of image interlacing scheme</td>
370 </tr>
371
372 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]373 <td valign="top"><a href="command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]374 <td valign="top">pixel cache resource limit</td>
375 </tr>
376
377 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]378 <td valign="top"><a href="command-line-options.html#log">-log <em class="option">format</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]379 <td valign="top">format of debugging information</td>
380 </tr>
381
382 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]383 <td valign="top"><a href="command-line-options.html#lowlight-color">-lowlight-color <em class="option">color</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]384 <td valign="top">de-emphasize pixel differences with this color</td>
385 </tr>
386
387 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]388 <td valign="top"><a href="command-line-options.html#metric">-metric <em class="option">type</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]389 <td valign="top">measure differences between images with this metric</td>
390 </tr>
391
392 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]393 <td valign="top"><a href="command-line-options.html#profile">-profile <em class="option">filename</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]394 <td valign="top">add, delete, or apply an image profile</td>
395 </tr>
396
397 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]398 <td valign="top"><a href="command-line-options.html#quality">-quality <em class="option">value</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]399 <td valign="top">JPEG/MIFF/PNG compression level</td>
400 </tr>
401
402 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]403 <td valign="top"><a href="command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]404 <td valign="top">reduce image colors in this colorspace</td>
405 </tr>
406
407 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]408 <td valign="top"><a href="command-line-options.html#quiet">-quiet</a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]409 <td valign="top">suppress all warning messages</td>
410 </tr>
411
412 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]413 <td valign="top"><a href="command-line-options.html#regard-warnings">-regard-warnings</a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]414 <td valign="top">pay attention to warning messages.</td>
415 </tr>
416
417 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]418 <td valign="top"><a href="command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]419 <td valign="top">settings remain in effect until parenthesis boundary.</td>
420 </tr>
421
422 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]423 <td valign="top"><a href="command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]424 <td valign="top">horizontal and vertical sampling factor</td>
425 </tr>
426
427 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]428 <td valign="top"><a href="command-line-options.html#seed">-seed <em class="option">value</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]429 <td valign="top">seed a new sequence of pseudo-random numbers</td>
430 </tr>
431
432 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]433 <td valign="top"><a href="command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]434 <td valign="top">set an image attribute</td>
435 </tr>
436
437 <tr>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]438 <td valign="top"><a href="command-line-options.html#similarity-threshold">-similarity-threshold <em class="option">value</em></a></td>
439 <td valign="top">minimum distortion for (sub)image match (default 0.0)</td>
440 </tr>
441
442 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]443 <td valign="top"><a href="command-line-options.html#size">-size <em class="option">geometry</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]444 <td valign="top">width and height of image</td>
445 </tr>
446
447 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]448 <td valign="top"><a href="command-line-options.html#subimage-search">-subimage-search</a></td>
cristyae6203d2010-08-09 01:12:14 +0000[diff] [blame]449 <td valign="top">search for subimage</td>
450 </tr>
451
452 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]453 <td valign="top"><a href="command-line-options.html#synchronize">-synchronize</a></td>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]454 <td valign="top">synchronize image to storage device</td>
455 </tr>
456
457 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]458 <td valign="top"><a href="command-line-options.html#taint">-taint</a></td>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]459 <td valign="top">mark the image as modified</td>
460 </tr>
461
462 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]463 <td valign="top"><a href="command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]464 <td valign="top">transparent color</td>
465 </tr>
466
467 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]468 <td valign="top"><a href="command-line-options.html#verbose">-verbose</a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]469 <td valign="top">print detailed information about the image</td>
470 </tr>
471
472 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]473 <td valign="top"><a href="command-line-options.html#version">-version</a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]474 <td valign="top">print version information</td>
475 </tr>
476
477 <tr>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]478 <td valign="top"><a href="command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]479 <td valign="top">access method for pixels outside the boundaries of the image</td>
480 </tr>
481
482 </tbody>
483</table>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]484</div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]485
486</div>
487
488<div id="linkbar">
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]489 <span id="linkbar-west"> </span>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]490
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]491 <span id="linkbar-center">
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]492 <a href="../discourse-server">Discourse Server</a> •
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]493 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
cristy417eeb12013-07-28 18:48:22 +0000[diff] [blame]494 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> •
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]495 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]496 </span>
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]497 <span id="linkbar-east"> </span>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]498</div>
499<div class="footer">
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]500 <span id="footer-west">© 1999-2014 ImageMagick Studio LLC</span>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]501 <span id="footer-east"> <a href="contact.html">Contact the Wizards</a></span>
502</div>
503<div style="clear: both; margin: 0; width: 100%; "></div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]504</body>
505</html>