blob: 0e8bab6679a3b8a8b5d780ccb75b576def387703 [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"/>
14 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
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"/>
cristy7e41fe82010-12-04 23:12:08 +000030 <meta name="Copyright" content="Copyright (c) 1999-2011 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" />
cristy29c5c992011-06-25 13:58:49 +000037 <link rel="stylesheet" type="text/css" href="../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>
cristydcca3fa2010-12-29 21:50:07 +000042 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000043 <script type="text/javascript" src="../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">
164 <img src="../images/networkredux.png" alt="[sponsor]"
165 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">
cristy81492d62011-06-07 16:41:42 +0000168 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
169</div>
170<div class="sponsor">
cristy84134182011-06-15 22:59:00 +0000171 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
172</div>
173<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000174 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
175</div>
176<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000177 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
178</div>
179<div class="sponsor">
180 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
181</div>
182<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000183 <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 +0000184</div>
185<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000186 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000187</div>
188<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000189 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000190</div>
191<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000192 <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 +0000193</div>
194<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000195 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy7d52cd62010-10-01 17:26:59 +0000196</div>
197<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000198 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000199</div>
200<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000201 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
cristy851dbce2010-08-06 21:40:00 +0000202</div>
cristyec6b4752011-01-08 03:16:23 +0000203<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000204 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000205</div>
206<div class="sponsor">
cristy29c5c992011-06-25 13:58:49 +0000207 <a rel="follow" title="Sponsor: Autoteile Online Shop" href="http://www.autoteile-carparts.de">Autoteile Online Shop</a><!-- 2011080100030 autoteile-Carparts-->
cristyec6b4752011-01-08 03:16:23 +0000208</div>
cristy3ed852e2009-09-05 21:47:34 +0000209</div>
210</div>
cristyce69bb02010-07-27 19:49:46 +0000211</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000212
cristyce69bb02010-07-27 19:49:46 +0000213<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000214<div style="margin: 9pt 9pt 9pt 9pt;">
215 <div class="g-plusone" data-size="standard" data-count="false"></div>
216</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000217</div>
218
219<div class="main">
220
cristydcca3fa2010-12-29 21:50:07 +0000221<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000222<p class="navigation-index">
cristy8b9dd952011-03-21 22:56:18 +0000223[ <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 +0000224
cristydcca3fa2010-12-29 21:50:07 +0000225<div class="doc-section">
226
cristyb36feb22010-03-26 16:54:37 +0000227<p>Below is list of command-line options recognized by the ImageMagick <a
228href="../www/command-line-tools.html">command-line
229tools</a>. If you want a description of a particular option, click on the
230option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000231otherwise 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 +0000232
233<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000234 <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 +0000235</div>
236
237<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 +0000238<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>
239
240<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000241 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000242</div>
243
244<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>
245
246<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>
247
248<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000249 <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 +0000250</div>
251
252<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>
253
254<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>
255
256<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000257 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000258</div>
259
260<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>
261
cristy30092792011-02-22 02:06:14 +0000262<p>This option is enabled by default. An attempt is made to save all images of
263an image sequence into the given output file. However, some formats, such as
264JPEG and PNG, do not support more than one image per file, and in that case
265ImageMagick is forced to write each image as a separate file. As such, if
266more than one image needs to be written, the filename given is modified by
267adding a <a href="#scene">-scene</a> number before the suffix, in order to
268make distinct names for each image. </p>
cristy3ed852e2009-09-05 21:47:34 +0000269
cristy30092792011-02-22 02:06:14 +0000270<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written to
271separate files, whether or not the file format allows multiple images per file
272(for example, GIF, MIFF, and TIFF). </p>
cristy3ed852e2009-09-05 21:47:34 +0000273
cristy30092792011-02-22 02:06:14 +0000274<p>Including a C-style integer format string in the output filename will
275automagically enable <a href="#adjoin">+adjoin</a> and are used to specify
276where the <a href="#scene">-scene</a> number is placed in the filenames. These
277strings, such as '<kbd>%d</kbd>' or '<kbd>%03d</kbd>', are familiar to those
278who have used the standard <kbd>printf()</kbd>' C-library function. As an
279example, the command</p>
cristy3ed852e2009-09-05 21:47:34 +0000280
281<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 +0000282<p>will create a sequence of 17 images (the two given plus 15 more created by
283<a href="#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
284my02morph.jpg, ..., my16morph.jpg. </p>
cristy3ed852e2009-09-05 21:47:34 +0000285
cristy30092792011-02-22 02:06:14 +0000286<p>In summary, ImageMagick tries to write all images to one file, but will
287save to multiple files, if any of the following conditions exist...
288<ol>
289<li>the output image's file format does not allow multi-image files,
290<li>the <a href="#adjoin">+adjoin</a> option is given, or
291<li>a printf() integer format string (eg: "%d") is present in the output
292 filename.
293</ol></p>
cristy3ed852e2009-09-05 21:47:34 +0000294
295
296<div style="margin: auto;">
cristy30092792011-02-22 02:06:14 +0000297 <h4><a id="affine"></a>-affine
298 <em class="arg">s<sub>x</sub></em>,<em class="arg">r<sub>x</sub></em>,<em
299 class="arg">r<sub>y</sub></em>,<em class="arg">s<sub>y</sub></em>[,<em
cristye9a32c32011-04-07 01:11:05 +0000300 class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000301</div>
302
303<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>
304
cristy30092792011-02-22 02:06:14 +0000305<p>This option sets a transformation matrix, for use by subsequent <a
306href="#draw">-draw</a> or <a href="#transform">-transform</a> options. </p>
cristy3ed852e2009-09-05 21:47:34 +0000307
cristy30092792011-02-22 02:06:14 +0000308<p>The matrix entries are entered as comma-separated numeric values either in
309quotes or without spaces. </p>
cristy3ed852e2009-09-05 21:47:34 +0000310
cristy30092792011-02-22 02:06:14 +0000311<p>Internally, the transformation matrix has 3x3 elements, but three of them
312are omitted from the input because they are constant. The new (transformed)
313coordinates (<em class="arg">x'</em>, <em class="arg">y'</em>) of a pixel at
314position (<em class="arg">x</em>, <em class="arg">y</em>) in the original
315image are calculated using the following matrix equation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000316
317<div class="eqn">
318<img alt="affine transformation" src="../images/affine.png"/>
319</div>
320
cristy30092792011-02-22 02:06:14 +0000321<p> The size of the resulting image is that of the smallest rectangle that
322contains the transformed source image. The parameters <em
323class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em>
324subsequently shift the image pixels so that those that are moved out of the
325image area are cut off.</p>
cristy3ed852e2009-09-05 21:47:34 +0000326
cristy30092792011-02-22 02:06:14 +0000327<p>The transformation matrix complies with the left-handed pixel coordinate
328system: positive <em class="arg">x</em> and <em class="arg">y</em> directions
329are rightward and downward, resp.; positive rotation is clockwise.</p>
cristy3ed852e2009-09-05 21:47:34 +0000330
cristy30092792011-02-22 02:06:14 +0000331<p> If the translation coefficients <em class="arg">t<sub>x</sub></em> and <em
332class="arg">t<sub>y</sub></em> are omotted they default to 0,0. Therefore,
333four parameters suffice for rotation and scaling without translation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000334
cristy30092792011-02-22 02:06:14 +0000335<p>Scaling by the factors <em class="arg">s<sub>x</sub></em> and <em
336class="arg">s<sub>y</sub></em> in the <em>x</em> and <em>y</em> directions,
337respectively, is accomplished with the following.</p>
338
339<p>See <a href="#transform">-transform</a>, and the <a
340href="#distort">-distort</a> method '<kbd>Affineprojection</kbd> for more
341information </p>
342
cristy3ed852e2009-09-05 21:47:34 +0000343
344<p class="crtsnip">
345 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
346</p>
347
348<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>
349
350<p class="crtsnip">
351 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
352</p>
353
354<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
355<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
356
357<p class="crtsnip">
358 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
359</p>
360
361<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>
362
363<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>
364
365<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000366 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000367</div>
368
369<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>
370
371<p>Used to set a flag on an image indicating whether or not to use existing alpha
372channel 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>
373
374
375<table class="doc">
376 <tbody>
377 <tr valign="top">
378 <th align="left" style="width: 8%">type</th>
379 <th align="left">Description</th>
380 </tr>
381
382 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000383 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000384 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000385 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
386 should be used instead of this, unless you specifically need to
387 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
388 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000389
390 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000391 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000392 <td valign="top">
393 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000394 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000395
396 <tr valign="top">
397 <td valign="top"><kbd>Set</kbd></td>
398 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000399 Activates the alpha/matte channel. If it was previously turned off
400 then it also resets the channel to opaque. If the image already had
401 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000402
403 <tr valign="top">
404 <td valign="top"><kbd>Opaque</kbd></td>
405 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000406 Enables the alpha/matte channel and forces it to be fully opaque.
407 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000408
409 <tr valign="top">
410 <td valign="top"><kbd>Transparent</kbd></td>
411 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000412 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000413 transparent. This effectively creates a fully transparent image the
414 same size as the original and with all its original RGB data still
415 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000416
417 <tr valign="top">
418 <td valign="top"><kbd>Extract</kbd></td>
419 <td valign="top">
420 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000421 '<kbd>Off</kbd>' the the image's transparency, so as to generate
422 a gray-scale mask of the image's shape. The alpha channel data is left
423 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
424 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000425
426 <tr valign="top">
427 <td valign="top"><kbd>Copy</kbd></td>
428 <td valign="top">
429 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000430 gray-scale intensity of the image, into the alpha channel, converting
431 a gray-scale mask into a transparent shaped mask ready to be colored
432 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000433
434 <tr valign="top">
435 <td valign="top"><kbd>Shape</kbd></td>
436 <td valign="top">
437 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000438 the current background color. That is the RGB color channels is
439 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000440 </td></tr>
441
442 <tr valign="top">
443 <td valign="top"><kbd>Background</kbd></td>
444 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000445 Set any fully-transparent pixel to the background color, while leaving
446 it fully-transparent. This can make some image file formats, such as
447 PNG, smaller as the RGB values of transparent pixels are more uniform,
448 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000449 </td></tr>
450 </tbody>
451</table>
452
453<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000454"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000455>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000456Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000457
458
459<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000460 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000461 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
462 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
463 -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>
464</div>
465
466<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>
467
468<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>
469
470
471<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>
472
473<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>
474
475<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>
476<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
477
478<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>
479
480<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>
481
482<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000483 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000484</div>
485
486<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
487drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
488
489<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
490drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
491antialiasing edge pixels. This will then reduce the number of colors added to
492an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000493are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000494
495<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000496 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000497</div>
498
499<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>
500
501<p>This option creates a single longer image image, by joining all the current
502images in sequence top-to-bottom. Use <a href="#append">+append</a> to
503stack images left-to-right. </p>
504
505<p>If they are not of the same width, narrower images are padded with the
506current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000507position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000508href="#gravity">-gravity</a> setting. </p>
509
510
511<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000512 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000513</div>
514
515<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>
516
517
518<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000519 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000520</div>
521
522<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>
523
524<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>
525
526<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
527
cristyd934d102009-10-10 12:55:13 +0000528
529
cristy3ed852e2009-09-05 21:47:34 +0000530<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000531 <h4><a id="auto-gamma"></a>-auto-gamma</h4>
cristy3ed852e2009-09-05 21:47:34 +0000532</div>
533
534<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>
535
cristyd934d102009-10-10 12:55:13 +0000536<p>This calculates the mean values of an image, then applies a calculated <a
537href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
538image it will get a have a value of 50%. </p>
539
cristyd0bd44a2010-09-24 12:38:11 +0000540<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000541
542<p>This works well for real-life images with little or no extreme dark and
543light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000544dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000545</p>
546
547<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristy2dcd6822011-06-13 16:21:20 +0000548'<em>sync</em>' flag for channel synchronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000549values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000550>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000551together by the same gamma value, preserving colors. </p>
552
553
554
cristy3ed852e2009-09-05 21:47:34 +0000555<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000556 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000557</div>
558
559<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>
560
cristyd934d102009-10-10 12:55:13 +0000561<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000562minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000563href="#level" >-level</a> operator to stretch the values to the full range of
564values. </p>
565
cristy83543962009-10-16 19:04:28 +0000566<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000567JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
568for the <a href="#level" >-level</a> operation. On the other hand it is the
569right operator to use for color stretching gradient images being used to
570generate Color lookup tables, distortion maps, or other 'mathematically'
571defined images. </p>
572
573<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
574href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
575>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
576problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000577>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000578
579<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristy2dcd6822011-06-13 16:21:20 +0000580special '<em>sync</em>' flag for channel synchronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000581which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000582href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
583'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000584together by the same gamma value, preserving colors, and ignoring
585transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000586
587
cristy3ed852e2009-09-05 21:47:34 +0000588<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000589 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000590</div>
591
592<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>
593
cristy83543962009-10-16 19:04:28 +0000594<p>This operator reads and resets the EXIF image profile setting 'Orientation'
595and then performs the appropriate 90 degree rotation on the image to orient
596the image, for correct viewing. </p>
597
598<p>This EXIF profile setting is usually set using a gravity sensor in digital
599camara, however photos taken directly downward or upward may not have an
600appropriate value. Also images that have been orientation 'corrected' without
601reseting this setting, may be 'corrected' again resulting in a incorrect
602result. If the he EXIF profile was previously stripped, the <a
603href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
604
605
cristy3ed852e2009-09-05 21:47:34 +0000606<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000607 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000608</div>
609
610<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>
611
612<p>An error results if the images are not identically sized.</p>
613
cristy3ed852e2009-09-05 21:47:34 +0000614
615<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000616 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000617</div>
618
619<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>
620
621<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>
622
623<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000624 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000625</div>
626
627<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>
628
629<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>
630
631<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000632 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000633</div>
634
635<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>
636
cristye6378132009-10-26 20:05:17 +0000637<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 +0000638
cristye6378132009-10-26 20:05:17 +0000639<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>
640<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 +0000641
642<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000643 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000644</div>
645
646<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>
647
648<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>
649
650<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>
651
652<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
653negative results without clipping to the color value range
654(0..QuantumRange).</p>
655
656<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +0000657<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 +0000658</p>
659
660<div style="margin: auto;">
cristy37e0dfd2011-03-06 16:35:34 +0000661 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000662</div>
663
664<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>
665
666<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000667 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000668</div>
669
cristy5cadd612009-09-21 19:33:41 +0000670<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>
671
672<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.
673</p>
cristy3ed852e2009-09-05 21:47:34 +0000674
675
676<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000677 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000678</div>
679
cristy83a272e2010-05-07 20:40:35 +0000680<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 +0000681
682<p>Blend will average the images together ('plus') according to the
683percentages given and each pixels transparency. If only a single percentage
684value is given it sets the weight of the composite or 'source' image, while
685the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000686<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
687'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000688
689
690<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000691 <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 +0000692</div>
693
694<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>
695
696<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000697 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000698</div>
699
700<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>
701
702<div style="margin: auto;">
703
704<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000705 <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 +0000706</div>
707
708<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>
709
cristyb15553d2010-07-03 22:53:14 +0000710<p>Convolve the image with a Gaussian or normal distribution using the given
711<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000712
713<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
714</div>
715
cristyb15553d2010-07-03 22:53:14 +0000716<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000717determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000718
cristyb15553d2010-07-03 22:53:14 +0000719<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000720array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000721integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000722radius that will provide meaningful results for the Gaussian distribution.
723</p>
724
725<p>The larger the <em class="arg" >Radius</em> the radius the slower the
726operation is. However too small a <em class="arg" >Radius</em>, and sever
727aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
728should be at least twice the <em class="arg" >Sigma</em> value, though three
729times will produce a more accurite result. </p>
730
731<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
732by taking advantage of the separability properties of the distribution. Here
733we apply a single-dimensional Gaussian matrix in the horizontal direction,
734then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000735
736<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
737pixels which are outside the image proper are blurred into the final result.
738</p>
739
740
741<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000742 <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 +0000743</div>
744
745<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>
746
747<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
748Average (EWA) of the source image, scaled according to the grayscale
749mapping. </p>
750
751<p>The ellipse is weighted with sigma set to the given <em class="arg"
752>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
753defaults to the <em class="arg" >Width</em> for a normal circular Guassian
754weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
755horizontal clock-wise. </p>
756
757<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
758pixels which are outside the image proper are blurred into the final result.
759</p>
760
761
762<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000763 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000764</div>
765
766<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>
767
cristybc9539a2010-08-16 18:06:20 +0000768<p>Set the width and height using the <em class="arg">size</em> portion of the
769<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
770ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000771
cristybc9539a2010-08-16 18:06:20 +0000772<p>Set the border color by preceding with the <a
773href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000774
cristybc9539a2010-08-16 18:06:20 +0000775<p>The <a href="#border">-border</a> operation is affected by the current <a
776href="#compose">-compose</a> setting and assumes that this is using the default
777'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
778size colors by the current <a href="#bordercolor">-bordercolor</a> before
779overlaying the original image in the center of this net image. This means that
780with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000781be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000782<p>See also the <a href="#frame">-frame</a> option, which has more
783functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000784
785<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000786 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000787</div>
788
789<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>
790
791<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
792
793<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
794
795<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000796 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000797</div>
798
799<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>
800
801<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000802 <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 +0000803</div>
804
805<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>
806
cristyefb2bdb2010-11-20 19:35:22 +0000807<p>Brightness and Contrast values apply changes to the input image. They are
808not absolute settings. A brightness or contrast value of zero means no change.
809The range of values is -100 to +100 on each. Positive values increase the
810brightness or contrast and negative values decrease the brightness or contrast.
811To control only contrast, set the brightness=0. To control only brightness,
812set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000813
cristyefb2bdb2010-11-20 19:35:22 +0000814<p>You may also use <a href="#fill">-channel</a> to control which channels to
815apply the brightness and/or contrast change. The default is to apply the same
816transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000817
cristyefb2bdb2010-11-20 19:35:22 +0000818<p>Brightness and Contrast arguments are converted to offset and slope of a
819linear transform and applied
820using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000821
cristyefb2bdb2010-11-20 19:35:22 +0000822<p>The slope varies from 0 at contrast=-100 to almost vertical at
823contrast=+100. For brightness=0 and contrast=-100, the result are totally
824midgray. For brightness=0 and contrast=+100, the result will approach but
825not quite reach a threshold at midgray; that is the linear transformation
826is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000827
cristyefb2bdb2010-11-20 19:35:22 +0000828<p>Negative slopes, i.e. negating the image, are not possible with this
829function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000830
cristyefb2bdb2010-11-20 19:35:22 +0000831<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
832at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
833totally white. Similarly, when contrast=0 and brightness=-100, the result is
834totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000835
cristyefb2bdb2010-11-20 19:35:22 +0000836<p>As the range of values for the arguments are -100 to +100, adding the '%'
837symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000838
839<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000840 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000841</div>
842
843<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>
844
845<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000846 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000847</div>
848
849<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>
850
cristy71a3f602010-09-15 12:38:16 +0000851<p>This option sets the caption meta-data of an image read in after this
852option has been given. To modify a caption of images already in memory use
853"<kbd><a href="#set">-set</a> caption</kbd>". </p>
854
855<p>The caption can contain special format characters listed in the <a
856href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000857Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000858is finally assigned to the individual images. </p>
859
860<p>If the first character of <em class="arg">string</em> is <em
861class="arg">@</em>, the image caption is read from a file titled by the
862remaining characters in the string. Comments read in from a file are literal;
863no embedded formatting characters are recognized.</p>
864
865<p>Caption meta-data ais not visible on the image itself. To do that use the
866<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
867instead.</p>
868
869<p>For example,</p>
870
871<p class="crtsnip">
872 -caption "%m:%f %wx%h" bird.miff
873</p>
874
875<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
876that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
877480.</p>
878
879
cristy3ed852e2009-09-05 21:47:34 +0000880<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000881 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000882</div>
883
884<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>
885
886<p>Here is an example color correction collection:</p>
887
888<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000889&lt;?xml version="1.0" encoding="UTF-8"?&gt;
890&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
891 &lt;ColorCorrection id="cc06668"&gt;
892 &lt;SOPNode&gt;
893 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
894 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
895 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
896 &lt;/SOPNode&gt;
897 &lt;SATNode&gt;
898 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
899 &lt;/SATNode&gt;
900 &lt;/ColorCorrection&gt;
901&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000902</pre>
903
904<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000905 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000906</div>
907
908<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>
909
cristyefb2bdb2010-11-20 19:35:22 +0000910<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
911<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
912<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
913<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000914
cristy83a272e2010-05-07 20:40:35 +0000915<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000916abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
917'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
918'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000919
cristy83a272e2010-05-07 20:40:35 +0000920For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
921you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000922<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000923 -channel Red,Blue
924</p>
925<p>or you can use the short hand form</p>
926<p class="crtsnip">
927 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000928</p>
929
cristy2dcd6822011-06-13 16:21:20 +0000930<p>All the channels that are present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000931special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
932but generally any operators that are generally 'grey-scale' image operators,
933will understand this setting. See individual operator documentation. </p>
934
cristydcca3fa2010-12-29 21:50:07 +0000935<br />
cristy83a272e2010-05-07 20:40:35 +0000936
cristy2dcd6822011-06-13 16:21:20 +0000937<p>On top of the normal channel selection an extra flag can be specified,
cristy83a272e2010-05-07 20:40:35 +0000938'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000939operators that understand this flag should perform: cross-channel
cristy2dcd6822011-06-13 16:21:20 +0000940synchronization of the channels. If not specified, then most grey-scale
cristybac7a162010-06-15 19:57:29 +0000941operators will apply their image processing operations to each individual
942channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000943setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000944
945<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000946<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000947together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000948it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000949independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000950
cristydcca3fa2010-12-29 21:50:07 +0000951<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000952and the <a href="#compose">-compose</a> mathematical methods, also understands
953the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
954to the alpha channel (if present). That is to say it will modify the image
955processing with the understanding that fully-transparent colors should not
956contribute to the final result. </p>
957
cristy2dcd6822011-06-13 16:21:20 +0000958<p>Basically, by default, operators work with color channels in synchronous, and
cristybac7a162010-06-15 19:57:29 +0000959treats transparency as special, unless the <a href="#channel">-channel</a>
960setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
961How each operator does this depends on that operators current implementation.
962Not all operators understands this flag at this time, but that is changing.
963</p>
cristy83a272e2010-05-07 20:40:35 +0000964
965<p>To print a complete list of channel types, use <a href="#list">-list
966channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000967
cristydcca3fa2010-12-29 21:50:07 +0000968<br />
cristyd934d102009-10-10 12:55:13 +0000969
970<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000971'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
972channels except the transparency channel, and that all the color channels are
973to be modified in exactly the same way, with a understanding of transprancy
974(depending on the operation being applied). The 'plus' form <a
975href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000976
977<p>Options that are affected by the <a href="#channel" >-channel</a> setting
978include the following.
979
980<a href="#auto-gamma">-auto-gamma</a>,
981<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000982<a href="#black-threshold">-black-threshold</a>,
983<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000984<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000985<a href="#clut">-clut</a>,
986<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000987<a href="#composite">-composite</a> (Mathematical compose methods only),
988<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000989<a href="#contrast-stretch">-contrast-stretch</a>,
990<a href="#evaluate">-evaluate</a>,
991<a href="#function">-function</a>,
992<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000993<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000994<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000995<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000996<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000997<a href="#negate">-negate</a>,
998<a href="#normalize">-normalize</a>,
999<a href="#ordered-dither">-ordered-dither</a>,
1000<a href="#radial-blur">-radial-blur</a>,
1001<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +00001002<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +00001003<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +00001004<a href="#white-threshold">-white-threshold</a>.
1005</p>
1006
cristyd0bda5e2010-09-21 16:22:45 +00001007<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +00001008>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +00001009href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +00001010default). These operators have yet to be made to understand the newer 'Sync'
1011flag. </p>
1012
cristybac7a162010-06-15 19:57:29 +00001013<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
1014the image before thresholding, if no <a href="#channel" >-channel</a> setting
1015has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +00001016
1017<p>Also some operators such as <a href="#blur">-blur</a>, <a
1018href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
1019color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
1020href="#channel" >-channel</a>. Generally this done to ensure that
1021fully-transparent colors are treated as being fully-transparent, and thus any
1022underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +00001023resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +00001024convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +00001025and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +00001026
cristybac7a162010-06-15 19:57:29 +00001027<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +00001028color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +00001029alpha channel present, and the <a href="#channel" >-channel</a> setting tells
1030the operator to apply the operation using alpha channels. The <a
1031href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +00001032
cristy3ed852e2009-09-05 21:47:34 +00001033
1034<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001035 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +00001036</div>
1037
1038<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>
1039
1040<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001041 <h4><a id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001042</div>
1043
1044<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>
1045
1046<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001047 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001048</div>
1049
1050<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>
1051
cristyefb2bdb2010-11-20 19:35:22 +00001052<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>
1053and <em class="arg">height</em> given in the of the <em class="arg">size</em>
1054portion of the <em class="arg">geometry</em> argument give the number of
1055columns and rows to remove. The <em class="arg">offset</em> portion of
1056the <em class="arg">geometry</em> argument is influenced by
1057a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +00001058
cristyefb2bdb2010-11-20 19:35:22 +00001059<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
1060and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00001061
cristyacc04882011-05-04 23:03:43 +00001062<p>While it can remove internal rows and columns of pixels, it is more
1063typically used with as <a href="#gravity">-gravity</a> setting and zero
1064offsets so as to remove a single edge from an image. Compare this to <a
1065href="#shave" >-shave</a> which removes equal numbers of pixels from oppisite
1066sides of the image. </p>
cristydcca3fa2010-12-29 21:50:07 +00001067
cristyacc04882011-05-04 23:03:43 +00001068<p>Using <a href="#chop">-chop</a> will effectivally undo the results of a <a
1069href="#splice">-splice</a> that was given the same <em
1070class="arg">geometry</em> and <a href="#gravity">-gravity</a> settings. </p>
cristydcca3fa2010-12-29 21:50:07 +00001071
1072
cristy3ed852e2009-09-05 21:47:34 +00001073<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001074 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001075</div>
1076
1077<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>
1078
1079<p>If a clipping path is present, it is applied to subsequent operations.</p>
1080
1081<p>For example, in the command</p>
1082
1083<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
1084<p>only the pixels within the clipping path are negated.</p>
1085
1086<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1087
1088<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001089 <h4><a id="clip-mask"></a>-clip-mask</h4>
cristy3ed852e2009-09-05 21:47:34 +00001090</div>
1091
1092<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>
1093
cristy30092792011-02-22 02:06:14 +00001094<p>Use the given image as a 'do-not-modify' mask of the current images in the
1095current image sequence. Assuming the clipmask is a greyscale image the same
1096size at the one already in memory, any areas that is white will not be
1097modified by any of the 'image processing operators' that follow, until the
1098mask is removed. Pixels in the black areas of the clip mask will be modified
1099as normal. </p>
1100
1101<p>In some ways this is similar to (though not the same) as defining
1102a rectangular <a href="#region" >-region</a>, or using the negative of the
1103mask (thrid) image in a three image <a href="#composite" >-composite</a>,
1104operation. </p>
1105
1106
cristy3ed852e2009-09-05 21:47:34 +00001107<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001108 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001109</div>
1110
1111<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>
1112
cristyd241f442011-03-29 13:50:49 +00001113<p>This is almost identical to <a href="#clip">-clip</a>. </p>
cristy30092792011-02-22 02:06:14 +00001114
1115
cristy3ed852e2009-09-05 21:47:34 +00001116<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001117 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001118</div>
1119
cristy8b9dd952011-03-21 22:56:18 +00001120<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 +00001121
cristydcca3fa2010-12-29 21:50:07 +00001122<p>Inside parenthesis (where the operator is normally used) it will make a
1123clone of the images from the last 'pushed' image sequence, and adds them to
1124the end of the current image sequence. Outside parenthesis
1125(not recommended) it clones the images from the current image sequence. </p>
1126
cristy3ed852e2009-09-05 21:47:34 +00001127<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000011280. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001129example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001130represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001131dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1132spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
cristy8b9dd952011-03-21 22:56:18 +00001133effectively clone all the images. </p>
cristydcca3fa2010-12-29 21:50:07 +00001134
1135<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
cristybaacd172011-04-30 23:11:03 +00001136in the image sequence, and is thus equivalent to using a argument of
cristydcca3fa2010-12-29 21:50:07 +00001137'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001138
1139<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001140 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001141</div>
1142
1143<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
1144corresponding channel in the second image as a <b>c</b>olor
1145<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1146
1147<p>The second (LUT) image is ordinarily a gradient image containing the
1148histogram mapping of how each channel should be modified. Typically it is a
1149either a single row or column image of replacement color values. If larger
1150than a single row or column, values are taken from a diagonal line from
1151top-left to bottom-right corners.</p>
1152
1153<p>The lookup is further controlled by the <a
1154href="#interpolate">-interpolate</a> setting, which is especially handy for an
1155LUT which is not the full length needed by the ImageMagick installed Quality
1156(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1157'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1158gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1159lookup of color values. </p>
1160
1161<p>This operator is especially suited to replacing a grayscale image with a
1162specific color gradient from the CLUT image. </p>
1163
1164<p>Only the channel values defined by the <a href="#channel">-channel</a>
1165setting will have their values replaced. In particular, since the default <a
1166href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1167transparency (alpha/matte channel) is not affected, unless the <a
1168href="#channel">-channel</a> setting is modified. When the alpha channel is
1169set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1170as the other channels, implying that alpha/matte values are replaced using the
1171alpha/matte values of the original image. </p>
1172
cristyd0bda5e2010-09-21 16:22:45 +00001173<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001174transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1175href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001176assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001177replacement alpha values. That is you can use a gray-scale CLUT image to
1178adjust a existing images alpha channel, or you can color a gray-scale image
1179using colors form CLUT containing the desired colors, including transparency.
1180</p>
1181
cristyefb2bdb2010-11-20 19:35:22 +00001182<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1183according to the lookup of the full color RGB value from a 2D representation
1184of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001185
1186
1187<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001188 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001189</div>
1190
1191<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>
1192
cristyefb2bdb2010-11-20 19:35:22 +00001193<p>Overlay each image in an image sequence according to
1194its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1195an animation at each point in the animation sequence. All images should be
1196the same size, and are assigned appropriate GIF disposal settings for the
1197animation to continue working as expected as a GIF animation. Such frames
1198are more easily viewed and processed than the highly optimized GIF overlay
1199images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001200
cristyefb2bdb2010-11-20 19:35:22 +00001201<p>The animation can be re-optimized after processing using
1202the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1203there is no guarantee that the restored GIF animation optimization is
1204better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001205
1206
1207<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001208 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001209</div>
1210
1211<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>
1212
cristyefb2bdb2010-11-20 19:35:22 +00001213<p>Specify the amount of colorization as a percentage. Separate colorization
1214values can be applied to the red, green, and blue channels of the image with
1215a comma-delimited list of colorization
1216values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001217
1218<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001219 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001220</div>
1221
1222<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>
1223
1224<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1225
cristyefb2bdb2010-11-20 19:35:22 +00001226<p>This option only applies when the default X server visual
1227is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1228to <a href="#visual">-visual</a> for more details. By default,
1229a shared colormap is allocated. The image shares colors with
1230other X clients. Some image colors could be approximated,
1231therefore your image may look very different than intended.
1232If <kbd>private</kbd> is chosen, the image colors appear exactly
1233as they are defined. However, other clients may go <em>technicolor</em>
1234when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001235
1236<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001237 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001238</div>
1239
1240<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>
1241
cristyefb2bdb2010-11-20 19:35:22 +00001242<p>The actual number of colors in the image may be less than your request,
1243but never more. Note that this a color reduction option. Images with fewer
1244unique colors than specified by <em class="arg">value</em> will have any
1245duplicate or unused colors removed. The ordering of an existing color
1246palette may be altered. When converting an image from color to grayscale,
1247it is more efficient to convert the image to the gray colorspace before
1248reducing the number of colors. Refer to
1249the <a href="../www/quantize.html">
1250color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001251
1252<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001253 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001254</div>
1255
1256<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>
1257
cristyefb2bdb2010-11-20 19:35:22 +00001258<p>This option permits saturation changes, hue rotation, luminance to alpha,
1259and various other effects. Although variable-sized transformation matrices
1260can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1261for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1262Adobe Flash except offsets are in column 6 rather than 5 (in support of
1263CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001264
1265<p>As an example, to add contrast to an image with offsets, try this command:</p>
1266
1267<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001268 convert kittens.jpg -color-matrix \
1269 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1270 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1271 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1272 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1273 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1274 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
cristy2c839602010-04-03 02:32:08 +00001275</pre>
1276<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001277 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001278</div>
1279
1280<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>
1281
1282<p>Choices are:</p>
1283
1284<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001285 CMY CMYK Gray HSB
1286 HSL HWB Lab Log
1287 OHTA Rec601Luma Rec601YCbCr Rec709Luma
1288 Rec709YCbCr RGB sRGB Transparent
1289 XYZ YCbCr YCC YIQ
1290 YPbPr YUV
cristy3ed852e2009-09-05 21:47:34 +00001291</pre>
1292
1293<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1294
1295<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>
1296
1297<table class="doc">
1298 <caption>Conversion Of RGB To Other Color Spaces</caption>
1299 <tr><th align="left" valign="middle">CMY</th></tr>
1300 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1301 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1302 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1303 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1304 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1305 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1306 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1307 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1308
1309 <tr><th align="left" valign="middle">Gray</th></tr>
1310 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1311
1312 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1313 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1314 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1315 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1316
1317 <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>
1318 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1319 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1320 <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>
1321
1322 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1323 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1324 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1325 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1326
1327 <tr><th align="left" valign="middle">LAB</th></tr>
1328 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1329 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1330 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1331
1332 <tr><th align="left" valign="middle">LOG</th></tr>
1333 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1334 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1335 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1336
1337 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1338 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1339 <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>
1340 <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>
1341
1342 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1343 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1344
1345 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1346 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1347 <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>
1348 <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>
1349
1350 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1351 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1352
1353 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1354 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1355 <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>
1356 <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>
1357
1358 <tr><th align="left" valign="middle">sRGB</th></tr>
cristyf9a6c462011-04-24 14:01:11 +00001359 <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>
1360 <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>
1361 <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 +00001362
1363 <tr><th align="left" valign="middle">XYZ</th></tr>
1364 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1365 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1366 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1367
1368 <tr><th align="left" valign="middle">YCC</th></tr>
1369 <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>
1370 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1371 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1372
1373 <tr><th align="left" valign="middle">YCbCr</th></tr>
1374 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1375 <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>
1376 <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>
1377
1378 <tr><th align="left" valign="middle">YIQ</th></tr>
1379 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1380 <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>
1381 <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>
1382
1383 <tr><th align="left" valign="middle">YPbPr</th></tr>
1384 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1385 <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>
1386 <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>
1387
1388 <tr><th align="left" valign="middle">YUV</th></tr>
1389 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1390 <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>
1391 <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>
1392</table>
1393
1394<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001395 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001396</div>
1397
1398<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>
1399
1400<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>
1401
1402<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.
1403</p>
1404
cristy4949d522010-03-12 18:41:34 +00001405<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 +00001406<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001407 <h4><a id="comment"></a>-comment <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001408</div>
1409
1410<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>
1411
cristyd0bda5e2010-09-21 16:22:45 +00001412<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001413option has been given. To modify a comment of images already in memory use
1414"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001415
cristy71a3f602010-09-15 12:38:16 +00001416<p>The comment can contain special format characters listed in the <a
1417href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001418Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001419is finally assigned to the individual images. </p>
1420
1421<p>If the first character of <em class="arg">string</em> is <em
1422class="arg">@</em>, the image comment is read from a file titled by the
1423remaining characters in the string. Comments read in from a file are literal;
1424no embedded formatting characters are recognized.</p>
1425
1426<p>Comment meta-data are not visible on the image itself. To do that use the
1427<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1428instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001429
1430<p>For example,</p>
1431
1432<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001433 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001434</p>
1435
cristy71a3f602010-09-15 12:38:16 +00001436<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1437that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1438480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001439
1440<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001441 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001442</div>
1443
1444<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>
1445
cristybc9539a2010-08-16 18:06:20 +00001446<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1447a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001448
cristybc9539a2010-08-16 18:06:20 +00001449<p>This setting effects image processing operators that merge two (or more)
1450images together in some way. This includes the operators,
1451<a href="#composite">-composite</a>,
1452<a href="#layers">-layers</a> composite,
1453<a href="#flatten">-flatten</a>,
1454<a href="#mosaic">-mosaic</a>,
1455<a href="#layers">-layers</a> merge,
1456<a href="#border">-border</a>,
1457<a href="#frame">-frame</a>,
1458and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001459
cristybc9539a2010-08-16 18:06:20 +00001460<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1461command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001462
1463
1464<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001465 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001466</div>
1467
cristybc9539a2010-08-16 18:06:20 +00001468<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 +00001469
1470<p>Take the first image 'destination' and overlay the second 'source' image
1471according to the current <a href="#compose">-compose</a> setting. The location
1472of the 'source' or 'overlay' image is controlled according to <a
1473href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1474settings. </p>
1475
1476<p>If a third image is given this is treated as a gray-scale 'mask' image
1477relative to the first 'destination' image. This mask will limit what parts of
1478the destination can be modified by the image composition. However for the
1479'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1480Y-displacement image instead. </p>
1481
1482<p>If a <a href="#compose">-compose</a> method requires extra numerical
1483arguments or flags these can be provided by setting the <a
1484href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001485appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001486
1487<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1488image outside the overlay area. You can disable this by setting the special <a
1489href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1490to '<kbd>false</kbd>'. </p>
1491
1492
1493<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001494 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001495</div>
1496
1497<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>
1498
1499<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>
1500
1501<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1502
1503<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>
1504
1505<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>
1506
1507<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>
1508
1509<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>
1510
1511<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001512 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001513</div>
1514
1515<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>
1516
1517<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>
1518
1519<p>For a more pronounced effect you can repeat the option:</p>
1520
1521<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1522<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001523 <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 +00001524</div>
1525
1526<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>
1527
cristyd934d102009-10-10 12:55:13 +00001528<p>While performing the stretch, black-out at most <em
1529class="arg" >black-point</em> pixels and white-out at most <em
1530class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1531<em class="arg" >black-point %</em> pixels and white-out at most <em
1532class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001533
cristyd934d102009-10-10 12:55:13 +00001534<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1535>-contrast-stretch</a> will black-out at most <em class="arg"
1536>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1537minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1538class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1539>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001540
cristyd934d102009-10-10 12:55:13 +00001541<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1542the image's min and max values are stretched to 0 and <em class="QR"
1543>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1544clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001545>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001546prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001547
cristyd934d102009-10-10 12:55:13 +00001548<p>Internally operator works by creating a histogram bin, and then uses that
1549bin to modify the image. As such some colors may be merged together when they
1550originally fell into the same 'bin'. </p>
1551
1552<p>All the channels are normalized in concert by the came amount so as to
1553preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001554setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001555setting will normalize the RGB channels independently.</p>
1556
1557<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1558normalization of mathematical images. </p>
1559
1560<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001561
1562
1563<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001564 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001565</div>
1566
1567<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>
1568
cristy16ff93c2010-01-13 23:18:07 +00001569<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001570a comma-separated list of integers (with no spaces), ordered left-to right,
1571starting with the top row. Presently, only odd-dimensioned kernels are
1572supported, and therefore the number of entries in the specified <em
1573class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15747<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001575
cristyd934d102009-10-10 12:55:13 +00001576<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
1577positive and negative results are relative to a user-specified bias value.
1578This is important for non-HDRI compilations of ImageMagick when dealing with
1579convolutions that contain negative as well as positive values. This is
1580especially the case with convolutions involving high pass filters or edge
1581detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001582</p>
1583
cristyd934d102009-10-10 12:55:13 +00001584<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
1585negative results without clipping to the color value range (0..QuantumRange).
1586See the discussion on HDRI implementations of ImageMagick on the page <a
cristy47774982011-02-15 15:17:19 +00001587href="../www/high-dynamic-range.html">High
cristyd934d102009-10-10 12:55:13 +00001588Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1589href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1590<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1591entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001592
cristy3ed852e2009-09-05 21:47:34 +00001593
1594<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001595 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001596</div>
1597
1598<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>
1599
1600<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>
1601
1602<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>
1603
1604<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>
1605
1606<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>
1607
1608<p>By adding a exclamation character flag to the geometry argument, the
1609cropped images virtual canvas page size and offset is set as if the
1610geometry argument was a viewport or window. This means the canvas page size
1611is set to exactly the same size you specified, the image offset set
1612relative top left corner of the region cropped. </p>
1613
1614<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1615special single pixel transparent 'missed' image is returned, and a 'crop
1616missed' warning given. </p>
1617
cristy739df912009-10-24 16:10:18 +00001618<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 +00001619
1620<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001621 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001622</div>
1623
1624<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>
1625
1626<p><em class="arg">Amount</em> defines the number of positions each
1627colormap entry is shifted.</p>
1628
1629
1630<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001631 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001632</div>
1633
1634<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>
1635
1636<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>
1637
1638
1639<p>For example, to log cache and blob events, use.</p>
1640
1641<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1642<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1643
1644<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1645
1646<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1647
1648<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1649
1650<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>
1651
1652
1653<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001654 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001655</div>
1656
1657<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>
1658
1659<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1660
1661<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1662
1663
1664<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001665 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001666</div>
1667
1668<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>
1669
1670<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>
1671
1672<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>
1673
1674<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1675
1676
1677<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001678 <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 +00001679</div>
1680
cristyd0bd44a2010-09-24 12:38:11 +00001681<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 +00001682coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001683
cristyd0bda5e2010-09-21 16:22:45 +00001684<p>This option creates one or more definitions for coders and decoders to use
1685while reading and writing image data. Definitions are generally used to
1686control image file format coder modules, and image processing operations,
1687beyond what is provided by normal means. Defined settings are listed in <a
1688href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1689as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001690
cristyd0bda5e2010-09-21 16:22:45 +00001691<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1692definition of a flag is created with that name. This used to control on/off
1693options. Use <a href="#define">+define key</a> to remove definitions
1694previously created. Use <a href="#define">+define "*"</a> to remove all
1695existing definitions.</p>
1696
cristyd0bd44a2010-09-24 12:38:11 +00001697<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001698href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001699>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 +00001700Properties</a> in the defined value. </p>
1701
cristyefb2bdb2010-11-20 19:35:22 +00001702<p>The <em>option</em> and <em>key</em> are case-independent (they are
1703converted to lowercase for use within the decoders) while the <em>value</em>
1704is case-dependent.</p>
1705
cristyd0bda5e2010-09-21 16:22:45 +00001706<p>Such settings are global in scope, and effect all images and operations. </p>
1707
1708<p>The following definitions are just some of the artifacts that are
1709available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001710
cristydcca3fa2010-12-29 21:50:07 +00001711<dl>
cristy045bd902010-01-30 18:56:24 +00001712<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001713<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001714 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001715
cristy045bd902010-01-30 18:56:24 +00001716<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001717<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001718 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001719
cristy045bd902010-01-30 18:56:24 +00001720<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001721<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001722 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001723
cristy045bd902010-01-30 18:56:24 +00001724<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001725<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1726 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001727 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001728
cristy045bd902010-01-30 18:56:24 +00001729<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001730<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1731 compression factor is the reciprocal of the compression ratio. The valid
1732 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1733 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001734 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001735
cristy3ed852e2009-09-05 21:47:34 +00001736<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001737 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001738
cristy045bd902010-01-30 18:56:24 +00001739<dt>png:bit-depth=<em class="arg">value</em></dt>
1740<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001741<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1742 encoder to use a different bit-depth and color-type than it would have
1743 normally selected, but only if this does not cause any loss of image
1744 quality. Any attempt to reduce image quality is treated as an error and no
1745 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1746 can use these "defines" to cause it to be written as an 8-bit grayscale,
1747 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1748 you cannot force it to be written as a grayscale or indexed PNG. If you
1749 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1750 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1751 reduce the image quality prior to using the PNG encoder. Note that in
1752 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001753 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001754 8-bit depth.</dd>
1755
1756<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1757<dt>png:include-chunk=<em class="arg">value</em></dt>
1758<dd>ancillary chunks to be excluded from or included in PNG output.
1759
1760 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1761 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1762 or the word <em class="arg">all</em> or
1763 the word <em class="arg">none</em>. There must be no spaces in the
1764 list. Although PNG chunk-names are case-dependent, you can use
1765 all lowercase names if you prefer.</p>
1766
cristyd241f442011-03-29 13:50:49 +00001767 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
1768 of the PNG encoder and have no effect on the PNG decoder.</p>
1769
cristydcca3fa2010-12-29 21:50:07 +00001770 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1771 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1772 only be written if gamma is not 1/2.2, since most decoders assume
1773 sRGB and gamma=1/2.2 when no colorspace information is included in
1774 the PNG file. Because the list is processed from left to right, you
1775 can achieve this with a single define:</p>
1776
1777<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001778 -define png:include-chunk=none,gAMA
cristydcca3fa2010-12-29 21:50:07 +00001779</pre>
1780
1781 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
1782 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any of
1783 these entries appearing in the list will be ignored.</p>
1784
1785 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1786 image has transparency, the PNG colortype is forced to be 4 or 6
1787 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1788 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1789 on the PNG colortype of the output image.</p>
1790
1791 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1792 following for PNG output:</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 default behavior is to include all known PNG ancillary chunks
cristyf7964272011-01-30 03:49:12 +00001799 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk,
1800 and to exclude all PNG chunks that are unknown to ImageMagick,
1801 regardless of their PNG "copy-safe" status as described in the
1802 PNG specification.</p>
cristyd241f442011-03-29 13:50:49 +00001803
1804 <p>Any chunk names that are not known to ImageMagick are ignored
1805 if they appear in either the "include-chunk" or "exclude-chunk" list.
1806 The ancillary chunks currently known to ImageMagick are
1807 <kbd>bKGD</kbd>, <kbd>cHRM</kbd>, <kbd>gAMA</kbd>, <kbd>iCCP</kbd>,
1808 <kbd>oFFs</kbd>, <kbd>pHYs</kbd>, <kbd>sRGB</kbd>, <kbd>tEXt</kbd>,
1809 <kbd>tRNS</kbd>, <kbd>vpAg</kbd>, and <kbd>zTXt</kbd>.</p>
1810
cristyf9a6c462011-04-24 14:01:11 +00001811 <p>You can also put <kbd>date</kbd> in the list to include or exclude
1812 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
1813 inserts in the output PNG.</p>
1814
1815</dd>
1816
1817<dt>png:preserve-colormap</dt>
1818 <dd>Use the existing image->colormap. Normally the PNG encoder will
1819 try to optimize the palette, eliminating unused entries and putting
1820 the transparent colors first. If this flag is set, that behavior
1821 is suppressed.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001822
cristy3ed852e2009-09-05 21:47:34 +00001823<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001824<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1825 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001826 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001827
cristy045bd902010-01-30 18:56:24 +00001828<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001829<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1830 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1831 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001832 included, the result is a single precision floating point format.
1833 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001834 double precision floating point format.</dd>
1835
cristydcca3fa2010-12-29 21:50:07 +00001836</dl>
cristy3ed852e2009-09-05 21:47:34 +00001837
cristyd0bda5e2010-09-21 16:22:45 +00001838<p>For example, to create a postscript file that will render only the black
1839pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001840
1841<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 +00001842<p>Set attributes of the image registry by prefixing the value with
1843<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1844use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001845
1846<p class="crtsnip">
1847-define registry:temporary-path=/data/tmp
1848</p>
1849
cristyd0bda5e2010-09-21 16:22:45 +00001850
1851
cristy3ed852e2009-09-05 21:47:34 +00001852<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001853 <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 +00001854</div>
1855
1856<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>
1857
1858<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>
1859
1860<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>
1861
1862
1863<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00001864 <h4><a id="delete"></a>-delete <em class="arg">indexes</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001865</div>
1866
1867<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>
1868
1869<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>
1870
1871
1872<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001873 <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 +00001874</div>
1875
1876<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>
1877
1878<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>
1879
1880<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>
1881
1882<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>
1883
1884<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>
1885
1886<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001887 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001888</div>
1889
1890<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>
1891
1892<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>
1893
1894<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001895 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00001896</div>
1897
1898<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>
1899
1900<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001901 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001902</div>
1903
1904<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>
1905
1906<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>
1907
1908<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001909 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00001910</div>
1911
1912<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>
1913
1914<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001915 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001916</div>
1917
1918<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>
1919
1920<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001921 <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 +00001922</div>
1923
1924<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>
1925
1926<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001927is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001928what part of the 'background' image is seen at each point of the overlaid
1929area. Much like the displacement map is a 'lens' that redirects light shining
1930through it so as to present a distorted view the original 'background' image
1931behind it. </p>
1932
1933<p>Any perfect grey areas of the displacement map produce a zero
1934displacement of the image. Black areas produce the given maximum negative
1935displacement of the lookup point, while white produce a maximum positive
1936displacement of the lookup. </p>
1937
1938<p>Note that it is the lookup of the 'background' that is displaced, not a
1939displacement of the image itself. As such an area of the displacement map
1940containing 'white' will have the lookup point 'shifted' by a positive amount,
1941and thus generating a copy of the destination image to the right/downward from
1942the correct position. That is the image will look like it may have been
1943'shifted' in a negative left/upward direction. Understanding this is a very
1944important in understanding how displacement maps work. </p>
1945
1946<p>The given arguments define the maximum amount of displacement in pixels
1947that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001948it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001949outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001950easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001951into the overlay area. </p>
1952
1953<p>The '%' flag makes the displacement scale relative to the size of the
1954overlay image (100% = half width/height of image). Using '!' switches
1955percentage arguments to refer to the destination image size instead.
1956these flags were added as of IM v6.5.3-5.</p>
1957
1958<p>Normally a single grayscale displacement map is provided, which with the
1959given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001960displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001961specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001962the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001963displacement, while the <em class="arg">mask image</em> is used for vertical Y
1964displacement. This allows you to define completely different displacement
1965values for the X and Y directions, and allowing you to lookup any point within
1966the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001967any other nearby pixel, producing complex 2 dimensional displacements, rather
1968than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001969
cristyd0bda5e2010-09-21 16:22:45 +00001970<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001971you can use the 'red' channel of the overlay image to specify the horizontal
1972or X displacement, and the 'green' channel for the vertical or Y displacement.
1973</p>
1974
cristyd0bd44a2010-09-24 12:38:11 +00001975<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 +00001976mask the transparency of the destination image. However areas outside the
1977overlaid areas will not be effected. </p>
1978
1979
1980<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001981 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001982</div>
1983
1984<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>
1985
1986<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1987
1988<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001989 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001990</div>
1991
1992<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>
1993
1994<p>The layer disposal method defines the way each the displayed image is to be
1995modified after the current 'frame' of an animation has finished being
1996displayed (after its 'delay' period), but before the next frame on an
1997animation is to be overlaid onto the display. </p>
1998
1999<p>Here are the valid methods:</p>
2000
2001<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002002 Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
2003 None 1 Do not dispose, just overlay next frame image.
2004 Background 2 Clear the frame area with the background color.
2005 Previous 3 Clear to the image prior to this frames overlay.
cristy3ed852e2009-09-05 21:47:34 +00002006</pre>
2007
2008<p>You can also use the numbers given above, which is what the GIF format
2009uses internally to represent the above settings. </p>
2010
cristyd0bda5e2010-09-21 16:22:45 +00002011<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002012
2013<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
2014resetting the layer disposal methods of images being read in. </p>
2015
2016<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
2017disposal method for images already in memory.</p>
2018
2019<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002020 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002021</div>
2022
2023<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>
2024
2025
2026<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002027 <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 +00002028</div>
2029
2030<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>
2031
2032<p>The opacity of the composite image is multiplied by the given percent, then
2033it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00002034is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00002035transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
2036are given, each image are dissolved to the percentages given. </p>
2037
2038<p>Note that dissolve percentages do not add, two opaque images dissolved
2039'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2040images, you would need to use dissolve values of '50,100'. </p>
2041
2042<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002043 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002044</div>
2045
2046<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>
2047
2048<p>The <em class="arg">arguments</em> is a single string containing a list
2049of floating point numbers separated by commas or spaces. The number of
2050and meaning of the floating point values depends on the distortion <em
2051class="arg">method</em> being used. </p>
2052
2053<p>Choose from these distortion types:</p>
2054
2055<table class="doc">
2056 <tr valign="top">
2057 <th align="left" style="width: 8%">Method</th>
2058 <th align="left">Description</th>
2059 </tr>
2060
2061 <tr valign="top">
2062 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
2063 <br/>or &nbsp; <kbd>SRT</kbd></td>
2064 <td valign="top">
2065 Distort image by first scaling and rotating about a given 'center',
2066 before translating that 'center' to the new location, in that order. It
2067 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
2068 distortion, but without shearing effects. It also provides a good way
2069 of rotating and displacing a smaller image for tiling onto a larger
2070 background (IE 2-dimensional animations). <br/>
2071
2072 The number of arguments determine the specific meaning of each
2073 argument for the scales, rotation, and translation operations. <br/>
2074
2075 <table style="margin-left:auto; margin-right:auto;">
2076 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
2077 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
2078 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00002079 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002080 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
2081 <tr><td>5:</td>
2082 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2083 <tr><td>6:</td>
2084 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
2085 <tr><td>7:</td>
2086 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
2087 &nbsp; NewX,NewY</em></td></tr>
2088 </table>
2089
cristyd0bda5e2010-09-21 16:22:45 +00002090 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00002091 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2092
2093 <tr valign="top">
2094 <td valign="top"><kbd>Affine</kbd></td>
2095 <td valign="top">
2096 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002097 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002098 point values are given allowing the image to be linearly scaled,
2099 rotated, sheared, and translated, according to those three points. See
2100 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2101 distortions. <br/>
2102
2103 More than 3 sets given control point pairs (12 numbers) is least
2104 squares fitted to best match a lineary affine distortion. If only 2
2105 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002106 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002107 flipping or changes in aspect ratio to the resulting image. If only one
2108 control point pair is provides the image is only translated, (which may
2109 be a floating point non-integer translation). <br/>
2110
2111 This distortion does not include any form of perspective distortion.
2112 </td>
2113
2114 </tr>
2115
2116 <tr valign="top">
2117 <td valign="top"><kbd>AffineProjection</kbd></td>
2118 <td valign="top">
2119 Linearly distort an image using the given Affine Matrix of 6
2120 pre-calculated coefficients forming a set of Affine Equations to map
2121 the source image to the destination image.
2122
2123 <div style="text-align: center"><em>
2124 s<sub>x</sub>, r<sub>x</sub>,
2125 r<sub>y</sub>, s<sub>y</sub>,
2126 t<sub>x</sub>, t<sub>y</sub>
2127 </em></div>
2128
2129 See <a href="#affine" >-affine</a> setting for more detail, and
2130 meanings of these coefficients. <br/>
2131
2132 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002133 alternative methods of defining this distortion, with ImageMagick doing
2134 the calculations needed to generate the required coefficients. You can
2135 see the internally generated coefficients, by using a <a
2136 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002137
2138 </tr>
2139
cristy3ed852e2009-09-05 21:47:34 +00002140 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002141 <td valign="top"><kbd>BilinearForward</kbd><br/>
2142 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002143 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002144 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2145 16 values (see below). Not that lines may not appear straight after
2146 distortion, though the distance between coordinates will remain
2147 consistent. <br/>
2148
2149 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2150 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2151 quadrilateral to a rectangle, while preserving the straigth line edges
2152 in each case. <br/>
2153
2154 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2155 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2156 color setting. Also if the quadraterial becomes 'flipped' the image
2157 may dissappear. <br/>
2158
2159 There are future plans to produce a true Bilinear distortion that will
2160 attempt to map any quadrilateral to any other quadrilateral, while
2161 preserving edges (and edge distance ratios).
2162
2163 </td>
cristy3ed852e2009-09-05 21:47:34 +00002164 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002165
2166 <tr valign="top">
2167 <td valign="top"><kbd>Perspective</kbd></td>
2168 <td valign="top">
2169 Perspective distort the images, using a list of 4 or more sets of
2170 control points (as defined below). More that 4 sets (16 numbers) of
2171 control points provide least squares fitting for more accurate
2172 distortions (for the purposes of image registration and panarama
2173 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2174 linear distortion. <br/>
2175
2176 Perspective Distorted images ensures that straight lines remain
2177 straight, but the scale of the distorted image will vary. The horizon
2178 is anti-aliased, and the 'sky' color may be set using the
2179 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2180 </tr>
2181
2182 <tr valign="top">
2183 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2184 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002185 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002186 pre-calculated coefficients. You can get these coefficients by looking
2187 at the <a href="#verbose" >-verbose</a> output of a
2188 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2189 If the last two perspective scaling coefficients are zero, the
2190 remaining 6 represents a transposed 'Affine Matrix'. </td>
2191
2192 </tr>
2193
2194 <tr valign="top">
2195 <td valign="top"><kbd>Arc</kbd></td>
2196 <td valign="top">
2197 Arc the image (variation of polar mapping) over the angle given around
2198 a circle. <br/>
2199 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2200 <tr valign="top"><td>Argument</td>
2201 <td>Meaning</td></tr>
2202 <tr valign="top"><td><em>arc_angle</em></td>
2203 <td>The angle over which to arc the image side-to-side</td></tr>
2204 <tr valign="top"><td><em>rotate_angle</em></td>
2205 <td>Angle to rotate resulting image from vertical center</td></tr>
2206 <tr valign="top"><td><em>top_radius</em></td>
2207 <td>Set top edge of source image at this radius</td></tr>
2208 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2209 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2210 </table>
2211
2212 The resulting image is always resized to best fit the resulting image,
2213 (as if using <a href="#distort" >+distort</a>) while attempting to
2214 preserve scale and aspect ratio of the original image as much as
2215 possible with the arguments given by the user. All four arguments will
2216 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2217
2218 This a variation of a polar distortion designed to try to preserve the
2219 aspect ratio of the image rather than direct Cartesian to Polar
2220 conversion. </td>
2221 </tr>
2222
2223 <tr valign="top">
2224 <td valign="top"><kbd>Polar</kbd></td>
2225 <td valign="top">
2226 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2227 the image. that is the height of the input image is mapped to the
2228 radius limits, while the width is wrapped around between the
2229 angle limits. <br/>
2230
2231 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2232
2233 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2234 center to the center of the image, and the angles going from -180 (top)
2235 to +180 (top). If <em>Rmax</em> is given the special value of
2236 '<code>0</code>', the the distance from the center to the nearest edge
2237 is used for the radius of the output image, which will ensure the whole
2238 image is visible (though scaled smaller). However a special value of
2239 '<code>-1</code>' will use the distance from the center to the furthest
2240 corner, This may 'clip' the corners from the input rectangular image,
2241 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2242 the same arguments. <br/>
2243
2244 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2245 output image center will default to <code>0,0</code> of the virtual
2246 canvas, and the image size adjusted to ensure the whole input image is
2247 made visible in the output image on the virtual canvas. </td>
2248
2249 </tr>
2250
2251 <tr valign="top">
2252 <td valign="top"><kbd>DePolar</kbd></td>
2253 <td valign="top">
2254 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2255 but generates the reverse Polar to Cartesian distortion. <br/>
2256
2257 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2258 the corners of the input image. However using the special
2259 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2260 distance) will ensure the whole distorted image is preserved in the
2261 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2262 reverse the distortion re-producing the original.
2263
2264 Note that as this distortion requires the area resampling of a circular
2265 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002266 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002267 form of 'super-sampling' image processing technique be used to produce
2268 a high quality result. </td>
2269
2270 </tr>
2271
2272 <tr valign="top">
2273 <td valign="top"><kbd>Barrel</kbd></td>
2274 <td valign="top">
2275 Given the four coefficients (A,B,C,D) as defined by <a
cristy6bcf48e2011-02-15 19:09:04 +00002276 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002277 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002278 correct radial lens distortions. That is in photographs, make straight
2279 lines straight again. <br/>
2280
2281 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2282 <em>X</em> , <em>Y</em> ] ] <br/>
2283 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2284 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2285 [ <em>X</em> , <em>Y</em> ] <br/>
2286 So that it forms the function <br/>
2287 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2288 <em>C</em>*r + <em>D</em> )<br/>
2289
2290 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2291 (defaulting to the center of the image). <br/>
2292 The second form is typically used to distort images, rather than
2293 correct lens distortions. <br/>
2294 </td>
2295
2296 </tr>
2297
2298 <tr valign="top">
2299 <td valign="top"><kbd>BarrelInverse</kbd></td>
2300 <td valign="top">
2301 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2302 arguments, and argument handling. However it uses the inverse
2303 of the radial polynomial,
2304 so that it forms the function <br/>
2305 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002306 <em>C</em>*r + <em>D</em> )<br/>
2307 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2308 distortion, just a different barrel-like radial distortion method.
2309
cristy3ed852e2009-09-05 21:47:34 +00002310 </td>
2311 </tr>
2312
2313 <tr valign="top">
2314 <td valign="top"><kbd>Shepards</kbd></td>
2315 <td valign="top">
2316 Distort the given list control points (any number) using an Inverse
2317 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002318 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2319 Method</a>). The control points in effect do 'localized' displacement
2320 of the image around the given control point (preserving the look and
2321 the rotation of the area near the control points. For best results
2322 extra control points should be added to 'lock' the positions of the
2323 corners, edges and other unchanging parts of the image, to prevent
2324 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002325
cristyd0bd44a2010-09-24 12:38:11 +00002326 The distortion has been likened to 'taffy pulling' using nails, or
2327 pins' stuck in a block of 'jelly' which is then moved to the new
2328 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002329
cristybaacd172011-04-30 23:11:03 +00002330 Internally it is equivalent to generating a displacement map (see <a
cristyd0bd44a2010-09-24 12:38:11 +00002331 href="#displace" >-displace</a>) for source image color look-up using
2332 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2333
2334 </td>
cristy3ed852e2009-09-05 21:47:34 +00002335 </tr>
2336
2337</table>
2338
cristyd0bd44a2010-09-24 12:38:11 +00002339<p>To print a complete list of distortion methods, use <a href="#list">-list
2340distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002341
2342<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2343'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2344defining how these points in the given image should be distorted in the
2345destination image. Each set of four floating point values represent a source
2346image coordinate, followed immediately by the destination image coordinate.
2347This produces a list of values such as...</p>
2348<div style="text-align: center"><em>
2349 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2350 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2351 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2352 ... &nbsp;
2353 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2354</em></div>
2355<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2356destination image. </p>
2357
2358<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2359needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2360perspective distortion of the built-in "rose:" image. Note how spaces were
2361used to group the 4 sets of coordinate pairs, to make it easier to read and
2362understand.</p>
2363
2364<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002365convert rose: -virtual-pixel black \<br/>
2366 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2367 rose_3d_rotated.gif</span></p>
2368<p>If more that the required number of coordinate pairs are given for
2369a distortion, the distortion method is 'least squares' fitted to produce the
2370best result for all the coordinate pairs given. If less than the ideal number
2371of points are given, the distort will generally fall back to a simpler form of
2372distortion that can handles the smaller number of coordinates (usally a linear
2373'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002374
cristyd0bda5e2010-09-21 16:22:45 +00002375<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002376find matching coordinate pairs in overlapping images, so as to improve the
2377'fit' of the distortion. Of course a bad coordinate pair can also make the
2378'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002379
2380<p>Colors are acquired from the source image according to the <a
2381href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002382magnified. However if the viewed image is minified (image becomes smaller),
2383a special area resampling function (added ImageMagick v6.3.5-9), is used to
2384produce a higher quality image. For example you can use
2385a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2386the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002387
cristyd0bd44a2010-09-24 12:38:11 +00002388<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2389convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2390 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2391 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002392<p>Note that a infinitely tiled perspective images involving the horizon can
2393be very slow to generate due to the use of the high quality 'area resampling'
2394function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2395using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2396(recommended if you plan to use super-sampling instead). </p>
2397
2398<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2399'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2400will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2401pixels. If you do not what these pixels to be visible, set the color to match
2402the rest of the ground. </p>
2403
2404<p>The output image size will by default be the same as the input image. This
2405means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002406the 'distorted space', those parts is clipped and lost. However if you use
2407the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2408will attempt (if possible) to show the whole of the distorted image, while
2409retaining a correct 'virtual canvas' offset, for image layering. This offset
2410may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2411is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002412
2413<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2414option:distort:viewport {geometry_string}</kbd>" setting which will specify
2415the size and the offset of the generated 'viewport' image of the distorted
2416image space.</p>
2417
2418<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2419{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2420that factor without changing the viewed contents of the distorted image. This
2421can be used either for 'super-sampling' the image for a higher quality result,
2422or for panning and zooming around the image (with appropriate viewport
2423changes, or post-distort cropping and resizing). </p>
2424
2425<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2426href="#distort" >-distort</a> to attempt to output the internal coefficients,
2427and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2428and debugging purposes. This many not be available for all distorts. </p>
2429
2430<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2431produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2432and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002433above settings. It is algorithmically slower however, though that may not be
2434the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002435
2436
2437<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002438 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002439</div>
2440
2441<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>
2442
cristyd0bda5e2010-09-21 16:22:45 +00002443<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 +00002444
2445<p>Dithering is turned on by default, to turn it off use the plus form of the
2446setting, <a href="#dither">+dither</a>. This will also also render PostScript
2447without text or graphic aliasing. Disabling dithering often (but not always)
2448leads to faster process, a smaller number of colors, but more cartoon like
2449image coloring. Generally resulting in 'color banding' effects in areas with
2450color gradients. </p>
2451
2452<p>The color reduction operators <a href="#colors">-colors</a>, <a
2453href="#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>
2454
2455<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>
2456
2457
2458<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002459 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002460</div>
2461
2462<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>
2463
2464<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>
2465
2466<p>The shape primitives:</p>
2467
2468<pre class="text">
2469 point x,y
2470 line x0,y0 x1,y1
2471 rectangle x0,y0 x1,y1
2472 roundRectangle x0,y0 x1,y1 wc,hc
2473 arc x0,y0 x1,y1 a0,a1
2474 ellipse x0,y0 rx,ry a0,a1
2475 circle x0,y0 x1,y1
2476 polyline x0,y0 ... xn,yn
2477 polygon x0,y0 ... xn,yn
2478 bezier x0,y0 ... xn,yn
2479 path path specification
2480 image operator x0,y0 w,h filename
2481</pre>
2482
2483<p>The text primitive:</p>
2484
2485<pre class="text">
2486 text x0,y0 string
2487</pre>
2488<p>The text gravity primitive:</p>
2489
2490<pre class="text">
2491 gravity NorthWest, North, NorthEast, West, Center,
2492 East, SouthWest, South, or SouthEast
2493</pre>
2494
2495<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>
2496
2497<p>The transformation primitives:</p>
2498
2499<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002500 rotate degrees
2501 translate dx,dy
2502 scale sx,sy
2503 skewX degrees
2504 skewY degrees
cristy3ed852e2009-09-05 21:47:34 +00002505</pre>
2506
2507<p>The pixel operation primitives:</p>
2508
2509<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002510 color x0,y0 method
2511 matte x0,y0 method
cristy3ed852e2009-09-05 21:47:34 +00002512</pre>
2513
2514<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>
2515
2516<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>
2517
2518<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2519
2520<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2521
2522<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>
2523
2524<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2525
2526<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>
2527
2528<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>
2529
2530<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>.
2531</p>
2532
2533<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2534
2535<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2536
2537<p class="crtsnip">
2538 -draw 'circle 100,100 150,150'
2539</p>
2540
2541<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
2542draw 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>
2543
2544<p class="crtsnip">
2545 -draw 'bezier 20,50 45,100 45,0 70,50'
2546</p>
2547<p class="crtsnip">
2548 -draw 'bezier 70,50 95,100 95,0 120,50'
2549</p>
2550
2551
2552<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>
2553
2554<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>
2555
2556<p class="crtsnip">
2557 -draw 'image SrcOver 100,100 225,225 image.jpg'
2558</p>
2559
cristybc9539a2010-08-16 18:06:20 +00002560<p>You can use 0,0 for the image size, which means to use the actual
2561dimensions found in the image header. Otherwise, it is scaled to the given
2562dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
cristy29c5c992011-06-25 13:58:49 +00002563a detailed discussion of alpha composition methods that are available.
2564The "special augmented compose operators" such as "dissolve" that require
2565arguments cannot be used at present with the <kbd>-draw image</kbd> option.
2566 </p>
cristy3ed852e2009-09-05 21:47:34 +00002567<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>
2568
2569<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2570
2571<p class="crtsnip">
cristy4bf6e232011-05-21 01:43:33 +00002572 -draw "text 100,100 'Works like magick!' "
cristy3ed852e2009-09-05 21:47:34 +00002573</p>
2574
2575<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2576
2577<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>
2578
2579<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2580
2581<p>The <kbd>scale</kbd> primitive scales them.</p>
2582
2583<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>
2584
2585<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
2586matrix.</p>
2587
2588<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>
2589
2590<pre class="text">
2591 point
2592 replace
2593 floodfill
2594 filltoborder
2595 reset
2596</pre>
2597
2598<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>
2599
2600<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>
2601
2602<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>
2603
2604<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2605
2606<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2607
cristy2dcd6822011-06-13 16:21:20 +00002608
cristy8b9dd952011-03-21 22:56:18 +00002609<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00002610 <h4><a id="duplicate"></a>-duplicate <em class="arg">count,indexes</em></h4>
cristy8b9dd952011-03-21 22:56:18 +00002611</div>
2612
cristy323f35b2011-03-24 23:05:13 +00002613<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 +00002614
cristy323f35b2011-03-24 23:05:13 +00002615<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 +00002616
2617<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002618 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002619</div>
2620
2621<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>
2622
2623<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002624 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002625</div>
2626
2627<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>
2628
2629<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002630 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002631</div>
2632
2633<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>
2634
2635<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2636
2637<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2638
cristyd0bda5e2010-09-21 16:22:45 +00002639
2640
cristy3ed852e2009-09-05 21:47:34 +00002641<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002642 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002643</div>
2644
2645<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>
2646
2647<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>
2648
2649<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002650 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002651</div>
2652
2653<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>
2654
2655<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2656
2657<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2658
2659
2660<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002661 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002662</div>
2663
2664<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>
2665
2666
2667<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002668 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002669</div>
2670
2671<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>
2672
2673<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>
2674
2675<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2676
2677<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>
2678
2679<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002680 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002681</div>
2682
2683<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>
2684
2685<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>
2686
2687<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>
2688
2689<table class="doc">
2690 <col width="25%" />
2691 <col width="75%" />
2692 <thead>
2693 <tr>
2694 <th><em class="arg">operator</em></th>
2695 <th>Summary (see further below for details)</th>
2696 </tr>
2697 </thead>
2698 <tbody>
2699
cristy3c98a4f2010-08-13 20:09:41 +00002700 <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 +00002701 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2702 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2703 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2704 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2705 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002706 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2707 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002708 <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>
2709 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2710 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002711 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002712 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002713 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2714 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2715 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2716 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2717 <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>
2718 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2719 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2720 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2721 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2722
2723 <tr><td>&nbsp;</td></tr>
2724
2725 <tr><td>Gaussian-noise</td></tr>
2726 <tr><td>Impulse-noise</td></tr>
2727 <tr><td>Laplacian-noise</td></tr>
2728 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2729 <tr><td>PoissonNoise</td></tr>
2730 <tr><td>Uniform-noise</td></tr>
2731
2732 <tr><td>&nbsp;</td></tr>
2733
2734 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2735 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2736 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2737 </tbody>
2738 </table>
2739
2740<p>The specified functions are applied only to each previously set <a
2741href="#channel" >-channel</a> in the image. If necessary, the results of the
2742calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2743class="QR">QuantumRange</em>]. The transparency channel of the image is
2744represented as a 'alpha' values (0 = fully transparent), so, for example, a
2745<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2746semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2747as a percentage of the <em class="QR">QuantumRange</em>.</p>
2748
2749<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2750<a href="#list">-list evaluate</a>.</p>
2751
2752<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2753<kbd>Multiply</kbd> methods can also be achieved using either the <a
2754href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2755appropriate argument, to linearly modify the overall range of color values.
2756Please note, however, that <a href="#level" >-level</a> treats transparency as
2757'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2758'alpha' values.</p>
2759
2760<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>
2761
cristyce66ab12010-10-21 23:36:32 +00002762<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>
2763
2764 <div style="text-align:center;">
2765 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2766 </div>
2767
2768<p> If the input image is squared, for example, using <a
2769href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2770
cristy3ed852e2009-09-05 21:47:34 +00002771<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>
2772
2773 <div style="text-align:center;">
2774 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2775 </div>
2776
2777<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2778normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2779href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2780to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2781with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2782with <kbd>Pow</kbd>.</p>
2783
2784<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2785converts the image values into a value according to a (co)sine wave function.
2786The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2787is biased 50% and normalized by 50% so as to fit in the respective color value
2788range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2789function (its frequency), and thus determines the number of 'waves' that will
2790be generated over the input color range. For example, if the <em
2791class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2792class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2793then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002794class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002795
2796 <div style="text-align:center;">
2797 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2798 </div>
2799
cristydcca3fa2010-12-29 21:50:07 +00002800<p>See also the <a href="#function" >-function</a> operator, which is a
2801multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002802
cristy63fed272010-03-07 19:08:45 +00002803<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002804 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002805</div>
2806
2807<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 +00002808
2809<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002810 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002811</div>
2812
2813<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>
2814
cristy3e2860c2010-01-24 01:36:30 +00002815<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 +00002816<p>This command reduces or expands a JPEG image to fit on an 800x600
2817display. If the aspect ratio of the input image isn't exactly 4:3, then the
2818image is centered on an 800x600 black canvas: </p>
2819
2820<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>
2821
cristy3ed852e2009-09-05 21:47:34 +00002822
2823<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>
2824
2825<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002826 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002827</div>
2828
2829<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>
2830
2831<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2832
cristy4949d522010-03-12 18:41:34 +00002833<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 +00002834
cristy4949d522010-03-12 18:41:34 +00002835<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 +00002836<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002837equivalent to:</p>
2838
2839<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>
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="family"></a>-family <em class="arg">fontFamily</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%'>Set a font family for text.</td><td style='text-align:right;'></td></tr></table>
2847
2848<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).
2849</p>
2850
2851<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>.
2852</p>
2853
2854<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002855 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002856</div>
2857
2858<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>
2859
2860<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002861 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002862</div>
2863
2864<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>
2865
cristydcca3fa2010-12-29 21:50:07 +00002866<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 +00002867
cristydcca3fa2010-12-29 21:50:07 +00002868<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 +00002869
2870<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>
2871
2872<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2873<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>
2874
2875<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2876<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>
2877
cristyd0bd44a2010-09-24 12:38:11 +00002878<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 +00002879
2880<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>
2881
2882<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2883 -evaluate log 1000 fft_image_spectrum.png</span></p>
2884<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>
2885
cristydcca3fa2010-12-29 21:50:07 +00002886<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 +00002887
2888<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>
2889
2890<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>
2891
cristydcca3fa2010-12-29 21:50:07 +00002892<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 +00002893
2894<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +00002895<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 +00002896</p>
2897
2898
2899<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002900 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002901</div>
2902
2903<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>
2904
2905<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>
2906
2907<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2908
2909<p>For example,</p>
2910
2911<p class="crtsnip">
2912 -fill blue
2913</p>
2914<p class="crtsnip">
2915 -fill "#ddddff"
2916</p>
2917<p class="crtsnip">
2918 -fill "rgb(255,255,255)"
2919</p>
2920
2921<p>See <a href="#draw">-draw</a> for further details.</p>
2922
2923<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2924
2925<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002926 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002927</div>
2928
cristyd0bda5e2010-09-21 16:22:45 +00002929<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
2930distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002931
cristyd0bda5e2010-09-21 16:22:45 +00002932<p>Use this option to affect the resizing operation of an image during
2933operations such as <a href="#resize">-resize</a> and <a href="#distort"
2934>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002935
2936<pre class="text">
2937 Point Hermite Cubic
2938 Box Gaussian Catrom
2939 Triangle Quadratic Mitchell
2940</pre>
2941
cristyd0bda5e2010-09-21 16:22:45 +00002942<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002943as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2944generally useless on their own as they are infinite filters that are being
2945clipped to the filters support size. Their direct use is not recommended
2946except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002947
cristydcca3fa2010-12-29 21:50:07 +00002948<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002949function that the <a href="#filter" >-filter</a> setting defines. That is
2950using these functions will define a 'Windowed' filter, appropriate to the
2951operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002952
2953<pre class="text">
2954 Lanczos Hamming Parzen
2955 Blackman Kaiser Welsh
2956 Hanning Bartlett Bohman
2957</pre>
2958
2959<p>Also one special self-windowing filter is also provided
2960<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2961on the current 'support' or 'lobes' expert settings (see below).</p>
2962
cristyd0bda5e2010-09-21 16:22:45 +00002963<p>If you do not select a filter with this option, the filter defaults to
2964<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2965if the image is enlarged. Otherwise the filter default to
2966<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002967
cristyd0bda5e2010-09-21 16:22:45 +00002968<p>To print a complete list of resize filters, use the <a href="#list">-list
2969filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002970
2971<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002972use of these expert settings (see also <a href="#define" >-define</a> and <a
2973href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002974
2975<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002976<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002977<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002978 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2979 Gaussian-like filters simple filters, or you may not get the expected
2980 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002981
cristyd0bda5e2010-09-21 16:22:45 +00002982<dt>-define filter:support=<em>radius</em></dt>
2983<dd>Set the filter support radius. Defines how large the filter should be and
2984 thus directly defines how slow the filtered resampling process is. All
2985 filters have a default 'prefered' support size. Some filters like
2986 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2987 this value. With simple filters this value either does nothing (but slow
2988 the resampling), or will clip the filter function in a detrimental way.
2989 </dd>
cristy3ed852e2009-09-05 21:47:34 +00002990
cristyd0bda5e2010-09-21 16:22:45 +00002991<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002992<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00002993 alternative way of specifying the 'support' range of the filter, that is
2994 designed to be more suited to windowed filters, especially when used for
2995 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002996
cristyd0bda5e2010-09-21 16:22:45 +00002997<dt>-define filter:b=<em>b-spline_factor</em></dt>
2998<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002999<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
3000 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
3001 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
3002 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00003003 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00003004 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003005
cristyd0bda5e2010-09-21 16:22:45 +00003006<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003007<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00003008 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00003009 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00003010 'Bessel' functions. If defined, no windowing function is used, unless the
3011 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003012
cristyd0bda5e2010-09-21 16:22:45 +00003013<dt>-define filter:window=<em>filter_function</em></dt>
3014<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
3015 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
3016 support range) with the given filter. This allows you to specify a filter
3017 function that is not normally used as a windowing function, such as
3018 <kbd>Box</kbd>, (which effectively turns off the windowing function),
3019 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
3020 </dd>
3021
3022<dt>-define filter:verbose=<em>1</em></dt>
3023<dd>This causes IM to print information on the final internal filter
3024 selection to standard output. This includes a commented header on the
3025 filter settings being used, and data allowing the filter weights to be
3026 easily graphed. </dd>
3027
3028<dd>Note however that some filters are internally defined in terms of other
3029 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
3030 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
3031 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
3032 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00003033
3034</dl>
3035
cristyd0bda5e2010-09-21 16:22:45 +00003036<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00003037
3038<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
3039 -set filter:window=bessel -set filter:lobes=8 \ <br/>
3040 -resize 150% image.jpg</span></p>
3041<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3042
3043<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
3044 -resize 150% image.jpg</span></p>
3045<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00003046filters, and 'verbose' for viewing the internal filter selection), are
3047provided for image processing experts who have studied and understood how
3048resize filters work. Without this knowledge, and an understanding of the
3049definition of the actual filters involved, using expert settings are more
3050likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00003051
3052
3053<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003054 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00003055</div>
3056
3057<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>
3058
3059
3060<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003061 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00003062</div>
3063
3064<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>
3065
cristy2dcd6822011-06-13 16:21:20 +00003066<p>reflect the scanlines in the vertical direction. The image will be mirrored
3067upside-down. </p>
3068
cristy3ed852e2009-09-05 21:47:34 +00003069
3070<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003071 <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 +00003072</div>
3073
cristy2dcd6822011-06-13 16:21:20 +00003074<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>
3075
3076<p>Flood fill starts from the given 'seed point' which is not gravity effected.
3077Any color that matches within <a href="#fuzz" >-fuzz</a> color distance of the
3078given <em class="arg">color</em> argument, connected to that 'seed point'
3079will be replaced with the current <a href="#fill" >-fill</a> color. </p>
3080
3081<p>Note that if the pixel at the 'seed point' does not itself match the given
3082<em class="arg">color</em> (according to <a href="#fuzz" >-fuzz</a>), then no
3083action will be taken. </p>
3084
3085<p>This operator works more like the <a href="#opaque" >-opaque</A> option, than
3086a 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>
3087
cristy3ed852e2009-09-05 21:47:34 +00003088
3089<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003090 <h4><a id="flop"></a>-flop</h4>
cristy3ed852e2009-09-05 21:47:34 +00003091</div>
3092
3093<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>
3094
cristy2dcd6822011-06-13 16:21:20 +00003095<p>Reflect the scanlines in the horizontal direction, just like the image in
3096a vertical mirror. </p>
cristy3ed852e2009-09-05 21:47:34 +00003097
3098
3099<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003100 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003101</div>
3102
3103<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>
3104
3105<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>
3106
3107<p>In addition to the fonts specified by the above pre-defined list, you can
3108also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
3109is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
3110<kbd>x:fixed</kbd> is X11 font.</p>
3111
3112<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>
3113
3114
3115<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003116 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003117</div>
3118
3119<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>
3120
3121<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3122
3123<p>The default foreground color is black.</p>
3124
3125<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003126 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003127</div>
3128
3129<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>
3130
cristy47774982011-02-15 15:17:19 +00003131<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 +00003132
3133<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>
3134
3135<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003136 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003137</div>
3138
3139<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>
3140
3141<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>
3142
3143<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003144 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003145</div>
3146
3147<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>
3148
cristybc9539a2010-08-16 18:06:20 +00003149<p>The color of the border is specified with the <a href="#mattecolor"
3150>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003151
cristybc9539a2010-08-16 18:06:20 +00003152<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
3153class="arg">geometry</em> argument indicates the amount of extra width and
3154height that is added to the dimensions of the image. If no offsets are given
3155in the <em class="arg">geometry</em> argument, then the border added is
3156a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3157the width and height of the border is partitioned to form an outer bevel of
3158thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3159<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3160</p>
3161
3162<p>The <a href="#frame">-frame</a> option is affected by the current <a
3163href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003164'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003165size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3166draws the frame of four distinct colors close to the current <a
3167href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3168center of this image. This means that with the default compose method of
3169'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3170href="#bordercolor">-bordercolor</a> setting.</p>
3171
3172<p>The image composition is not
3173affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003174
3175
3176<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003177 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003178</div>
3179
3180<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>
3181
3182<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003183 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003184</div>
3185
3186<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>
3187
3188<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>
3189
3190<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>
3191
3192<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>
3193
3194<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003195 Polynomial
3196 Sinusoid
3197 Arcsin
3198 Arctan
cristy3ed852e2009-09-05 21:47:34 +00003199</pre>
3200
3201<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3202
3203<dl class="doc">
3204<dt><kbd>Polynomial</kbd></dt>
3205<dd>
3206<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>
3207
3208<div style="text-align: center">
3209 -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>
3210</div>
3211
3212<p>will invoke a polynomial function given by</p>
3213
3214<div style="text-align: center">
3215 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3216 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3217 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3218</div>
3219
3220<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3221
3222<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>
3223
3224<table class="doc">
3225 <col width="35%" />
3226 <col width="35%" />
3227 <col width="30%" />
3228 <tr>
3229 <td>-evaluate Set <em class="arg">value</em> </td>
3230 <td>-function Polynomial <em class="arg">value</em></td>
3231 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3232 </tr>
3233 <tr>
3234 <td>-evaluate Add <em class="arg">value</em> </td>
3235 <td>-function Polynomial 1,<em class="arg">value</em></td>
3236 </tr>
3237 <tr>
3238 <td>-evaluate Subtract <em class="arg">value</em> </td>
3239 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3240 </tr>
3241 <tr>
3242 <td>-evaluate Multiply <em class="arg">value</em> </td>
3243 <td>-function Polynomial <em class="arg">value</em>,0</td>
3244 </tr>
3245 <tr>
3246 <td>+level black% x white%</td>
3247 <td>-function Polynomial A,B</td>
3248 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3249 </tr>
3250</table>
3251
3252<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>
3253</dd>
3254
3255<dt><kbd>Sinusoid</kbd></dt>
3256<dd>
3257<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>
3258
3259<div style="text-align: center">
3260 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3261</div>
3262
3263<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>
3264
3265<div style="text-align: center">
3266<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>
3267</div>
3268
3269<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>
3270
3271<p class="crtsnip">
3272 -function Sinusoid 3,-90,.2,.7
3273</p>
3274
3275<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>
3276
3277<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>
3278
3279<table class="doc">
3280 <tr>
3281 <td>-evaluate Sin <em class="arg">freq</em> </td>
3282 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3283 </tr>
3284 <tr>
3285 <td>-evaluate Cos <em class="arg">freq</em> </td>
3286 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3287 </tr>
3288</table>
3289</dd>
3290
3291<dt><kbd>ArcSin</kbd></dt>
3292<dd>
3293<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3294and can be used to generate cylindrical distortion and displacement maps.
3295The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003296of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003297
cristydcca3fa2010-12-29 21:50:07 +00003298<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003299 -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 +00003300</p>
cristy3ed852e2009-09-05 21:47:34 +00003301
3302<p>with all values given in terms of noramlize color values (0.0 for black,
33031.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3304for bout input (<em class="arg">width</em>), and output (<em
3305class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3306
cristydcca3fa2010-12-29 21:50:07 +00003307<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003308<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 +00003309</p>
cristy3ed852e2009-09-05 21:47:34 +00003310
3311</dd>
3312
3313<dt><kbd>ArcTan</kbd></dt>
3314<dd>
3315<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3316limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003317All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003318
cristydcca3fa2010-12-29 21:50:07 +00003319<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003320 -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 +00003321</p>
cristy3ed852e2009-09-05 21:47:34 +00003322
3323<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3324</p>
3325
cristydcca3fa2010-12-29 21:50:07 +00003326<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003327<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 +00003328</p>
cristy3ed852e2009-09-05 21:47:34 +00003329
3330</dd>
3331
3332</dl>
3333
3334
3335<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003336 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003337</div>
3338
3339<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>
3340
3341<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>
3342
3343<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>
3344
3345
3346<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003347 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003348</div>
3349
3350<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>
3351
3352<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>
3353
3354<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3355
3356
3357<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003358 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003359</div>
3360
3361<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>
3362
3363<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>
3364
3365<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>
3366
3367<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>
3368
3369<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>
3370
3371<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3372
3373<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003374 <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 +00003375</div>
3376
3377<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>
3378
cristyb15553d2010-07-03 22:53:14 +00003379<p>Convolve the image with a Gaussian or normal distribution using the given
3380<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003381
3382<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3383</div>
3384
cristyb15553d2010-07-03 22:53:14 +00003385<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003386determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003387
3388<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003389array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003390integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003391radius that will provide meaningful results for the Gaussian distribution.
3392</p>
3393
3394<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3395operation is. However too small a <em class="arg" >Radius</em>, and sever
3396aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3397should be at least twice the <em class="arg" >Sigma</em> value, though three
3398times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003399
3400<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003401full 2-dimensional convolution is used to generate the weighted average of the
3402neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003403
3404<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3405pixels which are outside the image proper are blurred into the final result.
3406</p>
3407
3408
3409<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003410 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003411</div>
3412
3413<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>
3414
3415<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>
3416
3417<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003418 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003419</div>
3420
3421<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>
3422
3423<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3424<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3425<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3426list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3427installation.</p>
3428
3429<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>
3430
3431<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>
3432
3433<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>
3434
cristy4949d522010-03-12 18:41:34 +00003435<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 +00003436<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>
3437
3438<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>
3439
3440
3441<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003442 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003443</div>
3444
3445<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>
3446
3447
3448<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003449 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003450</div>
3451
3452<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>
3453
3454<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3455dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3456can apply any color transformation to the Hald image and then use this option
3457to apply the transform to the image. </p>
3458
3459<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3460<p>This option provides a convenient method for you to use Gimp or Photoshop
3461to make color corrections to the Hald CLUT image and subsequently apply them
3462to multiple images using an ImageMagick script. </p>
3463
3464<p>Note that the representation is only of the normal RGB color space and that
3465the whole color value triplet is used for the interpolated lookup of the
3466represented Hald color cube image. Because of this the operation is not <a
3467href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3468images transparency or alpha/matte channel.</p>
3469
3470<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3471of the individual color channels, usally involving a simplier gray-scale
3472image. E.g: gray-scale to color replacement, or modification by a histogram
3473mapping. </p>
3474
3475
3476<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003477 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003478</div>
3479
3480<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>
3481
3482<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003483 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003484</div>
3485
3486<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>
3487
3488<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003489 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003490</div>
3491
3492<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the icon geometry.</td><td style='text-align:right;'></td></tr></table>
3493
3494<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>
3495
3496<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>
3497
3498<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003499 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003500</div>
3501
3502<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>
3503
3504<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003505 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003506</div>
3507
3508<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>
3509
3510<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>
3511
cristy47774982011-02-15 15:17:19 +00003512<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 +00003513
cristyd0bda5e2010-09-21 16:22:45 +00003514<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003515amounts of image properties are displayed including image statistics, profiles,
3516image histogram, and others.</p>
3517
3518<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003519 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003520</div>
3521
3522<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>
3523
cristydcca3fa2010-12-29 21:50:07 +00003524<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 +00003525
3526<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>
3527
3528<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3529<p>or</p>
3530
3531<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>
3532
cristydcca3fa2010-12-29 21:50:07 +00003533<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 +00003534
cristydcca3fa2010-12-29 21:50:07 +00003535<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 +00003536
cristydcca3fa2010-12-29 21:50:07 +00003537<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 +00003538
3539<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003540 <h4><a id="immutable"></a>-immutable</h4>
cristy3ed852e2009-09-05 21:47:34 +00003541</div>
3542
3543<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>
3544
3545<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003546 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003547</div>
3548
3549<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>
3550
3551<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003552 <h4><a id="insert"></a>-insert <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003553</div>
3554
3555<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>
3556
3557<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>
3558
3559<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>
3560
3561<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003562 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003563</div>
3564
3565<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>
3566
3567<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>
3568
3569<p>The default intent is undefined.</p>
3570
3571<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3572
3573<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003574 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003575</div>
3576
3577<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>
3578
3579<p>Choose from:</p>
3580
3581<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003582 none
3583 line
3584 plane
3585 partition
3586 JPEG
3587 GIF
3588 PNG
cristy3ed852e2009-09-05 21:47:34 +00003589</pre>
3590
3591<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>
3592
3593<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3594
3595<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3596
3597<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3598
3599<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3600image.G, and image.B).</p>
3601
3602<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>
3603image.</p>
3604
3605<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3606
3607<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003608 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003609</div>
3610
3611<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>
3612
cristyd0bda5e2010-09-21 16:22:45 +00003613<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003614value, you typically fall in between the pixel colors defined by the source
3615image. This setting determines how the color is determined from the colors of
3616the pixels surrounding that point. That is how to determine the color of a
3617point that falls between two, or even four different colored pixels. </p>
3618
3619<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003620 integer The color of the top-left pixel (floor function)
3621 nearest-neighbor The nearest pixel to the lookup point (rounded function)
3622 average The average color of the surrounding four pixels
3623 bilinear A double linear interpolation of pixels (the default)
3624 mesh Divide area into two flat triangular interpolations
3625 bicubic Fitted bicubic-spines of surrounding 16 pixels
3626 spline Direct spline curves (colors are blurred)
3627 filter Use resize <a href="#filter">-filter</a> settings
cristy3ed852e2009-09-05 21:47:34 +00003628</pre>
3629
3630<p>This most important for distortion operators such as <a href="#distort"
3631>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3632>-transform</a> and <a href="#fx" >-fx</a>. </p>
3633
3634<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3635
3636<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3637lookup for positions outside the boundaries of the image. </p>
3638
3639
3640<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003641 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003642</div>
3643
3644<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>
3645
3646<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003647 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003648</div>
3649
3650<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>
3651
3652<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003653 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003654</div>
3655
3656<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>
3657
3658<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003659 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003660</div>
3661
3662<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>
3663
cristy71a3f602010-09-15 12:38:16 +00003664<p>Use this option to assign a specific label to the image, as it is read in
3665or created. You can use the <a href="#set" >-set</a> operation to re-assign
3666a the labels of images already read in. Image formats such as TIFF, PNG,
3667MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003668
cristy71a3f602010-09-15 12:38:16 +00003669<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3670assigned to an image is used as a header string to print above the postscript
3671image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003672
cristybc9539a2010-08-16 18:06:20 +00003673<p>You can include the image filename, type, width, height, or other image
3674attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3675Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003676
3677<p>For example,</p>
3678
3679<p class="crtsnip">
3680 -label "%m:%f %wx%h" bird.miff
3681</p>
3682
cristy71a3f602010-09-15 12:38:16 +00003683<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3684"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3685is read in. If a <a href="#label">+label</a> option was used instead, any
3686existing label present in the image would be used. You can remove all labels
3687from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003688
cristy71a3f602010-09-15 12:38:16 +00003689<p>A label is not drawn on the image, but is embedded in the image datastream
3690via <em>Label</em> tag or similar mechanism. If you want the label to be
3691visible on the image itself, use the <a href="#draw">-draw</a> option, or
3692during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003693
cristy71a3f602010-09-15 12:38:16 +00003694<p>If the first character of <em class="arg">string</em> is <em
3695class="arg">@</em>, the image label is read from a file titled by the
3696remaining characters in the string. Labels in a file are literal, no embedded
3697formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003698
3699
3700<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003701 <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 +00003702</div>
3703
3704<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>
3705
3706<p>Adaptively threshold each pixel based on the value of pixels in a
3707surrounding window. If the current pixel is lighter than this average plus
3708the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3709black. Small variations in pixel values such as found in scanned documents
3710can be ignored if offset is positive. A negative offset will make it more
3711sensitive to those small variations. </p>
3712
3713<p>This is commonly used to threshold images with an uneven background. It is
3714based on the assumption that average color of the small window is the
3715the local background color, from which to separate the forground color. </p>
3716
3717
3718<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003719 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003720</div>
3721
3722<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>
3723
3724<p>Perform various image operation methods to a ordered sequence of images
3725which may represent either a set of overlaid 'image layers', a GIF disposal
3726animation, or a fully-'coalesced' animation sequence. </p>
3727
3728<table class="doc">
3729 <tbody>
3730 <tr valign="top">
3731 <th align="left" style="width: 8%">Method</th>
3732 <th align="left">Description</th>
3733 </tr>
3734
3735 <tr valign="top">
3736 <td valign="top">compare-any</td>
3737 <td valign="top">Crop the second and later frames to the smallest rectangle
3738 that contains all the differences between the two images. No GIF <a
3739 href="#dispose" >-dispose</a> methods are taken into account. </td>
3740 </tr>
3741
3742 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3743 >-deconstruct</a> operator, and does not preserve animations normal
3744 working, especially when animation used layer disposal methods such as
3745 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3746 </tr>
3747
3748 <tr valign="top">
3749 <td valign="top">compare-clear</td>
3750 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3751 opaque pixels which become transparent in the second frame. That is the
3752 smallest image needed to mask or erase pixels for the next frame. </td>
3753 </tr>
3754
3755 <tr valign="top">
3756 <td valign="top">compare-overlay</td>
3757 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3758 extra color to the next image, as a result of overlaying color pixels.
3759 That is the smallest single overlaid image to add or change colors. </td>
3760 </tr>
3761
3762 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3763 composition method '<kbd>change-mask</kbd>', to reduce the image to
3764 just the pixels that need to be overlaid. </td>
3765 </tr>
3766
3767 <tr valign="top">
3768 <td valign="top">coalesce</td>
3769 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3770 >-coalesce</a> operator. Apply the layer disposal methods set in the
3771 current image sequence to form a fully defined animation sequence, as
3772 it should be displayed. Effectively converting a GIF animation into a
3773 'film strip'-like animation. </td>
3774 </tr>
3775
3776 <tr valign="top">
3777 <td valign="top">composite</td>
3778 <td valign="top">Alpha Composition of two image lists, separated by a
3779 "<kbd>null:</kbd>" image, with the destination image list first, and
3780 the source images last. An image from each list are composited
3781 together until one list is finished. The separator image and source
3782 image lists are removed. </td>
3783 </tr>
3784
3785
cristybac7a162010-06-15 19:57:29 +00003786 <tr><td></td>
3787 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3788 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3789 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003790 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003791 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003792
cristybac7a162010-06-15 19:57:29 +00003793 <tr><td></td>
3794 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003795 applied to all the images in the other image list, regardless of which
3796 list it is. In this case it is the image meta-data of the list which
3797 preserved. </td>
3798 </tr>
3799
3800
3801 <tr valign="top">
3802 <td valign="top">dispose</td>
3803 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3804 the animation after the layer disposal method has been applied, before
3805 the next sub-frame image is overlaid. That is the 'dispose' image that
3806 results from the application of the GIF <a href="#dispose"
3807 >-dispose</a> method. This allows you to check what
3808 is going wrong with a particular animation you may be developing.
3809 </td>
3810 </tr>
3811
3812 <tr valign="top">
3813 <td valign="top">flatten</td>
3814 <td valign="top">Create a canvas the size of the first images virtual
3815 canvas using the current <a href="#background" >-background</a> color,
3816 and <a href="#compose" >-compose</a> each image in turn onto that
3817 canvas. Images falling outside that canvas is clipped. Final
3818 image will have a zero virtual canvas offset. </td>
3819 </tr>
3820
cristybac7a162010-06-15 19:57:29 +00003821 <tr><td></td>
3822 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003823 overlaying all the prepared image layers into a final image. </td>
3824 </tr>
3825
cristybac7a162010-06-15 19:57:29 +00003826 <tr><td></td>
3827 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003828 canvas with real pixels, or to underlay a opaque color to remove
3829 transparency from an image.</td>
3830 </tr>
3831
3832
3833 <tr valign="top">
3834 <td valign="top">merge</td>
3835 <td valign="top">As 'flatten' method but merging all the given image
cristy10549a12011-05-15 19:04:46 +00003836 layers to create a new layer image just large enough to hold all the
3837 image without clipping or extra space. The new images virtual offset
3838 will preserve the position of the new layer, even if this offset is
3839 negative. The virtual canvas size of the first image is preserved.
cristy3ed852e2009-09-05 21:47:34 +00003840 </td>
cristy10549a12011-05-15 19:04:46 +00003841 </tr>
cristy3ed852e2009-09-05 21:47:34 +00003842
cristy10549a12011-05-15 19:04:46 +00003843 <tr><td></td><td>Caution is advised when handling image layers with
3844 negative offsets as few image file formats handle them correctly.
3845 Following this operation methd with <a href="#repage" >+repage</a>
3846 will remove the layer offset, and create a image in which all the
3847 overlaid image positions relative to each other is preserved, though
3848 not nessaraily exactly where you specified them.
3849 </td>
3850 </tr>
3851
3852 <tr><td></td><td>See also 'trim-bounds' below whcih is closely related but
3853 without doing the'flatten' to merge the images together. </td>
cristy3ed852e2009-09-05 21:47:34 +00003854 </tr>
3855
3856 <tr valign="top">
3857 <td valign="top">mosaic</td>
3858 <td valign="top">As 'flatten' method but expanding the initial canvas size
cristy10549a12011-05-15 19:04:46 +00003859 of the first image in a positive direction only so as to hold all the
3860 image layers. However as a virtual canvas is 'locked' to the origin,
3861 by its own definition, image layers with a negative offsets will still
3862 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
3863 if this could be a problem. </td>
3864
cristy3ed852e2009-09-05 21:47:34 +00003865 </tr>
3866
cristy10549a12011-05-15 19:04:46 +00003867 <tr><td></td><td>This method is commonly used to layout individual image
3868 using various offset but without knowing the final canvas size. The
3869 resulting image will, like 'flatten' not have any virtual offset, so
3870 can be saved to any image file format. </td>
cristy3ed852e2009-09-05 21:47:34 +00003871 </tr>
3872
3873
3874 <tr valign="top">
3875 <td valign="top">optimize</td>
3876 <td valign="top">Optimize a coalesced animation, into GIF animation using
3877 a number of general techniques. This currently a short cut to
3878 apply both the '<kbd>optimize-frame</kbd>', and
3879 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3880 include other optimization methods as they are developed. </td>
3881 </tr>
3882
3883 <tr valign="top">
3884 <td valign="top">optimize-frame</td>
3885 <td valign="top">Optimize a coalesced animation, into GIF animation by
3886 reducing the number of pixels per frame as much as possible by
3887 attempting to pick the best layer disposal method to use, while ensuring
3888 the result will continue to animate properly. </td>
3889 </tr>
3890
cristy10549a12011-05-15 19:04:46 +00003891 <tr><td></td><td> There is no guarantee that the best optimization is found.
3892 But then no reasonably fast GIF optimization algorithm can do this.
cristy3ed852e2009-09-05 21:47:34 +00003893 However this does seem to do better than most other GIF frame
3894 optimizers seen. </td>
3895 </tr>
3896
3897 <tr valign="top">
3898 <td valign="top">optimize-plus</td>
3899 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3900 overall optimization by adding extra frames to the animation, without
3901 changing the final look or timing of the animation. The frames are
3902 added to attempt to separate the clearing of pixels from the
3903 overlaying of new additional pixels from one animation frame to the
3904 next. If this does not improve the optimization (for the next frame
3905 only), it will fall back to the results of the previous normal
3906 '<kbd>optimize-frame</kbd>' technique. </td>
3907 </tr>
3908
cristy10549a12011-05-15 19:04:46 +00003909 <tr><td></td><td>There is the possibility that the change in the disposal
3910 style will result in a worsening in the optimization of later frames,
3911 though this is unlikely. In other words there no guarantee that it is
3912 better than the normal '<kbd>optimize-frame</kbd>' technique. For some
3913 animations however you can get a vast improvement in the final
3914 animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003915 </tr>
3916
3917 <tr valign="top">
3918 <td valign="top">optimize-transparency</td>
3919 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3920 overlay images with transparency, if it does not change the resulting
3921 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3922 </td>
3923 </tr>
3924
cristy10549a12011-05-15 19:04:46 +00003925 <tr><td></td><td>This should allow a existing frame optimized GIF animation
3926 to compress into a smaller file size due to larger areas of one
3927 (transparent) color rather than a pattern of multiple colors repeating
3928 the current disposed image of the last frame. </td>
cristy3ed852e2009-09-05 21:47:34 +00003929 </tr>
3930
3931 <tr valign="top">
3932 <td valign="top">remove-dups</td>
3933 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3934 images, so as to simplify layer overlays of coalesced animations.
3935 </td>
3936 </tr>
3937
cristy10549a12011-05-15 19:04:46 +00003938 <tr><td></td><td>Usually this a result of using a constant time delay
3939 across the whole animation, or after a larger animation was split into
3940 smaller sub-animations. The duplicate frames could also have been
3941 used as part of some frame optimization methods. </td>
cristy3ed852e2009-09-05 21:47:34 +00003942 </tr>
3943
3944 <tr valign="top">
3945 <td valign="top">remove-zero</td>
3946 <td valign="top">Remove any image with a zero time delay, unless ALL the
3947 images have a zero time delay (and is not a proper timed animation, a
3948 warning is then issued). </td>
3949 </tr>
3950
cristy10549a12011-05-15 19:04:46 +00003951 <tr><td></td><td>In a GIF animation, such images are usually frames which
3952 provide partial intermediary updates between the frames that are
3953 actually displayed to users. These frames are usally added for
3954 improved frame optimization in GIF animations. </td>
cristy3ed852e2009-09-05 21:47:34 +00003955 </tr>
3956
3957 <tr valign="top">
3958 <td valign="top">trim-bounds</td>
3959 <td valign="top">Find the bounds of all the images in the current
3960 image sequence, then adjust the offsets so all images are contained on
cristy10549a12011-05-15 19:04:46 +00003961 a minimal positive canvas. None of the image data is modified or
3962 merged, only the individual image virtual canvas size and offset.
3963 All the images is given the same canvas size, and and will have
3964 a positive offset, but will remain in the same position relative to
3965 each other. As a result of the minimal canvas size at least one image
3966 will touch every edge of that canvas. The image data touching those
3967 edges however may be transparent. </td>
3968 </tr>
3969
3970 <tr><td></td><td>The result is much like if you used 'merge' followed by a
3971 <a href="#repage" >+repage</a> option, except that all the images
3972 have been kept separate. If 'flatten' is used after using
3973 'trim-bounds' you will get the same result. </td>
cristy3ed852e2009-09-05 21:47:34 +00003974 </tr>
3975
3976 </tbody>
3977</table>
3978
3979<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3980
3981<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3982>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
cristy10549a12011-05-15 19:04:46 +00003983>-mosaic</a> are only aliases for the above methods and may be depreciated in
3984the future. Also see <a href="#page" >-page</a>, <a href="#repage"
3985>-repage</a> operators, the <a href="#compose" >-compose</a> setting, and the
3986GIF <a href="#dispose" >-dispose</a> and <a href="#delay" >-delay</a>
3987settings. </p>
cristy3ed852e2009-09-05 21:47:34 +00003988
3989
3990<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003991 <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 +00003992</div>
3993
3994<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>
3995
3996<p>Given one, two or three values delimited with commas: black-point,
3997white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3998white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3999point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
4000contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
4001both black and white points are percentages of the full color range. Gamma
4002will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
4003omitted, the default of 1.0 (no gamma correction) is assumed.</p>
4004
4005<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
4006the given '<kbd>black_point</kbd>' value in the original image is set to
4007zero (or black), while the given '<kbd>white_point</kbd>' value is set to
4008<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
4009to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
4010adjusted. </p>
4011
4012<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
4013adding the special '!' flag anywhere in the argument list, will cause the
4014operator to do the reverse of the level adjustment. That is a zero, or
4015<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
4016adjusted to the given level values, allowing you to de-contrast, or compress
4017the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
4018
4019<p>Only the channels defined by the current <a href="#channel">-channel</a>
4020setting are adjusted (defaults to RGB color channels only), allowing you to
4021limit the effect of this operator. </p>
4022
4023<p>Please note that the transparency channel is treated as 'matte'
4024values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
4025
4026
4027<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004028 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00004029 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
4030</div>
4031
cristyd0bda5e2010-09-21 16:22:45 +00004032<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 +00004033
4034<p>This function is exactly like <a href="#level">-level</a>, except that the
4035value value for each color channel is determined by the
4036'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
4037described under the <a href="#fill">-fill</a> option). </p>
4038
cristyd0bda5e2010-09-21 16:22:45 +00004039<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
4040is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00004041colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00004042adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00004043
4044<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
4045will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00004046respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00004047those colors. This can also be used to convert a plain gray-scale image into a
4048one using the gradient of colors specified. </p>
4049
4050<p>By supplying a single color with a comma separator either before or after
4051that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00004052respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00004053used for both the black and white color points, making the operator either
4054threshold the images around that color (- form) or set all colors to that
4055color (+ form). </p>
4056
4057
4058<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004059 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004060</div>
4061
4062<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>
4063
4064<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>
4065
cristy6b636652009-12-05 17:16:11 +00004066<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 +00004067
4068<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00004069 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00004070</p>
4071
4072<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
4073
cristydcca3fa2010-12-29 21:50:07 +00004074<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 +00004075 File Area Memory Map Disk Thread Time
4076 ------------------------------------------------------------------------------
4077 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
cristydcca3fa2010-12-29 21:50:07 +00004078</pre>
4079
cristy3ed852e2009-09-05 21:47:34 +00004080<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>
4081
4082<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>
4083
4084<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>
4085
4086<p class="crtsnip">
4087-limit area 10mb
4088</p>
4089
cristyd0bda5e2010-09-21 16:22:45 +00004090<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 +00004091
4092<p class="crtsnip">
4093-limit area 10mb -limit disk 500mb
4094</p>
4095
4096<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
4097
4098<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>
4099
4100<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.
4101</p>
4102
4103<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.
4104</p>
4105
4106<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004107 <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 +00004108</div>
4109
4110<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>
4111
cristyd934d102009-10-10 12:55:13 +00004112<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
4113and uses a 'histogram bin' to determine the range of color values that needs to
4114be stretched. However it then stretchs those colors using the <a
4115href="#level" >-level</a> operator.</p>
4116
4117<p>As such while the initial determination may have 'binning' round off
4118effects, the image colors are stretched mathematically, rather than using the
4119histogram bins. This makes the operator more accurate. </p>
4120
4121<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
4122'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
4123perfect stretch of the color range. </p>
4124
4125<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
4126normalization of mathematical images. </p>
4127
4128<p>This operator is under review for re-development. </p>
4129
4130
cristy3ed852e2009-09-05 21:47:34 +00004131<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004132 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00004133</div>
4134
4135<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>
4136
4137<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004138 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004139</div>
4140
4141<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>
4142
4143<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>
4144
4145<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004146 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004147</div>
4148
4149<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>
4150
4151<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004152 Align Alpha Boolean Channel
4153 Class ClipPath Coder Color
4154 Colorspace Command Compose Compress
4155 Configure DataType Debug Decoration
4156 Delegate Direction Dispose Distort
4157 Dither Endian Evaluate FillRule
4158 Filter Font Format Function
4159 Gravity ImageList Intent Interlace
4160 Interpolate Kernel Layers LineCap
4161 LineJoin List Locale LogEvent
4162 Log Magic Method Metric
4163 Mime Mode Morphology Module
4164 Noise Orientation Policy PolicyDomain
4165 PolicyRights Preview Primitive QuantumFormat
4166 Resource SparseColor Storage Stretch
4167 Style Threshold Type Units
4168 Validate VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004169</pre>
4170
cristybac7a162010-06-15 19:57:29 +00004171<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4172list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4173available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004174
4175<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4176<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004177 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004178</div>
4179
4180<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>
4181
cristybac7a162010-06-15 19:57:29 +00004182<p>This option specifies the format for the log printed when the <a
4183href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004184
cristybac7a162010-06-15 19:57:29 +00004185<p>You can display the following components by embedding special format
4186characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004187
4188<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004189 %d domain
4190 %e event
4191 %f function
4192 %l line
4193 %m module
4194 %p process ID
4195 %r real CPU time
4196 %t wall clock time
4197 %u user CPU time
4198 %% percent sign
4199 \n newline
4200 \r carriage return
cristy3ed852e2009-09-05 21:47:34 +00004201</pre>
4202
4203<p>For example:</p>
4204
4205<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>
4206<p>The default behavior is to print all of the components.</p>
4207
4208<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004209 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004210</div>
4211
4212<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>
4213
cristybac7a162010-06-15 19:57:29 +00004214<p>Set iterations to zero to repeat the animation an infinite number of times,
4215otherwise the animation repeats itself up to <em class="arg">iterations</em>
4216times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004217
4218<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004219 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004220</div>
4221
4222<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>
4223
4224<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004225 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004226</div>
4227
4228<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>
4229
4230
4231<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004232 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004233</div>
4234
4235<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>
4236
4237<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4238
4239<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004240 best
4241 default
4242 gray
4243 red
4244 green
4245 blue
cristy3ed852e2009-09-05 21:47:34 +00004246</pre>
4247
cristybac7a162010-06-15 19:57:29 +00004248<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4249Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4250the type and <kbd>display</kbd> searches the list of colormap types in
4251<kbd>top-to-bottom</kbd> order until one is located. See <em
4252class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004253
4254
4255<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004256 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004257</div>
4258
4259<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>
4260
4261<p>Here are the valid components of a map:</p>
4262
4263<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004264 r red pixel component
4265 g green pixel component
4266 b blue pixel component
4267 a alpha pixel component (0 is transparent)
4268 o opacity pixel component (0 is opaque)
4269 i grayscale intensity pixel component
4270 c cyan pixel component
4271 m magenta pixel component
4272 y yellow pixel component
4273 k black pixel component
4274 p pad component (always 0)
cristy3ed852e2009-09-05 21:47:34 +00004275</pre>
4276
cristybac7a162010-06-15 19:57:29 +00004277<p>You can specify as many of these components as needed in any order (e.g.
4278bgr). The components can repeat as well (e.g. rgbr).</p>
4279
cristy3ed852e2009-09-05 21:47:34 +00004280
4281<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004282 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004283<em class="arg">filename</em></h4>
4284</div>
4285
cristyacc04882011-05-04 23:03:43 +00004286<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 +00004287
cristyacc04882011-05-04 23:03:43 +00004288<p>This the same as using a mask used for composite masking operations, with
4289grayscale values causing blended updates of the image the mask is attached to.
4290</P>
4291
4292<p>Use <a href="#mask">+mask</a> to remove the mask from images.</p>
4293
4294<p>Also see <a href="#clip-mask">-clip-mask</a> which work in the same way,
4295but with strict boolean masking. </p>
cristy3ed852e2009-09-05 21:47:34 +00004296
4297<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004298 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004299</div>
4300
4301<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>
4302
4303<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4304
cristybac7a162010-06-15 19:57:29 +00004305<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4306style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004307
4308<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004309 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004310</div>
4311
4312<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>
4313
cristyacc04882011-05-04 23:03:43 +00004314<p>Select the 'maximum' value from all the surrounding pixels. </p>
4315
4316<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4317name. </p>
4318
cristyd2baf7d2010-03-06 04:26:44 +00004319<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004320 <h4><a id="median"></a>-median <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004321</div>
4322
4323<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>
4324
cristyacc04882011-05-04 23:03:43 +00004325<p>Select the 'middle' value from all the surrounding pixels. </p>
4326
4327<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4328name. </p>
4329
cristy3ed852e2009-09-05 21:47:34 +00004330<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004331 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004332</div>
4333
4334<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>
4335
4336<p>Choose from:</p>
4337
4338<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004339 AE absolute error count, number of different pixels (-fuzz effected)
4340 FUZZ mean color distance
4341 MAE mean absolute error (normalized), average channel error distance
4342 MEPP mean error per pixel (normalized mean error, normalized peak error)
4343 MSE mean error squared, average of the channel error squared
4344 NCC normalized cross correlation
4345 PAE peak absolute (normalize peak absolute)
4346 PSNR peak signal to noise ratio
4347 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004348</pre>
4349
cristy771f7a72010-11-27 21:42:59 +00004350<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4351with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4352only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004353size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004354'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004355for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004356
4357<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4358('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004359normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004360
cristybac7a162010-06-15 19:57:29 +00004361<p>To print a complete list of metrics, use the <a href="#list">-list
4362metrics</a> option.</p>
4363
cristy3ed852e2009-09-05 21:47:34 +00004364
cristyd2baf7d2010-03-06 04:26:44 +00004365<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004366 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004367</div>
4368
4369<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>
4370
cristyacc04882011-05-04 23:03:43 +00004371<p>Select the 'minimal' value from all the surrounding pixels. </p>
4372
4373<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4374name. </p>
4375
4376
cristy3ed852e2009-09-05 21:47:34 +00004377
4378<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004379 <h4><a id="mode"></a>-mode <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004380</div>
4381
cristy29c5c992011-06-25 13:58:49 +00004382<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 +00004383
4384<div style="margin: auto;">
4385 <h4>-mode <em class="arg">value</em></h4>
4386</div>
4387
cristy3ed852e2009-09-05 21:47:34 +00004388<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>
4389
cristybac7a162010-06-15 19:57:29 +00004390<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4391Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004392
cristybac7a162010-06-15 19:57:29 +00004393<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4394for a list of <a href="#mode" >-mode</a> arguments available in your
4395ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004396
4397
4398<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004399 <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 +00004400</div>
4401
cristybac7a162010-06-15 19:57:29 +00004402<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
4403class="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 +00004404
cristyb36feb22010-03-26 16:54:37 +00004405<p>The arguments are given as a percentages of variation. A value of 100 means
4406no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004407
cristyb36feb22010-03-26 16:54:37 +00004408<p>The <em class="arg">brightness</em> is a multiplier of the overall
4409brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4410twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4411before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004412
cristyb36feb22010-03-26 16:54:37 +00004413<p>The <em class="arg">saturation</em> controls the amount of color in an
4414image. For example, 0 produce a grayscale image, while a large value such as
4415200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004416
cristyb36feb22010-03-26 16:54:37 +00004417<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4418within the image by the amount specified. For example, 50 results in
4419a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4420A value of either 0 or 200 results in a complete 180 degree rotation of the
4421image. Using a value of 300 is a 360 degree rotation resulting in no change to
4422the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004423
cristyb36feb22010-03-26 16:54:37 +00004424<p>For example, to increase the color brightness by 20% and decrease the color
4425saturation by 10% and leave the hue unchanged, use <a
4426href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004427
cristyb36feb22010-03-26 16:54:37 +00004428<p>Use <a href="#set">-set</a> attribute of '<kbd
4429class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4430modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4431<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004432
4433<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 +00004434
cristy3ed852e2009-09-05 21:47:34 +00004435<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004436 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004437</div>
4438
4439<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>
4440
4441
4442<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004443 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004444</div>
4445
4446<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>
4447
4448
4449<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004450 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004451</div>
4452
4453<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>
4454
4455<p>Both the image pixels and size are linearly interpolated to give the
4456appearance of a meta-morphosis from one image to the next, over all the images
4457in the current image list. The added images are the equivalent of a <a
4458href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4459argument determine how many images to interpolate between each image. </p>
4460
4461
4462<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004463 <h4><a id="morphology"></a>-morphology</h4>
4464 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004465</div>
4466
cristy2c839602010-04-03 02:32:08 +00004467<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 +00004468
cristydcca3fa2010-12-29 21:50:07 +00004469<p>Until I get around to writing a option summary for this, see <a
4470href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4471Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004472
4473
cristy488844c2010-01-22 14:02:05 +00004474<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004475 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004476</div>
4477
4478<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>
4479
4480
4481<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004482 <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 +00004483</div>
4484
4485<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>
4486
4487<p>Blur with the given radius, standard deviation (sigma), and angle. The
4488angle given is the angle toward which the image is blurred. That is the
4489direction people would consider the object is coming from. </p>
4490
4491<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004492definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004493
4494<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4495pixels which are outside the image proper are blurred into the final result.
4496</p>
4497
4498<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004499 <h4><a id="name"></a>-name</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%'>name an image.</td><td style='text-align:right;'></td></tr></table>
4503<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004504 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004505</div>
4506
cristyb29bc032010-02-01 20:29:43 +00004507<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 +00004508
4509<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>
4510
4511<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004512 <h4><a id="noise"></a>-noise <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004513 +noise <em class="arg">type</em></h4>
4514</div>
4515
4516<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>
4517
4518<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>
4519
4520<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>
4521
4522<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>
4523
4524<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004525 Gaussian
4526 Impulse
4527 Laplacian
4528 Multiplicative
4529 Poisson
4530 Random
4531 Uniform
cristy3ed852e2009-09-05 21:47:34 +00004532</pre>
4533
4534<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4535
cristy83543962009-10-16 19:04:28 +00004536<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4537the use of a controlling value to specify teh amount of noise that should be
4538added to an image. </p>
4539
cristy3ed852e2009-09-05 21:47:34 +00004540
4541<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004542 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004543</div>
4544
4545<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>
4546
cristyd934d102009-10-10 12:55:13 +00004547<p>The intensity values are stretched to cover the entire range of possible
4548values. While doing so, black-out at most <em>2%</em> of the pixels and
4549white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004550
cristyd934d102009-10-10 12:55:13 +00004551<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4552is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4553(Before this version, it was equivalent to <a href="#contrast-stretch"
4554>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004555
cristyd934d102009-10-10 12:55:13 +00004556<p>All the channels are normalized in concert by the came amount so as to
4557preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004558setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004559setting will normalize the RGB channels independently.</p>
4560
cristydcca3fa2010-12-29 21:50:07 +00004561<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004562Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004563that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004564
4565<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004566
4567
4568<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004569 <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 +00004570</div>
4571
cristyd934d102009-10-10 12:55:13 +00004572<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
4573class="arg">threshold map</em> specified, and a uniform color map with the
4574given 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 +00004575
4576<p>You can choose from these standard threshold maps:</p>
4577
4578<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004579 threshold 1x1 Threshold 1x1 (non-dither)
4580 checks 2x1 Checkerboard 2x1 (dither)
4581 o2x2 2x2 Ordered 2x2 (dispersed)
4582 o3x3 3x3 Ordered 3x3 (dispersed)
4583 o4x4 4x4 Ordered 4x4 (dispersed)
4584 o8x8 8x8 Ordered 8x8 (dispersed)
4585 h4x4a 4x1 Halftone 4x4 (angled)
4586 h6x6a 6x1 Halftone 6x6 (angled)
4587 h8x8a 8x1 Halftone 8x8 (angled)
4588 h4x4o Halftone 4x4 (orthogonal)
4589 h6x6o Halftone 6x6 (orthogonal)
4590 h8x8o Halftone 8x8 (orthogonal)
4591 h16x16o Halftone 16x16 (orthogonal)
4592 c5x5b c5x5 Circles 5x5 (black)
4593 c5x5w Circles 5x5 (white)
4594 c6x6b c6x6 Circles 6x6 (black)
4595 c6x6w Circles 6x6 (white)
4596 c7x7b c7x7 Circles 7x7 (black)
4597 c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004598</pre>
4599
cristy945bb352011-04-01 15:39:28 +00004600<p> The <kbd>threshold</kbd> generated a simple 50% threshold of the image.
cristybaacd172011-04-30 23:11:03 +00004601This could be used with <em class="arg" >level</em> to do the equivalent of <a
cristy945bb352011-04-01 15:39:28 +00004602href="#posterize" >-posterize</a> to reduce an image to basic primary colors.
4603</p>
cristy3ed852e2009-09-05 21:47:34 +00004604
cristy945bb352011-04-01 15:39:28 +00004605<p>The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
4606pattern. That is a grayscale will become a pattern of solid black, solid
4607white, and mid-tone colors into a checkerboard pattern of black and white.
4608</p>
cristy3ed852e2009-09-05 21:47:34 +00004609
cristy945bb352011-04-01 15:39:28 +00004610<p>You can define your own <em class="arg" >threshold map</em> for ordered
4611dithering and halftoning your images, in either personal or system
4612<kbd>thresholds.xml</kbd> XML file. See <a href="resources.html" >Resources</A>
4613for more details of configuration files. </p>
cristy3ed852e2009-09-05 21:47:34 +00004614
cristy945bb352011-04-01 15:39:28 +00004615<p>To print a complete list of the thresholds that have been defined, use the
4616<a href="#list" >-list threshold</a> option.</p>
4617
4618<p>Note that at this time the same threshold dithering map is used for all
4619color channels, no attempt is made to offset or rotate the map for different
4620channels is made, to create an offset printing effect. Also as the maps are
4621simple threshold levels, the halftone and circle maps will create incomplete
4622circles along the edges of a colored area. Also all the effects are purely
4623on/off boolean effects, without anti-aliasing to make the circles smooth
4624looking. Large dots can be made to look better with a small amount of blurring
4625after being created. </p>
cristy3ed852e2009-09-05 21:47:34 +00004626
4627
4628<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004629 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004630</div>
4631
4632<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>
4633
cristyc54f5d42009-11-27 21:36:31 +00004634<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004635described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4636>-fuzz</a> setting can be used to match and replace colors similar to the one
4637given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004638
cristyb36feb22010-03-26 16:54:37 +00004639<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4640the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004641
cristyb36feb22010-03-26 16:54:37 +00004642<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4643as <a href="#opaque" >-opaque</a> but replaces the matching color with
4644transparency rather than the current <a href="#fill">-fill</a> color setting.
4645To ensure that it can do this it also ensures that the image has an alpha
4646channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4647the new transparent colors, and does not require you to modify the <a
4648href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004649
cristy3ed852e2009-09-05 21:47:34 +00004650
4651<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004652 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004653</div>
4654
4655<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>
4656
4657<p>Choose from these orientations:</p>
4658
4659<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004660 bottom-left
4661 bottom-right
4662 left-bottom
4663 left-top
4664 right-bottom
4665 right-top
4666 top-left
4667 top-right
4668 undefined
cristy3ed852e2009-09-05 21:47:34 +00004669</pre>
4670
cristyd934d102009-10-10 12:55:13 +00004671<p>To print a complete list of orientations, use the <a href="#list" >-list
4672orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004673
4674
4675<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004676 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004677 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4678 +page
4679 </h4>
4680</div>
4681
4682<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>
4683
4684<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>
4685
4686<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>
4687
4688<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>
4689<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4690<thead>
4691 <tr valign="top">
4692 <th align="center"><em class="arg">media</em></th>
4693 <th align="center"><em class="arg">width</em></th>
4694 <th align="center"><em class="arg">height</em></th>
4695 </tr>
4696</thead>
4697<tbody>
4698<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4699<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4700<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4701<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4702<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4703<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4704<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4705<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4706<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4707<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4708<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4709<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4710<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4711<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4712<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4713<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4714<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4715<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4716<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4717<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4718<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4719<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4720<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4721<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4722<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4723<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4724<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4725<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4726<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4727<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4728<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4729<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4730<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4731<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4732<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4733<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4734<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4735<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4736</tbody>
4737</table>
4738
4739
4740
4741
4742<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>
4743
4744<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>
4745
4746<p>The default page dimensions for a TEXT image is 612x792.</p>
4747
4748<p>This option is used in concert with <a href="#density">-density</a>.</p>
4749
4750<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4751
4752<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004753 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004754</div>
4755
4756<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>
4757
4758<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>
4759
4760<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004761 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004762
4763<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>
4764
4765<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004766 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004767</div>
4768
4769<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Pause between animation loops.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>]</td></tr></table>
4770
4771<p>Pause for the specified number of seconds before repeating the animation.</p>
4772
4773<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004774 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004775</div>
4776
4777<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>
4778
4779<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4780
4781<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004782 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004783</div>
4784
4785<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>
4786
4787<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004788 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004789</div>
4790
4791<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>
4792
4793<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004794 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004795</div>
4796
4797<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>
4798
4799<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4800
4801<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004802 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004803</div>
4804
4805<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>
4806
4807<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004808 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004809</div>
4810
4811<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>
4812
4813<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004814 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004815</div>
4816
4817<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>
4818
4819<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>
4820
4821<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004822 Rotate Shear Roll Hue
4823 Saturation Brightness Gamma Spiff
4824 Dull Grayscale Quantize Despeckle
4825 ReduceNoise Add Noise Sharpen Blur
4826 Threshold EdgeDetect Spread Shade
4827 Raise Segment Solarize Swirl
4828 Implode Wave OilPaint CharcoalDrawing
4829 JPEG
cristy3ed852e2009-09-05 21:47:34 +00004830</pre>
4831
4832<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4833
4834<p>The default preview is <kbd>JPEG</kbd>.</p>
4835
4836<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004837 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004838</div>
4839
4840<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>
4841
4842<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004843 <h4><a id="process"></a>-process <em class="arg">command</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004844</div>
4845
4846<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>
4847
4848<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>
4849
4850<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004851 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004852 +profile <em class="arg">profile_name</em></h4>
4853</div>
4854
4855<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>
4856
4857<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>
4858
4859<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>
4860
4861<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>
4862
4863<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>
4864
4865<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4866
4867<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4868<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>
4869
4870<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>
4871<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4872CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4873</p>
4874
4875<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004876 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004877</div>
4878
4879<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>
4880
cristy851dbce2010-08-06 21:40:00 +00004881<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and highest compression) to 100 (best quality but least effective compression). The default is to use the estimate quality of your input image otherwise 92. Use the <a href="#sampling-factor">-sampling-factor</a> option to specify the factors for chroma downsampling.</p>
cristy3ed852e2009-09-05 21:47:34 +00004882
4883<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>
4884
cristy851dbce2010-08-06 21:40:00 +00004885<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 +00004886
cristy3c98a4f2010-08-13 20:09:41 +00004887<p>For the MNG and PNG image formats, the quality value sets the zlib compression level (quality / 10) and filter-type (quality % 10). For compression level 0, the Huffman-only strategy is used, which is fastest but not necessarily the worst compression. The default PNG compression is 75.</p>
cristy3ed852e2009-09-05 21:47:34 +00004888
4889<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4890
4891<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004892 0: none
4893 1: sub
4894 2: up
4895 3: average
4896 4: Paeth
cristy3ed852e2009-09-05 21:47:34 +00004897</pre>
4898
4899<p>If filter-type is 5, adaptive filtering is used when quality is greater than 50 and the image does not have a color map, otherwise no filtering is used.</p>
4900
4901<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4902
4903<p>Only if the output is MNG, if filter-type is 7, the LOCO color transformation and adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> are used.</p>
4904
cristy3c98a4f2010-08-13 20:09:41 +00004905<p>The quality setting has no effect on the appearance of PNG and MNG images, since the compression is always lossless.</p>
cristy3ed852e2009-09-05 21:47:34 +00004906
4907<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4908
cristy3ed852e2009-09-05 21:47:34 +00004909<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004910 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004911</div>
4912
cristy3c98a4f2010-08-13 20:09:41 +00004913<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 +00004914
cristy3c98a4f2010-08-13 20:09:41 +00004915<p>This setting defines the colorspace used to sort out and reduce the number
4916of colors needed by an image (for later dithering) by operators such as <a
4917href="#colors" >-colors</a>, Note that color reducion also happens
4918automatically when saving images to color-limited image file formats, such as
4919GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004920
4921
4922<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004923 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004924</div>
4925
4926<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>
4927
4928<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004929 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004930</div>
4931
4932<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>
4933
4934<p>Note that this is actually a rotational blur rather than a radial and as
4935such actually mis-named. </p>
4936
4937<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4938pixels which are outside the image proper are blurred into the final result.
4939</p>
4940
4941
4942<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004943 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004944</div>
4945
4946<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>
4947
4948<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>.
4949</p>
4950
4951<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4952
4953<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004954 <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 +00004955</div>
4956
4957<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>
4958
4959<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004960 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004961</div>
4962
4963<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>
4964
4965<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004966 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00004967</div>
4968
4969<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>
4970
4971<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004972 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004973</div>
4974
4975<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>
4976
4977<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4978the given colors are dithered over the image as necessary, otherwise the closest
4979color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4980
4981<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4982images in the current image sequence, all the images will have the same color
4983table. That means that when saved to a file format such as GIF, it will use
4984that color table as a single common or global color table, for all the images,
4985without requiring extra local color tables. </p>
4986
4987<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4988sequence to use a common color map over all the images. This equivalent to
4989appending all the images together (without extra background colors) and color
4990reducing those images using <a href="#colors">-colors</a> with a 256 color
4991limit, then <a href="#remap">-remap</a> those colors over the original list of
4992images. This ensures all the images follow a single color map. </p>
4993
4994<p>If the number of colors over all the images is less than 256, then <a
4995href="#remap">+remap</a> should not perform any color reduction or dithering, as
4996no color changes are needed. In that case, its only effect is to force the use
4997of a global color table. This recommended after using either <a
4998href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
4999reduce the number of colors in an animated image sequence. </p>
5000
5001<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005002 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005003</div>
5004
5005<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>
5006
5007<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>
5008
5009<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>
5010
5011<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005012 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00005013</div>
5014
5015<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>
5016
5017<p>The only command recognized is the name of an image file to load.</p>
5018
5019<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>
5020
5021<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005022 <h4><a id="render"></a>-render</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%'>render vector operations.</td><td style='text-align:right;'></td></tr></table>
5026
5027<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>
5028
5029<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005030<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005031</div>
5032
5033<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>
5034
5035<p>This option is like <a href="#page">-page</a> but acts as an image operator
5036rather than a setting. You can separately set the canvas size or the offset
5037of the image on that canvas by only providing those components. </p>
5038
5039<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>
5040
5041<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
5042offset to move the image relative to its previous position. This useful for
5043animation sequences. </p>
5044
5045<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
5046recalculate the canvas size so the image (at its current offset) will appear
5047completely on that canvas (unless it has a negative offset).</p>
5048
5049<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
5050canvas meta-data from the images. </p>
5051
5052<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
5053directly assign virtual canvas meta-data. </p>
5054
5055
5056<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005057 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005058</div>
5059
5060<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>
5061
5062<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>
5063
5064<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>
5065
5066<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005067 <h4><a id="resize"></a>-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005068</div>
5069
5070<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>
5071
5072<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>
5073
5074<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>
5075
cristy13538962010-02-26 17:53:04 +00005076<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>
5077
cristy4949d522010-03-12 18:41:34 +00005078<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 +00005079<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005080 <h4><a id="respect-parentheses"></a>-respect-parentheses</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%'>settings remain in effect until parenthesis boundary.</td><td style='text-align:right;'></td></tr></table>
5084
5085<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005086 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005087</div>
5088
5089<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>
5090
5091
5092<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005093 <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 +00005094</div>
5095
5096<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>
5097
5098<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>
5099
5100
5101<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005102 <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 +00005103</div>
5104
5105<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>
5106
5107<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>
5108
5109<p>Empty triangles in the corners, left over from rotating the image, are
5110filled with the <kbd>background</kbd> color. </p>
5111
5112<p>See also the <a href="#distort">-distort</a> operator and specifically the
5113'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5114
5115
5116<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005117 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005118</div>
5119
cristyd0bd44a2010-09-24 12:38:11 +00005120<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 +00005121
cristyd0bd44a2010-09-24 12:38:11 +00005122<p>Change the image size simply by directly sampling the pixels original
5123image. When magnifying, pixels are replicated in blocks. When minifying,
5124pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005125
cristyd0bd44a2010-09-24 12:38:11 +00005126<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5127a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5128neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5129avoids all the filter processing of the image. As such it completely ignores
5130the current <a href="#filter">-filter</a> setting. </p>
5131
5132<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5133will be added to the resulting image, though some colors may disappear. </p>
5134
5135<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
5136ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005137
5138
5139<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005140 <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 +00005141</div>
5142
5143<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>
5144
5145<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>
5146
5147<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005148 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005149</div>
5150
cristyd0bd44a2010-09-24 12:38:11 +00005151<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 +00005152
cristyd0bd44a2010-09-24 12:38:11 +00005153<p>Change the image size simply by replacing pixels by averaging pixels
5154together when minifying, or replacing pixels when magnifing. </p>
5155
5156<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5157a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5158faster, as it avoids all the filter processing of the image. As such it
5159completely ignores the current <a href="#filter">-filter</a> setting. </p>
5160
5161<p>If when shrinking (minifying) images the original image is some integer
5162multiple of the new image size, the number of pixels avergaed together to
5163produce the new pixel color is the same across the whole image. This is
5164a special case known as 'binning' and is often used as a method of reducing
5165noise in image such as those generated by digital cameras, especially in low
5166light conditions. </p>
5167
cristy3ed852e2009-09-05 21:47:34 +00005168
5169<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005170 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005171</div>
5172
5173<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>
5174
5175<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5176
5177<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005178 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005179</div>
5180
5181<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>
5182
5183<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>
5184
5185<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005186 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005187</div>
5188
5189<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>
5190
5191<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005192 <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 +00005193</div>
5194
5195<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>
5196
5197<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>
5198
5199<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>
5200
5201<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5202of the color clusters is returned.</p>
5203
5204
5205<div style="margin: auto;">
cristy8b9dd952011-03-21 22:56:18 +00005206 <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 +00005207</div>
5208
cristy3ed852e2009-09-05 21:47:34 +00005209<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>
5210
cristy2e2662a2010-10-09 14:29:37 +00005211<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>
5212
cristy3ed852e2009-09-05 21:47:34 +00005213<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005214 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005215</div>
5216
5217<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
5218
5219<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005220 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</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%'>simulate a sepia-toned photo.</td><td style='text-align:right;'></td></tr></table>
5224
5225<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5226
5227<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>
5228
cristyd0bda5e2010-09-21 16:22:45 +00005229
5230
cristy3ed852e2009-09-05 21:47:34 +00005231<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005232 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5233 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005234</div>
5235
cristyd0bd44a2010-09-24 12:38:11 +00005236<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 +00005237image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005238
cristyd0bd44a2010-09-24 12:38:11 +00005239<p>This will assign (or modify) specific settings attached to all the images
5240in the current image sequence. Using the <a href="#set">+set</a> form of the
5241option will either remove, or reset that setting to a default state, as
5242appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005243
cristyd0bd44a2010-09-24 12:38:11 +00005244<p>For example, it will modify specific well known image meta-data
5245'attributes' such as those normally overridden by: the options <a
5246href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5247href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5248assigned before the image is read in, by using a <em class="arg">key</em> of
5249the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005250
cristyd0bd44a2010-09-24 12:38:11 +00005251<p>If the given <em class="arg">key</em> does not match a specific known
5252'attribute ', such as shown above, the setting is stored as a a free form
cristy323f35b2011-03-24 23:05:13 +00005253'property' string. Such settings are listed in <a href="#verbose"
cristyd0bda5e2010-09-21 16:22:45 +00005254>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5255</p>
5256
cristy84134182011-06-15 22:59:00 +00005257<p>This includes string 'properties' that are set by and assigned to images
cristyd0bd44a2010-09-24 12:38:11 +00005258using the options <a href="#comment" >-comment</a>, <a href="#label"
5259>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5260a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5261Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005262
cristyd0bd44a2010-09-24 12:38:11 +00005263<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>
5264<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5265Properties</a> in the defined value. For example:</p>
5266
5267<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 +00005268<p>Other well known 'properties' that are availible include:
cristyd0bd44a2010-09-24 12:38:11 +00005269'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5270'<kbd>signature</kbd>'. </p>
5271
5272<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5273the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5274see <a href="#repage">-page</a>). However it is designed to provide a finer
5275control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5276option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5277attribute. </p>
5278
5279<p>This option can also associate a colorspace or profile with your image.
5280For example,</p>
5281
5282<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 +00005283<p>Some 'properties' must be defined in a specific way to be used. For
5284example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5285modify the output filename of an image. For example</p>
5286
5287<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>
5288<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5289be saved as a global "Artifact" exactly as if it was set using the <a
cristyf9a6c462011-04-24 14:01:11 +00005290href="#define" >-define</a> option. As such settings are global in scope, they
cristy84134182011-06-15 22:59:00 +00005291can be used to pass 'attributes' and 'properties' of one specific image,
cristyd0bd44a2010-09-24 12:38:11 +00005292in a way that allows you to use them in a completely different image, even if
5293the original image has long since been modified or destroyed. For example: </p>
5294
5295<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>
5296<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5297a 'artifact' if the given <em class="arg">key</em> does not match an existing
cristy323f35b2011-03-24 23:05:13 +00005298'attribute' or 'property'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005299
5300<p>You can set the attributes of the image registry by prefixing the value
5301with <kbd>registry:</kbd>.</p>
5302
cristy84134182011-06-15 22:59:00 +00005303<p>The <a href="#set">-set profile</a> option can also be used to inject
5304previously-formatted ancillary chunks into the output PNG file, using
5305the commandline option as shown below or by setting the profile via a
5306programming interface:</p>
5307
5308<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>
5309<p>where <em>x</em> is a location flag and
5310<em class="arg">filename</em> is a file containing the chunk
5311name in the first 4 bytes, then a colon (":"), followed by the chunk data.
5312This encoder will compute the chunk length and CRC, so those must not
5313be included in the file.</p>
5314
5315<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
5316or "e" (end, i.e., after IDAT). If you want to write multiple chunks
5317of the same type, then add a short unique string after the "x" to prevent
5318subsequent profiles from overwriting the preceding ones, e.g.,</p>
5319
5320
5321<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -set profile PNG-chunk-b01:file01 / <br/>
5322 -profile PNG-chunk-b02:file02 out.png</span></p>
5323<p>&nbsp;</p>
cristyd0bda5e2010-09-21 16:22:45 +00005324
cristy3ed852e2009-09-05 21:47:34 +00005325
5326<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005327 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005328</div>
5329
5330<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>
5331
5332<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>
5333
5334<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005335 <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 +00005336</div>
5337
5338<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>
5339
5340<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005341 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005342id="shared-memory"></a>-shared-memory</h4>
5343</div>
5344
5345<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>
5346
5347<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>
5348
5349<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005350 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005351</div>
5352
5353<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>
5354
5355<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5356
5357<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005358 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005359</div>
5360
5361<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>
5362
5363<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>
5364
5365<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>
5366
5367<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005368 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005369</div>
5370
5371<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>
5372
5373<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>
5374
5375<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>
5376
5377<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>
5378
5379<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>
5380
5381<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>
5382<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>
5383
5384<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5385<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005386 <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 +00005387</div>
5388
5389<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>
5390
5391<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>
5392
5393<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005394 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005395</div>
5396
5397<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>
5398
5399<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005400 <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 +00005401</div>
5402
5403<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>
5404
5405<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>
5406
5407<p>For Photo CD images, choose from these sizes:</p>
5408
5409<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005410 192x128
5411 384x256
5412 768x512
5413 1536x1024
5414 3072x2048
cristy3ed852e2009-09-05 21:47:34 +00005415</pre>
5416
cristy3ed852e2009-09-05 21:47:34 +00005417<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005418 <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 +00005419</div>
5420
5421<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>
5422
5423<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>
5424
5425<div style="margin: auto;">
cristy2d67ddd2011-02-13 15:38:23 +00005426 <h4><a id="smush"></a>-smush <em class="arg">offset</em></h4>
5427</div>
5428
5429<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>
5430
5431<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005432 <h4><a id="snaps"></a>-snaps <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005433</div>
5434
5435<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>
5436
5437<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5438
5439<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005440 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005441</div>
5442
5443<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>
5444
5445<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5446
5447<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5448
5449<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005450 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005451 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5452</div>
5453
5454<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>
5455
5456
5457<table class="doc">
5458 <tbody>
5459 <tr valign="top">
5460 <th align="left" style="width: 8%">Method</th>
5461 <th align="left">Description</th>
5462 </tr>
5463
5464 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005465 <td valign="top">barycentric</td>
5466 <td valign="top">three point triangle of color given 3 points.
5467 Giving only 2 points will form a linear gradient between those points.
5468 The gradient generated extends beyond the triangle created by those
5469 3 points. </td>
5470 </tr>
5471
5472 <tr valign="top">
5473 <td valign="top">bilinear</td>
5474 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5475 fall back to barycentric. </td>
5476 </tr>
5477 <tr valign="top">
cristy3ed852e2009-09-05 21:47:34 +00005478 <td valign="top">voronoi</td>
5479 <td valign="top">Simply map each pixel to the to nearest color point
5480 given. The result are polygonal 'cells' of solid color. </td>
5481 </tr>
5482
5483 <tr valign="top">
5484 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005485 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005486 squared. Generating spots of color in a sea of the average of
5487 colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005488 </tr>
5489
5490 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005491 <td valign="top">inverse</td>
5492 <td valign="top">Colors points biased on the ratio of inverse distance.
5493 This generates sharper points of color rather than rounded spots of
5494 '<kbd>shepards</kbd>' Generating spots of color in a sea of the
5495 average of colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005496 </tr>
5497
5498 </tbody>
5499</table>
5500
5501<p>The points are placed according to the images location on the virtual
5502canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5503offset), and do not actually have to exist on the given image, but may be
5504some point beyond the edge of the image. All points are floating point values.
5505</p>
5506
5507<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
cristyacc04882011-05-04 23:03:43 +00005508modified, which means that by default matte/alpha transparency channel is not
5509effected. Typically transparency channel is turned off either before or after
5510the operation. </P>
5511
5512Of course if some color points are transparent to generate a transparent
5513gradient, then the image also requires transparency enabled to store the
5514values. </p>
cristy3ed852e2009-09-05 21:47:34 +00005515
5516<p>All the above methods when given a single point of color will replace all
5517the colors in the image with the color given, regardless of the point. This is
5518logical, and provides an alternative technique to recolor a image to some
5519default value. </p>
5520
5521
5522<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005523 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005524</div>
5525
5526<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>
5527
cristyacc04882011-05-04 23:03:43 +00005528<p>This will add rows and columns of the current <a
5529href="#background">-background</a> color into the given image according to the
5530given <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
5531image into four quadrants, separating them by the inserted rows and columns.
5532</P>
5533
5534If a dimension of geometry is zero no rows or columns will be added for that
5535dimension. Similarly using a zero offset with the appropriate <a
5536href="#gravity">-gravity</a> setting will add rows and columns to the edges of
5537the image, padding the image only along that one edge. Edge padding is what <a
5538href="#splice">-splice</a> is most commonly used for. </p>
5539
5540<p>If the exact same <em class="arg">geometry</em> and <a
5541href="#gravity">-gravity</a> is later used with <a href="#chop">-chop</a> the
5542added added all splices removed. </p>
cristy3ed852e2009-09-05 21:47:34 +00005543
5544<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005545 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005546</div>
5547
5548<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>
5549
5550<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>
5551
5552<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00005553 <h4><a id="statistic"></a>-statistic <em class="arg">type</em> <em class="arg">geometry</em></h4>
cristyb52981c2011-03-19 17:09:31 +00005554</div>
5555
5556<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>
5557
5558<p>Choose from these statistic types:</p>
5559<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005560 Gradient maximum difference in area
5561 Maximum maximum value per channel in neighborhood
5562 Minimum minimum value per channel in neighborhood
5563 Mean average value per channel in neighborhood
5564 Median median value per channel in neighborhood
5565 Mode mode (most frequent) value per channel in neighborhood
5566 Nonpeak value just before or after the median value per channel in neighborhood
cristyb52981c2011-03-19 17:09:31 +00005567</pre>
5568
5569<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005570 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005571</div>
5572
5573<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>
5574
5575<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>
5576
5577<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005578 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005579</div>
5580
5581<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>
5582
5583<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>
5584
5585<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005586 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005587</div>
5588
5589<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>
5590
5591<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005592 char unsigned characters
5593 double doubles
5594 float floats
5595 integer integers
5596 long longs
5597 quantum pixels in the native depth of your ImageMagick distribution
5598 short unsigned shorts
cristy3ed852e2009-09-05 21:47:34 +00005599</pre>
5600
5601<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5602values range from 0 to the maximum value the storage type can support.</p>
5603
5604<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005605 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005606</div>
5607
5608<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>
5609
5610<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>
5611
5612<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005613 Any
5614 Condensed
5615 Expanded
5616 ExtraCondensed
5617 ExtraExpanded
5618 Normal
5619 SemiCondensed
5620 SemiExpanded
5621 UltraCondensed
5622 UltraExpanded
cristy3ed852e2009-09-05 21:47:34 +00005623</pre>
5624
5625<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5626
5627<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>
5628
5629<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005630 <h4><a id="strip"></a>-strip</h4>
cristy3ed852e2009-09-05 21:47:34 +00005631</div>
5632
5633<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>
5634
5635<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005636 <h4><a id="stroke"></a>-stroke <em class="arg">color</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%'>color to use when stroking a graphic primitive.</td><td style='text-align:right;'></td></tr></table>
5640
5641<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5642
5643<p>See <a href="#draw">-draw</a> for further details.</p>
5644
5645<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005646 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005647</div>
5648
5649<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>
5650
5651<p>See <a href="#draw">-draw</a> for further details.</p>
5652
5653<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005654 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005655</div>
5656
5657<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>
5658
cristy71a3f602010-09-15 12:38:16 +00005659<p>This setting suggests a font style that ImageMagick should try to apply to
5660the currently selected font family. Select <em class="arg">fontStyle</em> from
5661the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005662
5663<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005664 Any
5665 Italic
5666 Normal
5667 Oblique
cristy3ed852e2009-09-05 21:47:34 +00005668</pre>
5669
5670<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>
5671
5672<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005673 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005674</div>
5675
cristyd4d64ed2010-08-22 22:19:33 +00005676<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>
5677
cristy71a3f602010-09-15 12:38:16 +00005678<p>This option is required to have compare search for the best match location
5679of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005680(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005681be the "match score" image.</p>
5682
cristyd0bd44a2010-09-24 12:38:11 +00005683<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005684position of the top-left corner of the given sub-image. that is its size will
5685be the size of the larger_image - sub_image + 1. The brightest location in
5686this image is the location s the locate on the best match that is also
5687reported. Note that this may or may nor be a perfect match, and the actual
5688brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005689possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005690
cristyd0bda5e2010-09-21 16:22:45 +00005691<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005692location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005693sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005694
cristyae6203d2010-08-09 01:12:14 +00005695
5696<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005697 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005698</div>
5699
5700<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>
5701
cristy71a3f602010-09-15 12:38:16 +00005702<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5703images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5704the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005705
5706<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005707 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005708</div>
5709
5710<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>
5711
5712<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5713
5714<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005715 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005716</div>
5717
5718<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>
5719
5720<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005721 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005722</div>
5723
cristy5063d812010-10-19 16:28:10 +00005724<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 +00005725
5726<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005727 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005728</div>
5729
5730<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>
5731
5732<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>
5733
5734<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>
5735
5736<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005737 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005738</div>
5739
5740<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>
5741
5742<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005743 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005744</div>
5745
5746<!-- {<em class="arg">green,blue,opacity</em>}
5747<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>
5748-->
5749
5750<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>
5751
5752<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>
5753
5754<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.
5755</p>
5756
5757<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>
5758
5759<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5760<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>
5761
5762
5763<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>
5764<p>Note that the values of the transparency channel is treated as 'matte'
5765values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5766
5767<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>.
5768</p>
5769
5770<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005771 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005772</div>
5773
5774<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>
5775
5776<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>
5777
5778<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>
5779
5780<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005781 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005782</div>
5783
5784<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>
5785
5786<div style="margin: auto;">
5787 <h4>-tile <em class="arg">geometry</em></h4>
5788</div>
5789
5790<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>
5791
5792<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>
5793
5794<div style="margin: auto;">
5795 <h4>-tile</h4>
5796</div>
5797
5798<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>
5799
5800<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005801 <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 +00005802</div>
5803
5804<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>
5805
5806<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>
5807
5808<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>
5809
5810<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005811 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005812</div>
5813
5814<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>
5815
5816<p>Tint the image with the fill color.</p>
5817
5818<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>
5819
5820<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005821 <h4><a id="title"></a>-title <em class="arg">string</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%'>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>
5825
5826<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>
5827
5828<p>For example,</p>
5829
5830<p class="crtsnip">
5831 -title "%m:%f %wx%h"
5832</p>
5833
5834<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>
5835
5836
5837<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005838 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005839</div>
5840
5841<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>
5842
5843<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5844
5845<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 +00005846
5847<p>This operator has been now been superseded by the <a
5848href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5849
5850
cristy3ed852e2009-09-05 21:47:34 +00005851<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005852 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005853</div>
5854
5855<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>
5856
5857<p>The <em class="arg">color</em> argument is defined using the format
5858described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5859>-fuzz</a> setting can be used to match and replace colors similar to the one
5860given. </p>
5861
cristyb36feb22010-03-26 16:54:37 +00005862<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5863that is make all non-matching colors transparent. </p>
5864
cristy3ed852e2009-09-05 21:47:34 +00005865<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005866href="#transparent" >-transparent</a> but replaces the matching color with the
5867current <a href="#fill">-fill</a> color setting, rather than transparent.
5868However the <a href="#transparent" >-transparent</a> operator also ensures
5869that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5870>-alpha</a> set</kbd>", and does not require you to modify the <a
5871href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005872
cristyb36feb22010-03-26 16:54:37 +00005873<p>Note that this does not define the color as being the 'transparency color'
5874used for color-mapped image formats, such as GIF. For that use <a
5875href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005876
5877
5878<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005879 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005880</div>
5881
5882<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>
5883
5884<p>Sometimes this is used for saving to image formats such as
5885GIF and PNG8 which uses this color to represent boolean transparency. This
5886does not make a color transparent, it only defines what color the transparent
5887color is in the color palette of the saved image. Use <a
5888href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5889
5890<p>This option allows you to have both an opaque visible color, as well as a
5891transparent color of the same color value without conflict. That is, you can
5892use the same color for both the transparent and opaque color areas within an
5893image. This, in turn, frees to you to select a transparent color that is
5894appropriate when an image is displayed by an application that does not handle a
5895transparent color index, while allowing ImageMagick to correctly handle images of this
5896type. </p>
5897
5898<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5899
5900<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005901 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005902</div>
5903
5904<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>
5905
5906<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5907</p>
5908
5909<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005910 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005911</div>
5912
5913<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>
5914
5915
5916<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005917 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005918</div>
5919
5920<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>
5921
5922<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>
5923
5924<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>
5925
5926<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>
5927
5928<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005929 <h4><a id="trim"></a>-trim</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%'>trim an image.</td><td style='text-align:right;'></td></tr></table>
5933
5934<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>
5935
5936<p>The page or virtual canvas information of the image is preserved allowing
5937you to extract the result of the <a href="#trim">-trim</a> operation from the
5938image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5939information if it is unwanted.</p>
5940
5941<p>If the trimmed image 'disappears' an warning is produced, and a special
5942single pixel transparent 'missed' image is returned, in the same way as when a
5943<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5944
5945
5946<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005947 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005948</div>
5949
5950<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 +00005951 <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 +00005952
5953<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>
5954
5955<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5956<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>
5957
5958<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5959
5960<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005961 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005962</div>
5963
5964<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>
5965
5966<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5967
5968<p>See <a href="#draw">-draw</a> for further details.</p>
5969
5970
5971<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005972 <h4><a id="update"></a>-update <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005973</div>
5974
5975<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>
5976
5977<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>
5978
5979
5980<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005981 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00005982</div>
5983
5984<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>
5985
5986
5987<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005988 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005989</div>
5990
5991<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>
5992
5993<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>
5994
5995
5996<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005997 <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 +00005998</div>
5999
6000<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>
6001
6002<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>
6003
6004<p>The parameters are:</p>
6005
6006<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006007 radius The radius of the Gaussian, in pixels, not counting the center
6008 pixel (default 0).
6009 sigma The standard deviation of the Gaussian, in pixels (default 1.0).
6010 amount The fraction of the difference between the original and the blur
6011 image that is added back into the original (default 1.0).
6012 threshold The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
6013 difference amount (default 0.05).
cristy3ed852e2009-09-05 21:47:34 +00006014</pre>
6015
6016
6017<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006018 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00006019</div>
6020
cristyd0bda5e2010-09-21 16:22:45 +00006021<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 +00006022
6023
6024<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006025 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00006026</div>
6027
6028<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>
6029
6030
6031<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006032 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006033</div>
6034
6035<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>
6036
6037
6038<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006039 <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 +00006040</div>
6041
6042<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>
6043
6044
6045<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006046 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006047</div>
6048
6049<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>
6050
6051<p>This option defines what color source should be used if and when a color
6052lookup completely 'misses' the source image. The color(s) that appear to
6053surround the source image. Generally this color is derived from the source
6054image, but could also be set to a specify background color. </p>
6055
6056<p>Choose from these methods:</p>
6057
6058<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006059 background the area surrounding the image is the background color
6060 black the area surrounding the image is black
6061 checker-tile alternate squares with image and background color
6062 dither non-random 32x32 dithered pattern
6063 edge extend the edge pixel toward infinity
6064 gray the area surrounding the image is gray
6065 horizontal-tile horizontally tile the image, background color above/below
6066 horizontal-tile-edge horizontally tile the image and replicate the side edge pixels
6067 mirror mirror tile the image
6068 random choose a random pixel from the image
6069 tile tile the image (default)
6070 transparent the area surrounding the image is transparent blackness
6071 vertical-tile vertically tile the image, sides are background color
6072 vertical-tile-edge vertically tile the image and replicate the side edge pixels
6073 white the area surrounding the image is white
cristy3ed852e2009-09-05 21:47:34 +00006074</pre>
6075
6076<p>The default value is "edge".</p>
6077
6078<p>This most important for distortion operators such as <a href="#distort"
6079>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
6080However it also effects operations that may access pixels just outside the
6081image proper, such as <a href="#convolve">-convolve</a>, <a
6082href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
6083
6084<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
6085
6086
6087<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006088 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006089</div>
6090
6091<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>
6092
6093<p>Choose from these visual classes:</p>
6094
6095<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006096 StaticGray
6097 GrayScale
6098 StaticColor
6099 PseudoColor
6100 TrueColor
6101 DirectColor
6102 default
6103 visual id
cristy3ed852e2009-09-05 21:47:34 +00006104</pre>
6105
6106<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>
6107
6108
6109<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006110 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00006111 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
6112</div>
6113
6114<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
6115saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
6116
6117<p>Take a grayscale image (with alpha mask) and modify the destination image's
6118brightness according to watermark image's grayscale value and the <em
6119class="arg">brightness</em> percentage. The destinations color saturation
6120attribute is just direct modified by the <em class="arg">saturation</em>
6121percentage, which defaults to 100 percent (no color change). </p>
6122
6123
6124<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006125 <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 +00006126</div>
6127
6128<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>
6129
6130<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
6131
6132<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006133 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006134</div>
6135
6136<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>
6137
6138<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>
6139
6140<table class="doc">
6141 <col width="25%" />
6142 <col width="75%" />
6143 <thead>
6144 <tr>
6145 <th><em class="arg">fontWeight</em></th>
6146 <th>Description</th>
6147 </tr>
6148 </thead>
6149 <tbody>
6150 <tr><td>All </td> <td>No effect. </td></tr>
6151 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
6152 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
6153 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
6154 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
6155 </tbody>
6156 </table>
6157
6158<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
6159
6160<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>
6161
6162<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006163 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006164</div>
6165
6166<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>
6167
6168<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006169 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006170</div>
6171
cristy5cadd612009-09-21 19:33:41 +00006172<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>
6173
6174<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.
6175</p>
cristy3ed852e2009-09-05 21:47:34 +00006176
6177<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006178 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006179</div>
6180
6181<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>
6182
6183<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>
6184
6185<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>
6186
6187<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>
6188
6189<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006190 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006191</div>
6192
6193<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>
6194
6195<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006196 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006197</div>
6198
6199<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>
6200 <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>
6201
6202<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006203</div>
6204</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006205
6206</div>
6207
6208<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006209 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006210 <span id="linkbar-center">
6211 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006212 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006213 </span>
6214 <span id="linkbar-east">&nbsp;</span>
6215 </div>
6216 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +00006217 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006218 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6219 </div>
6220 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006221 <script type="text/javascript">
6222 var _gaq = _gaq || [];
6223 _gaq.push(['_setAccount', 'UA-17690367-1']);
6224 _gaq.push(['_trackPageview']);
6225
6226 (function() {
6227 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6228 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6229 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6230 })();
6231 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006232</body>
6233</html>