blob: 2c06ccc0f114cc0032503a45ee3f7bd3641079c2 [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"/>
cristye6e84152011-06-06 14:16:49 +000023 <meta name="Keywords" content="command-line, options, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Image, Processing, Automagically"/>
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"/>
cristy7a40ba82011-01-08 20:31:18 +000036 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy1efc1ab2011-08-01 14:47:02 +000037 <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" />
cristy3c98a4f2010-08-13 20:09:41 +000038 <style type="text/css" media="all">
39 @import url("../www/magick.css");
40 </style>
cristy29c5c992011-06-25 13:58:49 +000041 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
cristy1efc1ab2011-08-01 14:47:02 +000042 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>
43 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script>
cristy361f4662010-12-31 23:02:52 +000044 <script type="text/javascript">
45 $(document).ready(function() {
46 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
47 'transitionIn' : 'elastic',
48 'transitionOut' : 'elastic',
49 'overlayShow' : false,
50 'opacity' : true
51 });
52 });
53 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000054</head>
55
56<body id="www-imagemagick-org">
57<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +000058<div style="margin: 17px auto; float: left;">
59 <script type="text/javascript">
60 <!--
61 google_ad_client = "pub-3129977114552745";
62 google_ad_slot = "5439289906";
63 google_ad_width = 728;
64 google_ad_height = 90;
65 //-->
66 </script>
67 <script type="text/javascript"
68 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
69 </script>
70</div>
cristy3eaa0ef2010-03-06 20:35:26 +000071<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000072 <img src="../images/logo.jpg"
73 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000074 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000075<a href="../index.html">
cristyaf8d6652011-02-04 21:57:45 +000076 <img src="../images/sprite.jpg"
77 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000078 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
79</div>
80
cristyce69bb02010-07-27 19:49:46 +000081<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000082
cristy3ed852e2009-09-05 21:47:34 +000083<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000084 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000085</div>
cristy3ed852e2009-09-05 21:47:34 +000086<div class="menu">
cristybb503372010-05-27 20:51:26 +000087 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
88</div>
89<div class="sub">
90 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
91</div>
92<div class="sub">
93 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
94</div>
95<div class="sub">
cristye6e84152011-06-06 14:16:49 +000096 <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +000097</div>
98<div class="sub">
cristybb503372010-05-27 20:51:26 +000099 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
100</div>
101<div class="sep"></div>
102<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000106 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
108<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
111<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
117<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000118 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000119</div>
120<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000121 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000122</div>
123<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000124 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000125</div>
126<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000127 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000128</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000129<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000130<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000131 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000132</div>
133<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000134 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000135</div>
136<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000137 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000138 </div>
139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000140 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000141</div>
cristybb503372010-05-27 20:51:26 +0000142<div class="menu">
143 <a title="Architecture" href="../www/architecture.html">Architecture</a>
144</div>
cristy3ed852e2009-09-05 21:47:34 +0000145<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000146 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000147</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000148<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000149<div class="menu">
cristy52923442011-01-15 22:54:31 +0000150 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000151</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000152<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000153<div class="menu">
cristydcca3fa2010-12-29 21:50:07 +0000154 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000155</div>
156<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000157 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000158</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000159<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000160<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000161 <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000162
cristyb52981c2011-03-19 17:09:31 +0000163<a href="http://www.networkredux.com">
cristyaf894d72011-08-06 23:03:10 +0000164 <img src="../images/networkredux.png" width="140" height="31" alt="[sponsor]"
cristyb52981c2011-03-19 17:09:31 +0000165 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000166<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000167<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000168 <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540s suvalj -->
cristy81492d62011-06-07 16:41:42 +0000169</div>
170<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000171 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
cristy1efc1ab2011-08-01 14:47:02 +0000172</div>
173<div class="sponsor">
cristy84134182011-06-15 22:59:00 +0000174 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
175</div>
176<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000177 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
178</div>
179<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000180 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
181</div>
182<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000183 <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
184</div>
185<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000186 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
187</div>
188<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000189 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
cristy45dbd322011-03-27 16:40:38 +0000190</div>
191<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000192 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000193</div>
194<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000195 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000196</div>
197<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000198 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristyaf8d6652011-02-04 21:57:45 +0000199</div>
200<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000201 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy7d52cd62010-10-01 17:26:59 +0000202</div>
203<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000204 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000205</div>
206<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000207 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000208</div>
209<div class="sponsor">
cristy7c011e02011-08-12 17:28:55 +0000210 <a rel="follow" title="Sponsor: Bildbearbeitung" href="http://www.bildschliff.de">Bildbearbeitung</a><!-- 2012060100300 strait.de-->
cristyec6b4752011-01-08 03:16:23 +0000211</div>
cristy3ed852e2009-09-05 21:47:34 +0000212</div>
213</div>
cristyce69bb02010-07-27 19:49:46 +0000214</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000215
cristyce69bb02010-07-27 19:49:46 +0000216<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000217 <div class="g-plusone" data-size="standard" data-count="false"></div>
218</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000219
220<div class="main">
221
cristydcca3fa2010-12-29 21:50:07 +0000222<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000223<p class="navigation-index">
cristy8b9dd952011-03-21 22:56:18 +0000224[ <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 +0000225
cristydcca3fa2010-12-29 21:50:07 +0000226<div class="doc-section">
227
cristyb36feb22010-03-26 16:54:37 +0000228<p>Below is list of command-line options recognized by the ImageMagick <a
229href="../www/command-line-tools.html">command-line
230tools</a>. If you want a description of a particular option, click on the
231option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000232otherwise 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 +0000233
234<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000235 <h4><a id="adaptive-blur"></a>-adaptive-blur <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000236</div>
237
238<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 +0000239<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>
240
241<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000242 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000243</div>
244
245<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>
246
247<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>
248
249<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000250 <h4><a id="adaptive-sharpen"></a>-adaptive-sharpen <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000251</div>
252
253<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>
254
255<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>
256
257<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000258 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000259</div>
260
261<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>
262
cristy30092792011-02-22 02:06:14 +0000263<p>This option is enabled by default. An attempt is made to save all images of
264an image sequence into the given output file. However, some formats, such as
265JPEG and PNG, do not support more than one image per file, and in that case
266ImageMagick is forced to write each image as a separate file. As such, if
267more than one image needs to be written, the filename given is modified by
268adding a <a href="#scene">-scene</a> number before the suffix, in order to
269make distinct names for each image. </p>
cristy3ed852e2009-09-05 21:47:34 +0000270
cristy30092792011-02-22 02:06:14 +0000271<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written to
272separate files, whether or not the file format allows multiple images per file
273(for example, GIF, MIFF, and TIFF). </p>
cristy3ed852e2009-09-05 21:47:34 +0000274
cristy30092792011-02-22 02:06:14 +0000275<p>Including a C-style integer format string in the output filename will
276automagically enable <a href="#adjoin">+adjoin</a> and are used to specify
277where the <a href="#scene">-scene</a> number is placed in the filenames. These
278strings, such as '<kbd>%d</kbd>' or '<kbd>%03d</kbd>', are familiar to those
279who have used the standard <kbd>printf()</kbd>' C-library function. As an
280example, the command</p>
cristy3ed852e2009-09-05 21:47:34 +0000281
282<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: rose: -morph 15 my%02dmorph.jpg</span></p>
cristy30092792011-02-22 02:06:14 +0000283<p>will create a sequence of 17 images (the two given plus 15 more created by
284<a href="#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
285my02morph.jpg, ..., my16morph.jpg. </p>
cristy3ed852e2009-09-05 21:47:34 +0000286
cristy30092792011-02-22 02:06:14 +0000287<p>In summary, ImageMagick tries to write all images to one file, but will
288save to multiple files, if any of the following conditions exist...
289<ol>
290<li>the output image's file format does not allow multi-image files,
291<li>the <a href="#adjoin">+adjoin</a> option is given, or
292<li>a printf() integer format string (eg: "%d") is present in the output
293 filename.
294</ol></p>
cristy3ed852e2009-09-05 21:47:34 +0000295
296
297<div style="margin: auto;">
cristy30092792011-02-22 02:06:14 +0000298 <h4><a id="affine"></a>-affine
299 <em class="arg">s<sub>x</sub></em>,<em class="arg">r<sub>x</sub></em>,<em
300 class="arg">r<sub>y</sub></em>,<em class="arg">s<sub>y</sub></em>[,<em
cristye9a32c32011-04-07 01:11:05 +0000301 class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000302</div>
303
304<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>
305
cristy30092792011-02-22 02:06:14 +0000306<p>This option sets a transformation matrix, for use by subsequent <a
307href="#draw">-draw</a> or <a href="#transform">-transform</a> options. </p>
cristy3ed852e2009-09-05 21:47:34 +0000308
cristy30092792011-02-22 02:06:14 +0000309<p>The matrix entries are entered as comma-separated numeric values either in
310quotes or without spaces. </p>
cristy3ed852e2009-09-05 21:47:34 +0000311
cristy30092792011-02-22 02:06:14 +0000312<p>Internally, the transformation matrix has 3x3 elements, but three of them
313are omitted from the input because they are constant. The new (transformed)
314coordinates (<em class="arg">x'</em>, <em class="arg">y'</em>) of a pixel at
315position (<em class="arg">x</em>, <em class="arg">y</em>) in the original
316image are calculated using the following matrix equation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000317
318<div class="eqn">
319<img alt="affine transformation" src="../images/affine.png"/>
320</div>
321
cristy30092792011-02-22 02:06:14 +0000322<p> The size of the resulting image is that of the smallest rectangle that
323contains the transformed source image. The parameters <em
324class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em>
325subsequently shift the image pixels so that those that are moved out of the
326image area are cut off.</p>
cristy3ed852e2009-09-05 21:47:34 +0000327
cristy30092792011-02-22 02:06:14 +0000328<p>The transformation matrix complies with the left-handed pixel coordinate
329system: positive <em class="arg">x</em> and <em class="arg">y</em> directions
330are rightward and downward, resp.; positive rotation is clockwise.</p>
cristy3ed852e2009-09-05 21:47:34 +0000331
cristy30092792011-02-22 02:06:14 +0000332<p> If the translation coefficients <em class="arg">t<sub>x</sub></em> and <em
333class="arg">t<sub>y</sub></em> are omotted they default to 0,0. Therefore,
334four parameters suffice for rotation and scaling without translation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000335
cristy30092792011-02-22 02:06:14 +0000336<p>Scaling by the factors <em class="arg">s<sub>x</sub></em> and <em
337class="arg">s<sub>y</sub></em> in the <em>x</em> and <em>y</em> directions,
338respectively, is accomplished with the following.</p>
339
340<p>See <a href="#transform">-transform</a>, and the <a
341href="#distort">-distort</a> method '<kbd>Affineprojection</kbd> for more
342information </p>
343
cristy3ed852e2009-09-05 21:47:34 +0000344
345<p class="crtsnip">
346 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
347</p>
348
349<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>
350
351<p class="crtsnip">
352 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
353</p>
354
355<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
356<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
357
358<p class="crtsnip">
359 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
360</p>
361
362<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>
363
364<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>
365
366<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000367 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000368</div>
369
370<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>
371
372<p>Used to set a flag on an image indicating whether or not to use existing alpha
373channel 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>
374
375
376<table class="doc">
377 <tbody>
378 <tr valign="top">
379 <th align="left" style="width: 8%">type</th>
380 <th align="left">Description</th>
381 </tr>
382
383 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000384 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000385 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000386 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
387 should be used instead of this, unless you specifically need to
388 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
389 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000390
391 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000392 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000393 <td valign="top">
394 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000395 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000396
397 <tr valign="top">
398 <td valign="top"><kbd>Set</kbd></td>
399 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000400 Activates the alpha/matte channel. If it was previously turned off
401 then it also resets the channel to opaque. If the image already had
402 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000403
404 <tr valign="top">
405 <td valign="top"><kbd>Opaque</kbd></td>
406 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000407 Enables the alpha/matte channel and forces it to be fully opaque.
408 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000409
410 <tr valign="top">
411 <td valign="top"><kbd>Transparent</kbd></td>
412 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000413 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000414 transparent. This effectively creates a fully transparent image the
415 same size as the original and with all its original RGB data still
416 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000417
418 <tr valign="top">
419 <td valign="top"><kbd>Extract</kbd></td>
420 <td valign="top">
421 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000422 '<kbd>Off</kbd>' the the image's transparency, so as to generate
423 a gray-scale mask of the image's shape. The alpha channel data is left
424 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
425 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000426
427 <tr valign="top">
428 <td valign="top"><kbd>Copy</kbd></td>
429 <td valign="top">
430 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000431 gray-scale intensity of the image, into the alpha channel, converting
432 a gray-scale mask into a transparent shaped mask ready to be colored
433 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000434
435 <tr valign="top">
436 <td valign="top"><kbd>Shape</kbd></td>
437 <td valign="top">
438 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000439 the current background color. That is the RGB color channels is
440 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000441 </td></tr>
442
443 <tr valign="top">
444 <td valign="top"><kbd>Background</kbd></td>
445 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000446 Set any fully-transparent pixel to the background color, while leaving
447 it fully-transparent. This can make some image file formats, such as
448 PNG, smaller as the RGB values of transparent pixels are more uniform,
449 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000450 </td></tr>
451 </tbody>
452</table>
453
454<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000455"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000456>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000457Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000458
459
460<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000461 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000462 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
463 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
464 -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>
465</div>
466
467<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>
468
469<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>
470
471
472<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>
473
474<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>
475
476<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>
477<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
478
479<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>
480
481<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>
482
483<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000484 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000485</div>
486
487<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
488drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
489
490<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
491drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
492antialiasing edge pixels. This will then reduce the number of colors added to
493an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000494are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000495
496<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000497 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000498</div>
499
500<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>
501
502<p>This option creates a single longer image image, by joining all the current
503images in sequence top-to-bottom. Use <a href="#append">+append</a> to
504stack images left-to-right. </p>
505
506<p>If they are not of the same width, narrower images are padded with the
507current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000508position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000509href="#gravity">-gravity</a> setting. </p>
510
511
512<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000513 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000514</div>
515
516<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>
517
518
519<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000520 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000521</div>
522
523<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>
524
525<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>
526
527<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
528
cristyd934d102009-10-10 12:55:13 +0000529
530
cristy3ed852e2009-09-05 21:47:34 +0000531<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000532 <h4><a id="auto-gamma"></a>-auto-gamma</h4>
cristy3ed852e2009-09-05 21:47:34 +0000533</div>
534
535<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>
536
cristyd934d102009-10-10 12:55:13 +0000537<p>This calculates the mean values of an image, then applies a calculated <a
538href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
539image it will get a have a value of 50%. </p>
540
cristyd0bd44a2010-09-24 12:38:11 +0000541<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000542
543<p>This works well for real-life images with little or no extreme dark and
544light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000545dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000546</p>
547
548<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristy2dcd6822011-06-13 16:21:20 +0000549'<em>sync</em>' flag for channel synchronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000550values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000551>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000552together by the same gamma value, preserving colors. </p>
553
554
555
cristy3ed852e2009-09-05 21:47:34 +0000556<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000557 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000558</div>
559
560<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>
561
cristyd934d102009-10-10 12:55:13 +0000562<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000563minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000564href="#level" >-level</a> operator to stretch the values to the full range of
565values. </p>
566
cristy83543962009-10-16 19:04:28 +0000567<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000568JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
569for the <a href="#level" >-level</a> operation. On the other hand it is the
570right operator to use for color stretching gradient images being used to
571generate Color lookup tables, distortion maps, or other 'mathematically'
572defined images. </p>
573
574<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
575href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
576>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
577problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000578>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000579
580<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristy2dcd6822011-06-13 16:21:20 +0000581special '<em>sync</em>' flag for channel synchronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000582which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000583href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
584'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000585together by the same gamma value, preserving colors, and ignoring
586transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000587
588
cristy3ed852e2009-09-05 21:47:34 +0000589<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000590 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000591</div>
592
593<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>
594
cristy83543962009-10-16 19:04:28 +0000595<p>This operator reads and resets the EXIF image profile setting 'Orientation'
596and then performs the appropriate 90 degree rotation on the image to orient
597the image, for correct viewing. </p>
598
599<p>This EXIF profile setting is usually set using a gravity sensor in digital
600camara, however photos taken directly downward or upward may not have an
601appropriate value. Also images that have been orientation 'corrected' without
602reseting this setting, may be 'corrected' again resulting in a incorrect
603result. If the he EXIF profile was previously stripped, the <a
604href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
605
606
cristy3ed852e2009-09-05 21:47:34 +0000607<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000608 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000609</div>
610
611<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>
612
613<p>An error results if the images are not identically sized.</p>
614
cristy3ed852e2009-09-05 21:47:34 +0000615
616<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000617 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000618</div>
619
620<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>
621
622<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>
623
624<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000625 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000626</div>
627
628<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>
629
630<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>
631
632<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000633 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000634</div>
635
636<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>
637
cristye6378132009-10-26 20:05:17 +0000638<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 +0000639
cristye6378132009-10-26 20:05:17 +0000640<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -resize 1000% -bench 5 logo.png</span><span class='crtout'>Performance: 5i 0.875657ips 6.880u 0:05.710</span></p>
641<p>In this example, 5 iterations were completed at 0.875657 iterations per second, using 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 +0000642
643<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000644 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000645</div>
646
647<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>
648
649<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>
650
651<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>
652
653<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
654negative results without clipping to the color value range
655(0..QuantumRange).</p>
656
657<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +0000658<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 +0000659</p>
660
661<div style="margin: auto;">
cristy37e0dfd2011-03-06 16:35:34 +0000662 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000663</div>
664
665<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>
666
667<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000668 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000669</div>
670
cristy5cadd612009-09-21 19:33:41 +0000671<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>
672
673<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.
674</p>
cristy3ed852e2009-09-05 21:47:34 +0000675
676
677<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000678 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000679</div>
680
cristy83a272e2010-05-07 20:40:35 +0000681<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 +0000682
683<p>Blend will average the images together ('plus') according to the
684percentages given and each pixels transparency. If only a single percentage
685value is given it sets the weight of the composite or 'source' image, while
686the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000687<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
688'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000689
690
691<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000692 <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 +0000693</div>
694
695<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>
696
697<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000698 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000699</div>
700
701<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>
702
703<div style="margin: auto;">
704
705<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000706 <h4><a id="blur"></a>-blur <em class="arg">radius</em><br />-blur <em class="arg">radius</em>x<em class="arg">sigma</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000707</div>
708
709<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>
710
cristyb15553d2010-07-03 22:53:14 +0000711<p>Convolve the image with a Gaussian or normal distribution using the given
712<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000713
714<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
715</div>
716
cristyb15553d2010-07-03 22:53:14 +0000717<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000718determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000719
cristyb15553d2010-07-03 22:53:14 +0000720<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000721array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000722integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000723radius that will provide meaningful results for the Gaussian distribution.
724</p>
725
726<p>The larger the <em class="arg" >Radius</em> the radius the slower the
727operation is. However too small a <em class="arg" >Radius</em>, and sever
728aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
729should be at least twice the <em class="arg" >Sigma</em> value, though three
730times will produce a more accurite result. </p>
731
732<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
733by taking advantage of the separability properties of the distribution. Here
734we apply a single-dimensional Gaussian matrix in the horizontal direction,
735then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000736
737<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
738pixels which are outside the image proper are blurred into the final result.
739</p>
740
741
742<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000743 <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 +0000744</div>
745
746<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>
747
748<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
749Average (EWA) of the source image, scaled according to the grayscale
750mapping. </p>
751
752<p>The ellipse is weighted with sigma set to the given <em class="arg"
753>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
754defaults to the <em class="arg" >Width</em> for a normal circular Guassian
755weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
756horizontal clock-wise. </p>
757
758<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
759pixels which are outside the image proper are blurred into the final result.
760</p>
761
762
763<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000764 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000765</div>
766
767<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>
768
cristybc9539a2010-08-16 18:06:20 +0000769<p>Set the width and height using the <em class="arg">size</em> portion of the
770<em class="arg">gravity</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
771ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000772
cristybc9539a2010-08-16 18:06:20 +0000773<p>Set the border color by preceding with the <a
774href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000775
cristybc9539a2010-08-16 18:06:20 +0000776<p>The <a href="#border">-border</a> operation is affected by the current <a
777href="#compose">-compose</a> setting and assumes that this is using the default
778'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
779size colors by the current <a href="#bordercolor">-bordercolor</a> before
780overlaying the original image in the center of this net image. This means that
781with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000782be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000783<p>See also the <a href="#frame">-frame</a> option, which has more
784functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000785
786<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000787 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000788</div>
789
790<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>
791
792<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
793
794<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
795
796<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000797 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000798</div>
799
800<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>
801
802<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000803 <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 +0000804</div>
805
806<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>
807
cristyefb2bdb2010-11-20 19:35:22 +0000808<p>Brightness and Contrast values apply changes to the input image. They are
809not absolute settings. A brightness or contrast value of zero means no change.
810The range of values is -100 to +100 on each. Positive values increase the
811brightness or contrast and negative values decrease the brightness or contrast.
812To control only contrast, set the brightness=0. To control only brightness,
813set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000814
cristyefb2bdb2010-11-20 19:35:22 +0000815<p>You may also use <a href="#fill">-channel</a> to control which channels to
816apply the brightness and/or contrast change. The default is to apply the same
817transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000818
cristyefb2bdb2010-11-20 19:35:22 +0000819<p>Brightness and Contrast arguments are converted to offset and slope of a
820linear transform and applied
821using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000822
cristyefb2bdb2010-11-20 19:35:22 +0000823<p>The slope varies from 0 at contrast=-100 to almost vertical at
824contrast=+100. For brightness=0 and contrast=-100, the result are totally
825midgray. For brightness=0 and contrast=+100, the result will approach but
826not quite reach a threshold at midgray; that is the linear transformation
827is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000828
cristyefb2bdb2010-11-20 19:35:22 +0000829<p>Negative slopes, i.e. negating the image, are not possible with this
830function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000831
cristyefb2bdb2010-11-20 19:35:22 +0000832<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
833at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
834totally white. Similarly, when contrast=0 and brightness=-100, the result is
835totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000836
cristyefb2bdb2010-11-20 19:35:22 +0000837<p>As the range of values for the arguments are -100 to +100, adding the '%'
838symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000839
840<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000841 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000842</div>
843
844<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>
845
846<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000847 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000848</div>
849
850<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>
851
cristy71a3f602010-09-15 12:38:16 +0000852<p>This option sets the caption meta-data of an image read in after this
853option has been given. To modify a caption of images already in memory use
854"<kbd><a href="#set">-set</a> caption</kbd>". </p>
855
856<p>The caption can contain special format characters listed in the <a
857href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000858Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000859is finally assigned to the individual images. </p>
860
861<p>If the first character of <em class="arg">string</em> is <em
862class="arg">@</em>, the image caption is read from a file titled by the
863remaining characters in the string. Comments read in from a file are literal;
864no embedded formatting characters are recognized.</p>
865
866<p>Caption meta-data ais not visible on the image itself. To do that use the
867<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
868instead.</p>
869
870<p>For example,</p>
871
872<p class="crtsnip">
873 -caption "%m:%f %wx%h" bird.miff
874</p>
875
876<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
877that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
878480.</p>
879
880
cristy3ed852e2009-09-05 21:47:34 +0000881<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000882 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000883</div>
884
885<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>
886
887<p>Here is an example color correction collection:</p>
888
889<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000890&lt;?xml version="1.0" encoding="UTF-8"?&gt;
891&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
892 &lt;ColorCorrection id="cc06668"&gt;
893 &lt;SOPNode&gt;
894 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
895 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
896 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
897 &lt;/SOPNode&gt;
898 &lt;SATNode&gt;
899 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
900 &lt;/SATNode&gt;
901 &lt;/ColorCorrection&gt;
902&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000903</pre>
904
905<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000906 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000907</div>
908
909<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>
910
cristyefb2bdb2010-11-20 19:35:22 +0000911<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
912<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
913<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
914<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000915
cristy83a272e2010-05-07 20:40:35 +0000916<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000917abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
918'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
919'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000920
cristy83a272e2010-05-07 20:40:35 +0000921For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
922you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000923<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000924 -channel Red,Blue
925</p>
926<p>or you can use the short hand form</p>
927<p class="crtsnip">
928 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000929</p>
930
cristy2dcd6822011-06-13 16:21:20 +0000931<p>All the channels that are present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000932special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
933but generally any operators that are generally 'grey-scale' image operators,
934will understand this setting. See individual operator documentation. </p>
935
cristydcca3fa2010-12-29 21:50:07 +0000936<br />
cristy83a272e2010-05-07 20:40:35 +0000937
cristy2dcd6822011-06-13 16:21:20 +0000938<p>On top of the normal channel selection an extra flag can be specified,
cristy83a272e2010-05-07 20:40:35 +0000939'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000940operators that understand this flag should perform: cross-channel
cristy2dcd6822011-06-13 16:21:20 +0000941synchronization of the channels. If not specified, then most grey-scale
cristybac7a162010-06-15 19:57:29 +0000942operators will apply their image processing operations to each individual
943channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000944setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000945
946<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000947<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000948together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000949it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000950independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000951
cristydcca3fa2010-12-29 21:50:07 +0000952<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000953and the <a href="#compose">-compose</a> mathematical methods, also understands
954the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
955to the alpha channel (if present). That is to say it will modify the image
956processing with the understanding that fully-transparent colors should not
957contribute to the final result. </p>
958
cristy2dcd6822011-06-13 16:21:20 +0000959<p>Basically, by default, operators work with color channels in synchronous, and
cristybac7a162010-06-15 19:57:29 +0000960treats transparency as special, unless the <a href="#channel">-channel</a>
961setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
962How each operator does this depends on that operators current implementation.
963Not all operators understands this flag at this time, but that is changing.
964</p>
cristy83a272e2010-05-07 20:40:35 +0000965
966<p>To print a complete list of channel types, use <a href="#list">-list
967channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000968
cristydcca3fa2010-12-29 21:50:07 +0000969<br />
cristyd934d102009-10-10 12:55:13 +0000970
971<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000972'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
973channels except the transparency channel, and that all the color channels are
974to be modified in exactly the same way, with a understanding of transprancy
975(depending on the operation being applied). The 'plus' form <a
976href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000977
978<p>Options that are affected by the <a href="#channel" >-channel</a> setting
979include the following.
980
981<a href="#auto-gamma">-auto-gamma</a>,
982<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000983<a href="#black-threshold">-black-threshold</a>,
984<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000985<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000986<a href="#clut">-clut</a>,
987<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000988<a href="#composite">-composite</a> (Mathematical compose methods only),
989<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000990<a href="#contrast-stretch">-contrast-stretch</a>,
991<a href="#evaluate">-evaluate</a>,
992<a href="#function">-function</a>,
993<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000994<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000995<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000996<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000997<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000998<a href="#negate">-negate</a>,
999<a href="#normalize">-normalize</a>,
1000<a href="#ordered-dither">-ordered-dither</a>,
1001<a href="#radial-blur">-radial-blur</a>,
1002<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +00001003<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +00001004<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +00001005<a href="#white-threshold">-white-threshold</a>.
1006</p>
1007
cristyd0bda5e2010-09-21 16:22:45 +00001008<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +00001009>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +00001010href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +00001011default). These operators have yet to be made to understand the newer 'Sync'
1012flag. </p>
1013
cristybac7a162010-06-15 19:57:29 +00001014<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
1015the image before thresholding, if no <a href="#channel" >-channel</a> setting
1016has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +00001017
1018<p>Also some operators such as <a href="#blur">-blur</a>, <a
1019href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
1020color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
1021href="#channel" >-channel</a>. Generally this done to ensure that
1022fully-transparent colors are treated as being fully-transparent, and thus any
1023underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +00001024resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +00001025convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +00001026and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +00001027
cristybac7a162010-06-15 19:57:29 +00001028<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +00001029color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +00001030alpha channel present, and the <a href="#channel" >-channel</a> setting tells
1031the operator to apply the operation using alpha channels. The <a
1032href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +00001033
cristy3ed852e2009-09-05 21:47:34 +00001034
1035<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001036 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +00001037</div>
1038
1039<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>
1040
1041<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001042 <h4><a id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001043</div>
1044
1045<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>
1046
1047<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001048 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001049</div>
1050
1051<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>
1052
cristyefb2bdb2010-11-20 19:35:22 +00001053<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>
1054and <em class="arg">height</em> given in the of the <em class="arg">size</em>
1055portion of the <em class="arg">geometry</em> argument give the number of
1056columns and rows to remove. The <em class="arg">offset</em> portion of
1057the <em class="arg">geometry</em> argument is influenced by
1058a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +00001059
cristyefb2bdb2010-11-20 19:35:22 +00001060<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
1061and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00001062
cristyacc04882011-05-04 23:03:43 +00001063<p>While it can remove internal rows and columns of pixels, it is more
1064typically used with as <a href="#gravity">-gravity</a> setting and zero
1065offsets so as to remove a single edge from an image. Compare this to <a
1066href="#shave" >-shave</a> which removes equal numbers of pixels from oppisite
1067sides of the image. </p>
cristydcca3fa2010-12-29 21:50:07 +00001068
cristyacc04882011-05-04 23:03:43 +00001069<p>Using <a href="#chop">-chop</a> will effectivally undo the results of a <a
1070href="#splice">-splice</a> that was given the same <em
1071class="arg">geometry</em> and <a href="#gravity">-gravity</a> settings. </p>
cristydcca3fa2010-12-29 21:50:07 +00001072
1073
cristy3ed852e2009-09-05 21:47:34 +00001074<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001075 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001076</div>
1077
1078<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>
1079
1080<p>If a clipping path is present, it is applied to subsequent operations.</p>
1081
1082<p>For example, in the command</p>
1083
1084<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
1085<p>only the pixels within the clipping path are negated.</p>
1086
1087<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1088
1089<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001090 <h4><a id="clip-mask"></a>-clip-mask</h4>
cristy3ed852e2009-09-05 21:47:34 +00001091</div>
1092
1093<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>
1094
cristy30092792011-02-22 02:06:14 +00001095<p>Use the given image as a 'do-not-modify' mask of the current images in the
1096current image sequence. Assuming the clipmask is a greyscale image the same
1097size at the one already in memory, any areas that is white will not be
1098modified by any of the 'image processing operators' that follow, until the
1099mask is removed. Pixels in the black areas of the clip mask will be modified
1100as normal. </p>
1101
1102<p>In some ways this is similar to (though not the same) as defining
1103a rectangular <a href="#region" >-region</a>, or using the negative of the
1104mask (thrid) image in a three image <a href="#composite" >-composite</a>,
1105operation. </p>
1106
1107
cristy3ed852e2009-09-05 21:47:34 +00001108<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001109 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001110</div>
1111
1112<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 8BImageMagick profile.</td><td style='text-align:right;'></td></tr></table>
1113
cristyd241f442011-03-29 13:50:49 +00001114<p>This is almost identical to <a href="#clip">-clip</a>. </p>
cristy30092792011-02-22 02:06:14 +00001115
1116
cristy3ed852e2009-09-05 21:47:34 +00001117<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001118 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001119</div>
1120
cristy8b9dd952011-03-21 22:56:18 +00001121<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 +00001122
cristydcca3fa2010-12-29 21:50:07 +00001123<p>Inside parenthesis (where the operator is normally used) it will make a
1124clone of the images from the last 'pushed' image sequence, and adds them to
1125the end of the current image sequence. Outside parenthesis
1126(not recommended) it clones the images from the current image sequence. </p>
1127
cristy3ed852e2009-09-05 21:47:34 +00001128<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000011290. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001130example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001131represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001132dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1133spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
cristy8b9dd952011-03-21 22:56:18 +00001134effectively clone all the images. </p>
cristydcca3fa2010-12-29 21:50:07 +00001135
1136<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
cristybaacd172011-04-30 23:11:03 +00001137in the image sequence, and is thus equivalent to using a argument of
cristydcca3fa2010-12-29 21:50:07 +00001138'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001139
1140<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001141 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001142</div>
1143
1144<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
1145corresponding channel in the second image as a <b>c</b>olor
1146<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1147
1148<p>The second (LUT) image is ordinarily a gradient image containing the
1149histogram mapping of how each channel should be modified. Typically it is a
1150either a single row or column image of replacement color values. If larger
1151than a single row or column, values are taken from a diagonal line from
1152top-left to bottom-right corners.</p>
1153
1154<p>The lookup is further controlled by the <a
1155href="#interpolate">-interpolate</a> setting, which is especially handy for an
1156LUT which is not the full length needed by the ImageMagick installed Quality
1157(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1158'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1159gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1160lookup of color values. </p>
1161
1162<p>This operator is especially suited to replacing a grayscale image with a
1163specific color gradient from the CLUT image. </p>
1164
1165<p>Only the channel values defined by the <a href="#channel">-channel</a>
1166setting will have their values replaced. In particular, since the default <a
1167href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1168transparency (alpha/matte channel) is not affected, unless the <a
1169href="#channel">-channel</a> setting is modified. When the alpha channel is
1170set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1171as the other channels, implying that alpha/matte values are replaced using the
1172alpha/matte values of the original image. </p>
1173
cristyd0bda5e2010-09-21 16:22:45 +00001174<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001175transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1176href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001177assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001178replacement alpha values. That is you can use a gray-scale CLUT image to
1179adjust a existing images alpha channel, or you can color a gray-scale image
1180using colors form CLUT containing the desired colors, including transparency.
1181</p>
1182
cristyefb2bdb2010-11-20 19:35:22 +00001183<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1184according to the lookup of the full color RGB value from a 2D representation
1185of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001186
1187
1188<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001189 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001190</div>
1191
1192<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>
1193
cristyefb2bdb2010-11-20 19:35:22 +00001194<p>Overlay each image in an image sequence according to
1195its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1196an animation at each point in the animation sequence. All images should be
1197the same size, and are assigned appropriate GIF disposal settings for the
1198animation to continue working as expected as a GIF animation. Such frames
1199are more easily viewed and processed than the highly optimized GIF overlay
1200images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001201
cristyefb2bdb2010-11-20 19:35:22 +00001202<p>The animation can be re-optimized after processing using
1203the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1204there is no guarantee that the restored GIF animation optimization is
1205better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001206
1207
1208<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001209 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001210</div>
1211
1212<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>
1213
cristyefb2bdb2010-11-20 19:35:22 +00001214<p>Specify the amount of colorization as a percentage. Separate colorization
1215values can be applied to the red, green, and blue channels of the image with
1216a comma-delimited list of colorization
1217values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001218
1219<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001220 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></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%'>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>
1224
1225<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1226
cristyefb2bdb2010-11-20 19:35:22 +00001227<p>This option only applies when the default X server visual
1228is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1229to <a href="#visual">-visual</a> for more details. By default,
1230a shared colormap is allocated. The image shares colors with
1231other X clients. Some image colors could be approximated,
1232therefore your image may look very different than intended.
1233If <kbd>private</kbd> is chosen, the image colors appear exactly
1234as they are defined. However, other clients may go <em>technicolor</em>
1235when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001236
1237<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001238 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001239</div>
1240
1241<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>
1242
cristyefb2bdb2010-11-20 19:35:22 +00001243<p>The actual number of colors in the image may be less than your request,
1244but never more. Note that this a color reduction option. Images with fewer
1245unique colors than specified by <em class="arg">value</em> will have any
1246duplicate or unused colors removed. The ordering of an existing color
1247palette may be altered. When converting an image from color to grayscale,
1248it is more efficient to convert the image to the gray colorspace before
1249reducing the number of colors. Refer to
1250the <a href="../www/quantize.html">
1251color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001252
1253<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001254 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001255</div>
1256
1257<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>
1258
cristyefb2bdb2010-11-20 19:35:22 +00001259<p>This option permits saturation changes, hue rotation, luminance to alpha,
1260and various other effects. Although variable-sized transformation matrices
1261can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1262for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1263Adobe Flash except offsets are in column 6 rather than 5 (in support of
1264CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001265
1266<p>As an example, to add contrast to an image with offsets, try this command:</p>
1267
1268<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001269 convert kittens.jpg -color-matrix \
1270 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1271 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1272 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1273 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1274 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1275 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
cristy2c839602010-04-03 02:32:08 +00001276</pre>
1277<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001278 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001279</div>
1280
1281<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>
1282
1283<p>Choices are:</p>
1284
1285<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001286 CMY CMYK Gray HSB
1287 HSL HWB Lab Log
1288 OHTA Rec601Luma Rec601YCbCr Rec709Luma
1289 Rec709YCbCr RGB sRGB Transparent
1290 XYZ YCbCr YCC YIQ
1291 YPbPr YUV
cristy3ed852e2009-09-05 21:47:34 +00001292</pre>
1293
1294<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1295
1296<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>
1297
1298<table class="doc">
1299 <caption>Conversion Of RGB To Other Color Spaces</caption>
1300 <tr><th align="left" valign="middle">CMY</th></tr>
1301 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1302 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1303 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1304 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1305 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1306 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1307 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1308 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1309
1310 <tr><th align="left" valign="middle">Gray</th></tr>
1311 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1312
1313 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1314 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1315 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1316 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1317
1318 <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>
1319 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1320 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1321 <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>
1322
1323 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1324 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1325 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1326 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1327
1328 <tr><th align="left" valign="middle">LAB</th></tr>
1329 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1330 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1331 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1332
1333 <tr><th align="left" valign="middle">LOG</th></tr>
1334 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1335 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1336 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1337
1338 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1339 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1340 <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>
1341 <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>
1342
1343 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1344 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1345
1346 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1347 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1348 <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>
1349 <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>
1350
1351 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1352 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1353
1354 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1355 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1356 <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>
1357 <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>
1358
1359 <tr><th align="left" valign="middle">sRGB</th></tr>
cristyf9a6c462011-04-24 14:01:11 +00001360 <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>
1361 <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>
1362 <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 +00001363
1364 <tr><th align="left" valign="middle">XYZ</th></tr>
1365 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1366 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1367 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1368
1369 <tr><th align="left" valign="middle">YCC</th></tr>
1370 <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>
1371 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1372 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1373
1374 <tr><th align="left" valign="middle">YCbCr</th></tr>
1375 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1376 <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>
1377 <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>
1378
1379 <tr><th align="left" valign="middle">YIQ</th></tr>
1380 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1381 <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>
1382 <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>
1383
1384 <tr><th align="left" valign="middle">YPbPr</th></tr>
1385 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1386 <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>
1387 <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>
1388
1389 <tr><th align="left" valign="middle">YUV</th></tr>
1390 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1391 <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>
1392 <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>
1393</table>
1394
1395<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001396 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001397</div>
1398
1399<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>
1400
1401<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>
1402
1403<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.
1404</p>
1405
cristy4949d522010-03-12 18:41:34 +00001406<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert original.png -channel RGB -separate sepimage.png</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </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 +00001407<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001408 <h4><a id="comment"></a>-comment <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001409</div>
1410
1411<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>
1412
cristyd0bda5e2010-09-21 16:22:45 +00001413<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001414option has been given. To modify a comment of images already in memory use
1415"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001416
cristy71a3f602010-09-15 12:38:16 +00001417<p>The comment can contain special format characters listed in the <a
1418href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001419Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001420is finally assigned to the individual images. </p>
1421
1422<p>If the first character of <em class="arg">string</em> is <em
1423class="arg">@</em>, the image comment is read from a file titled by the
1424remaining characters in the string. Comments read in from a file are literal;
1425no embedded formatting characters are recognized.</p>
1426
1427<p>Comment meta-data are not visible on the image itself. To do that use the
1428<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1429instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001430
1431<p>For example,</p>
1432
1433<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001434 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001435</p>
1436
cristy71a3f602010-09-15 12:38:16 +00001437<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1438that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1439480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001440
1441<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001442 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001443</div>
1444
1445<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>
1446
cristybc9539a2010-08-16 18:06:20 +00001447<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1448a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001449
cristybc9539a2010-08-16 18:06:20 +00001450<p>This setting effects image processing operators that merge two (or more)
1451images together in some way. This includes the operators,
1452<a href="#composite">-composite</a>,
1453<a href="#layers">-layers</a> composite,
1454<a href="#flatten">-flatten</a>,
1455<a href="#mosaic">-mosaic</a>,
1456<a href="#layers">-layers</a> merge,
1457<a href="#border">-border</a>,
1458<a href="#frame">-frame</a>,
1459and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001460
cristybc9539a2010-08-16 18:06:20 +00001461<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1462command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001463
1464
1465<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001466 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001467</div>
1468
cristybc9539a2010-08-16 18:06:20 +00001469<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 +00001470
1471<p>Take the first image 'destination' and overlay the second 'source' image
1472according to the current <a href="#compose">-compose</a> setting. The location
1473of the 'source' or 'overlay' image is controlled according to <a
1474href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1475settings. </p>
1476
1477<p>If a third image is given this is treated as a gray-scale 'mask' image
1478relative to the first 'destination' image. This mask will limit what parts of
1479the destination can be modified by the image composition. However for the
1480'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1481Y-displacement image instead. </p>
1482
1483<p>If a <a href="#compose">-compose</a> method requires extra numerical
1484arguments or flags these can be provided by setting the <a
1485href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001486appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001487
1488<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1489image outside the overlay area. You can disable this by setting the special <a
1490href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1491to '<kbd>false</kbd>'. </p>
1492
1493
1494<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001495 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001496</div>
1497
1498<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>
1499
1500<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>
1501
1502<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1503
1504<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>
1505
1506<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>
1507
1508<p><kbd>Lossless</kbd> refers to lossless JPEG, which is only available if the JPEG library has been patched to support it. Use of lossless JPEG is generally not recommended.</p>
1509
1510<p>Use the <a href="#quality">-quality</a> option to set the compression level to be used by JPEG, PNG, MIFF, and MPEG encoders. Use the <a href="#sampling-factor">-sampling-factor</a> option to set the sampling factor to be used by JPEG, MPEG, and YUV encoders for down-sampling the chroma channels.</p>
1511
1512<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001513 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001514</div>
1515
1516<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>
1517
1518<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>
1519
1520<p>For a more pronounced effect you can repeat the option:</p>
1521
1522<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1523<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001524 <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 +00001525</div>
1526
1527<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>
1528
cristyd934d102009-10-10 12:55:13 +00001529<p>While performing the stretch, black-out at most <em
1530class="arg" >black-point</em> pixels and white-out at most <em
1531class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1532<em class="arg" >black-point %</em> pixels and white-out at most <em
1533class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001534
cristyd934d102009-10-10 12:55:13 +00001535<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1536>-contrast-stretch</a> will black-out at most <em class="arg"
1537>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1538minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1539class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1540>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001541
cristyd934d102009-10-10 12:55:13 +00001542<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1543the image's min and max values are stretched to 0 and <em class="QR"
1544>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1545clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001546>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001547prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001548
cristyd934d102009-10-10 12:55:13 +00001549<p>Internally operator works by creating a histogram bin, and then uses that
1550bin to modify the image. As such some colors may be merged together when they
1551originally fell into the same 'bin'. </p>
1552
1553<p>All the channels are normalized in concert by the came amount so as to
1554preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001555setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001556setting will normalize the RGB channels independently.</p>
1557
1558<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1559normalization of mathematical images. </p>
1560
1561<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001562
1563
1564<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001565 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001566</div>
1567
1568<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>
1569
cristy16ff93c2010-01-13 23:18:07 +00001570<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001571a comma-separated list of integers (with no spaces), ordered left-to right,
1572starting with the top row. Presently, only odd-dimensioned kernels are
1573supported, and therefore the number of entries in the specified <em
1574class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15757<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001576
cristyd934d102009-10-10 12:55:13 +00001577<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
1578positive and negative results are relative to a user-specified bias value.
1579This is important for non-HDRI compilations of ImageMagick when dealing with
1580convolutions that contain negative as well as positive values. This is
1581especially the case with convolutions involving high pass filters or edge
1582detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001583</p>
1584
cristyd934d102009-10-10 12:55:13 +00001585<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
1586negative results without clipping to the color value range (0..QuantumRange).
1587See the discussion on HDRI implementations of ImageMagick on the page <a
cristy47774982011-02-15 15:17:19 +00001588href="../www/high-dynamic-range.html">High
cristyd934d102009-10-10 12:55:13 +00001589Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1590href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1591<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1592entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001593
cristy3ed852e2009-09-05 21:47:34 +00001594
1595<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001596 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001597</div>
1598
1599<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>
1600
1601<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>
1602
1603<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>
1604
1605<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>
1606
1607<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>
1608
1609<p>By adding a exclamation character flag to the geometry argument, the
1610cropped images virtual canvas page size and offset is set as if the
1611geometry argument was a viewport or window. This means the canvas page size
1612is set to exactly the same size you specified, the image offset set
1613relative top left corner of the region cropped. </p>
1614
1615<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1616special single pixel transparent 'missed' image is returned, and a 'crop
1617missed' warning given. </p>
1618
cristy739df912009-10-24 16:10:18 +00001619<p>It might be necessary to <a href="#repage" >+repage</a> the image prior to cropping the image to ensure the crop coordinate frame is relocated to the upper-left corner of the visible image.</p>
cristy3ed852e2009-09-05 21:47:34 +00001620
1621<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001622 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001623</div>
1624
1625<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>
1626
1627<p><em class="arg">Amount</em> defines the number of positions each
1628colormap entry is shifted.</p>
1629
1630
1631<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001632 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001633</div>
1634
1635<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>
1636
1637<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>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>
1638
1639
1640<p>For example, to log cache and blob events, use.</p>
1641
1642<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1643<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1644
1645<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1646
1647<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1648
1649<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1650
1651<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>
1652
1653
1654<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001655 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001656</div>
1657
1658<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>
1659
1660<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1661
1662<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1663
1664
1665<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001666 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001667</div>
1668
1669<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>
1670
1671<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>
1672
1673<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>
1674
1675<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1676
1677
1678<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001679 <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 +00001680</div>
1681
cristyd0bd44a2010-09-24 12:38:11 +00001682<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 +00001683coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001684
cristyd0bda5e2010-09-21 16:22:45 +00001685<p>This option creates one or more definitions for coders and decoders to use
1686while reading and writing image data. Definitions are generally used to
1687control image file format coder modules, and image processing operations,
1688beyond what is provided by normal means. Defined settings are listed in <a
1689href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1690as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001691
cristyd0bda5e2010-09-21 16:22:45 +00001692<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1693definition of a flag is created with that name. This used to control on/off
1694options. Use <a href="#define">+define key</a> to remove definitions
1695previously created. Use <a href="#define">+define "*"</a> to remove all
1696existing definitions.</p>
1697
cristyd0bd44a2010-09-24 12:38:11 +00001698<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001699href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001700>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 +00001701Properties</a> in the defined value. </p>
1702
cristyefb2bdb2010-11-20 19:35:22 +00001703<p>The <em>option</em> and <em>key</em> are case-independent (they are
1704converted to lowercase for use within the decoders) while the <em>value</em>
1705is case-dependent.</p>
1706
cristyd0bda5e2010-09-21 16:22:45 +00001707<p>Such settings are global in scope, and effect all images and operations. </p>
1708
1709<p>The following definitions are just some of the artifacts that are
1710available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001711
cristydcca3fa2010-12-29 21:50:07 +00001712<dl>
cristy045bd902010-01-30 18:56:24 +00001713<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001714<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001715 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001716
cristy045bd902010-01-30 18:56:24 +00001717<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001718<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001719 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001720
cristy045bd902010-01-30 18:56:24 +00001721<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001722<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001723 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001724
cristy045bd902010-01-30 18:56:24 +00001725<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001726<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1727 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001728 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001729
cristy045bd902010-01-30 18:56:24 +00001730<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001731<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1732 compression factor is the reciprocal of the compression ratio. The valid
1733 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1734 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001735 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001736
cristy3ed852e2009-09-05 21:47:34 +00001737<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001738 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001739
cristy045bd902010-01-30 18:56:24 +00001740<dt>png:bit-depth=<em class="arg">value</em></dt>
1741<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001742<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1743 encoder to use a different bit-depth and color-type than it would have
1744 normally selected, but only if this does not cause any loss of image
1745 quality. Any attempt to reduce image quality is treated as an error and no
1746 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1747 can use these "defines" to cause it to be written as an 8-bit grayscale,
1748 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1749 you cannot force it to be written as a grayscale or indexed PNG. If you
1750 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1751 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1752 reduce the image quality prior to using the PNG encoder. Note that in
1753 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001754 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001755 8-bit depth.</dd>
1756
cristya4dfb122011-07-07 19:01:57 +00001757<dt>png:compression-filter=<em class="arg">value</em></dt>
1758 <dd> valid values are 0 through 7. 0-4 are the corresponding PNG filters,
1759 5 means adaptive filtering except for images with a colormap, 6 means
1760 adaptive filtering for all images, 7 means MNG "loco" compression.</dd>
1761
cristy87a7f072011-07-01 00:08:52 +00001762<dt>png:compression-level=<em class="arg">value</em></dt>
1763 <dd> valid values are 0 through 9, with 0 providing the least but fastest
1764 compression and 9 usually providing the best and always the slowest.</dd>
1765
1766<dt>png:compression-strategy=<em class="arg">value</em></dt>
1767 <dd> valid values are 0 through 4, meaning default, filtered, huffman_only,
cristya4dfb122011-07-07 19:01:57 +00001768 rle, and fixed ZLIB compression strategy. If you are using an old zlib
1769 that does not support Z_RLE (before 1.2.0) or Z_FIXED (before 1.2.2.2),
1770 values 3 and 4, respectively, will use the zlib default strategy
1771 instead.</dd>
cristy87a7f072011-07-01 00:08:52 +00001772
cristydcca3fa2010-12-29 21:50:07 +00001773<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1774<dt>png:include-chunk=<em class="arg">value</em></dt>
1775<dd>ancillary chunks to be excluded from or included in PNG output.
1776
1777 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1778 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1779 or the word <em class="arg">all</em> or
1780 the word <em class="arg">none</em>. There must be no spaces in the
1781 list. Although PNG chunk-names are case-dependent, you can use
1782 all lowercase names if you prefer.</p>
1783
cristyd241f442011-03-29 13:50:49 +00001784 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
1785 of the PNG encoder and have no effect on the PNG decoder.</p>
1786
cristydcca3fa2010-12-29 21:50:07 +00001787 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1788 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1789 only be written if gamma is not 1/2.2, since most decoders assume
1790 sRGB and gamma=1/2.2 when no colorspace information is included in
1791 the PNG file. Because the list is processed from left to right, you
1792 can achieve this with a single define:</p>
1793
1794<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001795 -define png:include-chunk=none,gAMA
cristydcca3fa2010-12-29 21:50:07 +00001796</pre>
1797
1798 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
cristya4dfb122011-07-07 19:01:57 +00001799 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any such
1800 entries appearing in the list will be ignored.</p>
cristydcca3fa2010-12-29 21:50:07 +00001801
1802 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1803 image has transparency, the PNG colortype is forced to be 4 or 6
1804 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1805 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1806 on the PNG colortype of the output image.</p>
1807
1808 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1809 following for PNG output:</p>
1810
1811<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001812 -define png:include-chunk=none,gama
cristydcca3fa2010-12-29 21:50:07 +00001813</pre>
1814
1815 <p>The default behavior is to include all known PNG ancillary chunks
cristyf7964272011-01-30 03:49:12 +00001816 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk,
1817 and to exclude all PNG chunks that are unknown to ImageMagick,
1818 regardless of their PNG "copy-safe" status as described in the
1819 PNG specification.</p>
cristyd241f442011-03-29 13:50:49 +00001820
1821 <p>Any chunk names that are not known to ImageMagick are ignored
1822 if they appear in either the "include-chunk" or "exclude-chunk" list.
1823 The ancillary chunks currently known to ImageMagick are
1824 <kbd>bKGD</kbd>, <kbd>cHRM</kbd>, <kbd>gAMA</kbd>, <kbd>iCCP</kbd>,
1825 <kbd>oFFs</kbd>, <kbd>pHYs</kbd>, <kbd>sRGB</kbd>, <kbd>tEXt</kbd>,
1826 <kbd>tRNS</kbd>, <kbd>vpAg</kbd>, and <kbd>zTXt</kbd>.</p>
1827
cristyf9a6c462011-04-24 14:01:11 +00001828 <p>You can also put <kbd>date</kbd> in the list to include or exclude
1829 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
1830 inserts in the output PNG.</p>
1831
1832</dd>
1833
1834<dt>png:preserve-colormap</dt>
1835 <dd>Use the existing image->colormap. Normally the PNG encoder will
1836 try to optimize the palette, eliminating unused entries and putting
1837 the transparent colors first. If this flag is set, that behavior
1838 is suppressed.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001839
cristy3ed852e2009-09-05 21:47:34 +00001840<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001841<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1842 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001843 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001844
cristy045bd902010-01-30 18:56:24 +00001845<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001846<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1847 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1848 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001849 included, the result is a single precision floating point format.
1850 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001851 double precision floating point format.</dd>
1852
cristydcca3fa2010-12-29 21:50:07 +00001853</dl>
cristy3ed852e2009-09-05 21:47:34 +00001854
cristyd0bda5e2010-09-21 16:22:45 +00001855<p>For example, to create a postscript file that will render only the black
1856pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001857
1858<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bilevel.tif -define ps:imagemask eps3:stencil.ps</span></p>
cristyd0bda5e2010-09-21 16:22:45 +00001859<p>Set attributes of the image registry by prefixing the value with
1860<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1861use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001862
1863<p class="crtsnip">
1864-define registry:temporary-path=/data/tmp
1865</p>
1866
cristyd0bda5e2010-09-21 16:22:45 +00001867
1868
cristy3ed852e2009-09-05 21:47:34 +00001869<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001870 <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 +00001871</div>
1872
1873<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>
1874
1875<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>
1876
1877<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>
1878
1879
1880<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00001881 <h4><a id="delete"></a>-delete <em class="arg">indexes</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001882</div>
1883
1884<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>
1885
1886<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>
1887
1888
1889<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001890 <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 +00001891</div>
1892
1893<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>
1894
1895<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>
1896
1897<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>
1898
1899<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>
1900
1901<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>
1902
1903<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001904 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001905</div>
1906
1907<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>
1908
1909<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>
1910
1911<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001912 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00001913</div>
1914
1915<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>
1916
1917<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001918 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001919</div>
1920
1921<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>
1922
1923<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>
1924
1925<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001926 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00001927</div>
1928
1929<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>
1930
1931<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001932 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001933</div>
1934
1935<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>
1936
1937<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001938 <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 +00001939</div>
1940
1941<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>
1942
1943<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001944is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001945what part of the 'background' image is seen at each point of the overlaid
1946area. Much like the displacement map is a 'lens' that redirects light shining
1947through it so as to present a distorted view the original 'background' image
1948behind it. </p>
1949
1950<p>Any perfect grey areas of the displacement map produce a zero
1951displacement of the image. Black areas produce the given maximum negative
1952displacement of the lookup point, while white produce a maximum positive
1953displacement of the lookup. </p>
1954
1955<p>Note that it is the lookup of the 'background' that is displaced, not a
1956displacement of the image itself. As such an area of the displacement map
1957containing 'white' will have the lookup point 'shifted' by a positive amount,
1958and thus generating a copy of the destination image to the right/downward from
1959the correct position. That is the image will look like it may have been
1960'shifted' in a negative left/upward direction. Understanding this is a very
1961important in understanding how displacement maps work. </p>
1962
1963<p>The given arguments define the maximum amount of displacement in pixels
1964that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001965it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001966outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001967easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001968into the overlay area. </p>
1969
1970<p>The '%' flag makes the displacement scale relative to the size of the
1971overlay image (100% = half width/height of image). Using '!' switches
1972percentage arguments to refer to the destination image size instead.
1973these flags were added as of IM v6.5.3-5.</p>
1974
1975<p>Normally a single grayscale displacement map is provided, which with the
1976given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001977displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001978specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001979the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001980displacement, while the <em class="arg">mask image</em> is used for vertical Y
1981displacement. This allows you to define completely different displacement
1982values for the X and Y directions, and allowing you to lookup any point within
1983the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001984any other nearby pixel, producing complex 2 dimensional displacements, rather
1985than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001986
cristya4dfb122011-07-07 19:01:57 +00001987<p>Alteratively rather than supplying two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001988you can use the 'red' channel of the overlay image to specify the horizontal
1989or X displacement, and the 'green' channel for the vertical or Y displacement.
1990</p>
1991
cristyd0bd44a2010-09-24 12:38:11 +00001992<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 +00001993mask the transparency of the destination image. However areas outside the
1994overlaid areas will not be effected. </p>
1995
1996
1997<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001998 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001999</div>
2000
2001<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>
2002
2003<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
2004
2005<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002006 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002007</div>
2008
2009<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>
2010
2011<p>The layer disposal method defines the way each the displayed image is to be
2012modified after the current 'frame' of an animation has finished being
2013displayed (after its 'delay' period), but before the next frame on an
2014animation is to be overlaid onto the display. </p>
2015
2016<p>Here are the valid methods:</p>
2017
2018<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002019 Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
2020 None 1 Do not dispose, just overlay next frame image.
2021 Background 2 Clear the frame area with the background color.
2022 Previous 3 Clear to the image prior to this frames overlay.
cristy3ed852e2009-09-05 21:47:34 +00002023</pre>
2024
2025<p>You can also use the numbers given above, which is what the GIF format
2026uses internally to represent the above settings. </p>
2027
cristyd0bda5e2010-09-21 16:22:45 +00002028<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002029
2030<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
2031resetting the layer disposal methods of images being read in. </p>
2032
2033<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
2034disposal method for images already in memory.</p>
2035
2036<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002037 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002038</div>
2039
2040<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>
2041
2042
2043<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002044 <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 +00002045</div>
2046
2047<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>
2048
2049<p>The opacity of the composite image is multiplied by the given percent, then
2050it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00002051is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00002052transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
2053are given, each image are dissolved to the percentages given. </p>
2054
2055<p>Note that dissolve percentages do not add, two opaque images dissolved
2056'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2057images, you would need to use dissolve values of '50,100'. </p>
2058
2059<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002060 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002061</div>
2062
2063<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>
2064
2065<p>The <em class="arg">arguments</em> is a single string containing a list
2066of floating point numbers separated by commas or spaces. The number of
2067and meaning of the floating point values depends on the distortion <em
2068class="arg">method</em> being used. </p>
2069
2070<p>Choose from these distortion types:</p>
2071
2072<table class="doc">
2073 <tr valign="top">
2074 <th align="left" style="width: 8%">Method</th>
2075 <th align="left">Description</th>
2076 </tr>
2077
2078 <tr valign="top">
2079 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
2080 <br/>or &nbsp; <kbd>SRT</kbd></td>
2081 <td valign="top">
2082 Distort image by first scaling and rotating about a given 'center',
2083 before translating that 'center' to the new location, in that order. It
2084 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
2085 distortion, but without shearing effects. It also provides a good way
2086 of rotating and displacing a smaller image for tiling onto a larger
2087 background (IE 2-dimensional animations). <br/>
2088
2089 The number of arguments determine the specific meaning of each
2090 argument for the scales, rotation, and translation operations. <br/>
2091
2092 <table style="margin-left:auto; margin-right:auto;">
2093 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
2094 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
2095 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00002096 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002097 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
2098 <tr><td>5:</td>
2099 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2100 <tr><td>6:</td>
2101 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
2102 <tr><td>7:</td>
2103 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
2104 &nbsp; NewX,NewY</em></td></tr>
2105 </table>
2106
cristyd0bda5e2010-09-21 16:22:45 +00002107 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00002108 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2109
2110 <tr valign="top">
2111 <td valign="top"><kbd>Affine</kbd></td>
2112 <td valign="top">
2113 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002114 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002115 point values are given allowing the image to be linearly scaled,
2116 rotated, sheared, and translated, according to those three points. See
2117 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2118 distortions. <br/>
2119
2120 More than 3 sets given control point pairs (12 numbers) is least
2121 squares fitted to best match a lineary affine distortion. If only 2
2122 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002123 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002124 flipping or changes in aspect ratio to the resulting image. If only one
2125 control point pair is provides the image is only translated, (which may
2126 be a floating point non-integer translation). <br/>
2127
2128 This distortion does not include any form of perspective distortion.
2129 </td>
2130
2131 </tr>
2132
2133 <tr valign="top">
2134 <td valign="top"><kbd>AffineProjection</kbd></td>
2135 <td valign="top">
2136 Linearly distort an image using the given Affine Matrix of 6
2137 pre-calculated coefficients forming a set of Affine Equations to map
2138 the source image to the destination image.
2139
2140 <div style="text-align: center"><em>
2141 s<sub>x</sub>, r<sub>x</sub>,
2142 r<sub>y</sub>, s<sub>y</sub>,
2143 t<sub>x</sub>, t<sub>y</sub>
2144 </em></div>
2145
2146 See <a href="#affine" >-affine</a> setting for more detail, and
2147 meanings of these coefficients. <br/>
2148
2149 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002150 alternative methods of defining this distortion, with ImageMagick doing
2151 the calculations needed to generate the required coefficients. You can
2152 see the internally generated coefficients, by using a <a
2153 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002154
2155 </tr>
2156
cristy3ed852e2009-09-05 21:47:34 +00002157 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002158 <td valign="top"><kbd>BilinearForward</kbd><br/>
2159 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002160 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002161 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2162 16 values (see below). Not that lines may not appear straight after
2163 distortion, though the distance between coordinates will remain
2164 consistent. <br/>
2165
2166 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2167 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2168 quadrilateral to a rectangle, while preserving the straigth line edges
2169 in each case. <br/>
2170
2171 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2172 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2173 color setting. Also if the quadraterial becomes 'flipped' the image
2174 may dissappear. <br/>
2175
2176 There are future plans to produce a true Bilinear distortion that will
2177 attempt to map any quadrilateral to any other quadrilateral, while
2178 preserving edges (and edge distance ratios).
2179
2180 </td>
cristy3ed852e2009-09-05 21:47:34 +00002181 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002182
2183 <tr valign="top">
2184 <td valign="top"><kbd>Perspective</kbd></td>
2185 <td valign="top">
2186 Perspective distort the images, using a list of 4 or more sets of
2187 control points (as defined below). More that 4 sets (16 numbers) of
2188 control points provide least squares fitting for more accurate
2189 distortions (for the purposes of image registration and panarama
2190 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2191 linear distortion. <br/>
2192
2193 Perspective Distorted images ensures that straight lines remain
2194 straight, but the scale of the distorted image will vary. The horizon
2195 is anti-aliased, and the 'sky' color may be set using the
2196 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2197 </tr>
2198
2199 <tr valign="top">
2200 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2201 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002202 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002203 pre-calculated coefficients. You can get these coefficients by looking
2204 at the <a href="#verbose" >-verbose</a> output of a
2205 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2206 If the last two perspective scaling coefficients are zero, the
2207 remaining 6 represents a transposed 'Affine Matrix'. </td>
2208
2209 </tr>
2210
2211 <tr valign="top">
2212 <td valign="top"><kbd>Arc</kbd></td>
2213 <td valign="top">
2214 Arc the image (variation of polar mapping) over the angle given around
2215 a circle. <br/>
2216 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2217 <tr valign="top"><td>Argument</td>
2218 <td>Meaning</td></tr>
2219 <tr valign="top"><td><em>arc_angle</em></td>
2220 <td>The angle over which to arc the image side-to-side</td></tr>
2221 <tr valign="top"><td><em>rotate_angle</em></td>
2222 <td>Angle to rotate resulting image from vertical center</td></tr>
2223 <tr valign="top"><td><em>top_radius</em></td>
2224 <td>Set top edge of source image at this radius</td></tr>
2225 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2226 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2227 </table>
2228
2229 The resulting image is always resized to best fit the resulting image,
2230 (as if using <a href="#distort" >+distort</a>) while attempting to
2231 preserve scale and aspect ratio of the original image as much as
2232 possible with the arguments given by the user. All four arguments will
2233 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2234
2235 This a variation of a polar distortion designed to try to preserve the
2236 aspect ratio of the image rather than direct Cartesian to Polar
2237 conversion. </td>
2238 </tr>
2239
2240 <tr valign="top">
2241 <td valign="top"><kbd>Polar</kbd></td>
2242 <td valign="top">
2243 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2244 the image. that is the height of the input image is mapped to the
2245 radius limits, while the width is wrapped around between the
2246 angle limits. <br/>
2247
2248 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2249
2250 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2251 center to the center of the image, and the angles going from -180 (top)
2252 to +180 (top). If <em>Rmax</em> is given the special value of
2253 '<code>0</code>', the the distance from the center to the nearest edge
2254 is used for the radius of the output image, which will ensure the whole
2255 image is visible (though scaled smaller). However a special value of
2256 '<code>-1</code>' will use the distance from the center to the furthest
2257 corner, This may 'clip' the corners from the input rectangular image,
2258 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2259 the same arguments. <br/>
2260
2261 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2262 output image center will default to <code>0,0</code> of the virtual
2263 canvas, and the image size adjusted to ensure the whole input image is
2264 made visible in the output image on the virtual canvas. </td>
2265
2266 </tr>
2267
2268 <tr valign="top">
2269 <td valign="top"><kbd>DePolar</kbd></td>
2270 <td valign="top">
2271 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2272 but generates the reverse Polar to Cartesian distortion. <br/>
2273
2274 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2275 the corners of the input image. However using the special
2276 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2277 distance) will ensure the whole distorted image is preserved in the
2278 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2279 reverse the distortion re-producing the original.
2280
2281 Note that as this distortion requires the area resampling of a circular
2282 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002283 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002284 form of 'super-sampling' image processing technique be used to produce
2285 a high quality result. </td>
2286
2287 </tr>
2288
2289 <tr valign="top">
2290 <td valign="top"><kbd>Barrel</kbd></td>
2291 <td valign="top">
2292 Given the four coefficients (A,B,C,D) as defined by <a
cristy6bcf48e2011-02-15 19:09:04 +00002293 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002294 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002295 correct radial lens distortions. That is in photographs, make straight
2296 lines straight again. <br/>
2297
2298 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2299 <em>X</em> , <em>Y</em> ] ] <br/>
2300 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2301 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2302 [ <em>X</em> , <em>Y</em> ] <br/>
2303 So that it forms the function <br/>
2304 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2305 <em>C</em>*r + <em>D</em> )<br/>
2306
2307 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2308 (defaulting to the center of the image). <br/>
2309 The second form is typically used to distort images, rather than
2310 correct lens distortions. <br/>
2311 </td>
2312
2313 </tr>
2314
2315 <tr valign="top">
2316 <td valign="top"><kbd>BarrelInverse</kbd></td>
2317 <td valign="top">
2318 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2319 arguments, and argument handling. However it uses the inverse
2320 of the radial polynomial,
2321 so that it forms the function <br/>
2322 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002323 <em>C</em>*r + <em>D</em> )<br/>
2324 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2325 distortion, just a different barrel-like radial distortion method.
2326
cristy3ed852e2009-09-05 21:47:34 +00002327 </td>
2328 </tr>
2329
2330 <tr valign="top">
2331 <td valign="top"><kbd>Shepards</kbd></td>
2332 <td valign="top">
2333 Distort the given list control points (any number) using an Inverse
2334 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002335 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2336 Method</a>). The control points in effect do 'localized' displacement
2337 of the image around the given control point (preserving the look and
2338 the rotation of the area near the control points. For best results
2339 extra control points should be added to 'lock' the positions of the
2340 corners, edges and other unchanging parts of the image, to prevent
2341 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002342
cristyd0bd44a2010-09-24 12:38:11 +00002343 The distortion has been likened to 'taffy pulling' using nails, or
2344 pins' stuck in a block of 'jelly' which is then moved to the new
2345 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002346
cristybaacd172011-04-30 23:11:03 +00002347 Internally it is equivalent to generating a displacement map (see <a
cristyd0bd44a2010-09-24 12:38:11 +00002348 href="#displace" >-displace</a>) for source image color look-up using
2349 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2350
2351 </td>
cristy3ed852e2009-09-05 21:47:34 +00002352 </tr>
2353
2354</table>
2355
cristyd0bd44a2010-09-24 12:38:11 +00002356<p>To print a complete list of distortion methods, use <a href="#list">-list
2357distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002358
2359<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2360'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2361defining how these points in the given image should be distorted in the
2362destination image. Each set of four floating point values represent a source
2363image coordinate, followed immediately by the destination image coordinate.
2364This produces a list of values such as...</p>
2365<div style="text-align: center"><em>
2366 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2367 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2368 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2369 ... &nbsp;
2370 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2371</em></div>
2372<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2373destination image. </p>
2374
2375<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2376needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2377perspective distortion of the built-in "rose:" image. Note how spaces were
2378used to group the 4 sets of coordinate pairs, to make it easier to read and
2379understand.</p>
2380
2381<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002382convert rose: -virtual-pixel black \<br/>
2383 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2384 rose_3d_rotated.gif</span></p>
2385<p>If more that the required number of coordinate pairs are given for
2386a distortion, the distortion method is 'least squares' fitted to produce the
2387best result for all the coordinate pairs given. If less than the ideal number
2388of points are given, the distort will generally fall back to a simpler form of
2389distortion that can handles the smaller number of coordinates (usally a linear
2390'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002391
cristyd0bda5e2010-09-21 16:22:45 +00002392<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002393find matching coordinate pairs in overlapping images, so as to improve the
2394'fit' of the distortion. Of course a bad coordinate pair can also make the
2395'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002396
2397<p>Colors are acquired from the source image according to the <a
2398href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002399magnified. However if the viewed image is minified (image becomes smaller),
2400a special area resampling function (added ImageMagick v6.3.5-9), is used to
2401produce a higher quality image. For example you can use
2402a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2403the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002404
cristyd0bd44a2010-09-24 12:38:11 +00002405<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2406convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2407 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2408 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002409<p>Note that a infinitely tiled perspective images involving the horizon can
2410be very slow to generate due to the use of the high quality 'area resampling'
2411function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2412using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2413(recommended if you plan to use super-sampling instead). </p>
2414
2415<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2416'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2417will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2418pixels. If you do not what these pixels to be visible, set the color to match
2419the rest of the ground. </p>
2420
2421<p>The output image size will by default be the same as the input image. This
2422means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002423the 'distorted space', those parts is clipped and lost. However if you use
2424the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2425will attempt (if possible) to show the whole of the distorted image, while
2426retaining a correct 'virtual canvas' offset, for image layering. This offset
2427may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2428is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002429
2430<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2431option:distort:viewport {geometry_string}</kbd>" setting which will specify
2432the size and the offset of the generated 'viewport' image of the distorted
2433image space.</p>
2434
2435<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2436{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2437that factor without changing the viewed contents of the distorted image. This
2438can be used either for 'super-sampling' the image for a higher quality result,
2439or for panning and zooming around the image (with appropriate viewport
2440changes, or post-distort cropping and resizing). </p>
2441
2442<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2443href="#distort" >-distort</a> to attempt to output the internal coefficients,
2444and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2445and debugging purposes. This many not be available for all distorts. </p>
2446
2447<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2448produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2449and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002450above settings. It is algorithmically slower however, though that may not be
2451the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002452
2453
2454<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002455 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002456</div>
2457
2458<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>
2459
cristyd0bda5e2010-09-21 16:22:45 +00002460<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 +00002461
2462<p>Dithering is turned on by default, to turn it off use the plus form of the
2463setting, <a href="#dither">+dither</a>. This will also also render PostScript
2464without text or graphic aliasing. Disabling dithering often (but not always)
2465leads to faster process, a smaller number of colors, but more cartoon like
2466image coloring. Generally resulting in 'color banding' effects in areas with
2467color gradients. </p>
2468
2469<p>The color reduction operators <a href="#colors">-colors</a>, <a
2470href="#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>
2471
2472<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>
2473
2474
2475<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002476 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002477</div>
2478
2479<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>
2480
2481<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>
2482
2483<p>The shape primitives:</p>
2484
2485<pre class="text">
2486 point x,y
2487 line x0,y0 x1,y1
2488 rectangle x0,y0 x1,y1
2489 roundRectangle x0,y0 x1,y1 wc,hc
2490 arc x0,y0 x1,y1 a0,a1
2491 ellipse x0,y0 rx,ry a0,a1
2492 circle x0,y0 x1,y1
2493 polyline x0,y0 ... xn,yn
2494 polygon x0,y0 ... xn,yn
2495 bezier x0,y0 ... xn,yn
2496 path path specification
2497 image operator x0,y0 w,h filename
2498</pre>
2499
2500<p>The text primitive:</p>
2501
2502<pre class="text">
2503 text x0,y0 string
2504</pre>
2505<p>The text gravity primitive:</p>
2506
2507<pre class="text">
2508 gravity NorthWest, North, NorthEast, West, Center,
2509 East, SouthWest, South, or SouthEast
2510</pre>
2511
2512<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>
2513
2514<p>The transformation primitives:</p>
2515
2516<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002517 rotate degrees
2518 translate dx,dy
2519 scale sx,sy
2520 skewX degrees
2521 skewY degrees
cristy3ed852e2009-09-05 21:47:34 +00002522</pre>
2523
2524<p>The pixel operation primitives:</p>
2525
2526<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002527 color x0,y0 method
2528 matte x0,y0 method
cristy3ed852e2009-09-05 21:47:34 +00002529</pre>
2530
2531<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>
2532
2533<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>
2534
2535<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2536
2537<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2538
2539<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>
2540
2541<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2542
2543<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>
2544
2545<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>
2546
2547<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>.
2548</p>
2549
2550<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2551
2552<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2553
2554<p class="crtsnip">
2555 -draw 'circle 100,100 150,150'
2556</p>
2557
2558<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
2559draw 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>
2560
2561<p class="crtsnip">
2562 -draw 'bezier 20,50 45,100 45,0 70,50'
2563</p>
2564<p class="crtsnip">
2565 -draw 'bezier 70,50 95,100 95,0 120,50'
2566</p>
2567
2568
2569<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>
2570
2571<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>
2572
2573<p class="crtsnip">
2574 -draw 'image SrcOver 100,100 225,225 image.jpg'
2575</p>
2576
cristybc9539a2010-08-16 18:06:20 +00002577<p>You can use 0,0 for the image size, which means to use the actual
2578dimensions found in the image header. Otherwise, it is scaled to the given
2579dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
cristy29c5c992011-06-25 13:58:49 +00002580a detailed discussion of alpha composition methods that are available.
2581The "special augmented compose operators" such as "dissolve" that require
2582arguments cannot be used at present with the <kbd>-draw image</kbd> option.
2583 </p>
cristy3ed852e2009-09-05 21:47:34 +00002584<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>
2585
2586<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2587
2588<p class="crtsnip">
cristy4bf6e232011-05-21 01:43:33 +00002589 -draw "text 100,100 'Works like magick!' "
cristy3ed852e2009-09-05 21:47:34 +00002590</p>
2591
2592<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2593
2594<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>
2595
2596<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2597
2598<p>The <kbd>scale</kbd> primitive scales them.</p>
2599
2600<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>
2601
2602<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
2603matrix.</p>
2604
2605<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>
2606
2607<pre class="text">
2608 point
2609 replace
2610 floodfill
2611 filltoborder
2612 reset
2613</pre>
2614
2615<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>
2616
2617<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>
2618
2619<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>
2620
2621<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2622
2623<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2624
cristy2dcd6822011-06-13 16:21:20 +00002625
cristy8b9dd952011-03-21 22:56:18 +00002626<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00002627 <h4><a id="duplicate"></a>-duplicate <em class="arg">count,indexes</em></h4>
cristy8b9dd952011-03-21 22:56:18 +00002628</div>
2629
cristy323f35b2011-03-24 23:05:13 +00002630<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 +00002631
cristy323f35b2011-03-24 23:05:13 +00002632<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 +00002633
2634<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002635 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002636</div>
2637
2638<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>
2639
2640<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002641 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002642</div>
2643
2644<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>
2645
2646<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002647 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002648</div>
2649
2650<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>
2651
2652<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2653
2654<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2655
cristyd0bda5e2010-09-21 16:22:45 +00002656
2657
cristy3ed852e2009-09-05 21:47:34 +00002658<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002659 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002660</div>
2661
2662<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>
2663
2664<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>
2665
2666<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002667 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002668</div>
2669
2670<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>
2671
2672<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2673
2674<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2675
2676
2677<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002678 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002679</div>
2680
2681<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>
2682
2683
2684<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002685 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002686</div>
2687
2688<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>
2689
2690<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>
2691
2692<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2693
2694<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>
2695
2696<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002697 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002698</div>
2699
2700<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>
2701
2702<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>
2703
2704<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>
2705
2706<table class="doc">
2707 <col width="25%" />
2708 <col width="75%" />
2709 <thead>
2710 <tr>
2711 <th><em class="arg">operator</em></th>
2712 <th>Summary (see further below for details)</th>
2713 </tr>
2714 </thead>
2715 <tbody>
2716
cristy3c98a4f2010-08-13 20:09:41 +00002717 <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 +00002718 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2719 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2720 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2721 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2722 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002723 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2724 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002725 <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>
2726 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2727 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002728 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002729 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002730 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2731 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2732 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2733 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2734 <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>
2735 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2736 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2737 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2738 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2739
2740 <tr><td>&nbsp;</td></tr>
2741
2742 <tr><td>Gaussian-noise</td></tr>
2743 <tr><td>Impulse-noise</td></tr>
2744 <tr><td>Laplacian-noise</td></tr>
2745 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2746 <tr><td>PoissonNoise</td></tr>
2747 <tr><td>Uniform-noise</td></tr>
2748
2749 <tr><td>&nbsp;</td></tr>
2750
2751 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2752 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2753 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2754 </tbody>
2755 </table>
2756
2757<p>The specified functions are applied only to each previously set <a
2758href="#channel" >-channel</a> in the image. If necessary, the results of the
2759calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2760class="QR">QuantumRange</em>]. The transparency channel of the image is
2761represented as a 'alpha' values (0 = fully transparent), so, for example, a
2762<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2763semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2764as a percentage of the <em class="QR">QuantumRange</em>.</p>
2765
2766<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2767<a href="#list">-list evaluate</a>.</p>
2768
2769<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2770<kbd>Multiply</kbd> methods can also be achieved using either the <a
2771href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2772appropriate argument, to linearly modify the overall range of color values.
2773Please note, however, that <a href="#level" >-level</a> treats transparency as
2774'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2775'alpha' values.</p>
2776
2777<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>
2778
cristyce66ab12010-10-21 23:36:32 +00002779<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>
2780
2781 <div style="text-align:center;">
2782 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2783 </div>
2784
2785<p> If the input image is squared, for example, using <a
2786href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2787
cristy3ed852e2009-09-05 21:47:34 +00002788<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>
2789
2790 <div style="text-align:center;">
2791 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2792 </div>
2793
2794<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2795normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2796href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2797to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2798with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2799with <kbd>Pow</kbd>.</p>
2800
2801<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2802converts the image values into a value according to a (co)sine wave function.
2803The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2804is biased 50% and normalized by 50% so as to fit in the respective color value
2805range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2806function (its frequency), and thus determines the number of 'waves' that will
2807be generated over the input color range. For example, if the <em
2808class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2809class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2810then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002811class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002812
2813 <div style="text-align:center;">
2814 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2815 </div>
2816
cristydcca3fa2010-12-29 21:50:07 +00002817<p>See also the <a href="#function" >-function</a> operator, which is a
2818multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002819
cristy63fed272010-03-07 19:08:45 +00002820<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002821 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002822</div>
2823
2824<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 +00002825
2826<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002827 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002828</div>
2829
2830<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>
2831
cristy3e2860c2010-01-24 01:36:30 +00002832<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 +00002833<p>This command reduces or expands a JPEG image to fit on an 800x600
2834display. If the aspect ratio of the input image isn't exactly 4:3, then the
2835image is centered on an 800x600 black canvas: </p>
2836
2837<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert input.jpg -resize 800x600 -background black -compose Copy \ <br /> -gravity center -extent 800x600 -quality 92 output.jpg</span></p>
2838
cristy3ed852e2009-09-05 21:47:34 +00002839
2840<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>
2841
2842<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002843 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002844</div>
2845
2846<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>
2847
2848<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2849
cristy4949d522010-03-12 18:41:34 +00002850<p class='crt'><span class="crtprompt"> $magick&gt; </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"> $magick&gt; </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 +00002851
cristy4949d522010-03-12 18:41:34 +00002852<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -size 16000x16000 -depth 8 -extract 640x480 \ <br/> image.rgb image.png</span></p>
cristyd0bd44a2010-09-24 12:38:11 +00002853<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002854equivalent to:</p>
2855
2856<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -size 16000x16000 -depth 8 -resize 640x480 image.rgb image.png</span></p>
2857<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>
2858
2859<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002860 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002861</div>
2862
2863<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>
2864
2865<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).
2866</p>
2867
2868<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>.
2869</p>
2870
2871<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002872 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002873</div>
2874
2875<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>
2876
2877<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002878 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002879</div>
2880
2881<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>
2882
cristydcca3fa2010-12-29 21:50:07 +00002883<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 +00002884
cristydcca3fa2010-12-29 21:50:07 +00002885<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 +00002886
2887<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>
2888
2889<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2890<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>
2891
2892<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2893<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>
2894
cristyd0bd44a2010-09-24 12:38:11 +00002895<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 +00002896
2897<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 for non-HDRI compilations of ImageMagick, the phase image is scaled to span the full dynamic range. 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>
2898
2899<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2900 -evaluate log 1000 fft_image_spectrum.png</span></p>
2901<p>where the <a href="#contrast-stretch">-contrast-stretch</a> 0 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>
2902
cristydcca3fa2010-12-29 21:50:07 +00002903<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 +00002904
2905<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>
2906
2907<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 or PFM 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.</p>
2908
cristydcca3fa2010-12-29 21:50:07 +00002909<p>The real and imaginary component images resulting from <a href="#fft">+fft</a> is 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 +00002910
2911<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +00002912<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 +00002913</p>
2914
2915
2916<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002917 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002918</div>
2919
2920<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>
2921
2922<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>
2923
2924<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2925
2926<p>For example,</p>
2927
2928<p class="crtsnip">
2929 -fill blue
2930</p>
2931<p class="crtsnip">
2932 -fill "#ddddff"
2933</p>
2934<p class="crtsnip">
2935 -fill "rgb(255,255,255)"
2936</p>
2937
2938<p>See <a href="#draw">-draw</a> for further details.</p>
2939
2940<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2941
2942<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002943 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002944</div>
2945
cristyd0bda5e2010-09-21 16:22:45 +00002946<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
2947distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002948
cristyd0bda5e2010-09-21 16:22:45 +00002949<p>Use this option to affect the resizing operation of an image during
2950operations such as <a href="#resize">-resize</a> and <a href="#distort"
2951>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002952
2953<pre class="text">
2954 Point Hermite Cubic
2955 Box Gaussian Catrom
2956 Triangle Quadratic Mitchell
2957</pre>
2958
cristyd0bda5e2010-09-21 16:22:45 +00002959<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002960as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2961generally useless on their own as they are infinite filters that are being
2962clipped to the filters support size. Their direct use is not recommended
2963except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002964
cristydcca3fa2010-12-29 21:50:07 +00002965<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002966function that the <a href="#filter" >-filter</a> setting defines. That is
2967using these functions will define a 'Windowed' filter, appropriate to the
2968operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002969
2970<pre class="text">
2971 Lanczos Hamming Parzen
2972 Blackman Kaiser Welsh
2973 Hanning Bartlett Bohman
2974</pre>
2975
2976<p>Also one special self-windowing filter is also provided
2977<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2978on the current 'support' or 'lobes' expert settings (see below).</p>
2979
cristyd0bda5e2010-09-21 16:22:45 +00002980<p>If you do not select a filter with this option, the filter defaults to
2981<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2982if the image is enlarged. Otherwise the filter default to
2983<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002984
cristyd0bda5e2010-09-21 16:22:45 +00002985<p>To print a complete list of resize filters, use the <a href="#list">-list
2986filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002987
2988<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002989use of these expert settings (see also <a href="#define" >-define</a> and <a
2990href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002991
2992<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002993<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002994<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002995 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2996 Gaussian-like filters simple filters, or you may not get the expected
2997 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002998
cristyd0bda5e2010-09-21 16:22:45 +00002999<dt>-define filter:support=<em>radius</em></dt>
3000<dd>Set the filter support radius. Defines how large the filter should be and
3001 thus directly defines how slow the filtered resampling process is. All
3002 filters have a default 'prefered' support size. Some filters like
3003 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
3004 this value. With simple filters this value either does nothing (but slow
3005 the resampling), or will clip the filter function in a detrimental way.
3006 </dd>
cristy3ed852e2009-09-05 21:47:34 +00003007
cristyd0bda5e2010-09-21 16:22:45 +00003008<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003009<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00003010 alternative way of specifying the 'support' range of the filter, that is
3011 designed to be more suited to windowed filters, especially when used for
3012 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003013
cristyd0bda5e2010-09-21 16:22:45 +00003014<dt>-define filter:b=<em>b-spline_factor</em></dt>
3015<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003016<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
3017 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
3018 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
3019 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00003020 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00003021 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003022
cristyd0bda5e2010-09-21 16:22:45 +00003023<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003024<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00003025 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00003026 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00003027 'Bessel' functions. If defined, no windowing function is used, unless the
3028 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003029
cristyd0bda5e2010-09-21 16:22:45 +00003030<dt>-define filter:window=<em>filter_function</em></dt>
3031<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
3032 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
3033 support range) with the given filter. This allows you to specify a filter
3034 function that is not normally used as a windowing function, such as
3035 <kbd>Box</kbd>, (which effectively turns off the windowing function),
3036 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
3037 </dd>
3038
3039<dt>-define filter:verbose=<em>1</em></dt>
3040<dd>This causes IM to print information on the final internal filter
3041 selection to standard output. This includes a commented header on the
3042 filter settings being used, and data allowing the filter weights to be
3043 easily graphed. </dd>
3044
3045<dd>Note however that some filters are internally defined in terms of other
3046 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
3047 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
3048 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
3049 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00003050
3051</dl>
3052
cristyd0bda5e2010-09-21 16:22:45 +00003053<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00003054
3055<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
3056 -set filter:window=bessel -set filter:lobes=8 \ <br/>
3057 -resize 150% image.jpg</span></p>
3058<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3059
3060<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
3061 -resize 150% image.jpg</span></p>
3062<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00003063filters, and 'verbose' for viewing the internal filter selection), are
3064provided for image processing experts who have studied and understood how
3065resize filters work. Without this knowledge, and an understanding of the
3066definition of the actual filters involved, using expert settings are more
3067likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00003068
3069
3070<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003071 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00003072</div>
3073
3074<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>
3075
3076
3077<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003078 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00003079</div>
3080
3081<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>
3082
cristy2dcd6822011-06-13 16:21:20 +00003083<p>reflect the scanlines in the vertical direction. The image will be mirrored
3084upside-down. </p>
3085
cristy3ed852e2009-09-05 21:47:34 +00003086
3087<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003088 <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 +00003089</div>
3090
cristy2dcd6822011-06-13 16:21:20 +00003091<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>
3092
3093<p>Flood fill starts from the given 'seed point' which is not gravity effected.
3094Any color that matches within <a href="#fuzz" >-fuzz</a> color distance of the
3095given <em class="arg">color</em> argument, connected to that 'seed point'
3096will be replaced with the current <a href="#fill" >-fill</a> color. </p>
3097
3098<p>Note that if the pixel at the 'seed point' does not itself match the given
3099<em class="arg">color</em> (according to <a href="#fuzz" >-fuzz</a>), then no
3100action will be taken. </p>
3101
3102<p>This operator works more like the <a href="#opaque" >-opaque</A> option, than
3103a 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>
3104
cristy3ed852e2009-09-05 21:47:34 +00003105
3106<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003107 <h4><a id="flop"></a>-flop</h4>
cristy3ed852e2009-09-05 21:47:34 +00003108</div>
3109
3110<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>
3111
cristy2dcd6822011-06-13 16:21:20 +00003112<p>Reflect the scanlines in the horizontal direction, just like the image in
3113a vertical mirror. </p>
cristy3ed852e2009-09-05 21:47:34 +00003114
3115
3116<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003117 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003118</div>
3119
3120<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>
3121
3122<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>
3123
3124<p>In addition to the fonts specified by the above pre-defined list, you can
3125also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
3126is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
3127<kbd>x:fixed</kbd> is X11 font.</p>
3128
3129<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>
3130
3131
3132<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003133 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003134</div>
3135
3136<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>
3137
3138<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3139
3140<p>The default foreground color is black.</p>
3141
3142<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003143 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003144</div>
3145
3146<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>
3147
cristy47774982011-02-15 15:17:19 +00003148<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 +00003149
3150<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>
3151
3152<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003153 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003154</div>
3155
3156<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>
3157
3158<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>
3159
3160<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003161 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003162</div>
3163
3164<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>
3165
cristybc9539a2010-08-16 18:06:20 +00003166<p>The color of the border is specified with the <a href="#mattecolor"
3167>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003168
cristybc9539a2010-08-16 18:06:20 +00003169<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
3170class="arg">geometry</em> argument indicates the amount of extra width and
3171height that is added to the dimensions of the image. If no offsets are given
3172in the <em class="arg">geometry</em> argument, then the border added is
3173a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3174the width and height of the border is partitioned to form an outer bevel of
3175thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3176<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3177</p>
3178
3179<p>The <a href="#frame">-frame</a> option is affected by the current <a
3180href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003181'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003182size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3183draws the frame of four distinct colors close to the current <a
3184href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3185center of this image. This means that with the default compose method of
3186'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3187href="#bordercolor">-bordercolor</a> setting.</p>
3188
3189<p>The image composition is not
3190affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003191
3192
3193<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003194 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003195</div>
3196
3197<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>
3198
3199<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003200 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003201</div>
3202
3203<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>
3204
3205<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>
3206
3207<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>
3208
3209<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>
3210
3211<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003212 Polynomial
3213 Sinusoid
3214 Arcsin
3215 Arctan
cristy3ed852e2009-09-05 21:47:34 +00003216</pre>
3217
3218<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3219
3220<dl class="doc">
3221<dt><kbd>Polynomial</kbd></dt>
3222<dd>
3223<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>
3224
3225<div style="text-align: center">
3226 -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>
3227</div>
3228
3229<p>will invoke a polynomial function given by</p>
3230
3231<div style="text-align: center">
3232 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3233 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3234 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3235</div>
3236
3237<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3238
3239<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>
3240
3241<table class="doc">
3242 <col width="35%" />
3243 <col width="35%" />
3244 <col width="30%" />
3245 <tr>
3246 <td>-evaluate Set <em class="arg">value</em> </td>
3247 <td>-function Polynomial <em class="arg">value</em></td>
3248 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3249 </tr>
3250 <tr>
3251 <td>-evaluate Add <em class="arg">value</em> </td>
3252 <td>-function Polynomial 1,<em class="arg">value</em></td>
3253 </tr>
3254 <tr>
3255 <td>-evaluate Subtract <em class="arg">value</em> </td>
3256 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3257 </tr>
3258 <tr>
3259 <td>-evaluate Multiply <em class="arg">value</em> </td>
3260 <td>-function Polynomial <em class="arg">value</em>,0</td>
3261 </tr>
3262 <tr>
3263 <td>+level black% x white%</td>
3264 <td>-function Polynomial A,B</td>
3265 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3266 </tr>
3267</table>
3268
3269<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>
3270</dd>
3271
3272<dt><kbd>Sinusoid</kbd></dt>
3273<dd>
3274<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>
3275
3276<div style="text-align: center">
3277 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3278</div>
3279
3280<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>
3281
3282<div style="text-align: center">
3283<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>
3284</div>
3285
3286<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>
3287
3288<p class="crtsnip">
3289 -function Sinusoid 3,-90,.2,.7
3290</p>
3291
3292<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>
3293
3294<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>
3295
3296<table class="doc">
3297 <tr>
3298 <td>-evaluate Sin <em class="arg">freq</em> </td>
3299 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3300 </tr>
3301 <tr>
3302 <td>-evaluate Cos <em class="arg">freq</em> </td>
3303 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3304 </tr>
3305</table>
3306</dd>
3307
3308<dt><kbd>ArcSin</kbd></dt>
3309<dd>
3310<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3311and can be used to generate cylindrical distortion and displacement maps.
3312The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003313of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003314
cristydcca3fa2010-12-29 21:50:07 +00003315<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003316 -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 +00003317</p>
cristy3ed852e2009-09-05 21:47:34 +00003318
3319<p>with all values given in terms of noramlize color values (0.0 for black,
33201.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3321for bout input (<em class="arg">width</em>), and output (<em
3322class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3323
cristydcca3fa2010-12-29 21:50:07 +00003324<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003325<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 +00003326</p>
cristy3ed852e2009-09-05 21:47:34 +00003327
3328</dd>
3329
3330<dt><kbd>ArcTan</kbd></dt>
3331<dd>
3332<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3333limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003334All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003335
cristydcca3fa2010-12-29 21:50:07 +00003336<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003337 -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 +00003338</p>
cristy3ed852e2009-09-05 21:47:34 +00003339
3340<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3341</p>
3342
cristydcca3fa2010-12-29 21:50:07 +00003343<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003344<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 +00003345</p>
cristy3ed852e2009-09-05 21:47:34 +00003346
3347</dd>
3348
3349</dl>
3350
3351
3352<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003353 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003354</div>
3355
3356<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>
3357
3358<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>
3359
3360<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>
3361
3362
3363<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003364 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003365</div>
3366
3367<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>
3368
3369<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>
3370
3371<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3372
3373
3374<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003375 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003376</div>
3377
3378<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>
3379
3380<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>
3381
3382<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>
3383
3384<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>
3385
3386<p>Use <a href="#gamma">+gamma <em class="arg">value</em></a> to set the image gamma level without actually adjusting the image pixels. This option is useful if the image is of a known gamma but not set as an image attribute (e.g. PNG images).</p>
3387
3388<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3389
3390<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003391 <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></h4>
cristy3ed852e2009-09-05 21:47:34 +00003392</div>
3393
3394<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>
3395
cristyb15553d2010-07-03 22:53:14 +00003396<p>Convolve the image with a Gaussian or normal distribution using the given
3397<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003398
3399<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3400</div>
3401
cristyb15553d2010-07-03 22:53:14 +00003402<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003403determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003404
3405<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003406array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003407integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003408radius that will provide meaningful results for the Gaussian distribution.
3409</p>
3410
3411<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3412operation is. However too small a <em class="arg" >Radius</em>, and sever
3413aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3414should be at least twice the <em class="arg" >Sigma</em> value, though three
3415times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003416
3417<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003418full 2-dimensional convolution is used to generate the weighted average of the
3419neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003420
3421<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3422pixels which are outside the image proper are blurred into the final result.
3423</p>
3424
3425
3426<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003427 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003428</div>
3429
3430<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>
3431
3432<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>
3433
3434<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003435 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003436</div>
3437
3438<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>
3439
3440<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3441<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3442<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3443list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3444installation.</p>
3445
3446<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> affected by the <a href="#gravity">-gravity</a> option.</p>
3447
3448<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>
3449
3450<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>
3451
cristy4949d522010-03-12 18:41:34 +00003452<p class='crt'><span class="crtprompt"> $magick&gt; </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 +00003453<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>
3454
3455<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>
3456
3457
3458<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003459 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003460</div>
3461
3462<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>
3463
3464
3465<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003466 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003467</div>
3468
3469<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>
3470
3471<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3472dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3473can apply any color transformation to the Hald image and then use this option
3474to apply the transform to the image. </p>
3475
3476<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3477<p>This option provides a convenient method for you to use Gimp or Photoshop
3478to make color corrections to the Hald CLUT image and subsequently apply them
3479to multiple images using an ImageMagick script. </p>
3480
3481<p>Note that the representation is only of the normal RGB color space and that
3482the whole color value triplet is used for the interpolated lookup of the
3483represented Hald color cube image. Because of this the operation is not <a
3484href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3485images transparency or alpha/matte channel.</p>
3486
3487<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3488of the individual color channels, usally involving a simplier gray-scale
3489image. E.g: gray-scale to color replacement, or modification by a histogram
3490mapping. </p>
3491
3492
3493<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003494 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003495</div>
3496
3497<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>
3498
3499<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003500 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003501</div>
3502
3503<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>
3504
3505<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003506 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003507</div>
3508
3509<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>
3510
3511<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>
3512
3513<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>
3514
3515<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003516 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003517</div>
3518
3519<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>
3520
3521<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003522 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003523</div>
3524
3525<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>
3526
3527<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>
3528
cristy47774982011-02-15 15:17:19 +00003529<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 +00003530
cristyd0bda5e2010-09-21 16:22:45 +00003531<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003532amounts of image properties are displayed including image statistics, profiles,
3533image histogram, and others.</p>
3534
3535<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003536 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003537</div>
3538
3539<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>
3540
cristydcca3fa2010-12-29 21:50:07 +00003541<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 +00003542
3543<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>
3544
3545<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3546<p>or</p>
3547
3548<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image-0.png fft_image-1.png -ift fft_image_ift.png</span></p>
3549
cristydcca3fa2010-12-29 21:50:07 +00003550<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 +00003551
cristydcca3fa2010-12-29 21:50:07 +00003552<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 +00003553
cristydcca3fa2010-12-29 21:50:07 +00003554<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 +00003555
3556<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003557 <h4><a id="immutable"></a>-immutable</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%'>make image immutable.</td><td style='text-align:right;'></td></tr></table>
3561
3562<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003563 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003564</div>
3565
3566<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>
3567
3568<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003569 <h4><a id="insert"></a>-insert <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003570</div>
3571
3572<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>
3573
3574<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>
3575
3576<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>
3577
3578<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003579 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003580</div>
3581
3582<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>
3583
3584<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>
3585
3586<p>The default intent is undefined.</p>
3587
3588<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3589
3590<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003591 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003592</div>
3593
3594<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>
3595
3596<p>Choose from:</p>
3597
3598<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003599 none
3600 line
3601 plane
3602 partition
3603 JPEG
3604 GIF
3605 PNG
cristy3ed852e2009-09-05 21:47:34 +00003606</pre>
3607
3608<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>
3609
3610<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3611
3612<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3613
3614<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3615
3616<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3617image.G, and image.B).</p>
3618
3619<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>
3620image.</p>
3621
3622<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3623
3624<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003625 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003626</div>
3627
3628<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>
3629
cristyd0bda5e2010-09-21 16:22:45 +00003630<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003631value, you typically fall in between the pixel colors defined by the source
3632image. This setting determines how the color is determined from the colors of
3633the pixels surrounding that point. That is how to determine the color of a
3634point that falls between two, or even four different colored pixels. </p>
3635
3636<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003637 integer The color of the top-left pixel (floor function)
3638 nearest-neighbor The nearest pixel to the lookup point (rounded function)
3639 average The average color of the surrounding four pixels
3640 bilinear A double linear interpolation of pixels (the default)
3641 mesh Divide area into two flat triangular interpolations
3642 bicubic Fitted bicubic-spines of surrounding 16 pixels
3643 spline Direct spline curves (colors are blurred)
3644 filter Use resize <a href="#filter">-filter</a> settings
cristy3ed852e2009-09-05 21:47:34 +00003645</pre>
3646
3647<p>This most important for distortion operators such as <a href="#distort"
3648>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3649>-transform</a> and <a href="#fx" >-fx</a>. </p>
3650
3651<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3652
3653<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3654lookup for positions outside the boundaries of the image. </p>
3655
3656
3657<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003658 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003659</div>
3660
3661<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>
3662
3663<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003664 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003665</div>
3666
3667<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>
3668
3669<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003670 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003671</div>
3672
3673<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>
3674
3675<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003676 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003677</div>
3678
3679<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>
3680
cristy71a3f602010-09-15 12:38:16 +00003681<p>Use this option to assign a specific label to the image, as it is read in
3682or created. You can use the <a href="#set" >-set</a> operation to re-assign
3683a the labels of images already read in. Image formats such as TIFF, PNG,
3684MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003685
cristy71a3f602010-09-15 12:38:16 +00003686<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3687assigned to an image is used as a header string to print above the postscript
3688image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003689
cristybc9539a2010-08-16 18:06:20 +00003690<p>You can include the image filename, type, width, height, or other image
3691attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3692Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003693
3694<p>For example,</p>
3695
3696<p class="crtsnip">
3697 -label "%m:%f %wx%h" bird.miff
3698</p>
3699
cristy71a3f602010-09-15 12:38:16 +00003700<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3701"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3702is read in. If a <a href="#label">+label</a> option was used instead, any
3703existing label present in the image would be used. You can remove all labels
3704from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003705
cristy71a3f602010-09-15 12:38:16 +00003706<p>A label is not drawn on the image, but is embedded in the image datastream
3707via <em>Label</em> tag or similar mechanism. If you want the label to be
3708visible on the image itself, use the <a href="#draw">-draw</a> option, or
3709during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003710
cristy71a3f602010-09-15 12:38:16 +00003711<p>If the first character of <em class="arg">string</em> is <em
3712class="arg">@</em>, the image label is read from a file titled by the
3713remaining characters in the string. Labels in a file are literal, no embedded
3714formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003715
3716
3717<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003718 <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 +00003719</div>
3720
3721<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>
3722
3723<p>Adaptively threshold each pixel based on the value of pixels in a
3724surrounding window. If the current pixel is lighter than this average plus
3725the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3726black. Small variations in pixel values such as found in scanned documents
3727can be ignored if offset is positive. A negative offset will make it more
3728sensitive to those small variations. </p>
3729
3730<p>This is commonly used to threshold images with an uneven background. It is
3731based on the assumption that average color of the small window is the
3732the local background color, from which to separate the forground color. </p>
3733
3734
3735<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003736 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003737</div>
3738
3739<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>
3740
3741<p>Perform various image operation methods to a ordered sequence of images
3742which may represent either a set of overlaid 'image layers', a GIF disposal
3743animation, or a fully-'coalesced' animation sequence. </p>
3744
3745<table class="doc">
3746 <tbody>
3747 <tr valign="top">
3748 <th align="left" style="width: 8%">Method</th>
3749 <th align="left">Description</th>
3750 </tr>
3751
3752 <tr valign="top">
3753 <td valign="top">compare-any</td>
3754 <td valign="top">Crop the second and later frames to the smallest rectangle
3755 that contains all the differences between the two images. No GIF <a
3756 href="#dispose" >-dispose</a> methods are taken into account. </td>
3757 </tr>
3758
3759 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3760 >-deconstruct</a> operator, and does not preserve animations normal
3761 working, especially when animation used layer disposal methods such as
3762 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3763 </tr>
3764
3765 <tr valign="top">
3766 <td valign="top">compare-clear</td>
3767 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3768 opaque pixels which become transparent in the second frame. That is the
3769 smallest image needed to mask or erase pixels for the next frame. </td>
3770 </tr>
3771
3772 <tr valign="top">
3773 <td valign="top">compare-overlay</td>
3774 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3775 extra color to the next image, as a result of overlaying color pixels.
3776 That is the smallest single overlaid image to add or change colors. </td>
3777 </tr>
3778
3779 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3780 composition method '<kbd>change-mask</kbd>', to reduce the image to
3781 just the pixels that need to be overlaid. </td>
3782 </tr>
3783
3784 <tr valign="top">
3785 <td valign="top">coalesce</td>
3786 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3787 >-coalesce</a> operator. Apply the layer disposal methods set in the
3788 current image sequence to form a fully defined animation sequence, as
3789 it should be displayed. Effectively converting a GIF animation into a
3790 'film strip'-like animation. </td>
3791 </tr>
3792
3793 <tr valign="top">
3794 <td valign="top">composite</td>
3795 <td valign="top">Alpha Composition of two image lists, separated by a
3796 "<kbd>null:</kbd>" image, with the destination image list first, and
3797 the source images last. An image from each list are composited
3798 together until one list is finished. The separator image and source
3799 image lists are removed. </td>
3800 </tr>
3801
3802
cristybac7a162010-06-15 19:57:29 +00003803 <tr><td></td>
3804 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3805 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3806 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003807 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003808 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003809
cristybac7a162010-06-15 19:57:29 +00003810 <tr><td></td>
3811 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003812 applied to all the images in the other image list, regardless of which
3813 list it is. In this case it is the image meta-data of the list which
3814 preserved. </td>
3815 </tr>
3816
3817
3818 <tr valign="top">
3819 <td valign="top">dispose</td>
3820 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3821 the animation after the layer disposal method has been applied, before
3822 the next sub-frame image is overlaid. That is the 'dispose' image that
3823 results from the application of the GIF <a href="#dispose"
3824 >-dispose</a> method. This allows you to check what
3825 is going wrong with a particular animation you may be developing.
3826 </td>
3827 </tr>
3828
3829 <tr valign="top">
3830 <td valign="top">flatten</td>
3831 <td valign="top">Create a canvas the size of the first images virtual
3832 canvas using the current <a href="#background" >-background</a> color,
3833 and <a href="#compose" >-compose</a> each image in turn onto that
3834 canvas. Images falling outside that canvas is clipped. Final
3835 image will have a zero virtual canvas offset. </td>
3836 </tr>
3837
cristybac7a162010-06-15 19:57:29 +00003838 <tr><td></td>
3839 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003840 overlaying all the prepared image layers into a final image. </td>
3841 </tr>
3842
cristybac7a162010-06-15 19:57:29 +00003843 <tr><td></td>
3844 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003845 canvas with real pixels, or to underlay a opaque color to remove
3846 transparency from an image.</td>
3847 </tr>
3848
3849
3850 <tr valign="top">
3851 <td valign="top">merge</td>
3852 <td valign="top">As 'flatten' method but merging all the given image
cristy10549a12011-05-15 19:04:46 +00003853 layers to create a new layer image just large enough to hold all the
3854 image without clipping or extra space. The new images virtual offset
3855 will preserve the position of the new layer, even if this offset is
3856 negative. The virtual canvas size of the first image is preserved.
cristy3ed852e2009-09-05 21:47:34 +00003857 </td>
cristy10549a12011-05-15 19:04:46 +00003858 </tr>
cristy3ed852e2009-09-05 21:47:34 +00003859
cristy10549a12011-05-15 19:04:46 +00003860 <tr><td></td><td>Caution is advised when handling image layers with
3861 negative offsets as few image file formats handle them correctly.
3862 Following this operation methd with <a href="#repage" >+repage</a>
3863 will remove the layer offset, and create a image in which all the
3864 overlaid image positions relative to each other is preserved, though
3865 not nessaraily exactly where you specified them.
3866 </td>
3867 </tr>
3868
3869 <tr><td></td><td>See also 'trim-bounds' below whcih is closely related but
3870 without doing the'flatten' to merge the images together. </td>
cristy3ed852e2009-09-05 21:47:34 +00003871 </tr>
3872
3873 <tr valign="top">
3874 <td valign="top">mosaic</td>
3875 <td valign="top">As 'flatten' method but expanding the initial canvas size
cristy10549a12011-05-15 19:04:46 +00003876 of the first image in a positive direction only so as to hold all the
3877 image layers. However as a virtual canvas is 'locked' to the origin,
3878 by its own definition, image layers with a negative offsets will still
3879 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
3880 if this could be a problem. </td>
3881
cristy3ed852e2009-09-05 21:47:34 +00003882 </tr>
3883
cristy10549a12011-05-15 19:04:46 +00003884 <tr><td></td><td>This method is commonly used to layout individual image
3885 using various offset but without knowing the final canvas size. The
3886 resulting image will, like 'flatten' not have any virtual offset, so
3887 can be saved to any image file format. </td>
cristy3ed852e2009-09-05 21:47:34 +00003888 </tr>
3889
3890
3891 <tr valign="top">
3892 <td valign="top">optimize</td>
3893 <td valign="top">Optimize a coalesced animation, into GIF animation using
3894 a number of general techniques. This currently a short cut to
3895 apply both the '<kbd>optimize-frame</kbd>', and
3896 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3897 include other optimization methods as they are developed. </td>
3898 </tr>
3899
3900 <tr valign="top">
3901 <td valign="top">optimize-frame</td>
3902 <td valign="top">Optimize a coalesced animation, into GIF animation by
3903 reducing the number of pixels per frame as much as possible by
3904 attempting to pick the best layer disposal method to use, while ensuring
3905 the result will continue to animate properly. </td>
3906 </tr>
3907
cristy10549a12011-05-15 19:04:46 +00003908 <tr><td></td><td> There is no guarantee that the best optimization is found.
3909 But then no reasonably fast GIF optimization algorithm can do this.
cristy3ed852e2009-09-05 21:47:34 +00003910 However this does seem to do better than most other GIF frame
3911 optimizers seen. </td>
3912 </tr>
3913
3914 <tr valign="top">
3915 <td valign="top">optimize-plus</td>
3916 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3917 overall optimization by adding extra frames to the animation, without
3918 changing the final look or timing of the animation. The frames are
3919 added to attempt to separate the clearing of pixels from the
3920 overlaying of new additional pixels from one animation frame to the
3921 next. If this does not improve the optimization (for the next frame
3922 only), it will fall back to the results of the previous normal
3923 '<kbd>optimize-frame</kbd>' technique. </td>
3924 </tr>
3925
cristy10549a12011-05-15 19:04:46 +00003926 <tr><td></td><td>There is the possibility that the change in the disposal
3927 style will result in a worsening in the optimization of later frames,
3928 though this is unlikely. In other words there no guarantee that it is
3929 better than the normal '<kbd>optimize-frame</kbd>' technique. For some
3930 animations however you can get a vast improvement in the final
3931 animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003932 </tr>
3933
3934 <tr valign="top">
3935 <td valign="top">optimize-transparency</td>
3936 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3937 overlay images with transparency, if it does not change the resulting
3938 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3939 </td>
3940 </tr>
3941
cristy10549a12011-05-15 19:04:46 +00003942 <tr><td></td><td>This should allow a existing frame optimized GIF animation
3943 to compress into a smaller file size due to larger areas of one
3944 (transparent) color rather than a pattern of multiple colors repeating
3945 the current disposed image of the last frame. </td>
cristy3ed852e2009-09-05 21:47:34 +00003946 </tr>
3947
3948 <tr valign="top">
3949 <td valign="top">remove-dups</td>
3950 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3951 images, so as to simplify layer overlays of coalesced animations.
3952 </td>
3953 </tr>
3954
cristy10549a12011-05-15 19:04:46 +00003955 <tr><td></td><td>Usually this a result of using a constant time delay
3956 across the whole animation, or after a larger animation was split into
3957 smaller sub-animations. The duplicate frames could also have been
3958 used as part of some frame optimization methods. </td>
cristy3ed852e2009-09-05 21:47:34 +00003959 </tr>
3960
3961 <tr valign="top">
3962 <td valign="top">remove-zero</td>
3963 <td valign="top">Remove any image with a zero time delay, unless ALL the
3964 images have a zero time delay (and is not a proper timed animation, a
3965 warning is then issued). </td>
3966 </tr>
3967
cristy10549a12011-05-15 19:04:46 +00003968 <tr><td></td><td>In a GIF animation, such images are usually frames which
3969 provide partial intermediary updates between the frames that are
3970 actually displayed to users. These frames are usally added for
3971 improved frame optimization in GIF animations. </td>
cristy3ed852e2009-09-05 21:47:34 +00003972 </tr>
3973
3974 <tr valign="top">
3975 <td valign="top">trim-bounds</td>
3976 <td valign="top">Find the bounds of all the images in the current
3977 image sequence, then adjust the offsets so all images are contained on
cristy10549a12011-05-15 19:04:46 +00003978 a minimal positive canvas. None of the image data is modified or
3979 merged, only the individual image virtual canvas size and offset.
3980 All the images is given the same canvas size, and and will have
3981 a positive offset, but will remain in the same position relative to
3982 each other. As a result of the minimal canvas size at least one image
3983 will touch every edge of that canvas. The image data touching those
3984 edges however may be transparent. </td>
3985 </tr>
3986
3987 <tr><td></td><td>The result is much like if you used 'merge' followed by a
3988 <a href="#repage" >+repage</a> option, except that all the images
3989 have been kept separate. If 'flatten' is used after using
3990 'trim-bounds' you will get the same result. </td>
cristy3ed852e2009-09-05 21:47:34 +00003991 </tr>
3992
3993 </tbody>
3994</table>
3995
3996<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3997
3998<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3999>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
cristy10549a12011-05-15 19:04:46 +00004000>-mosaic</a> are only aliases for the above methods and may be depreciated in
4001the future. Also see <a href="#page" >-page</a>, <a href="#repage"
4002>-repage</a> operators, the <a href="#compose" >-compose</a> setting, and the
4003GIF <a href="#dispose" >-dispose</a> and <a href="#delay" >-delay</a>
4004settings. </p>
cristy3ed852e2009-09-05 21:47:34 +00004005
4006
4007<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004008 <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 +00004009</div>
4010
4011<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>
4012
4013<p>Given one, two or three values delimited with commas: black-point,
4014white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
4015white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
4016point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
4017contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
4018both black and white points are percentages of the full color range. Gamma
4019will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
4020omitted, the default of 1.0 (no gamma correction) is assumed.</p>
4021
4022<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
4023the given '<kbd>black_point</kbd>' value in the original image is set to
4024zero (or black), while the given '<kbd>white_point</kbd>' value is set to
4025<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
4026to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
4027adjusted. </p>
4028
4029<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
4030adding the special '!' flag anywhere in the argument list, will cause the
4031operator to do the reverse of the level adjustment. That is a zero, or
4032<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
4033adjusted to the given level values, allowing you to de-contrast, or compress
4034the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
4035
4036<p>Only the channels defined by the current <a href="#channel">-channel</a>
4037setting are adjusted (defaults to RGB color channels only), allowing you to
4038limit the effect of this operator. </p>
4039
4040<p>Please note that the transparency channel is treated as 'matte'
4041values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
4042
4043
4044<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004045 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00004046 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
4047</div>
4048
cristyd0bda5e2010-09-21 16:22:45 +00004049<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 +00004050
4051<p>This function is exactly like <a href="#level">-level</a>, except that the
4052value value for each color channel is determined by the
4053'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
4054described under the <a href="#fill">-fill</a> option). </p>
4055
cristyd0bda5e2010-09-21 16:22:45 +00004056<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
4057is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00004058colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00004059adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00004060
4061<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
4062will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00004063respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00004064those colors. This can also be used to convert a plain gray-scale image into a
4065one using the gradient of colors specified. </p>
4066
4067<p>By supplying a single color with a comma separator either before or after
4068that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00004069respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00004070used for both the black and white color points, making the operator either
4071threshold the images around that color (- form) or set all colors to that
4072color (+ form). </p>
4073
4074
4075<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004076 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004077</div>
4078
4079<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>
4080
4081<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>
4082
cristy6b636652009-12-05 17:16:11 +00004083<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 +00004084
4085<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00004086 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00004087</p>
4088
4089<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
4090
cristydcca3fa2010-12-29 21:50:07 +00004091<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list resource</span><span class='crtout'></span></p><pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004092 File Area Memory Map Disk Thread Time
4093 ------------------------------------------------------------------------------
4094 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
cristydcca3fa2010-12-29 21:50:07 +00004095</pre>
4096
cristy3ed852e2009-09-05 21:47:34 +00004097<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>
4098
4099<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>
4100
4101<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>
4102
4103<p class="crtsnip">
4104-limit area 10mb
4105</p>
4106
cristyd0bda5e2010-09-21 16:22:45 +00004107<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 +00004108
4109<p class="crtsnip">
4110-limit area 10mb -limit disk 500mb
4111</p>
4112
4113<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
4114
4115<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>
4116
4117<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.
4118</p>
4119
4120<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.
4121</p>
4122
4123<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004124 <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 +00004125</div>
4126
4127<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>
4128
cristyd934d102009-10-10 12:55:13 +00004129<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
4130and uses a 'histogram bin' to determine the range of color values that needs to
4131be stretched. However it then stretchs those colors using the <a
4132href="#level" >-level</a> operator.</p>
4133
4134<p>As such while the initial determination may have 'binning' round off
4135effects, the image colors are stretched mathematically, rather than using the
4136histogram bins. This makes the operator more accurate. </p>
4137
4138<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
4139'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
4140perfect stretch of the color range. </p>
4141
4142<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
4143normalization of mathematical images. </p>
4144
4145<p>This operator is under review for re-development. </p>
4146
4147
cristy3ed852e2009-09-05 21:47:34 +00004148<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004149 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00004150</div>
4151
4152<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>
4153
4154<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004155 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004156</div>
4157
4158<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>
4159
4160<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>
4161
4162<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004163 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004164</div>
4165
4166<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>
4167
4168<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004169 Align Alpha Boolean Channel
4170 Class ClipPath Coder Color
4171 Colorspace Command Compose Compress
4172 Configure DataType Debug Decoration
4173 Delegate Direction Dispose Distort
4174 Dither Endian Evaluate FillRule
4175 Filter Font Format Function
4176 Gravity ImageList Intent Interlace
4177 Interpolate Kernel Layers LineCap
4178 LineJoin List Locale LogEvent
4179 Log Magic Method Metric
4180 Mime Mode Morphology Module
4181 Noise Orientation Policy PolicyDomain
4182 PolicyRights Preview Primitive QuantumFormat
4183 Resource SparseColor Storage Stretch
4184 Style Threshold Type Units
4185 Validate VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004186</pre>
4187
cristybac7a162010-06-15 19:57:29 +00004188<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4189list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4190available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004191
4192<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4193<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004194 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004195</div>
4196
4197<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>
4198
cristybac7a162010-06-15 19:57:29 +00004199<p>This option specifies the format for the log printed when the <a
4200href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004201
cristybac7a162010-06-15 19:57:29 +00004202<p>You can display the following components by embedding special format
4203characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004204
4205<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004206 %d domain
4207 %e event
4208 %f function
4209 %l line
4210 %m module
4211 %p process ID
4212 %r real CPU time
4213 %t wall clock time
4214 %u user CPU time
4215 %% percent sign
4216 \n newline
4217 \r carriage return
cristy3ed852e2009-09-05 21:47:34 +00004218</pre>
4219
4220<p>For example:</p>
4221
4222<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug coders -log "%u %m:%l %e" in.gif out.png</span></p>
4223<p>The default behavior is to print all of the components.</p>
4224
4225<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004226 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004227</div>
4228
4229<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>
4230
cristybac7a162010-06-15 19:57:29 +00004231<p>Set iterations to zero to repeat the animation an infinite number of times,
4232otherwise the animation repeats itself up to <em class="arg">iterations</em>
4233times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004234
4235<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004236 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004237</div>
4238
4239<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>
4240
4241<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004242 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004243</div>
4244
4245<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>
4246
4247
4248<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004249 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004250</div>
4251
4252<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>
4253
4254<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4255
4256<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004257 best
4258 default
4259 gray
4260 red
4261 green
4262 blue
cristy3ed852e2009-09-05 21:47:34 +00004263</pre>
4264
cristybac7a162010-06-15 19:57:29 +00004265<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4266Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4267the type and <kbd>display</kbd> searches the list of colormap types in
4268<kbd>top-to-bottom</kbd> order until one is located. See <em
4269class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004270
4271
4272<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004273 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004274</div>
4275
4276<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>
4277
4278<p>Here are the valid components of a map:</p>
4279
4280<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004281 r red pixel component
4282 g green pixel component
4283 b blue pixel component
4284 a alpha pixel component (0 is transparent)
4285 o opacity pixel component (0 is opaque)
4286 i grayscale intensity pixel component
4287 c cyan pixel component
4288 m magenta pixel component
4289 y yellow pixel component
4290 k black pixel component
4291 p pad component (always 0)
cristy3ed852e2009-09-05 21:47:34 +00004292</pre>
4293
cristybac7a162010-06-15 19:57:29 +00004294<p>You can specify as many of these components as needed in any order (e.g.
4295bgr). The components can repeat as well (e.g. rgbr).</p>
4296
cristy3ed852e2009-09-05 21:47:34 +00004297
4298<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004299 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004300<em class="arg">filename</em></h4>
4301</div>
4302
cristyacc04882011-05-04 23:03:43 +00004303<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 +00004304
cristyacc04882011-05-04 23:03:43 +00004305<p>This the same as using a mask used for composite masking operations, with
4306grayscale values causing blended updates of the image the mask is attached to.
4307</P>
4308
4309<p>Use <a href="#mask">+mask</a> to remove the mask from images.</p>
4310
4311<p>Also see <a href="#clip-mask">-clip-mask</a> which work in the same way,
4312but with strict boolean masking. </p>
cristy3ed852e2009-09-05 21:47:34 +00004313
4314<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004315 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004316</div>
4317
4318<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>
4319
4320<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4321
cristybac7a162010-06-15 19:57:29 +00004322<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4323style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004324
4325<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004326 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004327</div>
4328
4329<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>
4330
cristyacc04882011-05-04 23:03:43 +00004331<p>Select the 'maximum' value from all the surrounding pixels. </p>
4332
4333<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4334name. </p>
4335
cristyd2baf7d2010-03-06 04:26:44 +00004336<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004337 <h4><a id="median"></a>-median <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004338</div>
4339
4340<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>
4341
cristyacc04882011-05-04 23:03:43 +00004342<p>Select the 'middle' value from all the surrounding pixels. </p>
4343
4344<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4345name. </p>
4346
cristy3ed852e2009-09-05 21:47:34 +00004347<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004348 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004349</div>
4350
4351<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>
4352
4353<p>Choose from:</p>
4354
4355<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004356 AE absolute error count, number of different pixels (-fuzz effected)
4357 FUZZ mean color distance
4358 MAE mean absolute error (normalized), average channel error distance
4359 MEPP mean error per pixel (normalized mean error, normalized peak error)
4360 MSE mean error squared, average of the channel error squared
4361 NCC normalized cross correlation
4362 PAE peak absolute (normalize peak absolute)
4363 PSNR peak signal to noise ratio
4364 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004365</pre>
4366
cristy771f7a72010-11-27 21:42:59 +00004367<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4368with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4369only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004370size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004371'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004372for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004373
4374<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4375('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004376normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004377
cristybac7a162010-06-15 19:57:29 +00004378<p>To print a complete list of metrics, use the <a href="#list">-list
4379metrics</a> option.</p>
4380
cristy3ed852e2009-09-05 21:47:34 +00004381
cristyd2baf7d2010-03-06 04:26:44 +00004382<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004383 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004384</div>
4385
4386<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>
4387
cristyacc04882011-05-04 23:03:43 +00004388<p>Select the 'minimal' value from all the surrounding pixels. </p>
4389
4390<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4391name. </p>
4392
4393
cristy3ed852e2009-09-05 21:47:34 +00004394
4395<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004396 <h4><a id="mode"></a>-mode <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004397</div>
4398
cristy29c5c992011-06-25 13:58:49 +00004399<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 +00004400
4401<div style="margin: auto;">
4402 <h4>-mode <em class="arg">value</em></h4>
4403</div>
4404
cristy3ed852e2009-09-05 21:47:34 +00004405<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>
4406
cristybac7a162010-06-15 19:57:29 +00004407<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4408Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004409
cristybac7a162010-06-15 19:57:29 +00004410<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4411for a list of <a href="#mode" >-mode</a> arguments available in your
4412ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004413
4414
4415<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004416 <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 +00004417</div>
4418
cristybac7a162010-06-15 19:57:29 +00004419<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
4420class="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 +00004421
cristyb36feb22010-03-26 16:54:37 +00004422<p>The arguments are given as a percentages of variation. A value of 100 means
4423no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004424
cristyb36feb22010-03-26 16:54:37 +00004425<p>The <em class="arg">brightness</em> is a multiplier of the overall
4426brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4427twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4428before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004429
cristyb36feb22010-03-26 16:54:37 +00004430<p>The <em class="arg">saturation</em> controls the amount of color in an
4431image. For example, 0 produce a grayscale image, while a large value such as
4432200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004433
cristyb36feb22010-03-26 16:54:37 +00004434<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4435within the image by the amount specified. For example, 50 results in
4436a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4437A value of either 0 or 200 results in a complete 180 degree rotation of the
4438image. Using a value of 300 is a 360 degree rotation resulting in no change to
4439the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004440
cristyb36feb22010-03-26 16:54:37 +00004441<p>For example, to increase the color brightness by 20% and decrease the color
4442saturation by 10% and leave the hue unchanged, use <a
4443href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004444
cristyb36feb22010-03-26 16:54:37 +00004445<p>Use <a href="#set">-set</a> attribute of '<kbd
4446class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4447modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4448<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004449
4450<p class='crt'><span class="crtprompt"> $magick&gt; </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 +00004451
cristy3ed852e2009-09-05 21:47:34 +00004452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004453 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004454</div>
4455
4456<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>
4457
4458
4459<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004460 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004461</div>
4462
4463<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>
4464
4465
4466<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004467 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004468</div>
4469
4470<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>
4471
4472<p>Both the image pixels and size are linearly interpolated to give the
4473appearance of a meta-morphosis from one image to the next, over all the images
4474in the current image list. The added images are the equivalent of a <a
4475href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4476argument determine how many images to interpolate between each image. </p>
4477
4478
4479<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004480 <h4><a id="morphology"></a>-morphology</h4>
4481 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004482</div>
4483
cristy2c839602010-04-03 02:32:08 +00004484<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 +00004485
cristydcca3fa2010-12-29 21:50:07 +00004486<p>Until I get around to writing a option summary for this, see <a
4487href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4488Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004489
4490
cristy488844c2010-01-22 14:02:05 +00004491<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004492 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004493</div>
4494
4495<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>
4496
4497
4498<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004499 <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></h4>
cristy3ed852e2009-09-05 21:47:34 +00004500</div>
4501
4502<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>
4503
4504<p>Blur with the given radius, standard deviation (sigma), and angle. The
4505angle given is the angle toward which the image is blurred. That is the
4506direction people would consider the object is coming from. </p>
4507
4508<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004509definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004510
4511<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4512pixels which are outside the image proper are blurred into the final result.
4513</p>
4514
4515<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004516 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004517</div>
4518
4519<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>
4520<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004521 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004522</div>
4523
cristyb29bc032010-02-01 20:29:43 +00004524<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 +00004525
4526<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>
4527
4528<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004529 <h4><a id="noise"></a>-noise <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004530 +noise <em class="arg">type</em></h4>
4531</div>
4532
4533<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>
4534
4535<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>
4536
4537<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>
4538
4539<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>
4540
4541<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004542 Gaussian
4543 Impulse
4544 Laplacian
4545 Multiplicative
4546 Poisson
4547 Random
4548 Uniform
cristy3ed852e2009-09-05 21:47:34 +00004549</pre>
4550
4551<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4552
cristy83543962009-10-16 19:04:28 +00004553<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4554the use of a controlling value to specify teh amount of noise that should be
4555added to an image. </p>
4556
cristy3ed852e2009-09-05 21:47:34 +00004557
4558<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004559 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004560</div>
4561
4562<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>
4563
cristyd934d102009-10-10 12:55:13 +00004564<p>The intensity values are stretched to cover the entire range of possible
4565values. While doing so, black-out at most <em>2%</em> of the pixels and
4566white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004567
cristyd934d102009-10-10 12:55:13 +00004568<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4569is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4570(Before this version, it was equivalent to <a href="#contrast-stretch"
4571>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004572
cristyd934d102009-10-10 12:55:13 +00004573<p>All the channels are normalized in concert by the came amount so as to
4574preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004575setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004576setting will normalize the RGB channels independently.</p>
4577
cristydcca3fa2010-12-29 21:50:07 +00004578<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004579Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004580that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004581
4582<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004583
4584
4585<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004586 <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 +00004587</div>
4588
cristyd934d102009-10-10 12:55:13 +00004589<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
4590class="arg">threshold map</em> specified, and a uniform color map with the
4591given 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 +00004592
4593<p>You can choose from these standard threshold maps:</p>
4594
4595<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004596 threshold 1x1 Threshold 1x1 (non-dither)
4597 checks 2x1 Checkerboard 2x1 (dither)
4598 o2x2 2x2 Ordered 2x2 (dispersed)
4599 o3x3 3x3 Ordered 3x3 (dispersed)
4600 o4x4 4x4 Ordered 4x4 (dispersed)
4601 o8x8 8x8 Ordered 8x8 (dispersed)
4602 h4x4a 4x1 Halftone 4x4 (angled)
4603 h6x6a 6x1 Halftone 6x6 (angled)
4604 h8x8a 8x1 Halftone 8x8 (angled)
4605 h4x4o Halftone 4x4 (orthogonal)
4606 h6x6o Halftone 6x6 (orthogonal)
4607 h8x8o Halftone 8x8 (orthogonal)
4608 h16x16o Halftone 16x16 (orthogonal)
4609 c5x5b c5x5 Circles 5x5 (black)
4610 c5x5w Circles 5x5 (white)
4611 c6x6b c6x6 Circles 6x6 (black)
4612 c6x6w Circles 6x6 (white)
4613 c7x7b c7x7 Circles 7x7 (black)
4614 c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004615</pre>
4616
cristy945bb352011-04-01 15:39:28 +00004617<p> The <kbd>threshold</kbd> generated a simple 50% threshold of the image.
cristybaacd172011-04-30 23:11:03 +00004618This could be used with <em class="arg" >level</em> to do the equivalent of <a
cristy945bb352011-04-01 15:39:28 +00004619href="#posterize" >-posterize</a> to reduce an image to basic primary colors.
4620</p>
cristy3ed852e2009-09-05 21:47:34 +00004621
cristy945bb352011-04-01 15:39:28 +00004622<p>The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
4623pattern. That is a grayscale will become a pattern of solid black, solid
4624white, and mid-tone colors into a checkerboard pattern of black and white.
4625</p>
cristy3ed852e2009-09-05 21:47:34 +00004626
cristy945bb352011-04-01 15:39:28 +00004627<p>You can define your own <em class="arg" >threshold map</em> for ordered
4628dithering and halftoning your images, in either personal or system
4629<kbd>thresholds.xml</kbd> XML file. See <a href="resources.html" >Resources</A>
4630for more details of configuration files. </p>
cristy3ed852e2009-09-05 21:47:34 +00004631
cristy945bb352011-04-01 15:39:28 +00004632<p>To print a complete list of the thresholds that have been defined, use the
4633<a href="#list" >-list threshold</a> option.</p>
4634
4635<p>Note that at this time the same threshold dithering map is used for all
4636color channels, no attempt is made to offset or rotate the map for different
4637channels is made, to create an offset printing effect. Also as the maps are
4638simple threshold levels, the halftone and circle maps will create incomplete
4639circles along the edges of a colored area. Also all the effects are purely
4640on/off boolean effects, without anti-aliasing to make the circles smooth
4641looking. Large dots can be made to look better with a small amount of blurring
4642after being created. </p>
cristy3ed852e2009-09-05 21:47:34 +00004643
4644
4645<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004646 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004647</div>
4648
4649<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>
4650
cristyc54f5d42009-11-27 21:36:31 +00004651<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004652described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4653>-fuzz</a> setting can be used to match and replace colors similar to the one
4654given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004655
cristyb36feb22010-03-26 16:54:37 +00004656<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4657the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004658
cristyb36feb22010-03-26 16:54:37 +00004659<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4660as <a href="#opaque" >-opaque</a> but replaces the matching color with
4661transparency rather than the current <a href="#fill">-fill</a> color setting.
4662To ensure that it can do this it also ensures that the image has an alpha
4663channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4664the new transparent colors, and does not require you to modify the <a
4665href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004666
cristy3ed852e2009-09-05 21:47:34 +00004667
4668<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004669 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004670</div>
4671
4672<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>
4673
4674<p>Choose from these orientations:</p>
4675
4676<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004677 bottom-left
4678 bottom-right
4679 left-bottom
4680 left-top
4681 right-bottom
4682 right-top
4683 top-left
4684 top-right
4685 undefined
cristy3ed852e2009-09-05 21:47:34 +00004686</pre>
4687
cristyd934d102009-10-10 12:55:13 +00004688<p>To print a complete list of orientations, use the <a href="#list" >-list
4689orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004690
4691
4692<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004693 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004694 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4695 +page
4696 </h4>
4697</div>
4698
4699<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>
4700
4701<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>
4702
4703<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>
4704
4705<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>
4706<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4707<thead>
4708 <tr valign="top">
4709 <th align="center"><em class="arg">media</em></th>
4710 <th align="center"><em class="arg">width</em></th>
4711 <th align="center"><em class="arg">height</em></th>
4712 </tr>
4713</thead>
4714<tbody>
4715<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4716<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4717<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4718<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4719<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4720<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4721<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4722<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4723<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4724<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4725<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4726<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4727<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4728<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4729<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4730<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4731<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4732<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4733<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4734<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4735<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4736<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4737<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4738<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4739<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4740<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4741<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4742<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4743<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4744<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4745<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4746<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4747<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4748<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4749<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4750<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4751<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4752<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4753</tbody>
4754</table>
4755
4756
4757
4758
4759<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>
4760
4761<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>
4762
4763<p>The default page dimensions for a TEXT image is 612x792.</p>
4764
4765<p>This option is used in concert with <a href="#density">-density</a>.</p>
4766
4767<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4768
4769<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004770 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004771</div>
4772
4773<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>
4774
4775<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>
4776
4777<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004778 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004779
4780<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>
4781
4782<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004783 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004784</div>
4785
4786<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>
4787
4788<p>Pause for the specified number of seconds before repeating the animation.</p>
4789
4790<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004791 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004792</div>
4793
4794<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>
4795
4796<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4797
4798<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004799 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004800</div>
4801
4802<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>
4803
4804<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004805 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004806</div>
4807
4808<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>
4809
4810<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004811 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004812</div>
4813
4814<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>
4815
4816<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4817
4818<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004819 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004820</div>
4821
4822<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>
4823
4824<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004825 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004826</div>
4827
4828<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>
4829
4830<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004831 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004832</div>
4833
4834<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>
4835
4836<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>
4837
4838<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004839 Rotate Shear Roll Hue
4840 Saturation Brightness Gamma Spiff
4841 Dull Grayscale Quantize Despeckle
4842 ReduceNoise Add Noise Sharpen Blur
4843 Threshold EdgeDetect Spread Shade
4844 Raise Segment Solarize Swirl
4845 Implode Wave OilPaint CharcoalDrawing
4846 JPEG
cristy3ed852e2009-09-05 21:47:34 +00004847</pre>
4848
4849<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4850
4851<p>The default preview is <kbd>JPEG</kbd>.</p>
4852
4853<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004854 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004855</div>
4856
4857<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>
4858
4859<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004860 <h4><a id="process"></a>-process <em class="arg">command</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004861</div>
4862
4863<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>
4864
4865<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>
4866
4867<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004868 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004869 +profile <em class="arg">profile_name</em></h4>
4870</div>
4871
4872<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>
4873
4874<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>
4875
4876<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>
4877
4878<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>
4879
4880<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, 8BImageMagick, ICM,</em> or <em class="arg">IPTC</em>.</p>
4881
4882<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4883
4884<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4885<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>
4886
4887<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert CMYK.tif -profile "CMYK.icc" -profile "RGB.icc" RGB.tiff</span></p>
4888<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4889CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4890</p>
4891
4892<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004893 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004894</div>
4895
4896<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>
4897
cristy87a7f072011-07-01 00:08:52 +00004898<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
4899highest compression) to 100 (best quality but least effective compression).
4900The default is to use the estimated quality of your input image if it can
4901be determined, otherwise 92. When the quality is greater than 90, then the
4902chroma channels are not downsampled.
4903Use the <a href="#sampling-factor">-sampling-factor</a> option to specify the
4904factors for chroma downsampling.</p>
cristy3ed852e2009-09-05 21:47:34 +00004905
4906<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>
4907
cristy851dbce2010-08-06 21:40:00 +00004908<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 +00004909
cristy87a7f072011-07-01 00:08:52 +00004910<p>For the MNG and PNG image formats, the quality value sets the zlib
4911compression level (quality / 10) and filter-type (quality % 10). The default
4912PNG "quality" is 75, which means compression level 7 with adaptive PNG
4913filtering, unless the image has a color map, in which case it means
4914compression level 7 with no PNG filtering.</p>
4915
4916<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 +00004917
cristya4dfb122011-07-07 19:01:57 +00004918<p>If filter-type is 4 or less, the specified PNG filter-type is used for
4919all scanlines:</p>
cristy3ed852e2009-09-05 21:47:34 +00004920
4921<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004922 0: none
4923 1: sub
4924 2: up
4925 3: average
4926 4: Paeth
cristy3ed852e2009-09-05 21:47:34 +00004927</pre>
4928
cristy87a7f072011-07-01 00:08:52 +00004929<p>If filter-type is 5, adaptive filtering is used when quality is greater
4930than 50 and the image does not have a color map, otherwise no filtering is
4931used.</p>
cristy3ed852e2009-09-05 21:47:34 +00004932
cristy87a7f072011-07-01 00:08:52 +00004933<p>If filter-type is 6, adaptive filtering
4934with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
cristy3ed852e2009-09-05 21:47:34 +00004935
cristy87a7f072011-07-01 00:08:52 +00004936<p>Only if the output is MNG, if filter-type is 7, the LOCO color
4937transformation (intrapixel differencing) and adaptive filtering
4938with <em class="arg">minimum-sum-of-absolute-values</em> are used.</p>
cristy3ed852e2009-09-05 21:47:34 +00004939
cristy87a7f072011-07-01 00:08:52 +00004940<p>If the filter-type is 8 the zlib Z_RLE compression strategy is used with
4941 no PNG filtering.</p>
cristy3ed852e2009-09-05 21:47:34 +00004942
cristy87a7f072011-07-01 00:08:52 +00004943<p>If the filter-type is 9 the zlib Z_RLE compression strategy is used with
4944 adaptive PNG filtering.</p>
4945
cristya4dfb122011-07-07 19:01:57 +00004946<p>The quality setting has no effect on the appearance or signature of PNG
4947and MNG images, since the compression is always lossless.</p>
4948
4949<p>Not all combinations of compression level, strategy, and PNG filter type
4950can be obtained using the -quality option. For more precise control,
4951you can use the PNG:compression-level=N, PNG:compression-strategy=N, and
4952PNG:compression-filter=N defines, respectively, instead.
4953See <a href="#define">-define</a>. Values from the defines take precedence
4954over values from the -quality option.</p>
cristy87a7f072011-07-01 00:08:52 +00004955
4956<p>For further information, see
4957the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
cristy3ed852e2009-09-05 21:47:34 +00004958
cristy3ed852e2009-09-05 21:47:34 +00004959<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004960 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004961</div>
4962
cristy3c98a4f2010-08-13 20:09:41 +00004963<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 +00004964
cristy3c98a4f2010-08-13 20:09:41 +00004965<p>This setting defines the colorspace used to sort out and reduce the number
4966of colors needed by an image (for later dithering) by operators such as <a
4967href="#colors" >-colors</a>, Note that color reducion also happens
4968automatically when saving images to color-limited image file formats, such as
4969GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004970
4971
4972<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004973 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004974</div>
4975
4976<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>
4977
4978<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004979 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004980</div>
4981
4982<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>
4983
4984<p>Note that this is actually a rotational blur rather than a radial and as
4985such actually mis-named. </p>
4986
4987<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4988pixels which are outside the image proper are blurred into the final result.
4989</p>
4990
4991
4992<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004993 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004994</div>
4995
4996<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>
4997
4998<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>.
4999</p>
5000
5001<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
5002
5003<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005004 <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 +00005005</div>
5006
5007<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>
5008
5009<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005010 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005011</div>
5012
5013<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>
5014
5015<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005016 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00005017</div>
5018
5019<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>
5020
5021<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005022 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005023</div>
5024
5025<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>
5026
5027<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
5028the given colors are dithered over the image as necessary, otherwise the closest
5029color (in RGB colorspace) is selected to replace that pixel in the image. </p>
5030
5031<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
5032images in the current image sequence, all the images will have the same color
5033table. That means that when saved to a file format such as GIF, it will use
5034that color table as a single common or global color table, for all the images,
5035without requiring extra local color tables. </p>
5036
5037<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
5038sequence to use a common color map over all the images. This equivalent to
5039appending all the images together (without extra background colors) and color
5040reducing those images using <a href="#colors">-colors</a> with a 256 color
5041limit, then <a href="#remap">-remap</a> those colors over the original list of
5042images. This ensures all the images follow a single color map. </p>
5043
5044<p>If the number of colors over all the images is less than 256, then <a
5045href="#remap">+remap</a> should not perform any color reduction or dithering, as
5046no color changes are needed. In that case, its only effect is to force the use
5047of a global color table. This recommended after using either <a
5048href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
5049reduce the number of colors in an animated image sequence. </p>
5050
5051<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005052 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005053</div>
5054
5055<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>
5056
5057<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>
5058
5059<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>
5060
5061<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005062 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00005063</div>
5064
5065<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>
5066
5067<p>The only command recognized is the name of an image file to load.</p>
5068
5069<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>
5070
5071<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005072 <h4><a id="render"></a>-render</h4>
cristy3ed852e2009-09-05 21:47:34 +00005073</div>
5074
5075<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>
5076
5077<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>
5078
5079<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005080<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005081</div>
5082
5083<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>
5084
5085<p>This option is like <a href="#page">-page</a> but acts as an image operator
5086rather than a setting. You can separately set the canvas size or the offset
5087of the image on that canvas by only providing those components. </p>
5088
5089<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>
5090
5091<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
5092offset to move the image relative to its previous position. This useful for
5093animation sequences. </p>
5094
5095<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
5096recalculate the canvas size so the image (at its current offset) will appear
5097completely on that canvas (unless it has a negative offset).</p>
5098
5099<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
5100canvas meta-data from the images. </p>
5101
5102<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
5103directly assign virtual canvas meta-data. </p>
5104
5105
5106<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005107 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</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%'>Resample image to specified horizontal and vertical resolution.</td><td style='text-align:right;'></td></tr></table>
5111
5112<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>
5113
5114<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>
5115
5116<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005117 <h4><a id="resize"></a>-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005118</div>
5119
5120<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>
5121
5122<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>
5123
5124<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>
5125
cristy13538962010-02-26 17:53:04 +00005126<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>
5127
cristy4949d522010-03-12 18:41:34 +00005128<p class='crt'><span class="crtprompt"> $magick&gt; </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 +00005129<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005130 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00005131</div>
5132
5133<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>
5134
5135<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005136 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005137</div>
5138
5139<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>
5140
5141
5142<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005143 <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 +00005144</div>
5145
5146<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>
5147
5148<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>
5149
5150
5151<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005152 <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 +00005153</div>
5154
5155<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>
5156
5157<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>
5158
5159<p>Empty triangles in the corners, left over from rotating the image, are
5160filled with the <kbd>background</kbd> color. </p>
5161
5162<p>See also the <a href="#distort">-distort</a> operator and specifically the
5163'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5164
5165
5166<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005167 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005168</div>
5169
cristyd0bd44a2010-09-24 12:38:11 +00005170<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 +00005171
cristyd0bd44a2010-09-24 12:38:11 +00005172<p>Change the image size simply by directly sampling the pixels original
5173image. When magnifying, pixels are replicated in blocks. When minifying,
5174pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005175
cristyd0bd44a2010-09-24 12:38:11 +00005176<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5177a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5178neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5179avoids all the filter processing of the image. As such it completely ignores
5180the current <a href="#filter">-filter</a> setting. </p>
5181
5182<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5183will be added to the resulting image, though some colors may disappear. </p>
5184
5185<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
5186ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005187
5188
5189<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005190 <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 +00005191</div>
5192
5193<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>
5194
5195<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>
5196
5197<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005198 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005199</div>
5200
cristyd0bd44a2010-09-24 12:38:11 +00005201<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 +00005202
cristyd0bd44a2010-09-24 12:38:11 +00005203<p>Change the image size simply by replacing pixels by averaging pixels
5204together when minifying, or replacing pixels when magnifing. </p>
5205
5206<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5207a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5208faster, as it avoids all the filter processing of the image. As such it
5209completely ignores the current <a href="#filter">-filter</a> setting. </p>
5210
5211<p>If when shrinking (minifying) images the original image is some integer
5212multiple of the new image size, the number of pixels avergaed together to
5213produce the new pixel color is the same across the whole image. This is
5214a special case known as 'binning' and is often used as a method of reducing
5215noise in image such as those generated by digital cameras, especially in low
5216light conditions. </p>
5217
cristy3ed852e2009-09-05 21:47:34 +00005218
5219<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005220 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005221</div>
5222
5223<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>
5224
5225<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5226
5227<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005228 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005229</div>
5230
5231<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>
5232
5233<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>
5234
5235<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005236 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005237</div>
5238
5239<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>
5240
5241<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005242 <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 +00005243</div>
5244
5245<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>
5246
5247<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>
5248
5249<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>
5250
5251<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5252of the color clusters is returned.</p>
5253
5254
5255<div style="margin: auto;">
cristy8b9dd952011-03-21 22:56:18 +00005256 <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>}</h4>
cristy2e2662a2010-10-09 14:29:37 +00005257</div>
5258
cristy3ed852e2009-09-05 21:47:34 +00005259<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>
5260
cristy2e2662a2010-10-09 14:29:37 +00005261<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>
5262
cristy3ed852e2009-09-05 21:47:34 +00005263<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005264 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005265</div>
5266
5267<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>
5268
5269<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005270 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005271</div>
5272
5273<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>
5274
5275<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5276
5277<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>
5278
cristyd0bda5e2010-09-21 16:22:45 +00005279
5280
cristy3ed852e2009-09-05 21:47:34 +00005281<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005282 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5283 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005284</div>
5285
cristyd0bd44a2010-09-24 12:38:11 +00005286<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 +00005287image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005288
cristyd0bd44a2010-09-24 12:38:11 +00005289<p>This will assign (or modify) specific settings attached to all the images
5290in the current image sequence. Using the <a href="#set">+set</a> form of the
5291option will either remove, or reset that setting to a default state, as
5292appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005293
cristyd0bd44a2010-09-24 12:38:11 +00005294<p>For example, it will modify specific well known image meta-data
5295'attributes' such as those normally overridden by: the options <a
5296href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5297href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5298assigned before the image is read in, by using a <em class="arg">key</em> of
5299the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005300
cristyd0bd44a2010-09-24 12:38:11 +00005301<p>If the given <em class="arg">key</em> does not match a specific known
5302'attribute ', such as shown above, the setting is stored as a a free form
cristy323f35b2011-03-24 23:05:13 +00005303'property' string. Such settings are listed in <a href="#verbose"
cristyd0bda5e2010-09-21 16:22:45 +00005304>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5305</p>
5306
cristy84134182011-06-15 22:59:00 +00005307<p>This includes string 'properties' that are set by and assigned to images
cristyd0bd44a2010-09-24 12:38:11 +00005308using the options <a href="#comment" >-comment</a>, <a href="#label"
5309>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5310a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5311Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005312
cristyd0bd44a2010-09-24 12:38:11 +00005313<p class='crt'><span class="crtprompt"> $magick&gt; </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"> $magick&gt; </span><span class='crtin'>Rose is a rose is a rose is a rose</span></p>
5314<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5315Properties</a> in the defined value. For example:</p>
5316
5317<p class='crt'><span class="crtprompt"> $magick&gt; </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"> $magick&gt; </span><span class='crtin'>Old size = 70x46 New size = 35x23</span></p>
cristy84134182011-06-15 22:59:00 +00005318<p>Other well known 'properties' that are availible include:
cristyd0bd44a2010-09-24 12:38:11 +00005319'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5320'<kbd>signature</kbd>'. </p>
5321
5322<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5323the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5324see <a href="#repage">-page</a>). However it is designed to provide a finer
5325control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5326option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5327attribute. </p>
5328
5329<p>This option can also associate a colorspace or profile with your image.
5330For example,</p>
5331
5332<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.psd -set profile ISOcoated_v2_eci.icc image-icc.psd</span></p>
cristyd0bda5e2010-09-21 16:22:45 +00005333<p>Some 'properties' must be defined in a specific way to be used. For
5334example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5335modify the output filename of an image. For example</p>
5336
5337<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -set filename:mysize '%wx%h' 'rose_%[filename:mysize].png'</span></p>
5338<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5339be saved as a global "Artifact" exactly as if it was set using the <a
cristyf9a6c462011-04-24 14:01:11 +00005340href="#define" >-define</a> option. As such settings are global in scope, they
cristy84134182011-06-15 22:59:00 +00005341can be used to pass 'attributes' and 'properties' of one specific image,
cristyd0bd44a2010-09-24 12:38:11 +00005342in a way that allows you to use them in a completely different image, even if
5343the original image has long since been modified or destroyed. For example: </p>
5344
5345<p class='crt'><span class="crtprompt"> $magick&gt; </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>
5346<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5347a 'artifact' if the given <em class="arg">key</em> does not match an existing
cristy323f35b2011-03-24 23:05:13 +00005348'attribute' or 'property'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005349
5350<p>You can set the attributes of the image registry by prefixing the value
5351with <kbd>registry:</kbd>.</p>
5352
cristy84134182011-06-15 22:59:00 +00005353<p>The <a href="#set">-set profile</a> option can also be used to inject
5354previously-formatted ancillary chunks into the output PNG file, using
5355the commandline option as shown below or by setting the profile via a
5356programming interface:</p>
5357
5358<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -set profile PNG-chunk-x:&lt;filename&gt; out.png</span></p>
5359<p>where <em>x</em> is a location flag and
5360<em class="arg">filename</em> is a file containing the chunk
5361name in the first 4 bytes, then a colon (":"), followed by the chunk data.
5362This encoder will compute the chunk length and CRC, so those must not
5363be included in the file.</p>
5364
5365<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
5366or "e" (end, i.e., after IDAT). If you want to write multiple chunks
5367of the same type, then add a short unique string after the "x" to prevent
5368subsequent profiles from overwriting the preceding ones, e.g.,</p>
5369
5370
5371<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -set profile PNG-chunk-b01:file01 / <br/>
5372 -profile PNG-chunk-b02:file02 out.png</span></p>
5373<p>&nbsp;</p>
cristyd0bda5e2010-09-21 16:22:45 +00005374
cristy3ed852e2009-09-05 21:47:34 +00005375
5376<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005377 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005378</div>
5379
5380<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>
5381
5382<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>
5383
5384<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005385 <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 +00005386</div>
5387
5388<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>
5389
5390<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005391 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005392id="shared-memory"></a>-shared-memory</h4>
5393</div>
5394
5395<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>
5396
5397<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>
5398
5399<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005400 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005401</div>
5402
5403<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>
5404
5405<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5406
5407<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005408 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005409</div>
5410
5411<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>
5412
5413<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>
5414
5415<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>
5416
5417<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005418 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005419</div>
5420
5421<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>
5422
5423<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>
5424
5425<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>
5426
5427<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>
5428
5429<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>
5430
5431<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x0 -shear 0x60 logo-sheared.png</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 0x60 -shear 20x0 logo-sheared.png</span></p>
5432<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>
5433
5434<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5435<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005436 <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 +00005437</div>
5438
5439<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>
5440
5441<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>
5442
5443<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005444 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005445</div>
5446
5447<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>
5448
5449<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005450 <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 +00005451</div>
5452
5453<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>
5454
5455<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>
5456
5457<p>For Photo CD images, choose from these sizes:</p>
5458
5459<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005460 192x128
5461 384x256
5462 768x512
5463 1536x1024
5464 3072x2048
cristy3ed852e2009-09-05 21:47:34 +00005465</pre>
5466
cristy3ed852e2009-09-05 21:47:34 +00005467<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005468 <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></h4>
cristy3ed852e2009-09-05 21:47:34 +00005469</div>
5470
5471<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>
5472
5473<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>
5474
5475<div style="margin: auto;">
cristy2d67ddd2011-02-13 15:38:23 +00005476 <h4><a id="smush"></a>-smush <em class="arg">offset</em></h4>
5477</div>
5478
5479<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>
5480
5481<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005482 <h4><a id="snaps"></a>-snaps <em class="arg">value</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%'>Set the number of screen snapshots.</td><td style='text-align:right;'>[<a href="../www/import.html">import</a>]</td></tr></table>
5486
5487<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5488
5489<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005490 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005491</div>
5492
5493<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>
5494
5495<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5496
5497<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5498
5499<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005500 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005501 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5502</div>
5503
5504<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>
5505
5506
5507<table class="doc">
5508 <tbody>
5509 <tr valign="top">
5510 <th align="left" style="width: 8%">Method</th>
5511 <th align="left">Description</th>
5512 </tr>
5513
5514 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005515 <td valign="top">barycentric</td>
5516 <td valign="top">three point triangle of color given 3 points.
5517 Giving only 2 points will form a linear gradient between those points.
5518 The gradient generated extends beyond the triangle created by those
5519 3 points. </td>
5520 </tr>
5521
5522 <tr valign="top">
5523 <td valign="top">bilinear</td>
5524 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5525 fall back to barycentric. </td>
5526 </tr>
5527 <tr valign="top">
cristy3ed852e2009-09-05 21:47:34 +00005528 <td valign="top">voronoi</td>
5529 <td valign="top">Simply map each pixel to the to nearest color point
5530 given. The result are polygonal 'cells' of solid color. </td>
5531 </tr>
5532
5533 <tr valign="top">
5534 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005535 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005536 squared. Generating spots of color in a sea of the average of
5537 colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005538 </tr>
5539
5540 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005541 <td valign="top">inverse</td>
5542 <td valign="top">Colors points biased on the ratio of inverse distance.
5543 This generates sharper points of color rather than rounded spots of
5544 '<kbd>shepards</kbd>' Generating spots of color in a sea of the
5545 average of colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005546 </tr>
5547
5548 </tbody>
5549</table>
5550
5551<p>The points are placed according to the images location on the virtual
5552canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5553offset), and do not actually have to exist on the given image, but may be
5554some point beyond the edge of the image. All points are floating point values.
5555</p>
5556
5557<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
cristyacc04882011-05-04 23:03:43 +00005558modified, which means that by default matte/alpha transparency channel is not
5559effected. Typically transparency channel is turned off either before or after
5560the operation. </P>
5561
5562Of course if some color points are transparent to generate a transparent
5563gradient, then the image also requires transparency enabled to store the
5564values. </p>
cristy3ed852e2009-09-05 21:47:34 +00005565
5566<p>All the above methods when given a single point of color will replace all
5567the colors in the image with the color given, regardless of the point. This is
5568logical, and provides an alternative technique to recolor a image to some
5569default value. </p>
5570
5571
5572<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005573 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005574</div>
5575
5576<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>
5577
cristyacc04882011-05-04 23:03:43 +00005578<p>This will add rows and columns of the current <a
5579href="#background">-background</a> color into the given image according to the
5580given <a href="#gravity">-gravity</a> effectd 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. Essentually <a href="#splice">-splice</a> will divide the
5581image into four quadrants, separating them by the inserted rows and columns.
5582</P>
5583
5584If a dimension of geometry is zero no rows or columns will be added for that
5585dimension. Similarly using a zero offset with the appropriate <a
5586href="#gravity">-gravity</a> setting will add rows and columns to the edges of
5587the image, padding the image only along that one edge. Edge padding is what <a
5588href="#splice">-splice</a> is most commonly used for. </p>
5589
5590<p>If the exact same <em class="arg">geometry</em> and <a
5591href="#gravity">-gravity</a> is later used with <a href="#chop">-chop</a> the
5592added added all splices removed. </p>
cristy3ed852e2009-09-05 21:47:34 +00005593
5594<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005595 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005596</div>
5597
5598<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>
5599
5600<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>
5601
5602<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00005603 <h4><a id="statistic"></a>-statistic <em class="arg">type</em> <em class="arg">geometry</em></h4>
cristyb52981c2011-03-19 17:09:31 +00005604</div>
5605
5606<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>
5607
5608<p>Choose from these statistic types:</p>
5609<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005610 Gradient maximum difference in area
5611 Maximum maximum value per channel in neighborhood
5612 Minimum minimum value per channel in neighborhood
5613 Mean average value per channel in neighborhood
5614 Median median value per channel in neighborhood
5615 Mode mode (most frequent) value per channel in neighborhood
5616 Nonpeak value just before or after the median value per channel in neighborhood
cristyb52981c2011-03-19 17:09:31 +00005617</pre>
5618
5619<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005620 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005621</div>
5622
5623<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>
5624
5625<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>
5626
5627<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005628 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005629</div>
5630
5631<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>
5632
5633<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>
5634
5635<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005636 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005637</div>
5638
5639<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>
5640
5641<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005642 char unsigned characters
5643 double doubles
5644 float floats
5645 integer integers
5646 long longs
5647 quantum pixels in the native depth of your ImageMagick distribution
5648 short unsigned shorts
cristy3ed852e2009-09-05 21:47:34 +00005649</pre>
5650
5651<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5652values range from 0 to the maximum value the storage type can support.</p>
5653
5654<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005655 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005656</div>
5657
5658<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>
5659
5660<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>
5661
5662<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005663 Any
5664 Condensed
5665 Expanded
5666 ExtraCondensed
5667 ExtraExpanded
5668 Normal
5669 SemiCondensed
5670 SemiExpanded
5671 UltraCondensed
5672 UltraExpanded
cristy3ed852e2009-09-05 21:47:34 +00005673</pre>
5674
5675<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5676
5677<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>
5678
5679<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005680 <h4><a id="strip"></a>-strip</h4>
cristy3ed852e2009-09-05 21:47:34 +00005681</div>
5682
5683<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>
5684
5685<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005686 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005687</div>
5688
5689<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>
5690
5691<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5692
5693<p>See <a href="#draw">-draw</a> for further details.</p>
5694
5695<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005696 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005697</div>
5698
5699<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>
5700
5701<p>See <a href="#draw">-draw</a> for further details.</p>
5702
5703<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005704 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005705</div>
5706
5707<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>
5708
cristy71a3f602010-09-15 12:38:16 +00005709<p>This setting suggests a font style that ImageMagick should try to apply to
5710the currently selected font family. Select <em class="arg">fontStyle</em> from
5711the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005712
5713<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005714 Any
5715 Italic
5716 Normal
5717 Oblique
cristy3ed852e2009-09-05 21:47:34 +00005718</pre>
5719
5720<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>
5721
5722<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005723 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005724</div>
5725
cristyd4d64ed2010-08-22 22:19:33 +00005726<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>
5727
cristy71a3f602010-09-15 12:38:16 +00005728<p>This option is required to have compare search for the best match location
5729of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005730(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005731be the "match score" image.</p>
5732
cristyd0bd44a2010-09-24 12:38:11 +00005733<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005734position of the top-left corner of the given sub-image. that is its size will
5735be the size of the larger_image - sub_image + 1. The brightest location in
5736this image is the location s the locate on the best match that is also
5737reported. Note that this may or may nor be a perfect match, and the actual
5738brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005739possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005740
cristyd0bda5e2010-09-21 16:22:45 +00005741<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005742location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005743sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005744
cristyae6203d2010-08-09 01:12:14 +00005745
5746<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005747 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005748</div>
5749
5750<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>
5751
cristy71a3f602010-09-15 12:38:16 +00005752<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5753images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5754the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005755
5756<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005757 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005758</div>
5759
5760<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>
5761
5762<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5763
5764<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005765 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005766</div>
5767
5768<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>
5769
5770<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005771 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005772</div>
5773
cristy5063d812010-10-19 16:28:10 +00005774<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 +00005775
5776<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005777 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></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%'>font for writing fixed-width text.</td><td style='text-align:right;'></td></tr></table>
5781
5782<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>
5783
5784<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>
5785
5786<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005787 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005788</div>
5789
5790<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>
5791
5792<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005793 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005794</div>
5795
5796<!-- {<em class="arg">green,blue,opacity</em>}
5797<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>
5798-->
5799
5800<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>
5801
5802<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>
5803
5804<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.
5805</p>
5806
5807<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>
5808
5809<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5810<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>
5811
5812
5813<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -threshold 100% black.png</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -threshold -1 white.png</span></p>
5814<p>Note that the values of the transparency channel is treated as 'matte'
5815values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5816
5817<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>.
5818</p>
5819
5820<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005821 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005822</div>
5823
5824<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>
5825
5826<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>
5827
5828<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>
5829
5830<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005831 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005832</div>
5833
5834<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>
5835
5836<div style="margin: auto;">
5837 <h4>-tile <em class="arg">geometry</em></h4>
5838</div>
5839
5840<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>
5841
5842<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>
5843
5844<div style="margin: auto;">
5845 <h4>-tile</h4>
5846</div>
5847
5848<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>
5849
5850<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005851 <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 +00005852</div>
5853
5854<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>
5855
5856<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>
5857
5858<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>
5859
5860<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005861 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005862</div>
5863
5864<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>
5865
5866<p>Tint the image with the fill color.</p>
5867
5868<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>
5869
5870<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005871 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005872</div>
5873
5874<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>
5875
5876<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>
5877
5878<p>For example,</p>
5879
5880<p class="crtsnip">
5881 -title "%m:%f %wx%h"
5882</p>
5883
5884<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>
5885
5886
5887<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005888 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005889</div>
5890
5891<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>
5892
5893<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5894
5895<p class='crt'><span class="crtprompt"> $magick&gt; </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 +00005896
5897<p>This operator has been now been superseded by the <a
5898href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5899
5900
cristy3ed852e2009-09-05 21:47:34 +00005901<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005902 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005903</div>
5904
5905<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>
5906
5907<p>The <em class="arg">color</em> argument is defined using the format
5908described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5909>-fuzz</a> setting can be used to match and replace colors similar to the one
5910given. </p>
5911
cristyb36feb22010-03-26 16:54:37 +00005912<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5913that is make all non-matching colors transparent. </p>
5914
cristy3ed852e2009-09-05 21:47:34 +00005915<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005916href="#transparent" >-transparent</a> but replaces the matching color with the
5917current <a href="#fill">-fill</a> color setting, rather than transparent.
5918However the <a href="#transparent" >-transparent</a> operator also ensures
5919that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5920>-alpha</a> set</kbd>", and does not require you to modify the <a
5921href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005922
cristyb36feb22010-03-26 16:54:37 +00005923<p>Note that this does not define the color as being the 'transparency color'
5924used for color-mapped image formats, such as GIF. For that use <a
5925href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005926
5927
5928<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005929 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005930</div>
5931
5932<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>
5933
5934<p>Sometimes this is used for saving to image formats such as
5935GIF and PNG8 which uses this color to represent boolean transparency. This
5936does not make a color transparent, it only defines what color the transparent
5937color is in the color palette of the saved image. Use <a
5938href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5939
5940<p>This option allows you to have both an opaque visible color, as well as a
5941transparent color of the same color value without conflict. That is, you can
5942use the same color for both the transparent and opaque color areas within an
5943image. This, in turn, frees to you to select a transparent color that is
5944appropriate when an image is displayed by an application that does not handle a
5945transparent color index, while allowing ImageMagick to correctly handle images of this
5946type. </p>
5947
5948<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5949
5950<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005951 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005952</div>
5953
5954<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>
5955
5956<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5957</p>
5958
5959<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005960 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005961</div>
5962
5963<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>
5964
5965
5966<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005967 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005968</div>
5969
5970<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>
5971
5972<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>
5973
5974<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>
5975
5976<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>
5977
5978<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005979 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00005980</div>
5981
5982<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>
5983
5984<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>
5985
5986<p>The page or virtual canvas information of the image is preserved allowing
5987you to extract the result of the <a href="#trim">-trim</a> operation from the
5988image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5989information if it is unwanted.</p>
5990
5991<p>If the trimmed image 'disappears' an warning is produced, and a special
5992single pixel transparent 'missed' image is returned, in the same way as when a
5993<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5994
5995
5996<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005997 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005998</div>
5999
6000<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 +00006001 <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 +00006002
6003<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 overrride this behavior. For example, to prevent a JPEG from being written in grayscale format even though only gray pixels are present, use.</p>
6004
6005<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
6006<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>
6007
6008<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
6009
6010<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006011 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006012</div>
6013
6014<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>
6015
6016<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
6017
6018<p>See <a href="#draw">-draw</a> for further details.</p>
6019
6020
6021<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006022 <h4><a id="update"></a>-update <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006023</div>
6024
6025<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>
6026
6027<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>
6028
6029
6030<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006031 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00006032</div>
6033
6034<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>
6035
6036
6037<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006038 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006039</div>
6040
6041<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>
6042
6043<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>
6044
6045
6046<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006047 <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 +00006048</div>
6049
6050<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>
6051
6052<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>
6053
6054<p>The parameters are:</p>
6055
6056<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006057 radius The radius of the Gaussian, in pixels, not counting the center
6058 pixel (default 0).
6059 sigma The standard deviation of the Gaussian, in pixels (default 1.0).
6060 amount The fraction of the difference between the original and the blur
6061 image that is added back into the original (default 1.0).
6062 threshold The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
6063 difference amount (default 0.05).
cristy3ed852e2009-09-05 21:47:34 +00006064</pre>
6065
6066
6067<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006068 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00006069</div>
6070
cristyd0bda5e2010-09-21 16:22:45 +00006071<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 +00006072
6073
6074<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006075 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00006076</div>
6077
6078<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>
6079
6080
6081<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006082 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006083</div>
6084
6085<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>
6086
6087
6088<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006089 <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 +00006090</div>
6091
6092<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>
6093
6094
6095<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006096 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006097</div>
6098
6099<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>
6100
6101<p>This option defines what color source should be used if and when a color
6102lookup completely 'misses' the source image. The color(s) that appear to
6103surround the source image. Generally this color is derived from the source
6104image, but could also be set to a specify background color. </p>
6105
6106<p>Choose from these methods:</p>
6107
6108<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006109 background the area surrounding the image is the background color
6110 black the area surrounding the image is black
6111 checker-tile alternate squares with image and background color
6112 dither non-random 32x32 dithered pattern
6113 edge extend the edge pixel toward infinity
6114 gray the area surrounding the image is gray
6115 horizontal-tile horizontally tile the image, background color above/below
6116 horizontal-tile-edge horizontally tile the image and replicate the side edge pixels
6117 mirror mirror tile the image
6118 random choose a random pixel from the image
6119 tile tile the image (default)
6120 transparent the area surrounding the image is transparent blackness
6121 vertical-tile vertically tile the image, sides are background color
6122 vertical-tile-edge vertically tile the image and replicate the side edge pixels
6123 white the area surrounding the image is white
cristy3ed852e2009-09-05 21:47:34 +00006124</pre>
6125
6126<p>The default value is "edge".</p>
6127
6128<p>This most important for distortion operators such as <a href="#distort"
6129>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
6130However it also effects operations that may access pixels just outside the
6131image proper, such as <a href="#convolve">-convolve</a>, <a
6132href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
6133
6134<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
6135
6136
6137<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006138 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006139</div>
6140
6141<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>
6142
6143<p>Choose from these visual classes:</p>
6144
6145<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006146 StaticGray
6147 GrayScale
6148 StaticColor
6149 PseudoColor
6150 TrueColor
6151 DirectColor
6152 default
6153 visual id
cristy3ed852e2009-09-05 21:47:34 +00006154</pre>
6155
6156<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>
6157
6158
6159<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006160 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00006161 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
6162</div>
6163
6164<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
6165saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
6166
6167<p>Take a grayscale image (with alpha mask) and modify the destination image's
6168brightness according to watermark image's grayscale value and the <em
6169class="arg">brightness</em> percentage. The destinations color saturation
6170attribute is just direct modified by the <em class="arg">saturation</em>
6171percentage, which defaults to 100 percent (no color change). </p>
6172
6173
6174<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006175 <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 +00006176</div>
6177
6178<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>
6179
6180<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
6181
6182<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006183 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006184</div>
6185
6186<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>
6187
6188<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>
6189
6190<table class="doc">
6191 <col width="25%" />
6192 <col width="75%" />
6193 <thead>
6194 <tr>
6195 <th><em class="arg">fontWeight</em></th>
6196 <th>Description</th>
6197 </tr>
6198 </thead>
6199 <tbody>
6200 <tr><td>All </td> <td>No effect. </td></tr>
6201 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
6202 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
6203 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
6204 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
6205 </tbody>
6206 </table>
6207
6208<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
6209
6210<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>
6211
6212<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006213 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006214</div>
6215
6216<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>
6217
6218<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006219 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006220</div>
6221
cristy5cadd612009-09-21 19:33:41 +00006222<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>
6223
6224<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.
6225</p>
cristy3ed852e2009-09-05 21:47:34 +00006226
6227<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006228 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006229</div>
6230
6231<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>
6232
6233<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>
6234
6235<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>
6236
6237<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>
6238
6239<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006240 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006241</div>
6242
6243<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>
6244
6245<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006246 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006247</div>
6248
6249<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>
6250 <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>
6251
6252<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006253</div>
6254</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006255
6256</div>
6257
6258<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006259 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006260 <span id="linkbar-center">
6261 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006262 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006263 </span>
6264 <span id="linkbar-east">&nbsp;</span>
6265 </div>
6266 <div class="footer">
cristy1454be72011-12-19 01:52:48 +00006267 <span id="footer-west">&copy; 1999-2012 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006268 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6269 </div>
6270 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006271 <script type="text/javascript">
6272 var _gaq = _gaq || [];
6273 _gaq.push(['_setAccount', 'UA-17690367-1']);
6274 _gaq.push(['_trackPageview']);
6275
6276 (function() {
6277 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6278 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6279 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6280 })();
6281 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006282</body>
6283</html>