blob: 339bd77426c8d8ac9842ec5f7cd569c8e9b78e73 [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 Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000202</div>
203<div class="sponsor">
cristy87a7f072011-07-01 00:08:52 +0000204 <a rel="follow" title="Sponsor: Bildbearbeitung" href="http://www.bildschliff.de">Bildbearbeitung</a><!-- 2012060100300 strait.de-->
cristyec6b4752011-01-08 03:16:23 +0000205</div>
cristy3ed852e2009-09-05 21:47:34 +0000206</div>
207</div>
cristyce69bb02010-07-27 19:49:46 +0000208</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000209
cristyce69bb02010-07-27 19:49:46 +0000210<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000211<div style="margin: 9pt 9pt 9pt 9pt;">
212 <div class="g-plusone" data-size="standard" data-count="false"></div>
213</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000214</div>
215
216<div class="main">
217
cristydcca3fa2010-12-29 21:50:07 +0000218<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000219<p class="navigation-index">
cristy8b9dd952011-03-21 22:56:18 +0000220[ <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 +0000221
cristydcca3fa2010-12-29 21:50:07 +0000222<div class="doc-section">
223
cristyb36feb22010-03-26 16:54:37 +0000224<p>Below is list of command-line options recognized by the ImageMagick <a
225href="../www/command-line-tools.html">command-line
226tools</a>. If you want a description of a particular option, click on the
227option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000228otherwise 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 +0000229
230<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000231 <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 +0000232</div>
233
234<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 +0000235<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>
236
237<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000238 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000239</div>
240
241<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>
242
243<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>
244
245<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000246 <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 +0000247</div>
248
249<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>
250
251<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>
252
253<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000254 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000255</div>
256
257<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>
258
cristy30092792011-02-22 02:06:14 +0000259<p>This option is enabled by default. An attempt is made to save all images of
260an image sequence into the given output file. However, some formats, such as
261JPEG and PNG, do not support more than one image per file, and in that case
262ImageMagick is forced to write each image as a separate file. As such, if
263more than one image needs to be written, the filename given is modified by
264adding a <a href="#scene">-scene</a> number before the suffix, in order to
265make distinct names for each image. </p>
cristy3ed852e2009-09-05 21:47:34 +0000266
cristy30092792011-02-22 02:06:14 +0000267<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written to
268separate files, whether or not the file format allows multiple images per file
269(for example, GIF, MIFF, and TIFF). </p>
cristy3ed852e2009-09-05 21:47:34 +0000270
cristy30092792011-02-22 02:06:14 +0000271<p>Including a C-style integer format string in the output filename will
272automagically enable <a href="#adjoin">+adjoin</a> and are used to specify
273where the <a href="#scene">-scene</a> number is placed in the filenames. These
274strings, such as '<kbd>%d</kbd>' or '<kbd>%03d</kbd>', are familiar to those
275who have used the standard <kbd>printf()</kbd>' C-library function. As an
276example, the command</p>
cristy3ed852e2009-09-05 21:47:34 +0000277
278<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 +0000279<p>will create a sequence of 17 images (the two given plus 15 more created by
280<a href="#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
281my02morph.jpg, ..., my16morph.jpg. </p>
cristy3ed852e2009-09-05 21:47:34 +0000282
cristy30092792011-02-22 02:06:14 +0000283<p>In summary, ImageMagick tries to write all images to one file, but will
284save to multiple files, if any of the following conditions exist...
285<ol>
286<li>the output image's file format does not allow multi-image files,
287<li>the <a href="#adjoin">+adjoin</a> option is given, or
288<li>a printf() integer format string (eg: "%d") is present in the output
289 filename.
290</ol></p>
cristy3ed852e2009-09-05 21:47:34 +0000291
292
293<div style="margin: auto;">
cristy30092792011-02-22 02:06:14 +0000294 <h4><a id="affine"></a>-affine
295 <em class="arg">s<sub>x</sub></em>,<em class="arg">r<sub>x</sub></em>,<em
296 class="arg">r<sub>y</sub></em>,<em class="arg">s<sub>y</sub></em>[,<em
cristye9a32c32011-04-07 01:11:05 +0000297 class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000298</div>
299
300<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>
301
cristy30092792011-02-22 02:06:14 +0000302<p>This option sets a transformation matrix, for use by subsequent <a
303href="#draw">-draw</a> or <a href="#transform">-transform</a> options. </p>
cristy3ed852e2009-09-05 21:47:34 +0000304
cristy30092792011-02-22 02:06:14 +0000305<p>The matrix entries are entered as comma-separated numeric values either in
306quotes or without spaces. </p>
cristy3ed852e2009-09-05 21:47:34 +0000307
cristy30092792011-02-22 02:06:14 +0000308<p>Internally, the transformation matrix has 3x3 elements, but three of them
309are omitted from the input because they are constant. The new (transformed)
310coordinates (<em class="arg">x'</em>, <em class="arg">y'</em>) of a pixel at
311position (<em class="arg">x</em>, <em class="arg">y</em>) in the original
312image are calculated using the following matrix equation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000313
314<div class="eqn">
315<img alt="affine transformation" src="../images/affine.png"/>
316</div>
317
cristy30092792011-02-22 02:06:14 +0000318<p> The size of the resulting image is that of the smallest rectangle that
319contains the transformed source image. The parameters <em
320class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em>
321subsequently shift the image pixels so that those that are moved out of the
322image area are cut off.</p>
cristy3ed852e2009-09-05 21:47:34 +0000323
cristy30092792011-02-22 02:06:14 +0000324<p>The transformation matrix complies with the left-handed pixel coordinate
325system: positive <em class="arg">x</em> and <em class="arg">y</em> directions
326are rightward and downward, resp.; positive rotation is clockwise.</p>
cristy3ed852e2009-09-05 21:47:34 +0000327
cristy30092792011-02-22 02:06:14 +0000328<p> If the translation coefficients <em class="arg">t<sub>x</sub></em> and <em
329class="arg">t<sub>y</sub></em> are omotted they default to 0,0. Therefore,
330four parameters suffice for rotation and scaling without translation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000331
cristy30092792011-02-22 02:06:14 +0000332<p>Scaling by the factors <em class="arg">s<sub>x</sub></em> and <em
333class="arg">s<sub>y</sub></em> in the <em>x</em> and <em>y</em> directions,
334respectively, is accomplished with the following.</p>
335
336<p>See <a href="#transform">-transform</a>, and the <a
337href="#distort">-distort</a> method '<kbd>Affineprojection</kbd> for more
338information </p>
339
cristy3ed852e2009-09-05 21:47:34 +0000340
341<p class="crtsnip">
342 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
343</p>
344
345<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>
346
347<p class="crtsnip">
348 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
349</p>
350
351<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
352<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
353
354<p class="crtsnip">
355 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
356</p>
357
358<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>
359
360<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>
361
362<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000363 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000364</div>
365
366<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>
367
368<p>Used to set a flag on an image indicating whether or not to use existing alpha
369channel 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>
370
371
372<table class="doc">
373 <tbody>
374 <tr valign="top">
375 <th align="left" style="width: 8%">type</th>
376 <th align="left">Description</th>
377 </tr>
378
379 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000380 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000381 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000382 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
383 should be used instead of this, unless you specifically need to
384 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
385 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000386
387 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000388 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000389 <td valign="top">
390 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000391 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000392
393 <tr valign="top">
394 <td valign="top"><kbd>Set</kbd></td>
395 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000396 Activates the alpha/matte channel. If it was previously turned off
397 then it also resets the channel to opaque. If the image already had
398 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000399
400 <tr valign="top">
401 <td valign="top"><kbd>Opaque</kbd></td>
402 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000403 Enables the alpha/matte channel and forces it to be fully opaque.
404 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000405
406 <tr valign="top">
407 <td valign="top"><kbd>Transparent</kbd></td>
408 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000409 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000410 transparent. This effectively creates a fully transparent image the
411 same size as the original and with all its original RGB data still
412 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000413
414 <tr valign="top">
415 <td valign="top"><kbd>Extract</kbd></td>
416 <td valign="top">
417 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000418 '<kbd>Off</kbd>' the the image's transparency, so as to generate
419 a gray-scale mask of the image's shape. The alpha channel data is left
420 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
421 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000422
423 <tr valign="top">
424 <td valign="top"><kbd>Copy</kbd></td>
425 <td valign="top">
426 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000427 gray-scale intensity of the image, into the alpha channel, converting
428 a gray-scale mask into a transparent shaped mask ready to be colored
429 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000430
431 <tr valign="top">
432 <td valign="top"><kbd>Shape</kbd></td>
433 <td valign="top">
434 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000435 the current background color. That is the RGB color channels is
436 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000437 </td></tr>
438
439 <tr valign="top">
440 <td valign="top"><kbd>Background</kbd></td>
441 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000442 Set any fully-transparent pixel to the background color, while leaving
443 it fully-transparent. This can make some image file formats, such as
444 PNG, smaller as the RGB values of transparent pixels are more uniform,
445 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000446 </td></tr>
447 </tbody>
448</table>
449
450<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000451"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000452>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000453Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000454
455
456<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000457 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000458 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
459 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
460 -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>
461</div>
462
463<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>
464
465<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>
466
467
468<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>
469
470<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>
471
472<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>
473<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
474
475<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>
476
477<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>
478
479<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000480 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000481</div>
482
483<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
484drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
485
486<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
487drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
488antialiasing edge pixels. This will then reduce the number of colors added to
489an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000490are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000491
492<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000493 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000494</div>
495
496<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>
497
498<p>This option creates a single longer image image, by joining all the current
499images in sequence top-to-bottom. Use <a href="#append">+append</a> to
500stack images left-to-right. </p>
501
502<p>If they are not of the same width, narrower images are padded with the
503current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000504position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000505href="#gravity">-gravity</a> setting. </p>
506
507
508<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000509 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000510</div>
511
512<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>
513
514
515<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000516 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000517</div>
518
519<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>
520
521<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>
522
523<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
524
cristyd934d102009-10-10 12:55:13 +0000525
526
cristy3ed852e2009-09-05 21:47:34 +0000527<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000528 <h4><a id="auto-gamma"></a>-auto-gamma</h4>
cristy3ed852e2009-09-05 21:47:34 +0000529</div>
530
531<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Automagically adjust gamma level of image.</td><td style='text-align:right;'></td></tr></table>
532
cristyd934d102009-10-10 12:55:13 +0000533<p>This calculates the mean values of an image, then applies a calculated <a
534href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
535image it will get a have a value of 50%. </p>
536
cristyd0bd44a2010-09-24 12:38:11 +0000537<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000538
539<p>This works well for real-life images with little or no extreme dark and
540light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000541dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000542</p>
543
544<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristy2dcd6822011-06-13 16:21:20 +0000545'<em>sync</em>' flag for channel synchronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000546values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000547>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000548together by the same gamma value, preserving colors. </p>
549
550
551
cristy3ed852e2009-09-05 21:47:34 +0000552<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000553 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000554</div>
555
556<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>
557
cristyd934d102009-10-10 12:55:13 +0000558<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000559minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000560href="#level" >-level</a> operator to stretch the values to the full range of
561values. </p>
562
cristy83543962009-10-16 19:04:28 +0000563<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000564JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
565for the <a href="#level" >-level</a> operation. On the other hand it is the
566right operator to use for color stretching gradient images being used to
567generate Color lookup tables, distortion maps, or other 'mathematically'
568defined images. </p>
569
570<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
571href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
572>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
573problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000574>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000575
576<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristy2dcd6822011-06-13 16:21:20 +0000577special '<em>sync</em>' flag for channel synchronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000578which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000579href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
580'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000581together by the same gamma value, preserving colors, and ignoring
582transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000583
584
cristy3ed852e2009-09-05 21:47:34 +0000585<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000586 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000587</div>
588
589<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>
590
cristy83543962009-10-16 19:04:28 +0000591<p>This operator reads and resets the EXIF image profile setting 'Orientation'
592and then performs the appropriate 90 degree rotation on the image to orient
593the image, for correct viewing. </p>
594
595<p>This EXIF profile setting is usually set using a gravity sensor in digital
596camara, however photos taken directly downward or upward may not have an
597appropriate value. Also images that have been orientation 'corrected' without
598reseting this setting, may be 'corrected' again resulting in a incorrect
599result. If the he EXIF profile was previously stripped, the <a
600href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
601
602
cristy3ed852e2009-09-05 21:47:34 +0000603<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000604 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000605</div>
606
607<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>
608
609<p>An error results if the images are not identically sized.</p>
610
cristy3ed852e2009-09-05 21:47:34 +0000611
612<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000613 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000614</div>
615
616<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>
617
618<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>
619
620<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000621 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000622</div>
623
624<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the background color.</td><td style='text-align:right;'></td></tr></table>
625
626<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>
627
628<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000629 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000630</div>
631
632<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>
633
cristye6378132009-10-26 20:05:17 +0000634<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 +0000635
cristye6378132009-10-26 20:05:17 +0000636<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>
637<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 +0000638
639<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000640 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000641</div>
642
643<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>
644
645<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>
646
647<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>
648
649<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
650negative results without clipping to the color value range
651(0..QuantumRange).</p>
652
653<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +0000654<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 +0000655</p>
656
657<div style="margin: auto;">
cristy37e0dfd2011-03-06 16:35:34 +0000658 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000659</div>
660
661<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>
662
663<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000664 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000665</div>
666
cristy5cadd612009-09-21 19:33:41 +0000667<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>
668
669<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.
670</p>
cristy3ed852e2009-09-05 21:47:34 +0000671
672
673<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000674 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000675</div>
676
cristy83a272e2010-05-07 20:40:35 +0000677<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 +0000678
679<p>Blend will average the images together ('plus') according to the
680percentages given and each pixels transparency. If only a single percentage
681value is given it sets the weight of the composite or 'source' image, while
682the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000683<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
684'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000685
686
687<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000688 <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 +0000689</div>
690
691<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>
692
693<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000694 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000695</div>
696
697<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>
698
699<div style="margin: auto;">
700
701<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000702 <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 +0000703</div>
704
705<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>
706
cristyb15553d2010-07-03 22:53:14 +0000707<p>Convolve the image with a Gaussian or normal distribution using the given
708<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000709
710<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
711</div>
712
cristyb15553d2010-07-03 22:53:14 +0000713<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000714determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000715
cristyb15553d2010-07-03 22:53:14 +0000716<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000717array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000718integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000719radius that will provide meaningful results for the Gaussian distribution.
720</p>
721
722<p>The larger the <em class="arg" >Radius</em> the radius the slower the
723operation is. However too small a <em class="arg" >Radius</em>, and sever
724aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
725should be at least twice the <em class="arg" >Sigma</em> value, though three
726times will produce a more accurite result. </p>
727
728<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
729by taking advantage of the separability properties of the distribution. Here
730we apply a single-dimensional Gaussian matrix in the horizontal direction,
731then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000732
733<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
734pixels which are outside the image proper are blurred into the final result.
735</p>
736
737
738<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000739 <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 +0000740</div>
741
742<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>
743
744<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
745Average (EWA) of the source image, scaled according to the grayscale
746mapping. </p>
747
748<p>The ellipse is weighted with sigma set to the given <em class="arg"
749>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
750defaults to the <em class="arg" >Width</em> for a normal circular Guassian
751weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
752horizontal clock-wise. </p>
753
754<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
755pixels which are outside the image proper are blurred into the final result.
756</p>
757
758
759<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000760 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000761</div>
762
763<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>
764
cristybc9539a2010-08-16 18:06:20 +0000765<p>Set the width and height using the <em class="arg">size</em> portion of the
766<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
767ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000768
cristybc9539a2010-08-16 18:06:20 +0000769<p>Set the border color by preceding with the <a
770href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000771
cristybc9539a2010-08-16 18:06:20 +0000772<p>The <a href="#border">-border</a> operation is affected by the current <a
773href="#compose">-compose</a> setting and assumes that this is using the default
774'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
775size colors by the current <a href="#bordercolor">-bordercolor</a> before
776overlaying the original image in the center of this net image. This means that
777with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000778be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000779<p>See also the <a href="#frame">-frame</a> option, which has more
780functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000781
782<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000783 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000784</div>
785
786<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>
787
788<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
789
790<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
791
792<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000793 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000794</div>
795
796<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>
797
798<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000799 <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 +0000800</div>
801
802<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>
803
cristyefb2bdb2010-11-20 19:35:22 +0000804<p>Brightness and Contrast values apply changes to the input image. They are
805not absolute settings. A brightness or contrast value of zero means no change.
806The range of values is -100 to +100 on each. Positive values increase the
807brightness or contrast and negative values decrease the brightness or contrast.
808To control only contrast, set the brightness=0. To control only brightness,
809set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000810
cristyefb2bdb2010-11-20 19:35:22 +0000811<p>You may also use <a href="#fill">-channel</a> to control which channels to
812apply the brightness and/or contrast change. The default is to apply the same
813transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000814
cristyefb2bdb2010-11-20 19:35:22 +0000815<p>Brightness and Contrast arguments are converted to offset and slope of a
816linear transform and applied
817using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000818
cristyefb2bdb2010-11-20 19:35:22 +0000819<p>The slope varies from 0 at contrast=-100 to almost vertical at
820contrast=+100. For brightness=0 and contrast=-100, the result are totally
821midgray. For brightness=0 and contrast=+100, the result will approach but
822not quite reach a threshold at midgray; that is the linear transformation
823is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000824
cristyefb2bdb2010-11-20 19:35:22 +0000825<p>Negative slopes, i.e. negating the image, are not possible with this
826function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000827
cristyefb2bdb2010-11-20 19:35:22 +0000828<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
829at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
830totally white. Similarly, when contrast=0 and brightness=-100, the result is
831totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000832
cristyefb2bdb2010-11-20 19:35:22 +0000833<p>As the range of values for the arguments are -100 to +100, adding the '%'
834symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000835
836<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000837 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000838</div>
839
840<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>
841
842<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000843 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000844</div>
845
846<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>
847
cristy71a3f602010-09-15 12:38:16 +0000848<p>This option sets the caption meta-data of an image read in after this
849option has been given. To modify a caption of images already in memory use
850"<kbd><a href="#set">-set</a> caption</kbd>". </p>
851
852<p>The caption can contain special format characters listed in the <a
853href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000854Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000855is finally assigned to the individual images. </p>
856
857<p>If the first character of <em class="arg">string</em> is <em
858class="arg">@</em>, the image caption is read from a file titled by the
859remaining characters in the string. Comments read in from a file are literal;
860no embedded formatting characters are recognized.</p>
861
862<p>Caption meta-data ais not visible on the image itself. To do that use the
863<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
864instead.</p>
865
866<p>For example,</p>
867
868<p class="crtsnip">
869 -caption "%m:%f %wx%h" bird.miff
870</p>
871
872<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
873that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
874480.</p>
875
876
cristy3ed852e2009-09-05 21:47:34 +0000877<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000878 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000879</div>
880
881<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>color correct with a color decision list.</td><td style='text-align:right;'></td></tr></table>
882
883<p>Here is an example color correction collection:</p>
884
885<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000886&lt;?xml version="1.0" encoding="UTF-8"?&gt;
887&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
888 &lt;ColorCorrection id="cc06668"&gt;
889 &lt;SOPNode&gt;
890 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
891 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
892 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
893 &lt;/SOPNode&gt;
894 &lt;SATNode&gt;
895 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
896 &lt;/SATNode&gt;
897 &lt;/ColorCorrection&gt;
898&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000899</pre>
900
901<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000902 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000903</div>
904
905<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>
906
cristyefb2bdb2010-11-20 19:35:22 +0000907<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
908<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
909<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
910<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000911
cristy83a272e2010-05-07 20:40:35 +0000912<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000913abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
914'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
915'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000916
cristy83a272e2010-05-07 20:40:35 +0000917For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
918you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000919<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000920 -channel Red,Blue
921</p>
922<p>or you can use the short hand form</p>
923<p class="crtsnip">
924 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000925</p>
926
cristy2dcd6822011-06-13 16:21:20 +0000927<p>All the channels that are present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000928special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
929but generally any operators that are generally 'grey-scale' image operators,
930will understand this setting. See individual operator documentation. </p>
931
cristydcca3fa2010-12-29 21:50:07 +0000932<br />
cristy83a272e2010-05-07 20:40:35 +0000933
cristy2dcd6822011-06-13 16:21:20 +0000934<p>On top of the normal channel selection an extra flag can be specified,
cristy83a272e2010-05-07 20:40:35 +0000935'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000936operators that understand this flag should perform: cross-channel
cristy2dcd6822011-06-13 16:21:20 +0000937synchronization of the channels. If not specified, then most grey-scale
cristybac7a162010-06-15 19:57:29 +0000938operators will apply their image processing operations to each individual
939channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000940setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000941
942<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000943<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000944together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000945it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000946independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000947
cristydcca3fa2010-12-29 21:50:07 +0000948<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000949and the <a href="#compose">-compose</a> mathematical methods, also understands
950the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
951to the alpha channel (if present). That is to say it will modify the image
952processing with the understanding that fully-transparent colors should not
953contribute to the final result. </p>
954
cristy2dcd6822011-06-13 16:21:20 +0000955<p>Basically, by default, operators work with color channels in synchronous, and
cristybac7a162010-06-15 19:57:29 +0000956treats transparency as special, unless the <a href="#channel">-channel</a>
957setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
958How each operator does this depends on that operators current implementation.
959Not all operators understands this flag at this time, but that is changing.
960</p>
cristy83a272e2010-05-07 20:40:35 +0000961
962<p>To print a complete list of channel types, use <a href="#list">-list
963channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000964
cristydcca3fa2010-12-29 21:50:07 +0000965<br />
cristyd934d102009-10-10 12:55:13 +0000966
967<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000968'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
969channels except the transparency channel, and that all the color channels are
970to be modified in exactly the same way, with a understanding of transprancy
971(depending on the operation being applied). The 'plus' form <a
972href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000973
974<p>Options that are affected by the <a href="#channel" >-channel</a> setting
975include the following.
976
977<a href="#auto-gamma">-auto-gamma</a>,
978<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000979<a href="#black-threshold">-black-threshold</a>,
980<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000981<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000982<a href="#clut">-clut</a>,
983<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000984<a href="#composite">-composite</a> (Mathematical compose methods only),
985<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000986<a href="#contrast-stretch">-contrast-stretch</a>,
987<a href="#evaluate">-evaluate</a>,
988<a href="#function">-function</a>,
989<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000990<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000991<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000992<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000993<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000994<a href="#negate">-negate</a>,
995<a href="#normalize">-normalize</a>,
996<a href="#ordered-dither">-ordered-dither</a>,
997<a href="#radial-blur">-radial-blur</a>,
998<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000999<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +00001000<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +00001001<a href="#white-threshold">-white-threshold</a>.
1002</p>
1003
cristyd0bda5e2010-09-21 16:22:45 +00001004<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +00001005>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +00001006href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +00001007default). These operators have yet to be made to understand the newer 'Sync'
1008flag. </p>
1009
cristybac7a162010-06-15 19:57:29 +00001010<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
1011the image before thresholding, if no <a href="#channel" >-channel</a> setting
1012has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +00001013
1014<p>Also some operators such as <a href="#blur">-blur</a>, <a
1015href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
1016color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
1017href="#channel" >-channel</a>. Generally this done to ensure that
1018fully-transparent colors are treated as being fully-transparent, and thus any
1019underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +00001020resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +00001021convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +00001022and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +00001023
cristybac7a162010-06-15 19:57:29 +00001024<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +00001025color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +00001026alpha channel present, and the <a href="#channel" >-channel</a> setting tells
1027the operator to apply the operation using alpha channels. The <a
1028href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +00001029
cristy3ed852e2009-09-05 21:47:34 +00001030
1031<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001032 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +00001033</div>
1034
1035<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>
1036
1037<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001038 <h4><a id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001039</div>
1040
1041<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>
1042
1043<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001044 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001045</div>
1046
1047<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>
1048
cristyefb2bdb2010-11-20 19:35:22 +00001049<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>
1050and <em class="arg">height</em> given in the of the <em class="arg">size</em>
1051portion of the <em class="arg">geometry</em> argument give the number of
1052columns and rows to remove. The <em class="arg">offset</em> portion of
1053the <em class="arg">geometry</em> argument is influenced by
1054a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +00001055
cristyefb2bdb2010-11-20 19:35:22 +00001056<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
1057and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00001058
cristyacc04882011-05-04 23:03:43 +00001059<p>While it can remove internal rows and columns of pixels, it is more
1060typically used with as <a href="#gravity">-gravity</a> setting and zero
1061offsets so as to remove a single edge from an image. Compare this to <a
1062href="#shave" >-shave</a> which removes equal numbers of pixels from oppisite
1063sides of the image. </p>
cristydcca3fa2010-12-29 21:50:07 +00001064
cristyacc04882011-05-04 23:03:43 +00001065<p>Using <a href="#chop">-chop</a> will effectivally undo the results of a <a
1066href="#splice">-splice</a> that was given the same <em
1067class="arg">geometry</em> and <a href="#gravity">-gravity</a> settings. </p>
cristydcca3fa2010-12-29 21:50:07 +00001068
1069
cristy3ed852e2009-09-05 21:47:34 +00001070<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001071 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001072</div>
1073
1074<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>
1075
1076<p>If a clipping path is present, it is applied to subsequent operations.</p>
1077
1078<p>For example, in the command</p>
1079
1080<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
1081<p>only the pixels within the clipping path are negated.</p>
1082
1083<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1084
1085<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001086 <h4><a id="clip-mask"></a>-clip-mask</h4>
cristy3ed852e2009-09-05 21:47:34 +00001087</div>
1088
1089<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>
1090
cristy30092792011-02-22 02:06:14 +00001091<p>Use the given image as a 'do-not-modify' mask of the current images in the
1092current image sequence. Assuming the clipmask is a greyscale image the same
1093size at the one already in memory, any areas that is white will not be
1094modified by any of the 'image processing operators' that follow, until the
1095mask is removed. Pixels in the black areas of the clip mask will be modified
1096as normal. </p>
1097
1098<p>In some ways this is similar to (though not the same) as defining
1099a rectangular <a href="#region" >-region</a>, or using the negative of the
1100mask (thrid) image in a three image <a href="#composite" >-composite</a>,
1101operation. </p>
1102
1103
cristy3ed852e2009-09-05 21:47:34 +00001104<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001105 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001106</div>
1107
1108<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>
1109
cristyd241f442011-03-29 13:50:49 +00001110<p>This is almost identical to <a href="#clip">-clip</a>. </p>
cristy30092792011-02-22 02:06:14 +00001111
1112
cristy3ed852e2009-09-05 21:47:34 +00001113<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001114 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001115</div>
1116
cristy8b9dd952011-03-21 22:56:18 +00001117<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 +00001118
cristydcca3fa2010-12-29 21:50:07 +00001119<p>Inside parenthesis (where the operator is normally used) it will make a
1120clone of the images from the last 'pushed' image sequence, and adds them to
1121the end of the current image sequence. Outside parenthesis
1122(not recommended) it clones the images from the current image sequence. </p>
1123
cristy3ed852e2009-09-05 21:47:34 +00001124<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000011250. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001126example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001127represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001128dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1129spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
cristy8b9dd952011-03-21 22:56:18 +00001130effectively clone all the images. </p>
cristydcca3fa2010-12-29 21:50:07 +00001131
1132<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
cristybaacd172011-04-30 23:11:03 +00001133in the image sequence, and is thus equivalent to using a argument of
cristydcca3fa2010-12-29 21:50:07 +00001134'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001135
1136<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001137 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001138</div>
1139
1140<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
1141corresponding channel in the second image as a <b>c</b>olor
1142<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1143
1144<p>The second (LUT) image is ordinarily a gradient image containing the
1145histogram mapping of how each channel should be modified. Typically it is a
1146either a single row or column image of replacement color values. If larger
1147than a single row or column, values are taken from a diagonal line from
1148top-left to bottom-right corners.</p>
1149
1150<p>The lookup is further controlled by the <a
1151href="#interpolate">-interpolate</a> setting, which is especially handy for an
1152LUT which is not the full length needed by the ImageMagick installed Quality
1153(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1154'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1155gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1156lookup of color values. </p>
1157
1158<p>This operator is especially suited to replacing a grayscale image with a
1159specific color gradient from the CLUT image. </p>
1160
1161<p>Only the channel values defined by the <a href="#channel">-channel</a>
1162setting will have their values replaced. In particular, since the default <a
1163href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1164transparency (alpha/matte channel) is not affected, unless the <a
1165href="#channel">-channel</a> setting is modified. When the alpha channel is
1166set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1167as the other channels, implying that alpha/matte values are replaced using the
1168alpha/matte values of the original image. </p>
1169
cristyd0bda5e2010-09-21 16:22:45 +00001170<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001171transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1172href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001173assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001174replacement alpha values. That is you can use a gray-scale CLUT image to
1175adjust a existing images alpha channel, or you can color a gray-scale image
1176using colors form CLUT containing the desired colors, including transparency.
1177</p>
1178
cristyefb2bdb2010-11-20 19:35:22 +00001179<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1180according to the lookup of the full color RGB value from a 2D representation
1181of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001182
1183
1184<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001185 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001186</div>
1187
1188<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>
1189
cristyefb2bdb2010-11-20 19:35:22 +00001190<p>Overlay each image in an image sequence according to
1191its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1192an animation at each point in the animation sequence. All images should be
1193the same size, and are assigned appropriate GIF disposal settings for the
1194animation to continue working as expected as a GIF animation. Such frames
1195are more easily viewed and processed than the highly optimized GIF overlay
1196images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001197
cristyefb2bdb2010-11-20 19:35:22 +00001198<p>The animation can be re-optimized after processing using
1199the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1200there is no guarantee that the restored GIF animation optimization is
1201better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001202
1203
1204<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001205 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001206</div>
1207
1208<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>
1209
cristyefb2bdb2010-11-20 19:35:22 +00001210<p>Specify the amount of colorization as a percentage. Separate colorization
1211values can be applied to the red, green, and blue channels of the image with
1212a comma-delimited list of colorization
1213values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001214
1215<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001216 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001217</div>
1218
1219<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>
1220
1221<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1222
cristyefb2bdb2010-11-20 19:35:22 +00001223<p>This option only applies when the default X server visual
1224is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1225to <a href="#visual">-visual</a> for more details. By default,
1226a shared colormap is allocated. The image shares colors with
1227other X clients. Some image colors could be approximated,
1228therefore your image may look very different than intended.
1229If <kbd>private</kbd> is chosen, the image colors appear exactly
1230as they are defined. However, other clients may go <em>technicolor</em>
1231when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001232
1233<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001234 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001235</div>
1236
1237<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>
1238
cristyefb2bdb2010-11-20 19:35:22 +00001239<p>The actual number of colors in the image may be less than your request,
1240but never more. Note that this a color reduction option. Images with fewer
1241unique colors than specified by <em class="arg">value</em> will have any
1242duplicate or unused colors removed. The ordering of an existing color
1243palette may be altered. When converting an image from color to grayscale,
1244it is more efficient to convert the image to the gray colorspace before
1245reducing the number of colors. Refer to
1246the <a href="../www/quantize.html">
1247color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001248
1249<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001250 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001251</div>
1252
1253<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>
1254
cristyefb2bdb2010-11-20 19:35:22 +00001255<p>This option permits saturation changes, hue rotation, luminance to alpha,
1256and various other effects. Although variable-sized transformation matrices
1257can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1258for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1259Adobe Flash except offsets are in column 6 rather than 5 (in support of
1260CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001261
1262<p>As an example, to add contrast to an image with offsets, try this command:</p>
1263
1264<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001265 convert kittens.jpg -color-matrix \
1266 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1267 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1268 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1269 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1270 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1271 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
cristy2c839602010-04-03 02:32:08 +00001272</pre>
1273<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001274 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001275</div>
1276
1277<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>
1278
1279<p>Choices are:</p>
1280
1281<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001282 CMY CMYK Gray HSB
1283 HSL HWB Lab Log
1284 OHTA Rec601Luma Rec601YCbCr Rec709Luma
1285 Rec709YCbCr RGB sRGB Transparent
1286 XYZ YCbCr YCC YIQ
1287 YPbPr YUV
cristy3ed852e2009-09-05 21:47:34 +00001288</pre>
1289
1290<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1291
1292<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>
1293
1294<table class="doc">
1295 <caption>Conversion Of RGB To Other Color Spaces</caption>
1296 <tr><th align="left" valign="middle">CMY</th></tr>
1297 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1298 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1299 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1300 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1301 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1302 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1303 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1304 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1305
1306 <tr><th align="left" valign="middle">Gray</th></tr>
1307 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1308
1309 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1310 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1311 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1312 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1313
1314 <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>
1315 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1316 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1317 <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>
1318
1319 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1320 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1321 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1322 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1323
1324 <tr><th align="left" valign="middle">LAB</th></tr>
1325 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1326 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1327 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1328
1329 <tr><th align="left" valign="middle">LOG</th></tr>
1330 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1331 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1332 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1333
1334 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1335 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1336 <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>
1337 <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>
1338
1339 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1340 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1341
1342 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1343 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1344 <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>
1345 <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>
1346
1347 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1348 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1349
1350 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1351 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1352 <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>
1353 <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>
1354
1355 <tr><th align="left" valign="middle">sRGB</th></tr>
cristyf9a6c462011-04-24 14:01:11 +00001356 <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>
1357 <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>
1358 <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 +00001359
1360 <tr><th align="left" valign="middle">XYZ</th></tr>
1361 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1362 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1363 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1364
1365 <tr><th align="left" valign="middle">YCC</th></tr>
1366 <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>
1367 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1368 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1369
1370 <tr><th align="left" valign="middle">YCbCr</th></tr>
1371 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1372 <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>
1373 <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>
1374
1375 <tr><th align="left" valign="middle">YIQ</th></tr>
1376 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1377 <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>
1378 <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>
1379
1380 <tr><th align="left" valign="middle">YPbPr</th></tr>
1381 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1382 <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>
1383 <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>
1384
1385 <tr><th align="left" valign="middle">YUV</th></tr>
1386 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1387 <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>
1388 <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>
1389</table>
1390
1391<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001392 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001393</div>
1394
1395<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>
1396
1397<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>
1398
1399<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.
1400</p>
1401
cristy4949d522010-03-12 18:41:34 +00001402<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 +00001403<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001404 <h4><a id="comment"></a>-comment <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001405</div>
1406
1407<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>
1408
cristyd0bda5e2010-09-21 16:22:45 +00001409<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001410option has been given. To modify a comment of images already in memory use
1411"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001412
cristy71a3f602010-09-15 12:38:16 +00001413<p>The comment can contain special format characters listed in the <a
1414href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001415Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001416is finally assigned to the individual images. </p>
1417
1418<p>If the first character of <em class="arg">string</em> is <em
1419class="arg">@</em>, the image comment is read from a file titled by the
1420remaining characters in the string. Comments read in from a file are literal;
1421no embedded formatting characters are recognized.</p>
1422
1423<p>Comment meta-data are not visible on the image itself. To do that use the
1424<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1425instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001426
1427<p>For example,</p>
1428
1429<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001430 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001431</p>
1432
cristy71a3f602010-09-15 12:38:16 +00001433<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1434that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1435480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001436
1437<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001438 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001439</div>
1440
1441<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>
1442
cristybc9539a2010-08-16 18:06:20 +00001443<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1444a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001445
cristybc9539a2010-08-16 18:06:20 +00001446<p>This setting effects image processing operators that merge two (or more)
1447images together in some way. This includes the operators,
1448<a href="#composite">-composite</a>,
1449<a href="#layers">-layers</a> composite,
1450<a href="#flatten">-flatten</a>,
1451<a href="#mosaic">-mosaic</a>,
1452<a href="#layers">-layers</a> merge,
1453<a href="#border">-border</a>,
1454<a href="#frame">-frame</a>,
1455and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001456
cristybc9539a2010-08-16 18:06:20 +00001457<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1458command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001459
1460
1461<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001462 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001463</div>
1464
cristybc9539a2010-08-16 18:06:20 +00001465<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 +00001466
1467<p>Take the first image 'destination' and overlay the second 'source' image
1468according to the current <a href="#compose">-compose</a> setting. The location
1469of the 'source' or 'overlay' image is controlled according to <a
1470href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1471settings. </p>
1472
1473<p>If a third image is given this is treated as a gray-scale 'mask' image
1474relative to the first 'destination' image. This mask will limit what parts of
1475the destination can be modified by the image composition. However for the
1476'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1477Y-displacement image instead. </p>
1478
1479<p>If a <a href="#compose">-compose</a> method requires extra numerical
1480arguments or flags these can be provided by setting the <a
1481href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001482appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001483
1484<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1485image outside the overlay area. You can disable this by setting the special <a
1486href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1487to '<kbd>false</kbd>'. </p>
1488
1489
1490<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001491 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001492</div>
1493
1494<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>
1495
1496<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>
1497
1498<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1499
1500<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>
1501
1502<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>
1503
1504<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>
1505
1506<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>
1507
1508<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001509 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001510</div>
1511
1512<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>
1513
1514<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>
1515
1516<p>For a more pronounced effect you can repeat the option:</p>
1517
1518<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1519<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001520 <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 +00001521</div>
1522
1523<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>
1524
cristyd934d102009-10-10 12:55:13 +00001525<p>While performing the stretch, black-out at most <em
1526class="arg" >black-point</em> pixels and white-out at most <em
1527class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1528<em class="arg" >black-point %</em> pixels and white-out at most <em
1529class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001530
cristyd934d102009-10-10 12:55:13 +00001531<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1532>-contrast-stretch</a> will black-out at most <em class="arg"
1533>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1534minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1535class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1536>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001537
cristyd934d102009-10-10 12:55:13 +00001538<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1539the image's min and max values are stretched to 0 and <em class="QR"
1540>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1541clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001542>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001543prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001544
cristyd934d102009-10-10 12:55:13 +00001545<p>Internally operator works by creating a histogram bin, and then uses that
1546bin to modify the image. As such some colors may be merged together when they
1547originally fell into the same 'bin'. </p>
1548
1549<p>All the channels are normalized in concert by the came amount so as to
1550preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001551setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001552setting will normalize the RGB channels independently.</p>
1553
1554<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1555normalization of mathematical images. </p>
1556
1557<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001558
1559
1560<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001561 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001562</div>
1563
1564<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>
1565
cristy16ff93c2010-01-13 23:18:07 +00001566<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001567a comma-separated list of integers (with no spaces), ordered left-to right,
1568starting with the top row. Presently, only odd-dimensioned kernels are
1569supported, and therefore the number of entries in the specified <em
1570class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15717<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001572
cristyd934d102009-10-10 12:55:13 +00001573<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
1574positive and negative results are relative to a user-specified bias value.
1575This is important for non-HDRI compilations of ImageMagick when dealing with
1576convolutions that contain negative as well as positive values. This is
1577especially the case with convolutions involving high pass filters or edge
1578detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001579</p>
1580
cristyd934d102009-10-10 12:55:13 +00001581<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
1582negative results without clipping to the color value range (0..QuantumRange).
1583See the discussion on HDRI implementations of ImageMagick on the page <a
cristy47774982011-02-15 15:17:19 +00001584href="../www/high-dynamic-range.html">High
cristyd934d102009-10-10 12:55:13 +00001585Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1586href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1587<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1588entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001589
cristy3ed852e2009-09-05 21:47:34 +00001590
1591<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001592 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001593</div>
1594
1595<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>
1596
1597<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>
1598
1599<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>
1600
1601<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>
1602
1603<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>
1604
1605<p>By adding a exclamation character flag to the geometry argument, the
1606cropped images virtual canvas page size and offset is set as if the
1607geometry argument was a viewport or window. This means the canvas page size
1608is set to exactly the same size you specified, the image offset set
1609relative top left corner of the region cropped. </p>
1610
1611<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1612special single pixel transparent 'missed' image is returned, and a 'crop
1613missed' warning given. </p>
1614
cristy739df912009-10-24 16:10:18 +00001615<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 +00001616
1617<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001618 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001619</div>
1620
1621<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>
1622
1623<p><em class="arg">Amount</em> defines the number of positions each
1624colormap entry is shifted.</p>
1625
1626
1627<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001628 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001629</div>
1630
1631<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>
1632
1633<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>
1634
1635
1636<p>For example, to log cache and blob events, use.</p>
1637
1638<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1639<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1640
1641<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1642
1643<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1644
1645<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1646
1647<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>
1648
1649
1650<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001651 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001652</div>
1653
1654<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>
1655
1656<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1657
1658<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1659
1660
1661<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001662 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001663</div>
1664
1665<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>
1666
1667<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>
1668
1669<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>
1670
1671<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1672
1673
1674<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001675 <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 +00001676</div>
1677
cristyd0bd44a2010-09-24 12:38:11 +00001678<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 +00001679coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001680
cristyd0bda5e2010-09-21 16:22:45 +00001681<p>This option creates one or more definitions for coders and decoders to use
1682while reading and writing image data. Definitions are generally used to
1683control image file format coder modules, and image processing operations,
1684beyond what is provided by normal means. Defined settings are listed in <a
1685href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1686as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001687
cristyd0bda5e2010-09-21 16:22:45 +00001688<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1689definition of a flag is created with that name. This used to control on/off
1690options. Use <a href="#define">+define key</a> to remove definitions
1691previously created. Use <a href="#define">+define "*"</a> to remove all
1692existing definitions.</p>
1693
cristyd0bd44a2010-09-24 12:38:11 +00001694<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001695href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001696>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 +00001697Properties</a> in the defined value. </p>
1698
cristyefb2bdb2010-11-20 19:35:22 +00001699<p>The <em>option</em> and <em>key</em> are case-independent (they are
1700converted to lowercase for use within the decoders) while the <em>value</em>
1701is case-dependent.</p>
1702
cristyd0bda5e2010-09-21 16:22:45 +00001703<p>Such settings are global in scope, and effect all images and operations. </p>
1704
1705<p>The following definitions are just some of the artifacts that are
1706available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001707
cristydcca3fa2010-12-29 21:50:07 +00001708<dl>
cristy045bd902010-01-30 18:56:24 +00001709<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001710<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001711 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001712
cristy045bd902010-01-30 18:56:24 +00001713<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001714<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001715 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001716
cristy045bd902010-01-30 18:56:24 +00001717<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001718<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001719 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001720
cristy045bd902010-01-30 18:56:24 +00001721<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001722<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1723 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001724 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001725
cristy045bd902010-01-30 18:56:24 +00001726<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001727<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1728 compression factor is the reciprocal of the compression ratio. The valid
1729 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1730 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001731 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001732
cristy3ed852e2009-09-05 21:47:34 +00001733<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001734 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001735
cristy045bd902010-01-30 18:56:24 +00001736<dt>png:bit-depth=<em class="arg">value</em></dt>
1737<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001738<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1739 encoder to use a different bit-depth and color-type than it would have
1740 normally selected, but only if this does not cause any loss of image
1741 quality. Any attempt to reduce image quality is treated as an error and no
1742 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1743 can use these "defines" to cause it to be written as an 8-bit grayscale,
1744 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1745 you cannot force it to be written as a grayscale or indexed PNG. If you
1746 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1747 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1748 reduce the image quality prior to using the PNG encoder. Note that in
1749 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001750 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001751 8-bit depth.</dd>
1752
cristy87a7f072011-07-01 00:08:52 +00001753<dt>png:compression-level=<em class="arg">value</em></dt>
1754 <dd> valid values are 0 through 9, with 0 providing the least but fastest
1755 compression and 9 usually providing the best and always the slowest.</dd>
1756
1757<dt>png:compression-strategy=<em class="arg">value</em></dt>
1758 <dd> valid values are 0 through 4, meaning default, filtered, huffman_only,
1759 rle, and fixed ZLIB compression strategy.</dd>
1760
1761<dt>png:compression-filter=<em class="arg">value</em></dt>
1762 <dd> valid values are 0 through 7. 0-4 are the corresponding PNG filters,
1763 5 means adaptive filtering except for images with a colormap, 6 means
1764 adaptive filtering for all images, 7 means MNG "loco" compression.</dd>
1765
cristydcca3fa2010-12-29 21:50:07 +00001766<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1767<dt>png:include-chunk=<em class="arg">value</em></dt>
1768<dd>ancillary chunks to be excluded from or included in PNG output.
1769
1770 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1771 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1772 or the word <em class="arg">all</em> or
1773 the word <em class="arg">none</em>. There must be no spaces in the
1774 list. Although PNG chunk-names are case-dependent, you can use
1775 all lowercase names if you prefer.</p>
1776
cristyd241f442011-03-29 13:50:49 +00001777 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
1778 of the PNG encoder and have no effect on the PNG decoder.</p>
1779
cristydcca3fa2010-12-29 21:50:07 +00001780 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1781 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1782 only be written if gamma is not 1/2.2, since most decoders assume
1783 sRGB and gamma=1/2.2 when no colorspace information is included in
1784 the PNG file. Because the list is processed from left to right, you
1785 can achieve this with a single define:</p>
1786
1787<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001788 -define png:include-chunk=none,gAMA
cristydcca3fa2010-12-29 21:50:07 +00001789</pre>
1790
1791 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
1792 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any of
1793 these entries appearing in the list will be ignored.</p>
1794
1795 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1796 image has transparency, the PNG colortype is forced to be 4 or 6
1797 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1798 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1799 on the PNG colortype of the output image.</p>
1800
1801 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1802 following for PNG output:</p>
1803
1804<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001805 -define png:include-chunk=none,gama
cristydcca3fa2010-12-29 21:50:07 +00001806</pre>
1807
1808 <p>The default behavior is to include all known PNG ancillary chunks
cristyf7964272011-01-30 03:49:12 +00001809 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk,
1810 and to exclude all PNG chunks that are unknown to ImageMagick,
1811 regardless of their PNG "copy-safe" status as described in the
1812 PNG specification.</p>
cristyd241f442011-03-29 13:50:49 +00001813
1814 <p>Any chunk names that are not known to ImageMagick are ignored
1815 if they appear in either the "include-chunk" or "exclude-chunk" list.
1816 The ancillary chunks currently known to ImageMagick are
1817 <kbd>bKGD</kbd>, <kbd>cHRM</kbd>, <kbd>gAMA</kbd>, <kbd>iCCP</kbd>,
1818 <kbd>oFFs</kbd>, <kbd>pHYs</kbd>, <kbd>sRGB</kbd>, <kbd>tEXt</kbd>,
1819 <kbd>tRNS</kbd>, <kbd>vpAg</kbd>, and <kbd>zTXt</kbd>.</p>
1820
cristyf9a6c462011-04-24 14:01:11 +00001821 <p>You can also put <kbd>date</kbd> in the list to include or exclude
1822 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
1823 inserts in the output PNG.</p>
1824
1825</dd>
1826
1827<dt>png:preserve-colormap</dt>
1828 <dd>Use the existing image->colormap. Normally the PNG encoder will
1829 try to optimize the palette, eliminating unused entries and putting
1830 the transparent colors first. If this flag is set, that behavior
1831 is suppressed.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001832
cristy3ed852e2009-09-05 21:47:34 +00001833<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001834<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1835 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001836 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001837
cristy045bd902010-01-30 18:56:24 +00001838<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001839<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1840 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1841 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001842 included, the result is a single precision floating point format.
1843 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001844 double precision floating point format.</dd>
1845
cristydcca3fa2010-12-29 21:50:07 +00001846</dl>
cristy3ed852e2009-09-05 21:47:34 +00001847
cristyd0bda5e2010-09-21 16:22:45 +00001848<p>For example, to create a postscript file that will render only the black
1849pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001850
1851<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 +00001852<p>Set attributes of the image registry by prefixing the value with
1853<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1854use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001855
1856<p class="crtsnip">
1857-define registry:temporary-path=/data/tmp
1858</p>
1859
cristyd0bda5e2010-09-21 16:22:45 +00001860
1861
cristy3ed852e2009-09-05 21:47:34 +00001862<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001863 <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 +00001864</div>
1865
1866<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>
1867
1868<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>
1869
1870<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>
1871
1872
1873<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00001874 <h4><a id="delete"></a>-delete <em class="arg">indexes</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001875</div>
1876
1877<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>
1878
1879<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>
1880
1881
1882<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001883 <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 +00001884</div>
1885
1886<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>
1887
1888<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>
1889
1890<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>
1891
1892<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>
1893
1894<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>
1895
1896<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001897 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001898</div>
1899
1900<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>
1901
1902<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>
1903
1904<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001905 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00001906</div>
1907
1908<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>
1909
1910<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001911 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001912</div>
1913
1914<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>
1915
1916<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>
1917
1918<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001919 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00001920</div>
1921
1922<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>
1923
1924<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001925 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001926</div>
1927
1928<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>
1929
1930<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001931 <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 +00001932</div>
1933
1934<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>
1935
1936<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001937is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001938what part of the 'background' image is seen at each point of the overlaid
1939area. Much like the displacement map is a 'lens' that redirects light shining
1940through it so as to present a distorted view the original 'background' image
1941behind it. </p>
1942
1943<p>Any perfect grey areas of the displacement map produce a zero
1944displacement of the image. Black areas produce the given maximum negative
1945displacement of the lookup point, while white produce a maximum positive
1946displacement of the lookup. </p>
1947
1948<p>Note that it is the lookup of the 'background' that is displaced, not a
1949displacement of the image itself. As such an area of the displacement map
1950containing 'white' will have the lookup point 'shifted' by a positive amount,
1951and thus generating a copy of the destination image to the right/downward from
1952the correct position. That is the image will look like it may have been
1953'shifted' in a negative left/upward direction. Understanding this is a very
1954important in understanding how displacement maps work. </p>
1955
1956<p>The given arguments define the maximum amount of displacement in pixels
1957that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001958it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001959outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001960easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001961into the overlay area. </p>
1962
1963<p>The '%' flag makes the displacement scale relative to the size of the
1964overlay image (100% = half width/height of image). Using '!' switches
1965percentage arguments to refer to the destination image size instead.
1966these flags were added as of IM v6.5.3-5.</p>
1967
1968<p>Normally a single grayscale displacement map is provided, which with the
1969given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001970displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001971specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001972the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001973displacement, while the <em class="arg">mask image</em> is used for vertical Y
1974displacement. This allows you to define completely different displacement
1975values for the X and Y directions, and allowing you to lookup any point within
1976the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001977any other nearby pixel, producing complex 2 dimensional displacements, rather
1978than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001979
cristyd0bda5e2010-09-21 16:22:45 +00001980<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001981you can use the 'red' channel of the overlay image to specify the horizontal
1982or X displacement, and the 'green' channel for the vertical or Y displacement.
1983</p>
1984
cristyd0bd44a2010-09-24 12:38:11 +00001985<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 +00001986mask the transparency of the destination image. However areas outside the
1987overlaid areas will not be effected. </p>
1988
1989
1990<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001991 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001992</div>
1993
1994<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>
1995
1996<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1997
1998<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001999 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002000</div>
2001
2002<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>
2003
2004<p>The layer disposal method defines the way each the displayed image is to be
2005modified after the current 'frame' of an animation has finished being
2006displayed (after its 'delay' period), but before the next frame on an
2007animation is to be overlaid onto the display. </p>
2008
2009<p>Here are the valid methods:</p>
2010
2011<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002012 Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
2013 None 1 Do not dispose, just overlay next frame image.
2014 Background 2 Clear the frame area with the background color.
2015 Previous 3 Clear to the image prior to this frames overlay.
cristy3ed852e2009-09-05 21:47:34 +00002016</pre>
2017
2018<p>You can also use the numbers given above, which is what the GIF format
2019uses internally to represent the above settings. </p>
2020
cristyd0bda5e2010-09-21 16:22:45 +00002021<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002022
2023<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
2024resetting the layer disposal methods of images being read in. </p>
2025
2026<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
2027disposal method for images already in memory.</p>
2028
2029<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002030 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002031</div>
2032
2033<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>
2034
2035
2036<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002037 <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 +00002038</div>
2039
2040<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>
2041
2042<p>The opacity of the composite image is multiplied by the given percent, then
2043it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00002044is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00002045transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
2046are given, each image are dissolved to the percentages given. </p>
2047
2048<p>Note that dissolve percentages do not add, two opaque images dissolved
2049'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2050images, you would need to use dissolve values of '50,100'. </p>
2051
2052<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002053 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002054</div>
2055
2056<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>
2057
2058<p>The <em class="arg">arguments</em> is a single string containing a list
2059of floating point numbers separated by commas or spaces. The number of
2060and meaning of the floating point values depends on the distortion <em
2061class="arg">method</em> being used. </p>
2062
2063<p>Choose from these distortion types:</p>
2064
2065<table class="doc">
2066 <tr valign="top">
2067 <th align="left" style="width: 8%">Method</th>
2068 <th align="left">Description</th>
2069 </tr>
2070
2071 <tr valign="top">
2072 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
2073 <br/>or &nbsp; <kbd>SRT</kbd></td>
2074 <td valign="top">
2075 Distort image by first scaling and rotating about a given 'center',
2076 before translating that 'center' to the new location, in that order. It
2077 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
2078 distortion, but without shearing effects. It also provides a good way
2079 of rotating and displacing a smaller image for tiling onto a larger
2080 background (IE 2-dimensional animations). <br/>
2081
2082 The number of arguments determine the specific meaning of each
2083 argument for the scales, rotation, and translation operations. <br/>
2084
2085 <table style="margin-left:auto; margin-right:auto;">
2086 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
2087 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
2088 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00002089 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002090 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
2091 <tr><td>5:</td>
2092 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2093 <tr><td>6:</td>
2094 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
2095 <tr><td>7:</td>
2096 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
2097 &nbsp; NewX,NewY</em></td></tr>
2098 </table>
2099
cristyd0bda5e2010-09-21 16:22:45 +00002100 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00002101 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2102
2103 <tr valign="top">
2104 <td valign="top"><kbd>Affine</kbd></td>
2105 <td valign="top">
2106 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002107 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002108 point values are given allowing the image to be linearly scaled,
2109 rotated, sheared, and translated, according to those three points. See
2110 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2111 distortions. <br/>
2112
2113 More than 3 sets given control point pairs (12 numbers) is least
2114 squares fitted to best match a lineary affine distortion. If only 2
2115 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002116 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002117 flipping or changes in aspect ratio to the resulting image. If only one
2118 control point pair is provides the image is only translated, (which may
2119 be a floating point non-integer translation). <br/>
2120
2121 This distortion does not include any form of perspective distortion.
2122 </td>
2123
2124 </tr>
2125
2126 <tr valign="top">
2127 <td valign="top"><kbd>AffineProjection</kbd></td>
2128 <td valign="top">
2129 Linearly distort an image using the given Affine Matrix of 6
2130 pre-calculated coefficients forming a set of Affine Equations to map
2131 the source image to the destination image.
2132
2133 <div style="text-align: center"><em>
2134 s<sub>x</sub>, r<sub>x</sub>,
2135 r<sub>y</sub>, s<sub>y</sub>,
2136 t<sub>x</sub>, t<sub>y</sub>
2137 </em></div>
2138
2139 See <a href="#affine" >-affine</a> setting for more detail, and
2140 meanings of these coefficients. <br/>
2141
2142 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002143 alternative methods of defining this distortion, with ImageMagick doing
2144 the calculations needed to generate the required coefficients. You can
2145 see the internally generated coefficients, by using a <a
2146 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002147
2148 </tr>
2149
cristy3ed852e2009-09-05 21:47:34 +00002150 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002151 <td valign="top"><kbd>BilinearForward</kbd><br/>
2152 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002153 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002154 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2155 16 values (see below). Not that lines may not appear straight after
2156 distortion, though the distance between coordinates will remain
2157 consistent. <br/>
2158
2159 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2160 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2161 quadrilateral to a rectangle, while preserving the straigth line edges
2162 in each case. <br/>
2163
2164 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2165 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2166 color setting. Also if the quadraterial becomes 'flipped' the image
2167 may dissappear. <br/>
2168
2169 There are future plans to produce a true Bilinear distortion that will
2170 attempt to map any quadrilateral to any other quadrilateral, while
2171 preserving edges (and edge distance ratios).
2172
2173 </td>
cristy3ed852e2009-09-05 21:47:34 +00002174 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002175
2176 <tr valign="top">
2177 <td valign="top"><kbd>Perspective</kbd></td>
2178 <td valign="top">
2179 Perspective distort the images, using a list of 4 or more sets of
2180 control points (as defined below). More that 4 sets (16 numbers) of
2181 control points provide least squares fitting for more accurate
2182 distortions (for the purposes of image registration and panarama
2183 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2184 linear distortion. <br/>
2185
2186 Perspective Distorted images ensures that straight lines remain
2187 straight, but the scale of the distorted image will vary. The horizon
2188 is anti-aliased, and the 'sky' color may be set using the
2189 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2190 </tr>
2191
2192 <tr valign="top">
2193 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2194 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002195 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002196 pre-calculated coefficients. You can get these coefficients by looking
2197 at the <a href="#verbose" >-verbose</a> output of a
2198 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2199 If the last two perspective scaling coefficients are zero, the
2200 remaining 6 represents a transposed 'Affine Matrix'. </td>
2201
2202 </tr>
2203
2204 <tr valign="top">
2205 <td valign="top"><kbd>Arc</kbd></td>
2206 <td valign="top">
2207 Arc the image (variation of polar mapping) over the angle given around
2208 a circle. <br/>
2209 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2210 <tr valign="top"><td>Argument</td>
2211 <td>Meaning</td></tr>
2212 <tr valign="top"><td><em>arc_angle</em></td>
2213 <td>The angle over which to arc the image side-to-side</td></tr>
2214 <tr valign="top"><td><em>rotate_angle</em></td>
2215 <td>Angle to rotate resulting image from vertical center</td></tr>
2216 <tr valign="top"><td><em>top_radius</em></td>
2217 <td>Set top edge of source image at this radius</td></tr>
2218 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2219 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2220 </table>
2221
2222 The resulting image is always resized to best fit the resulting image,
2223 (as if using <a href="#distort" >+distort</a>) while attempting to
2224 preserve scale and aspect ratio of the original image as much as
2225 possible with the arguments given by the user. All four arguments will
2226 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2227
2228 This a variation of a polar distortion designed to try to preserve the
2229 aspect ratio of the image rather than direct Cartesian to Polar
2230 conversion. </td>
2231 </tr>
2232
2233 <tr valign="top">
2234 <td valign="top"><kbd>Polar</kbd></td>
2235 <td valign="top">
2236 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2237 the image. that is the height of the input image is mapped to the
2238 radius limits, while the width is wrapped around between the
2239 angle limits. <br/>
2240
2241 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2242
2243 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2244 center to the center of the image, and the angles going from -180 (top)
2245 to +180 (top). If <em>Rmax</em> is given the special value of
2246 '<code>0</code>', the the distance from the center to the nearest edge
2247 is used for the radius of the output image, which will ensure the whole
2248 image is visible (though scaled smaller). However a special value of
2249 '<code>-1</code>' will use the distance from the center to the furthest
2250 corner, This may 'clip' the corners from the input rectangular image,
2251 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2252 the same arguments. <br/>
2253
2254 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2255 output image center will default to <code>0,0</code> of the virtual
2256 canvas, and the image size adjusted to ensure the whole input image is
2257 made visible in the output image on the virtual canvas. </td>
2258
2259 </tr>
2260
2261 <tr valign="top">
2262 <td valign="top"><kbd>DePolar</kbd></td>
2263 <td valign="top">
2264 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2265 but generates the reverse Polar to Cartesian distortion. <br/>
2266
2267 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2268 the corners of the input image. However using the special
2269 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2270 distance) will ensure the whole distorted image is preserved in the
2271 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2272 reverse the distortion re-producing the original.
2273
2274 Note that as this distortion requires the area resampling of a circular
2275 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002276 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002277 form of 'super-sampling' image processing technique be used to produce
2278 a high quality result. </td>
2279
2280 </tr>
2281
2282 <tr valign="top">
2283 <td valign="top"><kbd>Barrel</kbd></td>
2284 <td valign="top">
2285 Given the four coefficients (A,B,C,D) as defined by <a
cristy6bcf48e2011-02-15 19:09:04 +00002286 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002287 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002288 correct radial lens distortions. That is in photographs, make straight
2289 lines straight again. <br/>
2290
2291 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2292 <em>X</em> , <em>Y</em> ] ] <br/>
2293 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2294 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2295 [ <em>X</em> , <em>Y</em> ] <br/>
2296 So that it forms the function <br/>
2297 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2298 <em>C</em>*r + <em>D</em> )<br/>
2299
2300 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2301 (defaulting to the center of the image). <br/>
2302 The second form is typically used to distort images, rather than
2303 correct lens distortions. <br/>
2304 </td>
2305
2306 </tr>
2307
2308 <tr valign="top">
2309 <td valign="top"><kbd>BarrelInverse</kbd></td>
2310 <td valign="top">
2311 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2312 arguments, and argument handling. However it uses the inverse
2313 of the radial polynomial,
2314 so that it forms the function <br/>
2315 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002316 <em>C</em>*r + <em>D</em> )<br/>
2317 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2318 distortion, just a different barrel-like radial distortion method.
2319
cristy3ed852e2009-09-05 21:47:34 +00002320 </td>
2321 </tr>
2322
2323 <tr valign="top">
2324 <td valign="top"><kbd>Shepards</kbd></td>
2325 <td valign="top">
2326 Distort the given list control points (any number) using an Inverse
2327 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002328 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2329 Method</a>). The control points in effect do 'localized' displacement
2330 of the image around the given control point (preserving the look and
2331 the rotation of the area near the control points. For best results
2332 extra control points should be added to 'lock' the positions of the
2333 corners, edges and other unchanging parts of the image, to prevent
2334 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002335
cristyd0bd44a2010-09-24 12:38:11 +00002336 The distortion has been likened to 'taffy pulling' using nails, or
2337 pins' stuck in a block of 'jelly' which is then moved to the new
2338 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002339
cristybaacd172011-04-30 23:11:03 +00002340 Internally it is equivalent to generating a displacement map (see <a
cristyd0bd44a2010-09-24 12:38:11 +00002341 href="#displace" >-displace</a>) for source image color look-up using
2342 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2343
2344 </td>
cristy3ed852e2009-09-05 21:47:34 +00002345 </tr>
2346
2347</table>
2348
cristyd0bd44a2010-09-24 12:38:11 +00002349<p>To print a complete list of distortion methods, use <a href="#list">-list
2350distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002351
2352<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2353'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2354defining how these points in the given image should be distorted in the
2355destination image. Each set of four floating point values represent a source
2356image coordinate, followed immediately by the destination image coordinate.
2357This produces a list of values such as...</p>
2358<div style="text-align: center"><em>
2359 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2360 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2361 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2362 ... &nbsp;
2363 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2364</em></div>
2365<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2366destination image. </p>
2367
2368<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2369needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2370perspective distortion of the built-in "rose:" image. Note how spaces were
2371used to group the 4 sets of coordinate pairs, to make it easier to read and
2372understand.</p>
2373
2374<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002375convert rose: -virtual-pixel black \<br/>
2376 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2377 rose_3d_rotated.gif</span></p>
2378<p>If more that the required number of coordinate pairs are given for
2379a distortion, the distortion method is 'least squares' fitted to produce the
2380best result for all the coordinate pairs given. If less than the ideal number
2381of points are given, the distort will generally fall back to a simpler form of
2382distortion that can handles the smaller number of coordinates (usally a linear
2383'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002384
cristyd0bda5e2010-09-21 16:22:45 +00002385<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002386find matching coordinate pairs in overlapping images, so as to improve the
2387'fit' of the distortion. Of course a bad coordinate pair can also make the
2388'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002389
2390<p>Colors are acquired from the source image according to the <a
2391href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002392magnified. However if the viewed image is minified (image becomes smaller),
2393a special area resampling function (added ImageMagick v6.3.5-9), is used to
2394produce a higher quality image. For example you can use
2395a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2396the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002397
cristyd0bd44a2010-09-24 12:38:11 +00002398<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2399convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2400 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2401 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002402<p>Note that a infinitely tiled perspective images involving the horizon can
2403be very slow to generate due to the use of the high quality 'area resampling'
2404function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2405using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2406(recommended if you plan to use super-sampling instead). </p>
2407
2408<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2409'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2410will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2411pixels. If you do not what these pixels to be visible, set the color to match
2412the rest of the ground. </p>
2413
2414<p>The output image size will by default be the same as the input image. This
2415means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002416the 'distorted space', those parts is clipped and lost. However if you use
2417the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2418will attempt (if possible) to show the whole of the distorted image, while
2419retaining a correct 'virtual canvas' offset, for image layering. This offset
2420may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2421is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002422
2423<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2424option:distort:viewport {geometry_string}</kbd>" setting which will specify
2425the size and the offset of the generated 'viewport' image of the distorted
2426image space.</p>
2427
2428<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2429{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2430that factor without changing the viewed contents of the distorted image. This
2431can be used either for 'super-sampling' the image for a higher quality result,
2432or for panning and zooming around the image (with appropriate viewport
2433changes, or post-distort cropping and resizing). </p>
2434
2435<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2436href="#distort" >-distort</a> to attempt to output the internal coefficients,
2437and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2438and debugging purposes. This many not be available for all distorts. </p>
2439
2440<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2441produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2442and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002443above settings. It is algorithmically slower however, though that may not be
2444the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002445
2446
2447<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002448 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002449</div>
2450
2451<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>
2452
cristyd0bda5e2010-09-21 16:22:45 +00002453<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 +00002454
2455<p>Dithering is turned on by default, to turn it off use the plus form of the
2456setting, <a href="#dither">+dither</a>. This will also also render PostScript
2457without text or graphic aliasing. Disabling dithering often (but not always)
2458leads to faster process, a smaller number of colors, but more cartoon like
2459image coloring. Generally resulting in 'color banding' effects in areas with
2460color gradients. </p>
2461
2462<p>The color reduction operators <a href="#colors">-colors</a>, <a
2463href="#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>
2464
2465<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>
2466
2467
2468<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002469 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002470</div>
2471
2472<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>
2473
2474<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>
2475
2476<p>The shape primitives:</p>
2477
2478<pre class="text">
2479 point x,y
2480 line x0,y0 x1,y1
2481 rectangle x0,y0 x1,y1
2482 roundRectangle x0,y0 x1,y1 wc,hc
2483 arc x0,y0 x1,y1 a0,a1
2484 ellipse x0,y0 rx,ry a0,a1
2485 circle x0,y0 x1,y1
2486 polyline x0,y0 ... xn,yn
2487 polygon x0,y0 ... xn,yn
2488 bezier x0,y0 ... xn,yn
2489 path path specification
2490 image operator x0,y0 w,h filename
2491</pre>
2492
2493<p>The text primitive:</p>
2494
2495<pre class="text">
2496 text x0,y0 string
2497</pre>
2498<p>The text gravity primitive:</p>
2499
2500<pre class="text">
2501 gravity NorthWest, North, NorthEast, West, Center,
2502 East, SouthWest, South, or SouthEast
2503</pre>
2504
2505<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>
2506
2507<p>The transformation primitives:</p>
2508
2509<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002510 rotate degrees
2511 translate dx,dy
2512 scale sx,sy
2513 skewX degrees
2514 skewY degrees
cristy3ed852e2009-09-05 21:47:34 +00002515</pre>
2516
2517<p>The pixel operation primitives:</p>
2518
2519<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002520 color x0,y0 method
2521 matte x0,y0 method
cristy3ed852e2009-09-05 21:47:34 +00002522</pre>
2523
2524<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>
2525
2526<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>
2527
2528<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2529
2530<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2531
2532<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>
2533
2534<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2535
2536<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>
2537
2538<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>
2539
2540<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>.
2541</p>
2542
2543<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2544
2545<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2546
2547<p class="crtsnip">
2548 -draw 'circle 100,100 150,150'
2549</p>
2550
2551<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
2552draw 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>
2553
2554<p class="crtsnip">
2555 -draw 'bezier 20,50 45,100 45,0 70,50'
2556</p>
2557<p class="crtsnip">
2558 -draw 'bezier 70,50 95,100 95,0 120,50'
2559</p>
2560
2561
2562<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>
2563
2564<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>
2565
2566<p class="crtsnip">
2567 -draw 'image SrcOver 100,100 225,225 image.jpg'
2568</p>
2569
cristybc9539a2010-08-16 18:06:20 +00002570<p>You can use 0,0 for the image size, which means to use the actual
2571dimensions found in the image header. Otherwise, it is scaled to the given
2572dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
cristy29c5c992011-06-25 13:58:49 +00002573a detailed discussion of alpha composition methods that are available.
2574The "special augmented compose operators" such as "dissolve" that require
2575arguments cannot be used at present with the <kbd>-draw image</kbd> option.
2576 </p>
cristy3ed852e2009-09-05 21:47:34 +00002577<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>
2578
2579<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2580
2581<p class="crtsnip">
cristy4bf6e232011-05-21 01:43:33 +00002582 -draw "text 100,100 'Works like magick!' "
cristy3ed852e2009-09-05 21:47:34 +00002583</p>
2584
2585<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2586
2587<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>
2588
2589<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2590
2591<p>The <kbd>scale</kbd> primitive scales them.</p>
2592
2593<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>
2594
2595<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
2596matrix.</p>
2597
2598<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>
2599
2600<pre class="text">
2601 point
2602 replace
2603 floodfill
2604 filltoborder
2605 reset
2606</pre>
2607
2608<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>
2609
2610<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>
2611
2612<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>
2613
2614<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2615
2616<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2617
cristy2dcd6822011-06-13 16:21:20 +00002618
cristy8b9dd952011-03-21 22:56:18 +00002619<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00002620 <h4><a id="duplicate"></a>-duplicate <em class="arg">count,indexes</em></h4>
cristy8b9dd952011-03-21 22:56:18 +00002621</div>
2622
cristy323f35b2011-03-24 23:05:13 +00002623<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 +00002624
cristy323f35b2011-03-24 23:05:13 +00002625<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 +00002626
2627<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002628 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002629</div>
2630
2631<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>
2632
2633<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002634 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002635</div>
2636
2637<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>
2638
2639<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002640 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002641</div>
2642
2643<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>
2644
2645<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2646
2647<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2648
cristyd0bda5e2010-09-21 16:22:45 +00002649
2650
cristy3ed852e2009-09-05 21:47:34 +00002651<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002652 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002653</div>
2654
2655<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>
2656
2657<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>
2658
2659<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002660 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002661</div>
2662
2663<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>
2664
2665<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2666
2667<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2668
2669
2670<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002671 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002672</div>
2673
2674<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>
2675
2676
2677<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002678 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002679</div>
2680
2681<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>perform histogram equalization on the image channel-by-channel.</td><td style='text-align:right;'></td></tr></table>
2682
2683<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>
2684
2685<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2686
2687<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>
2688
2689<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002690 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002691</div>
2692
2693<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>
2694
2695<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>
2696
2697<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>
2698
2699<table class="doc">
2700 <col width="25%" />
2701 <col width="75%" />
2702 <thead>
2703 <tr>
2704 <th><em class="arg">operator</em></th>
2705 <th>Summary (see further below for details)</th>
2706 </tr>
2707 </thead>
2708 <tbody>
2709
cristy3c98a4f2010-08-13 20:09:41 +00002710 <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 +00002711 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2712 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2713 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2714 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2715 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002716 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2717 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002718 <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>
2719 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2720 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002721 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002722 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002723 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2724 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2725 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2726 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2727 <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>
2728 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2729 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2730 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2731 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2732
2733 <tr><td>&nbsp;</td></tr>
2734
2735 <tr><td>Gaussian-noise</td></tr>
2736 <tr><td>Impulse-noise</td></tr>
2737 <tr><td>Laplacian-noise</td></tr>
2738 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2739 <tr><td>PoissonNoise</td></tr>
2740 <tr><td>Uniform-noise</td></tr>
2741
2742 <tr><td>&nbsp;</td></tr>
2743
2744 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2745 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2746 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2747 </tbody>
2748 </table>
2749
2750<p>The specified functions are applied only to each previously set <a
2751href="#channel" >-channel</a> in the image. If necessary, the results of the
2752calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2753class="QR">QuantumRange</em>]. The transparency channel of the image is
2754represented as a 'alpha' values (0 = fully transparent), so, for example, a
2755<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2756semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2757as a percentage of the <em class="QR">QuantumRange</em>.</p>
2758
2759<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2760<a href="#list">-list evaluate</a>.</p>
2761
2762<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2763<kbd>Multiply</kbd> methods can also be achieved using either the <a
2764href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2765appropriate argument, to linearly modify the overall range of color values.
2766Please note, however, that <a href="#level" >-level</a> treats transparency as
2767'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2768'alpha' values.</p>
2769
2770<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>
2771
cristyce66ab12010-10-21 23:36:32 +00002772<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>
2773
2774 <div style="text-align:center;">
2775 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2776 </div>
2777
2778<p> If the input image is squared, for example, using <a
2779href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2780
cristy3ed852e2009-09-05 21:47:34 +00002781<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>
2782
2783 <div style="text-align:center;">
2784 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2785 </div>
2786
2787<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2788normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2789href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2790to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2791with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2792with <kbd>Pow</kbd>.</p>
2793
2794<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2795converts the image values into a value according to a (co)sine wave function.
2796The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2797is biased 50% and normalized by 50% so as to fit in the respective color value
2798range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2799function (its frequency), and thus determines the number of 'waves' that will
2800be generated over the input color range. For example, if the <em
2801class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2802class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2803then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002804class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002805
2806 <div style="text-align:center;">
2807 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2808 </div>
2809
cristydcca3fa2010-12-29 21:50:07 +00002810<p>See also the <a href="#function" >-function</a> operator, which is a
2811multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002812
cristy63fed272010-03-07 19:08:45 +00002813<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002814 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002815</div>
2816
2817<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 +00002818
2819<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002820 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002821</div>
2822
2823<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>
2824
cristy3e2860c2010-01-24 01:36:30 +00002825<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 +00002826<p>This command reduces or expands a JPEG image to fit on an 800x600
2827display. If the aspect ratio of the input image isn't exactly 4:3, then the
2828image is centered on an 800x600 black canvas: </p>
2829
2830<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>
2831
cristy3ed852e2009-09-05 21:47:34 +00002832
2833<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>
2834
2835<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002836 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002837</div>
2838
2839<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>
2840
2841<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2842
cristy4949d522010-03-12 18:41:34 +00002843<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 +00002844
cristy4949d522010-03-12 18:41:34 +00002845<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 +00002846<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002847equivalent to:</p>
2848
2849<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>
2850<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>
2851
2852<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002853 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002854</div>
2855
2856<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>
2857
2858<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).
2859</p>
2860
2861<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>.
2862</p>
2863
2864<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002865 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002866</div>
2867
2868<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>
2869
2870<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002871 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002872</div>
2873
2874<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>
2875
cristydcca3fa2010-12-29 21:50:07 +00002876<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 +00002877
cristydcca3fa2010-12-29 21:50:07 +00002878<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 +00002879
2880<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>
2881
2882<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2883<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>
2884
2885<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2886<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>
2887
cristyd0bd44a2010-09-24 12:38:11 +00002888<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 +00002889
2890<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>
2891
2892<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2893 -evaluate log 1000 fft_image_spectrum.png</span></p>
2894<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>
2895
cristydcca3fa2010-12-29 21:50:07 +00002896<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 +00002897
2898<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>
2899
2900<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>
2901
cristydcca3fa2010-12-29 21:50:07 +00002902<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 +00002903
2904<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +00002905<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 +00002906</p>
2907
2908
2909<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002910 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002911</div>
2912
2913<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>
2914
2915<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>
2916
2917<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2918
2919<p>For example,</p>
2920
2921<p class="crtsnip">
2922 -fill blue
2923</p>
2924<p class="crtsnip">
2925 -fill "#ddddff"
2926</p>
2927<p class="crtsnip">
2928 -fill "rgb(255,255,255)"
2929</p>
2930
2931<p>See <a href="#draw">-draw</a> for further details.</p>
2932
2933<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2934
2935<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002936 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002937</div>
2938
cristyd0bda5e2010-09-21 16:22:45 +00002939<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
2940distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002941
cristyd0bda5e2010-09-21 16:22:45 +00002942<p>Use this option to affect the resizing operation of an image during
2943operations such as <a href="#resize">-resize</a> and <a href="#distort"
2944>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002945
2946<pre class="text">
2947 Point Hermite Cubic
2948 Box Gaussian Catrom
2949 Triangle Quadratic Mitchell
2950</pre>
2951
cristyd0bda5e2010-09-21 16:22:45 +00002952<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002953as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2954generally useless on their own as they are infinite filters that are being
2955clipped to the filters support size. Their direct use is not recommended
2956except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002957
cristydcca3fa2010-12-29 21:50:07 +00002958<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002959function that the <a href="#filter" >-filter</a> setting defines. That is
2960using these functions will define a 'Windowed' filter, appropriate to the
2961operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002962
2963<pre class="text">
2964 Lanczos Hamming Parzen
2965 Blackman Kaiser Welsh
2966 Hanning Bartlett Bohman
2967</pre>
2968
2969<p>Also one special self-windowing filter is also provided
2970<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2971on the current 'support' or 'lobes' expert settings (see below).</p>
2972
cristyd0bda5e2010-09-21 16:22:45 +00002973<p>If you do not select a filter with this option, the filter defaults to
2974<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2975if the image is enlarged. Otherwise the filter default to
2976<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002977
cristyd0bda5e2010-09-21 16:22:45 +00002978<p>To print a complete list of resize filters, use the <a href="#list">-list
2979filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002980
2981<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002982use of these expert settings (see also <a href="#define" >-define</a> and <a
2983href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002984
2985<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002986<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002987<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002988 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2989 Gaussian-like filters simple filters, or you may not get the expected
2990 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002991
cristyd0bda5e2010-09-21 16:22:45 +00002992<dt>-define filter:support=<em>radius</em></dt>
2993<dd>Set the filter support radius. Defines how large the filter should be and
2994 thus directly defines how slow the filtered resampling process is. All
2995 filters have a default 'prefered' support size. Some filters like
2996 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2997 this value. With simple filters this value either does nothing (but slow
2998 the resampling), or will clip the filter function in a detrimental way.
2999 </dd>
cristy3ed852e2009-09-05 21:47:34 +00003000
cristyd0bda5e2010-09-21 16:22:45 +00003001<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003002<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00003003 alternative way of specifying the 'support' range of the filter, that is
3004 designed to be more suited to windowed filters, especially when used for
3005 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003006
cristyd0bda5e2010-09-21 16:22:45 +00003007<dt>-define filter:b=<em>b-spline_factor</em></dt>
3008<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003009<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
3010 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
3011 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
3012 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00003013 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00003014 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003015
cristyd0bda5e2010-09-21 16:22:45 +00003016<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003017<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00003018 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00003019 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00003020 'Bessel' functions. If defined, no windowing function is used, unless the
3021 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003022
cristyd0bda5e2010-09-21 16:22:45 +00003023<dt>-define filter:window=<em>filter_function</em></dt>
3024<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
3025 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
3026 support range) with the given filter. This allows you to specify a filter
3027 function that is not normally used as a windowing function, such as
3028 <kbd>Box</kbd>, (which effectively turns off the windowing function),
3029 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
3030 </dd>
3031
3032<dt>-define filter:verbose=<em>1</em></dt>
3033<dd>This causes IM to print information on the final internal filter
3034 selection to standard output. This includes a commented header on the
3035 filter settings being used, and data allowing the filter weights to be
3036 easily graphed. </dd>
3037
3038<dd>Note however that some filters are internally defined in terms of other
3039 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
3040 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
3041 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
3042 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00003043
3044</dl>
3045
cristyd0bda5e2010-09-21 16:22:45 +00003046<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00003047
3048<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
3049 -set filter:window=bessel -set filter:lobes=8 \ <br/>
3050 -resize 150% image.jpg</span></p>
3051<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3052
3053<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
3054 -resize 150% image.jpg</span></p>
3055<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00003056filters, and 'verbose' for viewing the internal filter selection), are
3057provided for image processing experts who have studied and understood how
3058resize filters work. Without this knowledge, and an understanding of the
3059definition of the actual filters involved, using expert settings are more
3060likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00003061
3062
3063<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003064 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00003065</div>
3066
3067<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>
3068
3069
3070<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003071 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00003072</div>
3073
3074<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>create a <em>mirror image</em>.</td><td style='text-align:right;'></td></tr></table>
3075
cristy2dcd6822011-06-13 16:21:20 +00003076<p>reflect the scanlines in the vertical direction. The image will be mirrored
3077upside-down. </p>
3078
cristy3ed852e2009-09-05 21:47:34 +00003079
3080<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003081 <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 +00003082</div>
3083
cristy2dcd6822011-06-13 16:21:20 +00003084<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>
3085
3086<p>Flood fill starts from the given 'seed point' which is not gravity effected.
3087Any color that matches within <a href="#fuzz" >-fuzz</a> color distance of the
3088given <em class="arg">color</em> argument, connected to that 'seed point'
3089will be replaced with the current <a href="#fill" >-fill</a> color. </p>
3090
3091<p>Note that if the pixel at the 'seed point' does not itself match the given
3092<em class="arg">color</em> (according to <a href="#fuzz" >-fuzz</a>), then no
3093action will be taken. </p>
3094
3095<p>This operator works more like the <a href="#opaque" >-opaque</A> option, than
3096a 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>
3097
cristy3ed852e2009-09-05 21:47:34 +00003098
3099<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003100 <h4><a id="flop"></a>-flop</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%'>create a <em>mirror image</em>.</td><td style='text-align:right;'></td></tr></table>
3104
cristy2dcd6822011-06-13 16:21:20 +00003105<p>Reflect the scanlines in the horizontal direction, just like the image in
3106a vertical mirror. </p>
cristy3ed852e2009-09-05 21:47:34 +00003107
3108
3109<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003110 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003111</div>
3112
3113<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>
3114
3115<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>
3116
3117<p>In addition to the fonts specified by the above pre-defined list, you can
3118also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
3119is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
3120<kbd>x:fixed</kbd> is X11 font.</p>
3121
3122<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>
3123
3124
3125<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003126 <h4><a id="foreground"></a>-foreground <em class="arg">color</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%'>Define the foreground color.</td><td style='text-align:right;'></td></tr></table>
3130
3131<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3132
3133<p>The default foreground color is black.</p>
3134
3135<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003136 <h4><a id="format"></a>-format <em class="arg">type</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%'>the image format type.</td><td style='text-align:right;'></td></tr></table>
3140
cristy47774982011-02-15 15:17:19 +00003141<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 +00003142
3143<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>
3144
3145<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003146 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003147</div>
3148
3149<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>
3150
3151<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>
3152
3153<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003154 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003155</div>
3156
3157<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>
3158
cristybc9539a2010-08-16 18:06:20 +00003159<p>The color of the border is specified with the <a href="#mattecolor"
3160>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003161
cristybc9539a2010-08-16 18:06:20 +00003162<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
3163class="arg">geometry</em> argument indicates the amount of extra width and
3164height that is added to the dimensions of the image. If no offsets are given
3165in the <em class="arg">geometry</em> argument, then the border added is
3166a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3167the width and height of the border is partitioned to form an outer bevel of
3168thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3169<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3170</p>
3171
3172<p>The <a href="#frame">-frame</a> option is affected by the current <a
3173href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003174'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003175size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3176draws the frame of four distinct colors close to the current <a
3177href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3178center of this image. This means that with the default compose method of
3179'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3180href="#bordercolor">-bordercolor</a> setting.</p>
3181
3182<p>The image composition is not
3183affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003184
3185
3186<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003187 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003188</div>
3189
3190<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>
3191
3192<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003193 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003194</div>
3195
3196<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>
3197
3198<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>
3199
3200<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>
3201
3202<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>
3203
3204<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003205 Polynomial
3206 Sinusoid
3207 Arcsin
3208 Arctan
cristy3ed852e2009-09-05 21:47:34 +00003209</pre>
3210
3211<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3212
3213<dl class="doc">
3214<dt><kbd>Polynomial</kbd></dt>
3215<dd>
3216<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>
3217
3218<div style="text-align: center">
3219 -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>
3220</div>
3221
3222<p>will invoke a polynomial function given by</p>
3223
3224<div style="text-align: center">
3225 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3226 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3227 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3228</div>
3229
3230<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3231
3232<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>
3233
3234<table class="doc">
3235 <col width="35%" />
3236 <col width="35%" />
3237 <col width="30%" />
3238 <tr>
3239 <td>-evaluate Set <em class="arg">value</em> </td>
3240 <td>-function Polynomial <em class="arg">value</em></td>
3241 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3242 </tr>
3243 <tr>
3244 <td>-evaluate Add <em class="arg">value</em> </td>
3245 <td>-function Polynomial 1,<em class="arg">value</em></td>
3246 </tr>
3247 <tr>
3248 <td>-evaluate Subtract <em class="arg">value</em> </td>
3249 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3250 </tr>
3251 <tr>
3252 <td>-evaluate Multiply <em class="arg">value</em> </td>
3253 <td>-function Polynomial <em class="arg">value</em>,0</td>
3254 </tr>
3255 <tr>
3256 <td>+level black% x white%</td>
3257 <td>-function Polynomial A,B</td>
3258 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3259 </tr>
3260</table>
3261
3262<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>
3263</dd>
3264
3265<dt><kbd>Sinusoid</kbd></dt>
3266<dd>
3267<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>
3268
3269<div style="text-align: center">
3270 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3271</div>
3272
3273<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>
3274
3275<div style="text-align: center">
3276<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>
3277</div>
3278
3279<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>
3280
3281<p class="crtsnip">
3282 -function Sinusoid 3,-90,.2,.7
3283</p>
3284
3285<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>
3286
3287<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>
3288
3289<table class="doc">
3290 <tr>
3291 <td>-evaluate Sin <em class="arg">freq</em> </td>
3292 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3293 </tr>
3294 <tr>
3295 <td>-evaluate Cos <em class="arg">freq</em> </td>
3296 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3297 </tr>
3298</table>
3299</dd>
3300
3301<dt><kbd>ArcSin</kbd></dt>
3302<dd>
3303<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3304and can be used to generate cylindrical distortion and displacement maps.
3305The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003306of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003307
cristydcca3fa2010-12-29 21:50:07 +00003308<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003309 -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 +00003310</p>
cristy3ed852e2009-09-05 21:47:34 +00003311
3312<p>with all values given in terms of noramlize color values (0.0 for black,
33131.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3314for bout input (<em class="arg">width</em>), and output (<em
3315class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3316
cristydcca3fa2010-12-29 21:50:07 +00003317<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003318<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 +00003319</p>
cristy3ed852e2009-09-05 21:47:34 +00003320
3321</dd>
3322
3323<dt><kbd>ArcTan</kbd></dt>
3324<dd>
3325<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3326limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003327All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003328
cristydcca3fa2010-12-29 21:50:07 +00003329<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003330 -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 +00003331</p>
cristy3ed852e2009-09-05 21:47:34 +00003332
3333<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3334</p>
3335
cristydcca3fa2010-12-29 21:50:07 +00003336<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003337<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 +00003338</p>
cristy3ed852e2009-09-05 21:47:34 +00003339
3340</dd>
3341
3342</dl>
3343
3344
3345<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003346 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003347</div>
3348
3349<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>
3350
3351<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>
3352
3353<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>
3354
3355
3356<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003357 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003358</div>
3359
3360<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>
3361
3362<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>
3363
3364<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3365
3366
3367<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003368 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003369</div>
3370
3371<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>
3372
3373<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>
3374
3375<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>
3376
3377<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>
3378
3379<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>
3380
3381<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3382
3383<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003384 <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 +00003385</div>
3386
3387<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>
3388
cristyb15553d2010-07-03 22:53:14 +00003389<p>Convolve the image with a Gaussian or normal distribution using the given
3390<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003391
3392<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3393</div>
3394
cristyb15553d2010-07-03 22:53:14 +00003395<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003396determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003397
3398<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003399array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003400integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003401radius that will provide meaningful results for the Gaussian distribution.
3402</p>
3403
3404<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3405operation is. However too small a <em class="arg" >Radius</em>, and sever
3406aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3407should be at least twice the <em class="arg" >Sigma</em> value, though three
3408times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003409
3410<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003411full 2-dimensional convolution is used to generate the weighted average of the
3412neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003413
3414<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3415pixels which are outside the image proper are blurred into the final result.
3416</p>
3417
3418
3419<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003420 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003421</div>
3422
3423<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>
3424
3425<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>
3426
3427<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003428 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003429</div>
3430
3431<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>
3432
3433<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3434<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3435<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3436list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3437installation.</p>
3438
3439<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>
3440
3441<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>
3442
3443<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>
3444
cristy4949d522010-03-12 18:41:34 +00003445<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 +00003446<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>
3447
3448<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>
3449
3450
3451<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003452 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003453</div>
3454
3455<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>
3456
3457
3458<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003459 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003460</div>
3461
3462<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>apply a Hald color lookup table to the image.</td><td style='text-align:right;'></td></tr></table>
3463
3464<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3465dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3466can apply any color transformation to the Hald image and then use this option
3467to apply the transform to the image. </p>
3468
3469<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3470<p>This option provides a convenient method for you to use Gimp or Photoshop
3471to make color corrections to the Hald CLUT image and subsequently apply them
3472to multiple images using an ImageMagick script. </p>
3473
3474<p>Note that the representation is only of the normal RGB color space and that
3475the whole color value triplet is used for the interpolated lookup of the
3476represented Hald color cube image. Because of this the operation is not <a
3477href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3478images transparency or alpha/matte channel.</p>
3479
3480<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3481of the individual color channels, usally involving a simplier gray-scale
3482image. E.g: gray-scale to color replacement, or modification by a histogram
3483mapping. </p>
3484
3485
3486<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003487 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003488</div>
3489
3490<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>
3491
3492<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003493 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003494</div>
3495
3496<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>
3497
3498<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003499 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></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%'>specify the icon geometry.</td><td style='text-align:right;'></td></tr></table>
3503
3504<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>
3505
3506<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>
3507
3508<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003509 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003510</div>
3511
3512<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>
3513
3514<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003515 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003516</div>
3517
3518<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>
3519
3520<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>
3521
cristy47774982011-02-15 15:17:19 +00003522<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 +00003523
cristyd0bda5e2010-09-21 16:22:45 +00003524<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003525amounts of image properties are displayed including image statistics, profiles,
3526image histogram, and others.</p>
3527
3528<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003529 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003530</div>
3531
3532<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>
3533
cristydcca3fa2010-12-29 21:50:07 +00003534<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 +00003535
3536<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>
3537
3538<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3539<p>or</p>
3540
3541<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>
3542
cristydcca3fa2010-12-29 21:50:07 +00003543<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 +00003544
cristydcca3fa2010-12-29 21:50:07 +00003545<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 +00003546
cristydcca3fa2010-12-29 21:50:07 +00003547<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 +00003548
3549<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003550 <h4><a id="immutable"></a>-immutable</h4>
cristy3ed852e2009-09-05 21:47:34 +00003551</div>
3552
3553<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>
3554
3555<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003556 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003557</div>
3558
3559<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>
3560
3561<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003562 <h4><a id="insert"></a>-insert <em class="arg">index</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%'>insert the last image into the image sequence.</td><td style='text-align:right;'></td></tr></table>
3566
3567<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>
3568
3569<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>
3570
3571<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003572 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003573</div>
3574
3575<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>
3576
3577<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>
3578
3579<p>The default intent is undefined.</p>
3580
3581<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3582
3583<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003584 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003585</div>
3586
3587<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>
3588
3589<p>Choose from:</p>
3590
3591<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003592 none
3593 line
3594 plane
3595 partition
3596 JPEG
3597 GIF
3598 PNG
cristy3ed852e2009-09-05 21:47:34 +00003599</pre>
3600
3601<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>
3602
3603<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3604
3605<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3606
3607<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3608
3609<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3610image.G, and image.B).</p>
3611
3612<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>
3613image.</p>
3614
3615<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3616
3617<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003618 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003619</div>
3620
3621<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>
3622
cristyd0bda5e2010-09-21 16:22:45 +00003623<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003624value, you typically fall in between the pixel colors defined by the source
3625image. This setting determines how the color is determined from the colors of
3626the pixels surrounding that point. That is how to determine the color of a
3627point that falls between two, or even four different colored pixels. </p>
3628
3629<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003630 integer The color of the top-left pixel (floor function)
3631 nearest-neighbor The nearest pixel to the lookup point (rounded function)
3632 average The average color of the surrounding four pixels
3633 bilinear A double linear interpolation of pixels (the default)
3634 mesh Divide area into two flat triangular interpolations
3635 bicubic Fitted bicubic-spines of surrounding 16 pixels
3636 spline Direct spline curves (colors are blurred)
3637 filter Use resize <a href="#filter">-filter</a> settings
cristy3ed852e2009-09-05 21:47:34 +00003638</pre>
3639
3640<p>This most important for distortion operators such as <a href="#distort"
3641>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3642>-transform</a> and <a href="#fx" >-fx</a>. </p>
3643
3644<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3645
3646<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3647lookup for positions outside the boundaries of the image. </p>
3648
3649
3650<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003651 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003652</div>
3653
3654<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>
3655
3656<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003657 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003658</div>
3659
3660<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>
3661
3662<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003663 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003664</div>
3665
3666<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>
3667
3668<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003669 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003670</div>
3671
3672<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>
3673
cristy71a3f602010-09-15 12:38:16 +00003674<p>Use this option to assign a specific label to the image, as it is read in
3675or created. You can use the <a href="#set" >-set</a> operation to re-assign
3676a the labels of images already read in. Image formats such as TIFF, PNG,
3677MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003678
cristy71a3f602010-09-15 12:38:16 +00003679<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3680assigned to an image is used as a header string to print above the postscript
3681image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003682
cristybc9539a2010-08-16 18:06:20 +00003683<p>You can include the image filename, type, width, height, or other image
3684attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3685Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003686
3687<p>For example,</p>
3688
3689<p class="crtsnip">
3690 -label "%m:%f %wx%h" bird.miff
3691</p>
3692
cristy71a3f602010-09-15 12:38:16 +00003693<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3694"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3695is read in. If a <a href="#label">+label</a> option was used instead, any
3696existing label present in the image would be used. You can remove all labels
3697from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003698
cristy71a3f602010-09-15 12:38:16 +00003699<p>A label is not drawn on the image, but is embedded in the image datastream
3700via <em>Label</em> tag or similar mechanism. If you want the label to be
3701visible on the image itself, use the <a href="#draw">-draw</a> option, or
3702during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003703
cristy71a3f602010-09-15 12:38:16 +00003704<p>If the first character of <em class="arg">string</em> is <em
3705class="arg">@</em>, the image label is read from a file titled by the
3706remaining characters in the string. Labels in a file are literal, no embedded
3707formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003708
3709
3710<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003711 <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 +00003712</div>
3713
3714<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>
3715
3716<p>Adaptively threshold each pixel based on the value of pixels in a
3717surrounding window. If the current pixel is lighter than this average plus
3718the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3719black. Small variations in pixel values such as found in scanned documents
3720can be ignored if offset is positive. A negative offset will make it more
3721sensitive to those small variations. </p>
3722
3723<p>This is commonly used to threshold images with an uneven background. It is
3724based on the assumption that average color of the small window is the
3725the local background color, from which to separate the forground color. </p>
3726
3727
3728<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003729 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003730</div>
3731
3732<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>
3733
3734<p>Perform various image operation methods to a ordered sequence of images
3735which may represent either a set of overlaid 'image layers', a GIF disposal
3736animation, or a fully-'coalesced' animation sequence. </p>
3737
3738<table class="doc">
3739 <tbody>
3740 <tr valign="top">
3741 <th align="left" style="width: 8%">Method</th>
3742 <th align="left">Description</th>
3743 </tr>
3744
3745 <tr valign="top">
3746 <td valign="top">compare-any</td>
3747 <td valign="top">Crop the second and later frames to the smallest rectangle
3748 that contains all the differences between the two images. No GIF <a
3749 href="#dispose" >-dispose</a> methods are taken into account. </td>
3750 </tr>
3751
3752 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3753 >-deconstruct</a> operator, and does not preserve animations normal
3754 working, especially when animation used layer disposal methods such as
3755 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3756 </tr>
3757
3758 <tr valign="top">
3759 <td valign="top">compare-clear</td>
3760 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3761 opaque pixels which become transparent in the second frame. That is the
3762 smallest image needed to mask or erase pixels for the next frame. </td>
3763 </tr>
3764
3765 <tr valign="top">
3766 <td valign="top">compare-overlay</td>
3767 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3768 extra color to the next image, as a result of overlaying color pixels.
3769 That is the smallest single overlaid image to add or change colors. </td>
3770 </tr>
3771
3772 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3773 composition method '<kbd>change-mask</kbd>', to reduce the image to
3774 just the pixels that need to be overlaid. </td>
3775 </tr>
3776
3777 <tr valign="top">
3778 <td valign="top">coalesce</td>
3779 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3780 >-coalesce</a> operator. Apply the layer disposal methods set in the
3781 current image sequence to form a fully defined animation sequence, as
3782 it should be displayed. Effectively converting a GIF animation into a
3783 'film strip'-like animation. </td>
3784 </tr>
3785
3786 <tr valign="top">
3787 <td valign="top">composite</td>
3788 <td valign="top">Alpha Composition of two image lists, separated by a
3789 "<kbd>null:</kbd>" image, with the destination image list first, and
3790 the source images last. An image from each list are composited
3791 together until one list is finished. The separator image and source
3792 image lists are removed. </td>
3793 </tr>
3794
3795
cristybac7a162010-06-15 19:57:29 +00003796 <tr><td></td>
3797 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3798 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3799 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003800 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003801 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003802
cristybac7a162010-06-15 19:57:29 +00003803 <tr><td></td>
3804 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003805 applied to all the images in the other image list, regardless of which
3806 list it is. In this case it is the image meta-data of the list which
3807 preserved. </td>
3808 </tr>
3809
3810
3811 <tr valign="top">
3812 <td valign="top">dispose</td>
3813 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3814 the animation after the layer disposal method has been applied, before
3815 the next sub-frame image is overlaid. That is the 'dispose' image that
3816 results from the application of the GIF <a href="#dispose"
3817 >-dispose</a> method. This allows you to check what
3818 is going wrong with a particular animation you may be developing.
3819 </td>
3820 </tr>
3821
3822 <tr valign="top">
3823 <td valign="top">flatten</td>
3824 <td valign="top">Create a canvas the size of the first images virtual
3825 canvas using the current <a href="#background" >-background</a> color,
3826 and <a href="#compose" >-compose</a> each image in turn onto that
3827 canvas. Images falling outside that canvas is clipped. Final
3828 image will have a zero virtual canvas offset. </td>
3829 </tr>
3830
cristybac7a162010-06-15 19:57:29 +00003831 <tr><td></td>
3832 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003833 overlaying all the prepared image layers into a final image. </td>
3834 </tr>
3835
cristybac7a162010-06-15 19:57:29 +00003836 <tr><td></td>
3837 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003838 canvas with real pixels, or to underlay a opaque color to remove
3839 transparency from an image.</td>
3840 </tr>
3841
3842
3843 <tr valign="top">
3844 <td valign="top">merge</td>
3845 <td valign="top">As 'flatten' method but merging all the given image
cristy10549a12011-05-15 19:04:46 +00003846 layers to create a new layer image just large enough to hold all the
3847 image without clipping or extra space. The new images virtual offset
3848 will preserve the position of the new layer, even if this offset is
3849 negative. The virtual canvas size of the first image is preserved.
cristy3ed852e2009-09-05 21:47:34 +00003850 </td>
cristy10549a12011-05-15 19:04:46 +00003851 </tr>
cristy3ed852e2009-09-05 21:47:34 +00003852
cristy10549a12011-05-15 19:04:46 +00003853 <tr><td></td><td>Caution is advised when handling image layers with
3854 negative offsets as few image file formats handle them correctly.
3855 Following this operation methd with <a href="#repage" >+repage</a>
3856 will remove the layer offset, and create a image in which all the
3857 overlaid image positions relative to each other is preserved, though
3858 not nessaraily exactly where you specified them.
3859 </td>
3860 </tr>
3861
3862 <tr><td></td><td>See also 'trim-bounds' below whcih is closely related but
3863 without doing the'flatten' to merge the images together. </td>
cristy3ed852e2009-09-05 21:47:34 +00003864 </tr>
3865
3866 <tr valign="top">
3867 <td valign="top">mosaic</td>
3868 <td valign="top">As 'flatten' method but expanding the initial canvas size
cristy10549a12011-05-15 19:04:46 +00003869 of the first image in a positive direction only so as to hold all the
3870 image layers. However as a virtual canvas is 'locked' to the origin,
3871 by its own definition, image layers with a negative offsets will still
3872 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
3873 if this could be a problem. </td>
3874
cristy3ed852e2009-09-05 21:47:34 +00003875 </tr>
3876
cristy10549a12011-05-15 19:04:46 +00003877 <tr><td></td><td>This method is commonly used to layout individual image
3878 using various offset but without knowing the final canvas size. The
3879 resulting image will, like 'flatten' not have any virtual offset, so
3880 can be saved to any image file format. </td>
cristy3ed852e2009-09-05 21:47:34 +00003881 </tr>
3882
3883
3884 <tr valign="top">
3885 <td valign="top">optimize</td>
3886 <td valign="top">Optimize a coalesced animation, into GIF animation using
3887 a number of general techniques. This currently a short cut to
3888 apply both the '<kbd>optimize-frame</kbd>', and
3889 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3890 include other optimization methods as they are developed. </td>
3891 </tr>
3892
3893 <tr valign="top">
3894 <td valign="top">optimize-frame</td>
3895 <td valign="top">Optimize a coalesced animation, into GIF animation by
3896 reducing the number of pixels per frame as much as possible by
3897 attempting to pick the best layer disposal method to use, while ensuring
3898 the result will continue to animate properly. </td>
3899 </tr>
3900
cristy10549a12011-05-15 19:04:46 +00003901 <tr><td></td><td> There is no guarantee that the best optimization is found.
3902 But then no reasonably fast GIF optimization algorithm can do this.
cristy3ed852e2009-09-05 21:47:34 +00003903 However this does seem to do better than most other GIF frame
3904 optimizers seen. </td>
3905 </tr>
3906
3907 <tr valign="top">
3908 <td valign="top">optimize-plus</td>
3909 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3910 overall optimization by adding extra frames to the animation, without
3911 changing the final look or timing of the animation. The frames are
3912 added to attempt to separate the clearing of pixels from the
3913 overlaying of new additional pixels from one animation frame to the
3914 next. If this does not improve the optimization (for the next frame
3915 only), it will fall back to the results of the previous normal
3916 '<kbd>optimize-frame</kbd>' technique. </td>
3917 </tr>
3918
cristy10549a12011-05-15 19:04:46 +00003919 <tr><td></td><td>There is the possibility that the change in the disposal
3920 style will result in a worsening in the optimization of later frames,
3921 though this is unlikely. In other words there no guarantee that it is
3922 better than the normal '<kbd>optimize-frame</kbd>' technique. For some
3923 animations however you can get a vast improvement in the final
3924 animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003925 </tr>
3926
3927 <tr valign="top">
3928 <td valign="top">optimize-transparency</td>
3929 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3930 overlay images with transparency, if it does not change the resulting
3931 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3932 </td>
3933 </tr>
3934
cristy10549a12011-05-15 19:04:46 +00003935 <tr><td></td><td>This should allow a existing frame optimized GIF animation
3936 to compress into a smaller file size due to larger areas of one
3937 (transparent) color rather than a pattern of multiple colors repeating
3938 the current disposed image of the last frame. </td>
cristy3ed852e2009-09-05 21:47:34 +00003939 </tr>
3940
3941 <tr valign="top">
3942 <td valign="top">remove-dups</td>
3943 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3944 images, so as to simplify layer overlays of coalesced animations.
3945 </td>
3946 </tr>
3947
cristy10549a12011-05-15 19:04:46 +00003948 <tr><td></td><td>Usually this a result of using a constant time delay
3949 across the whole animation, or after a larger animation was split into
3950 smaller sub-animations. The duplicate frames could also have been
3951 used as part of some frame optimization methods. </td>
cristy3ed852e2009-09-05 21:47:34 +00003952 </tr>
3953
3954 <tr valign="top">
3955 <td valign="top">remove-zero</td>
3956 <td valign="top">Remove any image with a zero time delay, unless ALL the
3957 images have a zero time delay (and is not a proper timed animation, a
3958 warning is then issued). </td>
3959 </tr>
3960
cristy10549a12011-05-15 19:04:46 +00003961 <tr><td></td><td>In a GIF animation, such images are usually frames which
3962 provide partial intermediary updates between the frames that are
3963 actually displayed to users. These frames are usally added for
3964 improved frame optimization in GIF animations. </td>
cristy3ed852e2009-09-05 21:47:34 +00003965 </tr>
3966
3967 <tr valign="top">
3968 <td valign="top">trim-bounds</td>
3969 <td valign="top">Find the bounds of all the images in the current
3970 image sequence, then adjust the offsets so all images are contained on
cristy10549a12011-05-15 19:04:46 +00003971 a minimal positive canvas. None of the image data is modified or
3972 merged, only the individual image virtual canvas size and offset.
3973 All the images is given the same canvas size, and and will have
3974 a positive offset, but will remain in the same position relative to
3975 each other. As a result of the minimal canvas size at least one image
3976 will touch every edge of that canvas. The image data touching those
3977 edges however may be transparent. </td>
3978 </tr>
3979
3980 <tr><td></td><td>The result is much like if you used 'merge' followed by a
3981 <a href="#repage" >+repage</a> option, except that all the images
3982 have been kept separate. If 'flatten' is used after using
3983 'trim-bounds' you will get the same result. </td>
cristy3ed852e2009-09-05 21:47:34 +00003984 </tr>
3985
3986 </tbody>
3987</table>
3988
3989<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3990
3991<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3992>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
cristy10549a12011-05-15 19:04:46 +00003993>-mosaic</a> are only aliases for the above methods and may be depreciated in
3994the future. Also see <a href="#page" >-page</a>, <a href="#repage"
3995>-repage</a> operators, the <a href="#compose" >-compose</a> setting, and the
3996GIF <a href="#dispose" >-dispose</a> and <a href="#delay" >-delay</a>
3997settings. </p>
cristy3ed852e2009-09-05 21:47:34 +00003998
3999
4000<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004001 <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 +00004002</div>
4003
4004<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>
4005
4006<p>Given one, two or three values delimited with commas: black-point,
4007white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
4008white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
4009point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
4010contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
4011both black and white points are percentages of the full color range. Gamma
4012will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
4013omitted, the default of 1.0 (no gamma correction) is assumed.</p>
4014
4015<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
4016the given '<kbd>black_point</kbd>' value in the original image is set to
4017zero (or black), while the given '<kbd>white_point</kbd>' value is set to
4018<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
4019to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
4020adjusted. </p>
4021
4022<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
4023adding the special '!' flag anywhere in the argument list, will cause the
4024operator to do the reverse of the level adjustment. That is a zero, or
4025<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
4026adjusted to the given level values, allowing you to de-contrast, or compress
4027the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
4028
4029<p>Only the channels defined by the current <a href="#channel">-channel</a>
4030setting are adjusted (defaults to RGB color channels only), allowing you to
4031limit the effect of this operator. </p>
4032
4033<p>Please note that the transparency channel is treated as 'matte'
4034values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
4035
4036
4037<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004038 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00004039 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
4040</div>
4041
cristyd0bda5e2010-09-21 16:22:45 +00004042<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 +00004043
4044<p>This function is exactly like <a href="#level">-level</a>, except that the
4045value value for each color channel is determined by the
4046'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
4047described under the <a href="#fill">-fill</a> option). </p>
4048
cristyd0bda5e2010-09-21 16:22:45 +00004049<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
4050is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00004051colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00004052adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00004053
4054<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
4055will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00004056respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00004057those colors. This can also be used to convert a plain gray-scale image into a
4058one using the gradient of colors specified. </p>
4059
4060<p>By supplying a single color with a comma separator either before or after
4061that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00004062respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00004063used for both the black and white color points, making the operator either
4064threshold the images around that color (- form) or set all colors to that
4065color (+ form). </p>
4066
4067
4068<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004069 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004070</div>
4071
4072<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>
4073
4074<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>
4075
cristy6b636652009-12-05 17:16:11 +00004076<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 +00004077
4078<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00004079 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00004080</p>
4081
4082<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
4083
cristydcca3fa2010-12-29 21:50:07 +00004084<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 +00004085 File Area Memory Map Disk Thread Time
4086 ------------------------------------------------------------------------------
4087 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
cristydcca3fa2010-12-29 21:50:07 +00004088</pre>
4089
cristy3ed852e2009-09-05 21:47:34 +00004090<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>
4091
4092<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>
4093
4094<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>
4095
4096<p class="crtsnip">
4097-limit area 10mb
4098</p>
4099
cristyd0bda5e2010-09-21 16:22:45 +00004100<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 +00004101
4102<p class="crtsnip">
4103-limit area 10mb -limit disk 500mb
4104</p>
4105
4106<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
4107
4108<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>
4109
4110<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.
4111</p>
4112
4113<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.
4114</p>
4115
4116<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004117 <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 +00004118</div>
4119
4120<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>
4121
cristyd934d102009-10-10 12:55:13 +00004122<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
4123and uses a 'histogram bin' to determine the range of color values that needs to
4124be stretched. However it then stretchs those colors using the <a
4125href="#level" >-level</a> operator.</p>
4126
4127<p>As such while the initial determination may have 'binning' round off
4128effects, the image colors are stretched mathematically, rather than using the
4129histogram bins. This makes the operator more accurate. </p>
4130
4131<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
4132'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
4133perfect stretch of the color range. </p>
4134
4135<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
4136normalization of mathematical images. </p>
4137
4138<p>This operator is under review for re-development. </p>
4139
4140
cristy3ed852e2009-09-05 21:47:34 +00004141<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004142 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00004143</div>
4144
4145<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>
4146
4147<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004148 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004149</div>
4150
4151<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>
4152
4153<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>
4154
4155<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004156 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004157</div>
4158
4159<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>
4160
4161<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004162 Align Alpha Boolean Channel
4163 Class ClipPath Coder Color
4164 Colorspace Command Compose Compress
4165 Configure DataType Debug Decoration
4166 Delegate Direction Dispose Distort
4167 Dither Endian Evaluate FillRule
4168 Filter Font Format Function
4169 Gravity ImageList Intent Interlace
4170 Interpolate Kernel Layers LineCap
4171 LineJoin List Locale LogEvent
4172 Log Magic Method Metric
4173 Mime Mode Morphology Module
4174 Noise Orientation Policy PolicyDomain
4175 PolicyRights Preview Primitive QuantumFormat
4176 Resource SparseColor Storage Stretch
4177 Style Threshold Type Units
4178 Validate VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004179</pre>
4180
cristybac7a162010-06-15 19:57:29 +00004181<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4182list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4183available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004184
4185<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4186<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004187 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004188</div>
4189
4190<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>
4191
cristybac7a162010-06-15 19:57:29 +00004192<p>This option specifies the format for the log printed when the <a
4193href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004194
cristybac7a162010-06-15 19:57:29 +00004195<p>You can display the following components by embedding special format
4196characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004197
4198<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004199 %d domain
4200 %e event
4201 %f function
4202 %l line
4203 %m module
4204 %p process ID
4205 %r real CPU time
4206 %t wall clock time
4207 %u user CPU time
4208 %% percent sign
4209 \n newline
4210 \r carriage return
cristy3ed852e2009-09-05 21:47:34 +00004211</pre>
4212
4213<p>For example:</p>
4214
4215<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>
4216<p>The default behavior is to print all of the components.</p>
4217
4218<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004219 <h4><a id="loop"></a>-loop <em class="arg">iterations</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%'>add Netscape loop extension to your GIF animation.</td><td style='text-align:right;'></td></tr></table>
4223
cristybac7a162010-06-15 19:57:29 +00004224<p>Set iterations to zero to repeat the animation an infinite number of times,
4225otherwise the animation repeats itself up to <em class="arg">iterations</em>
4226times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004227
4228<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004229 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004230</div>
4231
4232<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>
4233
4234<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004235 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004236</div>
4237
4238<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>
4239
4240
4241<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004242 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004243</div>
4244
4245<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
4246
4247<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4248
4249<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004250 best
4251 default
4252 gray
4253 red
4254 green
4255 blue
cristy3ed852e2009-09-05 21:47:34 +00004256</pre>
4257
cristybac7a162010-06-15 19:57:29 +00004258<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4259Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4260the type and <kbd>display</kbd> searches the list of colormap types in
4261<kbd>top-to-bottom</kbd> order until one is located. See <em
4262class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004263
4264
4265<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004266 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004267</div>
4268
4269<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>
4270
4271<p>Here are the valid components of a map:</p>
4272
4273<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004274 r red pixel component
4275 g green pixel component
4276 b blue pixel component
4277 a alpha pixel component (0 is transparent)
4278 o opacity pixel component (0 is opaque)
4279 i grayscale intensity pixel component
4280 c cyan pixel component
4281 m magenta pixel component
4282 y yellow pixel component
4283 k black pixel component
4284 p pad component (always 0)
cristy3ed852e2009-09-05 21:47:34 +00004285</pre>
4286
cristybac7a162010-06-15 19:57:29 +00004287<p>You can specify as many of these components as needed in any order (e.g.
4288bgr). The components can repeat as well (e.g. rgbr).</p>
4289
cristy3ed852e2009-09-05 21:47:34 +00004290
4291<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004292 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004293<em class="arg">filename</em></h4>
4294</div>
4295
cristyacc04882011-05-04 23:03:43 +00004296<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 +00004297
cristyacc04882011-05-04 23:03:43 +00004298<p>This the same as using a mask used for composite masking operations, with
4299grayscale values causing blended updates of the image the mask is attached to.
4300</P>
4301
4302<p>Use <a href="#mask">+mask</a> to remove the mask from images.</p>
4303
4304<p>Also see <a href="#clip-mask">-clip-mask</a> which work in the same way,
4305but with strict boolean masking. </p>
cristy3ed852e2009-09-05 21:47:34 +00004306
4307<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004308 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004309</div>
4310
4311<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>
4312
4313<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4314
cristybac7a162010-06-15 19:57:29 +00004315<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4316style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004317
4318<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004319 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004320</div>
4321
4322<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>
4323
cristyacc04882011-05-04 23:03:43 +00004324<p>Select the 'maximum' value from all the surrounding pixels. </p>
4325
4326<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4327name. </p>
4328
cristyd2baf7d2010-03-06 04:26:44 +00004329<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004330 <h4><a id="median"></a>-median <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004331</div>
4332
4333<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>
4334
cristyacc04882011-05-04 23:03:43 +00004335<p>Select the 'middle' value from all the surrounding pixels. </p>
4336
4337<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4338name. </p>
4339
cristy3ed852e2009-09-05 21:47:34 +00004340<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004341 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004342</div>
4343
4344<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>
4345
4346<p>Choose from:</p>
4347
4348<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004349 AE absolute error count, number of different pixels (-fuzz effected)
4350 FUZZ mean color distance
4351 MAE mean absolute error (normalized), average channel error distance
4352 MEPP mean error per pixel (normalized mean error, normalized peak error)
4353 MSE mean error squared, average of the channel error squared
4354 NCC normalized cross correlation
4355 PAE peak absolute (normalize peak absolute)
4356 PSNR peak signal to noise ratio
4357 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004358</pre>
4359
cristy771f7a72010-11-27 21:42:59 +00004360<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4361with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4362only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004363size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004364'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004365for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004366
4367<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4368('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004369normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004370
cristybac7a162010-06-15 19:57:29 +00004371<p>To print a complete list of metrics, use the <a href="#list">-list
4372metrics</a> option.</p>
4373
cristy3ed852e2009-09-05 21:47:34 +00004374
cristyd2baf7d2010-03-06 04:26:44 +00004375<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004376 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004377</div>
4378
4379<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>
4380
cristyacc04882011-05-04 23:03:43 +00004381<p>Select the 'minimal' value from all the surrounding pixels. </p>
4382
4383<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4384name. </p>
4385
4386
cristy3ed852e2009-09-05 21:47:34 +00004387
4388<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004389 <h4><a id="mode"></a>-mode <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004390</div>
4391
cristy29c5c992011-06-25 13:58:49 +00004392<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 +00004393
4394<div style="margin: auto;">
4395 <h4>-mode <em class="arg">value</em></h4>
4396</div>
4397
cristy3ed852e2009-09-05 21:47:34 +00004398<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>
4399
cristybac7a162010-06-15 19:57:29 +00004400<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4401Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004402
cristybac7a162010-06-15 19:57:29 +00004403<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4404for a list of <a href="#mode" >-mode</a> arguments available in your
4405ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004406
4407
4408<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004409 <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 +00004410</div>
4411
cristybac7a162010-06-15 19:57:29 +00004412<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
4413class="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 +00004414
cristyb36feb22010-03-26 16:54:37 +00004415<p>The arguments are given as a percentages of variation. A value of 100 means
4416no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004417
cristyb36feb22010-03-26 16:54:37 +00004418<p>The <em class="arg">brightness</em> is a multiplier of the overall
4419brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4420twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4421before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004422
cristyb36feb22010-03-26 16:54:37 +00004423<p>The <em class="arg">saturation</em> controls the amount of color in an
4424image. For example, 0 produce a grayscale image, while a large value such as
4425200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004426
cristyb36feb22010-03-26 16:54:37 +00004427<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4428within the image by the amount specified. For example, 50 results in
4429a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4430A value of either 0 or 200 results in a complete 180 degree rotation of the
4431image. Using a value of 300 is a 360 degree rotation resulting in no change to
4432the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004433
cristyb36feb22010-03-26 16:54:37 +00004434<p>For example, to increase the color brightness by 20% and decrease the color
4435saturation by 10% and leave the hue unchanged, use <a
4436href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004437
cristyb36feb22010-03-26 16:54:37 +00004438<p>Use <a href="#set">-set</a> attribute of '<kbd
4439class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4440modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4441<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004442
4443<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 +00004444
cristy3ed852e2009-09-05 21:47:34 +00004445<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004446 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004447</div>
4448
4449<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>monitor progress.</td><td style='text-align:right;'></td></tr></table>
4450
4451
4452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004453 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004454</div>
4455
4456<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>transform the image to black and white.</td><td style='text-align:right;'></td></tr></table>
4457
4458
4459<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004460 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004461</div>
4462
4463<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>morphs an image sequence.</td><td style='text-align:right;'></td></tr></table>
4464
4465<p>Both the image pixels and size are linearly interpolated to give the
4466appearance of a meta-morphosis from one image to the next, over all the images
4467in the current image list. The added images are the equivalent of a <a
4468href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4469argument determine how many images to interpolate between each image. </p>
4470
4471
4472<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004473 <h4><a id="morphology"></a>-morphology</h4>
4474 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004475</div>
4476
cristy2c839602010-04-03 02:32:08 +00004477<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 +00004478
cristydcca3fa2010-12-29 21:50:07 +00004479<p>Until I get around to writing a option summary for this, see <a
4480href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4481Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004482
4483
cristy488844c2010-01-22 14:02:05 +00004484<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004485 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004486</div>
4487
4488<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>
4489
4490
4491<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004492 <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 +00004493</div>
4494
4495<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>
4496
4497<p>Blur with the given radius, standard deviation (sigma), and angle. The
4498angle given is the angle toward which the image is blurred. That is the
4499direction people would consider the object is coming from. </p>
4500
4501<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004502definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004503
4504<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4505pixels which are outside the image proper are blurred into the final result.
4506</p>
4507
4508<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004509 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004510</div>
4511
4512<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>
4513<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004514 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004515</div>
4516
cristyb29bc032010-02-01 20:29:43 +00004517<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 +00004518
4519<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>
4520
4521<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004522 <h4><a id="noise"></a>-noise <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004523 +noise <em class="arg">type</em></h4>
4524</div>
4525
4526<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>
4527
4528<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>
4529
4530<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>
4531
4532<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>
4533
4534<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004535 Gaussian
4536 Impulse
4537 Laplacian
4538 Multiplicative
4539 Poisson
4540 Random
4541 Uniform
cristy3ed852e2009-09-05 21:47:34 +00004542</pre>
4543
4544<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4545
cristy83543962009-10-16 19:04:28 +00004546<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4547the use of a controlling value to specify teh amount of noise that should be
4548added to an image. </p>
4549
cristy3ed852e2009-09-05 21:47:34 +00004550
4551<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004552 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004553</div>
4554
4555<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>
4556
cristyd934d102009-10-10 12:55:13 +00004557<p>The intensity values are stretched to cover the entire range of possible
4558values. While doing so, black-out at most <em>2%</em> of the pixels and
4559white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004560
cristyd934d102009-10-10 12:55:13 +00004561<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4562is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4563(Before this version, it was equivalent to <a href="#contrast-stretch"
4564>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004565
cristyd934d102009-10-10 12:55:13 +00004566<p>All the channels are normalized in concert by the came amount so as to
4567preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004568setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004569setting will normalize the RGB channels independently.</p>
4570
cristydcca3fa2010-12-29 21:50:07 +00004571<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004572Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004573that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004574
4575<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004576
4577
4578<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004579 <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 +00004580</div>
4581
cristyd934d102009-10-10 12:55:13 +00004582<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
4583class="arg">threshold map</em> specified, and a uniform color map with the
4584given 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 +00004585
4586<p>You can choose from these standard threshold maps:</p>
4587
4588<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004589 threshold 1x1 Threshold 1x1 (non-dither)
4590 checks 2x1 Checkerboard 2x1 (dither)
4591 o2x2 2x2 Ordered 2x2 (dispersed)
4592 o3x3 3x3 Ordered 3x3 (dispersed)
4593 o4x4 4x4 Ordered 4x4 (dispersed)
4594 o8x8 8x8 Ordered 8x8 (dispersed)
4595 h4x4a 4x1 Halftone 4x4 (angled)
4596 h6x6a 6x1 Halftone 6x6 (angled)
4597 h8x8a 8x1 Halftone 8x8 (angled)
4598 h4x4o Halftone 4x4 (orthogonal)
4599 h6x6o Halftone 6x6 (orthogonal)
4600 h8x8o Halftone 8x8 (orthogonal)
4601 h16x16o Halftone 16x16 (orthogonal)
4602 c5x5b c5x5 Circles 5x5 (black)
4603 c5x5w Circles 5x5 (white)
4604 c6x6b c6x6 Circles 6x6 (black)
4605 c6x6w Circles 6x6 (white)
4606 c7x7b c7x7 Circles 7x7 (black)
4607 c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004608</pre>
4609
cristy945bb352011-04-01 15:39:28 +00004610<p> The <kbd>threshold</kbd> generated a simple 50% threshold of the image.
cristybaacd172011-04-30 23:11:03 +00004611This could be used with <em class="arg" >level</em> to do the equivalent of <a
cristy945bb352011-04-01 15:39:28 +00004612href="#posterize" >-posterize</a> to reduce an image to basic primary colors.
4613</p>
cristy3ed852e2009-09-05 21:47:34 +00004614
cristy945bb352011-04-01 15:39:28 +00004615<p>The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
4616pattern. That is a grayscale will become a pattern of solid black, solid
4617white, and mid-tone colors into a checkerboard pattern of black and white.
4618</p>
cristy3ed852e2009-09-05 21:47:34 +00004619
cristy945bb352011-04-01 15:39:28 +00004620<p>You can define your own <em class="arg" >threshold map</em> for ordered
4621dithering and halftoning your images, in either personal or system
4622<kbd>thresholds.xml</kbd> XML file. See <a href="resources.html" >Resources</A>
4623for more details of configuration files. </p>
cristy3ed852e2009-09-05 21:47:34 +00004624
cristy945bb352011-04-01 15:39:28 +00004625<p>To print a complete list of the thresholds that have been defined, use the
4626<a href="#list" >-list threshold</a> option.</p>
4627
4628<p>Note that at this time the same threshold dithering map is used for all
4629color channels, no attempt is made to offset or rotate the map for different
4630channels is made, to create an offset printing effect. Also as the maps are
4631simple threshold levels, the halftone and circle maps will create incomplete
4632circles along the edges of a colored area. Also all the effects are purely
4633on/off boolean effects, without anti-aliasing to make the circles smooth
4634looking. Large dots can be made to look better with a small amount of blurring
4635after being created. </p>
cristy3ed852e2009-09-05 21:47:34 +00004636
4637
4638<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004639 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004640</div>
4641
4642<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>
4643
cristyc54f5d42009-11-27 21:36:31 +00004644<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004645described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4646>-fuzz</a> setting can be used to match and replace colors similar to the one
4647given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004648
cristyb36feb22010-03-26 16:54:37 +00004649<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4650the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004651
cristyb36feb22010-03-26 16:54:37 +00004652<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4653as <a href="#opaque" >-opaque</a> but replaces the matching color with
4654transparency rather than the current <a href="#fill">-fill</a> color setting.
4655To ensure that it can do this it also ensures that the image has an alpha
4656channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4657the new transparent colors, and does not require you to modify the <a
4658href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004659
cristy3ed852e2009-09-05 21:47:34 +00004660
4661<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004662 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004663</div>
4664
4665<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>
4666
4667<p>Choose from these orientations:</p>
4668
4669<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004670 bottom-left
4671 bottom-right
4672 left-bottom
4673 left-top
4674 right-bottom
4675 right-top
4676 top-left
4677 top-right
4678 undefined
cristy3ed852e2009-09-05 21:47:34 +00004679</pre>
4680
cristyd934d102009-10-10 12:55:13 +00004681<p>To print a complete list of orientations, use the <a href="#list" >-list
4682orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004683
4684
4685<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004686 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004687 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4688 +page
4689 </h4>
4690</div>
4691
4692<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>
4693
4694<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>
4695
4696<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>
4697
4698<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>
4699<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4700<thead>
4701 <tr valign="top">
4702 <th align="center"><em class="arg">media</em></th>
4703 <th align="center"><em class="arg">width</em></th>
4704 <th align="center"><em class="arg">height</em></th>
4705 </tr>
4706</thead>
4707<tbody>
4708<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4709<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4710<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4711<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4712<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4713<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4714<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4715<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4716<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4717<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4718<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4719<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4720<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4721<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4722<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4723<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4724<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4725<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4726<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4727<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4728<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4729<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4730<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4731<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4732<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4733<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4734<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4735<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4736<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4737<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4738<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4739<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4740<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4741<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4742<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4743<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4744<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4745<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4746</tbody>
4747</table>
4748
4749
4750
4751
4752<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>
4753
4754<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>
4755
4756<p>The default page dimensions for a TEXT image is 612x792.</p>
4757
4758<p>This option is used in concert with <a href="#density">-density</a>.</p>
4759
4760<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4761
4762<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004763 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004764</div>
4765
4766<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>
4767
4768<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>
4769
4770<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004771 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004772
4773<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>
4774
4775<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004776 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004777</div>
4778
4779<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>
4780
4781<p>Pause for the specified number of seconds before repeating the animation.</p>
4782
4783<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004784 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004785</div>
4786
4787<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>
4788
4789<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4790
4791<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004792 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004793</div>
4794
4795<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>
4796
4797<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004798 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004799</div>
4800
4801<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>
4802
4803<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004804 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004805</div>
4806
4807<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>
4808
4809<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4810
4811<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004812 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004813</div>
4814
4815<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>
4816
4817<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004818 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004819</div>
4820
4821<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>
4822
4823<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004824 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004825</div>
4826
4827<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>
4828
4829<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>
4830
4831<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004832 Rotate Shear Roll Hue
4833 Saturation Brightness Gamma Spiff
4834 Dull Grayscale Quantize Despeckle
4835 ReduceNoise Add Noise Sharpen Blur
4836 Threshold EdgeDetect Spread Shade
4837 Raise Segment Solarize Swirl
4838 Implode Wave OilPaint CharcoalDrawing
4839 JPEG
cristy3ed852e2009-09-05 21:47:34 +00004840</pre>
4841
4842<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4843
4844<p>The default preview is <kbd>JPEG</kbd>.</p>
4845
4846<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004847 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004848</div>
4849
4850<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>
4851
4852<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004853 <h4><a id="process"></a>-process <em class="arg">command</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004854</div>
4855
4856<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>
4857
4858<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>
4859
4860<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004861 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004862 +profile <em class="arg">profile_name</em></h4>
4863</div>
4864
4865<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>
4866
4867<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>
4868
4869<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>
4870
4871<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>
4872
4873<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>
4874
4875<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4876
4877<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4878<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>
4879
4880<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>
4881<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4882CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4883</p>
4884
4885<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004886 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004887</div>
4888
4889<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>
4890
cristy87a7f072011-07-01 00:08:52 +00004891<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
4892highest compression) to 100 (best quality but least effective compression).
4893The default is to use the estimated quality of your input image if it can
4894be determined, otherwise 92. When the quality is greater than 90, then the
4895chroma channels are not downsampled.
4896Use the <a href="#sampling-factor">-sampling-factor</a> option to specify the
4897factors for chroma downsampling.</p>
cristy3ed852e2009-09-05 21:47:34 +00004898
4899<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>
4900
cristy851dbce2010-08-06 21:40:00 +00004901<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 +00004902
cristy87a7f072011-07-01 00:08:52 +00004903<p>For the MNG and PNG image formats, the quality value sets the zlib
4904compression level (quality / 10) and filter-type (quality % 10). The default
4905PNG "quality" is 75, which means compression level 7 with adaptive PNG
4906filtering, unless the image has a color map, in which case it means
4907compression level 7 with no PNG filtering.</p>
4908
4909<p>For compression level 0, the Huffman-only strategy is used, which is fastest but not necessarily the worst compression.</p>
cristy3ed852e2009-09-05 21:47:34 +00004910
4911<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4912
4913<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004914 0: none
4915 1: sub
4916 2: up
4917 3: average
4918 4: Paeth
cristy3ed852e2009-09-05 21:47:34 +00004919</pre>
4920
cristy87a7f072011-07-01 00:08:52 +00004921<p>If filter-type is 5, adaptive filtering is used when quality is greater
4922than 50 and the image does not have a color map, otherwise no filtering is
4923used.</p>
cristy3ed852e2009-09-05 21:47:34 +00004924
cristy87a7f072011-07-01 00:08:52 +00004925<p>If filter-type is 6, adaptive filtering
4926with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
cristy3ed852e2009-09-05 21:47:34 +00004927
cristy87a7f072011-07-01 00:08:52 +00004928<p>Only if the output is MNG, if filter-type is 7, the LOCO color
4929transformation (intrapixel differencing) and adaptive filtering
4930with <em class="arg">minimum-sum-of-absolute-values</em> are used.</p>
cristy3ed852e2009-09-05 21:47:34 +00004931
cristy87a7f072011-07-01 00:08:52 +00004932<p>If the filter-type is 8 the zlib Z_RLE compression strategy is used with
4933 no PNG filtering.</p>
cristy3ed852e2009-09-05 21:47:34 +00004934
cristy87a7f072011-07-01 00:08:52 +00004935<p>If the filter-type is 9 the zlib Z_RLE compression strategy is used with
4936 adaptive PNG filtering.</p>
4937
4938<p>The quality setting has no effect on the appearance of PNG and MNG images,
4939since the compression is always lossless.</p>
4940
4941<p>For further information, see
4942the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
cristy3ed852e2009-09-05 21:47:34 +00004943
cristy3ed852e2009-09-05 21:47:34 +00004944<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004945 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004946</div>
4947
cristy3c98a4f2010-08-13 20:09:41 +00004948<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 +00004949
cristy3c98a4f2010-08-13 20:09:41 +00004950<p>This setting defines the colorspace used to sort out and reduce the number
4951of colors needed by an image (for later dithering) by operators such as <a
4952href="#colors" >-colors</a>, Note that color reducion also happens
4953automatically when saving images to color-limited image file formats, such as
4954GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004955
4956
4957<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004958 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004959</div>
4960
4961<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>
4962
4963<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004964 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004965</div>
4966
4967<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>
4968
4969<p>Note that this is actually a rotational blur rather than a radial and as
4970such actually mis-named. </p>
4971
4972<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4973pixels which are outside the image proper are blurred into the final result.
4974</p>
4975
4976
4977<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004978 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004979</div>
4980
4981<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>
4982
4983<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>.
4984</p>
4985
4986<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4987
4988<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004989 <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 +00004990</div>
4991
4992<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>
4993
4994<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004995 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004996</div>
4997
4998<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>
4999
5000<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005001 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00005002</div>
5003
5004<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>
5005
5006<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005007 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005008</div>
5009
5010<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>
5011
5012<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
5013the given colors are dithered over the image as necessary, otherwise the closest
5014color (in RGB colorspace) is selected to replace that pixel in the image. </p>
5015
5016<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
5017images in the current image sequence, all the images will have the same color
5018table. That means that when saved to a file format such as GIF, it will use
5019that color table as a single common or global color table, for all the images,
5020without requiring extra local color tables. </p>
5021
5022<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
5023sequence to use a common color map over all the images. This equivalent to
5024appending all the images together (without extra background colors) and color
5025reducing those images using <a href="#colors">-colors</a> with a 256 color
5026limit, then <a href="#remap">-remap</a> those colors over the original list of
5027images. This ensures all the images follow a single color map. </p>
5028
5029<p>If the number of colors over all the images is less than 256, then <a
5030href="#remap">+remap</a> should not perform any color reduction or dithering, as
5031no color changes are needed. In that case, its only effect is to force the use
5032of a global color table. This recommended after using either <a
5033href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
5034reduce the number of colors in an animated image sequence. </p>
5035
5036<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005037 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005038</div>
5039
5040<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>
5041
5042<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>
5043
5044<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>
5045
5046<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005047 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00005048</div>
5049
5050<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>
5051
5052<p>The only command recognized is the name of an image file to load.</p>
5053
5054<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>
5055
5056<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005057 <h4><a id="render"></a>-render</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%'>render vector operations.</td><td style='text-align:right;'></td></tr></table>
5061
5062<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>
5063
5064<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005065<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005066</div>
5067
5068<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>
5069
5070<p>This option is like <a href="#page">-page</a> but acts as an image operator
5071rather than a setting. You can separately set the canvas size or the offset
5072of the image on that canvas by only providing those components. </p>
5073
5074<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>
5075
5076<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
5077offset to move the image relative to its previous position. This useful for
5078animation sequences. </p>
5079
5080<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
5081recalculate the canvas size so the image (at its current offset) will appear
5082completely on that canvas (unless it has a negative offset).</p>
5083
5084<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
5085canvas meta-data from the images. </p>
5086
5087<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
5088directly assign virtual canvas meta-data. </p>
5089
5090
5091<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005092 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005093</div>
5094
5095<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>
5096
5097<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>
5098
5099<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>
5100
5101<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005102 <h4><a id="resize"></a>-resize <em class="arg">geometry</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%'>Resize an image.</td><td style='text-align:right;'></td></tr></table>
5106
5107<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>
5108
5109<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>
5110
cristy13538962010-02-26 17:53:04 +00005111<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>
5112
cristy4949d522010-03-12 18:41:34 +00005113<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 +00005114<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005115 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00005116</div>
5117
5118<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>
5119
5120<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005121 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005122</div>
5123
5124<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>
5125
5126
5127<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005128 <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 +00005129</div>
5130
5131<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>
5132
5133<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>
5134
5135
5136<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005137 <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 +00005138</div>
5139
5140<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>
5141
5142<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>
5143
5144<p>Empty triangles in the corners, left over from rotating the image, are
5145filled with the <kbd>background</kbd> color. </p>
5146
5147<p>See also the <a href="#distort">-distort</a> operator and specifically the
5148'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5149
5150
5151<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005152 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005153</div>
5154
cristyd0bd44a2010-09-24 12:38:11 +00005155<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 +00005156
cristyd0bd44a2010-09-24 12:38:11 +00005157<p>Change the image size simply by directly sampling the pixels original
5158image. When magnifying, pixels are replicated in blocks. When minifying,
5159pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005160
cristyd0bd44a2010-09-24 12:38:11 +00005161<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5162a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5163neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5164avoids all the filter processing of the image. As such it completely ignores
5165the current <a href="#filter">-filter</a> setting. </p>
5166
5167<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5168will be added to the resulting image, though some colors may disappear. </p>
5169
5170<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
5171ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005172
5173
5174<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005175 <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 +00005176</div>
5177
5178<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>
5179
5180<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>
5181
5182<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005183 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005184</div>
5185
cristyd0bd44a2010-09-24 12:38:11 +00005186<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 +00005187
cristyd0bd44a2010-09-24 12:38:11 +00005188<p>Change the image size simply by replacing pixels by averaging pixels
5189together when minifying, or replacing pixels when magnifing. </p>
5190
5191<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5192a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5193faster, as it avoids all the filter processing of the image. As such it
5194completely ignores the current <a href="#filter">-filter</a> setting. </p>
5195
5196<p>If when shrinking (minifying) images the original image is some integer
5197multiple of the new image size, the number of pixels avergaed together to
5198produce the new pixel color is the same across the whole image. This is
5199a special case known as 'binning' and is often used as a method of reducing
5200noise in image such as those generated by digital cameras, especially in low
5201light conditions. </p>
5202
cristy3ed852e2009-09-05 21:47:34 +00005203
5204<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005205 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005206</div>
5207
5208<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>
5209
5210<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5211
5212<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005213 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005214</div>
5215
5216<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>
5217
5218<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>
5219
5220<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005221 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005222</div>
5223
5224<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>
5225
5226<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005227 <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 +00005228</div>
5229
5230<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>
5231
5232<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>
5233
5234<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>
5235
5236<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5237of the color clusters is returned.</p>
5238
5239
5240<div style="margin: auto;">
cristy8b9dd952011-03-21 22:56:18 +00005241 <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 +00005242</div>
5243
cristy3ed852e2009-09-05 21:47:34 +00005244<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>
5245
cristy2e2662a2010-10-09 14:29:37 +00005246<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>
5247
cristy3ed852e2009-09-05 21:47:34 +00005248<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005249 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005250</div>
5251
5252<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
5253
5254<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005255 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005256</div>
5257
5258<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>
5259
5260<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5261
5262<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>
5263
cristyd0bda5e2010-09-21 16:22:45 +00005264
5265
cristy3ed852e2009-09-05 21:47:34 +00005266<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005267 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5268 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005269</div>
5270
cristyd0bd44a2010-09-24 12:38:11 +00005271<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 +00005272image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005273
cristyd0bd44a2010-09-24 12:38:11 +00005274<p>This will assign (or modify) specific settings attached to all the images
5275in the current image sequence. Using the <a href="#set">+set</a> form of the
5276option will either remove, or reset that setting to a default state, as
5277appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005278
cristyd0bd44a2010-09-24 12:38:11 +00005279<p>For example, it will modify specific well known image meta-data
5280'attributes' such as those normally overridden by: the options <a
5281href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5282href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5283assigned before the image is read in, by using a <em class="arg">key</em> of
5284the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005285
cristyd0bd44a2010-09-24 12:38:11 +00005286<p>If the given <em class="arg">key</em> does not match a specific known
5287'attribute ', such as shown above, the setting is stored as a a free form
cristy323f35b2011-03-24 23:05:13 +00005288'property' string. Such settings are listed in <a href="#verbose"
cristyd0bda5e2010-09-21 16:22:45 +00005289>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5290</p>
5291
cristy84134182011-06-15 22:59:00 +00005292<p>This includes string 'properties' that are set by and assigned to images
cristyd0bd44a2010-09-24 12:38:11 +00005293using the options <a href="#comment" >-comment</a>, <a href="#label"
5294>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5295a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5296Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005297
cristyd0bd44a2010-09-24 12:38:11 +00005298<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>
5299<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5300Properties</a> in the defined value. For example:</p>
5301
5302<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 +00005303<p>Other well known 'properties' that are availible include:
cristyd0bd44a2010-09-24 12:38:11 +00005304'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5305'<kbd>signature</kbd>'. </p>
5306
5307<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5308the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5309see <a href="#repage">-page</a>). However it is designed to provide a finer
5310control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5311option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5312attribute. </p>
5313
5314<p>This option can also associate a colorspace or profile with your image.
5315For example,</p>
5316
5317<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 +00005318<p>Some 'properties' must be defined in a specific way to be used. For
5319example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5320modify the output filename of an image. For example</p>
5321
5322<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>
5323<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5324be saved as a global "Artifact" exactly as if it was set using the <a
cristyf9a6c462011-04-24 14:01:11 +00005325href="#define" >-define</a> option. As such settings are global in scope, they
cristy84134182011-06-15 22:59:00 +00005326can be used to pass 'attributes' and 'properties' of one specific image,
cristyd0bd44a2010-09-24 12:38:11 +00005327in a way that allows you to use them in a completely different image, even if
5328the original image has long since been modified or destroyed. For example: </p>
5329
5330<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>
5331<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5332a 'artifact' if the given <em class="arg">key</em> does not match an existing
cristy323f35b2011-03-24 23:05:13 +00005333'attribute' or 'property'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005334
5335<p>You can set the attributes of the image registry by prefixing the value
5336with <kbd>registry:</kbd>.</p>
5337
cristy84134182011-06-15 22:59:00 +00005338<p>The <a href="#set">-set profile</a> option can also be used to inject
5339previously-formatted ancillary chunks into the output PNG file, using
5340the commandline option as shown below or by setting the profile via a
5341programming interface:</p>
5342
5343<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>
5344<p>where <em>x</em> is a location flag and
5345<em class="arg">filename</em> is a file containing the chunk
5346name in the first 4 bytes, then a colon (":"), followed by the chunk data.
5347This encoder will compute the chunk length and CRC, so those must not
5348be included in the file.</p>
5349
5350<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
5351or "e" (end, i.e., after IDAT). If you want to write multiple chunks
5352of the same type, then add a short unique string after the "x" to prevent
5353subsequent profiles from overwriting the preceding ones, e.g.,</p>
5354
5355
5356<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -set profile PNG-chunk-b01:file01 / <br/>
5357 -profile PNG-chunk-b02:file02 out.png</span></p>
5358<p>&nbsp;</p>
cristyd0bda5e2010-09-21 16:22:45 +00005359
cristy3ed852e2009-09-05 21:47:34 +00005360
5361<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005362 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005363</div>
5364
5365<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>
5366
5367<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>
5368
5369<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005370 <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 +00005371</div>
5372
5373<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>
5374
5375<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005376 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005377id="shared-memory"></a>-shared-memory</h4>
5378</div>
5379
5380<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>
5381
5382<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>
5383
5384<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005385 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005386</div>
5387
5388<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>sharpen the image.</td><td style='text-align:right;'></td></tr></table>
5389
5390<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5391
5392<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005393 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005394</div>
5395
5396<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>
5397
5398<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>
5399
5400<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>
5401
5402<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005403 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005404</div>
5405
5406<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>
5407
5408<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>
5409
5410<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>
5411
5412<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>
5413
5414<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>
5415
5416<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>
5417<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>
5418
5419<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5420<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005421 <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 +00005422</div>
5423
5424<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>
5425
5426<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>
5427
5428<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005429 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005430</div>
5431
5432<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>
5433
5434<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005435 <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 +00005436</div>
5437
5438<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>
5439
5440<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>
5441
5442<p>For Photo CD images, choose from these sizes:</p>
5443
5444<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005445 192x128
5446 384x256
5447 768x512
5448 1536x1024
5449 3072x2048
cristy3ed852e2009-09-05 21:47:34 +00005450</pre>
5451
cristy3ed852e2009-09-05 21:47:34 +00005452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005453 <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 +00005454</div>
5455
5456<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>
5457
5458<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>
5459
5460<div style="margin: auto;">
cristy2d67ddd2011-02-13 15:38:23 +00005461 <h4><a id="smush"></a>-smush <em class="arg">offset</em></h4>
5462</div>
5463
5464<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>
5465
5466<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005467 <h4><a id="snaps"></a>-snaps <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005468</div>
5469
5470<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>
5471
5472<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5473
5474<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005475 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005476</div>
5477
5478<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>
5479
5480<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5481
5482<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5483
5484<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005485 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005486 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5487</div>
5488
5489<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>
5490
5491
5492<table class="doc">
5493 <tbody>
5494 <tr valign="top">
5495 <th align="left" style="width: 8%">Method</th>
5496 <th align="left">Description</th>
5497 </tr>
5498
5499 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005500 <td valign="top">barycentric</td>
5501 <td valign="top">three point triangle of color given 3 points.
5502 Giving only 2 points will form a linear gradient between those points.
5503 The gradient generated extends beyond the triangle created by those
5504 3 points. </td>
5505 </tr>
5506
5507 <tr valign="top">
5508 <td valign="top">bilinear</td>
5509 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5510 fall back to barycentric. </td>
5511 </tr>
5512 <tr valign="top">
cristy3ed852e2009-09-05 21:47:34 +00005513 <td valign="top">voronoi</td>
5514 <td valign="top">Simply map each pixel to the to nearest color point
5515 given. The result are polygonal 'cells' of solid color. </td>
5516 </tr>
5517
5518 <tr valign="top">
5519 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005520 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005521 squared. Generating spots of color in a sea of the average of
5522 colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005523 </tr>
5524
5525 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005526 <td valign="top">inverse</td>
5527 <td valign="top">Colors points biased on the ratio of inverse distance.
5528 This generates sharper points of color rather than rounded spots of
5529 '<kbd>shepards</kbd>' Generating spots of color in a sea of the
5530 average of colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005531 </tr>
5532
5533 </tbody>
5534</table>
5535
5536<p>The points are placed according to the images location on the virtual
5537canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5538offset), and do not actually have to exist on the given image, but may be
5539some point beyond the edge of the image. All points are floating point values.
5540</p>
5541
5542<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
cristyacc04882011-05-04 23:03:43 +00005543modified, which means that by default matte/alpha transparency channel is not
5544effected. Typically transparency channel is turned off either before or after
5545the operation. </P>
5546
5547Of course if some color points are transparent to generate a transparent
5548gradient, then the image also requires transparency enabled to store the
5549values. </p>
cristy3ed852e2009-09-05 21:47:34 +00005550
5551<p>All the above methods when given a single point of color will replace all
5552the colors in the image with the color given, regardless of the point. This is
5553logical, and provides an alternative technique to recolor a image to some
5554default value. </p>
5555
5556
5557<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005558 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005559</div>
5560
5561<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>
5562
cristyacc04882011-05-04 23:03:43 +00005563<p>This will add rows and columns of the current <a
5564href="#background">-background</a> color into the given image according to the
5565given <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
5566image into four quadrants, separating them by the inserted rows and columns.
5567</P>
5568
5569If a dimension of geometry is zero no rows or columns will be added for that
5570dimension. Similarly using a zero offset with the appropriate <a
5571href="#gravity">-gravity</a> setting will add rows and columns to the edges of
5572the image, padding the image only along that one edge. Edge padding is what <a
5573href="#splice">-splice</a> is most commonly used for. </p>
5574
5575<p>If the exact same <em class="arg">geometry</em> and <a
5576href="#gravity">-gravity</a> is later used with <a href="#chop">-chop</a> the
5577added added all splices removed. </p>
cristy3ed852e2009-09-05 21:47:34 +00005578
5579<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005580 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005581</div>
5582
5583<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>
5584
5585<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>
5586
5587<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00005588 <h4><a id="statistic"></a>-statistic <em class="arg">type</em> <em class="arg">geometry</em></h4>
cristyb52981c2011-03-19 17:09:31 +00005589</div>
5590
5591<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>
5592
5593<p>Choose from these statistic types:</p>
5594<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005595 Gradient maximum difference in area
5596 Maximum maximum value per channel in neighborhood
5597 Minimum minimum value per channel in neighborhood
5598 Mean average value per channel in neighborhood
5599 Median median value per channel in neighborhood
5600 Mode mode (most frequent) value per channel in neighborhood
5601 Nonpeak value just before or after the median value per channel in neighborhood
cristyb52981c2011-03-19 17:09:31 +00005602</pre>
5603
5604<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005605 <h4><a id="stegano"></a>-stegano <em class="arg">offset</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%'>hide watermark within an image.</td><td style='text-align:right;'></td></tr></table>
5609
5610<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>
5611
5612<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005613 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005614</div>
5615
5616<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>
5617
5618<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>
5619
5620<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005621 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005622</div>
5623
5624<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>
5625
5626<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005627 char unsigned characters
5628 double doubles
5629 float floats
5630 integer integers
5631 long longs
5632 quantum pixels in the native depth of your ImageMagick distribution
5633 short unsigned shorts
cristy3ed852e2009-09-05 21:47:34 +00005634</pre>
5635
5636<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5637values range from 0 to the maximum value the storage type can support.</p>
5638
5639<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005640 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005641</div>
5642
5643<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>
5644
5645<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>
5646
5647<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005648 Any
5649 Condensed
5650 Expanded
5651 ExtraCondensed
5652 ExtraExpanded
5653 Normal
5654 SemiCondensed
5655 SemiExpanded
5656 UltraCondensed
5657 UltraExpanded
cristy3ed852e2009-09-05 21:47:34 +00005658</pre>
5659
5660<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5661
5662<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>
5663
5664<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005665 <h4><a id="strip"></a>-strip</h4>
cristy3ed852e2009-09-05 21:47:34 +00005666</div>
5667
5668<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>
5669
5670<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005671 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005672</div>
5673
5674<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>
5675
5676<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5677
5678<p>See <a href="#draw">-draw</a> for further details.</p>
5679
5680<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005681 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005682</div>
5683
5684<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>
5685
5686<p>See <a href="#draw">-draw</a> for further details.</p>
5687
5688<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005689 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005690</div>
5691
5692<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>
5693
cristy71a3f602010-09-15 12:38:16 +00005694<p>This setting suggests a font style that ImageMagick should try to apply to
5695the currently selected font family. Select <em class="arg">fontStyle</em> from
5696the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005697
5698<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005699 Any
5700 Italic
5701 Normal
5702 Oblique
cristy3ed852e2009-09-05 21:47:34 +00005703</pre>
5704
5705<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>
5706
5707<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005708 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005709</div>
5710
cristyd4d64ed2010-08-22 22:19:33 +00005711<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>
5712
cristy71a3f602010-09-15 12:38:16 +00005713<p>This option is required to have compare search for the best match location
5714of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005715(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005716be the "match score" image.</p>
5717
cristyd0bd44a2010-09-24 12:38:11 +00005718<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005719position of the top-left corner of the given sub-image. that is its size will
5720be the size of the larger_image - sub_image + 1. The brightest location in
5721this image is the location s the locate on the best match that is also
5722reported. Note that this may or may nor be a perfect match, and the actual
5723brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005724possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005725
cristyd0bda5e2010-09-21 16:22:45 +00005726<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005727location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005728sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005729
cristyae6203d2010-08-09 01:12:14 +00005730
5731<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005732 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005733</div>
5734
5735<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>
5736
cristy71a3f602010-09-15 12:38:16 +00005737<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5738images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5739the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005740
5741<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005742 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005743</div>
5744
5745<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>
5746
5747<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5748
5749<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005750 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005751</div>
5752
5753<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>
5754
5755<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005756 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005757</div>
5758
cristy5063d812010-10-19 16:28:10 +00005759<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 +00005760
5761<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005762 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005763</div>
5764
5765<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>
5766
5767<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>
5768
5769<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>
5770
5771<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005772 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005773</div>
5774
5775<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>
5776
5777<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005778 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005779</div>
5780
5781<!-- {<em class="arg">green,blue,opacity</em>}
5782<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>
5783-->
5784
5785<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>
5786
5787<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>
5788
5789<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.
5790</p>
5791
5792<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>
5793
5794<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5795<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>
5796
5797
5798<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>
5799<p>Note that the values of the transparency channel is treated as 'matte'
5800values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5801
5802<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>.
5803</p>
5804
5805<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005806 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005807</div>
5808
5809<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>
5810
5811<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>
5812
5813<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>
5814
5815<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005816 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005817</div>
5818
5819<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>
5820
5821<div style="margin: auto;">
5822 <h4>-tile <em class="arg">geometry</em></h4>
5823</div>
5824
5825<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>
5826
5827<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>
5828
5829<div style="margin: auto;">
5830 <h4>-tile</h4>
5831</div>
5832
5833<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>
5834
5835<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005836 <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 +00005837</div>
5838
5839<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>
5840
5841<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>
5842
5843<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>
5844
5845<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005846 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005847</div>
5848
5849<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>
5850
5851<p>Tint the image with the fill color.</p>
5852
5853<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>
5854
5855<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005856 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005857</div>
5858
5859<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>
5860
5861<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>
5862
5863<p>For example,</p>
5864
5865<p class="crtsnip">
5866 -title "%m:%f %wx%h"
5867</p>
5868
5869<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>
5870
5871
5872<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005873 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005874</div>
5875
5876<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>
5877
5878<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5879
5880<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 +00005881
5882<p>This operator has been now been superseded by the <a
5883href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5884
5885
cristy3ed852e2009-09-05 21:47:34 +00005886<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005887 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005888</div>
5889
5890<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>
5891
5892<p>The <em class="arg">color</em> argument is defined using the format
5893described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5894>-fuzz</a> setting can be used to match and replace colors similar to the one
5895given. </p>
5896
cristyb36feb22010-03-26 16:54:37 +00005897<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5898that is make all non-matching colors transparent. </p>
5899
cristy3ed852e2009-09-05 21:47:34 +00005900<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005901href="#transparent" >-transparent</a> but replaces the matching color with the
5902current <a href="#fill">-fill</a> color setting, rather than transparent.
5903However the <a href="#transparent" >-transparent</a> operator also ensures
5904that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5905>-alpha</a> set</kbd>", and does not require you to modify the <a
5906href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005907
cristyb36feb22010-03-26 16:54:37 +00005908<p>Note that this does not define the color as being the 'transparency color'
5909used for color-mapped image formats, such as GIF. For that use <a
5910href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005911
5912
5913<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005914 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005915</div>
5916
5917<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>
5918
5919<p>Sometimes this is used for saving to image formats such as
5920GIF and PNG8 which uses this color to represent boolean transparency. This
5921does not make a color transparent, it only defines what color the transparent
5922color is in the color palette of the saved image. Use <a
5923href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5924
5925<p>This option allows you to have both an opaque visible color, as well as a
5926transparent color of the same color value without conflict. That is, you can
5927use the same color for both the transparent and opaque color areas within an
5928image. This, in turn, frees to you to select a transparent color that is
5929appropriate when an image is displayed by an application that does not handle a
5930transparent color index, while allowing ImageMagick to correctly handle images of this
5931type. </p>
5932
5933<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5934
5935<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005936 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005937</div>
5938
5939<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>
5940
5941<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5942</p>
5943
5944<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005945 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005946</div>
5947
5948<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>
5949
5950
5951<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005952 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005953</div>
5954
5955<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>
5956
5957<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>
5958
5959<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>
5960
5961<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>
5962
5963<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005964 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00005965</div>
5966
5967<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>
5968
5969<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>
5970
5971<p>The page or virtual canvas information of the image is preserved allowing
5972you to extract the result of the <a href="#trim">-trim</a> operation from the
5973image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5974information if it is unwanted.</p>
5975
5976<p>If the trimmed image 'disappears' an warning is produced, and a special
5977single pixel transparent 'missed' image is returned, in the same way as when a
5978<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5979
5980
5981<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005982 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005983</div>
5984
5985<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 +00005986 <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 +00005987
5988<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>
5989
5990<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5991<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>
5992
5993<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5994
5995<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005996 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005997</div>
5998
5999<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>
6000
6001<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
6002
6003<p>See <a href="#draw">-draw</a> for further details.</p>
6004
6005
6006<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006007 <h4><a id="update"></a>-update <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006008</div>
6009
6010<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>
6011
6012<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>
6013
6014
6015<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006016 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00006017</div>
6018
6019<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>
6020
6021
6022<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006023 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006024</div>
6025
6026<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>
6027
6028<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>
6029
6030
6031<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006032 <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 +00006033</div>
6034
6035<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>
6036
6037<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>
6038
6039<p>The parameters are:</p>
6040
6041<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006042 radius The radius of the Gaussian, in pixels, not counting the center
6043 pixel (default 0).
6044 sigma The standard deviation of the Gaussian, in pixels (default 1.0).
6045 amount The fraction of the difference between the original and the blur
6046 image that is added back into the original (default 1.0).
6047 threshold The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
6048 difference amount (default 0.05).
cristy3ed852e2009-09-05 21:47:34 +00006049</pre>
6050
6051
6052<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006053 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00006054</div>
6055
cristyd0bda5e2010-09-21 16:22:45 +00006056<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 +00006057
6058
6059<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006060 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00006061</div>
6062
6063<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>
6064
6065
6066<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006067 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006068</div>
6069
6070<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>
6071
6072
6073<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006074 <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 +00006075</div>
6076
6077<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>
6078
6079
6080<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006081 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006082</div>
6083
6084<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>
6085
6086<p>This option defines what color source should be used if and when a color
6087lookup completely 'misses' the source image. The color(s) that appear to
6088surround the source image. Generally this color is derived from the source
6089image, but could also be set to a specify background color. </p>
6090
6091<p>Choose from these methods:</p>
6092
6093<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006094 background the area surrounding the image is the background color
6095 black the area surrounding the image is black
6096 checker-tile alternate squares with image and background color
6097 dither non-random 32x32 dithered pattern
6098 edge extend the edge pixel toward infinity
6099 gray the area surrounding the image is gray
6100 horizontal-tile horizontally tile the image, background color above/below
6101 horizontal-tile-edge horizontally tile the image and replicate the side edge pixels
6102 mirror mirror tile the image
6103 random choose a random pixel from the image
6104 tile tile the image (default)
6105 transparent the area surrounding the image is transparent blackness
6106 vertical-tile vertically tile the image, sides are background color
6107 vertical-tile-edge vertically tile the image and replicate the side edge pixels
6108 white the area surrounding the image is white
cristy3ed852e2009-09-05 21:47:34 +00006109</pre>
6110
6111<p>The default value is "edge".</p>
6112
6113<p>This most important for distortion operators such as <a href="#distort"
6114>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
6115However it also effects operations that may access pixels just outside the
6116image proper, such as <a href="#convolve">-convolve</a>, <a
6117href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
6118
6119<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
6120
6121
6122<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006123 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006124</div>
6125
6126<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>
6127
6128<p>Choose from these visual classes:</p>
6129
6130<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006131 StaticGray
6132 GrayScale
6133 StaticColor
6134 PseudoColor
6135 TrueColor
6136 DirectColor
6137 default
6138 visual id
cristy3ed852e2009-09-05 21:47:34 +00006139</pre>
6140
6141<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>
6142
6143
6144<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006145 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00006146 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
6147</div>
6148
6149<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
6150saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
6151
6152<p>Take a grayscale image (with alpha mask) and modify the destination image's
6153brightness according to watermark image's grayscale value and the <em
6154class="arg">brightness</em> percentage. The destinations color saturation
6155attribute is just direct modified by the <em class="arg">saturation</em>
6156percentage, which defaults to 100 percent (no color change). </p>
6157
6158
6159<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006160 <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 +00006161</div>
6162
6163<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>
6164
6165<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
6166
6167<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006168 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006169</div>
6170
6171<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>
6172
6173<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>
6174
6175<table class="doc">
6176 <col width="25%" />
6177 <col width="75%" />
6178 <thead>
6179 <tr>
6180 <th><em class="arg">fontWeight</em></th>
6181 <th>Description</th>
6182 </tr>
6183 </thead>
6184 <tbody>
6185 <tr><td>All </td> <td>No effect. </td></tr>
6186 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
6187 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
6188 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
6189 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
6190 </tbody>
6191 </table>
6192
6193<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
6194
6195<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>
6196
6197<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006198 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006199</div>
6200
6201<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>
6202
6203<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006204 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006205</div>
6206
cristy5cadd612009-09-21 19:33:41 +00006207<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>
6208
6209<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.
6210</p>
cristy3ed852e2009-09-05 21:47:34 +00006211
6212<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006213 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006214</div>
6215
6216<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
6217
6218<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>
6219
6220<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>
6221
6222<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>
6223
6224<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006225 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006226</div>
6227
6228<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>
6229
6230<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006231 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006232</div>
6233
6234<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>
6235 <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>
6236
6237<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006238</div>
6239</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006240
6241</div>
6242
6243<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006244 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006245 <span id="linkbar-center">
6246 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006247 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006248 </span>
6249 <span id="linkbar-east">&nbsp;</span>
6250 </div>
6251 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +00006252 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006253 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6254 </div>
6255 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006256 <script type="text/javascript">
6257 var _gaq = _gaq || [];
6258 _gaq.push(['_setAccount', 'UA-17690367-1']);
6259 _gaq.push(['_trackPageview']);
6260
6261 (function() {
6262 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6263 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6264 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6265 })();
6266 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006267</body>
6268</html>