blob: 8f41a82d0a9f166d22b18089c576bddf3a427ea7 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001
2
3
4
cristydcca3fa2010-12-29 21:50:07 +00005<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
6 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
cristy2bd2a982011-02-15 00:52:58 +00007<html version="-//W3C//DTD XHTML 1.1//EN"
8 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
9 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
10 xsi:schemaLocation="http://www.w3.org/1999/xhtml
11 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +000012<head>
cristy3c98a4f2010-08-13 20:09:41 +000013 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
cristy1efc1ab2011-08-01 14:47:02 +000014 <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
cristydcca3fa2010-12-29 21:50:07 +000015 <title>ImageMagick: Command-line Options</title>
cristy3ed852e2009-09-05 21:47:34 +000016 <meta http-equiv="Content-Language" content="en-US"/>
17 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
18 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000019 <meta name="Application-name" content="ImageMagick"/>
cristye6e84152011-06-06 14:16:49 +000020 <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 +000021 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000022 <meta name="Generator" content="PHP"/>
cristyeed6cb62012-01-28 19:38:34 +000023 <meta name="Keywords" content="command-line, options, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
cristy3ed852e2009-09-05 21:47:34 +000024 <meta name="Rating" content="GENERAL"/>
25 <meta name="Robots" content="INDEX, FOLLOW"/>
26 <meta name="Generator" content="ImageMagick Studio LLC"/>
27 <meta name="Author" content="ImageMagick Studio LLC"/>
28 <meta name="Revisit-after" content="2 DAYS"/>
29 <meta name="Resource-type" content="document"/>
cristy1454be72011-12-19 01:52:48 +000030 <meta name="Copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000031 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000032 <link rel="icon" href="../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000033 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
cristy29c5c992011-06-25 13:58:49 +000034 <link rel="canonical" href="http://www.imagemagick.org" />
cristy3c98a4f2010-08-13 20:09:41 +000035 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristyeed6cb62012-01-28 19:38:34 +000036 <!-- Add jQuery library -->
37 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
38
39 <!-- Optionaly include easing and/or mousewheel plugins -->
40 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
41 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
42
43 <!-- Add fancyBox -->
44 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.3" type="text/css" media="screen" />
45 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.3"></script>
46
47 <!-- Optionaly include button and/or thumbnail helpers -->
48 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.3" type="text/css" media="screen" />
49 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.3"></script>
50
51 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.3" type="text/css" media="screen" />
52 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.3"></script>
53 <script type="text/javascript">
54 $(document).ready(function() {
55 $(".fancybox").fancybox();
56 });
57 </script>
58 <!-- ImageMagick style -->
cristy7a40ba82011-01-08 20:31:18 +000059 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000060 <style type="text/css" media="all">
61 @import url("../www/magick.css");
62 </style>
cristy3eaa0ef2010-03-06 20:35:26 +000063</head>
64
65<body id="www-imagemagick-org">
66<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +000067<div style="margin: 17px auto; float: left;">
68 <script type="text/javascript">
69 <!--
70 google_ad_client = "pub-3129977114552745";
71 google_ad_slot = "5439289906";
72 google_ad_width = 728;
73 google_ad_height = 90;
74 //-->
75 </script>
76 <script type="text/javascript"
77 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
78 </script>
79</div>
cristy3eaa0ef2010-03-06 20:35:26 +000080<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000081 <img src="../images/logo.jpg"
82 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000083 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000084<a href="../index.html">
cristyaf8d6652011-02-04 21:57:45 +000085 <img src="../images/sprite.jpg"
86 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000087 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
88</div>
89
cristyce69bb02010-07-27 19:49:46 +000090<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000091
cristy3ed852e2009-09-05 21:47:34 +000092<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
cristy3ed852e2009-09-05 21:47:34 +000095<div class="menu">
cristybb503372010-05-27 20:51:26 +000096 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
97</div>
98<div class="sub">
99 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
100</div>
101<div class="sub">
102 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
103</div>
104<div class="sub">
cristye6e84152011-06-06 14:16:49 +0000105 <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000106</div>
107<div class="sub">
cristybb503372010-05-27 20:51:26 +0000108 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
109</div>
110<div class="sep"></div>
111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</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: Processing" href="../www/command-line-processing.html">Processing</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: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000119</div>
120<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000121 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000122</div>
123<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000124 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000125</div>
126<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000128</div>
129<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000131</div>
132<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000133 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000134</div>
135<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000136 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000140 <a title="Install from Source" href="../www/install-source.html">Install from Source</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: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000144</div>
145<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000146 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000147 </div>
148<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000149 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000150</div>
cristybb503372010-05-27 20:51:26 +0000151<div class="menu">
152 <a title="Architecture" href="../www/architecture.html">Architecture</a>
153</div>
cristy3ed852e2009-09-05 21:47:34 +0000154<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000155 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000156</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000157<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000158<div class="menu">
cristy52923442011-01-15 22:54:31 +0000159 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000160</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000161<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000162<div class="menu">
cristydcca3fa2010-12-29 21:50:07 +0000163 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000164</div>
165<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000166 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000167</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000168<div class="sep"></div>
cristyeed6cb62012-01-28 19:38:34 +0000169<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000170 <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000171
cristyeed6cb62012-01-28 19:38:34 +0000172 <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>
173 <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 +0000174<div class="sponsbox">
cristyeed6cb62012-01-28 19:38:34 +0000175<div class="sponsor">
176 <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 +0000177</div>
cristyeed6cb62012-01-28 19:38:34 +0000178<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000179 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
cristy1efc1ab2011-08-01 14:47:02 +0000180</div>
cristyeed6cb62012-01-28 19:38:34 +0000181<div class="sponsor">
182 <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 +0000183</div>
cristyeed6cb62012-01-28 19:38:34 +0000184<div class="sponsor">
185 <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 +0000186</div>
cristyeed6cb62012-01-28 19:38:34 +0000187<div class="sponsor">
188 <a rel="follow" title="Sponsor: Tenant Check" href="http://www.rentmethod.com/">Tenant Check</a><!-- 201203010090 chris@rentm... -->
cristyba1758d2011-06-03 01:29:12 +0000189</div>
cristyeed6cb62012-01-28 19:38:34 +0000190<div class="sponsor">
191 <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201204010090 barsh@inter... -->
cristyaf894d72011-08-06 23:03:10 +0000192</div>
cristyeed6cb62012-01-28 19:38:34 +0000193<div class="sponsor">
194 <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
195</div>
196<div class="sponsor">
197 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201301010090s jen@seo lowprofilelinks -->
198</div>
199<div class="sponsor">
200 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
201</div>
202<div class="sponsor">
203 <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
204</div>
205<div class="sponsor">
206 <a rel="follow" title="Sponsor: Stock Photography" href="http://www.fotosearch.com/">Stock Photography</a><!-- 2012040100250 ... -->
207</div>
208<div class="sponsor">
209 <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540 suvalj -->
210</div>
211<div class="sponsor">
212 <a rel="follow" title="Sponsor: Royalty Free Stock Images" href="http://www.canstockphoto.com/">Royalty Free Stock Images</a><!-- 2012050100360 support@can -->
213</div>
214<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000215 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
216</div>
cristyeed6cb62012-01-28 19:38:34 +0000217<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000218 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000219</div>
cristyeed6cb62012-01-28 19:38:34 +0000220<div class="sponsor">
221 <a rel="follow" title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristy4bf6e232011-05-21 01:43:33 +0000222</div>
cristyeed6cb62012-01-28 19:38:34 +0000223<div class="sponsor">
224 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://www.webhostingclue.com">Best Web Hosting</a><!-- 2012030100300 accounting@webhostingclue -->
cristyec6b4752011-01-08 03:16:23 +0000225</div>
cristy3ed852e2009-09-05 21:47:34 +0000226</div>
227</div>
cristyce69bb02010-07-27 19:49:46 +0000228</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000229
cristyce69bb02010-07-27 19:49:46 +0000230<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000231 <div class="g-plusone" data-size="standard" data-count="false"></div>
cristyeed6cb62012-01-28 19:38:34 +0000232 <script type="text/javascript">
233 window.___gcfg = {
234 lang: 'en-US'
235 };
236
237 (function() {
238 var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
239 po.src = 'https://apis.google.com/js/plusone.js';
240 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
241 })();
242 </script>
cristy29c5c992011-06-25 13:58:49 +0000243</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000244
245<div class="main">
246
cristydcca3fa2010-12-29 21:50:07 +0000247<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000248<p class="navigation-index">
cristy8b9dd952011-03-21 22:56:18 +0000249[ <a href="../www/command-line-options.html#adaptive-blur">&#x2011;adaptive&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adaptive-resize">&#x2011;adaptive&#x2011;resize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adaptive-sharpen">&#x2011;adaptive&#x2011;sharpen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adjoin">&#x2011;adjoin</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#affine">&#x2011;affine</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#alpha">&#x2011;alpha</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#annotate">&#x2011;annotate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#antialias">&#x2011;antialias</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#append">&#x2011;append</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#attenuate">&#x2011;attenuate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#authenticate">&#x2011;authenticate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-gamma">&#x2011;auto&#x2011;gamma</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-level">&#x2011;auto&#x2011;level</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-orient">&#x2011;auto&#x2011;orient</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#backdrop">&#x2011;backdrop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#background">&#x2011;background</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bench">&#x2011;bench</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bias">&#x2011;bias</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#black-point-compensation">&#x2011;black&#x2011;point&#x2011;compensation</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#black-threshold">&#x2011;black&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blend">&#x2011;blend</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blue-primary">&#x2011;blue&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blue-shift">&#x2011;blue&#x2011;shift</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blur">&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#border">&#x2011;border</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bordercolor">&#x2011;bordercolor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#borderwidth">&#x2011;borderwidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#brightness-contrast">&#x2011;brightness&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cache">&#x2011;cache</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#caption">&#x2011;caption</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cdl">&#x2011;cdl</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#channel">&#x2011;channel</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#charcoal">&#x2011;charcoal</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#chop">&#x2011;chop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clamp">&#x2011;clamp</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip">&#x2011;clip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip-mask">&#x2011;clip&#x2011;mask</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip-path">&#x2011;clip&#x2011;path</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clone">&#x2011;clone</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clut">&#x2011;clut</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#coalesce">&#x2011;coalesce</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colorize">&#x2011;colorize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colormap">&#x2011;colormap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#color-matrix">&#x2011;color&#x2011;matrix</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colors">&#x2011;colors</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colorspace">&#x2011;colorspace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#combine">&#x2011;combine</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#comment">&#x2011;comment</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#compose">&#x2011;compose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#composite">&#x2011;composite</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#compress">&#x2011;compress</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#contrast">&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#contrast-stretch">&#x2011;contrast&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#convolve">&#x2011;convolve</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#crop">&#x2011;crop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cycle">&#x2011;cycle</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#debug">&#x2011;debug</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#decipher">&#x2011;decipher</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#deconstruct">&#x2011;deconstruct</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#define">&#x2011;define</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#delay">&#x2011;delay</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#delete">&#x2011;delete</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#density">&#x2011;density</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#depth">&#x2011;depth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#descend">&#x2011;descend</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#deskew">&#x2011;deskew</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#despeckle">&#x2011;despeckle</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#direction">&#x2011;direction</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#displace">&#x2011;displace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#display">&#x2011;display</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dispose">&#x2011;dispose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dissimilarity-threshold">&#x2011;dissimilarity&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dissolve">&#x2011;dissolve</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#distort">&#x2011;distort</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dither">&#x2011;dither</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#draw">&#x2011;draw</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#duplicate">&#x2011;duplicate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#edge">&#x2011;edge</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#emboss">&#x2011;emboss</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#encipher">&#x2011;encipher</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#encoding">&#x2011;encoding</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#endian">&#x2011;endian</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#enhance">&#x2011;enhance</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#equalize">&#x2011;equalize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#evaluate">&#x2011;evaluate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#evaluate-sequence">&#x2011;evaluate&#x2011;sequence</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#extent">&#x2011;extent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#extract">&#x2011;extract</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#family">&#x2011;family</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#features">&#x2011;features</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fft">&#x2011;fft</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fill">&#x2011;fill</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#filter">&#x2011;filter</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flatten">&#x2011;flatten</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flip">&#x2011;flip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#floodfill">&#x2011;floodfill</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flop">&#x2011;flop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#font">&#x2011;font</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#foreground">&#x2011;foreground</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#format">&#x2011;format</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#format_identify_">&#x2011;format[identify]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#frame">&#x2011;frame</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#frame_import_">&#x2011;frame[import]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#function">&#x2011;function</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fuzz">&#x2011;fuzz</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fx">&#x2011;fx</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gamma">&#x2011;gamma</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gaussian-blur">&#x2011;gaussian&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#geometry">&#x2011;geometry</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gravity">&#x2011;gravity</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#green-primary">&#x2011;green&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#hald-clut">&#x2011;hald&#x2011;clut</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#help">&#x2011;help</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#highlight-color">&#x2011;highlight&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#iconGeometry">&#x2011;iconGeometry</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#iconic">&#x2011;iconic</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#identify">&#x2011;identify</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ift">&#x2011;ift</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#immutable">&#x2011;immutable</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#implode">&#x2011;implode</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#insert">&#x2011;insert</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#intent">&#x2011;intent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interlace">&#x2011;interlace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interpolate">&#x2011;interpolate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interline-spacing">&#x2011;interline&#x2011;spacing</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interword-spacing">&#x2011;interword&#x2011;spacing</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#kerning">&#x2011;kerning</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#label">&#x2011;label</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#lat">&#x2011;lat</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#layers">&#x2011;layers</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#level">&#x2011;level</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#level-colors">&#x2011;level&#x2011;colors</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#limit">&#x2011;limit</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#linear-stretch">&#x2011;linear&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#linewidth">&#x2011;linewidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#liquid-rescale">&#x2011;liquid&#x2011;rescale</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#list">&#x2011;list</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#log">&#x2011;log</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#loop">&#x2011;loop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#lowlight-color">&#x2011;lowlight&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#magnify">&#x2011;magnify</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#map">&#x2011;map</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#map_stream_">&#x2011;map[stream]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mask">&#x2011;mask</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mattecolor">&#x2011;mattecolor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#median">&#x2011;median</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#metric">&#x2011;metric</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mode">&#x2011;mode</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#modulate">&#x2011;modulate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#monitor">&#x2011;monitor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#monochrome">&#x2011;monochrome</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#morph">&#x2011;morph</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#morphology">&#x2011;morphology</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mosaic">&#x2011;mosaic</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#motion-blur">&#x2011;motion&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#name">&#x2011;name</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#negate">&#x2011;negate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#noise">&#x2011;noise</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#normalize">&#x2011;normalize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#opaque">&#x2011;opaque</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ordered-dither">&#x2011;ordered&#x2011;dither</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#orient">&#x2011;orient</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#page">&#x2011;page</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#paint">&#x2011;paint</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#path">&#x2011;path</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pause_animate_">&#x2011;pause[animate]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pause_import_">&#x2011;pause[import]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pen">&#x2011;pen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ping">&#x2011;ping</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pointsize">&#x2011;pointsize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#polaroid">&#x2011;polaroid</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#posterize">&#x2011;posterize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#precision">&#x2011;precision</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#preview">&#x2011;preview</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#print">&#x2011;print</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#process">&#x2011;process</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#profile">&#x2011;profile</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quality">&#x2011;quality</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quantize">&#x2011;quantize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quiet">&#x2011;quiet</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#radial-blur">&#x2011;radial&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#raise">&#x2011;raise</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#random-threshold">&#x2011;random&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#red-primary">&#x2011;red&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#regard-warnings">&#x2011;regard&#x2011;warnings</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#region">&#x2011;region</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#remap">&#x2011;remap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#remote">&#x2011;remote</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#render">&#x2011;render</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#repage">&#x2011;repage</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#resample">&#x2011;resample</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#resize">&#x2011;resize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#respect-parentheses">&#x2011;respect&#x2011;parentheses</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#reverse">&#x2011;reverse</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#roll">&#x2011;roll</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#rotate">&#x2011;rotate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sample">&#x2011;sample</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sampling-factor">&#x2011;sampling&#x2011;factor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#scale">&#x2011;scale</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#scene">&#x2011;scene</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#screen">&#x2011;screen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#seed">&#x2011;seed</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#segment">&#x2011;segment</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#selective-blur">&#x2011;selective&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#separate">&#x2011;separate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sepia-tone">&#x2011;sepia&#x2011;tone</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#set">&#x2011;set</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shade">&#x2011;shade</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shadow">&#x2011;shadow</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shared-memory">&#x2011;shared&#x2011;memory</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sharpen">&#x2011;sharpen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shave">&#x2011;shave</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shear">&#x2011;shear</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sigmoidal-contrast">&#x2011;sigmoidal&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#silent">&#x2011;silent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#size">&#x2011;size</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sketch">&#x2011;sketch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#smush">&#x2011;smush</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#snaps">&#x2011;snaps</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#solarize">&#x2011;solarize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sparse-color">&#x2011;sparse&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#splice">&#x2011;splice</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#spread">&#x2011;spread</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#statistic">&#x2011;statistic</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stegano">&#x2011;stegano</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stereo">&#x2011;stereo</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stretch">&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#strip">&#x2011;strip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stroke">&#x2011;stroke</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#strokewidth">&#x2011;strokewidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#style">&#x2011;style</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#subimage-search">&#x2011;subimage&#x2011;search</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#swap">&#x2011;swap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#swirl">&#x2011;swirl</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#synchronize">&#x2011;synchronize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#taint">&#x2011;taint</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#text-font">&#x2011;text&#x2011;font</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#texture">&#x2011;texture</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#threshold">&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#thumbnail">&#x2011;thumbnail</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#tile">&#x2011;tile</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#tile-offset">&#x2011;tile&#x2011;offset</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#tint">&#x2011;tint</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#title">&#x2011;title</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transform">&#x2011;transform</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transparent">&#x2011;transparent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transparent-color">&#x2011;transparent&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transpose">&#x2011;transpose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transverse">&#x2011;transverse</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#treedepth">&#x2011;treedepth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#trim">&#x2011;trim</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#type">&#x2011;type</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#undercolor">&#x2011;undercolor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#unique-colors">&#x2011;unique&#x2011;colors</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#units">&#x2011;units</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#unsharp">&#x2011;unsharp</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#update">&#x2011;update</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#verbose">&#x2011;verbose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#version">&#x2011;version</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#view">&#x2011;view</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#vignette">&#x2011;vignette</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#virtual-pixel">&#x2011;virtual&#x2011;pixel</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#visual">&#x2011;visual</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#watermark">&#x2011;watermark</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#wave">&#x2011;wave</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#weight">&#x2011;weight</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#white-point">&#x2011;white&#x2011;point</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#white-threshold">&#x2011;white&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#window">&#x2011;window</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#window-group">&#x2011;window&#x2011;group</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#write">&#x2011;write</a> ] </p>
cristy3ed852e2009-09-05 21:47:34 +0000250
cristydcca3fa2010-12-29 21:50:07 +0000251<div class="doc-section">
252
cristyb36feb22010-03-26 16:54:37 +0000253<p>Below is list of command-line options recognized by the ImageMagick <a
254href="../www/command-line-tools.html">command-line
255tools</a>. If you want a description of a particular option, click on the
256option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000257otherwise noted, each option is recognized by the commands <a href="../www/convert.html">convert</a>, <a href="../www/mogrify.html">mogrify</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000258
259<div style="margin: auto;">
cristyeed6cb62012-01-28 19:38:34 +0000260 <h4><a id="adaptive-blur"></a>-adaptive-blur <em class="arg">radius</em>[x<em class="arg">sigma</em>+<em class="arg">bias</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000261</div>
262
263<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Adaptively blur pixels, with decreasing effect near edges.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +0000264<p>A Gaussian operator of the given radius and standard deviation (<em class="arg">sigma</em>) is used. If <em class="arg">sigma</em> is not given it defaults to 1.</p>
265
266<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000267 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000268</div>
269
270<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Resize the image using data-dependent triangulation.</td><td style='text-align:right;'></td></tr></table>
271
272<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <a href="#adaptive-resize">-adaptive-resize</a> option defaults to data-dependent triangulation. Use the <a href="#filter">-filter</a> to choose a different resampling algorithm. Offsets, if present in the geometry string, are ignored, and the <a href="#gravity">-gravity</a> option has no effect.</p>
273
274<div style="margin: auto;">
cristyeed6cb62012-01-28 19:38:34 +0000275 <h4><a id="adaptive-sharpen"></a>-adaptive-sharpen <em class="arg">radius</em>[x<em class="arg">sigma</em>+<em class="arg">bias</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000276</div>
277
278<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Adaptively sharpen pixels, with increasing effect near edges.</td><td style='text-align:right;'></td></tr></table>
279
280<p>A Gaussian operator of the given radius and standard deviation (<em class="arg">sigma</em>) is used. If <em class="arg">sigma</em> is not given it defaults to 1.</p>
281
282<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000283 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000284</div>
285
286<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Join images into a single multi-image file.</td><td style='text-align:right;'></td></tr></table>
287
cristy30092792011-02-22 02:06:14 +0000288<p>This option is enabled by default. An attempt is made to save all images of
289an image sequence into the given output file. However, some formats, such as
290JPEG and PNG, do not support more than one image per file, and in that case
291ImageMagick is forced to write each image as a separate file. As such, if
292more than one image needs to be written, the filename given is modified by
293adding a <a href="#scene">-scene</a> number before the suffix, in order to
294make distinct names for each image. </p>
cristy3ed852e2009-09-05 21:47:34 +0000295
cristy30092792011-02-22 02:06:14 +0000296<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written to
297separate files, whether or not the file format allows multiple images per file
298(for example, GIF, MIFF, and TIFF). </p>
cristy3ed852e2009-09-05 21:47:34 +0000299
cristy30092792011-02-22 02:06:14 +0000300<p>Including a C-style integer format string in the output filename will
301automagically enable <a href="#adjoin">+adjoin</a> and are used to specify
302where the <a href="#scene">-scene</a> number is placed in the filenames. These
303strings, such as '<kbd>%d</kbd>' or '<kbd>%03d</kbd>', are familiar to those
304who have used the standard <kbd>printf()</kbd>' C-library function. As an
305example, the command</p>
cristy3ed852e2009-09-05 21:47:34 +0000306
cristyeed6cb62012-01-28 19:38:34 +0000307<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert logo: rose: -morph 15 my%02dmorph.jpg</span></p>
cristy30092792011-02-22 02:06:14 +0000308<p>will create a sequence of 17 images (the two given plus 15 more created by
309<a href="#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
310my02morph.jpg, ..., my16morph.jpg. </p>
cristy3ed852e2009-09-05 21:47:34 +0000311
cristy30092792011-02-22 02:06:14 +0000312<p>In summary, ImageMagick tries to write all images to one file, but will
313save to multiple files, if any of the following conditions exist...
314<ol>
315<li>the output image's file format does not allow multi-image files,
316<li>the <a href="#adjoin">+adjoin</a> option is given, or
317<li>a printf() integer format string (eg: "%d") is present in the output
318 filename.
319</ol></p>
cristy3ed852e2009-09-05 21:47:34 +0000320
321
322<div style="margin: auto;">
cristy30092792011-02-22 02:06:14 +0000323 <h4><a id="affine"></a>-affine
324 <em class="arg">s<sub>x</sub></em>,<em class="arg">r<sub>x</sub></em>,<em
325 class="arg">r<sub>y</sub></em>,<em class="arg">s<sub>y</sub></em>[,<em
cristye9a32c32011-04-07 01:11:05 +0000326 class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000327</div>
328
329<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the drawing transformation matrix for combined rotating and scaling.</td><td style='text-align:right;'></td></tr></table>
330
cristy30092792011-02-22 02:06:14 +0000331<p>This option sets a transformation matrix, for use by subsequent <a
332href="#draw">-draw</a> or <a href="#transform">-transform</a> options. </p>
cristy3ed852e2009-09-05 21:47:34 +0000333
cristy30092792011-02-22 02:06:14 +0000334<p>The matrix entries are entered as comma-separated numeric values either in
335quotes or without spaces. </p>
cristy3ed852e2009-09-05 21:47:34 +0000336
cristy30092792011-02-22 02:06:14 +0000337<p>Internally, the transformation matrix has 3x3 elements, but three of them
338are omitted from the input because they are constant. The new (transformed)
339coordinates (<em class="arg">x'</em>, <em class="arg">y'</em>) of a pixel at
340position (<em class="arg">x</em>, <em class="arg">y</em>) in the original
341image are calculated using the following matrix equation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000342
343<div class="eqn">
344<img alt="affine transformation" src="../images/affine.png"/>
345</div>
346
cristy30092792011-02-22 02:06:14 +0000347<p> The size of the resulting image is that of the smallest rectangle that
348contains the transformed source image. The parameters <em
349class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em>
350subsequently shift the image pixels so that those that are moved out of the
351image area are cut off.</p>
cristy3ed852e2009-09-05 21:47:34 +0000352
cristy30092792011-02-22 02:06:14 +0000353<p>The transformation matrix complies with the left-handed pixel coordinate
354system: positive <em class="arg">x</em> and <em class="arg">y</em> directions
355are rightward and downward, resp.; positive rotation is clockwise.</p>
cristy3ed852e2009-09-05 21:47:34 +0000356
cristy30092792011-02-22 02:06:14 +0000357<p> If the translation coefficients <em class="arg">t<sub>x</sub></em> and <em
cristyeed6cb62012-01-28 19:38:34 +0000358class="arg">t<sub>y</sub></em> are omitted they default to 0,0. Therefore,
cristy30092792011-02-22 02:06:14 +0000359four parameters suffice for rotation and scaling without translation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000360
cristy30092792011-02-22 02:06:14 +0000361<p>Scaling by the factors <em class="arg">s<sub>x</sub></em> and <em
362class="arg">s<sub>y</sub></em> in the <em>x</em> and <em>y</em> directions,
363respectively, is accomplished with the following.</p>
364
365<p>See <a href="#transform">-transform</a>, and the <a
366href="#distort">-distort</a> method '<kbd>Affineprojection</kbd> for more
367information </p>
368
cristy3ed852e2009-09-05 21:47:34 +0000369
370<p class="crtsnip">
371 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
372</p>
373
374<p>Translation by a displacement (<em class="arg">t<sub>x</sub></em>, <em class="arg">t<sub>y</sub></em>) is accomplished like so:</p>
375
376<p class="crtsnip">
377 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
378</p>
379
380<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
381<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
382
383<p class="crtsnip">
384 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
385</p>
386
387<p>The cumulative effect of a sequence of <a href="#affine" >-affine</a> transformations can be accomplished by instead by a single <a href="#affine" >-affine</a> operation using the matrix equal to the product of the matrices of the individual transformations.</p>
388
389<p>An attempt is made to detect near-singular transformation matrices. If the matrix determinant has a sufficiently small absolute value it is rejected.</p>
390
391<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000392 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000393</div>
394
395<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Gives control of the alpha/matte channel of an image.</td><td style='text-align:right;'></td></tr></table>
396
397<p>Used to set a flag on an image indicating whether or not to use existing alpha
398channel data, to create an alpha channel, or to perform other operations on the alpha channel. Choose the argument <em class="arg">type</em> from the list below.</p>
399
400
401<table class="doc">
402 <tbody>
403 <tr valign="top">
404 <th align="left" style="width: 8%">type</th>
405 <th align="left">Description</th>
406 </tr>
407
408 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000409 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000410 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000411 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
412 should be used instead of this, unless you specifically need to
413 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
414 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000415
416 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000417 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000418 <td valign="top">
419 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000420 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000421
422 <tr valign="top">
423 <td valign="top"><kbd>Set</kbd></td>
424 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000425 Activates the alpha/matte channel. If it was previously turned off
426 then it also resets the channel to opaque. If the image already had
427 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000428
429 <tr valign="top">
430 <td valign="top"><kbd>Opaque</kbd></td>
431 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000432 Enables the alpha/matte channel and forces it to be fully opaque.
433 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000434
435 <tr valign="top">
436 <td valign="top"><kbd>Transparent</kbd></td>
437 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000438 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000439 transparent. This effectively creates a fully transparent image the
440 same size as the original and with all its original RGB data still
441 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000442
443 <tr valign="top">
444 <td valign="top"><kbd>Extract</kbd></td>
445 <td valign="top">
446 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000447 '<kbd>Off</kbd>' the the image's transparency, so as to generate
448 a gray-scale mask of the image's shape. The alpha channel data is left
449 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
450 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000451
452 <tr valign="top">
453 <td valign="top"><kbd>Copy</kbd></td>
454 <td valign="top">
455 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000456 gray-scale intensity of the image, into the alpha channel, converting
457 a gray-scale mask into a transparent shaped mask ready to be colored
458 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000459
460 <tr valign="top">
461 <td valign="top"><kbd>Shape</kbd></td>
462 <td valign="top">
463 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000464 the current background color. That is the RGB color channels is
465 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000466 </td></tr>
467
468 <tr valign="top">
469 <td valign="top"><kbd>Background</kbd></td>
470 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000471 Set any fully-transparent pixel to the background color, while leaving
472 it fully-transparent. This can make some image file formats, such as
473 PNG, smaller as the RGB values of transparent pixels are more uniform,
474 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000475 </td></tr>
cristyeed6cb62012-01-28 19:38:34 +0000476
477 <tr valign="top">
478 <td valign="top"><kbd>Flatten</kbd></td>
479 <td valign="top">
480 Composite the image over the background color.
481 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000482 </tbody>
483</table>
484
485<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000486"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000487>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000488Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000489
490
491<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000492 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000493 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
494 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
495 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> {+-}<em class="arg">t<sub>x</sub></em>{+-}<em class="arg">t<sub>y</sub></em> <em class="arg">text</em></h4>
496</div>
497
498<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Annotate an image with text.</td><td style='text-align:right;'></td></tr></table>
499
500<p>This is a convenience for annotating an image with text. For more precise control over text annotations, use <a href="#draw">-draw</a>.</p>
501
502
503<p>The values <em class="arg">Xdegrees</em> and <em class="arg">Ydegrees</em> control the shears with respect to the , respectively, applied to the text, while <em class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em> are offsets that give the location of the text relative to the upper left corner of the image.</p>
504
505<p>Using <a href="#annotate">-annotate</a>&nbsp;<em class="arg">degrees</em> or <a href="#annotate">-annotate</a>&nbsp;<em class="arg">degrees</em>x<em class="arg">degrees</em> produces an unsheared rotation of the text. The direction of the rotation is positive, which means a clockwise rotation if <em class="arg">degrees</em> is positive. (This conforms to the usual mathematical convention once it is realized that the positive <em>y</em>&ndash;direction is conventionally considered to be <em>downward</em> for images.)</p>
506
507<p>The new (transformed) coordinates (<em class="arg">x'</em>, <em class="arg">y'</em>) of a pixel at position (<em class="arg">x</em>, <em class="arg">y</em>) in the image are calculated using the following matrix equation.</p>
508<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
509
510<p>If <em class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em> are omitted, they default to 0. This makes the bottom-left of the text becomes the upper-left corner of the image, which is probably undesirable. Adding a <a href="#gravity" >-gravity</a> option in this case leads to nice results.</p>
511
512<p>Text is any UTF-8 encoded character sequence. If <em class="arg">text</em> is of the form '@mytext.txt', the text is read from the file <kbd>mytext.txt</kbd>. Text in a file is taken literally; no embedded formatting characters are recognized.</p>
513
514<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000515 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000516</div>
517
518<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Enable/Disable of the rendering of anti-aliasing pixels when
519drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
520
521<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
522drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
523antialiasing edge pixels. This will then reduce the number of colors added to
524an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000525are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000526
527<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000528 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000529</div>
530
531<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Join current images vertically or horizontally.</td><td style='text-align:right;'></td></tr></table>
532
533<p>This option creates a single longer image image, by joining all the current
534images in sequence top-to-bottom. Use <a href="#append">+append</a> to
535stack images left-to-right. </p>
536
537<p>If they are not of the same width, narrower images are padded with the
538current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000539position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000540href="#gravity">-gravity</a> setting. </p>
541
542
543<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000544 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000545</div>
546
547<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Lessen (or intensify) when adding noise to an image.</td><td style='text-align:right;'></td></tr></table>
548
549
550<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000551 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000552</div>
553
554<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Decrypt a PDF with a password.</td><td style='text-align:right;'></td></tr></table>
555
556<p>Use this option to supply a <em class="arg">password</em> for decrypting a PDF that has been encrypted using Microsoft Crypto API (MSC API). The encrypting using the MSC API is not supported.</p>
557
558<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
559
cristyd934d102009-10-10 12:55:13 +0000560
561
cristy3ed852e2009-09-05 21:47:34 +0000562<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000563 <h4><a id="auto-gamma"></a>-auto-gamma</h4>
cristy3ed852e2009-09-05 21:47:34 +0000564</div>
565
566<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Automagically adjust gamma level of image.</td><td style='text-align:right;'></td></tr></table>
567
cristyd934d102009-10-10 12:55:13 +0000568<p>This calculates the mean values of an image, then applies a calculated <a
569href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
570image it will get a have a value of 50%. </p>
571
cristyd0bd44a2010-09-24 12:38:11 +0000572<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000573
574<p>This works well for real-life images with little or no extreme dark and
575light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000576dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000577</p>
578
579<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristy2dcd6822011-06-13 16:21:20 +0000580'<em>sync</em>' flag for channel synchronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000581values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000582>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000583together by the same gamma value, preserving colors. </p>
584
585
586
cristy3ed852e2009-09-05 21:47:34 +0000587<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000588 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000589</div>
590
591<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Automagically adjust color levels of image.</td><td style='text-align:right;'></td></tr></table>
592
cristyd934d102009-10-10 12:55:13 +0000593<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000594minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000595href="#level" >-level</a> operator to stretch the values to the full range of
596values. </p>
597
cristy83543962009-10-16 19:04:28 +0000598<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000599JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
600for the <a href="#level" >-level</a> operation. On the other hand it is the
601right operator to use for color stretching gradient images being used to
602generate Color lookup tables, distortion maps, or other 'mathematically'
603defined images. </p>
604
605<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
606href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
607>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
608problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000609>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000610
611<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristy2dcd6822011-06-13 16:21:20 +0000612special '<em>sync</em>' flag for channel synchronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000613which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000614href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
615'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000616together by the same gamma value, preserving colors, and ignoring
617transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000618
619
cristy3ed852e2009-09-05 21:47:34 +0000620<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000621 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000622</div>
623
624<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Automagically orient (rotate) an image created by a digital camera.</td><td style='text-align:right;'></td></tr></table>
625
cristy83543962009-10-16 19:04:28 +0000626<p>This operator reads and resets the EXIF image profile setting 'Orientation'
627and then performs the appropriate 90 degree rotation on the image to orient
628the image, for correct viewing. </p>
629
630<p>This EXIF profile setting is usually set using a gravity sensor in digital
cristyeed6cb62012-01-28 19:38:34 +0000631camera, however photos taken directly downward or upward may not have an
cristy83543962009-10-16 19:04:28 +0000632appropriate value. Also images that have been orientation 'corrected' without
633reseting this setting, may be 'corrected' again resulting in a incorrect
cristyeed6cb62012-01-28 19:38:34 +0000634result. If the EXIF profile was previously stripped, the <a
cristy83543962009-10-16 19:04:28 +0000635href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
636
637
cristy3ed852e2009-09-05 21:47:34 +0000638<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000639 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000640</div>
641
642<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Average a set of images.</td><td style='text-align:right;'></td></tr></table>
643
644<p>An error results if the images are not identically sized.</p>
645
cristy3ed852e2009-09-05 21:47:34 +0000646
647<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000648 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000649</div>
650
651<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Display the image centered on a backdrop.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>]</td></tr></table>
652
653<p>This backdrop covers the entire workstation screen and is useful for hiding other X window activity while viewing the image. The color of the backdrop is specified as the background color. The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
654
655<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000656 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000657</div>
658
659<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the background color.</td><td style='text-align:right;'></td></tr></table>
660
661<p>The color is specified using the format described under the <a href="#fill">-fill</a> option. The default background color (if none is specified or found in the image) is white.</p>
662
663<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000664 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000665</div>
666
667<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Measure performance.</td><td style='text-align:right;'></td></tr></table>
668
cristye6378132009-10-26 20:05:17 +0000669<p>Repeat the entire command for the given number of <em class="arg">iterations</em> and report the user-time and elapsed time. For instance, consider the following command and its output. Modify the benchmark with the -duration to run the benchmark for a fixed number of seconds and -concurrent to run the benchmark in parallel (requires the OpenMP feature).</p>
cristy3ed852e2009-09-05 21:47:34 +0000670
cristyeed6cb62012-01-28 19:38:34 +0000671<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert logo: -resize 1000% -bench 5 logo.png</span><span class='crtout'>Performance[4]: 5i 0.875657ips 6.880u 0:05.710</span></p>
672<p>In this example, 5 iterations were completed at 0.875657 iterations per second, using 4 threads and 6.88 seconds of the user's allotted time, for a total elapsed time of 5.71 seconds.</p>
cristy3ed852e2009-09-05 21:47:34 +0000673
674<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000675 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000676</div>
677
678<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Add bias when convolving an image.</td><td style='text-align:right;'></td></tr></table>
679
680<p>This option shifts the output of <a href="../www/command-line-options.html#convolve">&#x2011;convolve</a> so that positive and negative results are relative to the specified bias value. </p>
681
682<p>This is important for non-HDRI compilations of ImageMagick when dealing with convolutions that contain negative as well as positive values. This is especially the case with convolutions involving high pass filters or edge detection. Without an output bias, the negative values are clipped at zero.</p>
683
684<p>When using an ImageMagick with the HDRI compile-time setting, <a href="../www/command-line-options.html#bias">&#x2011;bias</a> is not needed, as ImageMagick is able to store/handle any
685negative results without clipping to the color value range
686(0..QuantumRange).</p>
687
688<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +0000689<a href="../www/high-dynamic-range.html">High Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this <a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a> entry.
cristy3ed852e2009-09-05 21:47:34 +0000690</p>
691
692<div style="margin: auto;">
cristy37e0dfd2011-03-06 16:35:34 +0000693 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000694</div>
695
696<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Use black point compensation.</td><td style='text-align:right;'></td></tr></table>
697
698<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000699 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000700</div>
701
cristy5cadd612009-09-21 19:33:41 +0000702<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Force to black all pixels below the threshold while leaving all pixels at or above the threshold unchanged.</td><td style='text-align:right;'></td></tr></table>
703
704<p> The threshold value can be given as a percentage or as an absolute integer value within [0,&nbsp;<em class="QR">QuantumRange</em>] corresponding to the desired <a href="../www/command-line-options.html#channel">&#x2011;channel</a> value. See <a href="../www/command-line-options.html#threshold">&#x2011;threshold</a> for more details on thresholds and resulting values.
705</p>
cristy3ed852e2009-09-05 21:47:34 +0000706
707
708<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000709 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000710</div>
711
cristy83a272e2010-05-07 20:40:35 +0000712<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>blend an image into another by the given absolute value or percent.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +0000713
714<p>Blend will average the images together ('plus') according to the
715percentages given and each pixels transparency. If only a single percentage
716value is given it sets the weight of the composite or 'source' image, while
717the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000718<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
719'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000720
721
722<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000723 <h4><a id="blue-primary"></a>-blue-primary <em class="arg">x</em>,<em class="arg">y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000724</div>
725
726<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the blue chromaticity primary point.</td><td style='text-align:right;'></td></tr></table>
727
728<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000729 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000730</div>
731
732<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</td><td style='text-align:right;'></td></tr></table>
733
734<div style="margin: auto;">
735
736<div style="margin: auto;">
cristyeed6cb62012-01-28 19:38:34 +0000737 <h4><a id="blur"></a>-blur <em class="arg">radius</em><br />-blur <em class="arg">radius</em>x<em class="arg">sigma</em>+<em class="arg">bias</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000738</div>
739
740<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Reduce image noise and reduce detail levels.</td><td style='text-align:right;'></td></tr></table>
741
cristyb15553d2010-07-03 22:53:14 +0000742<p>Convolve the image with a Gaussian or normal distribution using the given
743<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000744
745<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
746</div>
747
cristyb15553d2010-07-03 22:53:14 +0000748<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000749determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000750
cristyb15553d2010-07-03 22:53:14 +0000751<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000752array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000753integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000754radius that will provide meaningful results for the Gaussian distribution.
755</p>
756
cristyeed6cb62012-01-28 19:38:34 +0000757<p>The larger the <em class="arg" >Radius</em> the slower the
cristyb15553d2010-07-03 22:53:14 +0000758operation is. However too small a <em class="arg" >Radius</em>, and sever
759aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
760should be at least twice the <em class="arg" >Sigma</em> value, though three
cristyeed6cb62012-01-28 19:38:34 +0000761times will produce a more accurate result. </p>
cristyb15553d2010-07-03 22:53:14 +0000762
763<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
764by taking advantage of the separability properties of the distribution. Here
765we apply a single-dimensional Gaussian matrix in the horizontal direction,
766then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000767
768<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
769pixels which are outside the image proper are blurred into the final result.
770</p>
771
772
773<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000774 <h4>-blur <em class="arg">Width</em>[x<em class="arg">Height</em>[+<em class="arg">Angle</em>]]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000775</div>
776
777<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Variably blur and image according to the overlay mapping.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
778
779<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
780Average (EWA) of the source image, scaled according to the grayscale
781mapping. </p>
782
783<p>The ellipse is weighted with sigma set to the given <em class="arg"
784>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
cristyeed6cb62012-01-28 19:38:34 +0000785defaults to the <em class="arg" >Width</em> for a normal circular Gaussian
cristy3ed852e2009-09-05 21:47:34 +0000786weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
787horizontal clock-wise. </p>
788
789<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
790pixels which are outside the image proper are blurred into the final result.
791</p>
792
793
794<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000795 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000796</div>
797
798<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Surround the image with a border of color. </td><td style='text-align:right;'></td></tr></table>
799
cristybc9539a2010-08-16 18:06:20 +0000800<p>Set the width and height using the <em class="arg">size</em> portion of the
cristyeed6cb62012-01-28 19:38:34 +0000801<em class="arg">geometry</em> argument. See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Offsets are
cristybc9539a2010-08-16 18:06:20 +0000802ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000803
cristybc9539a2010-08-16 18:06:20 +0000804<p>Set the border color by preceding with the <a
805href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000806
cristybc9539a2010-08-16 18:06:20 +0000807<p>The <a href="#border">-border</a> operation is affected by the current <a
808href="#compose">-compose</a> setting and assumes that this is using the default
809'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
810size colors by the current <a href="#bordercolor">-bordercolor</a> before
811overlaying the original image in the center of this net image. This means that
812with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000813be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000814<p>See also the <a href="#frame">-frame</a> option, which has more
815functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000816
817<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000818 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000819</div>
820
821<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the border color.</td><td style='text-align:right;'></td></tr></table>
822
823<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
824
825<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
826
827<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000828 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000829</div>
830
831<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the border width.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>]</td></tr></table>
832
833<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000834 <h4><a id="brightness-contrast"></a>-brightness-contrast <em class="arg">brightness</em><br />-brightness-contrast <em class="arg">brightness</em>{x<em class="arg">contrast</em>}{<em class="arg">%</em>}}</h4>
cristy16ff93c2010-01-13 23:18:07 +0000835</div>
836
837<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Adjust the brightness and/or contrast of the image.</td><td style='text-align:right;'></td></tr></table>
838
cristyefb2bdb2010-11-20 19:35:22 +0000839<p>Brightness and Contrast values apply changes to the input image. They are
840not absolute settings. A brightness or contrast value of zero means no change.
841The range of values is -100 to +100 on each. Positive values increase the
842brightness or contrast and negative values decrease the brightness or contrast.
843To control only contrast, set the brightness=0. To control only brightness,
844set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000845
cristyefb2bdb2010-11-20 19:35:22 +0000846<p>You may also use <a href="#fill">-channel</a> to control which channels to
847apply the brightness and/or contrast change. The default is to apply the same
848transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000849
cristyefb2bdb2010-11-20 19:35:22 +0000850<p>Brightness and Contrast arguments are converted to offset and slope of a
851linear transform and applied
852using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000853
cristyefb2bdb2010-11-20 19:35:22 +0000854<p>The slope varies from 0 at contrast=-100 to almost vertical at
855contrast=+100. For brightness=0 and contrast=-100, the result are totally
856midgray. For brightness=0 and contrast=+100, the result will approach but
857not quite reach a threshold at midgray; that is the linear transformation
858is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000859
cristyefb2bdb2010-11-20 19:35:22 +0000860<p>Negative slopes, i.e. negating the image, are not possible with this
861function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000862
cristyefb2bdb2010-11-20 19:35:22 +0000863<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
864at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
865totally white. Similarly, when contrast=0 and brightness=-100, the result is
866totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000867
cristyefb2bdb2010-11-20 19:35:22 +0000868<p>As the range of values for the arguments are -100 to +100, adding the '%'
869symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000870
871<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000872 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000873</div>
874
875<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>(This option has been replaced by the <a href='#limit'>-limit</a> option.)</td><td style='text-align:right;'></td></tr></table>
876
877<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000878 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000879</div>
880
881<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Assign a caption to an image.</td><td style='text-align:right;'></td></tr></table>
882
cristy71a3f602010-09-15 12:38:16 +0000883<p>This option sets the caption meta-data of an image read in after this
884option has been given. To modify a caption of images already in memory use
885"<kbd><a href="#set">-set</a> caption</kbd>". </p>
886
887<p>The caption can contain special format characters listed in the <a
888href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000889Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000890is finally assigned to the individual images. </p>
891
892<p>If the first character of <em class="arg">string</em> is <em
893class="arg">@</em>, the image caption is read from a file titled by the
894remaining characters in the string. Comments read in from a file are literal;
895no embedded formatting characters are recognized.</p>
896
cristyeed6cb62012-01-28 19:38:34 +0000897<p>Caption meta-data is not visible on the image itself. To do that use the
cristy71a3f602010-09-15 12:38:16 +0000898<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
899instead.</p>
900
901<p>For example,</p>
902
903<p class="crtsnip">
904 -caption "%m:%f %wx%h" bird.miff
905</p>
906
907<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
908that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
909480.</p>
910
911
cristy3ed852e2009-09-05 21:47:34 +0000912<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000913 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000914</div>
915
916<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>color correct with a color decision list.</td><td style='text-align:right;'></td></tr></table>
917
918<p>Here is an example color correction collection:</p>
919
920<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000921&lt;?xml version="1.0" encoding="UTF-8"?&gt;
922&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
923 &lt;ColorCorrection id="cc06668"&gt;
924 &lt;SOPNode&gt;
925 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
926 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
927 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
928 &lt;/SOPNode&gt;
929 &lt;SATNode&gt;
930 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
931 &lt;/SATNode&gt;
932 &lt;/ColorCorrection&gt;
933&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000934</pre>
935
936<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000937 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000938</div>
939
940<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify those image color channels to which subsequent operators are limited.</td><td style='text-align:right;'></td></tr></table>
941
cristyefb2bdb2010-11-20 19:35:22 +0000942<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
943<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
944<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
945<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000946
cristy83a272e2010-05-07 20:40:35 +0000947<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000948abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
949'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
950'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000951
cristy83a272e2010-05-07 20:40:35 +0000952For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
953you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000954<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000955 -channel Red,Blue
956</p>
957<p>or you can use the short hand form</p>
958<p class="crtsnip">
959 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000960</p>
961
cristy2dcd6822011-06-13 16:21:20 +0000962<p>All the channels that are present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000963special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
964but generally any operators that are generally 'grey-scale' image operators,
965will understand this setting. See individual operator documentation. </p>
966
cristydcca3fa2010-12-29 21:50:07 +0000967<br />
cristy83a272e2010-05-07 20:40:35 +0000968
cristy2dcd6822011-06-13 16:21:20 +0000969<p>On top of the normal channel selection an extra flag can be specified,
cristy83a272e2010-05-07 20:40:35 +0000970'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000971operators that understand this flag should perform: cross-channel
cristy2dcd6822011-06-13 16:21:20 +0000972synchronization of the channels. If not specified, then most grey-scale
cristybac7a162010-06-15 19:57:29 +0000973operators will apply their image processing operations to each individual
974channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000975setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000976
977<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000978<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000979together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000980it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000981independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000982
cristydcca3fa2010-12-29 21:50:07 +0000983<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000984and the <a href="#compose">-compose</a> mathematical methods, also understands
985the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
986to the alpha channel (if present). That is to say it will modify the image
987processing with the understanding that fully-transparent colors should not
988contribute to the final result. </p>
989
cristy2dcd6822011-06-13 16:21:20 +0000990<p>Basically, by default, operators work with color channels in synchronous, and
cristybac7a162010-06-15 19:57:29 +0000991treats transparency as special, unless the <a href="#channel">-channel</a>
992setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
993How each operator does this depends on that operators current implementation.
994Not all operators understands this flag at this time, but that is changing.
995</p>
cristy83a272e2010-05-07 20:40:35 +0000996
997<p>To print a complete list of channel types, use <a href="#list">-list
998channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000999
cristydcca3fa2010-12-29 21:50:07 +00001000<br />
cristyd934d102009-10-10 12:55:13 +00001001
1002<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +00001003'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
1004channels except the transparency channel, and that all the color channels are
cristyeed6cb62012-01-28 19:38:34 +00001005to be modified in exactly the same way, with an understanding of transparency
cristybac7a162010-06-15 19:57:29 +00001006(depending on the operation being applied). The 'plus' form <a
1007href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +00001008
1009<p>Options that are affected by the <a href="#channel" >-channel</a> setting
1010include the following.
1011
1012<a href="#auto-gamma">-auto-gamma</a>,
1013<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +00001014<a href="#black-threshold">-black-threshold</a>,
1015<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +00001016<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +00001017<a href="#clut">-clut</a>,
1018<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +00001019<a href="#composite">-composite</a> (Mathematical compose methods only),
1020<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +00001021<a href="#contrast-stretch">-contrast-stretch</a>,
1022<a href="#evaluate">-evaluate</a>,
1023<a href="#function">-function</a>,
1024<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +00001025<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +00001026<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +00001027<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +00001028<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +00001029<a href="#negate">-negate</a>,
1030<a href="#normalize">-normalize</a>,
1031<a href="#ordered-dither">-ordered-dither</a>,
1032<a href="#radial-blur">-radial-blur</a>,
1033<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +00001034<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +00001035<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +00001036<a href="#white-threshold">-white-threshold</a>.
1037</p>
1038
cristyd0bda5e2010-09-21 16:22:45 +00001039<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +00001040>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +00001041href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +00001042default). These operators have yet to be made to understand the newer 'Sync'
1043flag. </p>
1044
cristybac7a162010-06-15 19:57:29 +00001045<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
1046the image before thresholding, if no <a href="#channel" >-channel</a> setting
1047has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +00001048
1049<p>Also some operators such as <a href="#blur">-blur</a>, <a
1050href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
1051color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
1052href="#channel" >-channel</a>. Generally this done to ensure that
1053fully-transparent colors are treated as being fully-transparent, and thus any
1054underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +00001055resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +00001056convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +00001057and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +00001058
cristybac7a162010-06-15 19:57:29 +00001059<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +00001060color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +00001061alpha channel present, and the <a href="#channel" >-channel</a> setting tells
1062the operator to apply the operation using alpha channels. The <a
1063href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +00001064
cristy3ed852e2009-09-05 21:47:34 +00001065
1066<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001067 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +00001068</div>
1069
1070<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Restrict image colors from 0 to the quantum depth.</td><td style='text-align:right;'></td></tr></table>
1071
1072<div style="margin: auto;">
cristyeed6cb62012-01-28 19:38:34 +00001073 <h4><a id="charcoal"></a>-charcoal <em class="arg">radius</em><br />-charcoal <em class="arg">radius</em>x<em class="arg">sigma</em>+<em class="arg">bias</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001074</div>
1075
1076<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Simulate a charcoal drawing.</td><td style='text-align:right;'></td></tr></table>
1077
1078<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001079 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001080</div>
1081
1082<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Remove pixels from the interior of an image.</td><td style='text-align:right;'></td></tr></table>
1083
cristyefb2bdb2010-11-20 19:35:22 +00001084<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <em class="arg">width</em>
1085and <em class="arg">height</em> given in the of the <em class="arg">size</em>
1086portion of the <em class="arg">geometry</em> argument give the number of
1087columns and rows to remove. The <em class="arg">offset</em> portion of
1088the <em class="arg">geometry</em> argument is influenced by
1089a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +00001090
cristyefb2bdb2010-11-20 19:35:22 +00001091<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
1092and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00001093
cristyacc04882011-05-04 23:03:43 +00001094<p>While it can remove internal rows and columns of pixels, it is more
1095typically used with as <a href="#gravity">-gravity</a> setting and zero
1096offsets so as to remove a single edge from an image. Compare this to <a
1097href="#shave" >-shave</a> which removes equal numbers of pixels from oppisite
1098sides of the image. </p>
cristydcca3fa2010-12-29 21:50:07 +00001099
cristyeed6cb62012-01-28 19:38:34 +00001100<p>Using <a href="#chop">-chop</a> effectively undoes the results of a <a
cristyacc04882011-05-04 23:03:43 +00001101href="#splice">-splice</a> that was given the same <em
1102class="arg">geometry</em> and <a href="#gravity">-gravity</a> settings. </p>
cristydcca3fa2010-12-29 21:50:07 +00001103
1104
cristy3ed852e2009-09-05 21:47:34 +00001105<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001106 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001107</div>
1108
1109<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Apply the clipping path if one is present.</td><td style='text-align:right;'></td></tr></table>
1110
1111<p>If a clipping path is present, it is applied to subsequent operations.</p>
1112
1113<p>For example, in the command</p>
1114
cristyeed6cb62012-01-28 19:38:34 +00001115<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
cristy3ed852e2009-09-05 21:47:34 +00001116<p>only the pixels within the clipping path are negated.</p>
1117
1118<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1119
1120<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001121 <h4><a id="clip-mask"></a>-clip-mask</h4>
cristy3ed852e2009-09-05 21:47:34 +00001122</div>
1123
1124<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Clip the image as defined by this mask.</td><td style='text-align:right;'></td></tr></table>
1125
cristy30092792011-02-22 02:06:14 +00001126<p>Use the given image as a 'do-not-modify' mask of the current images in the
1127current image sequence. Assuming the clipmask is a greyscale image the same
1128size at the one already in memory, any areas that is white will not be
1129modified by any of the 'image processing operators' that follow, until the
1130mask is removed. Pixels in the black areas of the clip mask will be modified
1131as normal. </p>
1132
1133<p>In some ways this is similar to (though not the same) as defining
1134a rectangular <a href="#region" >-region</a>, or using the negative of the
1135mask (thrid) image in a three image <a href="#composite" >-composite</a>,
1136operation. </p>
1137
1138
cristy3ed852e2009-09-05 21:47:34 +00001139<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001140 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001141</div>
1142
cristyeed6cb62012-01-28 19:38:34 +00001143<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Clip along a named path from the 8BIM profile.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001144
cristyd241f442011-03-29 13:50:49 +00001145<p>This is almost identical to <a href="#clip">-clip</a>. </p>
cristy30092792011-02-22 02:06:14 +00001146
1147
cristy3ed852e2009-09-05 21:47:34 +00001148<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001149 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001150</div>
1151
cristy8b9dd952011-03-21 22:56:18 +00001152<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>make a clone of an image (or images).</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001153
cristydcca3fa2010-12-29 21:50:07 +00001154<p>Inside parenthesis (where the operator is normally used) it will make a
1155clone of the images from the last 'pushed' image sequence, and adds them to
1156the end of the current image sequence. Outside parenthesis
1157(not recommended) it clones the images from the current image sequence. </p>
1158
cristy3ed852e2009-09-05 21:47:34 +00001159<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000011600. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001161example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001162represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001163dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1164spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
cristy8b9dd952011-03-21 22:56:18 +00001165effectively clone all the images. </p>
cristydcca3fa2010-12-29 21:50:07 +00001166
1167<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
cristybaacd172011-04-30 23:11:03 +00001168in the image sequence, and is thus equivalent to using a argument of
cristydcca3fa2010-12-29 21:50:07 +00001169'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001170
1171<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001172 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001173</div>
1174
1175<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Replace the channel values in the first image using each
1176corresponding channel in the second image as a <b>c</b>olor
1177<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1178
1179<p>The second (LUT) image is ordinarily a gradient image containing the
1180histogram mapping of how each channel should be modified. Typically it is a
1181either a single row or column image of replacement color values. If larger
1182than a single row or column, values are taken from a diagonal line from
1183top-left to bottom-right corners.</p>
1184
1185<p>The lookup is further controlled by the <a
1186href="#interpolate">-interpolate</a> setting, which is especially handy for an
1187LUT which is not the full length needed by the ImageMagick installed Quality
1188(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1189'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1190gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1191lookup of color values. </p>
1192
1193<p>This operator is especially suited to replacing a grayscale image with a
1194specific color gradient from the CLUT image. </p>
1195
1196<p>Only the channel values defined by the <a href="#channel">-channel</a>
1197setting will have their values replaced. In particular, since the default <a
1198href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1199transparency (alpha/matte channel) is not affected, unless the <a
1200href="#channel">-channel</a> setting is modified. When the alpha channel is
1201set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1202as the other channels, implying that alpha/matte values are replaced using the
1203alpha/matte values of the original image. </p>
1204
cristyd0bda5e2010-09-21 16:22:45 +00001205<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001206transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1207href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001208assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001209replacement alpha values. That is you can use a gray-scale CLUT image to
1210adjust a existing images alpha channel, or you can color a gray-scale image
1211using colors form CLUT containing the desired colors, including transparency.
1212</p>
1213
cristyefb2bdb2010-11-20 19:35:22 +00001214<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1215according to the lookup of the full color RGB value from a 2D representation
1216of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001217
1218
1219<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001220 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001221</div>
1222
1223<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Fully define the look of each frame of an GIF animation sequence, to form a 'film strip' animation.</td><td style='text-align:right;'></td></tr></table>
1224
cristyefb2bdb2010-11-20 19:35:22 +00001225<p>Overlay each image in an image sequence according to
1226its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1227an animation at each point in the animation sequence. All images should be
1228the same size, and are assigned appropriate GIF disposal settings for the
1229animation to continue working as expected as a GIF animation. Such frames
1230are more easily viewed and processed than the highly optimized GIF overlay
1231images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001232
cristyefb2bdb2010-11-20 19:35:22 +00001233<p>The animation can be re-optimized after processing using
1234the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1235there is no guarantee that the restored GIF animation optimization is
1236better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001237
1238
1239<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001240 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001241</div>
1242
1243<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Colorize the image by an amount specified by <em class="arg">value</em> using the color specified by the most recent <a href="#fill" >-fill</a> setting.</td><td style='text-align:right;'></td></tr></table>
1244
cristyefb2bdb2010-11-20 19:35:22 +00001245<p>Specify the amount of colorization as a percentage. Separate colorization
1246values can be applied to the red, green, and blue channels of the image with
1247a comma-delimited list of colorization
1248values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001249
1250<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001251 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001252</div>
1253
1254<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Define the colormap type.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>]</td></tr></table>
1255
1256<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1257
cristyefb2bdb2010-11-20 19:35:22 +00001258<p>This option only applies when the default X server visual
1259is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1260to <a href="#visual">-visual</a> for more details. By default,
1261a shared colormap is allocated. The image shares colors with
1262other X clients. Some image colors could be approximated,
1263therefore your image may look very different than intended.
1264If <kbd>private</kbd> is chosen, the image colors appear exactly
1265as they are defined. However, other clients may go <em>technicolor</em>
1266when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001267
1268<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001269 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001270</div>
1271
1272<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the preferred number of colors in the image.</td><td style='text-align:right;'></td></tr></table>
1273
cristyefb2bdb2010-11-20 19:35:22 +00001274<p>The actual number of colors in the image may be less than your request,
1275but never more. Note that this a color reduction option. Images with fewer
1276unique colors than specified by <em class="arg">value</em> will have any
1277duplicate or unused colors removed. The ordering of an existing color
1278palette may be altered. When converting an image from color to grayscale,
1279it is more efficient to convert the image to the gray colorspace before
1280reducing the number of colors. Refer to
1281the <a href="../www/quantize.html">
1282color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001283
1284<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001285 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001286</div>
1287
1288<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>apply color correction to the image.</td><td style='text-align:right;'></td></tr></table>
1289
cristyefb2bdb2010-11-20 19:35:22 +00001290<p>This option permits saturation changes, hue rotation, luminance to alpha,
1291and various other effects. Although variable-sized transformation matrices
1292can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1293for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1294Adobe Flash except offsets are in column 6 rather than 5 (in support of
1295CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001296
1297<p>As an example, to add contrast to an image with offsets, try this command:</p>
1298
1299<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001300 convert kittens.jpg -color-matrix \
1301 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1302 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1303 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1304 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1305 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1306 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
cristy2c839602010-04-03 02:32:08 +00001307</pre>
1308<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001309 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001310</div>
1311
1312<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the image colorspace.</td><td style='text-align:right;'></td></tr></table>
1313
1314<p>Choices are:</p>
1315
1316<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001317 CMY CMYK Gray HSB
1318 HSL HWB Lab Log
1319 OHTA Rec601Luma Rec601YCbCr Rec709Luma
1320 Rec709YCbCr RGB sRGB Transparent
1321 XYZ YCbCr YCC YIQ
1322 YPbPr YUV
cristy3ed852e2009-09-05 21:47:34 +00001323</pre>
1324
1325<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1326
1327<p>For a more accurate color conversion to or from the RGB, CMYK, or grayscale colorspaces, use the <a href="#profile">-profile</a> option.</p>
1328
1329<table class="doc">
1330 <caption>Conversion Of RGB To Other Color Spaces</caption>
1331 <tr><th align="left" valign="middle">CMY</th></tr>
1332 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1333 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1334 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1335 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1336 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1337 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1338 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1339 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1340
1341 <tr><th align="left" valign="middle">Gray</th></tr>
1342 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1343
1344 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1345 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1346 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1347 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1348
1349 <tr><th align="left" valign="middle">HSL &mdash; Hue, Saturation, Lightness; like a double cone end-to-end with peaks at very top and bottom</th></tr>
1350 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1351 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1352 <tr><td align="left" valign="middle">L=distance along axis from bottom upward; L=0.5*max(R,G,B) + 0.5*min(R,G,B); <em>intensity-like</em></td></tr>
1353
1354 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1355 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1356 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1357 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1358
1359 <tr><th align="left" valign="middle">LAB</th></tr>
1360 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1361 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1362 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1363
1364 <tr><th align="left" valign="middle">LOG</th></tr>
1365 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1366 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1367 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1368
1369 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1370 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1371 <tr><td align="left" valign="middle">I2=(0.50000*R+0.00000*G&minus;0.50000*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1372 <tr><td align="left" valign="middle">I3=(&minus;0.25000*R+0.50000*G&minus;0.25000*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1373
1374 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1375 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1376
1377 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1378 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1379 <tr><td align="left" valign="middle">Cb=(&minus;0.168736*R-0.331264*G+0.500000*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1380 <tr><td align="left" valign="middle">Cr=(0.500000*R&minus;0.418688*G&minus;0.081312*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1381
1382 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1383 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1384
1385 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1386 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1387 <tr><td align="left" valign="middle">Cb=(&minus;0.114572*R&minus;0.385428*G+0.500000*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1388 <tr><td align="left" valign="middle">Cr=(0.500000*R&minus;0.454153*G&minus;0.045847*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1389
1390 <tr><th align="left" valign="middle">sRGB</th></tr>
cristyf9a6c462011-04-24 14:01:11 +00001391 <tr><td align="left" valign="middle">if Rs &le; .04045 then Rs=R/12.92 else Rs=((R+.055)/1.055)^2.4</td></tr>
1392 <tr><td align="left" valign="middle">if Gs &le; .04045 then Gs=B/12.92 else Gs=((G+.055)/1.055)^2.4</td></tr>
1393 <tr><td align="left" valign="middle">if Bs &le; .04045 then Bs=B/12.92 else Bs=((B+.055)/1.055)^2.4</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00001394
1395 <tr><th align="left" valign="middle">XYZ</th></tr>
1396 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1397 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1398 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1399
1400 <tr><th align="left" valign="middle">YCC</th></tr>
1401 <tr><td align="left" valign="middle">Y=(0.29900*R+0.58700*G+0.11400*B) (with complicated scaling); <em>intensity-like</em></td></tr>
1402 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1403 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1404
1405 <tr><th align="left" valign="middle">YCbCr</th></tr>
1406 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1407 <tr><td align="left" valign="middle">Cb=(&minus;0.168736*R&minus;0.331264*G+0.500000*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1408 <tr><td align="left" valign="middle">Cr=(0.500000*R&minus;0.418688*G&minus;0.081312*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1409
1410 <tr><th align="left" valign="middle">YIQ</th></tr>
1411 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1412 <tr><td align="left" valign="middle">I=(0.59600*R&minus;0.27400*G&minus;0.32200*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1413 <tr><td align="left" valign="middle">Q=(0.21100*R&minus;0.52300*G+0.31200*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1414
1415 <tr><th align="left" valign="middle">YPbPr</th></tr>
1416 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1417 <tr><td align="left" valign="middle">Pb=(&minus;0.168736*R&minus;0.331264*G+0.500000*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1418 <tr><td align="left" valign="middle">Pr=(0.500000*R&minus;0.418688*G&minus;0.081312*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1419
1420 <tr><th align="left" valign="middle">YUV</th></tr>
1421 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1422 <tr><td align="left" valign="middle">U=(&minus;0.14740*R&minus;0.28950*G+0.43690*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1423 <tr><td align="left" valign="middle">V=(0.61500*R&minus;0.51500*G&minus;0.10000*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1424</table>
1425
1426<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001427 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001428</div>
1429
1430<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Combine one or more images into a single image.</td><td style='text-align:right;'></td></tr></table>
1431
1432<p>The channels (previously set by <a href="#channel">-channel</a>) of the combined image are taken from the grayscale values of each image in the sequence, in order. For the default -channel setting of <kbd>RGB</kbd>, this means the first image is assigned to the <kbd>Red</kbd> channel, the second to the <kbd>Green</kbd> channel, the third to the <kbd>Blue</kbd>.</p>
1433
1434<p>This option can be thought of as the inverse to <a href="#separate">-separate</a>, so long as the channel settings are the same. Thus, in the following example, the final image should be a copy of the original.
1435</p>
1436
cristyeed6cb62012-01-28 19:38:34 +00001437<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert original.png -channel RGB -separate sepimage.png</span><span class='crtout'></span><span class="crtprompt"> $ </span><span class='crtin'>convert sepimage-0.png sepimage-1.png sepimage-2.png -channel RGB \ <br/> -combine imagecopy.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00001438<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001439 <h4><a id="comment"></a>-comment <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001440</div>
1441
1442<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Embed a comment in an image.</td><td style='text-align:right;'></td></tr></table>
1443
cristyd0bda5e2010-09-21 16:22:45 +00001444<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001445option has been given. To modify a comment of images already in memory use
1446"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001447
cristy71a3f602010-09-15 12:38:16 +00001448<p>The comment can contain special format characters listed in the <a
1449href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001450Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001451is finally assigned to the individual images. </p>
1452
1453<p>If the first character of <em class="arg">string</em> is <em
1454class="arg">@</em>, the image comment is read from a file titled by the
1455remaining characters in the string. Comments read in from a file are literal;
1456no embedded formatting characters are recognized.</p>
1457
1458<p>Comment meta-data are not visible on the image itself. To do that use the
1459<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1460instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001461
1462<p>For example,</p>
1463
1464<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001465 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001466</p>
1467
cristy71a3f602010-09-15 12:38:16 +00001468<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1469that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1470480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001471
1472<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001473 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001474</div>
1475
1476<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the type of image composition.</td><td style='text-align:right;'></td></tr></table>
1477
cristybc9539a2010-08-16 18:06:20 +00001478<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1479a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001480
cristybc9539a2010-08-16 18:06:20 +00001481<p>This setting effects image processing operators that merge two (or more)
1482images together in some way. This includes the operators,
1483<a href="#composite">-composite</a>,
1484<a href="#layers">-layers</a> composite,
1485<a href="#flatten">-flatten</a>,
1486<a href="#mosaic">-mosaic</a>,
1487<a href="#layers">-layers</a> merge,
1488<a href="#border">-border</a>,
1489<a href="#frame">-frame</a>,
1490and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001491
cristybc9539a2010-08-16 18:06:20 +00001492<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1493command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001494
1495
1496<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001497 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001498</div>
1499
cristybc9539a2010-08-16 18:06:20 +00001500<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Perform alpha composition on two images and an optional mask</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001501
1502<p>Take the first image 'destination' and overlay the second 'source' image
1503according to the current <a href="#compose">-compose</a> setting. The location
1504of the 'source' or 'overlay' image is controlled according to <a
1505href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1506settings. </p>
1507
1508<p>If a third image is given this is treated as a gray-scale 'mask' image
1509relative to the first 'destination' image. This mask will limit what parts of
1510the destination can be modified by the image composition. However for the
1511'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1512Y-displacement image instead. </p>
1513
1514<p>If a <a href="#compose">-compose</a> method requires extra numerical
1515arguments or flags these can be provided by setting the <a
1516href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001517appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001518
1519<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1520image outside the overlay area. You can disable this by setting the special <a
1521href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1522to '<kbd>false</kbd>'. </p>
1523
1524
1525<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001526 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001527</div>
1528
1529<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Use pixel compression specified by <em class="arg">type</em> when writing the image.</td><td style='text-align:right;'></td></tr></table>
1530
1531<p>Choices are: <kbd class="arg">None</kbd>, <kbd class="arg">BZip</kbd>, <kbd class="arg">Fax</kbd>, <kbd class="arg">Group4</kbd>, <kbd class="arg">JPEG</kbd>, <kbd class="arg">JPEG2000</kbd>, <kbd class="arg">Lossless</kbd>, <kbd class="arg">LZW</kbd>, <kbd class="arg">RLE</kbd> or <kbd class="arg">Zip</kbd>.</p>
1532
1533<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1534
1535<p>Specify <a href="#compress">+compress</a> to store the binary image in an uncompressed format. The default is the compression type of the specified image file.</p>
1536
1537<p>If <kbd>LZW</kbd> compression is specified but LZW compression has not been enabled, the image data is written in an uncompressed LZW format that can be read by LZW decoders. This may result in larger-than-expected GIF files.</p>
1538
cristyeed6cb62012-01-28 19:38:34 +00001539<p><kbd>Lossless</kbd> refers to lossless JPEG, which is only available if the
1540JPEG library has been patched to support it. Use of lossless JPEG is generally
1541not recommended.</p>
cristy3ed852e2009-09-05 21:47:34 +00001542
cristyeed6cb62012-01-28 19:38:34 +00001543<p>
1544When writing an ICO file, you may request that the images be encoded in
1545PNG format, by specifying <kbd>Zip</kbd> compression.</p>
1546
1547<p>
1548When writing a JNG file, specify <kbd>Zip</kbd> compression to request that
1549the alpha channel be encoded in PNG "IDAT" format, or <kbd>JPEG</kbd>
1550to request that it be encoded in JPG "JDAA" format.</p>
1551
1552<p>Use the <a href="#quality">-quality</a> option to set the compression level
1553to be used by JPEG, PNG, MIFF, and MPEG encoders.
1554Use the <a href="#sampling-factor">-sampling-factor</a> option to set the
1555sampling factor to be used by JPEG, MPEG, and YUV encoders for down-sampling
1556the chroma channels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001557
1558<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001559 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001560</div>
1561
1562<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Enhance or reduce the image contrast.</td><td style='text-align:right;'></td></tr></table>
1563
1564<p>This option enhances the intensity differences between the lighter and darker elements of the image. Use <a href="#contrast">-contrast</a> to enhance the image or <a href="#contrast">+contrast</a> to reduce the image contrast.</p>
1565
1566<p>For a more pronounced effect you can repeat the option:</p>
1567
cristyeed6cb62012-01-28 19:38:34 +00001568<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00001569<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001570 <h4><a id="contrast-stretch"></a>-contrast-stretch <em class="arg">black-point</em><br />-contrast-stretch <em class="arg">black-point</em>{x<em class="arg">white-point</em>}{<em class="arg">%</em>}}</h4>
cristy3ed852e2009-09-05 21:47:34 +00001571</div>
1572
1573<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Increase the contrast in an image by <em>stretching</em> the range of intensity values.</td><td style='text-align:right;'></td></tr></table>
1574
cristyd934d102009-10-10 12:55:13 +00001575<p>While performing the stretch, black-out at most <em
1576class="arg" >black-point</em> pixels and white-out at most <em
1577class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1578<em class="arg" >black-point %</em> pixels and white-out at most <em
1579class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001580
cristyd934d102009-10-10 12:55:13 +00001581<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1582>-contrast-stretch</a> will black-out at most <em class="arg"
1583>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1584minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1585class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1586>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001587
cristyd934d102009-10-10 12:55:13 +00001588<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1589the image's min and max values are stretched to 0 and <em class="QR"
1590>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1591clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001592>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001593prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001594
cristyd934d102009-10-10 12:55:13 +00001595<p>Internally operator works by creating a histogram bin, and then uses that
1596bin to modify the image. As such some colors may be merged together when they
1597originally fell into the same 'bin'. </p>
1598
1599<p>All the channels are normalized in concert by the came amount so as to
1600preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001601setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001602setting will normalize the RGB channels independently.</p>
1603
1604<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1605normalization of mathematical images. </p>
1606
1607<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001608
1609
1610<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001611 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001612</div>
1613
1614<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Convolve an image with a user-supplied convolution kernel.</td><td style='text-align:right;'></td></tr></table>
1615
cristy16ff93c2010-01-13 23:18:07 +00001616<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001617a comma-separated list of integers (with no spaces), ordered left-to right,
1618starting with the top row. Presently, only odd-dimensioned kernels are
1619supported, and therefore the number of entries in the specified <em
1620class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
16217<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001622
cristyd934d102009-10-10 12:55:13 +00001623<p>Note that the <a href="../www/command-line-options.html#convolve">&#x2011;convolve</a> operator supports the <a href="../www/command-line-options.html#bias">&#x2011;bias</a> setting. This option shifts the convolution so that
1624positive and negative results are relative to a user-specified bias value.
1625This is important for non-HDRI compilations of ImageMagick when dealing with
1626convolutions that contain negative as well as positive values. This is
1627especially the case with convolutions involving high pass filters or edge
1628detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001629</p>
1630
cristyd934d102009-10-10 12:55:13 +00001631<p>When using an ImageMagick with the HDRI compile-time setting, <a href="../www/command-line-options.html#bias">&#x2011;bias</a> is not needed, as ImageMagick is able to store/handle any
1632negative results without clipping to the color value range (0..QuantumRange).
1633See the discussion on HDRI implementations of ImageMagick on the page <a
cristy47774982011-02-15 15:17:19 +00001634href="../www/high-dynamic-range.html">High
cristyd934d102009-10-10 12:55:13 +00001635Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1636href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1637<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1638entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001639
cristy3ed852e2009-09-05 21:47:34 +00001640
1641<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001642 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001643</div>
1644
1645<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Cut out one or more rectangular regions of the image.</td><td style='text-align:right;'></td></tr></table>
1646
1647<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
1648
1649<p>The <em class="arg">width</em> and <em class="arg">height</em> of the <em class="arg">geometry</em> argument give the size of the image that remains after cropping, and <em class="arg">x</em> and <em class="arg">y</em> in the <em class="arg">offset</em> (if present) gives the location of the top left corner of the cropped image with respect to the original image. To specify the amount to be removed, use <a href="#shave">-shave</a> instead.</p>
1650
1651<p>If the <em class="arg">x</em> and <em class="arg">y</em> offsets are present, a single image is generated, consisting of the pixels from the cropping region. The offsets specify the location of the upper left corner of the cropping region measured downward and rightward with respect to the upper left corner of the image. If the <a href="#gravity">-gravity</a> option is present with <kbd>NorthEast</kbd>, <kbd>East</kbd>, or <kbd>SouthEast</kbd> gravity, it gives the distance leftward from the right edge of the image to the right edge of the cropping region. Similarly, if the <a href="#gravity">-gravity</a> option is present with <kbd>SouthWest</kbd>, <kbd>South</kbd>, or <kbd>SouthEast</kbd> gravity, the distance is measured upward between the bottom edges.</p>
1652
1653<p>If the <em class="arg">x</em> and <em class="arg">y</em> offsets are omitted, a set of tiles of the specified geometry, covering the entire input image, is generated. The rightmost tiles and the bottom tiles are smaller if the specified geometry extends beyond the dimensions of the input image.</p>
1654
1655<p>By adding a exclamation character flag to the geometry argument, the
1656cropped images virtual canvas page size and offset is set as if the
1657geometry argument was a viewport or window. This means the canvas page size
1658is set to exactly the same size you specified, the image offset set
1659relative top left corner of the region cropped. </p>
1660
1661<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1662special single pixel transparent 'missed' image is returned, and a 'crop
1663missed' warning given. </p>
1664
cristyeed6cb62012-01-28 19:38:34 +00001665<p>It might be necessary to <a href="#repage" >+repage</a> the image prior to
1666cropping the image to ensure the crop coordinate frame is relocated to the
1667upper-left corner of the visible image. This is especially true when you are
1668going to write to an image format such as PNG that supports an image
1669offset.</p>
cristy3ed852e2009-09-05 21:47:34 +00001670
1671<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001672 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001673</div>
1674
1675<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>displace image colormap by amount.</td><td style='text-align:right;'></td></tr></table>
1676
1677<p><em class="arg">Amount</em> defines the number of positions each
1678colormap entry is shifted.</p>
1679
1680
1681<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001682 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001683</div>
1684
1685<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>enable debug printout.</td><td style='text-align:right;'></td></tr></table>
1686
cristyeed6cb62012-01-28 19:38:34 +00001687<p>The <kbd>events</kbd> parameter specifies which events are to be logged. It can be either <kbd>None</kbd>, <kbd>All</kbd>, <kbd>Trace</kbd>, or a comma-separated list consisting of one or more of the following domains: <kbd>Accelerate</kbd>, <kbd>Annotate</kbd>, <kbd>Blob</kbd>, <kbd>Cache</kbd>, <kbd>Coder</kbd>, <kbd>Configure</kbd>, <kbd>Deprecate</kbd>, <kbd>Exception</kbd>, <kbd>Locale</kbd>, <kbd>Render</kbd>, <kbd>Resource</kbd>, <kbd>Security</kbd>, <kbd>TemporaryFile</kbd>, <kbd>Transform</kbd>, <kbd>X11</kbd>, or <kbd>User</kbd>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001688
1689
1690<p>For example, to log cache and blob events, use.</p>
1691
cristyeed6cb62012-01-28 19:38:34 +00001692<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00001693<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1694
1695<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1696
1697<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1698
1699<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1700
1701<p>Debugging may also be set using the <kbd>MAGICK_DEBUG</kbd> <a href="../www/resources.html#environment">environment variable</a>. The allowed values for the <kbd>MAGICK_DEBUG</kbd> environment variable are the same as for the <a href="#debug">-debug</a> option.</p>
1702
1703
1704<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001705 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001706</div>
1707
1708<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Decipher and restore pixels that were previously transformed by <a href="#encipher">-encipher</a>.</td><td style='text-align:right;'></td></tr></table>
1709
1710<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1711
1712<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1713
1714
1715<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001716 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001717</div>
1718
1719<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>find areas that has changed between images </td><td style='text-align:right;'></td></tr></table>
1720
1721<p>Given a sequence of images all the same size, such as produced by <a href="#coalesce">-coalesce</a>, replace the second and later images, with a smaller image of just the area that changed relative to the previous image. </p>
1722
1723<p>The resulting sequence of images can be used to optimize an animation sequence, though will not work correctly for GIF animations when parts of the animation can go from opaque to transparent. </p>
1724
1725<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1726
1727
1728<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001729 <h4><a id="define"></a>-define <em class="arg">key</em>{<em class="arg">=value</em>}<em class="arg">...</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001730</div>
1731
cristyd0bd44a2010-09-24 12:38:11 +00001732<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>add specific global settings generally used to control
cristyd0bda5e2010-09-21 16:22:45 +00001733coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001734
cristyd0bda5e2010-09-21 16:22:45 +00001735<p>This option creates one or more definitions for coders and decoders to use
1736while reading and writing image data. Definitions are generally used to
1737control image file format coder modules, and image processing operations,
1738beyond what is provided by normal means. Defined settings are listed in <a
1739href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1740as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001741
cristyd0bda5e2010-09-21 16:22:45 +00001742<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1743definition of a flag is created with that name. This used to control on/off
1744options. Use <a href="#define">+define key</a> to remove definitions
1745previously created. Use <a href="#define">+define "*"</a> to remove all
1746existing definitions.</p>
1747
cristyd0bd44a2010-09-24 12:38:11 +00001748<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001749href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001750>value</em>"</a> option, which also allows the use of <a href="../www/escape.html" >Format and Print Image
cristyd0bda5e2010-09-21 16:22:45 +00001751Properties</a> in the defined value. </p>
1752
cristyefb2bdb2010-11-20 19:35:22 +00001753<p>The <em>option</em> and <em>key</em> are case-independent (they are
1754converted to lowercase for use within the decoders) while the <em>value</em>
1755is case-dependent.</p>
1756
cristyd0bda5e2010-09-21 16:22:45 +00001757<p>Such settings are global in scope, and effect all images and operations. </p>
1758
1759<p>The following definitions are just some of the artifacts that are
1760available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001761
cristydcca3fa2010-12-29 21:50:07 +00001762<dl>
cristyeed6cb62012-01-28 19:38:34 +00001763
1764<dt>compose:args=<em class="arg">arguments</em></dt>
1765<dd>Sets certain compose argument values when using convert ... -compose ... -composite. See <a href="http://www.imagemagick.org/www/compose.html">Image Composition</a></dd>
1766
1767<dt>distort:scale=<em class="arg">value</em></dt>
1768 <dd>Sets the output scaling factor for use with <a href="#distort">-distort</a></dd>
1769
1770<dt>distort:viewport=WxH+X+Y</dt>
1771 <dd>Sets the viewport for use with <a href="#distort">-distort</a></dd>
1772
cristy045bd902010-01-30 18:56:24 +00001773<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001774<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001775 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001776
cristy045bd902010-01-30 18:56:24 +00001777<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001778<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001779 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001780
cristy045bd902010-01-30 18:56:24 +00001781<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001782<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001783 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001784
cristy045bd902010-01-30 18:56:24 +00001785<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001786<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1787 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001788 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001789
cristy045bd902010-01-30 18:56:24 +00001790<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001791<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1792 compression factor is the reciprocal of the compression ratio. The valid
1793 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1794 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001795 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001796
cristy3ed852e2009-09-05 21:47:34 +00001797<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001798 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001799
cristy045bd902010-01-30 18:56:24 +00001800<dt>png:bit-depth=<em class="arg">value</em></dt>
1801<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001802<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1803 encoder to use a different bit-depth and color-type than it would have
1804 normally selected, but only if this does not cause any loss of image
1805 quality. Any attempt to reduce image quality is treated as an error and no
1806 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1807 can use these "defines" to cause it to be written as an 8-bit grayscale,
1808 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1809 you cannot force it to be written as a grayscale or indexed PNG. If you
1810 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1811 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1812 reduce the image quality prior to using the PNG encoder. Note that in
1813 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001814 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001815 8-bit depth.</dd>
1816
cristya4dfb122011-07-07 19:01:57 +00001817<dt>png:compression-filter=<em class="arg">value</em></dt>
1818 <dd> valid values are 0 through 7. 0-4 are the corresponding PNG filters,
1819 5 means adaptive filtering except for images with a colormap, 6 means
1820 adaptive filtering for all images, 7 means MNG "loco" compression.</dd>
1821
cristy87a7f072011-07-01 00:08:52 +00001822<dt>png:compression-level=<em class="arg">value</em></dt>
1823 <dd> valid values are 0 through 9, with 0 providing the least but fastest
1824 compression and 9 usually providing the best and always the slowest.</dd>
1825
1826<dt>png:compression-strategy=<em class="arg">value</em></dt>
1827 <dd> valid values are 0 through 4, meaning default, filtered, huffman_only,
cristya4dfb122011-07-07 19:01:57 +00001828 rle, and fixed ZLIB compression strategy. If you are using an old zlib
1829 that does not support Z_RLE (before 1.2.0) or Z_FIXED (before 1.2.2.2),
1830 values 3 and 4, respectively, will use the zlib default strategy
1831 instead.</dd>
cristy87a7f072011-07-01 00:08:52 +00001832
cristyeed6cb62012-01-28 19:38:34 +00001833<dt>png:format=<em class="arg">value</em></dt>
1834 <dd> valid values are <em class="arg">png8</em>, <em class="arg">png24</em>,
1835 and <em class="arg">png32</em>. This property can be useful for specifying
1836 the specific PNG format to be used, when the usual method of prepending the
1837 format name to the output filename is inconvenient, such as when writing
1838 a PNG-encoded ICO file.</dd>
1839
cristydcca3fa2010-12-29 21:50:07 +00001840<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1841<dt>png:include-chunk=<em class="arg">value</em></dt>
1842<dd>ancillary chunks to be excluded from or included in PNG output.
1843
1844 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1845 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1846 or the word <em class="arg">all</em> or
1847 the word <em class="arg">none</em>. There must be no spaces in the
1848 list. Although PNG chunk-names are case-dependent, you can use
1849 all lowercase names if you prefer.</p>
1850
cristyd241f442011-03-29 13:50:49 +00001851 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
1852 of the PNG encoder and have no effect on the PNG decoder.</p>
1853
cristydcca3fa2010-12-29 21:50:07 +00001854 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1855 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1856 only be written if gamma is not 1/2.2, since most decoders assume
1857 sRGB and gamma=1/2.2 when no colorspace information is included in
1858 the PNG file. Because the list is processed from left to right, you
1859 can achieve this with a single define:</p>
1860
1861<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001862 -define png:include-chunk=none,gAMA
cristydcca3fa2010-12-29 21:50:07 +00001863</pre>
1864
cristyeed6cb62012-01-28 19:38:34 +00001865 <p>As a special case, if the <kbd>sRGB</kbd> chunk is not excluded and
1866 the PNG encoder recognizes that the image contains the sRGB ICC profile,
1867 the PNG encoder will write the <kbd>sRGB</kbd> chunk instead of the entire
1868 3144-byte ICC profile. To force the PNG encoder to write the sRGB
1869 profile as an <kbd>iCCP</kbd> chunk in the output PNG instead of the
1870 <kbd>sRGB</kbd> chunk, exclude the <kbd>sRGB</kbd> chunk.</p>
1871
cristydcca3fa2010-12-29 21:50:07 +00001872 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
cristya4dfb122011-07-07 19:01:57 +00001873 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any such
1874 entries appearing in the list will be ignored.</p>
cristydcca3fa2010-12-29 21:50:07 +00001875
1876 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1877 image has transparency, the PNG colortype is forced to be 4 or 6
1878 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1879 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1880 on the PNG colortype of the output image.</p>
1881
1882 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1883 following for PNG output:</p>
1884
1885<pre class="text">
cristyeed6cb62012-01-28 19:38:34 +00001886 -define png:include-chunk=none,trns,gama
cristydcca3fa2010-12-29 21:50:07 +00001887</pre>
1888
1889 <p>The default behavior is to include all known PNG ancillary chunks
cristyf7964272011-01-30 03:49:12 +00001890 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk,
1891 and to exclude all PNG chunks that are unknown to ImageMagick,
1892 regardless of their PNG "copy-safe" status as described in the
1893 PNG specification.</p>
cristyd241f442011-03-29 13:50:49 +00001894
1895 <p>Any chunk names that are not known to ImageMagick are ignored
1896 if they appear in either the "include-chunk" or "exclude-chunk" list.
1897 The ancillary chunks currently known to ImageMagick are
1898 <kbd>bKGD</kbd>, <kbd>cHRM</kbd>, <kbd>gAMA</kbd>, <kbd>iCCP</kbd>,
1899 <kbd>oFFs</kbd>, <kbd>pHYs</kbd>, <kbd>sRGB</kbd>, <kbd>tEXt</kbd>,
1900 <kbd>tRNS</kbd>, <kbd>vpAg</kbd>, and <kbd>zTXt</kbd>.</p>
1901
cristyf9a6c462011-04-24 14:01:11 +00001902 <p>You can also put <kbd>date</kbd> in the list to include or exclude
1903 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
1904 inserts in the output PNG.</p>
1905
1906</dd>
1907
1908<dt>png:preserve-colormap</dt>
1909 <dd>Use the existing image->colormap. Normally the PNG encoder will
1910 try to optimize the palette, eliminating unused entries and putting
1911 the transparent colors first. If this flag is set, that behavior
1912 is suppressed.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001913
cristy3ed852e2009-09-05 21:47:34 +00001914<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001915<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1916 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001917 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001918
cristy045bd902010-01-30 18:56:24 +00001919<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001920<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1921 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1922 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001923 included, the result is a single precision floating point format.
1924 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001925 double precision floating point format.</dd>
1926
cristyeed6cb62012-01-28 19:38:34 +00001927<dt>showkernel=1</em></dt>
1928 <dd>Outputs (to 'standard error') all the information about a generated <a href="#morphology">-morphology</a> kernel.</dd>
1929
1930<dt>tiff:quantum:polarity=min-is-black
1931<br />
1932tiff:quantum:polarity=min-is-white</dt>
1933 <dd>Toggles the photometric interpretation</dd>
1934
1935<dt>tiff:rows-per-strip=<em class="arg">value</em></dt>
1936 <dd>Sets the number of rows per strip</dd>
1937
1938<dt>tiff:tile-geometry=<em class="arg">WxH</em></dt>
1939 <dd>Sets the tile size for pyramid tiffs. Requires the suffix PTIF: before the outputname</dd>
1940
1941
cristydcca3fa2010-12-29 21:50:07 +00001942</dl>
cristy3ed852e2009-09-05 21:47:34 +00001943
cristyd0bda5e2010-09-21 16:22:45 +00001944<p>For example, to create a postscript file that will render only the black
1945pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001946
cristyeed6cb62012-01-28 19:38:34 +00001947<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert bilevel.tif -define ps:imagemask eps3:stencil.ps</span></p>
cristyd0bda5e2010-09-21 16:22:45 +00001948<p>Set attributes of the image registry by prefixing the value with
1949<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1950use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001951
1952<p class="crtsnip">
1953-define registry:temporary-path=/data/tmp
1954</p>
1955
cristyd0bda5e2010-09-21 16:22:45 +00001956
1957
cristy3ed852e2009-09-05 21:47:34 +00001958<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001959 <h4><a id="delay"></a>-delay <em class="arg">ticks</em> <br />-delay <em class="arg">ticks</em>x<em class="arg">ticks-per-second</em> {<em class="arg">&lt;</em>} {<em class="arg">&gt;</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00001960</div>
1961
1962<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>display the next image after pausing.</td><td style='text-align:right;'></td></tr></table>
1963
1964<p>This option is useful for regulating the animation of image sequences <em>ticks/ticks-per-second</em> seconds must expire before the display of the next image. The default is no delay between each showing of the image sequence. The default ticks-per-second is 100.</p>
1965
1966<p>Use <kbd>&gt;</kbd> to change the image delay <em>only</em> if its current value exceeds the given delay. <kbd>&lt;</kbd> changes the image delay <em>only</em> if current value is less than the given delay. For example, if you specify <kbd>30&gt;</kbd> and the image delay is 20, the image delay does not change. However, if the image delay is 40 or 50, the delay it is changed to 30. Enclose the given delay in quotation marks to prevent the <kbd>&lt;</kbd> or <kbd>&gt;</kbd> from being interpreted by your shell as a file redirection.</p>
1967
1968
1969<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00001970 <h4><a id="delete"></a>-delete <em class="arg">indexes</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001971</div>
1972
1973<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>delete the image, specified by its index, from the image sequence.</td><td style='text-align:right;'></td></tr></table>
1974
1975<p>Specify the image by its index in the sequence. The first image is index 0. Negative indexes are relative to the end of the sequence, for example, -1 represents the last image of the sequence. Specify a range of images with a dash (e.g. 0-4). Separate indexes with a comma (e.g. 0,2). Use <kbd>+delete</kbd> to delete the last image in the current image sequence.</p>
1976
1977
1978<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001979 <h4><a id="density"></a>-density <em class="arg">width</em><br />-density <em class="arg">width</em>x<em class="arg">height</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001980</div>
1981
1982<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the horizontal and vertical resolution of an image for rendering to devices.</td><td style='text-align:right;'></td></tr></table>
1983
1984<p>This option specifies the image resolution to store while encoding a raster image or the canvas resolution while rendering (reading) vector formats such as Postscript, PDF, WMF, and SVG into a raster image. Image resolution provides the unit of measure to apply when rendering to an output device or raster image. The default unit of measure is in dots per inch (DPI). The <a href="#units">-units</a> option may be used to select dots per centimeter instead.</p>
1985
1986<p>The default resolution is 72 dots per inch, which is equivalent to one point per pixel (Macintosh and Postscript standard). Computer screens are normally 72 or 96 dots per inch, while printers typically support 150, 300, 600, or 1200 dots per inch. To determine the resolution of your display, use a ruler to measure the width of your screen in inches, and divide by the number of horizontal pixels (1024 on a 1024x768 display).</p>
1987
1988<p>If the file format supports it, this option may be used to update the stored image resolution. Note that Photoshop stores and obtains image resolution from a proprietary embedded profile. If this profile is not stripped from the image, then Photoshop will continue to treat the image using its former resolution, ignoring the image resolution specified in the standard file header.</p>
1989
1990<p>The <a href="#density">-density</a> option sets an <em>attribute</em> and does not alter the underlying raster image. It may be used to adjust the rendered size for desktop publishing purposes by adjusting the scale applied to the pixels. To resize the image so that it is the same size at a different resolution, use the <a href="#resample">-resample</a> option.</p>
1991
1992<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001993 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001994</div>
1995
1996<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>depth of the image.</td><td style='text-align:right;'></td></tr></table>
1997
1998<p>This the number of bits in a color sample within a pixel. Use this option to specify the depth of raw images whose depth is unknown such as GRAY, RGB, or CMYK, or to change the depth of any image after it has been read.</p>
1999
2000<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002001 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00002002</div>
2003
2004<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>obtain image by descending window hierarchy.</td><td style='text-align:right;'></td></tr></table>
2005
2006<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002007 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002008</div>
2009
2010<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>straighten an image. A threshold of 40% works for most images.</td><td style='text-align:right;'></td></tr></table>
2011
2012<p>Use <a href="#set">-set</a> <kbd>option:deskew:auto-crop <em>width</em></kbd> to auto crop the image. The set argument is the pixel width of the image background (e.g 40).</p>
2013
2014<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002015 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00002016</div>
2017
2018<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>reduce the speckles within an image.</td><td style='text-align:right;'></td></tr></table>
2019
2020<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002021 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00002022</div>
2023
2024<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>render text right-to-left or left-to-right.</td><td style='text-align:right;'></td></tr></table>
2025
2026<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002027 <h4><a id="displace"></a>-displace <em class="arg">horizontal-scale</em><br />-displace <em class="arg">horizontal-scale</em>x<em class="arg">vertical-scale</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002028</div>
2029
2030<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>shift image pixels as defined by a displacement map.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
2031
2032<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00002033is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00002034what part of the 'background' image is seen at each point of the overlaid
2035area. Much like the displacement map is a 'lens' that redirects light shining
2036through it so as to present a distorted view the original 'background' image
2037behind it. </p>
2038
2039<p>Any perfect grey areas of the displacement map produce a zero
2040displacement of the image. Black areas produce the given maximum negative
2041displacement of the lookup point, while white produce a maximum positive
2042displacement of the lookup. </p>
2043
2044<p>Note that it is the lookup of the 'background' that is displaced, not a
2045displacement of the image itself. As such an area of the displacement map
2046containing 'white' will have the lookup point 'shifted' by a positive amount,
2047and thus generating a copy of the destination image to the right/downward from
2048the correct position. That is the image will look like it may have been
2049'shifted' in a negative left/upward direction. Understanding this is a very
2050important in understanding how displacement maps work. </p>
2051
2052<p>The given arguments define the maximum amount of displacement in pixels
2053that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00002054it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00002055outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00002056easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00002057into the overlay area. </p>
2058
2059<p>The '%' flag makes the displacement scale relative to the size of the
2060overlay image (100% = half width/height of image). Using '!' switches
2061percentage arguments to refer to the destination image size instead.
2062these flags were added as of IM v6.5.3-5.</p>
2063
2064<p>Normally a single grayscale displacement map is provided, which with the
2065given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00002066displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00002067specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00002068the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00002069displacement, while the <em class="arg">mask image</em> is used for vertical Y
2070displacement. This allows you to define completely different displacement
2071values for the X and Y directions, and allowing you to lookup any point within
2072the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00002073any other nearby pixel, producing complex 2 dimensional displacements, rather
2074than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00002075
cristyeed6cb62012-01-28 19:38:34 +00002076<p>Alternatively rather than supplying two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00002077you can use the 'red' channel of the overlay image to specify the horizontal
2078or X displacement, and the 'green' channel for the vertical or Y displacement.
2079</p>
2080
cristyd0bd44a2010-09-24 12:38:11 +00002081<p>As of IM v6.5.3-5 any alpha channel in the overlay image is used as a
cristy3ed852e2009-09-05 21:47:34 +00002082mask the transparency of the destination image. However areas outside the
2083overlaid areas will not be effected. </p>
2084
2085
2086<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002087 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002088</div>
2089
2090<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specifies the X server to contact.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>]</td></tr></table>
2091
2092<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
2093
2094<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002095 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002096</div>
2097
2098<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>define the GIF disposal image setting for images that are being created or read in. </td><td style='text-align:right;'></td></tr></table>
2099
2100<p>The layer disposal method defines the way each the displayed image is to be
2101modified after the current 'frame' of an animation has finished being
2102displayed (after its 'delay' period), but before the next frame on an
2103animation is to be overlaid onto the display. </p>
2104
2105<p>Here are the valid methods:</p>
2106
2107<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002108 Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
2109 None 1 Do not dispose, just overlay next frame image.
2110 Background 2 Clear the frame area with the background color.
2111 Previous 3 Clear to the image prior to this frames overlay.
cristy3ed852e2009-09-05 21:47:34 +00002112</pre>
2113
2114<p>You can also use the numbers given above, which is what the GIF format
2115uses internally to represent the above settings. </p>
2116
cristyd0bda5e2010-09-21 16:22:45 +00002117<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002118
2119<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
2120resetting the layer disposal methods of images being read in. </p>
2121
2122<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
2123disposal method for images already in memory.</p>
2124
2125<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002126 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002127</div>
2128
2129<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>maximum RMSE for subimage match (default 0.2).</td><td style='text-align:right;'>[<a href="../www/compare.html">compare</a>]</td></tr></table>
2130
2131
2132<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002133 <h4><a id="dissolve"></a>-dissolve <em class="arg">src_percent</em>[x<em class="arg">dst_percent</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00002134</div>
2135
2136<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>dissolve an image into another by the given percent.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
2137
2138<p>The opacity of the composite image is multiplied by the given percent, then
2139it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00002140is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00002141transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
2142are given, each image are dissolved to the percentages given. </p>
2143
2144<p>Note that dissolve percentages do not add, two opaque images dissolved
2145'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2146images, you would need to use dissolve values of '50,100'. </p>
2147
2148<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002149 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002150</div>
2151
2152<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>distort an image, using the given <em class="arg">method</em> and its required <em class="arg">arguments</em>.</td><td style='text-align:right;'></td></tr></table>
2153
2154<p>The <em class="arg">arguments</em> is a single string containing a list
2155of floating point numbers separated by commas or spaces. The number of
2156and meaning of the floating point values depends on the distortion <em
2157class="arg">method</em> being used. </p>
2158
2159<p>Choose from these distortion types:</p>
2160
2161<table class="doc">
2162 <tr valign="top">
2163 <th align="left" style="width: 8%">Method</th>
2164 <th align="left">Description</th>
2165 </tr>
2166
2167 <tr valign="top">
2168 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
2169 <br/>or &nbsp; <kbd>SRT</kbd></td>
2170 <td valign="top">
2171 Distort image by first scaling and rotating about a given 'center',
2172 before translating that 'center' to the new location, in that order. It
2173 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
2174 distortion, but without shearing effects. It also provides a good way
2175 of rotating and displacing a smaller image for tiling onto a larger
2176 background (IE 2-dimensional animations). <br/>
2177
2178 The number of arguments determine the specific meaning of each
2179 argument for the scales, rotation, and translation operations. <br/>
2180
2181 <table style="margin-left:auto; margin-right:auto;">
2182 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
2183 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
2184 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00002185 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002186 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
2187 <tr><td>5:</td>
2188 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2189 <tr><td>6:</td>
2190 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
2191 <tr><td>7:</td>
2192 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
2193 &nbsp; NewX,NewY</em></td></tr>
2194 </table>
2195
cristyd0bda5e2010-09-21 16:22:45 +00002196 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00002197 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2198
2199 <tr valign="top">
2200 <td valign="top"><kbd>Affine</kbd></td>
2201 <td valign="top">
2202 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002203 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002204 point values are given allowing the image to be linearly scaled,
2205 rotated, sheared, and translated, according to those three points. See
2206 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2207 distortions. <br/>
2208
2209 More than 3 sets given control point pairs (12 numbers) is least
cristyeed6cb62012-01-28 19:38:34 +00002210 squares fitted to best match a linear affine distortion. If only 2
cristy3ed852e2009-09-05 21:47:34 +00002211 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002212 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002213 flipping or changes in aspect ratio to the resulting image. If only one
2214 control point pair is provides the image is only translated, (which may
2215 be a floating point non-integer translation). <br/>
2216
2217 This distortion does not include any form of perspective distortion.
2218 </td>
2219
2220 </tr>
2221
2222 <tr valign="top">
2223 <td valign="top"><kbd>AffineProjection</kbd></td>
2224 <td valign="top">
2225 Linearly distort an image using the given Affine Matrix of 6
2226 pre-calculated coefficients forming a set of Affine Equations to map
2227 the source image to the destination image.
2228
2229 <div style="text-align: center"><em>
2230 s<sub>x</sub>, r<sub>x</sub>,
2231 r<sub>y</sub>, s<sub>y</sub>,
2232 t<sub>x</sub>, t<sub>y</sub>
2233 </em></div>
2234
2235 See <a href="#affine" >-affine</a> setting for more detail, and
2236 meanings of these coefficients. <br/>
2237
2238 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002239 alternative methods of defining this distortion, with ImageMagick doing
2240 the calculations needed to generate the required coefficients. You can
2241 see the internally generated coefficients, by using a <a
cristyeed6cb62012-01-28 19:38:34 +00002242 href="#verbose" >-verbose</a> setting with those other variants. </td>
cristy3ed852e2009-09-05 21:47:34 +00002243
2244 </tr>
2245
cristy3ed852e2009-09-05 21:47:34 +00002246 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002247 <td valign="top"><kbd>BilinearForward</kbd><br/>
2248 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002249 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002250 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2251 16 values (see below). Not that lines may not appear straight after
2252 distortion, though the distance between coordinates will remain
2253 consistent. <br/>
2254
2255 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2256 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
cristyeed6cb62012-01-28 19:38:34 +00002257 quadrilateral to a rectangle, while preserving the straight line edges
cristyd0bd44a2010-09-24 12:38:11 +00002258 in each case. <br/>
2259
2260 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2261 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
cristyeed6cb62012-01-28 19:38:34 +00002262 color setting. Also if the quadrilateral becomes 'flipped' the image
2263 may disappear. <br/>
cristyd0bd44a2010-09-24 12:38:11 +00002264
2265 There are future plans to produce a true Bilinear distortion that will
2266 attempt to map any quadrilateral to any other quadrilateral, while
2267 preserving edges (and edge distance ratios).
2268
2269 </td>
cristy3ed852e2009-09-05 21:47:34 +00002270 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002271
2272 <tr valign="top">
2273 <td valign="top"><kbd>Perspective</kbd></td>
2274 <td valign="top">
2275 Perspective distort the images, using a list of 4 or more sets of
2276 control points (as defined below). More that 4 sets (16 numbers) of
2277 control points provide least squares fitting for more accurate
cristyeed6cb62012-01-28 19:38:34 +00002278 distortions (for the purposes of image registration and panorama
cristy3ed852e2009-09-05 21:47:34 +00002279 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2280 linear distortion. <br/>
2281
2282 Perspective Distorted images ensures that straight lines remain
2283 straight, but the scale of the distorted image will vary. The horizon
2284 is anti-aliased, and the 'sky' color may be set using the
2285 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2286 </tr>
2287
2288 <tr valign="top">
2289 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2290 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002291 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002292 pre-calculated coefficients. You can get these coefficients by looking
2293 at the <a href="#verbose" >-verbose</a> output of a
cristyeed6cb62012-01-28 19:38:34 +00002294 '<kbd>Perspective</kbd>' distortion, or by calculating them yourself.
cristy3ed852e2009-09-05 21:47:34 +00002295 If the last two perspective scaling coefficients are zero, the
2296 remaining 6 represents a transposed 'Affine Matrix'. </td>
2297
2298 </tr>
2299
2300 <tr valign="top">
2301 <td valign="top"><kbd>Arc</kbd></td>
2302 <td valign="top">
2303 Arc the image (variation of polar mapping) over the angle given around
2304 a circle. <br/>
2305 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2306 <tr valign="top"><td>Argument</td>
2307 <td>Meaning</td></tr>
2308 <tr valign="top"><td><em>arc_angle</em></td>
2309 <td>The angle over which to arc the image side-to-side</td></tr>
2310 <tr valign="top"><td><em>rotate_angle</em></td>
2311 <td>Angle to rotate resulting image from vertical center</td></tr>
2312 <tr valign="top"><td><em>top_radius</em></td>
2313 <td>Set top edge of source image at this radius</td></tr>
2314 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2315 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2316 </table>
2317
2318 The resulting image is always resized to best fit the resulting image,
2319 (as if using <a href="#distort" >+distort</a>) while attempting to
2320 preserve scale and aspect ratio of the original image as much as
2321 possible with the arguments given by the user. All four arguments will
2322 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2323
2324 This a variation of a polar distortion designed to try to preserve the
2325 aspect ratio of the image rather than direct Cartesian to Polar
2326 conversion. </td>
2327 </tr>
2328
2329 <tr valign="top">
2330 <td valign="top"><kbd>Polar</kbd></td>
2331 <td valign="top">
2332 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2333 the image. that is the height of the input image is mapped to the
2334 radius limits, while the width is wrapped around between the
2335 angle limits. <br/>
2336
2337 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2338
2339 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2340 center to the center of the image, and the angles going from -180 (top)
2341 to +180 (top). If <em>Rmax</em> is given the special value of
2342 '<code>0</code>', the the distance from the center to the nearest edge
2343 is used for the radius of the output image, which will ensure the whole
2344 image is visible (though scaled smaller). However a special value of
2345 '<code>-1</code>' will use the distance from the center to the furthest
2346 corner, This may 'clip' the corners from the input rectangular image,
2347 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2348 the same arguments. <br/>
2349
2350 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2351 output image center will default to <code>0,0</code> of the virtual
2352 canvas, and the image size adjusted to ensure the whole input image is
2353 made visible in the output image on the virtual canvas. </td>
2354
2355 </tr>
2356
2357 <tr valign="top">
2358 <td valign="top"><kbd>DePolar</kbd></td>
2359 <td valign="top">
2360 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2361 but generates the reverse Polar to Cartesian distortion. <br/>
2362
2363 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2364 the corners of the input image. However using the special
2365 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2366 distance) will ensure the whole distorted image is preserved in the
2367 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2368 reverse the distortion re-producing the original.
2369
2370 Note that as this distortion requires the area resampling of a circular
2371 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002372 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002373 form of 'super-sampling' image processing technique be used to produce
2374 a high quality result. </td>
2375
2376 </tr>
2377
2378 <tr valign="top">
2379 <td valign="top"><kbd>Barrel</kbd></td>
2380 <td valign="top">
2381 Given the four coefficients (A,B,C,D) as defined by <a
cristy6bcf48e2011-02-15 19:09:04 +00002382 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
cristyeed6cb62012-01-28 19:38:34 +00002383 Dersch</a>, perform a barrel or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002384 correct radial lens distortions. That is in photographs, make straight
2385 lines straight again. <br/>
2386
2387 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2388 <em>X</em> , <em>Y</em> ] ] <br/>
2389 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2390 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2391 [ <em>X</em> , <em>Y</em> ] <br/>
2392 So that it forms the function <br/>
2393 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2394 <em>C</em>*r + <em>D</em> )<br/>
2395
2396 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2397 (defaulting to the center of the image). <br/>
2398 The second form is typically used to distort images, rather than
2399 correct lens distortions. <br/>
2400 </td>
2401
2402 </tr>
2403
2404 <tr valign="top">
2405 <td valign="top"><kbd>BarrelInverse</kbd></td>
2406 <td valign="top">
cristyeed6cb62012-01-28 19:38:34 +00002407 This is very similar to '<kbd>Barrel</kbd>' with the same set of
cristy3ed852e2009-09-05 21:47:34 +00002408 arguments, and argument handling. However it uses the inverse
2409 of the radial polynomial,
2410 so that it forms the function <br/>
2411 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002412 <em>C</em>*r + <em>D</em> )<br/>
2413 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2414 distortion, just a different barrel-like radial distortion method.
2415
cristy3ed852e2009-09-05 21:47:34 +00002416 </td>
2417 </tr>
2418
2419 <tr valign="top">
2420 <td valign="top"><kbd>Shepards</kbd></td>
2421 <td valign="top">
2422 Distort the given list control points (any number) using an Inverse
2423 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002424 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2425 Method</a>). The control points in effect do 'localized' displacement
2426 of the image around the given control point (preserving the look and
2427 the rotation of the area near the control points. For best results
2428 extra control points should be added to 'lock' the positions of the
2429 corners, edges and other unchanging parts of the image, to prevent
2430 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002431
cristyd0bd44a2010-09-24 12:38:11 +00002432 The distortion has been likened to 'taffy pulling' using nails, or
2433 pins' stuck in a block of 'jelly' which is then moved to the new
cristyeed6cb62012-01-28 19:38:34 +00002434 position, distorting the surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002435
cristybaacd172011-04-30 23:11:03 +00002436 Internally it is equivalent to generating a displacement map (see <a
cristyd0bd44a2010-09-24 12:38:11 +00002437 href="#displace" >-displace</a>) for source image color look-up using
2438 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2439
2440 </td>
cristy3ed852e2009-09-05 21:47:34 +00002441 </tr>
2442
2443</table>
2444
cristyd0bd44a2010-09-24 12:38:11 +00002445<p>To print a complete list of distortion methods, use <a href="#list">-list
2446distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002447
2448<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2449'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2450defining how these points in the given image should be distorted in the
2451destination image. Each set of four floating point values represent a source
2452image coordinate, followed immediately by the destination image coordinate.
2453This produces a list of values such as...</p>
2454<div style="text-align: center"><em>
2455 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2456 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2457 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2458 ... &nbsp;
2459 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2460</em></div>
2461<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2462destination image. </p>
2463
2464<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2465needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2466perspective distortion of the built-in "rose:" image. Note how spaces were
2467used to group the 4 sets of coordinate pairs, to make it easier to read and
2468understand.</p>
2469
cristyeed6cb62012-01-28 19:38:34 +00002470<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002471convert rose: -virtual-pixel black \<br/>
2472 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2473 rose_3d_rotated.gif</span></p>
2474<p>If more that the required number of coordinate pairs are given for
2475a distortion, the distortion method is 'least squares' fitted to produce the
2476best result for all the coordinate pairs given. If less than the ideal number
2477of points are given, the distort will generally fall back to a simpler form of
cristyeed6cb62012-01-28 19:38:34 +00002478distortion that can handles the smaller number of coordinates (usually a linear
cristyd0bd44a2010-09-24 12:38:11 +00002479'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002480
cristyd0bda5e2010-09-21 16:22:45 +00002481<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002482find matching coordinate pairs in overlapping images, so as to improve the
2483'fit' of the distortion. Of course a bad coordinate pair can also make the
2484'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002485
2486<p>Colors are acquired from the source image according to the <a
2487href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002488magnified. However if the viewed image is minified (image becomes smaller),
2489a special area resampling function (added ImageMagick v6.3.5-9), is used to
2490produce a higher quality image. For example you can use
2491a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2492the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002493
cristyeed6cb62012-01-28 19:38:34 +00002494<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002495convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2496 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2497 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002498<p>Note that a infinitely tiled perspective images involving the horizon can
2499be very slow to generate due to the use of the high quality 'area resampling'
2500function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2501using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2502(recommended if you plan to use super-sampling instead). </p>
2503
2504<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2505'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2506will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2507pixels. If you do not what these pixels to be visible, set the color to match
2508the rest of the ground. </p>
2509
2510<p>The output image size will by default be the same as the input image. This
2511means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002512the 'distorted space', those parts is clipped and lost. However if you use
2513the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2514will attempt (if possible) to show the whole of the distorted image, while
2515retaining a correct 'virtual canvas' offset, for image layering. This offset
2516may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2517is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002518
2519<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2520option:distort:viewport {geometry_string}</kbd>" setting which will specify
2521the size and the offset of the generated 'viewport' image of the distorted
2522image space.</p>
2523
2524<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2525{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2526that factor without changing the viewed contents of the distorted image. This
2527can be used either for 'super-sampling' the image for a higher quality result,
2528or for panning and zooming around the image (with appropriate viewport
2529changes, or post-distort cropping and resizing). </p>
2530
2531<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2532href="#distort" >-distort</a> to attempt to output the internal coefficients,
2533and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2534and debugging purposes. This many not be available for all distorts. </p>
2535
2536<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2537produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2538and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002539above settings. It is algorithmically slower however, though that may not be
2540the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002541
2542
2543<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002544 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002545</div>
2546
2547<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Apply a Riemersma or Floyd-Steinberg error diffusion dither to images when general color reduction is applied via an option, or automagically when saving to specific formats. This enabled by default. </td><td style='text-align:right;'></td></tr></table>
2548
cristyd0bda5e2010-09-21 16:22:45 +00002549<p>Dithering places two or more colors in neighboring pixels so that to the eye a closer approximation of the images original color is reproduced. This reduces the number of colors needed to reproduce the image but at the cost of a lower level pattern of colors. Error diffusion dithers can use any set of colors (generated or user defined) to an image. </p>
cristy3ed852e2009-09-05 21:47:34 +00002550
2551<p>Dithering is turned on by default, to turn it off use the plus form of the
2552setting, <a href="#dither">+dither</a>. This will also also render PostScript
2553without text or graphic aliasing. Disabling dithering often (but not always)
2554leads to faster process, a smaller number of colors, but more cartoon like
2555image coloring. Generally resulting in 'color banding' effects in areas with
2556color gradients. </p>
2557
2558<p>The color reduction operators <a href="#colors">-colors</a>, <a
2559href="#monochrome">-monochrome</a>, <a href="#remap ">-remap</a>, and <a href="#posterize">-posterize</a>, apply dithering to images using the reduced color set they created. These operators are also used as part of automatic color reduction when saving images to formats with limited color support, such as <kbd>GIF:</kbd>, <kbd>XBM:</kbd>, and others, so dithering may also be used in these cases. </p>
2560
2561<p>Alternatively you can use <a href="#random-threshold">-random-threshold</a> to generate purely random dither. Or use <a href="#ordered-dither">-ordered-dither</a> to apply threshold mapped dither patterns, using uniform color maps, rather than specific color maps. </p>
2562
2563
2564<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002565 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002566</div>
2567
2568<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Annotate an image with one or more graphic primitives.</td><td style='text-align:right;'></td></tr></table>
2569
2570<p>Use this option to annotate or decorate an image with one or more graphic primitives. The primitives include shapes, text, transformations, and pixel operations.</p>
2571
2572<p>The shape primitives:</p>
2573
2574<pre class="text">
2575 point x,y
2576 line x0,y0 x1,y1
2577 rectangle x0,y0 x1,y1
2578 roundRectangle x0,y0 x1,y1 wc,hc
2579 arc x0,y0 x1,y1 a0,a1
2580 ellipse x0,y0 rx,ry a0,a1
2581 circle x0,y0 x1,y1
2582 polyline x0,y0 ... xn,yn
2583 polygon x0,y0 ... xn,yn
2584 bezier x0,y0 ... xn,yn
2585 path path specification
2586 image operator x0,y0 w,h filename
2587</pre>
2588
2589<p>The text primitive:</p>
2590
2591<pre class="text">
2592 text x0,y0 string
2593</pre>
2594<p>The text gravity primitive:</p>
2595
2596<pre class="text">
2597 gravity NorthWest, North, NorthEast, West, Center,
2598 East, SouthWest, South, or SouthEast
2599</pre>
2600
2601<p>The text gravity primitive only affects the placement of text and does not interact with the other primitives. It is equivalent to using the <a href="#gravity">-gravity</a> command-line option, except that it is limited in scope to the <a href="#draw">-draw</a> option in which it appears.</p>
2602
2603<p>The transformation primitives:</p>
2604
2605<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002606 rotate degrees
2607 translate dx,dy
2608 scale sx,sy
2609 skewX degrees
2610 skewY degrees
cristy3ed852e2009-09-05 21:47:34 +00002611</pre>
2612
2613<p>The pixel operation primitives:</p>
2614
2615<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002616 color x0,y0 method
2617 matte x0,y0 method
cristy3ed852e2009-09-05 21:47:34 +00002618</pre>
2619
2620<p>The shape primitives are drawn in the color specified by the preceding <a href="#fill">-fill</a> setting. For unfilled shapes, use <a href="#fill">-fill none</a>. You can optionally control the stroke (the "outline" of a shape) with the <a href="#stroke">-stroke</a> and <a href="#strokewidth">-strokewidth</a> settings.</p>
2621
2622<p>A <kbd>point</kbd> primitive is specified by a single <em>point</em> in the pixel plane, that is, by an ordered pair of integer coordinates, <em>x</em>,<em>y</em>. (As it involves only a single pixel, a <kbd>point</kbd> primitive is not affected by <a href="#stroke">-stroke</a> or <a href="#strokewidth">-strokewidth</a>.)</p>
2623
2624<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2625
2626<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2627
2628<p>A <kbd>roundRectangle</kbd> primitive takes the same corner points as a <kbd>rectangle</kbd> followed by the width and height of the rounded corners to be removed.</p>
2629
2630<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2631
2632<p>The <kbd>arc</kbd> primitive is used to inscribe an elliptical segment in to a given rectangle. An <kbd>arc</kbd> requires the two corners used for <kbd>rectangle</kbd> (see above) followed by the start and end angles of the arc of the segment segment (e.g. 130,30 200,100 45,90). The start and end points produced are then joined with a line segment and the resulting segment of an ellipse is filled.</p>
2633
2634<p>Use <kbd>ellipse</kbd> to draw a partial (or whole) ellipse. Give the center point, the horizontal and vertical "radii" (the <em>semi-axes</em> of the ellipse) and start and end angles in degrees (e.g. 100,100 100,150 0,360).</p>
2635
2636<p>The <kbd>polyline</kbd> and <kbd>polygon</kbd> primitives require three or more points to define their perimeters. A <kbd>polyline</kbd> is simply a <kbd>polygon</kbd> in which the final point is not stroked to the start point. When unfilled, this is a <em>polygonal line</em>. If the <a href="#stroke">-stroke</a> setting is <kbd>none</kbd> (the default), then a <kbd>polyline</kbd> is identical to a <kbd>polygon</kbd>.
2637</p>
2638
2639<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2640
2641<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2642
2643<p class="crtsnip">
2644 -draw 'circle 100,100 150,150'
2645</p>
2646
2647<p>The <kbd>Bezier</kbd> primitive creates a spline curve and requires three or points to define its shape. The first and last points are the <em>knots</em> and these points are attained by the curve, while any intermediate coordinates are <em>control points</em>. If two control points are specified, the line between each end knot and its sequentially respective control point determines the tangent direction of the curve at that end. If one control point is specified, the lines from the end knots to the one control point determines the tangent directions of the curve at each end. If more than two control points are specified, then the additional control points act in combination to determine the intermediate shape of the curve. In order to
2648draw complex curves, it is highly recommended either to use the <kbd>path</kbd> primitive or to draw multiple four-point bezier segments with the start and end knots of each successive segment repeated. For example:</p>
2649
2650<p class="crtsnip">
2651 -draw 'bezier 20,50 45,100 45,0 70,50'
2652</p>
2653<p class="crtsnip">
2654 -draw 'bezier 70,50 95,100 95,0 120,50'
2655</p>
2656
2657
2658<p>A <kbd>path</kbd> represents an outline of an object, defined in terms of moveto (set a new current point), lineto (draw a straight line), curveto (draw a Bezier curve), arc (elliptical or circular arc) and closepath (close the current shape by drawing a line to the last moveto) elements. Compound paths (i.e., a path with subpaths, each consisting of a single moveto followed by one or more line or curve operations) are possible to allow effects such as <em>donut holes</em> in objects. (See <a href="http://www.w3.org/TR/SVG/paths.html">Paths</a>.)</p>
2659
2660<p>Use <kbd>image</kbd> to composite an image with another image. Follow the image keyword with the composite operator, image location, image size, and filename:</p>
2661
2662<p class="crtsnip">
2663 -draw 'image SrcOver 100,100 225,225 image.jpg'
2664</p>
2665
cristybc9539a2010-08-16 18:06:20 +00002666<p>You can use 0,0 for the image size, which means to use the actual
2667dimensions found in the image header. Otherwise, it is scaled to the given
2668dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
cristy29c5c992011-06-25 13:58:49 +00002669a detailed discussion of alpha composition methods that are available.
2670The "special augmented compose operators" such as "dissolve" that require
2671arguments cannot be used at present with the <kbd>-draw image</kbd> option.
2672 </p>
cristy3ed852e2009-09-05 21:47:34 +00002673<p>Use <kbd>text</kbd> to annotate an image with text. Follow the text coordinates with a string. If the string has embedded spaces, enclose it in single or double quotes.</p>
2674
2675<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2676
2677<p class="crtsnip">
cristy4bf6e232011-05-21 01:43:33 +00002678 -draw "text 100,100 'Works like magick!' "
cristy3ed852e2009-09-05 21:47:34 +00002679</p>
2680
2681<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2682
2683<p>The <kbd>rotate</kbd> primitive rotates subsequent shape primitives and text primitives about the origin of the main image. If the <a href="#region">-region</a> option precedes the <a href="#draw">-draw</a> option, the origin for transformations is the upper left corner of the region.</p>
2684
2685<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2686
2687<p>The <kbd>scale</kbd> primitive scales them.</p>
2688
2689<p>The <kbd>skewX</kbd> and <kbd>skewY</kbd> primitives skew them with respect to the origin of the main image or the region.</p>
2690
2691<p>The transformations modify the current affine matrix, which is initialized from the initial affine matrix defined by the <a href="#affine">-affine</a> option. Transformations are cumulative within the <a href="#draw">-draw</a> option. The initial affine matrix is not affected; that matrix is only changed by the appearance of another <a href="#affine">-affine</a> option. If another <a href="#draw">-draw</a> option appears, the current affine matrix is reinitialized from the initial affine
2692matrix.</p>
2693
2694<p>Use the <kbd>color</kbd> primitive to change the color of a pixel to the fill color (see <a href="#fill">-fill</a>). Follow the pixel coordinate with a method:</p>
2695
2696<pre class="text">
2697 point
2698 replace
2699 floodfill
2700 filltoborder
2701 reset
2702</pre>
2703
2704<p>Consider the target pixel as that specified by your coordinate. The <kbd>point</kbd> method recolors the target pixel. The <kbd>replace</kbd> method recolors any pixel that matches the color of the target pixel. <kbd>Floodfill</kbd> recolors any pixel that matches the color of the target pixel and is a neighbor, whereas <kbd>filltoborder</kbd> recolors any neighbor pixel that is not the border color. Finally, <kbd>reset</kbd> recolors all pixels.</p>
2705
2706<p>Use <kbd>matte</kbd> to the change the pixel matte value to transparent. Follow the pixel coordinate with a method (see the <kbd>color</kbd> primitive for a description of methods). The <kbd>point</kbd> method changes the matte value of the target pixel. The <kbd>replace</kbd> method changes the matte value of any pixel that matches the color of the target pixel. <kbd>Floodfill</kbd> changes the matte value of any pixel that matches the color of the target pixel and is a neighbor, whereas <kbd>filltoborder</kbd> changes the matte value of any neighbor pixel that is not the border color (<a href="#bordercolor">-bordercolor</a>). Finally <kbd>reset</kbd> changes the matte value of all pixels.</p>
2707
2708<p>You can set the primitive color, font, and font bounding box color with <a href="#fill">-fill</a>, <a href="#font">-font</a>, and <a href="#box">-box</a> respectively. Options are processed in command line order so be sure to use these options <em>before</em> the <a href="#draw">-draw</a> option.</p>
2709
2710<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2711
2712<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2713
cristy2dcd6822011-06-13 16:21:20 +00002714
cristy8b9dd952011-03-21 22:56:18 +00002715<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00002716 <h4><a id="duplicate"></a>-duplicate <em class="arg">count,indexes</em></h4>
cristy8b9dd952011-03-21 22:56:18 +00002717</div>
2718
cristy323f35b2011-03-24 23:05:13 +00002719<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>duplicate an image one or more times.</td><td style='text-align:right;'></td></tr></table>
cristy8b9dd952011-03-21 22:56:18 +00002720
cristy323f35b2011-03-24 23:05:13 +00002721<p>Specify the count and the image to duplicate by its index in the sequence. The first image is index 0. Negative indexes are relative to the end of the sequence, for example, -1 represents the last image of the sequence. Specify a range of images with a dash (e.g. 0-4). Separate indexes with a comma (e.g. 0,2). Use <kbd>+duplicate</kbd> to duplicate the last image in the current image sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00002722
2723<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002724 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002725</div>
2726
2727<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>detect edges within an image.</td><td style='text-align:right;'></td></tr></table>
2728
2729<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002730 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002731</div>
2732
2733<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>emboss an image.</td><td style='text-align:right;'></td></tr></table>
2734
2735<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002736 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002737</div>
2738
2739<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Encipher pixels for later deciphering by <a href="#decipher">-decipher</a>.</td><td style='text-align:right;'></td></tr></table>
2740
2741<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2742
2743<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2744
cristyd0bda5e2010-09-21 16:22:45 +00002745
2746
cristy3ed852e2009-09-05 21:47:34 +00002747<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002748 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002749</div>
2750
2751<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the text encoding.</td><td style='text-align:right;'></td></tr></table>
2752
2753<p>Choose from <kbd>AdobeCustom</kbd>, <kbd>AdobeExpert</kbd>, <kbd>AdobeStandard</kbd>, <kbd>AppleRoman</kbd>, <kbd>BIG5</kbd>, <kbd>GB2312</kbd>, <kbd>Latin 2</kbd>, <kbd>None</kbd>, <kbd>SJIScode</kbd>, <kbd>Symbol</kbd>, <kbd>Unicode</kbd>, <kbd>Wansung</kbd>.</p>
2754
2755<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002756 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002757</div>
2758
2759<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify endianness (<kbd>MSB</kbd> or <kbd>LSB</kbd>) of the image.</td><td style='text-align:right;'></td></tr></table>
2760
2761<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2762
2763<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2764
2765
2766<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002767 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002768</div>
2769
2770<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Apply a digital filter to enhance a noisy image.</td><td style='text-align:right;'></td></tr></table>
2771
2772
2773<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002774 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002775</div>
2776
2777<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>perform histogram equalization on the image channel-by-channel.</td><td style='text-align:right;'></td></tr></table>
2778
2779<p>To perform histogram equalization on all channels in concert, transform the image into some other color space, such as HSL, OHTA, YIQ or YUV, then equalize the appropriate intensity-like channel, then convert back to RGB.</p>
2780
2781<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2782
2783<p>For YIQ, YUV and OHTA use the red channel. For example, OHTA is a principal components transformation that puts most of the information in the first channel. Here we have ... <kbd>-colorspace OHTA -channel red -equalize -colorspace RGB</kbd> ...</p>
2784
2785<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002786 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002787</div>
2788
2789<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Alter channel pixels by evaluating an arithmetic, relational, or logical expression.</td><td style='text-align:right;'></td></tr></table>
2790
2791<p>(See the <a href="#function" >-function</a> operator for some multi-parameter functions. See the <a href="#fx" >-fx</a> operator if more elaborate calculations are needed.)</p>
2792
2793<p>The behaviors of each <em class="arg">operator</em> are summarized in the following list. For brevity, the numerical value of a "pixel" referred to below is the value of the corresponding channel of that pixel, while a "normalized pixel" is that number divided by the maximum (installation-dependent) value <em class="QR">QuantumRange</em>. (If normalized pixels are used, they are restored, following the other calculations, to the full range by multiplying by <em class="QR">QuantumRange</em>.)</p>
2794
2795<table class="doc">
2796 <col width="25%" />
2797 <col width="75%" />
2798 <thead>
2799 <tr>
2800 <th><em class="arg">operator</em></th>
2801 <th>Summary (see further below for details)</th>
2802 </tr>
2803 </thead>
2804 <tbody>
2805
cristy3c98a4f2010-08-13 20:09:41 +00002806 <tr><td>Abs </td> <td>Add <em class="arg">value</em> to pixels and return absolute value. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002807 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2808 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2809 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2810 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2811 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002812 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2813 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002814 <tr><td>LeftShift </td> <td>Shift the pixel values left by <em class="arg">value</em> bits (i.e., multiply pixels by 2<sup><em class="arg">value</em></sup>).</td></tr>
2815 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2816 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002817 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002818 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002819 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2820 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2821 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2822 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2823 <tr><td>RightShift </td> <td>Shift the pixel values right by <em class="arg">value</em> bits (i.e., divide pixels by 2<sup><em class="arg">value</em></sup>).</td></tr>
2824 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2825 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2826 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2827 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2828
2829 <tr><td>&nbsp;</td></tr>
2830
2831 <tr><td>Gaussian-noise</td></tr>
2832 <tr><td>Impulse-noise</td></tr>
2833 <tr><td>Laplacian-noise</td></tr>
2834 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2835 <tr><td>PoissonNoise</td></tr>
2836 <tr><td>Uniform-noise</td></tr>
2837
2838 <tr><td>&nbsp;</td></tr>
2839
2840 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2841 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2842 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2843 </tbody>
2844 </table>
2845
2846<p>The specified functions are applied only to each previously set <a
2847href="#channel" >-channel</a> in the image. If necessary, the results of the
2848calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2849class="QR">QuantumRange</em>]. The transparency channel of the image is
2850represented as a 'alpha' values (0 = fully transparent), so, for example, a
2851<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2852semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2853as a percentage of the <em class="QR">QuantumRange</em>.</p>
2854
2855<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2856<a href="#list">-list evaluate</a>.</p>
2857
2858<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2859<kbd>Multiply</kbd> methods can also be achieved using either the <a
2860href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2861appropriate argument, to linearly modify the overall range of color values.
2862Please note, however, that <a href="#level" >-level</a> treats transparency as
2863'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2864'alpha' values.</p>
2865
2866<p><kbd>AddModulus</kbd> has been added as of ImageMagick 6.4.8-4 and provides addition modulo the <em class="QR">QuantumRange</em>. It is therefore equivalent to <kbd>Add</kbd> unless the resulting pixel value is outside the interval [0,&nbsp;<em class="QR">QuantumRange</em>]. </p>
2867
cristyce66ab12010-10-21 23:36:32 +00002868<p><kbd>Exp or Exponential</kbd> has been added as of ImageMagick 6.6.5-1 and works on normalized pixel values. The <em class="arg">value</em> used with <kbd>Exp</kbd> should be negative so as to produce a decaying exponential function. Non-negative values will always produce results larger unity and thus outside the interval [0,&nbsp;<em class="QR">QuantumRange</em>]. The formula is expressed below. </p>
2869
2870 <div style="text-align:center;">
2871 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2872 </div>
2873
2874<p> If the input image is squared, for example, using <a
2875href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2876
cristy3ed852e2009-09-05 21:47:34 +00002877<p><kbd>Log</kbd> has been added as of ImageMagick 6.4.2-1 and works on normalized pixel values. This a <em>scaled</em> log function. The <em class="arg">value</em> used with <kbd>Log</kbd> provides a <em>scaling factor</em> that adjusts the curvature in the graph of the log function. The formula applied to a normalized value <b><em>u</em></b> is below. </p>
2878
2879 <div style="text-align:center;">
2880 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2881 </div>
2882
2883<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2884normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2885href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2886to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2887with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2888with <kbd>Pow</kbd>.</p>
2889
2890<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2891converts the image values into a value according to a (co)sine wave function.
2892The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2893is biased 50% and normalized by 50% so as to fit in the respective color value
2894range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2895function (its frequency), and thus determines the number of 'waves' that will
2896be generated over the input color range. For example, if the <em
2897class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2898class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2899then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002900class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002901
2902 <div style="text-align:center;">
2903 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2904 </div>
2905
cristydcca3fa2010-12-29 21:50:07 +00002906<p>See also the <a href="#function" >-function</a> operator, which is a
2907multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002908
cristy63fed272010-03-07 19:08:45 +00002909<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002910 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002911</div>
2912
2913<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Alter channel pixels by evaluating an arithmetic, relational, or logical expression over a sequence of images.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002914
2915<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002916 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002917</div>
2918
2919<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the image size and offset.</td><td style='text-align:right;'></td></tr></table>
2920
cristy3e2860c2010-01-24 01:36:30 +00002921<p>If the image is enlarged, unfilled areas are set to the background color. To position the image, use offsets in the <em class="arg">geometry</em> specification or precede with a <a href="#gravity">-gravity</a> setting. To specify how to compose the image with the background, use <a href="#compose" >-compose</a>.</p>
cristy549177c2010-11-11 13:51:21 +00002922<p>This command reduces or expands a JPEG image to fit on an 800x600
2923display. If the aspect ratio of the input image isn't exactly 4:3, then the
2924image is centered on an 800x600 black canvas: </p>
2925
cristyeed6cb62012-01-28 19:38:34 +00002926<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert input.jpg -resize 800x600 -background black -compose Copy \ <br /> -gravity center -extent 800x600 -quality 92 output.jpg</span></p>
cristy549177c2010-11-11 13:51:21 +00002927
cristy3ed852e2009-09-05 21:47:34 +00002928
2929<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
2930
2931<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002932 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002933</div>
2934
2935<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Extract the specified area from image.</td><td style='text-align:right;'></td></tr></table>
2936
2937<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2938
cristyeed6cb62012-01-28 19:38:34 +00002939<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -size 16000x16000 -depth 8 -extract 640x480+1280+960 \ <br/> image.rgb image.png</span><span class='crtout'></span><span class="crtprompt"> $ </span><span class='crtin'>convert -size 16000x16000 -depth 8 'image.rgb[640x480+1280+960]' \ <br/> image.rgb image.png</span></p><p>If you omit the offsets, as in</p>
cristy3ed852e2009-09-05 21:47:34 +00002940
cristyeed6cb62012-01-28 19:38:34 +00002941<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -size 16000x16000 -depth 8 -extract 640x480 \ <br/> image.rgb image.png</span></p>
cristyd0bd44a2010-09-24 12:38:11 +00002942<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002943equivalent to:</p>
2944
cristyeed6cb62012-01-28 19:38:34 +00002945<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -size 16000x16000 -depth 8 -resize 640x480 image.rgb image.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002946<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
2947
2948<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002949 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002950</div>
2951
2952<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set a font family for text.</td><td style='text-align:right;'></td></tr></table>
2953
2954<p>This setting suggests a font family that ImageMagick should try to use for rendering text. If the family can be found it is used; if not, a default font (e.g., "Arial") or a family known to be similar is substituted (e.g., "Courier" might be used if "System" is requested but not found).
2955</p>
2956
2957<p>For other settings that affect fonts, see the options <a href="#font">-font</a>, <a href="#stretch">-stretch</a>, <a href="#style">-style</a>, and <a href="#weight">-weight</a>.
2958</p>
2959
2960<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002961 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002962</div>
2963
2964<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>display features for each channel in the image in each of four directions (horizontal, vertical, left and right diagonals) for the specified distance.</td><td style='text-align:right;'></td></tr></table>
2965
2966<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002967 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002968</div>
2969
2970<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>implements the forward discrete Fourier transform (DFT).</td><td style='text-align:right;'></td></tr></table>
2971
cristydcca3fa2010-12-29 21:50:07 +00002972<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows users in ImageMagick 6.6.0-9). It transforms an image from the normal (spatial) domain to the frequency domain. In the frequency domain, an image is represented as a superposition of complex sinusoidal waves of varying amplitudes. The image x and y coordinates are the possible frequencies along the x and y directions, respectively, and the pixel intensity values are complex numbers that correspond to the sinusoidal wave amplitudes. See for example, <a href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002973
cristydcca3fa2010-12-29 21:50:07 +00002974<p>A single image name is provided as output for this option. However, the output result will have two components. It is either a two-frame image or two separate images, depending upon whether the image format specified supports multi-frame images. The reason that we get a dual output result is because the frequency domain represents an image using complex numbers, which cannot be visualized directly. Therefore, the complex values are automagically separated into a two-component image representation. The first component is the magnitude of the complex number and the second is the phase of the complex number. See for example, <a href="http://en.wikipedia.org/wiki/Complex_numbers">Complex Numbers</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002975
2976<p>The magnitude and phase component images must be specified using image formats that do not limit the color or compress the image. Thus, MIFF, TIF, PFM, EXR and PNG are the recommended image formats to use. All of these formats, except PNG support multi-frame images. So for example,</p>
2977
cristyeed6cb62012-01-28 19:38:34 +00002978<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002979<p>generates a magnitude image as <kbd>fft_image.miff[0]</kbd> and a phase image as <kbd>fft_image.miff[1]</kbd>. Similarly,</p>
2980
cristyeed6cb62012-01-28 19:38:34 +00002981<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002982<p>generates a magnitude image as <kbd>fft_image-0.png</kbd> and a phase image as <kbd>fft_image-1.png</kbd>. If you prefer this representation, then you can force any of the other formats to produce two output images by including <a href="#adjoin">+adjoin</a> following -fft in the command line.</p>
2983
cristyd0bd44a2010-09-24 12:38:11 +00002984<p>The input image can be any size, but if not square and even-dimensioned, it is padded automagically to the larger of the width or height of the input image and to an even number of pixels. The padding will occur at the bottom and/or right sides of the input image. The resulting output magnitude and phase images is square at this size. The kind of padding relies on the <a href="#virtual-pixel">-virtual-pixel</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +00002985
cristyeed6cb62012-01-28 19:38:34 +00002986<p>Both output components will have dynamic ranges that fit within [0,&nbsp;<em class="QR">QuantumRange</em>], so that HDRI need not be enabled. Phase values nominally range from 0 to 2*&pi;, but is scaled to span the full dynamic range.
2987(The first few releases had non-HDRI scaled but HDRI not scaled). The magnitude image is not scaled and thus generally will contain very small values. As such, the image normally will appear totally black. In order to view any detail, the magnitude image typically is enhanced with a log function into what is usually called the spectrum. A log function is used to enhance the darker values more in comparison to the lighter values. This can be done, for example, as follows:</p>
cristy3ed852e2009-09-05 21:47:34 +00002988
cristyeed6cb62012-01-28 19:38:34 +00002989<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
cristy3ed852e2009-09-05 21:47:34 +00002990 -evaluate log 1000 fft_image_spectrum.png</span></p>
cristyeed6cb62012-01-28 19:38:34 +00002991<p>where either <a href="#contrast-stretch">-contrast-stretch</a> 0 or <a href="#auto-level">-auto-level</a> is used to scale the image to full dynamic range, first. The argument to the <a href="#evaluate">-evaluate</a> log typically is specified between 100 and 10,000, depending upon the amount of detail that one wants to bring out in the spectrum. Larger values produce more visible detail. Too much detail, however, may hide the important features.</p>
cristy3ed852e2009-09-05 21:47:34 +00002992
cristydcca3fa2010-12-29 21:50:07 +00002993<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to use <a href="#fft">-fft</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002994
2995<p>Use <a href="#fft">+fft</a> to produce two output images that are the real and imaginary components of the complex valued Fourier transform.</p>
2996
cristyeed6cb62012-01-28 19:38:34 +00002997<p>However, as the real and imaginary components can contain negative values, this requires that IM be configured with HDRI enabled. In this case, you must use either MIFF, TIF, PFM or MPC formats for the real and imaginary component results, since they are formats that preserve both negative and fractional values without clipping them or truncating the fractional part. With either
2998MIFF or TIF, one should add -define quantum:format=32, to allow those image
2999types to work properly in HDRI mode without clipping.</p>
cristy3ed852e2009-09-05 21:47:34 +00003000
cristyeed6cb62012-01-28 19:38:34 +00003001<p>The real and imaginary component images resulting from <a href="#fft">+fft</a> are also square, even dimensioned images due to the same padding that was discussed above for the magnitude and phase component images.</p>
cristy3ed852e2009-09-05 21:47:34 +00003002
3003<p>See the discussion on HDRI implementations of ImageMagick on the page
cristyeed6cb62012-01-28 19:38:34 +00003004<a href="../www/high-dynamic-range.html">High Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages, <a href="http://www.fmwconcepts.com/imagemagick/fourier_transforms/fourier.html">Fred's Fourier Processing With ImageMagick page</a> or this <a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a> entry.
cristy3ed852e2009-09-05 21:47:34 +00003005</p>
3006
3007
3008<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003009 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003010</div>
3011
3012<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>color to use when filling a graphic primitive.</td><td style='text-align:right;'></td></tr></table>
3013
3014<p>This option accepts a color name, a hex color, or a numerical RGB, RGBA, HSL, HSLA, CMYK, or CMYKA specification. See <a href="../www/color.html">Color Names</a> for a description of how to properly specify the color argument.</p>
3015
3016<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
3017
3018<p>For example,</p>
3019
3020<p class="crtsnip">
3021 -fill blue
3022</p>
3023<p class="crtsnip">
3024 -fill "#ddddff"
3025</p>
3026<p class="crtsnip">
3027 -fill "rgb(255,255,255)"
3028</p>
3029
3030<p>See <a href="#draw">-draw</a> for further details.</p>
3031
3032<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
3033
3034<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003035 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003036</div>
3037
cristyd0bda5e2010-09-21 16:22:45 +00003038<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Use this <em class="arg">type</em> of filter when resizing or
3039distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00003040
cristyd0bda5e2010-09-21 16:22:45 +00003041<p>Use this option to affect the resizing operation of an image during
3042operations such as <a href="#resize">-resize</a> and <a href="#distort"
3043>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00003044
3045<pre class="text">
3046 Point Hermite Cubic
3047 Box Gaussian Catrom
3048 Triangle Quadratic Mitchell
3049</pre>
3050
cristyd0bda5e2010-09-21 16:22:45 +00003051<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00003052as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
3053generally useless on their own as they are infinite filters that are being
3054clipped to the filters support size. Their direct use is not recommended
3055except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00003056
cristydcca3fa2010-12-29 21:50:07 +00003057<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00003058function that the <a href="#filter" >-filter</a> setting defines. That is
3059using these functions will define a 'Windowed' filter, appropriate to the
3060operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00003061
3062<pre class="text">
3063 Lanczos Hamming Parzen
3064 Blackman Kaiser Welsh
3065 Hanning Bartlett Bohman
3066</pre>
3067
3068<p>Also one special self-windowing filter is also provided
3069<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
3070on the current 'support' or 'lobes' expert settings (see below).</p>
3071
cristyd0bda5e2010-09-21 16:22:45 +00003072<p>If you do not select a filter with this option, the filter defaults to
3073<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
3074if the image is enlarged. Otherwise the filter default to
3075<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00003076
cristyd0bda5e2010-09-21 16:22:45 +00003077<p>To print a complete list of resize filters, use the <a href="#list">-list
3078filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003079
3080<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00003081use of these expert settings (see also <a href="#define" >-define</a> and <a
3082href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00003083
3084<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00003085<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003086<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00003087 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
3088 Gaussian-like filters simple filters, or you may not get the expected
3089 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00003090
cristyd0bda5e2010-09-21 16:22:45 +00003091<dt>-define filter:support=<em>radius</em></dt>
3092<dd>Set the filter support radius. Defines how large the filter should be and
3093 thus directly defines how slow the filtered resampling process is. All
3094 filters have a default 'prefered' support size. Some filters like
3095 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
3096 this value. With simple filters this value either does nothing (but slow
3097 the resampling), or will clip the filter function in a detrimental way.
3098 </dd>
cristy3ed852e2009-09-05 21:47:34 +00003099
cristyd0bda5e2010-09-21 16:22:45 +00003100<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003101<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00003102 alternative way of specifying the 'support' range of the filter, that is
3103 designed to be more suited to windowed filters, especially when used for
3104 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003105
cristyd0bda5e2010-09-21 16:22:45 +00003106<dt>-define filter:b=<em>b-spline_factor</em></dt>
3107<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003108<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
3109 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
3110 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
3111 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00003112 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00003113 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003114
cristyd0bda5e2010-09-21 16:22:45 +00003115<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003116<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00003117 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00003118 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00003119 'Bessel' functions. If defined, no windowing function is used, unless the
3120 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003121
cristyd0bda5e2010-09-21 16:22:45 +00003122<dt>-define filter:window=<em>filter_function</em></dt>
3123<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
3124 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
3125 support range) with the given filter. This allows you to specify a filter
3126 function that is not normally used as a windowing function, such as
3127 <kbd>Box</kbd>, (which effectively turns off the windowing function),
3128 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
3129 </dd>
3130
3131<dt>-define filter:verbose=<em>1</em></dt>
3132<dd>This causes IM to print information on the final internal filter
3133 selection to standard output. This includes a commented header on the
3134 filter settings being used, and data allowing the filter weights to be
3135 easily graphed. </dd>
3136
3137<dd>Note however that some filters are internally defined in terms of other
3138 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
3139 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
3140 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
3141 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00003142
3143</dl>
3144
cristyd0bda5e2010-09-21 16:22:45 +00003145<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00003146
cristyeed6cb62012-01-28 19:38:34 +00003147<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert image.png -filter bessel \ <br/>
cristy3ed852e2009-09-05 21:47:34 +00003148 -set filter:window=bessel -set filter:lobes=8 \ <br/>
3149 -resize 150% image.jpg</span></p>
3150<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3151
cristyeed6cb62012-01-28 19:38:34 +00003152<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
cristy3ed852e2009-09-05 21:47:34 +00003153 -resize 150% image.jpg</span></p>
3154<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00003155filters, and 'verbose' for viewing the internal filter selection), are
3156provided for image processing experts who have studied and understood how
3157resize filters work. Without this knowledge, and an understanding of the
3158definition of the actual filters involved, using expert settings are more
3159likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00003160
3161
3162<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003163 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00003164</div>
3165
3166<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>This is a simple alias for the <a href="#layers" >-layers</a> method "flatten".</td><td style='text-align:right;'></td></tr></table>
3167
3168
3169<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003170 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00003171</div>
3172
3173<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>create a <em>mirror image</em>.</td><td style='text-align:right;'></td></tr></table>
3174
cristy2dcd6822011-06-13 16:21:20 +00003175<p>reflect the scanlines in the vertical direction. The image will be mirrored
3176upside-down. </p>
3177
cristy3ed852e2009-09-05 21:47:34 +00003178
3179<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003180 <h4><a id="floodfill"></a>-floodfill {<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em> <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003181</div>
3182
cristy2dcd6822011-06-13 16:21:20 +00003183<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>floodfill the image with color at the specified offset.</td><td style='text-align:right;'></td></tr></table>
3184
3185<p>Flood fill starts from the given 'seed point' which is not gravity effected.
3186Any color that matches within <a href="#fuzz" >-fuzz</a> color distance of the
3187given <em class="arg">color</em> argument, connected to that 'seed point'
3188will be replaced with the current <a href="#fill" >-fill</a> color. </p>
3189
3190<p>Note that if the pixel at the 'seed point' does not itself match the given
3191<em class="arg">color</em> (according to <a href="#fuzz" >-fuzz</a>), then no
3192action will be taken. </p>
3193
3194<p>This operator works more like the <a href="#opaque" >-opaque</A> option, than
3195a more general flood fill that reads the matching color directly at the 'seed point'. For this form of flood fill, look at <a href="#draw" >-draw</a> and its 'color floodfill' drawing method. </p>
3196
cristy3ed852e2009-09-05 21:47:34 +00003197
3198<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003199 <h4><a id="flop"></a>-flop</h4>
cristy3ed852e2009-09-05 21:47:34 +00003200</div>
3201
3202<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>create a <em>mirror image</em>.</td><td style='text-align:right;'></td></tr></table>
3203
cristy2dcd6822011-06-13 16:21:20 +00003204<p>Reflect the scanlines in the horizontal direction, just like the image in
3205a vertical mirror. </p>
cristy3ed852e2009-09-05 21:47:34 +00003206
3207
3208<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003209 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003210</div>
3211
3212<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set the font to use when annotating images with text, or creating labels.</td><td style='text-align:right;'></td></tr></table>
3213
3214<p>To print a complete list of fonts, use the <a href="#list">-list font</a> option (for versions prior to 6.3.6, use 'type' instead of 'font').</p>
3215
3216<p>In addition to the fonts specified by the above pre-defined list, you can
3217also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
3218is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
3219<kbd>x:fixed</kbd> is X11 font.</p>
3220
3221<p>For other settings that affect fonts, see the options <a href="#family">-family</a>, <a href="#stretch">-stretch</a>, <a href="#style">-style</a>, and <a href="#weight">-weight</a>. </p>
3222
3223
3224<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003225 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003226</div>
3227
3228<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Define the foreground color.</td><td style='text-align:right;'></td></tr></table>
3229
3230<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3231
3232<p>The default foreground color is black.</p>
3233
3234<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003235 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003236</div>
3237
3238<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the image format type.</td><td style='text-align:right;'></td></tr></table>
3239
cristy47774982011-02-15 15:17:19 +00003240<p>When used with the <kbd>mogrify</kbd> utility, this option converts any image to the image <a href="../www/formats.html">format</a> you specify. For a list of image format types supported by ImageMagick, use <a href="#list">-list format</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00003241
3242<p>By default the file is written to its original name. However, if the filename extension matches a supported format, the extension is replaced with the image format type specified with <a href="#format">-format</a>. For example, if you specify <em class="arg">tiff</em> as the format type and the input image filename is <em class="arg">image.gif</em>, the output image filename becomes <em class="arg">image.tiff</em>.</p>
3243
3244<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003245 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003246</div>
3247
3248<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>output formatted image characteristics.</td><td style='text-align:right;'>[<a href="../www/identify.html">identify</a>]</td></tr></table>
3249
3250<p>See <a href="../www/escape.html">Format and Print Image Properties</a> for an explanation on how to specify the argument to this option.</p>
3251
3252<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003253 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003254</div>
3255
3256<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Surround the image with a border or beveled frame.</td><td style='text-align:right;'></td></tr></table>
3257
cristybc9539a2010-08-16 18:06:20 +00003258<p>The color of the border is specified with the <a href="#mattecolor"
3259>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003260
cristybc9539a2010-08-16 18:06:20 +00003261<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <em class="arg">size</em> portion of the <em
3262class="arg">geometry</em> argument indicates the amount of extra width and
3263height that is added to the dimensions of the image. If no offsets are given
3264in the <em class="arg">geometry</em> argument, then the border added is
3265a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3266the width and height of the border is partitioned to form an outer bevel of
3267thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3268<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3269</p>
3270
3271<p>The <a href="#frame">-frame</a> option is affected by the current <a
3272href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003273'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003274size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3275draws the frame of four distinct colors close to the current <a
3276href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3277center of this image. This means that with the default compose method of
3278'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3279href="#bordercolor">-bordercolor</a> setting.</p>
3280
3281<p>The image composition is not
3282affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003283
3284
3285<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003286 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003287</div>
3288
3289<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>include the X window frame in the imported image.</td><td style='text-align:right;'>[<a href="../www/import.html">import</a>]</td></tr></table>
3290
3291<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003292 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003293</div>
3294
3295<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Apply a function to channel values.</td><td style='text-align:right;'></td></tr></table>
3296
3297<p>This operator performs calculations based on the given arguments to modify each of the color values for each previously set <a href="#channel">-channel</a> in the image. See <a href="#evaluate">-evaluate</a> for details concerning how the results of the calculations are handled.</p>
3298
3299<p>This is can be considered a multi-argument version of the <a href="#evaluate">-evaluate</a> operator. (Added in ImageMagick&nbsp;6.4.8&minus;8.)</p>
3300
3301<p>Here, <em class="arg">parameters</em> is a comma-separated list of numerical values. The number of values varies depending on which <em class="arg">function</em> is selected. Choose the <em class="arg">function</em> from:</p>
3302
3303<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003304 Polynomial
3305 Sinusoid
3306 Arcsin
3307 Arctan
cristy3ed852e2009-09-05 21:47:34 +00003308</pre>
3309
3310<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3311
3312<dl class="doc">
3313<dt><kbd>Polynomial</kbd></dt>
3314<dd>
3315<p>The <kbd>Polynomial</kbd> function takes an arbitrary number of parameters, these being the coefficients of a polynomial, in decreasing order of degree. That is, entering</p>
3316
3317<div style="text-align: center">
3318 -function Polynomial <em>a</em><sub><em>n</em></sub>,<em>a</em><sub><em>n</em>-1</sub>,...<em>a</em><sub>1</sub>,<em>a</em><sub>0</sub>
3319</div>
3320
3321<p>will invoke a polynomial function given by</p>
3322
3323<div style="text-align: center">
3324 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3325 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3326 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3327</div>
3328
3329<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3330
3331<p>The <kbd>Polynomial</kbd> function can be used in place of <kbd>Set</kbd> (the <em>constant</em> polynomial) and <kbd>Add</kbd>, <kbd>Divide</kbd>, <kbd>Multiply</kbd>, and <kbd>Subtract</kbd> (some <em>linear</em> polynomials) of the <a href="#evaluate">-evaluate</a> operator. The <a href="#level">-level</a> operator also affects channels linearly. Some correspondences follow.</p>
3332
3333<table class="doc">
3334 <col width="35%" />
3335 <col width="35%" />
3336 <col width="30%" />
3337 <tr>
3338 <td>-evaluate Set <em class="arg">value</em> </td>
3339 <td>-function Polynomial <em class="arg">value</em></td>
3340 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3341 </tr>
3342 <tr>
3343 <td>-evaluate Add <em class="arg">value</em> </td>
3344 <td>-function Polynomial 1,<em class="arg">value</em></td>
3345 </tr>
3346 <tr>
3347 <td>-evaluate Subtract <em class="arg">value</em> </td>
3348 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3349 </tr>
3350 <tr>
3351 <td>-evaluate Multiply <em class="arg">value</em> </td>
3352 <td>-function Polynomial <em class="arg">value</em>,0</td>
3353 </tr>
3354 <tr>
3355 <td>+level black% x white%</td>
3356 <td>-function Polynomial A,B</td>
3357 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3358 </tr>
3359</table>
3360
3361<p>The <kbd>Polynomial</kbd> function gives great versatility, since polynomials can be used to fit any continuous curve to any degree of accuracy desired.</p>
3362</dd>
3363
3364<dt><kbd>Sinusoid</kbd></dt>
3365<dd>
3366<p>The <kbd>Sinusoid</kbd> function can be used to vary the channel values sinusoidally by setting frequency, phase shift, amplitude, and a bias. These values are given as one to four parameters, as follows,</p>
3367
3368<div style="text-align: center">
3369 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3370</div>
3371
3372<p>where <em>phase</em> is in degrees. (The domain [0,1] of the function corresponds to 0 through <em class="arg">freq</em>&times;360&nbsp;degrees.) The result is that if a pixel's normalized channel value is originally <b><em>u</em></b>, its resulting normalized value is given by </p>
3373
3374<div style="text-align: center">
3375<em class="arg">amp</em> * sin(2*&pi;* (<em class="arg">freq</em> * <b><em>u</em></b> + <em class="arg">phase</em> / 360)) + <em class="arg">bias</em>
3376</div>
3377
3378<p> For example, the following generates a curve that starts and ends at 0.9 (when <b><em>u</em></b>=0 and 1, resp.), oscillating three times between .7&minus;.2=.5 and .7+.2=.9. </p>
3379
3380<p class="crtsnip">
3381 -function Sinusoid 3,-90,.2,.7
3382</p>
3383
3384<p>The default values of <em class="arg">amp</em> and <em class="arg">bias</em> are both .5. The default for <em class="arg">phase</em> is 0.</p>
3385
3386<p>The <kbd>Sinusoid</kbd> function generalizes <kbd>Sin</kbd> and <kbd>Cos</kbd> of the <a href="#evaluate">-evaluate</a> operator by allowing varying amplitude, phase and bias. The correspondence is as follows.</p>
3387
3388<table class="doc">
3389 <tr>
3390 <td>-evaluate Sin <em class="arg">freq</em> </td>
3391 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3392 </tr>
3393 <tr>
3394 <td>-evaluate Cos <em class="arg">freq</em> </td>
3395 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3396 </tr>
3397</table>
3398</dd>
3399
3400<dt><kbd>ArcSin</kbd></dt>
3401<dd>
3402<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3403and can be used to generate cylindrical distortion and displacement maps.
3404The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003405of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003406
cristydcca3fa2010-12-29 21:50:07 +00003407<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003408 -function <kbd>ArcSin</kbd> <em class="arg">width</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
cristydcca3fa2010-12-29 21:50:07 +00003409</p>
cristy3ed852e2009-09-05 21:47:34 +00003410
cristyeed6cb62012-01-28 19:38:34 +00003411<p>with all values given in terms of normalized color values (0.0 for black,
cristy3ed852e2009-09-05 21:47:34 +000034121.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3413for bout input (<em class="arg">width</em>), and output (<em
3414class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3415
cristydcca3fa2010-12-29 21:50:07 +00003416<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003417<em class="arg">range</em>/&pi; * asin( 2/<em class="arg">width</em> * ( <b><em>u</em></b> - <em class="arg">center</em> ) ) + <em class="arg">bias</em>
cristydcca3fa2010-12-29 21:50:07 +00003418</p>
cristy3ed852e2009-09-05 21:47:34 +00003419
3420</dd>
3421
3422<dt><kbd>ArcTan</kbd></dt>
3423<dd>
3424<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3425limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003426All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003427
cristydcca3fa2010-12-29 21:50:07 +00003428<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003429 -function <kbd>ArcTan</kbd> <em class="arg">slope</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
cristydcca3fa2010-12-29 21:50:07 +00003430</p>
cristy3ed852e2009-09-05 21:47:34 +00003431
3432<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3433</p>
3434
cristydcca3fa2010-12-29 21:50:07 +00003435<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003436<em class="arg">range</em>/&pi; * atan( <em class="arg">slope</em>*&pi; * ( <b><em>u</em></b> - <em class="arg">center</em> ) ) + <em class="arg">bias</em>
cristydcca3fa2010-12-29 21:50:07 +00003437</p>
cristy3ed852e2009-09-05 21:47:34 +00003438
3439</dd>
3440
3441</dl>
3442
3443
3444<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003445 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003446</div>
3447
3448<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Colors within this <em class="arg">distance</em> are considered equal.</td><td style='text-align:right;'></td></tr></table>
3449
3450<p>A number of algorithms search for a target color. By default the color must be exact. Use this option to match colors that are close to the target color in RGB space. For example, if you want to automagically trim the edges of an image with <a href="#trim">-trim</a> but the image was scanned and the target background color may differ by a small amount. This option can account for these differences.</p>
3451
3452<p>The <em class="arg">distance</em> can be in absolute intensity units or, by appending <kbd>%</kbd> as a percentage of the maximum possible intensity (255, 65535, or 4294967295).</p>
3453
3454
3455<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003456 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003457</div>
3458
3459<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>apply a mathematical expression to an image or image channels.</td><td style='text-align:right;'></td></tr></table>
3460
3461<p>If the first character of <em class="arg">expression</em> is <kbd>@</kbd>, the expression is read from a file titled by the remaining characters in the string.</p>
3462
3463<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3464
3465
3466<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003467 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003468</div>
3469
3470<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>level of gamma correction.</td><td style='text-align:right;'></td></tr></table>
3471
3472<p>The same color image displayed on two different workstations may look different due to differences in the display monitor. Use gamma correction to adjust for this color difference. Reasonable values extend from <kbd>0.8</kbd> to <kbd>2.3</kbd>. Gamma less than 1.0 darkens the image and gamma greater than 1.0 lightens it. Large adjustments to image gamma may result in the loss of some image information if the pixel quantum size is only eight bits (quantum range 0 to 255).</p>
3473
3474<p>Gamma adjusts the image's channel values pixel-by-pixel according to a power law, namely, pow(pixel,1/gamma) or pixel^(1/gamma), where pixel is the normalized or 0 to 1 color value. For example, using a value of gamma=2 is the same as taking the square root of the image.</p>
3475
3476<p>You can apply separate gamma values to the red, green, and blue channels of the image with a gamma value list delimited with commas (e.g., <kbd>1.7,2.3,1.2</kbd>).</p>
3477
cristyeed6cb62012-01-28 19:38:34 +00003478<p>Use <a href="#gamma">+gamma <em class="arg">value</em></a> to set the
3479image gamma level without actually adjusting the image pixels. This option
3480is useful if the image is of a known gamma but not set as an image attribute
3481(e.g. PNG images). Write the "file gamma" which is the reciprocal of the
3482display gamma; e.g., if your image is sRGB and you want to write a PNG gAMA
3483chunk, use
3484<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert input.png +gamma .45455 output.png</span></p>(0.45455 is 1/2.2)</p>
cristy3ed852e2009-09-05 21:47:34 +00003485
3486<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3487
3488<div style="margin: auto;">
cristyeed6cb62012-01-28 19:38:34 +00003489 <h4><a id="gaussian-blur"></a>-gaussian-blur <em class="arg">radius</em><br />-gaussian-blur <em class="arg">radius</em>x<em class="arg">sigma</em>+<em class="arg">bias</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003490</div>
3491
3492<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Blur the image with a Gaussian operator.</td><td style='text-align:right;'></td></tr></table>
3493
cristyb15553d2010-07-03 22:53:14 +00003494<p>Convolve the image with a Gaussian or normal distribution using the given
3495<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003496
3497<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3498</div>
3499
cristyb15553d2010-07-03 22:53:14 +00003500<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003501determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003502
3503<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003504array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003505integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003506radius that will provide meaningful results for the Gaussian distribution.
3507</p>
3508
3509<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3510operation is. However too small a <em class="arg" >Radius</em>, and sever
3511aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3512should be at least twice the <em class="arg" >Sigma</em> value, though three
cristyeed6cb62012-01-28 19:38:34 +00003513times will produce a more accurate result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003514
3515<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003516full 2-dimensional convolution is used to generate the weighted average of the
3517neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003518
3519<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3520pixels which are outside the image proper are blurred into the final result.
3521</p>
3522
3523
3524<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003525 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003526</div>
3527
3528<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the preferred size and location of the image.</td><td style='text-align:right;'></td></tr></table>
3529
3530<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3531
3532<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003533 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003534</div>
3535
3536<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Sets the current gravity suggestion for various other settings and options.</td><td style='text-align:right;'></td></tr></table>
3537
3538<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3539<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3540<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3541list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3542installation.</p>
3543
cristyeed6cb62012-01-28 19:38:34 +00003544<p>The direction you choose specifies where to position text or subimages. For example, a gravity of <kbd>Center</kbd> forces the text to be centered within the image. By default, the image gravity is <kbd>NorthWest</kbd>. See <a href="#draw">-draw</a> for more details about graphic primitives. Only the text primitive of <a href="#draw">-draw</a> is affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003545
3546<p>The <a href="#gravity">-gravity</a> option is also used in concert with the <a href="#geometry">-geometry</a> setting and other settings or options that take <em class="arg">geometry</em> as an argument, such as the <a href="#crop">-crop</a> option. </p>
3547
3548<p>If a <a href="#gravity">-gravity</a> setting occurs before another option or setting having a <em class="arg">geometry</em> argument that specifies an offset, the offset is usually applied to the point within the image suggested by the <a href="#gravity">-gravity</a> argument. Thus, in the following command, for example, suppose the file <kbd>image.png</kbd> has dimensions 200x100. The offset specified by the argument to <a href="#region">-region</a> is (&minus;40,+20). The argument to <a href="#gravity">-gravity</a> is <kbd>Center</kbd>, which suggests the midpoint of the image, at the point (100,50). The offset (&minus;40,20) is applied to that point, giving (100&minus;40,50+20)=(60,70), so the specified 10x10&nbsp;region is located at that point. (In addition, the <a href="#gravity">-gravity</a> affects the region itself, which is <em>centered</em> at the pixel coordinate&nbsp;(60,70). (See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.)</p>
3549
cristyeed6cb62012-01-28 19:38:34 +00003550<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert image.png -gravity Center -region 10x10-40+20 \ <br/> -negate output.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00003551<p>When used as an option to <a href="../www/composite.html">composite</a>, <a href="#gravity">-gravity</a> gives the direction that the image gravitates within the composite.</p>
3552
3553<p>When used as an option to <a href="../www/montage.html">montage</a>, <a href="#gravity">-gravity</a> gives the direction that an image gravitates within a tile. The default gravity is <kbd>Center</kbd> for this purpose.</p>
3554
3555
3556<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003557 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003558</div>
3559
3560<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>green chromaticity primary point.</td><td style='text-align:right;'></td></tr></table>
3561
3562
3563<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003564 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003565</div>
3566
3567<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>apply a Hald color lookup table to the image.</td><td style='text-align:right;'></td></tr></table>
3568
3569<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3570dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3571can apply any color transformation to the Hald image and then use this option
3572to apply the transform to the image. </p>
3573
cristyeed6cb62012-01-28 19:38:34 +00003574<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00003575<p>This option provides a convenient method for you to use Gimp or Photoshop
3576to make color corrections to the Hald CLUT image and subsequently apply them
3577to multiple images using an ImageMagick script. </p>
3578
3579<p>Note that the representation is only of the normal RGB color space and that
3580the whole color value triplet is used for the interpolated lookup of the
3581represented Hald color cube image. Because of this the operation is not <a
3582href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3583images transparency or alpha/matte channel.</p>
3584
3585<p>See also <a href="#clut" >-clut</a> which provides color value replacement
cristyeed6cb62012-01-28 19:38:34 +00003586of the individual color channels, usually involving a simpler gray-scale
cristy3ed852e2009-09-05 21:47:34 +00003587image. E.g: gray-scale to color replacement, or modification by a histogram
3588mapping. </p>
3589
3590
3591<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003592 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003593</div>
3594
3595<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>print usage instructions.</td><td style='text-align:right;'></td></tr></table>
3596
3597<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003598 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003599</div>
3600
3601<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>when comparing images, emphasize pixel differences with this color.</td><td style='text-align:right;'></td></tr></table>
3602
3603<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003604 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003605</div>
3606
3607<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the icon geometry.</td><td style='text-align:right;'></td></tr></table>
3608
3609<p>Offsets, if present in the geometry specification, are handled in the same manner as the <a href="#geometry">-geometry</a> option, using X11 style to handle negative offsets.</p>
3610
3611<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
3612
3613<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003614 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003615</div>
3616
3617<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>iconic animation.</td><td style='text-align:right;'></td></tr></table>
3618
3619<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003620 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003621</div>
3622
3623<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>identify the format and characteristics of the image.</td><td style='text-align:right;'></td></tr></table>
3624
3625<p>This information is printed: image scene number; image name; image size; the image class (<em class="arg">DirectClass</em> or <em class="arg">PseudoClass</em>); the total number of unique colors; and the number of seconds to read and transform the image. Refer to <a href="../www/miff.html">MIFF</a> for a description of the image class.</p>
3626
cristy47774982011-02-15 15:17:19 +00003627<p>If <a href="#colors">-colors</a> is also specified, the total unique colors in the image and color reduction error values are printed. Refer to <a href="../www/quantize.html">color reduction algorithm</a> for a description of these values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003628
cristyd0bda5e2010-09-21 16:22:45 +00003629<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003630amounts of image properties are displayed including image statistics, profiles,
3631image histogram, and others.</p>
3632
3633<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003634 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003635</div>
3636
3637<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>implements the inverse discrete Fourier transform (DFT).</td><td style='text-align:right;'></td></tr></table>
3638
cristydcca3fa2010-12-29 21:50:07 +00003639<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows users in ImageMagick 6.6.0-9). It transforms a pair of magnitude and phase images from the frequency domain to a single image in the normal or spatial domain. See for example, <a href="http://en.wikipedia.org/wiki/Fourier_transform">Fourier Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00003640
3641<p>For example, depending upon the image format used to store the result of the <a href="#fft">-fft</a>, one would use either</p>
3642
cristyeed6cb62012-01-28 19:38:34 +00003643<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00003644<p>or</p>
3645
cristyeed6cb62012-01-28 19:38:34 +00003646<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert fft_image-0.png fft_image-1.png -ift fft_image_ift.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00003647
cristydcca3fa2010-12-29 21:50:07 +00003648<p>The resulting image may need to be cropped due to padding introduced when the original image, prior to the <a href="#fft">-fft</a> or <a href="#fft">+fft</a>, was not square or even dimensioned. Any padding is at the right and/or bottom sides of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003649
cristydcca3fa2010-12-29 21:50:07 +00003650<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to use <a href="#ift">-ift</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00003651
cristydcca3fa2010-12-29 21:50:07 +00003652<p>Use <a href="#ift">+ift</a> (with HDRI enabled) to transform a pair of real and imaginary images from the frequency domain to a single image in the normal (spatial) domain.</p>
cristy3ed852e2009-09-05 21:47:34 +00003653
3654<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003655 <h4><a id="immutable"></a>-immutable</h4>
cristy3ed852e2009-09-05 21:47:34 +00003656</div>
3657
3658<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>make image immutable.</td><td style='text-align:right;'></td></tr></table>
3659
3660<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003661 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003662</div>
3663
3664<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>implode image pixels about the center.</td><td style='text-align:right;'></td></tr></table>
3665
3666<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003667 <h4><a id="insert"></a>-insert <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003668</div>
3669
3670<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>insert the last image into the image sequence.</td><td style='text-align:right;'></td></tr></table>
3671
3672<p>This option takes last image in the current image sequence and inserts it at the given index. If a negative index is used, the insert position is calculated before the last image is removed from the sequence. As such <kbd>-insert -1</kbd> will result in no change to the image sequence.</p>
3673
3674<p>The <kbd>+insert</kbd> option is equivalent to <kbd>-insert -1</kbd>. In other words, insert the last image, at the end of the current image sequence. Consequently this has no effect on the image sequence order.</p>
3675
3676<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003677 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003678</div>
3679
3680<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>use this type of rendering intent when managing the image color.</td><td style='text-align:right;'></td></tr></table>
3681
3682<p>Use this option to affect the color management operation of an image (see <a href="#profile">-profile</a>). Choose from these intents: <kbd>Absolute, Perceptual, Relative, Saturation</kbd>.</p>
3683
3684<p>The default intent is undefined.</p>
3685
3686<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3687
3688<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003689 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003690</div>
3691
3692<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the type of interlacing scheme.</td><td style='text-align:right;'></td></tr></table>
3693
3694<p>Choose from:</p>
3695
3696<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003697 none
3698 line
3699 plane
3700 partition
3701 JPEG
3702 GIF
3703 PNG
cristy3ed852e2009-09-05 21:47:34 +00003704</pre>
3705
3706<p>This option is used to specify the type of interlacing scheme for raw image formats such as <kbd>RGB</kbd> or <kbd>YUV</kbd>.</p>
3707
3708<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3709
3710<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3711
3712<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3713
3714<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3715image.G, and image.B).</p>
3716
3717<p>Use <kbd>Line</kbd> or <kbd>Plane</kbd> to create an <kbd>interlaced PNG</kbd> or <kbd>GIF</kbd> or <kbd>progressive JPEG</kbd>
3718image.</p>
3719
3720<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3721
3722<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003723 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003724</div>
3725
3726<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the pixel color interpolation method to use when looking up a color based on a floating point or real value.</td><td style='text-align:right;'></td></tr></table>
3727
cristyd0bda5e2010-09-21 16:22:45 +00003728<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003729value, you typically fall in between the pixel colors defined by the source
3730image. This setting determines how the color is determined from the colors of
3731the pixels surrounding that point. That is how to determine the color of a
3732point that falls between two, or even four different colored pixels. </p>
3733
3734<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003735 integer The color of the top-left pixel (floor function)
3736 nearest-neighbor The nearest pixel to the lookup point (rounded function)
3737 average The average color of the surrounding four pixels
3738 bilinear A double linear interpolation of pixels (the default)
3739 mesh Divide area into two flat triangular interpolations
3740 bicubic Fitted bicubic-spines of surrounding 16 pixels
3741 spline Direct spline curves (colors are blurred)
3742 filter Use resize <a href="#filter">-filter</a> settings
cristy3ed852e2009-09-05 21:47:34 +00003743</pre>
3744
3745<p>This most important for distortion operators such as <a href="#distort"
3746>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3747>-transform</a> and <a href="#fx" >-fx</a>. </p>
3748
3749<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3750
3751<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3752lookup for positions outside the boundaries of the image. </p>
3753
3754
3755<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003756 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003757</div>
3758
3759<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the space between two text lines.</td><td style='text-align:right;'></td></tr></table>
3760
3761<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003762 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003763</div>
3764
3765<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the space between two words.</td><td style='text-align:right;'></td></tr></table>
3766
3767<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003768 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003769</div>
3770
3771<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the space between two letters.</td><td style='text-align:right;'></td></tr></table>
3772
3773<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003774 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003775</div>
3776
3777<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>assign a label to an image.</td><td style='text-align:right;'></td></tr></table>
3778
cristy71a3f602010-09-15 12:38:16 +00003779<p>Use this option to assign a specific label to the image, as it is read in
3780or created. You can use the <a href="#set" >-set</a> operation to re-assign
3781a the labels of images already read in. Image formats such as TIFF, PNG,
3782MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003783
cristy71a3f602010-09-15 12:38:16 +00003784<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3785assigned to an image is used as a header string to print above the postscript
3786image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003787
cristybc9539a2010-08-16 18:06:20 +00003788<p>You can include the image filename, type, width, height, or other image
3789attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3790Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003791
3792<p>For example,</p>
3793
3794<p class="crtsnip">
3795 -label "%m:%f %wx%h" bird.miff
3796</p>
3797
cristy71a3f602010-09-15 12:38:16 +00003798<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3799"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3800is read in. If a <a href="#label">+label</a> option was used instead, any
3801existing label present in the image would be used. You can remove all labels
3802from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003803
cristy71a3f602010-09-15 12:38:16 +00003804<p>A label is not drawn on the image, but is embedded in the image datastream
3805via <em>Label</em> tag or similar mechanism. If you want the label to be
3806visible on the image itself, use the <a href="#draw">-draw</a> option, or
3807during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003808
cristy71a3f602010-09-15 12:38:16 +00003809<p>If the first character of <em class="arg">string</em> is <em
3810class="arg">@</em>, the image label is read from a file titled by the
3811remaining characters in the string. Labels in a file are literal, no embedded
3812formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003813
3814
3815<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003816 <h4><a id="lat"></a>-lat <em class="arg">width</em><br />-lat <em class="arg">width</em>x<em class="arg">height</em>{<em class="arg">+-</em>}<em class="arg">offset</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003817</div>
3818
3819<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>perform local adaptive threshold.</td><td style='text-align:right;'></td></tr></table>
3820
3821<p>Adaptively threshold each pixel based on the value of pixels in a
3822surrounding window. If the current pixel is lighter than this average plus
3823the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3824black. Small variations in pixel values such as found in scanned documents
3825can be ignored if offset is positive. A negative offset will make it more
3826sensitive to those small variations. </p>
3827
3828<p>This is commonly used to threshold images with an uneven background. It is
3829based on the assumption that average color of the small window is the
cristyeed6cb62012-01-28 19:38:34 +00003830the local background color, from which to separate the foreground color. </p>
cristy3ed852e2009-09-05 21:47:34 +00003831
3832
3833<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003834 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003835</div>
3836
3837<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>handle multiple images forming a set of image layers or animation frames.</td><td style='text-align:right;'></td></tr></table>
3838
3839<p>Perform various image operation methods to a ordered sequence of images
3840which may represent either a set of overlaid 'image layers', a GIF disposal
3841animation, or a fully-'coalesced' animation sequence. </p>
3842
3843<table class="doc">
3844 <tbody>
3845 <tr valign="top">
3846 <th align="left" style="width: 8%">Method</th>
3847 <th align="left">Description</th>
3848 </tr>
3849
3850 <tr valign="top">
3851 <td valign="top">compare-any</td>
3852 <td valign="top">Crop the second and later frames to the smallest rectangle
3853 that contains all the differences between the two images. No GIF <a
3854 href="#dispose" >-dispose</a> methods are taken into account. </td>
3855 </tr>
3856
3857 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3858 >-deconstruct</a> operator, and does not preserve animations normal
3859 working, especially when animation used layer disposal methods such as
3860 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3861 </tr>
3862
3863 <tr valign="top">
3864 <td valign="top">compare-clear</td>
3865 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3866 opaque pixels which become transparent in the second frame. That is the
3867 smallest image needed to mask or erase pixels for the next frame. </td>
3868 </tr>
3869
3870 <tr valign="top">
3871 <td valign="top">compare-overlay</td>
3872 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3873 extra color to the next image, as a result of overlaying color pixels.
3874 That is the smallest single overlaid image to add or change colors. </td>
3875 </tr>
3876
3877 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3878 composition method '<kbd>change-mask</kbd>', to reduce the image to
3879 just the pixels that need to be overlaid. </td>
3880 </tr>
3881
3882 <tr valign="top">
3883 <td valign="top">coalesce</td>
3884 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3885 >-coalesce</a> operator. Apply the layer disposal methods set in the
3886 current image sequence to form a fully defined animation sequence, as
3887 it should be displayed. Effectively converting a GIF animation into a
3888 'film strip'-like animation. </td>
3889 </tr>
3890
3891 <tr valign="top">
3892 <td valign="top">composite</td>
3893 <td valign="top">Alpha Composition of two image lists, separated by a
3894 "<kbd>null:</kbd>" image, with the destination image list first, and
3895 the source images last. An image from each list are composited
3896 together until one list is finished. The separator image and source
3897 image lists are removed. </td>
3898 </tr>
3899
3900
cristybac7a162010-06-15 19:57:29 +00003901 <tr><td></td>
3902 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3903 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3904 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003905 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003906 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003907
cristybac7a162010-06-15 19:57:29 +00003908 <tr><td></td>
3909 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003910 applied to all the images in the other image list, regardless of which
3911 list it is. In this case it is the image meta-data of the list which
3912 preserved. </td>
3913 </tr>
3914
3915
3916 <tr valign="top">
3917 <td valign="top">dispose</td>
3918 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3919 the animation after the layer disposal method has been applied, before
3920 the next sub-frame image is overlaid. That is the 'dispose' image that
3921 results from the application of the GIF <a href="#dispose"
3922 >-dispose</a> method. This allows you to check what
3923 is going wrong with a particular animation you may be developing.
3924 </td>
3925 </tr>
3926
3927 <tr valign="top">
3928 <td valign="top">flatten</td>
3929 <td valign="top">Create a canvas the size of the first images virtual
3930 canvas using the current <a href="#background" >-background</a> color,
3931 and <a href="#compose" >-compose</a> each image in turn onto that
3932 canvas. Images falling outside that canvas is clipped. Final
3933 image will have a zero virtual canvas offset. </td>
3934 </tr>
3935
cristybac7a162010-06-15 19:57:29 +00003936 <tr><td></td>
cristyeed6cb62012-01-28 19:38:34 +00003937 <td>This usually used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003938 overlaying all the prepared image layers into a final image. </td>
3939 </tr>
3940
cristybac7a162010-06-15 19:57:29 +00003941 <tr><td></td>
3942 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003943 canvas with real pixels, or to underlay a opaque color to remove
3944 transparency from an image.</td>
3945 </tr>
3946
3947
3948 <tr valign="top">
3949 <td valign="top">merge</td>
3950 <td valign="top">As 'flatten' method but merging all the given image
cristy10549a12011-05-15 19:04:46 +00003951 layers to create a new layer image just large enough to hold all the
3952 image without clipping or extra space. The new images virtual offset
3953 will preserve the position of the new layer, even if this offset is
3954 negative. The virtual canvas size of the first image is preserved.
cristy3ed852e2009-09-05 21:47:34 +00003955 </td>
cristy10549a12011-05-15 19:04:46 +00003956 </tr>
cristy3ed852e2009-09-05 21:47:34 +00003957
cristy10549a12011-05-15 19:04:46 +00003958 <tr><td></td><td>Caution is advised when handling image layers with
3959 negative offsets as few image file formats handle them correctly.
cristyeed6cb62012-01-28 19:38:34 +00003960 Following this operation method with <a href="#repage" >+repage</a>
cristy10549a12011-05-15 19:04:46 +00003961 will remove the layer offset, and create a image in which all the
3962 overlaid image positions relative to each other is preserved, though
cristyeed6cb62012-01-28 19:38:34 +00003963 not necessarily exactly where you specified them.
cristy10549a12011-05-15 19:04:46 +00003964 </td>
3965 </tr>
3966
cristyeed6cb62012-01-28 19:38:34 +00003967 <tr><td></td><td>See also 'trim-bounds' below which is closely related but
cristy10549a12011-05-15 19:04:46 +00003968 without doing the'flatten' to merge the images together. </td>
cristy3ed852e2009-09-05 21:47:34 +00003969 </tr>
3970
3971 <tr valign="top">
3972 <td valign="top">mosaic</td>
3973 <td valign="top">As 'flatten' method but expanding the initial canvas size
cristy10549a12011-05-15 19:04:46 +00003974 of the first image in a positive direction only so as to hold all the
3975 image layers. However as a virtual canvas is 'locked' to the origin,
3976 by its own definition, image layers with a negative offsets will still
3977 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
3978 if this could be a problem. </td>
3979
cristy3ed852e2009-09-05 21:47:34 +00003980 </tr>
3981
cristy10549a12011-05-15 19:04:46 +00003982 <tr><td></td><td>This method is commonly used to layout individual image
3983 using various offset but without knowing the final canvas size. The
3984 resulting image will, like 'flatten' not have any virtual offset, so
3985 can be saved to any image file format. </td>
cristy3ed852e2009-09-05 21:47:34 +00003986 </tr>
3987
3988
3989 <tr valign="top">
3990 <td valign="top">optimize</td>
3991 <td valign="top">Optimize a coalesced animation, into GIF animation using
3992 a number of general techniques. This currently a short cut to
3993 apply both the '<kbd>optimize-frame</kbd>', and
3994 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3995 include other optimization methods as they are developed. </td>
3996 </tr>
3997
3998 <tr valign="top">
3999 <td valign="top">optimize-frame</td>
4000 <td valign="top">Optimize a coalesced animation, into GIF animation by
4001 reducing the number of pixels per frame as much as possible by
4002 attempting to pick the best layer disposal method to use, while ensuring
4003 the result will continue to animate properly. </td>
4004 </tr>
4005
cristy10549a12011-05-15 19:04:46 +00004006 <tr><td></td><td> There is no guarantee that the best optimization is found.
4007 But then no reasonably fast GIF optimization algorithm can do this.
cristy3ed852e2009-09-05 21:47:34 +00004008 However this does seem to do better than most other GIF frame
4009 optimizers seen. </td>
4010 </tr>
4011
4012 <tr valign="top">
4013 <td valign="top">optimize-plus</td>
4014 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
4015 overall optimization by adding extra frames to the animation, without
4016 changing the final look or timing of the animation. The frames are
4017 added to attempt to separate the clearing of pixels from the
4018 overlaying of new additional pixels from one animation frame to the
4019 next. If this does not improve the optimization (for the next frame
4020 only), it will fall back to the results of the previous normal
4021 '<kbd>optimize-frame</kbd>' technique. </td>
4022 </tr>
4023
cristy10549a12011-05-15 19:04:46 +00004024 <tr><td></td><td>There is the possibility that the change in the disposal
4025 style will result in a worsening in the optimization of later frames,
4026 though this is unlikely. In other words there no guarantee that it is
4027 better than the normal '<kbd>optimize-frame</kbd>' technique. For some
4028 animations however you can get a vast improvement in the final
4029 animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00004030 </tr>
4031
4032 <tr valign="top">
4033 <td valign="top">optimize-transparency</td>
4034 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
4035 overlay images with transparency, if it does not change the resulting
4036 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
4037 </td>
4038 </tr>
4039
cristy10549a12011-05-15 19:04:46 +00004040 <tr><td></td><td>This should allow a existing frame optimized GIF animation
4041 to compress into a smaller file size due to larger areas of one
4042 (transparent) color rather than a pattern of multiple colors repeating
4043 the current disposed image of the last frame. </td>
cristy3ed852e2009-09-05 21:47:34 +00004044 </tr>
4045
4046 <tr valign="top">
4047 <td valign="top">remove-dups</td>
4048 <td valign="top">Remove (and merge time delays) of duplicate consecutive
4049 images, so as to simplify layer overlays of coalesced animations.
4050 </td>
4051 </tr>
4052
cristy10549a12011-05-15 19:04:46 +00004053 <tr><td></td><td>Usually this a result of using a constant time delay
4054 across the whole animation, or after a larger animation was split into
4055 smaller sub-animations. The duplicate frames could also have been
4056 used as part of some frame optimization methods. </td>
cristy3ed852e2009-09-05 21:47:34 +00004057 </tr>
4058
4059 <tr valign="top">
4060 <td valign="top">remove-zero</td>
4061 <td valign="top">Remove any image with a zero time delay, unless ALL the
4062 images have a zero time delay (and is not a proper timed animation, a
4063 warning is then issued). </td>
4064 </tr>
4065
cristy10549a12011-05-15 19:04:46 +00004066 <tr><td></td><td>In a GIF animation, such images are usually frames which
4067 provide partial intermediary updates between the frames that are
cristyeed6cb62012-01-28 19:38:34 +00004068 actually displayed to users. These frames are usually added for
cristy10549a12011-05-15 19:04:46 +00004069 improved frame optimization in GIF animations. </td>
cristy3ed852e2009-09-05 21:47:34 +00004070 </tr>
4071
4072 <tr valign="top">
4073 <td valign="top">trim-bounds</td>
4074 <td valign="top">Find the bounds of all the images in the current
4075 image sequence, then adjust the offsets so all images are contained on
cristy10549a12011-05-15 19:04:46 +00004076 a minimal positive canvas. None of the image data is modified or
4077 merged, only the individual image virtual canvas size and offset.
4078 All the images is given the same canvas size, and and will have
4079 a positive offset, but will remain in the same position relative to
4080 each other. As a result of the minimal canvas size at least one image
4081 will touch every edge of that canvas. The image data touching those
4082 edges however may be transparent. </td>
4083 </tr>
4084
4085 <tr><td></td><td>The result is much like if you used 'merge' followed by a
4086 <a href="#repage" >+repage</a> option, except that all the images
4087 have been kept separate. If 'flatten' is used after using
4088 'trim-bounds' you will get the same result. </td>
cristy3ed852e2009-09-05 21:47:34 +00004089 </tr>
4090
4091 </tbody>
4092</table>
4093
4094<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
4095
4096<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
4097>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
cristy10549a12011-05-15 19:04:46 +00004098>-mosaic</a> are only aliases for the above methods and may be depreciated in
4099the future. Also see <a href="#page" >-page</a>, <a href="#repage"
4100>-repage</a> operators, the <a href="#compose" >-compose</a> setting, and the
4101GIF <a href="#dispose" >-dispose</a> and <a href="#delay" >-delay</a>
4102settings. </p>
cristy3ed852e2009-09-05 21:47:34 +00004103
4104
4105<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004106 <h4><a id="level"></a>-level <em class="arg">black_point</em>{,<em class="arg">white_point</em>}{<em class="arg">%</em>}{,<em class="arg">gamma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00004107</div>
4108
4109<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>adjust the level of image channels.</td><td style='text-align:right;'></td></tr></table>
4110
4111<p>Given one, two or three values delimited with commas: black-point,
4112white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
4113white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
4114point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
4115contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
4116both black and white points are percentages of the full color range. Gamma
4117will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
4118omitted, the default of 1.0 (no gamma correction) is assumed.</p>
4119
4120<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
4121the given '<kbd>black_point</kbd>' value in the original image is set to
4122zero (or black), while the given '<kbd>white_point</kbd>' value is set to
4123<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
4124to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
4125adjusted. </p>
4126
4127<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
4128adding the special '!' flag anywhere in the argument list, will cause the
4129operator to do the reverse of the level adjustment. That is a zero, or
4130<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
4131adjusted to the given level values, allowing you to de-contrast, or compress
4132the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
4133
4134<p>Only the channels defined by the current <a href="#channel">-channel</a>
4135setting are adjusted (defaults to RGB color channels only), allowing you to
4136limit the effect of this operator. </p>
4137
4138<p>Please note that the transparency channel is treated as 'matte'
4139values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
4140
4141
4142<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004143 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00004144 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
4145</div>
4146
cristyd0bda5e2010-09-21 16:22:45 +00004147<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>adjust the level of an image using the provided dash separated colors.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00004148
4149<p>This function is exactly like <a href="#level">-level</a>, except that the
4150value value for each color channel is determined by the
4151'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
4152described under the <a href="#fill">-fill</a> option). </p>
4153
cristyd0bda5e2010-09-21 16:22:45 +00004154<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
4155is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00004156colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00004157adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00004158
4159<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
4160will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00004161respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00004162those colors. This can also be used to convert a plain gray-scale image into a
4163one using the gradient of colors specified. </p>
4164
4165<p>By supplying a single color with a comma separator either before or after
4166that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00004167respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00004168used for both the black and white color points, making the operator either
4169threshold the images around that color (- form) or set all colors to that
4170color (+ form). </p>
4171
4172
4173<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004174 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004175</div>
4176
4177<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the pixel cache resource limit.</td><td style='text-align:right;'></td></tr></table>
4178
4179<p>Choose from: <kbd>area</kbd>, <kbd>disk</kbd>, <kbd>file</kbd>, <kbd>map</kbd>, <kbd>memory</kbd>, <kbd>threads</kbd>, or <kbd>time</kbd>.</p>
4180
cristy6b636652009-12-05 17:16:11 +00004181<p>The value for <kbd>file</kbd> is in number of files. The other limits are in bytes. By default the limits are 768 files, 2GB of image area, 1.5GiB memory, 8GiB memory map, and 18.45EB of disk. These limits are adjusted relative to the available resources on your computer if this information is available. When any limit is reached, ImageMagick fails in some fashion but attempts to take compensating actions, if possible. For example, the following limits memory:</p>
cristy3ed852e2009-09-05 21:47:34 +00004182
4183<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00004184 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00004185</p>
4186
4187<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
4188
cristyeed6cb62012-01-28 19:38:34 +00004189<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>identify -list resource</span><span class='crtout'></span></p><pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004190 File Area Memory Map Disk Thread Time
4191 ------------------------------------------------------------------------------
4192 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
cristydcca3fa2010-12-29 21:50:07 +00004193</pre>
4194
cristy3ed852e2009-09-05 21:47:34 +00004195<p>Requests for pixel storage to keep intermediate images are satisfied by one of three resource categories: in-memory pool, memory-mapped files pool, and disk pool (in that order) depending on the <a href="../www/command-line-options.html#limit">&#x2011;limit</a> settings and whether the system honors a resource request. If the total size of allocated pixel storage in the given pool reaches the corresponding limit, the request is passed to the next pool. Additionally, requests that exceed the <kbd>area</kbd> limit automagically are allocated on disk.</p>
4196
4197<p>To illustrate how ImageMagick utilizes resource limits, consider a typical image resource request. First, ImageMagick tries to allocate the pixels in memory. The request might be denied if the resource request exceeds the <kbd>memory</kbd> limit or if the system does not honor the request. If a memory request is not honored, the pixels are allocated to disk and the file is memory-mapped. However, if the allocation request exceeds the <kbd>map</kbd> limit, the resource allocation goes to disk. In all cases, if the resource request exceeds the <kbd>area</kbd> limit, the pixels are automagically cached to disk. If the disk has a hard limit, the program fails.</p>
4198
4199<p>In most cases you simply do not need to concern yourself with resource limits. ImageMagick chooses reasonable defaults and most images do not tax your computer resources. Where limits do come in handy is when you process images that are large or on shared systems where ImageMagick can consume all or most of the available memory. In this case, the ImageMagick workflow slows other processes or, in extreme cases, brings the system to a halt. Under these circumstances, setting limits give some assurances that the ImageMagick workflow will not interfere with other concurrent uses of the computer. For example, assume you have a web interface that processes images uploaded from the Internet. To assure ImageMagick does not exceed 10mb of memory you can simply set the area limit to 10mb:</p>
4200
4201<p class="crtsnip">
4202-limit area 10mb
4203</p>
4204
cristyd0bda5e2010-09-21 16:22:45 +00004205<p>Now whenever a large image is processed, the pixels are automagically cached to disk instead of memory. This of course implies that large images typically process very slowly, simply because pixel processing in memory can be an order of magnitude faster than on disk. Because your web site users might inadvertently upload a huge image to process, you should set a disk limit as well:</p>
cristy3ed852e2009-09-05 21:47:34 +00004206
4207<p class="crtsnip">
4208-limit area 10mb -limit disk 500mb
4209</p>
4210
4211<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
4212
4213<p>In addition to command-line resource limit option, resources can be set with <a href="../www/resources.html#environment">environment variables</a>. Set the environment variables <kbd>MAGICK_AREA_LIMIT</kbd>, <kbd>MAGICK_DISK_LIMIT</kbd>, <kbd>MAGICK_FILE_LIMIT</kbd>, <kbd>MAGICK_MEMORY_LIMIT</kbd>, <kbd>MAGICK_MAP_LIMIT</kbd>, <kbd>MAGICK_THREAD_LIMIT</kbd>, <kbd>MAGICK_TIME_LIMIT</kbd> for limits of image area, disk space, open files, heap memory, memory map, number of threads of execution, and maximum elapsed time in seconds respectively.</p>
4214
4215<p> Inquisitive users can try adding <a href="#debug">-debug cache</a> to their commands and then scouring the generated output for references to the pixel cache, in order to determine how the pixel cache was allocated and how resources were consumed. Advanced Unix/Linux users can pipe that output through <kbd>grep memory|open|destroy|disk</kbd> for more readable sifting.
4216</p>
4217
4218<p>For more about ImageMagick's use of resources, see the section <b>Cache Storage and Resource Requirements</b> on the <a href="../www/architecture.html#cache">Architecture</a> page.
4219</p>
4220
4221<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004222 <h4><a id="linear-stretch"></a>-linear-stretch <em class="arg">black-point</em><br />-linear-stretch <em class="arg">black-point</em>{x<em class="arg">white-point</em>}{<em class="arg">%</em>}}</h4>
cristy3ed852e2009-09-05 21:47:34 +00004223</div>
4224
4225<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Linear with saturation stretch.</td><td style='text-align:right;'></td></tr></table>
4226
cristyd934d102009-10-10 12:55:13 +00004227<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
4228and uses a 'histogram bin' to determine the range of color values that needs to
cristyeed6cb62012-01-28 19:38:34 +00004229be stretched. However it then stretches those colors using the <a
cristyd934d102009-10-10 12:55:13 +00004230href="#level" >-level</a> operator.</p>
4231
4232<p>As such while the initial determination may have 'binning' round off
4233effects, the image colors are stretched mathematically, rather than using the
4234histogram bins. This makes the operator more accurate. </p>
4235
4236<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
4237'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
4238perfect stretch of the color range. </p>
4239
4240<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
4241normalization of mathematical images. </p>
4242
4243<p>This operator is under review for re-development. </p>
4244
4245
cristy3ed852e2009-09-05 21:47:34 +00004246<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004247 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00004248</div>
4249
4250<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the line width for subsequent draw operations.</td><td style='text-align:right;'></td></tr></table>
4251
4252<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004253 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004254</div>
4255
4256<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>rescale image with seam-carving.</td><td style='text-align:right;'></td></tr></table>
4257
4258<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4259
4260<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004261 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004262</div>
4263
4264<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Print a list of supported arguments for various options or settings. Choose from these list types:</td><td style='text-align:right;'></td></tr></table>
4265
4266<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004267 Align Alpha Boolean Channel
4268 Class ClipPath Coder Color
4269 Colorspace Command Compose Compress
4270 Configure DataType Debug Decoration
4271 Delegate Direction Dispose Distort
4272 Dither Endian Evaluate FillRule
4273 Filter Font Format Function
4274 Gravity ImageList Intent Interlace
4275 Interpolate Kernel Layers LineCap
4276 LineJoin List Locale LogEvent
4277 Log Magic Method Metric
4278 Mime Mode Morphology Module
4279 Noise Orientation Policy PolicyDomain
4280 PolicyRights Preview Primitive QuantumFormat
4281 Resource SparseColor Storage Stretch
4282 Style Threshold Type Units
4283 Validate VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004284</pre>
4285
cristybac7a162010-06-15 19:57:29 +00004286<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4287list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4288available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004289
cristyeed6cb62012-01-28 19:38:34 +00004290<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>identify -list list</span></p>
cristy3ed852e2009-09-05 21:47:34 +00004291<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004292 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004293</div>
4294
4295<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify format for debug log.</td><td style='text-align:right;'></td></tr></table>
4296
cristybac7a162010-06-15 19:57:29 +00004297<p>This option specifies the format for the log printed when the <a
4298href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004299
cristybac7a162010-06-15 19:57:29 +00004300<p>You can display the following components by embedding special format
4301characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004302
4303<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004304 %d domain
4305 %e event
4306 %f function
4307 %l line
4308 %m module
4309 %p process ID
4310 %r real CPU time
4311 %t wall clock time
4312 %u user CPU time
4313 %% percent sign
4314 \n newline
4315 \r carriage return
cristy3ed852e2009-09-05 21:47:34 +00004316</pre>
4317
4318<p>For example:</p>
4319
cristyeed6cb62012-01-28 19:38:34 +00004320<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -debug coders -log "%u %m:%l %e" in.gif out.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00004321<p>The default behavior is to print all of the components.</p>
4322
4323<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004324 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004325</div>
4326
4327<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>add Netscape loop extension to your GIF animation.</td><td style='text-align:right;'></td></tr></table>
4328
cristybac7a162010-06-15 19:57:29 +00004329<p>Set iterations to zero to repeat the animation an infinite number of times,
4330otherwise the animation repeats itself up to <em class="arg">iterations</em>
4331times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004332
4333<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004334 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004335</div>
4336
4337<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>when comparing images, de-emphasize pixel differences with this color.</td><td style='text-align:right;'></td></tr></table>
4338
4339<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004340 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004341</div>
4342
4343<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>magnify the image.</td><td style='text-align:right;'></td></tr></table>
4344
4345
4346<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004347 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004348</div>
4349
4350<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Display image using this <em class="arg">type</em>.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>]</td></tr></table>
4351
4352<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4353
4354<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004355 best
4356 default
4357 gray
4358 red
4359 green
4360 blue
cristy3ed852e2009-09-05 21:47:34 +00004361</pre>
4362
cristybac7a162010-06-15 19:57:29 +00004363<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4364Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4365the type and <kbd>display</kbd> searches the list of colormap types in
4366<kbd>top-to-bottom</kbd> order until one is located. See <em
4367class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004368
4369
4370<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004371 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004372</div>
4373
4374<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>pixel map.</td><td style='text-align:right;'>[<a href="../www/stream.html">stream</a>]</td></tr></table>
4375
4376<p>Here are the valid components of a map:</p>
4377
4378<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004379 r red pixel component
4380 g green pixel component
4381 b blue pixel component
4382 a alpha pixel component (0 is transparent)
4383 o opacity pixel component (0 is opaque)
4384 i grayscale intensity pixel component
4385 c cyan pixel component
4386 m magenta pixel component
4387 y yellow pixel component
4388 k black pixel component
4389 p pad component (always 0)
cristy3ed852e2009-09-05 21:47:34 +00004390</pre>
4391
cristybac7a162010-06-15 19:57:29 +00004392<p>You can specify as many of these components as needed in any order (e.g.
4393bgr). The components can repeat as well (e.g. rgbr).</p>
4394
cristy3ed852e2009-09-05 21:47:34 +00004395
4396<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004397 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004398<em class="arg">filename</em></h4>
4399</div>
4400
cristyacc04882011-05-04 23:03:43 +00004401<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Prevent updates to image pixels specified by the mask.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00004402
cristyacc04882011-05-04 23:03:43 +00004403<p>This the same as using a mask used for composite masking operations, with
4404grayscale values causing blended updates of the image the mask is attached to.
4405</P>
4406
4407<p>Use <a href="#mask">+mask</a> to remove the mask from images.</p>
4408
4409<p>Also see <a href="#clip-mask">-clip-mask</a> which work in the same way,
4410but with strict boolean masking. </p>
cristy3ed852e2009-09-05 21:47:34 +00004411
4412<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004413 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004414</div>
4415
4416<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify the color to be used with the <a href="#frame">-frame</a> option.</td><td style='text-align:right;'></td></tr></table>
4417
4418<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4419
cristybac7a162010-06-15 19:57:29 +00004420<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4421style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004422
4423<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004424 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004425</div>
4426
4427<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>return the maximum intensity of an image sequence.</td><td style='text-align:right;'></td></tr></table>
4428
cristyacc04882011-05-04 23:03:43 +00004429<p>Select the 'maximum' value from all the surrounding pixels. </p>
4430
4431<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4432name. </p>
4433
cristyd2baf7d2010-03-06 04:26:44 +00004434<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004435 <h4><a id="median"></a>-median <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004436</div>
4437
4438<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>apply a median filter to the image.</td><td style='text-align:right;'></td></tr></table>
4439
cristyacc04882011-05-04 23:03:43 +00004440<p>Select the 'middle' value from all the surrounding pixels. </p>
4441
4442<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4443name. </p>
4444
cristy3ed852e2009-09-05 21:47:34 +00004445<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004446 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004447</div>
4448
4449<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Output to STDERR a measure of the differences between images according to the <em class="arg">type</em> given metric.</td><td style='text-align:right;'></td></tr></table>
4450
4451<p>Choose from:</p>
4452
4453<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004454 AE absolute error count, number of different pixels (-fuzz effected)
4455 FUZZ mean color distance
4456 MAE mean absolute error (normalized), average channel error distance
4457 MEPP mean error per pixel (normalized mean error, normalized peak error)
4458 MSE mean error squared, average of the channel error squared
4459 NCC normalized cross correlation
4460 PAE peak absolute (normalize peak absolute)
4461 PSNR peak signal to noise ratio
4462 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004463</pre>
4464
cristy771f7a72010-11-27 21:42:59 +00004465<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4466with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4467only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004468size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristyeed6cb62012-01-28 19:38:34 +00004469'similar', while '<kbd>MAE</kbd>' determines the factor needed
cristybac7a162010-06-15 19:57:29 +00004470for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004471
4472<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4473('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004474normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004475
cristybac7a162010-06-15 19:57:29 +00004476<p>To print a complete list of metrics, use the <a href="#list">-list
4477metrics</a> option.</p>
4478
cristy3ed852e2009-09-05 21:47:34 +00004479
cristyd2baf7d2010-03-06 04:26:44 +00004480<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004481 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004482</div>
4483
4484<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>return the minimum intensity of an image sequence.</td><td style='text-align:right;'></td></tr></table>
4485
cristyacc04882011-05-04 23:03:43 +00004486<p>Select the 'minimal' value from all the surrounding pixels. </p>
4487
4488<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4489name. </p>
4490
4491
cristy3ed852e2009-09-05 21:47:34 +00004492
4493<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004494 <h4><a id="mode"></a>-mode <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004495</div>
4496
cristy29c5c992011-06-25 13:58:49 +00004497<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>make each pixel the 'predominant color' of the neighborhood.</td><td style='text-align:right;'>[<a href="../www/convert.html">convert</a>, <a href="../www/mogrify.html">mogrify</a>]</td></tr></table>
cristybe3c5be2011-03-05 17:35:07 +00004498
4499<div style="margin: auto;">
4500 <h4>-mode <em class="arg">value</em></h4>
4501</div>
4502
cristy3ed852e2009-09-05 21:47:34 +00004503<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Mode of operation.</td><td style='text-align:right;'>[<a href="../www/montage.html">montage</a>]</td></tr></table>
4504
cristybac7a162010-06-15 19:57:29 +00004505<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4506Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004507
cristybac7a162010-06-15 19:57:29 +00004508<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4509for a list of <a href="#mode" >-mode</a> arguments available in your
4510ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004511
4512
4513<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004514 <h4><a id="modulate"></a>-modulate <em class="arg">brightness</em>[,<em class="arg">saturation</em>,<em class="arg">hue</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00004515</div>
4516
cristybac7a162010-06-15 19:57:29 +00004517<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Vary the <em class="arg">brightness</em>, <em
4518class="arg">saturation</em>, and <em class="arg">hue</em> of an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00004519
cristyb36feb22010-03-26 16:54:37 +00004520<p>The arguments are given as a percentages of variation. A value of 100 means
4521no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004522
cristyb36feb22010-03-26 16:54:37 +00004523<p>The <em class="arg">brightness</em> is a multiplier of the overall
4524brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4525twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4526before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004527
cristyb36feb22010-03-26 16:54:37 +00004528<p>The <em class="arg">saturation</em> controls the amount of color in an
4529image. For example, 0 produce a grayscale image, while a large value such as
4530200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004531
cristyb36feb22010-03-26 16:54:37 +00004532<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4533within the image by the amount specified. For example, 50 results in
4534a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4535A value of either 0 or 200 results in a complete 180 degree rotation of the
4536image. Using a value of 300 is a 360 degree rotation resulting in no change to
4537the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004538
cristyb36feb22010-03-26 16:54:37 +00004539<p>For example, to increase the color brightness by 20% and decrease the color
4540saturation by 10% and leave the hue unchanged, use <a
4541href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004542
cristyb36feb22010-03-26 16:54:37 +00004543<p>Use <a href="#set">-set</a> attribute of '<kbd
4544class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4545modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4546<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004547
cristyeed6cb62012-01-28 19:38:34 +00004548<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert image.png -set option:modulate:colorspace hsb -modulate 120,90 modulate.png</span></p>
cristyb36feb22010-03-26 16:54:37 +00004549
cristy3ed852e2009-09-05 21:47:34 +00004550<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004551 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004552</div>
4553
4554<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>monitor progress.</td><td style='text-align:right;'></td></tr></table>
4555
4556
4557<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004558 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004559</div>
4560
4561<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>transform the image to black and white.</td><td style='text-align:right;'></td></tr></table>
4562
cristy3ed852e2009-09-05 21:47:34 +00004563<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004564 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004565</div>
4566
4567<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>morphs an image sequence.</td><td style='text-align:right;'></td></tr></table>
4568
4569<p>Both the image pixels and size are linearly interpolated to give the
cristyeed6cb62012-01-28 19:38:34 +00004570appearance of a metamorphosis from one image to the next, over all the images
cristy3ed852e2009-09-05 21:47:34 +00004571in the current image list. The added images are the equivalent of a <a
4572href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4573argument determine how many images to interpolate between each image. </p>
4574
4575
4576<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004577 <h4><a id="morphology"></a>-morphology</h4>
4578 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004579</div>
4580
cristy2c839602010-04-03 02:32:08 +00004581<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>apply a morphology method to the image.</td><td style='text-align:right;'></td></tr></table>
cristy488844c2010-01-22 14:02:05 +00004582
cristydcca3fa2010-12-29 21:50:07 +00004583<p>Until I get around to writing a option summary for this, see <a
4584href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4585Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004586
4587
cristy488844c2010-01-22 14:02:05 +00004588<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004589 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004590</div>
4591
4592<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>an simple alias for the <a href="#layers" >-layers</a> method "mosaic"</td><td style='text-align:right;'></td></tr></table>
4593
4594
4595<div style="margin: auto;">
cristyeed6cb62012-01-28 19:38:34 +00004596 <h4><a id="motion-blur"></a>-motion-blur <em class="arg">radius</em><br />-motion-blur <em class="arg">radius</em>x<em class="arg">sigma</em>+<em class="arg">angle</em>+<em class="arg">bias</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004597</div>
4598
4599<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate motion blur.</td><td style='text-align:right;'></td></tr></table>
4600
4601<p>Blur with the given radius, standard deviation (sigma), and angle. The
4602angle given is the angle toward which the image is blurred. That is the
4603direction people would consider the object is coming from. </p>
4604
4605<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004606definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004607
4608<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4609pixels which are outside the image proper are blurred into the final result.
4610</p>
4611
4612<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004613 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004614</div>
4615
4616<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>name an image.</td><td style='text-align:right;'></td></tr></table>
4617<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004618 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004619</div>
4620
cristyb29bc032010-02-01 20:29:43 +00004621<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>replace each pixel with its complementary color.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00004622
4623<p>The red, green, and blue intensities of an image are negated. White becomes black, yellow becomes blue, etc. Use <a href="#negate">+negate</a> to only negate the grayscale pixels of the image.</p>
4624
4625<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004626 <h4><a id="noise"></a>-noise <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004627 +noise <em class="arg">type</em></h4>
4628</div>
4629
4630<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Add or reduce noise in an image.</td><td style='text-align:right;'></td></tr></table>
4631
4632<p>The principal function of noise peak elimination filter is to smooth the objects within an image without losing edge information and without creating undesired structures. The central idea of the algorithm is to replace a pixel with its next neighbor in value within a pixel window, if this pixel has been found to be noise. A pixel is defined as noise if and only if this pixel is a maximum or minimum within the pixel window.</p>
4633
4634<p>Use <kbd><a href="#noise">-noise</a> <em class="arg">radius</em></kbd> to specify the width of the neighborhood when reducing noise.</p>
4635
4636<p>Use <a href="#noise">+noise</a> followed by a noise <em class="arg">type</em> to add noise to an image. Choose from these noise types:</p>
4637
4638<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004639 Gaussian
4640 Impulse
4641 Laplacian
4642 Multiplicative
4643 Poisson
4644 Random
4645 Uniform
cristy3ed852e2009-09-05 21:47:34 +00004646</pre>
4647
4648<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4649
cristyeed6cb62012-01-28 19:38:34 +00004650<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allows
4651the use of a controlling value to specify the amount of noise that should be
cristy83543962009-10-16 19:04:28 +00004652added to an image. </p>
4653
cristy3ed852e2009-09-05 21:47:34 +00004654
4655<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004656 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004657</div>
4658
4659<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Increase the contrast in an image by <em>stretching</em> the range of intensity values.</td><td style='text-align:right;'></td></tr></table>
4660
cristyd934d102009-10-10 12:55:13 +00004661<p>The intensity values are stretched to cover the entire range of possible
4662values. While doing so, black-out at most <em>2%</em> of the pixels and
4663white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004664
cristyd934d102009-10-10 12:55:13 +00004665<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4666is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4667(Before this version, it was equivalent to <a href="#contrast-stretch"
4668>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004669
cristyd934d102009-10-10 12:55:13 +00004670<p>All the channels are normalized in concert by the came amount so as to
4671preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004672setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004673setting will normalize the RGB channels independently.</p>
4674
cristydcca3fa2010-12-29 21:50:07 +00004675<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004676Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004677that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004678
4679<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004680
4681
4682<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004683 <h4><a id="ordered-dither"></a>-ordered-dither <em class="arg">threshold_map</em>{,<em class="arg">level</em>...}</h4>
cristy3ed852e2009-09-05 21:47:34 +00004684</div>
4685
cristyd934d102009-10-10 12:55:13 +00004686<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>dither the image using a pre-defined ordered dither <em
4687class="arg">threshold map</em> specified, and a uniform color map with the
4688given number of <em class="arg">levels</em> per color channel . </td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00004689
4690<p>You can choose from these standard threshold maps:</p>
4691
4692<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004693 threshold 1x1 Threshold 1x1 (non-dither)
4694 checks 2x1 Checkerboard 2x1 (dither)
4695 o2x2 2x2 Ordered 2x2 (dispersed)
4696 o3x3 3x3 Ordered 3x3 (dispersed)
4697 o4x4 4x4 Ordered 4x4 (dispersed)
4698 o8x8 8x8 Ordered 8x8 (dispersed)
4699 h4x4a 4x1 Halftone 4x4 (angled)
4700 h6x6a 6x1 Halftone 6x6 (angled)
4701 h8x8a 8x1 Halftone 8x8 (angled)
4702 h4x4o Halftone 4x4 (orthogonal)
4703 h6x6o Halftone 6x6 (orthogonal)
4704 h8x8o Halftone 8x8 (orthogonal)
4705 h16x16o Halftone 16x16 (orthogonal)
4706 c5x5b c5x5 Circles 5x5 (black)
4707 c5x5w Circles 5x5 (white)
4708 c6x6b c6x6 Circles 6x6 (black)
4709 c6x6w Circles 6x6 (white)
4710 c7x7b c7x7 Circles 7x7 (black)
4711 c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004712</pre>
4713
cristy945bb352011-04-01 15:39:28 +00004714<p> The <kbd>threshold</kbd> generated a simple 50% threshold of the image.
cristybaacd172011-04-30 23:11:03 +00004715This could be used with <em class="arg" >level</em> to do the equivalent of <a
cristy945bb352011-04-01 15:39:28 +00004716href="#posterize" >-posterize</a> to reduce an image to basic primary colors.
4717</p>
cristy3ed852e2009-09-05 21:47:34 +00004718
cristyeed6cb62012-01-28 19:38:34 +00004719<p>The <kbd>checks</kbd> pattern produces a 3 level checkerboard dither
cristy945bb352011-04-01 15:39:28 +00004720pattern. That is a grayscale will become a pattern of solid black, solid
4721white, and mid-tone colors into a checkerboard pattern of black and white.
4722</p>
cristy3ed852e2009-09-05 21:47:34 +00004723
cristy945bb352011-04-01 15:39:28 +00004724<p>You can define your own <em class="arg" >threshold map</em> for ordered
4725dithering and halftoning your images, in either personal or system
4726<kbd>thresholds.xml</kbd> XML file. See <a href="resources.html" >Resources</A>
4727for more details of configuration files. </p>
cristy3ed852e2009-09-05 21:47:34 +00004728
cristy945bb352011-04-01 15:39:28 +00004729<p>To print a complete list of the thresholds that have been defined, use the
4730<a href="#list" >-list threshold</a> option.</p>
4731
4732<p>Note that at this time the same threshold dithering map is used for all
4733color channels, no attempt is made to offset or rotate the map for different
4734channels is made, to create an offset printing effect. Also as the maps are
4735simple threshold levels, the halftone and circle maps will create incomplete
4736circles along the edges of a colored area. Also all the effects are purely
4737on/off boolean effects, without anti-aliasing to make the circles smooth
4738looking. Large dots can be made to look better with a small amount of blurring
4739after being created. </p>
cristy3ed852e2009-09-05 21:47:34 +00004740
4741
4742<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004743 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004744</div>
4745
4746<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>change this color to the fill color within the image.</td><td style='text-align:right;'></td></tr></table>
4747
cristyc54f5d42009-11-27 21:36:31 +00004748<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004749described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4750>-fuzz</a> setting can be used to match and replace colors similar to the one
4751given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004752
cristyb36feb22010-03-26 16:54:37 +00004753<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4754the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004755
cristyb36feb22010-03-26 16:54:37 +00004756<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4757as <a href="#opaque" >-opaque</a> but replaces the matching color with
4758transparency rather than the current <a href="#fill">-fill</a> color setting.
4759To ensure that it can do this it also ensures that the image has an alpha
4760channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4761the new transparent colors, and does not require you to modify the <a
4762href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004763
cristy3ed852e2009-09-05 21:47:34 +00004764
4765<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004766 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004767</div>
4768
4769<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify orientation of a digital camera image.</td><td style='text-align:right;'></td></tr></table>
4770
4771<p>Choose from these orientations:</p>
4772
4773<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004774 bottom-left
4775 bottom-right
4776 left-bottom
4777 left-top
4778 right-bottom
4779 right-top
4780 top-left
4781 top-right
4782 undefined
cristy3ed852e2009-09-05 21:47:34 +00004783</pre>
4784
cristyd934d102009-10-10 12:55:13 +00004785<p>To print a complete list of orientations, use the <a href="#list" >-list
4786orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004787
4788
4789<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004790 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004791 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4792 +page
4793 </h4>
4794</div>
4795
4796<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the size and location of an image on the larger virtual canvas.</td><td style='text-align:right;'></td></tr></table>
4797
4798<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
4799
4800<p>For convenience you can specify the page size using <em class="arg">media</em> (see below). Offsets can then be added as with other <em class="arg">geometry</em> arguments (e.g. <a href="#page">-page</a>&nbsp;<kbd>Letter+43+43</kbd>).</p>
4801
4802<p>Use <em class="arg">media</em> as shorthand to specify the dimensions (<em class="arg">width</em>x<em class="arg">height</em>) of the <em class="arg">PostScript</em> page in dots per inch or a TEXT page in pixels. The choices for a PostScript page are:</p>
4803<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4804<thead>
4805 <tr valign="top">
4806 <th align="center"><em class="arg">media</em></th>
4807 <th align="center"><em class="arg">width</em></th>
4808 <th align="center"><em class="arg">height</em></th>
4809 </tr>
4810</thead>
4811<tbody>
4812<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4813<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4814<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4815<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4816<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4817<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4818<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4819<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4820<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4821<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4822<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4823<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4824<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4825<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4826<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4827<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4828<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4829<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4830<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4831<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4832<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4833<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4834<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4835<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4836<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4837<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4838<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4839<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4840<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4841<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4842<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4843<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4844<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4845<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4846<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4847<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4848<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4849<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4850</tbody>
4851</table>
4852
4853
4854
4855
4856<p>This option is also used to place subimages when writing to a multi-image format that supports offsets, such as GIF89 and MNG. When used for this purpose the offsets are always measured from the top left corner of the canvas and are not affected by the <a href="#gravity">-gravity</a> option. To position a GIF or MNG image, use <a href="#page">-page</a><em class="arg">{+-}x{+-}y</em> (e.g. -page +100+200). When writing to a MNG file, a <a href="#page">-page</a> option appearing ahead of the first image in the sequence with nonzero width and height defines the width and height values that are written in the <kbd>MHDR</kbd> chunk. Otherwise, the MNG width and height are computed from the bounding box that contains all images in the sequence. When writing a GIF89 file, only the bounding box method is used to determine its dimensions.</p>
4857
4858<p>For a PostScript page, the image is sized as in <a href="#geometry">-geometry</a> but positioned relative to the <em>lower left-hand corner</em> of the page by {+-}<kbd>x</kbd><em class="arg">offset</em>{+-}<kbd>y</kbd> <em class="arg">offset</em>. Use <a href="#page">-page 612x792</a>, for example, to center the image within the page. If the image size exceeds the PostScript page, it is reduced to fit the page. The default gravity for the <a href="#page">-page</a> option is <em class="arg">NorthWest</em>, i.e., positive <kbd>x</kbd> and <kbd>y</kbd> <em class="arg">offset</em> are measured rightward and downward from the top left corner of the page, unless the <a href="#gravity">-gravity</a> option is present with a value other than <em class="arg">NorthWest</em>.</p>
4859
4860<p>The default page dimensions for a TEXT image is 612x792.</p>
4861
4862<p>This option is used in concert with <a href="#density">-density</a>.</p>
4863
4864<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4865
4866<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004867 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004868</div>
4869
4870<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate an oil painting.</td><td style='text-align:right;'></td></tr></table>
4871
4872<p>Each pixel is replaced by the most frequent color in a circular neighborhood whose width is specified with <em class="arg">radius</em>.</p>
4873
4874<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004875 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004876
4877<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>write images to this path on disk.</td><td style='text-align:right;'></td></tr></table>
4878
4879<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004880 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004881</div>
4882
4883<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Pause between animation loops.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>]</td></tr></table>
4884
4885<p>Pause for the specified number of seconds before repeating the animation.</p>
4886
4887<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004888 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004889</div>
4890
4891<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Pause between snapshots.</td><td style='text-align:right;'>[<a href="../www/import.html">import</a>]</td></tr></table>
4892
4893<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4894
4895<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004896 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004897</div>
4898
4899<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>efficiently determine image characteristics.</td><td style='text-align:right;'></td></tr></table>
4900
4901<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004902 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004903</div>
4904
4905<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>pointsize of the PostScript, OPTION1, or TrueType font.</td><td style='text-align:right;'></td></tr></table>
4906
4907<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004908 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004909</div>
4910
4911<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate a Polaroid picture.</td><td style='text-align:right;'></td></tr></table>
4912
4913<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4914
4915<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004916 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004917</div>
4918
4919<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>reduce the image to a limited number of color levels.</td><td style='text-align:right;'></td></tr></table>
4920
4921<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004922 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004923</div>
4924
4925<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set the maximum number of significant digits to be printed.</td><td style='text-align:right;'></td></tr></table>
4926
4927<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004928 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004929</div>
4930
4931<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>image preview type.</td><td style='text-align:right;'></td></tr></table>
4932
4933<p>Use this option to affect the preview operation of an image (e.g. <kbd>convert file.png -preview Gamma Preview:gamma.png</kbd>). Choose from these previews:</p>
4934
4935<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004936 Rotate Shear Roll Hue
4937 Saturation Brightness Gamma Spiff
4938 Dull Grayscale Quantize Despeckle
4939 ReduceNoise Add Noise Sharpen Blur
4940 Threshold EdgeDetect Spread Shade
4941 Raise Segment Solarize Swirl
4942 Implode Wave OilPaint CharcoalDrawing
4943 JPEG
cristy3ed852e2009-09-05 21:47:34 +00004944</pre>
4945
4946<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4947
4948<p>The default preview is <kbd>JPEG</kbd>.</p>
4949
4950<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004951 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004952</div>
4953
4954<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>interpret string and print to console.</td><td style='text-align:right;'></td></tr></table>
4955
4956<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004957 <h4><a id="process"></a>-process <em class="arg">command</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004958</div>
4959
4960<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>process the image with a custom image filter.</td><td style='text-align:right;'></td></tr></table>
4961
4962<p>The command arguments has the form <kbd>"module arg1 arg2 arg3 ... argN"</kbd> where <kbd>module</kbd> is the name of the module to invoke (e.g. "Analyze") and arg1 arg2 arg3 ... argN are an arbitrary number of arguments to pass to the process module.</p>
4963
4964<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004965 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004966 +profile <em class="arg">profile_name</em></h4>
4967</div>
4968
4969<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Manage ICM, IPTC, or generic profiles in an image.</td><td style='text-align:right;'></td></tr></table>
4970
4971<p>Using <a href="#profile">-profile</a> <em class="arg">filename</em> adds an ICM (ICC color management), IPTC (newswire information), or a generic profile to the image.</p>
4972
4973<p>Use <a href="#profile">+profile <em class="arg">profile_name</em></a> to remove the indicated profile. ImageMagick uses standard filename globbing, so wildcard expressions may be used to remove more than one profile. Here we remove all profiles from the image except for the XMP profile: <kbd>+profile "!xmp,*"</kbd>. </p>
4974
4975<p>Use <kbd>identify -verbose</kbd> to find out which profiles are in the image file. Use <a href="#strip">-strip</a> to remove all profiles (and comments).</p>
4976
cristyeed6cb62012-01-28 19:38:34 +00004977<p>To extract a profile, the <a href="#profile">-profile</a> option is not used. Instead, simply write the file to an image format such as <em class="arg">APP1, 8BIM, ICM,</em> or <em class="arg">IPTC</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004978
4979<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4980
cristyeed6cb62012-01-28 19:38:34 +00004981<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
cristy3ed852e2009-09-05 21:47:34 +00004982<p>It is important to note that results may depend on whether or not the original image already has an included profile. Also, keep in mind that <a href="#profile">-profile</a> is an "operator" (as opposed to a "setting") and therefore a conversion is made each time it is encountered, in order, in the command-line. For instance, in the following example, if the original image is CMYK with profile, a CMYK-CMYK-RGB conversion results.</p>
4983
cristyeed6cb62012-01-28 19:38:34 +00004984<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert CMYK.tif -profile "CMYK.icc" -profile "RGB.icc" RGB.tiff</span></p>
cristy3ed852e2009-09-05 21:47:34 +00004985<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4986CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4987</p>
4988
4989<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004990 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004991</div>
4992
4993<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>JPEG/MIFF/PNG compression level.</td><td style='text-align:right;'></td></tr></table>
4994
cristy87a7f072011-07-01 00:08:52 +00004995<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
4996highest compression) to 100 (best quality but least effective compression).
4997The default is to use the estimated quality of your input image if it can
4998be determined, otherwise 92. When the quality is greater than 90, then the
4999chroma channels are not downsampled.
5000Use the <a href="#sampling-factor">-sampling-factor</a> option to specify the
5001factors for chroma downsampling.</p>
cristy3ed852e2009-09-05 21:47:34 +00005002
5003<p>For the MIFF image format, quality/10 is the zlib compression level, which is 0 (worst but fastest compression) to 9 (best but slowest). It has no effect on the image appearance, since the compression is always lossless.</p>
5004
cristy851dbce2010-08-06 21:40:00 +00005005<p>For the JPEG-2000 image format, quality is mapped using a non-linear equation to the compression ratio required by the Jasper library. This non-linear equation is intended to loosely approximate the quality provided by the JPEG v1 format. The default quality value 100, a request for non-lossy compression. A quality of 75 results in a request for 16:1 compression.</p>
cristy3ed852e2009-09-05 21:47:34 +00005006
cristy87a7f072011-07-01 00:08:52 +00005007<p>For the MNG and PNG image formats, the quality value sets the zlib
5008compression level (quality / 10) and filter-type (quality % 10). The default
5009PNG "quality" is 75, which means compression level 7 with adaptive PNG
5010filtering, unless the image has a color map, in which case it means
5011compression level 7 with no PNG filtering.</p>
5012
5013<p>For compression level 0, the Huffman-only strategy is used, which is fastest but not necessarily the worst compression.</p>
cristy3ed852e2009-09-05 21:47:34 +00005014
cristya4dfb122011-07-07 19:01:57 +00005015<p>If filter-type is 4 or less, the specified PNG filter-type is used for
5016all scanlines:</p>
cristy3ed852e2009-09-05 21:47:34 +00005017
5018<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005019 0: none
5020 1: sub
5021 2: up
5022 3: average
5023 4: Paeth
cristy3ed852e2009-09-05 21:47:34 +00005024</pre>
5025
cristy87a7f072011-07-01 00:08:52 +00005026<p>If filter-type is 5, adaptive filtering is used when quality is greater
5027than 50 and the image does not have a color map, otherwise no filtering is
5028used.</p>
cristy3ed852e2009-09-05 21:47:34 +00005029
cristy87a7f072011-07-01 00:08:52 +00005030<p>If filter-type is 6, adaptive filtering
5031with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
cristy3ed852e2009-09-05 21:47:34 +00005032
cristy87a7f072011-07-01 00:08:52 +00005033<p>Only if the output is MNG, if filter-type is 7, the LOCO color
5034transformation (intrapixel differencing) and adaptive filtering
5035with <em class="arg">minimum-sum-of-absolute-values</em> are used.</p>
cristy3ed852e2009-09-05 21:47:34 +00005036
cristy87a7f072011-07-01 00:08:52 +00005037<p>If the filter-type is 8 the zlib Z_RLE compression strategy is used with
5038 no PNG filtering.</p>
cristy3ed852e2009-09-05 21:47:34 +00005039
cristy87a7f072011-07-01 00:08:52 +00005040<p>If the filter-type is 9 the zlib Z_RLE compression strategy is used with
5041 adaptive PNG filtering.</p>
5042
cristya4dfb122011-07-07 19:01:57 +00005043<p>The quality setting has no effect on the appearance or signature of PNG
5044and MNG images, since the compression is always lossless.</p>
5045
5046<p>Not all combinations of compression level, strategy, and PNG filter type
5047can be obtained using the -quality option. For more precise control,
5048you can use the PNG:compression-level=N, PNG:compression-strategy=N, and
5049PNG:compression-filter=N defines, respectively, instead.
5050See <a href="#define">-define</a>. Values from the defines take precedence
5051over values from the -quality option.</p>
cristy87a7f072011-07-01 00:08:52 +00005052
5053<p>For further information, see
5054the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
cristy3ed852e2009-09-05 21:47:34 +00005055
cristy3ed852e2009-09-05 21:47:34 +00005056<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005057 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005058</div>
5059
cristy3c98a4f2010-08-13 20:09:41 +00005060<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>reduce colors using this colorspace.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005061
cristy3c98a4f2010-08-13 20:09:41 +00005062<p>This setting defines the colorspace used to sort out and reduce the number
5063of colors needed by an image (for later dithering) by operators such as <a
cristyeed6cb62012-01-28 19:38:34 +00005064href="#colors" >-colors</a>, Note that color reduction also happens
cristy3c98a4f2010-08-13 20:09:41 +00005065automatically when saving images to color-limited image file formats, such as
5066GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00005067
5068
5069<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005070 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00005071</div>
5072
5073<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>suppress all warning messages. Error messages are still reported.</td><td style='text-align:right;'></td></tr></table>
5074
5075<div style="margin: auto;">
cristyeed6cb62012-01-28 19:38:34 +00005076 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em>+<em class="arg">bias</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005077</div>
5078
5079<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Blur around the center of the image.</td><td style='text-align:right;'></td></tr></table>
5080
5081<p>Note that this is actually a rotational blur rather than a radial and as
5082such actually mis-named. </p>
5083
5084<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
5085pixels which are outside the image proper are blurred into the final result.
5086</p>
5087
5088
5089<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005090 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005091</div>
5092
5093<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Lighten or darken image edges.</td><td style='text-align:right;'></td></tr></table>
5094
5095<p>This will create a 3-D effect. Use <a href="#raise">-raise</a> to create a raised effect, otherwise use <a href="#raise">+raise</a>.
5096</p>
5097
5098<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
5099
5100<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005101 <h4><a id="random-threshold"></a>-random-threshold <em class="arg">low</em>x<em class="arg">high</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005102</div>
5103
5104<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Apply a random threshold to the image.</td><td style='text-align:right;'></td></tr></table>
5105
5106<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005107 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005108</div>
5109
5110<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the red chromaticity primary point.</td><td style='text-align:right;'></td></tr></table>
5111
5112<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005113 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00005114</div>
5115
5116<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Pay attention to warning messages.</td><td style='text-align:right;'></td></tr></table>
5117
5118<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005119 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005120</div>
5121
5122<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Reduce the number of colors in an image to the colors used by this image.</td><td style='text-align:right;'></td></tr></table>
5123
5124<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
5125the given colors are dithered over the image as necessary, otherwise the closest
5126color (in RGB colorspace) is selected to replace that pixel in the image. </p>
5127
5128<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
5129images in the current image sequence, all the images will have the same color
5130table. That means that when saved to a file format such as GIF, it will use
5131that color table as a single common or global color table, for all the images,
5132without requiring extra local color tables. </p>
5133
5134<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
5135sequence to use a common color map over all the images. This equivalent to
5136appending all the images together (without extra background colors) and color
5137reducing those images using <a href="#colors">-colors</a> with a 256 color
5138limit, then <a href="#remap">-remap</a> those colors over the original list of
5139images. This ensures all the images follow a single color map. </p>
5140
5141<p>If the number of colors over all the images is less than 256, then <a
5142href="#remap">+remap</a> should not perform any color reduction or dithering, as
5143no color changes are needed. In that case, its only effect is to force the use
5144of a global color table. This recommended after using either <a
5145href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
5146reduce the number of colors in an animated image sequence. </p>
5147
5148<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005149 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005150</div>
5151
5152<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set a region in which subsequent operations apply.</td><td style='text-align:right;'></td></tr></table>
5153
5154<p>The <em class="arg">x</em> and <em class="arg">y</em> offsets are treated in the same manner as in <a href="#crop">-crop</a>.</p>
5155
5156<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5157
5158<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005159 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00005160</div>
5161
5162<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>perform a remote operation.</td><td style='text-align:right;'></td></tr></table>
5163
5164<p>The only command recognized is the name of an image file to load.</p>
5165
5166<p>If you have more than one <a href="../www/display.html">display</a> application running simultaneously, use the <a href="#window"> window</a> option to specify which application to control.</p>
5167
5168<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005169 <h4><a id="render"></a>-render</h4>
cristy3ed852e2009-09-05 21:47:34 +00005170</div>
5171
5172<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>render vector operations.</td><td style='text-align:right;'></td></tr></table>
5173
5174<p>Use <a href="#render">+render</a> to turn off rendering vector operations. This useful when saving the result to vector formats such as MVG or SVG.</p>
5175
5176<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005177<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005178</div>
5179
5180<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Adjust the canvas and offset information of the image.</td><td style='text-align:right;'></td></tr></table>
5181
5182<p>This option is like <a href="#page">-page</a> but acts as an image operator
5183rather than a setting. You can separately set the canvas size or the offset
5184of the image on that canvas by only providing those components. </p>
5185
5186<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5187
5188<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
5189offset to move the image relative to its previous position. This useful for
5190animation sequences. </p>
5191
5192<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
5193recalculate the canvas size so the image (at its current offset) will appear
5194completely on that canvas (unless it has a negative offset).</p>
5195
5196<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
5197canvas meta-data from the images. </p>
5198
5199<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
5200directly assign virtual canvas meta-data. </p>
5201
5202
5203<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005204 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005205</div>
5206
5207<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Resample image to specified horizontal and vertical resolution.</td><td style='text-align:right;'></td></tr></table>
5208
5209<p>Resize the image so that its rendered size remains the same as the original at the specified target resolution. For example, if a 300 DPI image renders at 3 inches by 2 inches on a 300 DPI device, when the image has been resampled to 72 DPI, it will render at 3 inches by 2 inches on a 72 DPI device. Note that only a small number of image formats (e.g. JPEG, PNG, and TIFF) are capable of storing the image resolution. For formats which do not support an image resolution, the original resolution of the image must be specified via <a href="#density">-density</a> on the command line prior to specifying the resample resolution.</p>
5210
5211<p>Note that Photoshop stores and obtains image resolution from a proprietary embedded profile. If this profile exists in the image, then Photoshop will continue to treat the image using its former resolution, ignoring the image resolution specified in the standard file header.</p>
5212
5213<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005214 <h4><a id="resize"></a>-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005215</div>
5216
5217<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Resize an image.</td><td style='text-align:right;'></td></tr></table>
5218
5219<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Offsets, if present in the geometry string, are ignored, and the <a href="#gravity">-gravity</a> option has no effect.</p>
5220
5221<p>If the <a href="#filter">-filter</a> option precedes the <a href="#resize">-resize</a> option, the image is resized with the specified filter.</p>
5222
cristy13538962010-02-26 17:53:04 +00005223<p>Many image processing algorithms assume your image is in a linear-light coding. If your image is gamma-corrected, you can remove the nonlinear gamma correction, apply the transform, then restore it like this:</p>
5224
cristyeed6cb62012-01-28 19:38:34 +00005225<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert portrait.jpg -gamma .45455 -resize 25% -gamma 2.2 \ <br/> -quality 92 passport.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00005226<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005227 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00005228</div>
5229
5230<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>settings remain in effect until parenthesis boundary.</td><td style='text-align:right;'></td></tr></table>
5231
5232<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005233 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005234</div>
5235
5236<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Reverse the order of images in the current image list.</td><td style='text-align:right;'></td></tr></table>
5237
5238
5239<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005240 <h4><a id="roll"></a>-roll {<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005241</div>
5242
5243<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>roll an image vertically or horizontally by the amount given.</td><td style='text-align:right;'></td></tr></table>
5244
5245<p>A negative <em class="arg">x</em> offset rolls the image left-to-right. A negative <em class="arg">y</em> offset rolls the image top-to-bottom.</p>
5246
5247
5248<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005249 <h4><a id="rotate"></a>-rotate <em class="arg">degrees</em>{<em class="arg">&lt;</em>}{<em class="arg">&gt;</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005250</div>
5251
5252<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Apply Paeth image rotation (using shear operations) to the image.</td><td style='text-align:right;'></td></tr></table>
5253
5254<p>Use <kbd>&gt;</kbd> to rotate the image only if its width exceeds the height. <kbd>&lt;</kbd> rotates the image <em>only</em> if its width is less than the height. For example, if you specify <kbd>-rotate "-90&gt;"</kbd> and the image size is 480x640, the image is not rotated. However, if the image is 640x480, it is rotated by -90 degrees. If you use <kbd>&gt;</kbd> or <kbd>&lt;</kbd>, enclose it in quotation marks to prevent it from being misinterpreted as a file redirection.</p>
5255
5256<p>Empty triangles in the corners, left over from rotating the image, are
5257filled with the <kbd>background</kbd> color. </p>
5258
5259<p>See also the <a href="#distort">-distort</a> operator and specifically the
5260'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5261
5262
5263<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005264 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005265</div>
5266
cristyd0bd44a2010-09-24 12:38:11 +00005267<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>minify/magnify the image using pixel subsampling and pixel replication, respectively.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005268
cristyd0bd44a2010-09-24 12:38:11 +00005269<p>Change the image size simply by directly sampling the pixels original
5270image. When magnifying, pixels are replicated in blocks. When minifying,
5271pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005272
cristyd0bd44a2010-09-24 12:38:11 +00005273<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5274a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5275neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5276avoids all the filter processing of the image. As such it completely ignores
5277the current <a href="#filter">-filter</a> setting. </p>
5278
5279<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5280will be added to the resulting image, though some colors may disappear. </p>
5281
5282<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Offsets, if present in the geometry string, are
5283ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005284
5285
5286<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005287 <h4><a id="sampling-factor"></a>-sampling-factor <em class="arg">horizontal-factor</em>x<em class="arg">vertical-factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005288</div>
5289
5290<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>sampling factors used by JPEG or MPEG-2 encoder and YUV decoder/encoder.</td><td style='text-align:right;'></td></tr></table>
5291
5292<p>This option specifies the sampling factors to be used by the JPEG encoder for chroma downsampling. If this option is omitted, the JPEG library will use its own default values. When reading or writing the YUV format and when writing the M2V (MPEG-2) format, use <a href="#sampling-factor">-sampling-factor 2x1</a> or <a href="#sampling-factor">-sampling-factor 4:2:2</a> to specify the 4:2:2 downsampling method.</p>
5293
5294<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005295 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005296</div>
5297
cristyd0bd44a2010-09-24 12:38:11 +00005298<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>minify/magnify the image using pixel block averaging and pixel replication, respectively.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005299
cristyd0bd44a2010-09-24 12:38:11 +00005300<p>Change the image size simply by replacing pixels by averaging pixels
cristyeed6cb62012-01-28 19:38:34 +00005301together when minifying, or replacing pixels when magnifying. </p>
cristyd0bd44a2010-09-24 12:38:11 +00005302
5303<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5304a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5305faster, as it avoids all the filter processing of the image. As such it
5306completely ignores the current <a href="#filter">-filter</a> setting. </p>
5307
5308<p>If when shrinking (minifying) images the original image is some integer
cristyeed6cb62012-01-28 19:38:34 +00005309multiple of the new image size, the number of pixels averaged together to
cristyd0bd44a2010-09-24 12:38:11 +00005310produce the new pixel color is the same across the whole image. This is
5311a special case known as 'binning' and is often used as a method of reducing
5312noise in image such as those generated by digital cameras, especially in low
5313light conditions. </p>
5314
cristy3ed852e2009-09-05 21:47:34 +00005315
5316<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005317 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005318</div>
5319
5320<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set scene number.</td><td style='text-align:right;'></td></tr></table>
5321
5322<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5323
5324<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005325 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005326</div>
5327
5328<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the screen to capture.</td><td style='text-align:right;'></td></tr></table>
5329
5330<p>This option indicates that the GetImage request used to obtain the image should be done on the root window, rather than directly on the specified window. In this way, you can obtain pieces of other windows that overlap the specified window, and more importantly, you can capture menus or other popups that are independent windows but appear over the specified window.</p>
5331
5332<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005333 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005334</div>
5335
5336<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>seed a new sequence of pseudo-random numbers</td><td style='text-align:right;'></td></tr></table>
5337
5338<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005339 <h4><a id="segment"></a>-segment <em class="arg">cluster-threshold</em>x<em class="arg">smoothing-threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005340</div>
5341
5342<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>segment the colors of an image.</td><td style='text-align:right;'></td></tr></table>
5343
5344<p>Segment an image by analyzing the histograms of the color components and identifying units that are homogeneous with the fuzzy c-means technique. This is part of the ImageMagick color quantization routines. </p>
5345
5346<p>Specify <em class="arg">cluster threshold</em> as the number of pixels in each cluster that must exceed the cluster threshold to be considered valid. <em class="arg">Smoothing threshold</em> eliminates noise in the second derivative of the histogram. As the value is increased, you can expect a smoother second derivative. The default is 1.5.</p>
5347
5348<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5349of the color clusters is returned.</p>
5350
5351
5352<div style="margin: auto;">
cristyeed6cb62012-01-28 19:38:34 +00005353 <h4><a id="selective-blur"></a>-selective-blur <em class="arg">radius</em><br />-selective-blur <em class="arg">radius</em>x<em class="arg">sigma</em>{+<em class="arg">+threshold</em>+<em class="arg">bias</em>}</h4>
cristy2e2662a2010-10-09 14:29:37 +00005354</div>
5355
cristy3ed852e2009-09-05 21:47:34 +00005356<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Selectively blur pixels within a contrast threshold.</td><td style='text-align:right;'></td></tr></table>
5357
cristy2e2662a2010-10-09 14:29:37 +00005358<p>Blurs those pixels that are less than or equal to the threshold in contrast. The threshold may be expressed as a fraction of <em class="QR">QuantumRange</em> or as a percentage.</p>
5359
cristy3ed852e2009-09-05 21:47:34 +00005360<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005361 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005362</div>
5363
5364<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>separate an image channel into a grayscale image. Specify the channel with <a href="#channel">-channel</a>.</td><td style='text-align:right;'></td></tr></table>
5365
5366<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005367 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005368</div>
5369
5370<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate a sepia-toned photo.</td><td style='text-align:right;'></td></tr></table>
5371
5372<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5373
5374<p>This option applies a special effect to the image, similar to the effect achieved in a photo darkroom by sepia toning. Threshold ranges from 0 to <em class="QR">QuantumRange</em> and is a measure of the extent of the sepia toning. A threshold of 80% is a good starting point for a reasonable tone.</p>
5375
cristyd0bda5e2010-09-21 16:22:45 +00005376
5377
cristy3ed852e2009-09-05 21:47:34 +00005378<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005379 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5380 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005381</div>
5382
cristyd0bd44a2010-09-24 12:38:11 +00005383<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>sets image attributes and properties for images in the current
cristyd0bda5e2010-09-21 16:22:45 +00005384image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005385
cristyd0bd44a2010-09-24 12:38:11 +00005386<p>This will assign (or modify) specific settings attached to all the images
5387in the current image sequence. Using the <a href="#set">+set</a> form of the
5388option will either remove, or reset that setting to a default state, as
5389appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005390
cristyd0bd44a2010-09-24 12:38:11 +00005391<p>For example, it will modify specific well known image meta-data
5392'attributes' such as those normally overridden by: the options <a
5393href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5394href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5395assigned before the image is read in, by using a <em class="arg">key</em> of
5396the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005397
cristyd0bd44a2010-09-24 12:38:11 +00005398<p>If the given <em class="arg">key</em> does not match a specific known
5399'attribute ', such as shown above, the setting is stored as a a free form
cristy323f35b2011-03-24 23:05:13 +00005400'property' string. Such settings are listed in <a href="#verbose"
cristyd0bda5e2010-09-21 16:22:45 +00005401>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5402</p>
5403
cristy84134182011-06-15 22:59:00 +00005404<p>This includes string 'properties' that are set by and assigned to images
cristyd0bd44a2010-09-24 12:38:11 +00005405using the options <a href="#comment" >-comment</a>, <a href="#label"
5406>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5407a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5408Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005409
cristyeed6cb62012-01-28 19:38:34 +00005410<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert rose: -set comment 'Rose is a rose is a rose is a rose' rose.png</span><span class='crtout'>identify -format %c rose.png</span><span class="crtprompt"> $ </span><span class='crtin'>Rose is a rose is a rose is a rose</span></p>
cristyd0bd44a2010-09-24 12:38:11 +00005411<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5412Properties</a> in the defined value. For example:</p>
5413
cristyeed6cb62012-01-28 19:38:34 +00005414<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert rose: -set origsize '%wx%h' -resize 50% \</span><span class='crtout'> -format 'Old size = %[origsize] New size = %wx%h' info:</span><span class="crtprompt"> $ </span><span class='crtin'>Old size = 70x46 New size = 35x23</span></p>
cristy84134182011-06-15 22:59:00 +00005415<p>Other well known 'properties' that are availible include:
cristyd0bd44a2010-09-24 12:38:11 +00005416'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5417'<kbd>signature</kbd>'. </p>
5418
5419<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5420the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5421see <a href="#repage">-page</a>). However it is designed to provide a finer
5422control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5423option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5424attribute. </p>
5425
5426<p>This option can also associate a colorspace or profile with your image.
5427For example,</p>
5428
cristyeed6cb62012-01-28 19:38:34 +00005429<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert image.psd -set profile ISOcoated_v2_eci.icc image-icc.psd</span></p>
cristyd0bda5e2010-09-21 16:22:45 +00005430<p>Some 'properties' must be defined in a specific way to be used. For
5431example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5432modify the output filename of an image. For example</p>
5433
cristyeed6cb62012-01-28 19:38:34 +00005434<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert rose: -set filename:mysize '%wx%h' 'rose_%[filename:mysize].png'</span></p>
cristyd0bda5e2010-09-21 16:22:45 +00005435<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5436be saved as a global "Artifact" exactly as if it was set using the <a
cristyf9a6c462011-04-24 14:01:11 +00005437href="#define" >-define</a> option. As such settings are global in scope, they
cristy84134182011-06-15 22:59:00 +00005438can be used to pass 'attributes' and 'properties' of one specific image,
cristyd0bd44a2010-09-24 12:38:11 +00005439in a way that allows you to use them in a completely different image, even if
5440the original image has long since been modified or destroyed. For example: </p>
5441
cristyeed6cb62012-01-28 19:38:34 +00005442<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert rose: -set option:rosesize '%wx%h' -delete 0 \</span><span class='crtout'> label:'%[rosesize]' label_size_of_rose.gif</span></p>
cristyd0bd44a2010-09-24 12:38:11 +00005443<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5444a 'artifact' if the given <em class="arg">key</em> does not match an existing
cristy323f35b2011-03-24 23:05:13 +00005445'attribute' or 'property'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005446
5447<p>You can set the attributes of the image registry by prefixing the value
5448with <kbd>registry:</kbd>.</p>
5449
cristy84134182011-06-15 22:59:00 +00005450<p>The <a href="#set">-set profile</a> option can also be used to inject
5451previously-formatted ancillary chunks into the output PNG file, using
5452the commandline option as shown below or by setting the profile via a
5453programming interface:</p>
5454
cristyeed6cb62012-01-28 19:38:34 +00005455<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert in.png -set profile PNG-chunk-x:&lt;filename&gt; out.png</span></p>
cristy84134182011-06-15 22:59:00 +00005456<p>where <em>x</em> is a location flag and
5457<em class="arg">filename</em> is a file containing the chunk
5458name in the first 4 bytes, then a colon (":"), followed by the chunk data.
5459This encoder will compute the chunk length and CRC, so those must not
5460be included in the file.</p>
5461
5462<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
5463or "e" (end, i.e., after IDAT). If you want to write multiple chunks
5464of the same type, then add a short unique string after the "x" to prevent
5465subsequent profiles from overwriting the preceding ones, e.g.,</p>
5466
5467
cristyeed6cb62012-01-28 19:38:34 +00005468<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert in.png -set profile PNG-chunk-b01:file01 / <br/>
cristy84134182011-06-15 22:59:00 +00005469 -profile PNG-chunk-b02:file02 out.png</span></p>
5470<p>&nbsp;</p>
cristyd0bda5e2010-09-21 16:22:45 +00005471
cristy3ed852e2009-09-05 21:47:34 +00005472
5473<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005474 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005475</div>
5476
5477<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>shade the image using a distant light source.</td><td style='text-align:right;'></td></tr></table>
5478
5479<p>Specify <em class="arg">azimuth</em> and <em class="arg">elevation</em> as the position of the light source. Use <a href="#shade">+shade</a> to return the shading results as a grayscale image.</p>
5480
5481<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005482 <h4><a id="shadow"></a>-shadow <em class="arg">percent-opacity</em>{x<em class="arg">sigma</em>}{<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005483</div>
5484
5485<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate an image shadow.</td><td style='text-align:right;'></td></tr></table>
5486
5487<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005488 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005489id="shared-memory"></a>-shared-memory</h4>
5490</div>
5491
5492<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>use shared memory.</td><td style='text-align:right;'></td></tr></table>
5493
5494<p>This option specifies whether the utility should attempt to use shared memory for pixmaps. ImageMagick must be compiled with shared memory support, and the display must support the <em class="arg">MIT-SHM</em> extension. Otherwise, this option is ignored. The default is <kbd>True</kbd>.</p>
5495
5496<div style="margin: auto;">
cristyeed6cb62012-01-28 19:38:34 +00005497 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em><br />-sharpen <em class="arg">radius</em>x<em class="arg">sigma</em>+<em class="arg">bias</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005498</div>
5499
5500<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>sharpen the image.</td><td style='text-align:right;'></td></tr></table>
5501
5502<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5503
5504<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005505 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005506</div>
5507
5508<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Shave pixels from the image edges.</td><td style='text-align:right;'></td></tr></table>
5509
5510<p>The <em class="arg">size</em> portion of the <em class="arg">geometry</em> argument specifies the width of the region to be removed from both sides of the image and the height of the regions to be removed from top and bottom. Offsets are ignored.</p>
5511
5512<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5513
5514<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005515 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005516</div>
5517
5518<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Shear the image along the x-axis and/or y-axis.</td><td style='text-align:right;'></td></tr></table>
5519
5520<p>The shear angles may be positive, negative, or zero. When <em class="arg">Ydegrees</em> is omitted it defaults to 0. When both angles are given, the horizontal component of the shear is performed before the vertical component.</p>
5521
5522<p>Shearing slides one edge of an image along the x-axis or y-axis (i.e., horizontally or vertically, respectively),creating a parallelogram. The amount of each is controlled by the respective shear angle. For horizontal shears, <em class="arg">Xdegrees</em> is measured clockwise relative to "up" (the negative y-axis), sliding the top edge to the right when 0&deg;&lt;<em class="arg">Xdegrees</em>&lt;90&deg; and to the left when 90&deg;&lt;<em class="arg">Xdegrees</em>&lt;180&deg;. For vertical shears <em class="arg">Ydegrees</em> is measured clockwise relative to "right" (the positive x-axis), sliding the right edge down when 0&deg;&lt;<em class="arg">Ydegrees</em>&lt;90&deg; and up when 90&deg;&lt;<em class="arg">Ydegrees</em>&lt;180&deg;.</p>
5523
5524<p>Empty triangles left over from shearing the image are filled with the color defined by the <a href="#fill">-background</a> option. The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5525
5526<p>The horizontal shear is performed before the vertical part. This is important to note, since horizontal and vertical shears do not <em>commute</em>, i.e., the order matters in a sequence of shears. For example, the following two commands are not equivalent.</p>
5527
cristyeed6cb62012-01-28 19:38:34 +00005528<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert logo: -shear 20x0 -shear 0x60 logo-sheared.png</span><span class='crtout'></span><span class="crtprompt"> $ </span><span class='crtin'>convert logo: -shear 0x60 -shear 20x0 logo-sheared.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00005529<p>The first of the two commands above is equivalent to the following, except for the amount of empty space created; the command that follows generates a smaller image, and so is a better choice in terms of time and space.</p>
5530
cristyeed6cb62012-01-28 19:38:34 +00005531<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00005532<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005533 <h4><a id="sigmoidal-contrast"></a>-sigmoidal-contrast <em class="arg">contrast</em>x<em class="arg">mid-point</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005534</div>
5535
5536<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>increase the contrast without saturating highlights or shadows.</td><td style='text-align:right;'></td></tr></table>
5537
5538<p>Increase the contrast of the image using a sigmoidal transfer function without saturating highlights or shadows. <em class="arg">Contrast</em> indicates how much to increase the contrast (0 is none; 3 is typical; 20 is a lot); <em class="arg">mid-point</em> indicates where midtones fall in the resultant image (0 is white; 50% is middle-gray; 100% is black). By default the image contrast is increased, use <em class="arg">+sigmoidal-contrast</em> to decrease the contrast.</p>
5539
5540<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005541 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005542</div>
5543
5544<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>operate silently.</td><td style='text-align:right;'></td></tr></table>
5545
5546<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005547 <h4><a id="size"></a>-size <em class="arg">width</em>[x<em class="arg">height</em>][<em class="arg">+offset</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005548</div>
5549
5550<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set the width and height of the image.</td><td style='text-align:right;'></td></tr></table>
5551
5552<p>Use this option to specify the width and height of raw images whose dimensions are unknown such as <kbd>GRAY</kbd>, <kbd>RGB</kbd>, or <kbd>CMYK</kbd>. In addition to width and height, use <a href="#size">-size</a> with an offset to skip any header information in the image or tell the number of colors in a <kbd>MAP</kbd> image file, (e.g. -size 640x512+256).</p>
5553
5554<p>For Photo CD images, choose from these sizes:</p>
5555
5556<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005557 192x128
5558 384x256
5559 768x512
5560 1536x1024
5561 3072x2048
cristy3ed852e2009-09-05 21:47:34 +00005562</pre>
5563
cristy3ed852e2009-09-05 21:47:34 +00005564<div style="margin: auto;">
cristyeed6cb62012-01-28 19:38:34 +00005565 <h4><a id="sketch"></a>-sketch <em class="arg">radius</em><br />-sketch <em class="arg">radius</em>x<em class="arg">sigma</em>+<em class="arg">angle</em>+<em class="arg">bias</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005566</div>
5567
5568<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate a pencil sketch.</td><td style='text-align:right;'></td></tr></table>
5569
5570<p>Sketch with the given radius, standard deviation (sigma), and angle. The angle given is the angle toward which the image is sketched. That is the direction people would consider the object is coming from. </p>
5571
5572<div style="margin: auto;">
cristy2d67ddd2011-02-13 15:38:23 +00005573 <h4><a id="smush"></a>-smush <em class="arg">offset</em></h4>
5574</div>
5575
5576<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>smush an image sequence together.</td><td style='text-align:right;'></td></tr></table>
5577
5578<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005579 <h4><a id="snaps"></a>-snaps <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005580</div>
5581
5582<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the number of screen snapshots.</td><td style='text-align:right;'>[<a href="../www/import.html">import</a>]</td></tr></table>
5583
5584<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5585
5586<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005587 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005588</div>
5589
5590<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>negate all pixels above the threshold level.</td><td style='text-align:right;'></td></tr></table>
5591
5592<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5593
5594<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5595
5596<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005597 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005598 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5599</div>
5600
5601<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'> color the given image using the specified points of color, and filling the other intervening colors using the given methods. </td><td style='text-align:right;'></td></tr></table>
5602
5603
5604<table class="doc">
5605 <tbody>
5606 <tr valign="top">
5607 <th align="left" style="width: 8%">Method</th>
5608 <th align="left">Description</th>
5609 </tr>
5610
5611 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005612 <td valign="top">barycentric</td>
5613 <td valign="top">three point triangle of color given 3 points.
5614 Giving only 2 points will form a linear gradient between those points.
5615 The gradient generated extends beyond the triangle created by those
5616 3 points. </td>
5617 </tr>
5618
5619 <tr valign="top">
5620 <td valign="top">bilinear</td>
5621 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5622 fall back to barycentric. </td>
5623 </tr>
5624 <tr valign="top">
cristy3ed852e2009-09-05 21:47:34 +00005625 <td valign="top">voronoi</td>
5626 <td valign="top">Simply map each pixel to the to nearest color point
5627 given. The result are polygonal 'cells' of solid color. </td>
5628 </tr>
5629
5630 <tr valign="top">
5631 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005632 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005633 squared. Generating spots of color in a sea of the average of
5634 colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005635 </tr>
5636
5637 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005638 <td valign="top">inverse</td>
5639 <td valign="top">Colors points biased on the ratio of inverse distance.
5640 This generates sharper points of color rather than rounded spots of
5641 '<kbd>shepards</kbd>' Generating spots of color in a sea of the
5642 average of colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005643 </tr>
5644
5645 </tbody>
5646</table>
5647
5648<p>The points are placed according to the images location on the virtual
5649canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5650offset), and do not actually have to exist on the given image, but may be
5651some point beyond the edge of the image. All points are floating point values.
5652</p>
5653
5654<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
cristyacc04882011-05-04 23:03:43 +00005655modified, which means that by default matte/alpha transparency channel is not
5656effected. Typically transparency channel is turned off either before or after
5657the operation. </P>
5658
5659Of course if some color points are transparent to generate a transparent
5660gradient, then the image also requires transparency enabled to store the
5661values. </p>
cristy3ed852e2009-09-05 21:47:34 +00005662
5663<p>All the above methods when given a single point of color will replace all
5664the colors in the image with the color given, regardless of the point. This is
5665logical, and provides an alternative technique to recolor a image to some
5666default value. </p>
5667
5668
5669<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005670 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005671</div>
5672
5673<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Splice the current background color into the image.</td><td style='text-align:right;'></td></tr></table>
5674
cristyacc04882011-05-04 23:03:43 +00005675<p>This will add rows and columns of the current <a
5676href="#background">-background</a> color into the given image according to the
cristyeed6cb62012-01-28 19:38:34 +00005677given <a href="#gravity">-gravity</a> geometry setting. >See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Essentially <a href="#splice">-splice</a> will divide the
cristyacc04882011-05-04 23:03:43 +00005678image into four quadrants, separating them by the inserted rows and columns.
5679</P>
5680
5681If a dimension of geometry is zero no rows or columns will be added for that
5682dimension. Similarly using a zero offset with the appropriate <a
5683href="#gravity">-gravity</a> setting will add rows and columns to the edges of
5684the image, padding the image only along that one edge. Edge padding is what <a
5685href="#splice">-splice</a> is most commonly used for. </p>
5686
5687<p>If the exact same <em class="arg">geometry</em> and <a
5688href="#gravity">-gravity</a> is later used with <a href="#chop">-chop</a> the
5689added added all splices removed. </p>
cristy3ed852e2009-09-05 21:47:34 +00005690
5691<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005692 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005693</div>
5694
5695<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>displace image pixels by a random amount.</td><td style='text-align:right;'></td></tr></table>
5696
5697<p>The argument <em class="arg">amount</em> defines the size of the neighborhood around each pixel from which to choose a candidate pixel to swap.</p>
5698
5699<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00005700 <h4><a id="statistic"></a>-statistic <em class="arg">type</em> <em class="arg">geometry</em></h4>
cristyb52981c2011-03-19 17:09:31 +00005701</div>
5702
5703<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>replace each pixel with corresponding statistic from the neighborhood.</td><td style='text-align:right;'>[<a href="../www/convert.html">convert</a>, <a href="../www/mogrify.html">mogrify</a>]</td></tr></table>
5704
5705<p>Choose from these statistic types:</p>
5706<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005707 Gradient maximum difference in area
5708 Maximum maximum value per channel in neighborhood
5709 Minimum minimum value per channel in neighborhood
5710 Mean average value per channel in neighborhood
5711 Median median value per channel in neighborhood
5712 Mode mode (most frequent) value per channel in neighborhood
5713 Nonpeak value just before or after the median value per channel in neighborhood
cristyb52981c2011-03-19 17:09:31 +00005714</pre>
5715
5716<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005717 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005718</div>
5719
5720<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>hide watermark within an image.</td><td style='text-align:right;'></td></tr></table>
5721
5722<p>Use an offset to start the image hiding some number of pixels from the beginning of the image. Note this offset and the image size. You will need this information to recover the steganographic image (e.g. display -size 320x256+35 stegano:image.png).</p>
5723
5724<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005725 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005726</div>
5727
5728<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>composite two images to create a stereo anaglyph.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5729
5730<p>The left side of the stereo pair is saved as the red channel of the output image. The right side is saved as the green channel. Red-green stereo glasses are required to properly view the stereo image.</p>
5731
5732<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005733 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005734</div>
5735
5736<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>pixel storage type. Here are the valid types:</td><td style='text-align:right;'></td></tr></table>
5737
5738<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005739 char unsigned characters
5740 double doubles
5741 float floats
5742 integer integers
5743 long longs
5744 quantum pixels in the native depth of your ImageMagick distribution
5745 short unsigned shorts
cristy3ed852e2009-09-05 21:47:34 +00005746</pre>
5747
5748<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5749values range from 0 to the maximum value the storage type can support.</p>
5750
5751<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005752 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005753</div>
5754
5755<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set a type of stretch style for fonts.</td><td style='text-align:right;'></td></tr></table>
5756
5757<p>This setting suggests a type of stretch that ImageMagick should try to apply to the currently selected font family. Select <em class="arg">fontStretch</em> from the following.</p>
5758
5759<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005760 Any
5761 Condensed
5762 Expanded
5763 ExtraCondensed
5764 ExtraExpanded
5765 Normal
5766 SemiCondensed
5767 SemiExpanded
5768 UltraCondensed
5769 UltraExpanded
cristy3ed852e2009-09-05 21:47:34 +00005770</pre>
5771
5772<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5773
5774<p>For other settings that affect fonts, see the options <a href="#font">-font</a>, <a href="#family">-family</a>, <a href="#style">-style</a>, and <a href="#weight">-weight</a>. </p>
5775
5776<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005777 <h4><a id="strip"></a>-strip</h4>
cristy3ed852e2009-09-05 21:47:34 +00005778</div>
5779
5780<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>strip the image of any profiles or comments.</td><td style='text-align:right;'></td></tr></table>
5781
5782<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005783 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005784</div>
5785
5786<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>color to use when stroking a graphic primitive.</td><td style='text-align:right;'></td></tr></table>
5787
5788<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5789
5790<p>See <a href="#draw">-draw</a> for further details.</p>
5791
5792<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005793 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005794</div>
5795
5796<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set the stroke width.</td><td style='text-align:right;'></td></tr></table>
5797
5798<p>See <a href="#draw">-draw</a> for further details.</p>
5799
5800<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005801 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005802</div>
5803
5804<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set a font style for text.</td><td style='text-align:right;'></td></tr></table>
5805
cristy71a3f602010-09-15 12:38:16 +00005806<p>This setting suggests a font style that ImageMagick should try to apply to
5807the currently selected font family. Select <em class="arg">fontStyle</em> from
5808the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005809
5810<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005811 Any
5812 Italic
5813 Normal
5814 Oblique
cristy3ed852e2009-09-05 21:47:34 +00005815</pre>
5816
5817<p>For other settings that affect fonts, see the options <a href="#font">-font</a>, <a href="#family">-family</a>, <a href="#stretch">-stretch</a>, and <a href="#weight">-weight</a>. </p>
5818
5819<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005820 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005821</div>
5822
cristyd4d64ed2010-08-22 22:19:33 +00005823<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>search for subimage.</td><td style='text-align:right;'>[<a href="../www/compare.html">compare</a>]</td></tr></table>
5824
cristy71a3f602010-09-15 12:38:16 +00005825<p>This option is required to have compare search for the best match location
5826of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005827(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005828be the "match score" image.</p>
5829
cristyd0bd44a2010-09-24 12:38:11 +00005830<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005831position of the top-left corner of the given sub-image. that is its size will
5832be the size of the larger_image - sub_image + 1. The brightest location in
5833this image is the location s the locate on the best match that is also
5834reported. Note that this may or may nor be a perfect match, and the actual
5835brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyeed6cb62012-01-28 19:38:34 +00005836possible matching locations. </p>
cristy71a3f602010-09-15 12:38:16 +00005837
cristyeed6cb62012-01-28 19:38:34 +00005838<p>Note that the search will try to compare the sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005839location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005840sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005841
cristyae6203d2010-08-09 01:12:14 +00005842
5843<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005844 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005845</div>
5846
5847<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Swap the positions of two images in the image sequence.</td><td style='text-align:right;'></td></tr></table>
5848
cristy71a3f602010-09-15 12:38:16 +00005849<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5850images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5851the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005852
5853<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005854 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005855</div>
5856
5857<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>swirl image pixels about the center.</td><td style='text-align:right;'></td></tr></table>
5858
5859<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5860
5861<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005862 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005863</div>
5864
5865<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>synchronize image to storage device.</td><td style='text-align:right;'></td></tr></table>
5866
5867<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005868 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005869</div>
5870
cristy5063d812010-10-19 16:28:10 +00005871<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Mark the image as modified.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005872
5873<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005874 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005875</div>
5876
5877<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>font for writing fixed-width text.</td><td style='text-align:right;'></td></tr></table>
5878
5879<p>Specifies the name of the preferred font to use in fixed (typewriter style) formatted text. The default is 14 point <em class="arg">Courier</em>.</p>
5880
5881<p>You can tag a font to specify whether it is a PostScript, TrueType, or OPTION1 font. For example, <kbd>Courier.ttf</kbd> is a TrueType font and <kbd>x:fixed</kbd> is OPTION1.</p>
5882
5883<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005884 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005885</div>
5886
5887<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>name of texture to tile onto the image background.</td><td style='text-align:right;'></td></tr></table>
5888
5889<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005890 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005891</div>
5892
5893<!-- {<em class="arg">green,blue,opacity</em>}
5894<p>If the green or blue value is omitted, these channels use the same value as the first one provided. If all three color values are the same, the result is a bi-level image. If the opacity threshold is omitted, OpaqueOpacity is used and any partially transparent pixel becomes fully transparent.</p>
5895-->
5896
5897<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Apply simultaneous black/white threshold to the image.</td><td style='text-align:right;'></td></tr></table>
5898
5899<p>Any pixel values (more specifically, those channels set using <a href="../www/command-line-options.html#channel">&#x2011;channel</a>) that exceed the specified threshold are reassigned the maximum channel value, while all other values are assigned the minimum.</p>
5900
5901<p> The threshold value can be given as a percentage or as an absolute integer value corresponding to the desired channel value. When given as an integer, the minimum attainable value is 0 (corresponding to black when all channels are affected), but the maximum value (corresponding to white) is that of the <kbd>quantum depth</kbd> of the particular build of ImageMagick, and is therefore dependent on the installation. For that reason, a reasonable recommendation for most applications is to specify the threshold values as a percentage.
5902</p>
5903
5904<p> The following would force pixels with red values above 50% to have 100% red values, while those at or below 50% red would be set to 0 in the red channel. The green, blue, and alpha channels (if present) would be unchanged. </p>
5905
cristyeed6cb62012-01-28 19:38:34 +00005906<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00005907<p>As (possibly) impractical but instructive examples, the following would generate an all-black and an all-white image with the same dimensions as the input image.</p>
5908
5909
cristyeed6cb62012-01-28 19:38:34 +00005910<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert in.png -threshold 100% black.png</span><span class='crtout'></span><span class="crtprompt"> $ </span><span class='crtin'>convert in.png -threshold -1 white.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00005911<p>Note that the values of the transparency channel is treated as 'matte'
5912values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5913
5914<p> See also <a href="../www/command-line-options.html#black-threshold">&#x2011;black&#x2011;threshold</a> and <a href="../www/command-line-options.html#white-threshold">&#x2011;white&#x2011;threshold</a>.
5915</p>
5916
5917<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005918 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005919</div>
5920
5921<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Create a thumbnail of the image.</td><td style='text-align:right;'></td></tr></table>
5922
5923<p>This is similar to <a href="#resize">-resize</a>, except it is optimized for speed and any image profile, other than a color profile, is removed to reduce the thumbnail size. To strip the color profiles as well, add <a href="#strip">-strip</a> just before of after this option.</p>
5924
5925<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5926
5927<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005928 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005929</div>
5930
5931<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the tile image used for filling a subsequent graphic primitive.</td><td style='text-align:right;'></td></tr></table>
5932
5933<div style="margin: auto;">
5934 <h4>-tile <em class="arg">geometry</em></h4>
5935</div>
5936
5937<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify the layout of images .</td><td style='text-align:right;'>[<a href="../www/montage.html">montage</a>]</td></tr></table>
5938
5939<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5940
5941<div style="margin: auto;">
5942 <h4>-tile</h4>
5943</div>
5944
5945<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specifies that a subsequent composite operation is repeated across and down image.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5946
5947<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005948 <h4><a id="tile-offset"></a>-tile-offset {<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005949</div>
5950
5951<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify the offset for tile images, relative to the background image it is tiled on.</td><td style='text-align:right;'></td></tr></table>
5952
5953<p>This should be set before the tiling image is set by <a href="#tile" >-tile</a> or <a href="#texture" >-texture</a>, or directly applied for creating a tiled canvas using <kbd>TILE:</kbd> or <kbd>PATTERN:</kbd> input formats. </p>
5954
5955<p>Internally ImageMagick does a <a href="#roll" >-roll</a> of the tile image by the arguments given when the tile image is set. </p>
5956
5957<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005958 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005959</div>
5960
5961<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Tint the image with the fill color.</td><td style='text-align:right;'></td></tr></table>
5962
5963<p>Tint the image with the fill color.</p>
5964
5965<p>Specify the amount of tinting as a percentage. Pure colors like black, white red, yellow, will not be affected by -tint. Only mid-range colors such as the various shades of grey.</p>
5966
5967<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005968 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005969</div>
5970
5971<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Assign a title to displayed image.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>, <a href="../www/montage.html">montage</a>]</td></tr></table>
5972
5973<p>Use this option to assign a specific title to the image. This assigned to the image window and is typically displayed in the window title bar. Optionally you can include the image filename, type, width, height, Exif data, or other image attribute by embedding special format characters described under the <a href="#format">-format</a> option.</p>
5974
5975<p>For example,</p>
5976
5977<p class="crtsnip">
5978 -title "%m:%f %wx%h"
5979</p>
5980
5981<p>produces an image title of <kbd>MIFF:bird.miff 512x480</kbd> for an image titled <kbd>bird.miff</kbd> and whose width is 512 and height is 480.</p>
5982
5983
5984<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005985 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005986</div>
5987
5988<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>transform the image.</td><td style='text-align:right;'></td></tr></table>
5989
5990<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5991
cristyeed6cb62012-01-28 19:38:34 +00005992<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -affine 2,2,-2,2,0,0 -transform bird.ppm bird.jpg</span></p>
cristy83a272e2010-05-07 20:40:35 +00005993
5994<p>This operator has been now been superseded by the <a
5995href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5996
5997
cristy3ed852e2009-09-05 21:47:34 +00005998<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005999 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006000</div>
6001
6002<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Make this color transparent within the image.</td><td style='text-align:right;'></td></tr></table>
6003
6004<p>The <em class="arg">color</em> argument is defined using the format
6005described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
6006>-fuzz</a> setting can be used to match and replace colors similar to the one
6007given. </p>
6008
cristyb36feb22010-03-26 16:54:37 +00006009<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
6010that is make all non-matching colors transparent. </p>
6011
cristy3ed852e2009-09-05 21:47:34 +00006012<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00006013href="#transparent" >-transparent</a> but replaces the matching color with the
6014current <a href="#fill">-fill</a> color setting, rather than transparent.
6015However the <a href="#transparent" >-transparent</a> operator also ensures
6016that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
6017>-alpha</a> set</kbd>", and does not require you to modify the <a
6018href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00006019
cristyb36feb22010-03-26 16:54:37 +00006020<p>Note that this does not define the color as being the 'transparency color'
6021used for color-mapped image formats, such as GIF. For that use <a
6022href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00006023
6024
6025<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006026 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006027</div>
6028
6029<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the transparent color.</td><td style='text-align:right;'></td></tr></table>
6030
6031<p>Sometimes this is used for saving to image formats such as
6032GIF and PNG8 which uses this color to represent boolean transparency. This
6033does not make a color transparent, it only defines what color the transparent
6034color is in the color palette of the saved image. Use <a
6035href="#transparent">-transparent</a> to make an opaque color transparent.</p>
6036
6037<p>This option allows you to have both an opaque visible color, as well as a
6038transparent color of the same color value without conflict. That is, you can
6039use the same color for both the transparent and opaque color areas within an
6040image. This, in turn, frees to you to select a transparent color that is
6041appropriate when an image is displayed by an application that does not handle a
6042transparent color index, while allowing ImageMagick to correctly handle images of this
6043type. </p>
6044
6045<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
6046
6047<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006048 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00006049</div>
6050
6051<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Mirror the image along the top-left to bottom-right diagonal.</td><td style='text-align:right;'></td></tr></table>
6052
6053<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
6054</p>
6055
6056<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006057 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00006058</div>
6059
6060<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Mirror the image along the images bottom-left top-right diagonal. Equivalent to the operations <kbd>-flop -rotate 90</kbd>.</td><td style='text-align:right;'></td></tr></table>
6061
6062
6063<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006064 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006065</div>
6066
6067<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>tree depth for the color reduction algorithm.</td><td style='text-align:right;'></td></tr></table>
6068
6069<p>Normally, this integer value is zero or one. A value of zero or one causes the use of an optimal tree depth for the color reduction algorithm.</p>
6070
6071<p>An optimal depth generally allows the best representation of the source image with the fastest computational speed and the least amount of memory. However, the default depth is inappropriate for some images. To assure the best representation, try values between 2 and 8 for this parameter. Refer to the <a href="../www/quantize.html">color reduction algorithm</a> for more details.</p>
6072
6073<p>The <a href="#colors">-colors</a> or <a href="#monochrome">-monochrome</a> option, or writing to an image format which requires color reduction, is required for this option to take effect.</p>
6074
6075<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006076 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00006077</div>
6078
6079<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>trim an image.</td><td style='text-align:right;'></td></tr></table>
6080
6081<p>This option removes any edges that are exactly the same color as the corner pixels. Use <a href="#fuzz">-fuzz</a> to make <a href="#trim">-trim</a> remove edges that are nearly the same color as the corner pixels.</p>
6082
6083<p>The page or virtual canvas information of the image is preserved allowing
6084you to extract the result of the <a href="#trim">-trim</a> operation from the
6085image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
6086information if it is unwanted.</p>
6087
6088<p>If the trimmed image 'disappears' an warning is produced, and a special
6089single pixel transparent 'missed' image is returned, in the same way as when a
6090<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
6091
6092
6093<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006094 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006095</div>
6096
6097<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the image type.</td><td style='text-align:right;'></td></tr></table>
cristyefb2bdb2010-11-20 19:35:22 +00006098 <p>Choose from: <kbd>Bilevel</kbd>, <kbd>Grayscale</kbd>, <kbd>GrayscaleMatte</kbd>, <kbd>Palette</kbd>, <kbd>PaletteMatte</kbd>, <kbd>TrueColor</kbd>, <kbd>TrueColorMatte</kbd>, <kbd>ColorSeparation</kbd>, or <kbd>ColorSeparationMatte</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00006099
cristyeed6cb62012-01-28 19:38:34 +00006100<p>Normally, when a format supports different subformats such as grayscale and truecolor, the encoder will try to choose an efficient subformat. The <a href="#type">-type</a> option can be used to override this behavior. For example, to prevent a JPEG from being written in grayscale format even though only gray pixels are present, use.</p>
cristy3ed852e2009-09-05 21:47:34 +00006101
cristyeed6cb62012-01-28 19:38:34 +00006102<p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00006103<p>Similarly, use <a href="#type">-type TrueColorMatte</a> to force the encoder to write an alpha channel even though the image is opaque, if the output format supports transparency.</p>
6104
6105<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
6106
6107<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006108 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006109</div>
6110
6111<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set the color of the annotation bounding box.</td><td style='text-align:right;'></td></tr></table>
6112
6113<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
6114
6115<p>See <a href="#draw">-draw</a> for further details.</p>
6116
6117
6118<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006119 <h4><a id="update"></a>-update <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006120</div>
6121
6122<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>detect when image file is modified and redisplay.</td><td style='text-align:right;'></td></tr></table>
6123
6124<p>Suppose that while you are displaying an image the file that is currently displayed is over-written. <kbd>display</kbd> will automagically detect that the input file has been changed and update the displayed image accordingly.</p>
6125
6126
6127<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006128 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00006129</div>
6130
6131<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>discard all but one of any pixel color.</td><td style='text-align:right;'></td></tr></table>
6132
6133
6134<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006135 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006136</div>
6137
6138<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the units of image resolution.</td><td style='text-align:right;'></td></tr></table>
6139
6140<p>Choose from: <kbd>Undefined</kbd>, <kbd>PixelsPerInch</kbd>, or <kbd>PixelsPerCentimeter</kbd>. This option is normally used in conjunction with the <a href="#density">-density</a> option.</p>
6141
6142
6143<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006144 <h4><a id="unsharp"></a>-unsharp <em class="arg">radius</em><br />-unsharp <em class="arg">radius</em>x<em class="arg">sigma</em>{<em class="arg">+amount</em>}{<em class="arg">+threshold</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006145</div>
6146
6147<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>sharpen the image with an unsharp mask operator.</td><td style='text-align:right;'></td></tr></table>
6148
6149<p>The <a href="#unsharp">-unsharp</a> option sharpens an image. The image is convolved with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 to have the method select a suitable radius.</p>
6150
6151<p>The parameters are:</p>
6152
6153<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006154 radius The radius of the Gaussian, in pixels, not counting the center
6155 pixel (default 0).
6156 sigma The standard deviation of the Gaussian, in pixels (default 1.0).
6157 amount The fraction of the difference between the original and the blur
6158 image that is added back into the original (default 1.0).
6159 threshold The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
6160 difference amount (default 0.05).
cristy3ed852e2009-09-05 21:47:34 +00006161</pre>
6162
6163
6164<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006165 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00006166</div>
6167
cristyd0bda5e2010-09-21 16:22:45 +00006168<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>print detailed information about the image when this option precedes the <a href="#identify">-identify</a> option or <kbd>info:</kbd>.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00006169
6170
6171<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006172 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00006173</div>
6174
6175<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>print ImageMagick version string and exit.</td><td style='text-align:right;'></td></tr></table>
6176
6177
6178<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006179 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006180</div>
6181
6182<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>FlashPix viewing parameters.</td><td style='text-align:right;'></td></tr></table>
6183
6184
6185<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006186 <h4><a id="vignette"></a>-vignette <em class="arg">radius</em>{x<em class="arg">sigma</em>}{<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006187</div>
6188
6189<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>soften the edges of the image in vignette style.</td><td style='text-align:right;'></td></tr></table>
6190
6191
6192<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006193 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006194</div>
6195
6196<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify contents of <em>virtual pixels</em>.</td><td style='text-align:right;'></td></tr></table>
6197
6198<p>This option defines what color source should be used if and when a color
6199lookup completely 'misses' the source image. The color(s) that appear to
6200surround the source image. Generally this color is derived from the source
6201image, but could also be set to a specify background color. </p>
6202
6203<p>Choose from these methods:</p>
6204
6205<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006206 background the area surrounding the image is the background color
6207 black the area surrounding the image is black
6208 checker-tile alternate squares with image and background color
6209 dither non-random 32x32 dithered pattern
6210 edge extend the edge pixel toward infinity
6211 gray the area surrounding the image is gray
6212 horizontal-tile horizontally tile the image, background color above/below
6213 horizontal-tile-edge horizontally tile the image and replicate the side edge pixels
6214 mirror mirror tile the image
6215 random choose a random pixel from the image
6216 tile tile the image (default)
6217 transparent the area surrounding the image is transparent blackness
6218 vertical-tile vertically tile the image, sides are background color
6219 vertical-tile-edge vertically tile the image and replicate the side edge pixels
6220 white the area surrounding the image is white
cristy3ed852e2009-09-05 21:47:34 +00006221</pre>
6222
6223<p>The default value is "edge".</p>
6224
6225<p>This most important for distortion operators such as <a href="#distort"
6226>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
6227However it also effects operations that may access pixels just outside the
6228image proper, such as <a href="#convolve">-convolve</a>, <a
6229href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
6230
6231<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
6232
6233
6234<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006235 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006236</div>
6237
6238<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Animate images using this X visual type.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>]</td></tr></table>
6239
6240<p>Choose from these visual classes:</p>
6241
6242<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006243 StaticGray
6244 GrayScale
6245 StaticColor
6246 PseudoColor
6247 TrueColor
6248 DirectColor
6249 default
6250 visual id
cristy3ed852e2009-09-05 21:47:34 +00006251</pre>
6252
6253<p>The X server must support the visual you choose, otherwise an error occurs. If a visual is not specified, the visual class that can display the most simultaneous colors on the default screen is chosen.</p>
6254
6255
6256<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006257 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00006258 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
6259</div>
6260
6261<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Watermark an image using the given percentages of brightness and
6262saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
6263
6264<p>Take a grayscale image (with alpha mask) and modify the destination image's
6265brightness according to watermark image's grayscale value and the <em
6266class="arg">brightness</em> percentage. The destinations color saturation
6267attribute is just direct modified by the <em class="arg">saturation</em>
6268percentage, which defaults to 100 percent (no color change). </p>
6269
6270
6271<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006272 <h4><a id="wave"></a>-wave <em class="arg">amplitude</em><br />-wave <em class="arg">amplitude</em>x<em class="arg">wavelength</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006273</div>
6274
6275<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Shear the columns of an image into a sine wave.</td><td style='text-align:right;'></td></tr></table>
6276
6277<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
6278
6279<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006280 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006281</div>
6282
6283<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set a font weight for text.</td><td style='text-align:right;'></td></tr></table>
6284
6285<p>This setting suggests a font weight that ImageMagick should try to apply to the currently selected font family. Use a positive integer for <em class="arg">fontWeight</em> or select from the following.</p>
6286
6287<table class="doc">
6288 <col width="25%" />
6289 <col width="75%" />
6290 <thead>
6291 <tr>
6292 <th><em class="arg">fontWeight</em></th>
6293 <th>Description</th>
6294 </tr>
6295 </thead>
6296 <tbody>
6297 <tr><td>All </td> <td>No effect. </td></tr>
6298 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
6299 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
6300 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
6301 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
6302 </tbody>
6303 </table>
6304
6305<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
6306
6307<p>For other settings that affect fonts, see the options <a href="#font">-font</a>, <a href="#family">-family</a>, <a href="#stretch">-stretch</a>, and <a href="#style">-style</a>. </p>
6308
6309<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006310 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006311</div>
6312
6313<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>chromaticity white point.</td><td style='text-align:right;'></td></tr></table>
6314
6315<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006316 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006317</div>
6318
cristy5cadd612009-09-21 19:33:41 +00006319<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Force to white all pixels above the threshold while leaving all pixels at or below the threshold unchanged.</td><td style='text-align:right;'></td></tr></table>
6320
6321<p> The threshold value can be given as a percentage or as an absolute integer value within [0,&nbsp;<em class="QR">QuantumRange</em>] corresponding to the desired <a href="../www/command-line-options.html#channel">&#x2011;channel</a> value. See <a href="../www/command-line-options.html#threshold">&#x2011;threshold</a> for more details on thresholds and resulting values.
6322</p>
cristy3ed852e2009-09-05 21:47:34 +00006323
6324<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006325 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006326</div>
6327
6328<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Make the image the background of a window.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>]</td></tr></table>
6329
6330<p><em class="arg">id</em> can be a window id or name. Specify <kbd>root</kbd> to select X's root window as the target window.</p>
6331
6332<p>By default the image is tiled onto the background of the target window. If <kbd>backdrop</kbd> or <a href="#geometry">-resize</a> are specified, the image is surrounded by the background color. Refer to <kbd>X RESOURCES</kbd> for details.</p>
6333
6334<p>The image will not display on the root window if the image has more unique colors than the target window colormap allows. Use <a href="#colors">-colors</a> to reduce the number of colors.</p>
6335
6336<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006337 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006338</div>
6339
6340<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the window group.</td><td style='text-align:right;'></td></tr></table>
6341
6342<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006343 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006344</div>
6345
6346<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>write an image sequence.</td><td style='text-align:right;'></td></tr></table>
6347 <p>The image sequence preceding the <a href="#write">-write</a> <em class="arg">filename</em> option is written out, and processing continues with the same image in its current state if there are additional options. To restore the image to its original state after writing it, use the <a href="#write">+write</a> <em class="arg">filename</em> option.</p>
6348
6349<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006350</div>
6351</div>
cristyeed6cb62012-01-28 19:38:34 +00006352
cristy3eaa0ef2010-03-06 20:35:26 +00006353
6354</div>
6355
6356<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006357 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006358 <span id="linkbar-center">
6359 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006360 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006361 </span>
6362 <span id="linkbar-east">&nbsp;</span>
6363 </div>
6364 <div class="footer">
cristyeed6cb62012-01-28 19:38:34 +00006365 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006366 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6367 </div>
6368 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006369 <script type="text/javascript">
6370 var _gaq = _gaq || [];
6371 _gaq.push(['_setAccount', 'UA-17690367-1']);
6372 _gaq.push(['_trackPageview']);
6373
6374 (function() {
6375 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6376 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6377 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6378 })();
6379 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006380</body>
6381</html>