blob: f26b5270c33ba13647019c6b1609ccb979e1b83a [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
cristya4dfb122011-07-07 19:01:57 +00001753<dt>png:compression-filter=<em class="arg">value</em></dt>
1754 <dd> valid values are 0 through 7. 0-4 are the corresponding PNG filters,
1755 5 means adaptive filtering except for images with a colormap, 6 means
1756 adaptive filtering for all images, 7 means MNG "loco" compression.</dd>
1757
cristy87a7f072011-07-01 00:08:52 +00001758<dt>png:compression-level=<em class="arg">value</em></dt>
1759 <dd> valid values are 0 through 9, with 0 providing the least but fastest
1760 compression and 9 usually providing the best and always the slowest.</dd>
1761
1762<dt>png:compression-strategy=<em class="arg">value</em></dt>
1763 <dd> valid values are 0 through 4, meaning default, filtered, huffman_only,
cristya4dfb122011-07-07 19:01:57 +00001764 rle, and fixed ZLIB compression strategy. If you are using an old zlib
1765 that does not support Z_RLE (before 1.2.0) or Z_FIXED (before 1.2.2.2),
1766 values 3 and 4, respectively, will use the zlib default strategy
1767 instead.</dd>
cristy87a7f072011-07-01 00:08:52 +00001768
cristydcca3fa2010-12-29 21:50:07 +00001769<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1770<dt>png:include-chunk=<em class="arg">value</em></dt>
1771<dd>ancillary chunks to be excluded from or included in PNG output.
1772
1773 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1774 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1775 or the word <em class="arg">all</em> or
1776 the word <em class="arg">none</em>. There must be no spaces in the
1777 list. Although PNG chunk-names are case-dependent, you can use
1778 all lowercase names if you prefer.</p>
1779
cristyd241f442011-03-29 13:50:49 +00001780 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
1781 of the PNG encoder and have no effect on the PNG decoder.</p>
1782
cristydcca3fa2010-12-29 21:50:07 +00001783 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1784 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1785 only be written if gamma is not 1/2.2, since most decoders assume
1786 sRGB and gamma=1/2.2 when no colorspace information is included in
1787 the PNG file. Because the list is processed from left to right, you
1788 can achieve this with a single define:</p>
1789
1790<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001791 -define png:include-chunk=none,gAMA
cristydcca3fa2010-12-29 21:50:07 +00001792</pre>
1793
1794 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
cristya4dfb122011-07-07 19:01:57 +00001795 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any such
1796 entries appearing in the list will be ignored.</p>
cristydcca3fa2010-12-29 21:50:07 +00001797
1798 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1799 image has transparency, the PNG colortype is forced to be 4 or 6
1800 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1801 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1802 on the PNG colortype of the output image.</p>
1803
1804 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1805 following for PNG output:</p>
1806
1807<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001808 -define png:include-chunk=none,gama
cristydcca3fa2010-12-29 21:50:07 +00001809</pre>
1810
1811 <p>The default behavior is to include all known PNG ancillary chunks
cristyf7964272011-01-30 03:49:12 +00001812 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk,
1813 and to exclude all PNG chunks that are unknown to ImageMagick,
1814 regardless of their PNG "copy-safe" status as described in the
1815 PNG specification.</p>
cristyd241f442011-03-29 13:50:49 +00001816
1817 <p>Any chunk names that are not known to ImageMagick are ignored
1818 if they appear in either the "include-chunk" or "exclude-chunk" list.
1819 The ancillary chunks currently known to ImageMagick are
1820 <kbd>bKGD</kbd>, <kbd>cHRM</kbd>, <kbd>gAMA</kbd>, <kbd>iCCP</kbd>,
1821 <kbd>oFFs</kbd>, <kbd>pHYs</kbd>, <kbd>sRGB</kbd>, <kbd>tEXt</kbd>,
1822 <kbd>tRNS</kbd>, <kbd>vpAg</kbd>, and <kbd>zTXt</kbd>.</p>
1823
cristyf9a6c462011-04-24 14:01:11 +00001824 <p>You can also put <kbd>date</kbd> in the list to include or exclude
1825 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
1826 inserts in the output PNG.</p>
1827
1828</dd>
1829
1830<dt>png:preserve-colormap</dt>
1831 <dd>Use the existing image->colormap. Normally the PNG encoder will
1832 try to optimize the palette, eliminating unused entries and putting
1833 the transparent colors first. If this flag is set, that behavior
1834 is suppressed.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001835
cristy3ed852e2009-09-05 21:47:34 +00001836<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001837<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1838 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001839 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001840
cristy045bd902010-01-30 18:56:24 +00001841<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001842<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1843 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1844 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001845 included, the result is a single precision floating point format.
1846 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001847 double precision floating point format.</dd>
1848
cristydcca3fa2010-12-29 21:50:07 +00001849</dl>
cristy3ed852e2009-09-05 21:47:34 +00001850
cristyd0bda5e2010-09-21 16:22:45 +00001851<p>For example, to create a postscript file that will render only the black
1852pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001853
1854<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 +00001855<p>Set attributes of the image registry by prefixing the value with
1856<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1857use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001858
1859<p class="crtsnip">
1860-define registry:temporary-path=/data/tmp
1861</p>
1862
cristyd0bda5e2010-09-21 16:22:45 +00001863
1864
cristy3ed852e2009-09-05 21:47:34 +00001865<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001866 <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 +00001867</div>
1868
1869<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>
1870
1871<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>
1872
1873<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>
1874
1875
1876<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00001877 <h4><a id="delete"></a>-delete <em class="arg">indexes</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001878</div>
1879
1880<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>
1881
1882<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>
1883
1884
1885<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001886 <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 +00001887</div>
1888
1889<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>
1890
1891<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>
1892
1893<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>
1894
1895<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>
1896
1897<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>
1898
1899<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001900 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001901</div>
1902
1903<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>
1904
1905<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>
1906
1907<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001908 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00001909</div>
1910
1911<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>
1912
1913<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001914 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001915</div>
1916
1917<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>
1918
1919<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>
1920
1921<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001922 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00001923</div>
1924
1925<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>
1926
1927<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001928 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001929</div>
1930
1931<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>
1932
1933<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001934 <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 +00001935</div>
1936
1937<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>
1938
1939<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001940is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001941what part of the 'background' image is seen at each point of the overlaid
1942area. Much like the displacement map is a 'lens' that redirects light shining
1943through it so as to present a distorted view the original 'background' image
1944behind it. </p>
1945
1946<p>Any perfect grey areas of the displacement map produce a zero
1947displacement of the image. Black areas produce the given maximum negative
1948displacement of the lookup point, while white produce a maximum positive
1949displacement of the lookup. </p>
1950
1951<p>Note that it is the lookup of the 'background' that is displaced, not a
1952displacement of the image itself. As such an area of the displacement map
1953containing 'white' will have the lookup point 'shifted' by a positive amount,
1954and thus generating a copy of the destination image to the right/downward from
1955the correct position. That is the image will look like it may have been
1956'shifted' in a negative left/upward direction. Understanding this is a very
1957important in understanding how displacement maps work. </p>
1958
1959<p>The given arguments define the maximum amount of displacement in pixels
1960that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001961it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001962outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001963easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001964into the overlay area. </p>
1965
1966<p>The '%' flag makes the displacement scale relative to the size of the
1967overlay image (100% = half width/height of image). Using '!' switches
1968percentage arguments to refer to the destination image size instead.
1969these flags were added as of IM v6.5.3-5.</p>
1970
1971<p>Normally a single grayscale displacement map is provided, which with the
1972given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001973displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001974specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001975the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001976displacement, while the <em class="arg">mask image</em> is used for vertical Y
1977displacement. This allows you to define completely different displacement
1978values for the X and Y directions, and allowing you to lookup any point within
1979the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001980any other nearby pixel, producing complex 2 dimensional displacements, rather
1981than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001982
cristya4dfb122011-07-07 19:01:57 +00001983<p>Alteratively rather than supplying two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001984you can use the 'red' channel of the overlay image to specify the horizontal
1985or X displacement, and the 'green' channel for the vertical or Y displacement.
1986</p>
1987
cristyd0bd44a2010-09-24 12:38:11 +00001988<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 +00001989mask the transparency of the destination image. However areas outside the
1990overlaid areas will not be effected. </p>
1991
1992
1993<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001994 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001995</div>
1996
1997<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>
1998
1999<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
2000
2001<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002002 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002003</div>
2004
2005<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>
2006
2007<p>The layer disposal method defines the way each the displayed image is to be
2008modified after the current 'frame' of an animation has finished being
2009displayed (after its 'delay' period), but before the next frame on an
2010animation is to be overlaid onto the display. </p>
2011
2012<p>Here are the valid methods:</p>
2013
2014<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002015 Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
2016 None 1 Do not dispose, just overlay next frame image.
2017 Background 2 Clear the frame area with the background color.
2018 Previous 3 Clear to the image prior to this frames overlay.
cristy3ed852e2009-09-05 21:47:34 +00002019</pre>
2020
2021<p>You can also use the numbers given above, which is what the GIF format
2022uses internally to represent the above settings. </p>
2023
cristyd0bda5e2010-09-21 16:22:45 +00002024<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002025
2026<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
2027resetting the layer disposal methods of images being read in. </p>
2028
2029<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
2030disposal method for images already in memory.</p>
2031
2032<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002033 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002034</div>
2035
2036<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>
2037
2038
2039<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002040 <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 +00002041</div>
2042
2043<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>
2044
2045<p>The opacity of the composite image is multiplied by the given percent, then
2046it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00002047is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00002048transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
2049are given, each image are dissolved to the percentages given. </p>
2050
2051<p>Note that dissolve percentages do not add, two opaque images dissolved
2052'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2053images, you would need to use dissolve values of '50,100'. </p>
2054
2055<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002056 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002057</div>
2058
2059<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>
2060
2061<p>The <em class="arg">arguments</em> is a single string containing a list
2062of floating point numbers separated by commas or spaces. The number of
2063and meaning of the floating point values depends on the distortion <em
2064class="arg">method</em> being used. </p>
2065
2066<p>Choose from these distortion types:</p>
2067
2068<table class="doc">
2069 <tr valign="top">
2070 <th align="left" style="width: 8%">Method</th>
2071 <th align="left">Description</th>
2072 </tr>
2073
2074 <tr valign="top">
2075 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
2076 <br/>or &nbsp; <kbd>SRT</kbd></td>
2077 <td valign="top">
2078 Distort image by first scaling and rotating about a given 'center',
2079 before translating that 'center' to the new location, in that order. It
2080 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
2081 distortion, but without shearing effects. It also provides a good way
2082 of rotating and displacing a smaller image for tiling onto a larger
2083 background (IE 2-dimensional animations). <br/>
2084
2085 The number of arguments determine the specific meaning of each
2086 argument for the scales, rotation, and translation operations. <br/>
2087
2088 <table style="margin-left:auto; margin-right:auto;">
2089 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
2090 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
2091 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00002092 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002093 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
2094 <tr><td>5:</td>
2095 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2096 <tr><td>6:</td>
2097 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
2098 <tr><td>7:</td>
2099 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
2100 &nbsp; NewX,NewY</em></td></tr>
2101 </table>
2102
cristyd0bda5e2010-09-21 16:22:45 +00002103 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00002104 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2105
2106 <tr valign="top">
2107 <td valign="top"><kbd>Affine</kbd></td>
2108 <td valign="top">
2109 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002110 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002111 point values are given allowing the image to be linearly scaled,
2112 rotated, sheared, and translated, according to those three points. See
2113 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2114 distortions. <br/>
2115
2116 More than 3 sets given control point pairs (12 numbers) is least
2117 squares fitted to best match a lineary affine distortion. If only 2
2118 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002119 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002120 flipping or changes in aspect ratio to the resulting image. If only one
2121 control point pair is provides the image is only translated, (which may
2122 be a floating point non-integer translation). <br/>
2123
2124 This distortion does not include any form of perspective distortion.
2125 </td>
2126
2127 </tr>
2128
2129 <tr valign="top">
2130 <td valign="top"><kbd>AffineProjection</kbd></td>
2131 <td valign="top">
2132 Linearly distort an image using the given Affine Matrix of 6
2133 pre-calculated coefficients forming a set of Affine Equations to map
2134 the source image to the destination image.
2135
2136 <div style="text-align: center"><em>
2137 s<sub>x</sub>, r<sub>x</sub>,
2138 r<sub>y</sub>, s<sub>y</sub>,
2139 t<sub>x</sub>, t<sub>y</sub>
2140 </em></div>
2141
2142 See <a href="#affine" >-affine</a> setting for more detail, and
2143 meanings of these coefficients. <br/>
2144
2145 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002146 alternative methods of defining this distortion, with ImageMagick doing
2147 the calculations needed to generate the required coefficients. You can
2148 see the internally generated coefficients, by using a <a
2149 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002150
2151 </tr>
2152
cristy3ed852e2009-09-05 21:47:34 +00002153 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002154 <td valign="top"><kbd>BilinearForward</kbd><br/>
2155 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002156 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002157 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2158 16 values (see below). Not that lines may not appear straight after
2159 distortion, though the distance between coordinates will remain
2160 consistent. <br/>
2161
2162 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2163 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2164 quadrilateral to a rectangle, while preserving the straigth line edges
2165 in each case. <br/>
2166
2167 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2168 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2169 color setting. Also if the quadraterial becomes 'flipped' the image
2170 may dissappear. <br/>
2171
2172 There are future plans to produce a true Bilinear distortion that will
2173 attempt to map any quadrilateral to any other quadrilateral, while
2174 preserving edges (and edge distance ratios).
2175
2176 </td>
cristy3ed852e2009-09-05 21:47:34 +00002177 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002178
2179 <tr valign="top">
2180 <td valign="top"><kbd>Perspective</kbd></td>
2181 <td valign="top">
2182 Perspective distort the images, using a list of 4 or more sets of
2183 control points (as defined below). More that 4 sets (16 numbers) of
2184 control points provide least squares fitting for more accurate
2185 distortions (for the purposes of image registration and panarama
2186 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2187 linear distortion. <br/>
2188
2189 Perspective Distorted images ensures that straight lines remain
2190 straight, but the scale of the distorted image will vary. The horizon
2191 is anti-aliased, and the 'sky' color may be set using the
2192 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2193 </tr>
2194
2195 <tr valign="top">
2196 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2197 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002198 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002199 pre-calculated coefficients. You can get these coefficients by looking
2200 at the <a href="#verbose" >-verbose</a> output of a
2201 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2202 If the last two perspective scaling coefficients are zero, the
2203 remaining 6 represents a transposed 'Affine Matrix'. </td>
2204
2205 </tr>
2206
2207 <tr valign="top">
2208 <td valign="top"><kbd>Arc</kbd></td>
2209 <td valign="top">
2210 Arc the image (variation of polar mapping) over the angle given around
2211 a circle. <br/>
2212 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2213 <tr valign="top"><td>Argument</td>
2214 <td>Meaning</td></tr>
2215 <tr valign="top"><td><em>arc_angle</em></td>
2216 <td>The angle over which to arc the image side-to-side</td></tr>
2217 <tr valign="top"><td><em>rotate_angle</em></td>
2218 <td>Angle to rotate resulting image from vertical center</td></tr>
2219 <tr valign="top"><td><em>top_radius</em></td>
2220 <td>Set top edge of source image at this radius</td></tr>
2221 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2222 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2223 </table>
2224
2225 The resulting image is always resized to best fit the resulting image,
2226 (as if using <a href="#distort" >+distort</a>) while attempting to
2227 preserve scale and aspect ratio of the original image as much as
2228 possible with the arguments given by the user. All four arguments will
2229 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2230
2231 This a variation of a polar distortion designed to try to preserve the
2232 aspect ratio of the image rather than direct Cartesian to Polar
2233 conversion. </td>
2234 </tr>
2235
2236 <tr valign="top">
2237 <td valign="top"><kbd>Polar</kbd></td>
2238 <td valign="top">
2239 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2240 the image. that is the height of the input image is mapped to the
2241 radius limits, while the width is wrapped around between the
2242 angle limits. <br/>
2243
2244 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2245
2246 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2247 center to the center of the image, and the angles going from -180 (top)
2248 to +180 (top). If <em>Rmax</em> is given the special value of
2249 '<code>0</code>', the the distance from the center to the nearest edge
2250 is used for the radius of the output image, which will ensure the whole
2251 image is visible (though scaled smaller). However a special value of
2252 '<code>-1</code>' will use the distance from the center to the furthest
2253 corner, This may 'clip' the corners from the input rectangular image,
2254 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2255 the same arguments. <br/>
2256
2257 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2258 output image center will default to <code>0,0</code> of the virtual
2259 canvas, and the image size adjusted to ensure the whole input image is
2260 made visible in the output image on the virtual canvas. </td>
2261
2262 </tr>
2263
2264 <tr valign="top">
2265 <td valign="top"><kbd>DePolar</kbd></td>
2266 <td valign="top">
2267 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2268 but generates the reverse Polar to Cartesian distortion. <br/>
2269
2270 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2271 the corners of the input image. However using the special
2272 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2273 distance) will ensure the whole distorted image is preserved in the
2274 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2275 reverse the distortion re-producing the original.
2276
2277 Note that as this distortion requires the area resampling of a circular
2278 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002279 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002280 form of 'super-sampling' image processing technique be used to produce
2281 a high quality result. </td>
2282
2283 </tr>
2284
2285 <tr valign="top">
2286 <td valign="top"><kbd>Barrel</kbd></td>
2287 <td valign="top">
2288 Given the four coefficients (A,B,C,D) as defined by <a
cristy6bcf48e2011-02-15 19:09:04 +00002289 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002290 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002291 correct radial lens distortions. That is in photographs, make straight
2292 lines straight again. <br/>
2293
2294 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2295 <em>X</em> , <em>Y</em> ] ] <br/>
2296 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2297 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2298 [ <em>X</em> , <em>Y</em> ] <br/>
2299 So that it forms the function <br/>
2300 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2301 <em>C</em>*r + <em>D</em> )<br/>
2302
2303 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2304 (defaulting to the center of the image). <br/>
2305 The second form is typically used to distort images, rather than
2306 correct lens distortions. <br/>
2307 </td>
2308
2309 </tr>
2310
2311 <tr valign="top">
2312 <td valign="top"><kbd>BarrelInverse</kbd></td>
2313 <td valign="top">
2314 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2315 arguments, and argument handling. However it uses the inverse
2316 of the radial polynomial,
2317 so that it forms the function <br/>
2318 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002319 <em>C</em>*r + <em>D</em> )<br/>
2320 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2321 distortion, just a different barrel-like radial distortion method.
2322
cristy3ed852e2009-09-05 21:47:34 +00002323 </td>
2324 </tr>
2325
2326 <tr valign="top">
2327 <td valign="top"><kbd>Shepards</kbd></td>
2328 <td valign="top">
2329 Distort the given list control points (any number) using an Inverse
2330 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002331 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2332 Method</a>). The control points in effect do 'localized' displacement
2333 of the image around the given control point (preserving the look and
2334 the rotation of the area near the control points. For best results
2335 extra control points should be added to 'lock' the positions of the
2336 corners, edges and other unchanging parts of the image, to prevent
2337 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002338
cristyd0bd44a2010-09-24 12:38:11 +00002339 The distortion has been likened to 'taffy pulling' using nails, or
2340 pins' stuck in a block of 'jelly' which is then moved to the new
2341 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002342
cristybaacd172011-04-30 23:11:03 +00002343 Internally it is equivalent to generating a displacement map (see <a
cristyd0bd44a2010-09-24 12:38:11 +00002344 href="#displace" >-displace</a>) for source image color look-up using
2345 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2346
2347 </td>
cristy3ed852e2009-09-05 21:47:34 +00002348 </tr>
2349
2350</table>
2351
cristyd0bd44a2010-09-24 12:38:11 +00002352<p>To print a complete list of distortion methods, use <a href="#list">-list
2353distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002354
2355<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2356'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2357defining how these points in the given image should be distorted in the
2358destination image. Each set of four floating point values represent a source
2359image coordinate, followed immediately by the destination image coordinate.
2360This produces a list of values such as...</p>
2361<div style="text-align: center"><em>
2362 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2363 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2364 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2365 ... &nbsp;
2366 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2367</em></div>
2368<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2369destination image. </p>
2370
2371<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2372needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2373perspective distortion of the built-in "rose:" image. Note how spaces were
2374used to group the 4 sets of coordinate pairs, to make it easier to read and
2375understand.</p>
2376
2377<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002378convert rose: -virtual-pixel black \<br/>
2379 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2380 rose_3d_rotated.gif</span></p>
2381<p>If more that the required number of coordinate pairs are given for
2382a distortion, the distortion method is 'least squares' fitted to produce the
2383best result for all the coordinate pairs given. If less than the ideal number
2384of points are given, the distort will generally fall back to a simpler form of
2385distortion that can handles the smaller number of coordinates (usally a linear
2386'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002387
cristyd0bda5e2010-09-21 16:22:45 +00002388<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002389find matching coordinate pairs in overlapping images, so as to improve the
2390'fit' of the distortion. Of course a bad coordinate pair can also make the
2391'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002392
2393<p>Colors are acquired from the source image according to the <a
2394href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002395magnified. However if the viewed image is minified (image becomes smaller),
2396a special area resampling function (added ImageMagick v6.3.5-9), is used to
2397produce a higher quality image. For example you can use
2398a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2399the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002400
cristyd0bd44a2010-09-24 12:38:11 +00002401<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2402convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2403 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2404 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002405<p>Note that a infinitely tiled perspective images involving the horizon can
2406be very slow to generate due to the use of the high quality 'area resampling'
2407function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2408using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2409(recommended if you plan to use super-sampling instead). </p>
2410
2411<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2412'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2413will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2414pixels. If you do not what these pixels to be visible, set the color to match
2415the rest of the ground. </p>
2416
2417<p>The output image size will by default be the same as the input image. This
2418means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002419the 'distorted space', those parts is clipped and lost. However if you use
2420the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2421will attempt (if possible) to show the whole of the distorted image, while
2422retaining a correct 'virtual canvas' offset, for image layering. This offset
2423may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2424is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002425
2426<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2427option:distort:viewport {geometry_string}</kbd>" setting which will specify
2428the size and the offset of the generated 'viewport' image of the distorted
2429image space.</p>
2430
2431<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2432{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2433that factor without changing the viewed contents of the distorted image. This
2434can be used either for 'super-sampling' the image for a higher quality result,
2435or for panning and zooming around the image (with appropriate viewport
2436changes, or post-distort cropping and resizing). </p>
2437
2438<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2439href="#distort" >-distort</a> to attempt to output the internal coefficients,
2440and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2441and debugging purposes. This many not be available for all distorts. </p>
2442
2443<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2444produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2445and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002446above settings. It is algorithmically slower however, though that may not be
2447the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002448
2449
2450<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002451 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002452</div>
2453
2454<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>
2455
cristyd0bda5e2010-09-21 16:22:45 +00002456<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 +00002457
2458<p>Dithering is turned on by default, to turn it off use the plus form of the
2459setting, <a href="#dither">+dither</a>. This will also also render PostScript
2460without text or graphic aliasing. Disabling dithering often (but not always)
2461leads to faster process, a smaller number of colors, but more cartoon like
2462image coloring. Generally resulting in 'color banding' effects in areas with
2463color gradients. </p>
2464
2465<p>The color reduction operators <a href="#colors">-colors</a>, <a
2466href="#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>
2467
2468<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>
2469
2470
2471<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002472 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002473</div>
2474
2475<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>
2476
2477<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>
2478
2479<p>The shape primitives:</p>
2480
2481<pre class="text">
2482 point x,y
2483 line x0,y0 x1,y1
2484 rectangle x0,y0 x1,y1
2485 roundRectangle x0,y0 x1,y1 wc,hc
2486 arc x0,y0 x1,y1 a0,a1
2487 ellipse x0,y0 rx,ry a0,a1
2488 circle x0,y0 x1,y1
2489 polyline x0,y0 ... xn,yn
2490 polygon x0,y0 ... xn,yn
2491 bezier x0,y0 ... xn,yn
2492 path path specification
2493 image operator x0,y0 w,h filename
2494</pre>
2495
2496<p>The text primitive:</p>
2497
2498<pre class="text">
2499 text x0,y0 string
2500</pre>
2501<p>The text gravity primitive:</p>
2502
2503<pre class="text">
2504 gravity NorthWest, North, NorthEast, West, Center,
2505 East, SouthWest, South, or SouthEast
2506</pre>
2507
2508<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>
2509
2510<p>The transformation primitives:</p>
2511
2512<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002513 rotate degrees
2514 translate dx,dy
2515 scale sx,sy
2516 skewX degrees
2517 skewY degrees
cristy3ed852e2009-09-05 21:47:34 +00002518</pre>
2519
2520<p>The pixel operation primitives:</p>
2521
2522<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002523 color x0,y0 method
2524 matte x0,y0 method
cristy3ed852e2009-09-05 21:47:34 +00002525</pre>
2526
2527<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>
2528
2529<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>
2530
2531<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2532
2533<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2534
2535<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>
2536
2537<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2538
2539<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>
2540
2541<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>
2542
2543<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>.
2544</p>
2545
2546<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2547
2548<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2549
2550<p class="crtsnip">
2551 -draw 'circle 100,100 150,150'
2552</p>
2553
2554<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
2555draw 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>
2556
2557<p class="crtsnip">
2558 -draw 'bezier 20,50 45,100 45,0 70,50'
2559</p>
2560<p class="crtsnip">
2561 -draw 'bezier 70,50 95,100 95,0 120,50'
2562</p>
2563
2564
2565<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>
2566
2567<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>
2568
2569<p class="crtsnip">
2570 -draw 'image SrcOver 100,100 225,225 image.jpg'
2571</p>
2572
cristybc9539a2010-08-16 18:06:20 +00002573<p>You can use 0,0 for the image size, which means to use the actual
2574dimensions found in the image header. Otherwise, it is scaled to the given
2575dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
cristy29c5c992011-06-25 13:58:49 +00002576a detailed discussion of alpha composition methods that are available.
2577The "special augmented compose operators" such as "dissolve" that require
2578arguments cannot be used at present with the <kbd>-draw image</kbd> option.
2579 </p>
cristy3ed852e2009-09-05 21:47:34 +00002580<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>
2581
2582<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2583
2584<p class="crtsnip">
cristy4bf6e232011-05-21 01:43:33 +00002585 -draw "text 100,100 'Works like magick!' "
cristy3ed852e2009-09-05 21:47:34 +00002586</p>
2587
2588<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2589
2590<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>
2591
2592<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2593
2594<p>The <kbd>scale</kbd> primitive scales them.</p>
2595
2596<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>
2597
2598<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
2599matrix.</p>
2600
2601<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>
2602
2603<pre class="text">
2604 point
2605 replace
2606 floodfill
2607 filltoborder
2608 reset
2609</pre>
2610
2611<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>
2612
2613<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>
2614
2615<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>
2616
2617<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2618
2619<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2620
cristy2dcd6822011-06-13 16:21:20 +00002621
cristy8b9dd952011-03-21 22:56:18 +00002622<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00002623 <h4><a id="duplicate"></a>-duplicate <em class="arg">count,indexes</em></h4>
cristy8b9dd952011-03-21 22:56:18 +00002624</div>
2625
cristy323f35b2011-03-24 23:05:13 +00002626<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 +00002627
cristy323f35b2011-03-24 23:05:13 +00002628<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 +00002629
2630<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002631 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002632</div>
2633
2634<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>
2635
2636<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002637 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002638</div>
2639
2640<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>
2641
2642<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002643 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002644</div>
2645
2646<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>
2647
2648<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2649
2650<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2651
cristyd0bda5e2010-09-21 16:22:45 +00002652
2653
cristy3ed852e2009-09-05 21:47:34 +00002654<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002655 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002656</div>
2657
2658<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>
2659
2660<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>
2661
2662<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002663 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002664</div>
2665
2666<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>
2667
2668<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2669
2670<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2671
2672
2673<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002674 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002675</div>
2676
2677<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>
2678
2679
2680<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002681 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002682</div>
2683
2684<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>
2685
2686<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>
2687
2688<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2689
2690<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>
2691
2692<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002693 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002694</div>
2695
2696<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>
2697
2698<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>
2699
2700<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>
2701
2702<table class="doc">
2703 <col width="25%" />
2704 <col width="75%" />
2705 <thead>
2706 <tr>
2707 <th><em class="arg">operator</em></th>
2708 <th>Summary (see further below for details)</th>
2709 </tr>
2710 </thead>
2711 <tbody>
2712
cristy3c98a4f2010-08-13 20:09:41 +00002713 <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 +00002714 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2715 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2716 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2717 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2718 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002719 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2720 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002721 <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>
2722 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2723 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002724 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002725 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002726 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2727 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2728 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2729 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2730 <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>
2731 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2732 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2733 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2734 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2735
2736 <tr><td>&nbsp;</td></tr>
2737
2738 <tr><td>Gaussian-noise</td></tr>
2739 <tr><td>Impulse-noise</td></tr>
2740 <tr><td>Laplacian-noise</td></tr>
2741 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2742 <tr><td>PoissonNoise</td></tr>
2743 <tr><td>Uniform-noise</td></tr>
2744
2745 <tr><td>&nbsp;</td></tr>
2746
2747 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2748 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2749 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2750 </tbody>
2751 </table>
2752
2753<p>The specified functions are applied only to each previously set <a
2754href="#channel" >-channel</a> in the image. If necessary, the results of the
2755calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2756class="QR">QuantumRange</em>]. The transparency channel of the image is
2757represented as a 'alpha' values (0 = fully transparent), so, for example, a
2758<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2759semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2760as a percentage of the <em class="QR">QuantumRange</em>.</p>
2761
2762<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2763<a href="#list">-list evaluate</a>.</p>
2764
2765<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2766<kbd>Multiply</kbd> methods can also be achieved using either the <a
2767href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2768appropriate argument, to linearly modify the overall range of color values.
2769Please note, however, that <a href="#level" >-level</a> treats transparency as
2770'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2771'alpha' values.</p>
2772
2773<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>
2774
cristyce66ab12010-10-21 23:36:32 +00002775<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>
2776
2777 <div style="text-align:center;">
2778 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2779 </div>
2780
2781<p> If the input image is squared, for example, using <a
2782href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2783
cristy3ed852e2009-09-05 21:47:34 +00002784<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>
2785
2786 <div style="text-align:center;">
2787 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2788 </div>
2789
2790<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2791normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2792href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2793to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2794with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2795with <kbd>Pow</kbd>.</p>
2796
2797<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2798converts the image values into a value according to a (co)sine wave function.
2799The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2800is biased 50% and normalized by 50% so as to fit in the respective color value
2801range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2802function (its frequency), and thus determines the number of 'waves' that will
2803be generated over the input color range. For example, if the <em
2804class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2805class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2806then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002807class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002808
2809 <div style="text-align:center;">
2810 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2811 </div>
2812
cristydcca3fa2010-12-29 21:50:07 +00002813<p>See also the <a href="#function" >-function</a> operator, which is a
2814multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002815
cristy63fed272010-03-07 19:08:45 +00002816<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002817 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002818</div>
2819
2820<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 +00002821
2822<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002823 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002824</div>
2825
2826<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>
2827
cristy3e2860c2010-01-24 01:36:30 +00002828<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 +00002829<p>This command reduces or expands a JPEG image to fit on an 800x600
2830display. If the aspect ratio of the input image isn't exactly 4:3, then the
2831image is centered on an 800x600 black canvas: </p>
2832
2833<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>
2834
cristy3ed852e2009-09-05 21:47:34 +00002835
2836<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>
2837
2838<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002839 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002840</div>
2841
2842<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>
2843
2844<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2845
cristy4949d522010-03-12 18:41:34 +00002846<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 +00002847
cristy4949d522010-03-12 18:41:34 +00002848<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 +00002849<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002850equivalent to:</p>
2851
2852<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>
2853<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>
2854
2855<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002856 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002857</div>
2858
2859<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>
2860
2861<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).
2862</p>
2863
2864<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>.
2865</p>
2866
2867<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002868 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002869</div>
2870
2871<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>
2872
2873<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002874 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002875</div>
2876
2877<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>
2878
cristydcca3fa2010-12-29 21:50:07 +00002879<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 +00002880
cristydcca3fa2010-12-29 21:50:07 +00002881<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 +00002882
2883<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>
2884
2885<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2886<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>
2887
2888<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2889<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>
2890
cristyd0bd44a2010-09-24 12:38:11 +00002891<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 +00002892
2893<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>
2894
2895<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2896 -evaluate log 1000 fft_image_spectrum.png</span></p>
2897<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>
2898
cristydcca3fa2010-12-29 21:50:07 +00002899<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 +00002900
2901<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>
2902
2903<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>
2904
cristydcca3fa2010-12-29 21:50:07 +00002905<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 +00002906
2907<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +00002908<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 +00002909</p>
2910
2911
2912<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002913 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002914</div>
2915
2916<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>
2917
2918<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>
2919
2920<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2921
2922<p>For example,</p>
2923
2924<p class="crtsnip">
2925 -fill blue
2926</p>
2927<p class="crtsnip">
2928 -fill "#ddddff"
2929</p>
2930<p class="crtsnip">
2931 -fill "rgb(255,255,255)"
2932</p>
2933
2934<p>See <a href="#draw">-draw</a> for further details.</p>
2935
2936<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2937
2938<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002939 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002940</div>
2941
cristyd0bda5e2010-09-21 16:22:45 +00002942<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
2943distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002944
cristyd0bda5e2010-09-21 16:22:45 +00002945<p>Use this option to affect the resizing operation of an image during
2946operations such as <a href="#resize">-resize</a> and <a href="#distort"
2947>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002948
2949<pre class="text">
2950 Point Hermite Cubic
2951 Box Gaussian Catrom
2952 Triangle Quadratic Mitchell
2953</pre>
2954
cristyd0bda5e2010-09-21 16:22:45 +00002955<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002956as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2957generally useless on their own as they are infinite filters that are being
2958clipped to the filters support size. Their direct use is not recommended
2959except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002960
cristydcca3fa2010-12-29 21:50:07 +00002961<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002962function that the <a href="#filter" >-filter</a> setting defines. That is
2963using these functions will define a 'Windowed' filter, appropriate to the
2964operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002965
2966<pre class="text">
2967 Lanczos Hamming Parzen
2968 Blackman Kaiser Welsh
2969 Hanning Bartlett Bohman
2970</pre>
2971
2972<p>Also one special self-windowing filter is also provided
2973<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2974on the current 'support' or 'lobes' expert settings (see below).</p>
2975
cristyd0bda5e2010-09-21 16:22:45 +00002976<p>If you do not select a filter with this option, the filter defaults to
2977<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2978if the image is enlarged. Otherwise the filter default to
2979<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002980
cristyd0bda5e2010-09-21 16:22:45 +00002981<p>To print a complete list of resize filters, use the <a href="#list">-list
2982filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002983
2984<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002985use of these expert settings (see also <a href="#define" >-define</a> and <a
2986href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002987
2988<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002989<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002990<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002991 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2992 Gaussian-like filters simple filters, or you may not get the expected
2993 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002994
cristyd0bda5e2010-09-21 16:22:45 +00002995<dt>-define filter:support=<em>radius</em></dt>
2996<dd>Set the filter support radius. Defines how large the filter should be and
2997 thus directly defines how slow the filtered resampling process is. All
2998 filters have a default 'prefered' support size. Some filters like
2999 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
3000 this value. With simple filters this value either does nothing (but slow
3001 the resampling), or will clip the filter function in a detrimental way.
3002 </dd>
cristy3ed852e2009-09-05 21:47:34 +00003003
cristyd0bda5e2010-09-21 16:22:45 +00003004<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003005<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00003006 alternative way of specifying the 'support' range of the filter, that is
3007 designed to be more suited to windowed filters, especially when used for
3008 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003009
cristyd0bda5e2010-09-21 16:22:45 +00003010<dt>-define filter:b=<em>b-spline_factor</em></dt>
3011<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003012<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
3013 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
3014 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
3015 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00003016 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00003017 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003018
cristyd0bda5e2010-09-21 16:22:45 +00003019<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00003020<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00003021 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00003022 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00003023 'Bessel' functions. If defined, no windowing function is used, unless the
3024 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003025
cristyd0bda5e2010-09-21 16:22:45 +00003026<dt>-define filter:window=<em>filter_function</em></dt>
3027<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
3028 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
3029 support range) with the given filter. This allows you to specify a filter
3030 function that is not normally used as a windowing function, such as
3031 <kbd>Box</kbd>, (which effectively turns off the windowing function),
3032 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
3033 </dd>
3034
3035<dt>-define filter:verbose=<em>1</em></dt>
3036<dd>This causes IM to print information on the final internal filter
3037 selection to standard output. This includes a commented header on the
3038 filter settings being used, and data allowing the filter weights to be
3039 easily graphed. </dd>
3040
3041<dd>Note however that some filters are internally defined in terms of other
3042 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
3043 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
3044 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
3045 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00003046
3047</dl>
3048
cristyd0bda5e2010-09-21 16:22:45 +00003049<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00003050
3051<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
3052 -set filter:window=bessel -set filter:lobes=8 \ <br/>
3053 -resize 150% image.jpg</span></p>
3054<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3055
3056<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
3057 -resize 150% image.jpg</span></p>
3058<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00003059filters, and 'verbose' for viewing the internal filter selection), are
3060provided for image processing experts who have studied and understood how
3061resize filters work. Without this knowledge, and an understanding of the
3062definition of the actual filters involved, using expert settings are more
3063likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00003064
3065
3066<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003067 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00003068</div>
3069
3070<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>
3071
3072
3073<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003074 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00003075</div>
3076
3077<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>
3078
cristy2dcd6822011-06-13 16:21:20 +00003079<p>reflect the scanlines in the vertical direction. The image will be mirrored
3080upside-down. </p>
3081
cristy3ed852e2009-09-05 21:47:34 +00003082
3083<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003084 <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 +00003085</div>
3086
cristy2dcd6822011-06-13 16:21:20 +00003087<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>
3088
3089<p>Flood fill starts from the given 'seed point' which is not gravity effected.
3090Any color that matches within <a href="#fuzz" >-fuzz</a> color distance of the
3091given <em class="arg">color</em> argument, connected to that 'seed point'
3092will be replaced with the current <a href="#fill" >-fill</a> color. </p>
3093
3094<p>Note that if the pixel at the 'seed point' does not itself match the given
3095<em class="arg">color</em> (according to <a href="#fuzz" >-fuzz</a>), then no
3096action will be taken. </p>
3097
3098<p>This operator works more like the <a href="#opaque" >-opaque</A> option, than
3099a 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>
3100
cristy3ed852e2009-09-05 21:47:34 +00003101
3102<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003103 <h4><a id="flop"></a>-flop</h4>
cristy3ed852e2009-09-05 21:47:34 +00003104</div>
3105
3106<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>
3107
cristy2dcd6822011-06-13 16:21:20 +00003108<p>Reflect the scanlines in the horizontal direction, just like the image in
3109a vertical mirror. </p>
cristy3ed852e2009-09-05 21:47:34 +00003110
3111
3112<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003113 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003114</div>
3115
3116<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>
3117
3118<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>
3119
3120<p>In addition to the fonts specified by the above pre-defined list, you can
3121also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
3122is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
3123<kbd>x:fixed</kbd> is X11 font.</p>
3124
3125<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>
3126
3127
3128<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003129 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003130</div>
3131
3132<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>
3133
3134<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3135
3136<p>The default foreground color is black.</p>
3137
3138<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003139 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003140</div>
3141
3142<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>
3143
cristy47774982011-02-15 15:17:19 +00003144<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 +00003145
3146<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>
3147
3148<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003149 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003150</div>
3151
3152<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>
3153
3154<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>
3155
3156<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003157 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003158</div>
3159
3160<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>
3161
cristybc9539a2010-08-16 18:06:20 +00003162<p>The color of the border is specified with the <a href="#mattecolor"
3163>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003164
cristybc9539a2010-08-16 18:06:20 +00003165<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
3166class="arg">geometry</em> argument indicates the amount of extra width and
3167height that is added to the dimensions of the image. If no offsets are given
3168in the <em class="arg">geometry</em> argument, then the border added is
3169a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3170the width and height of the border is partitioned to form an outer bevel of
3171thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3172<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3173</p>
3174
3175<p>The <a href="#frame">-frame</a> option is affected by the current <a
3176href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003177'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003178size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3179draws the frame of four distinct colors close to the current <a
3180href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3181center of this image. This means that with the default compose method of
3182'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3183href="#bordercolor">-bordercolor</a> setting.</p>
3184
3185<p>The image composition is not
3186affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003187
3188
3189<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003190 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003191</div>
3192
3193<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>
3194
3195<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003196 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003197</div>
3198
3199<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>
3200
3201<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>
3202
3203<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>
3204
3205<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>
3206
3207<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003208 Polynomial
3209 Sinusoid
3210 Arcsin
3211 Arctan
cristy3ed852e2009-09-05 21:47:34 +00003212</pre>
3213
3214<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3215
3216<dl class="doc">
3217<dt><kbd>Polynomial</kbd></dt>
3218<dd>
3219<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>
3220
3221<div style="text-align: center">
3222 -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>
3223</div>
3224
3225<p>will invoke a polynomial function given by</p>
3226
3227<div style="text-align: center">
3228 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3229 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3230 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3231</div>
3232
3233<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3234
3235<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>
3236
3237<table class="doc">
3238 <col width="35%" />
3239 <col width="35%" />
3240 <col width="30%" />
3241 <tr>
3242 <td>-evaluate Set <em class="arg">value</em> </td>
3243 <td>-function Polynomial <em class="arg">value</em></td>
3244 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3245 </tr>
3246 <tr>
3247 <td>-evaluate Add <em class="arg">value</em> </td>
3248 <td>-function Polynomial 1,<em class="arg">value</em></td>
3249 </tr>
3250 <tr>
3251 <td>-evaluate Subtract <em class="arg">value</em> </td>
3252 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3253 </tr>
3254 <tr>
3255 <td>-evaluate Multiply <em class="arg">value</em> </td>
3256 <td>-function Polynomial <em class="arg">value</em>,0</td>
3257 </tr>
3258 <tr>
3259 <td>+level black% x white%</td>
3260 <td>-function Polynomial A,B</td>
3261 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3262 </tr>
3263</table>
3264
3265<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>
3266</dd>
3267
3268<dt><kbd>Sinusoid</kbd></dt>
3269<dd>
3270<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>
3271
3272<div style="text-align: center">
3273 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3274</div>
3275
3276<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>
3277
3278<div style="text-align: center">
3279<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>
3280</div>
3281
3282<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>
3283
3284<p class="crtsnip">
3285 -function Sinusoid 3,-90,.2,.7
3286</p>
3287
3288<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>
3289
3290<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>
3291
3292<table class="doc">
3293 <tr>
3294 <td>-evaluate Sin <em class="arg">freq</em> </td>
3295 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3296 </tr>
3297 <tr>
3298 <td>-evaluate Cos <em class="arg">freq</em> </td>
3299 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3300 </tr>
3301</table>
3302</dd>
3303
3304<dt><kbd>ArcSin</kbd></dt>
3305<dd>
3306<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3307and can be used to generate cylindrical distortion and displacement maps.
3308The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003309of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003310
cristydcca3fa2010-12-29 21:50:07 +00003311<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003312 -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 +00003313</p>
cristy3ed852e2009-09-05 21:47:34 +00003314
3315<p>with all values given in terms of noramlize color values (0.0 for black,
33161.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3317for bout input (<em class="arg">width</em>), and output (<em
3318class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3319
cristydcca3fa2010-12-29 21:50:07 +00003320<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003321<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 +00003322</p>
cristy3ed852e2009-09-05 21:47:34 +00003323
3324</dd>
3325
3326<dt><kbd>ArcTan</kbd></dt>
3327<dd>
3328<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3329limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003330All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003331
cristydcca3fa2010-12-29 21:50:07 +00003332<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003333 -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 +00003334</p>
cristy3ed852e2009-09-05 21:47:34 +00003335
3336<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3337</p>
3338
cristydcca3fa2010-12-29 21:50:07 +00003339<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003340<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 +00003341</p>
cristy3ed852e2009-09-05 21:47:34 +00003342
3343</dd>
3344
3345</dl>
3346
3347
3348<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003349 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003350</div>
3351
3352<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>
3353
3354<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>
3355
3356<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>
3357
3358
3359<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003360 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003361</div>
3362
3363<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>
3364
3365<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>
3366
3367<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3368
3369
3370<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003371 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003372</div>
3373
3374<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>
3375
3376<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>
3377
3378<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>
3379
3380<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>
3381
3382<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>
3383
3384<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3385
3386<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003387 <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 +00003388</div>
3389
3390<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>
3391
cristyb15553d2010-07-03 22:53:14 +00003392<p>Convolve the image with a Gaussian or normal distribution using the given
3393<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003394
3395<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3396</div>
3397
cristyb15553d2010-07-03 22:53:14 +00003398<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003399determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003400
3401<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003402array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003403integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003404radius that will provide meaningful results for the Gaussian distribution.
3405</p>
3406
3407<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3408operation is. However too small a <em class="arg" >Radius</em>, and sever
3409aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3410should be at least twice the <em class="arg" >Sigma</em> value, though three
3411times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003412
3413<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003414full 2-dimensional convolution is used to generate the weighted average of the
3415neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003416
3417<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3418pixels which are outside the image proper are blurred into the final result.
3419</p>
3420
3421
3422<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003423 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003424</div>
3425
3426<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>
3427
3428<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>
3429
3430<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003431 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003432</div>
3433
3434<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>
3435
3436<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3437<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3438<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3439list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3440installation.</p>
3441
3442<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>
3443
3444<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>
3445
3446<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>
3447
cristy4949d522010-03-12 18:41:34 +00003448<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 +00003449<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>
3450
3451<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>
3452
3453
3454<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003455 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003456</div>
3457
3458<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>
3459
3460
3461<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003462 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003463</div>
3464
3465<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>
3466
3467<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3468dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3469can apply any color transformation to the Hald image and then use this option
3470to apply the transform to the image. </p>
3471
3472<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3473<p>This option provides a convenient method for you to use Gimp or Photoshop
3474to make color corrections to the Hald CLUT image and subsequently apply them
3475to multiple images using an ImageMagick script. </p>
3476
3477<p>Note that the representation is only of the normal RGB color space and that
3478the whole color value triplet is used for the interpolated lookup of the
3479represented Hald color cube image. Because of this the operation is not <a
3480href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3481images transparency or alpha/matte channel.</p>
3482
3483<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3484of the individual color channels, usally involving a simplier gray-scale
3485image. E.g: gray-scale to color replacement, or modification by a histogram
3486mapping. </p>
3487
3488
3489<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003490 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003491</div>
3492
3493<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>
3494
3495<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003496 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003497</div>
3498
3499<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>
3500
3501<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003502 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003503</div>
3504
3505<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>
3506
3507<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>
3508
3509<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>
3510
3511<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003512 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003513</div>
3514
3515<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>
3516
3517<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003518 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003519</div>
3520
3521<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>
3522
3523<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>
3524
cristy47774982011-02-15 15:17:19 +00003525<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 +00003526
cristyd0bda5e2010-09-21 16:22:45 +00003527<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003528amounts of image properties are displayed including image statistics, profiles,
3529image histogram, and others.</p>
3530
3531<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003532 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003533</div>
3534
3535<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>
3536
cristydcca3fa2010-12-29 21:50:07 +00003537<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 +00003538
3539<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>
3540
3541<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3542<p>or</p>
3543
3544<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>
3545
cristydcca3fa2010-12-29 21:50:07 +00003546<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 +00003547
cristydcca3fa2010-12-29 21:50:07 +00003548<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 +00003549
cristydcca3fa2010-12-29 21:50:07 +00003550<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 +00003551
3552<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003553 <h4><a id="immutable"></a>-immutable</h4>
cristy3ed852e2009-09-05 21:47:34 +00003554</div>
3555
3556<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>
3557
3558<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003559 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003560</div>
3561
3562<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>
3563
3564<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003565 <h4><a id="insert"></a>-insert <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003566</div>
3567
3568<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>
3569
3570<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>
3571
3572<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>
3573
3574<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003575 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003576</div>
3577
3578<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>
3579
3580<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>
3581
3582<p>The default intent is undefined.</p>
3583
3584<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3585
3586<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003587 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003588</div>
3589
3590<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>
3591
3592<p>Choose from:</p>
3593
3594<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003595 none
3596 line
3597 plane
3598 partition
3599 JPEG
3600 GIF
3601 PNG
cristy3ed852e2009-09-05 21:47:34 +00003602</pre>
3603
3604<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>
3605
3606<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3607
3608<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3609
3610<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3611
3612<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3613image.G, and image.B).</p>
3614
3615<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>
3616image.</p>
3617
3618<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3619
3620<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003621 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003622</div>
3623
3624<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>
3625
cristyd0bda5e2010-09-21 16:22:45 +00003626<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003627value, you typically fall in between the pixel colors defined by the source
3628image. This setting determines how the color is determined from the colors of
3629the pixels surrounding that point. That is how to determine the color of a
3630point that falls between two, or even four different colored pixels. </p>
3631
3632<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003633 integer The color of the top-left pixel (floor function)
3634 nearest-neighbor The nearest pixel to the lookup point (rounded function)
3635 average The average color of the surrounding four pixels
3636 bilinear A double linear interpolation of pixels (the default)
3637 mesh Divide area into two flat triangular interpolations
3638 bicubic Fitted bicubic-spines of surrounding 16 pixels
3639 spline Direct spline curves (colors are blurred)
3640 filter Use resize <a href="#filter">-filter</a> settings
cristy3ed852e2009-09-05 21:47:34 +00003641</pre>
3642
3643<p>This most important for distortion operators such as <a href="#distort"
3644>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3645>-transform</a> and <a href="#fx" >-fx</a>. </p>
3646
3647<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3648
3649<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3650lookup for positions outside the boundaries of the image. </p>
3651
3652
3653<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003654 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003655</div>
3656
3657<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>
3658
3659<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003660 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003661</div>
3662
3663<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>
3664
3665<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003666 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003667</div>
3668
3669<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>
3670
3671<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003672 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003673</div>
3674
3675<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>
3676
cristy71a3f602010-09-15 12:38:16 +00003677<p>Use this option to assign a specific label to the image, as it is read in
3678or created. You can use the <a href="#set" >-set</a> operation to re-assign
3679a the labels of images already read in. Image formats such as TIFF, PNG,
3680MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003681
cristy71a3f602010-09-15 12:38:16 +00003682<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3683assigned to an image is used as a header string to print above the postscript
3684image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003685
cristybc9539a2010-08-16 18:06:20 +00003686<p>You can include the image filename, type, width, height, or other image
3687attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3688Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003689
3690<p>For example,</p>
3691
3692<p class="crtsnip">
3693 -label "%m:%f %wx%h" bird.miff
3694</p>
3695
cristy71a3f602010-09-15 12:38:16 +00003696<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3697"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3698is read in. If a <a href="#label">+label</a> option was used instead, any
3699existing label present in the image would be used. You can remove all labels
3700from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003701
cristy71a3f602010-09-15 12:38:16 +00003702<p>A label is not drawn on the image, but is embedded in the image datastream
3703via <em>Label</em> tag or similar mechanism. If you want the label to be
3704visible on the image itself, use the <a href="#draw">-draw</a> option, or
3705during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003706
cristy71a3f602010-09-15 12:38:16 +00003707<p>If the first character of <em class="arg">string</em> is <em
3708class="arg">@</em>, the image label is read from a file titled by the
3709remaining characters in the string. Labels in a file are literal, no embedded
3710formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003711
3712
3713<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003714 <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 +00003715</div>
3716
3717<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>
3718
3719<p>Adaptively threshold each pixel based on the value of pixels in a
3720surrounding window. If the current pixel is lighter than this average plus
3721the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3722black. Small variations in pixel values such as found in scanned documents
3723can be ignored if offset is positive. A negative offset will make it more
3724sensitive to those small variations. </p>
3725
3726<p>This is commonly used to threshold images with an uneven background. It is
3727based on the assumption that average color of the small window is the
3728the local background color, from which to separate the forground color. </p>
3729
3730
3731<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003732 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003733</div>
3734
3735<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>
3736
3737<p>Perform various image operation methods to a ordered sequence of images
3738which may represent either a set of overlaid 'image layers', a GIF disposal
3739animation, or a fully-'coalesced' animation sequence. </p>
3740
3741<table class="doc">
3742 <tbody>
3743 <tr valign="top">
3744 <th align="left" style="width: 8%">Method</th>
3745 <th align="left">Description</th>
3746 </tr>
3747
3748 <tr valign="top">
3749 <td valign="top">compare-any</td>
3750 <td valign="top">Crop the second and later frames to the smallest rectangle
3751 that contains all the differences between the two images. No GIF <a
3752 href="#dispose" >-dispose</a> methods are taken into account. </td>
3753 </tr>
3754
3755 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3756 >-deconstruct</a> operator, and does not preserve animations normal
3757 working, especially when animation used layer disposal methods such as
3758 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3759 </tr>
3760
3761 <tr valign="top">
3762 <td valign="top">compare-clear</td>
3763 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3764 opaque pixels which become transparent in the second frame. That is the
3765 smallest image needed to mask or erase pixels for the next frame. </td>
3766 </tr>
3767
3768 <tr valign="top">
3769 <td valign="top">compare-overlay</td>
3770 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3771 extra color to the next image, as a result of overlaying color pixels.
3772 That is the smallest single overlaid image to add or change colors. </td>
3773 </tr>
3774
3775 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3776 composition method '<kbd>change-mask</kbd>', to reduce the image to
3777 just the pixels that need to be overlaid. </td>
3778 </tr>
3779
3780 <tr valign="top">
3781 <td valign="top">coalesce</td>
3782 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3783 >-coalesce</a> operator. Apply the layer disposal methods set in the
3784 current image sequence to form a fully defined animation sequence, as
3785 it should be displayed. Effectively converting a GIF animation into a
3786 'film strip'-like animation. </td>
3787 </tr>
3788
3789 <tr valign="top">
3790 <td valign="top">composite</td>
3791 <td valign="top">Alpha Composition of two image lists, separated by a
3792 "<kbd>null:</kbd>" image, with the destination image list first, and
3793 the source images last. An image from each list are composited
3794 together until one list is finished. The separator image and source
3795 image lists are removed. </td>
3796 </tr>
3797
3798
cristybac7a162010-06-15 19:57:29 +00003799 <tr><td></td>
3800 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3801 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3802 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003803 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003804 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003805
cristybac7a162010-06-15 19:57:29 +00003806 <tr><td></td>
3807 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003808 applied to all the images in the other image list, regardless of which
3809 list it is. In this case it is the image meta-data of the list which
3810 preserved. </td>
3811 </tr>
3812
3813
3814 <tr valign="top">
3815 <td valign="top">dispose</td>
3816 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3817 the animation after the layer disposal method has been applied, before
3818 the next sub-frame image is overlaid. That is the 'dispose' image that
3819 results from the application of the GIF <a href="#dispose"
3820 >-dispose</a> method. This allows you to check what
3821 is going wrong with a particular animation you may be developing.
3822 </td>
3823 </tr>
3824
3825 <tr valign="top">
3826 <td valign="top">flatten</td>
3827 <td valign="top">Create a canvas the size of the first images virtual
3828 canvas using the current <a href="#background" >-background</a> color,
3829 and <a href="#compose" >-compose</a> each image in turn onto that
3830 canvas. Images falling outside that canvas is clipped. Final
3831 image will have a zero virtual canvas offset. </td>
3832 </tr>
3833
cristybac7a162010-06-15 19:57:29 +00003834 <tr><td></td>
3835 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003836 overlaying all the prepared image layers into a final image. </td>
3837 </tr>
3838
cristybac7a162010-06-15 19:57:29 +00003839 <tr><td></td>
3840 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003841 canvas with real pixels, or to underlay a opaque color to remove
3842 transparency from an image.</td>
3843 </tr>
3844
3845
3846 <tr valign="top">
3847 <td valign="top">merge</td>
3848 <td valign="top">As 'flatten' method but merging all the given image
cristy10549a12011-05-15 19:04:46 +00003849 layers to create a new layer image just large enough to hold all the
3850 image without clipping or extra space. The new images virtual offset
3851 will preserve the position of the new layer, even if this offset is
3852 negative. The virtual canvas size of the first image is preserved.
cristy3ed852e2009-09-05 21:47:34 +00003853 </td>
cristy10549a12011-05-15 19:04:46 +00003854 </tr>
cristy3ed852e2009-09-05 21:47:34 +00003855
cristy10549a12011-05-15 19:04:46 +00003856 <tr><td></td><td>Caution is advised when handling image layers with
3857 negative offsets as few image file formats handle them correctly.
3858 Following this operation methd with <a href="#repage" >+repage</a>
3859 will remove the layer offset, and create a image in which all the
3860 overlaid image positions relative to each other is preserved, though
3861 not nessaraily exactly where you specified them.
3862 </td>
3863 </tr>
3864
3865 <tr><td></td><td>See also 'trim-bounds' below whcih is closely related but
3866 without doing the'flatten' to merge the images together. </td>
cristy3ed852e2009-09-05 21:47:34 +00003867 </tr>
3868
3869 <tr valign="top">
3870 <td valign="top">mosaic</td>
3871 <td valign="top">As 'flatten' method but expanding the initial canvas size
cristy10549a12011-05-15 19:04:46 +00003872 of the first image in a positive direction only so as to hold all the
3873 image layers. However as a virtual canvas is 'locked' to the origin,
3874 by its own definition, image layers with a negative offsets will still
3875 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
3876 if this could be a problem. </td>
3877
cristy3ed852e2009-09-05 21:47:34 +00003878 </tr>
3879
cristy10549a12011-05-15 19:04:46 +00003880 <tr><td></td><td>This method is commonly used to layout individual image
3881 using various offset but without knowing the final canvas size. The
3882 resulting image will, like 'flatten' not have any virtual offset, so
3883 can be saved to any image file format. </td>
cristy3ed852e2009-09-05 21:47:34 +00003884 </tr>
3885
3886
3887 <tr valign="top">
3888 <td valign="top">optimize</td>
3889 <td valign="top">Optimize a coalesced animation, into GIF animation using
3890 a number of general techniques. This currently a short cut to
3891 apply both the '<kbd>optimize-frame</kbd>', and
3892 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3893 include other optimization methods as they are developed. </td>
3894 </tr>
3895
3896 <tr valign="top">
3897 <td valign="top">optimize-frame</td>
3898 <td valign="top">Optimize a coalesced animation, into GIF animation by
3899 reducing the number of pixels per frame as much as possible by
3900 attempting to pick the best layer disposal method to use, while ensuring
3901 the result will continue to animate properly. </td>
3902 </tr>
3903
cristy10549a12011-05-15 19:04:46 +00003904 <tr><td></td><td> There is no guarantee that the best optimization is found.
3905 But then no reasonably fast GIF optimization algorithm can do this.
cristy3ed852e2009-09-05 21:47:34 +00003906 However this does seem to do better than most other GIF frame
3907 optimizers seen. </td>
3908 </tr>
3909
3910 <tr valign="top">
3911 <td valign="top">optimize-plus</td>
3912 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3913 overall optimization by adding extra frames to the animation, without
3914 changing the final look or timing of the animation. The frames are
3915 added to attempt to separate the clearing of pixels from the
3916 overlaying of new additional pixels from one animation frame to the
3917 next. If this does not improve the optimization (for the next frame
3918 only), it will fall back to the results of the previous normal
3919 '<kbd>optimize-frame</kbd>' technique. </td>
3920 </tr>
3921
cristy10549a12011-05-15 19:04:46 +00003922 <tr><td></td><td>There is the possibility that the change in the disposal
3923 style will result in a worsening in the optimization of later frames,
3924 though this is unlikely. In other words there no guarantee that it is
3925 better than the normal '<kbd>optimize-frame</kbd>' technique. For some
3926 animations however you can get a vast improvement in the final
3927 animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003928 </tr>
3929
3930 <tr valign="top">
3931 <td valign="top">optimize-transparency</td>
3932 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3933 overlay images with transparency, if it does not change the resulting
3934 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3935 </td>
3936 </tr>
3937
cristy10549a12011-05-15 19:04:46 +00003938 <tr><td></td><td>This should allow a existing frame optimized GIF animation
3939 to compress into a smaller file size due to larger areas of one
3940 (transparent) color rather than a pattern of multiple colors repeating
3941 the current disposed image of the last frame. </td>
cristy3ed852e2009-09-05 21:47:34 +00003942 </tr>
3943
3944 <tr valign="top">
3945 <td valign="top">remove-dups</td>
3946 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3947 images, so as to simplify layer overlays of coalesced animations.
3948 </td>
3949 </tr>
3950
cristy10549a12011-05-15 19:04:46 +00003951 <tr><td></td><td>Usually this a result of using a constant time delay
3952 across the whole animation, or after a larger animation was split into
3953 smaller sub-animations. The duplicate frames could also have been
3954 used as part of some frame optimization methods. </td>
cristy3ed852e2009-09-05 21:47:34 +00003955 </tr>
3956
3957 <tr valign="top">
3958 <td valign="top">remove-zero</td>
3959 <td valign="top">Remove any image with a zero time delay, unless ALL the
3960 images have a zero time delay (and is not a proper timed animation, a
3961 warning is then issued). </td>
3962 </tr>
3963
cristy10549a12011-05-15 19:04:46 +00003964 <tr><td></td><td>In a GIF animation, such images are usually frames which
3965 provide partial intermediary updates between the frames that are
3966 actually displayed to users. These frames are usally added for
3967 improved frame optimization in GIF animations. </td>
cristy3ed852e2009-09-05 21:47:34 +00003968 </tr>
3969
3970 <tr valign="top">
3971 <td valign="top">trim-bounds</td>
3972 <td valign="top">Find the bounds of all the images in the current
3973 image sequence, then adjust the offsets so all images are contained on
cristy10549a12011-05-15 19:04:46 +00003974 a minimal positive canvas. None of the image data is modified or
3975 merged, only the individual image virtual canvas size and offset.
3976 All the images is given the same canvas size, and and will have
3977 a positive offset, but will remain in the same position relative to
3978 each other. As a result of the minimal canvas size at least one image
3979 will touch every edge of that canvas. The image data touching those
3980 edges however may be transparent. </td>
3981 </tr>
3982
3983 <tr><td></td><td>The result is much like if you used 'merge' followed by a
3984 <a href="#repage" >+repage</a> option, except that all the images
3985 have been kept separate. If 'flatten' is used after using
3986 'trim-bounds' you will get the same result. </td>
cristy3ed852e2009-09-05 21:47:34 +00003987 </tr>
3988
3989 </tbody>
3990</table>
3991
3992<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3993
3994<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3995>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
cristy10549a12011-05-15 19:04:46 +00003996>-mosaic</a> are only aliases for the above methods and may be depreciated in
3997the future. Also see <a href="#page" >-page</a>, <a href="#repage"
3998>-repage</a> operators, the <a href="#compose" >-compose</a> setting, and the
3999GIF <a href="#dispose" >-dispose</a> and <a href="#delay" >-delay</a>
4000settings. </p>
cristy3ed852e2009-09-05 21:47:34 +00004001
4002
4003<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004004 <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 +00004005</div>
4006
4007<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>
4008
4009<p>Given one, two or three values delimited with commas: black-point,
4010white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
4011white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
4012point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
4013contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
4014both black and white points are percentages of the full color range. Gamma
4015will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
4016omitted, the default of 1.0 (no gamma correction) is assumed.</p>
4017
4018<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
4019the given '<kbd>black_point</kbd>' value in the original image is set to
4020zero (or black), while the given '<kbd>white_point</kbd>' value is set to
4021<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
4022to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
4023adjusted. </p>
4024
4025<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
4026adding the special '!' flag anywhere in the argument list, will cause the
4027operator to do the reverse of the level adjustment. That is a zero, or
4028<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
4029adjusted to the given level values, allowing you to de-contrast, or compress
4030the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
4031
4032<p>Only the channels defined by the current <a href="#channel">-channel</a>
4033setting are adjusted (defaults to RGB color channels only), allowing you to
4034limit the effect of this operator. </p>
4035
4036<p>Please note that the transparency channel is treated as 'matte'
4037values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
4038
4039
4040<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004041 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00004042 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
4043</div>
4044
cristyd0bda5e2010-09-21 16:22:45 +00004045<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 +00004046
4047<p>This function is exactly like <a href="#level">-level</a>, except that the
4048value value for each color channel is determined by the
4049'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
4050described under the <a href="#fill">-fill</a> option). </p>
4051
cristyd0bda5e2010-09-21 16:22:45 +00004052<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
4053is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00004054colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00004055adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00004056
4057<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
4058will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00004059respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00004060those colors. This can also be used to convert a plain gray-scale image into a
4061one using the gradient of colors specified. </p>
4062
4063<p>By supplying a single color with a comma separator either before or after
4064that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00004065respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00004066used for both the black and white color points, making the operator either
4067threshold the images around that color (- form) or set all colors to that
4068color (+ form). </p>
4069
4070
4071<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004072 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004073</div>
4074
4075<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>
4076
4077<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>
4078
cristy6b636652009-12-05 17:16:11 +00004079<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 +00004080
4081<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00004082 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00004083</p>
4084
4085<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
4086
cristydcca3fa2010-12-29 21:50:07 +00004087<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 +00004088 File Area Memory Map Disk Thread Time
4089 ------------------------------------------------------------------------------
4090 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
cristydcca3fa2010-12-29 21:50:07 +00004091</pre>
4092
cristy3ed852e2009-09-05 21:47:34 +00004093<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>
4094
4095<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>
4096
4097<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>
4098
4099<p class="crtsnip">
4100-limit area 10mb
4101</p>
4102
cristyd0bda5e2010-09-21 16:22:45 +00004103<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 +00004104
4105<p class="crtsnip">
4106-limit area 10mb -limit disk 500mb
4107</p>
4108
4109<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
4110
4111<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>
4112
4113<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.
4114</p>
4115
4116<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.
4117</p>
4118
4119<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004120 <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 +00004121</div>
4122
4123<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>
4124
cristyd934d102009-10-10 12:55:13 +00004125<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
4126and uses a 'histogram bin' to determine the range of color values that needs to
4127be stretched. However it then stretchs those colors using the <a
4128href="#level" >-level</a> operator.</p>
4129
4130<p>As such while the initial determination may have 'binning' round off
4131effects, the image colors are stretched mathematically, rather than using the
4132histogram bins. This makes the operator more accurate. </p>
4133
4134<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
4135'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
4136perfect stretch of the color range. </p>
4137
4138<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
4139normalization of mathematical images. </p>
4140
4141<p>This operator is under review for re-development. </p>
4142
4143
cristy3ed852e2009-09-05 21:47:34 +00004144<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004145 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00004146</div>
4147
4148<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>
4149
4150<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004151 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004152</div>
4153
4154<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>
4155
4156<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>
4157
4158<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004159 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004160</div>
4161
4162<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>
4163
4164<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004165 Align Alpha Boolean Channel
4166 Class ClipPath Coder Color
4167 Colorspace Command Compose Compress
4168 Configure DataType Debug Decoration
4169 Delegate Direction Dispose Distort
4170 Dither Endian Evaluate FillRule
4171 Filter Font Format Function
4172 Gravity ImageList Intent Interlace
4173 Interpolate Kernel Layers LineCap
4174 LineJoin List Locale LogEvent
4175 Log Magic Method Metric
4176 Mime Mode Morphology Module
4177 Noise Orientation Policy PolicyDomain
4178 PolicyRights Preview Primitive QuantumFormat
4179 Resource SparseColor Storage Stretch
4180 Style Threshold Type Units
4181 Validate VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004182</pre>
4183
cristybac7a162010-06-15 19:57:29 +00004184<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4185list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4186available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004187
4188<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4189<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004190 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004191</div>
4192
4193<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>
4194
cristybac7a162010-06-15 19:57:29 +00004195<p>This option specifies the format for the log printed when the <a
4196href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004197
cristybac7a162010-06-15 19:57:29 +00004198<p>You can display the following components by embedding special format
4199characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004200
4201<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004202 %d domain
4203 %e event
4204 %f function
4205 %l line
4206 %m module
4207 %p process ID
4208 %r real CPU time
4209 %t wall clock time
4210 %u user CPU time
4211 %% percent sign
4212 \n newline
4213 \r carriage return
cristy3ed852e2009-09-05 21:47:34 +00004214</pre>
4215
4216<p>For example:</p>
4217
4218<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>
4219<p>The default behavior is to print all of the components.</p>
4220
4221<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004222 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004223</div>
4224
4225<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>add Netscape loop extension to your GIF animation.</td><td style='text-align:right;'></td></tr></table>
4226
cristybac7a162010-06-15 19:57:29 +00004227<p>Set iterations to zero to repeat the animation an infinite number of times,
4228otherwise the animation repeats itself up to <em class="arg">iterations</em>
4229times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004230
4231<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004232 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004233</div>
4234
4235<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>when comparing images, de-emphasize pixel differences with this color.</td><td style='text-align:right;'></td></tr></table>
4236
4237<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004238 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004239</div>
4240
4241<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>
4242
4243
4244<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004245 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004246</div>
4247
4248<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>
4249
4250<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4251
4252<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004253 best
4254 default
4255 gray
4256 red
4257 green
4258 blue
cristy3ed852e2009-09-05 21:47:34 +00004259</pre>
4260
cristybac7a162010-06-15 19:57:29 +00004261<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4262Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4263the type and <kbd>display</kbd> searches the list of colormap types in
4264<kbd>top-to-bottom</kbd> order until one is located. See <em
4265class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004266
4267
4268<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004269 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004270</div>
4271
4272<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>
4273
4274<p>Here are the valid components of a map:</p>
4275
4276<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004277 r red pixel component
4278 g green pixel component
4279 b blue pixel component
4280 a alpha pixel component (0 is transparent)
4281 o opacity pixel component (0 is opaque)
4282 i grayscale intensity pixel component
4283 c cyan pixel component
4284 m magenta pixel component
4285 y yellow pixel component
4286 k black pixel component
4287 p pad component (always 0)
cristy3ed852e2009-09-05 21:47:34 +00004288</pre>
4289
cristybac7a162010-06-15 19:57:29 +00004290<p>You can specify as many of these components as needed in any order (e.g.
4291bgr). The components can repeat as well (e.g. rgbr).</p>
4292
cristy3ed852e2009-09-05 21:47:34 +00004293
4294<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004295 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004296<em class="arg">filename</em></h4>
4297</div>
4298
cristyacc04882011-05-04 23:03:43 +00004299<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 +00004300
cristyacc04882011-05-04 23:03:43 +00004301<p>This the same as using a mask used for composite masking operations, with
4302grayscale values causing blended updates of the image the mask is attached to.
4303</P>
4304
4305<p>Use <a href="#mask">+mask</a> to remove the mask from images.</p>
4306
4307<p>Also see <a href="#clip-mask">-clip-mask</a> which work in the same way,
4308but with strict boolean masking. </p>
cristy3ed852e2009-09-05 21:47:34 +00004309
4310<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004311 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004312</div>
4313
4314<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>
4315
4316<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4317
cristybac7a162010-06-15 19:57:29 +00004318<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4319style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004320
4321<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004322 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004323</div>
4324
4325<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>
4326
cristyacc04882011-05-04 23:03:43 +00004327<p>Select the 'maximum' value from all the surrounding pixels. </p>
4328
4329<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4330name. </p>
4331
cristyd2baf7d2010-03-06 04:26:44 +00004332<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004333 <h4><a id="median"></a>-median <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004334</div>
4335
4336<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>
4337
cristyacc04882011-05-04 23:03:43 +00004338<p>Select the 'middle' value from all the surrounding pixels. </p>
4339
4340<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4341name. </p>
4342
cristy3ed852e2009-09-05 21:47:34 +00004343<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004344 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004345</div>
4346
4347<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>
4348
4349<p>Choose from:</p>
4350
4351<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004352 AE absolute error count, number of different pixels (-fuzz effected)
4353 FUZZ mean color distance
4354 MAE mean absolute error (normalized), average channel error distance
4355 MEPP mean error per pixel (normalized mean error, normalized peak error)
4356 MSE mean error squared, average of the channel error squared
4357 NCC normalized cross correlation
4358 PAE peak absolute (normalize peak absolute)
4359 PSNR peak signal to noise ratio
4360 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004361</pre>
4362
cristy771f7a72010-11-27 21:42:59 +00004363<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4364with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4365only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004366size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004367'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004368for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004369
4370<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4371('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004372normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004373
cristybac7a162010-06-15 19:57:29 +00004374<p>To print a complete list of metrics, use the <a href="#list">-list
4375metrics</a> option.</p>
4376
cristy3ed852e2009-09-05 21:47:34 +00004377
cristyd2baf7d2010-03-06 04:26:44 +00004378<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004379 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004380</div>
4381
4382<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>
4383
cristyacc04882011-05-04 23:03:43 +00004384<p>Select the 'minimal' value from all the surrounding pixels. </p>
4385
4386<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4387name. </p>
4388
4389
cristy3ed852e2009-09-05 21:47:34 +00004390
4391<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004392 <h4><a id="mode"></a>-mode <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004393</div>
4394
cristy29c5c992011-06-25 13:58:49 +00004395<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 +00004396
4397<div style="margin: auto;">
4398 <h4>-mode <em class="arg">value</em></h4>
4399</div>
4400
cristy3ed852e2009-09-05 21:47:34 +00004401<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>
4402
cristybac7a162010-06-15 19:57:29 +00004403<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4404Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004405
cristybac7a162010-06-15 19:57:29 +00004406<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4407for a list of <a href="#mode" >-mode</a> arguments available in your
4408ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004409
4410
4411<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004412 <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 +00004413</div>
4414
cristybac7a162010-06-15 19:57:29 +00004415<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
4416class="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 +00004417
cristyb36feb22010-03-26 16:54:37 +00004418<p>The arguments are given as a percentages of variation. A value of 100 means
4419no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004420
cristyb36feb22010-03-26 16:54:37 +00004421<p>The <em class="arg">brightness</em> is a multiplier of the overall
4422brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4423twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4424before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004425
cristyb36feb22010-03-26 16:54:37 +00004426<p>The <em class="arg">saturation</em> controls the amount of color in an
4427image. For example, 0 produce a grayscale image, while a large value such as
4428200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004429
cristyb36feb22010-03-26 16:54:37 +00004430<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4431within the image by the amount specified. For example, 50 results in
4432a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4433A value of either 0 or 200 results in a complete 180 degree rotation of the
4434image. Using a value of 300 is a 360 degree rotation resulting in no change to
4435the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004436
cristyb36feb22010-03-26 16:54:37 +00004437<p>For example, to increase the color brightness by 20% and decrease the color
4438saturation by 10% and leave the hue unchanged, use <a
4439href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004440
cristyb36feb22010-03-26 16:54:37 +00004441<p>Use <a href="#set">-set</a> attribute of '<kbd
4442class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4443modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4444<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004445
4446<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 +00004447
cristy3ed852e2009-09-05 21:47:34 +00004448<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004449 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004450</div>
4451
4452<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>
4453
4454
4455<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004456 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004457</div>
4458
4459<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>
4460
4461
4462<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004463 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004464</div>
4465
4466<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>
4467
4468<p>Both the image pixels and size are linearly interpolated to give the
4469appearance of a meta-morphosis from one image to the next, over all the images
4470in the current image list. The added images are the equivalent of a <a
4471href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4472argument determine how many images to interpolate between each image. </p>
4473
4474
4475<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004476 <h4><a id="morphology"></a>-morphology</h4>
4477 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004478</div>
4479
cristy2c839602010-04-03 02:32:08 +00004480<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 +00004481
cristydcca3fa2010-12-29 21:50:07 +00004482<p>Until I get around to writing a option summary for this, see <a
4483href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4484Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004485
4486
cristy488844c2010-01-22 14:02:05 +00004487<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004488 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004489</div>
4490
4491<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>
4492
4493
4494<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004495 <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 +00004496</div>
4497
4498<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>
4499
4500<p>Blur with the given radius, standard deviation (sigma), and angle. The
4501angle given is the angle toward which the image is blurred. That is the
4502direction people would consider the object is coming from. </p>
4503
4504<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004505definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004506
4507<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4508pixels which are outside the image proper are blurred into the final result.
4509</p>
4510
4511<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004512 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004513</div>
4514
4515<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>
4516<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004517 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004518</div>
4519
cristyb29bc032010-02-01 20:29:43 +00004520<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 +00004521
4522<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>
4523
4524<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004525 <h4><a id="noise"></a>-noise <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004526 +noise <em class="arg">type</em></h4>
4527</div>
4528
4529<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>
4530
4531<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>
4532
4533<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>
4534
4535<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>
4536
4537<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004538 Gaussian
4539 Impulse
4540 Laplacian
4541 Multiplicative
4542 Poisson
4543 Random
4544 Uniform
cristy3ed852e2009-09-05 21:47:34 +00004545</pre>
4546
4547<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4548
cristy83543962009-10-16 19:04:28 +00004549<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4550the use of a controlling value to specify teh amount of noise that should be
4551added to an image. </p>
4552
cristy3ed852e2009-09-05 21:47:34 +00004553
4554<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004555 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004556</div>
4557
4558<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>
4559
cristyd934d102009-10-10 12:55:13 +00004560<p>The intensity values are stretched to cover the entire range of possible
4561values. While doing so, black-out at most <em>2%</em> of the pixels and
4562white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004563
cristyd934d102009-10-10 12:55:13 +00004564<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4565is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4566(Before this version, it was equivalent to <a href="#contrast-stretch"
4567>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004568
cristyd934d102009-10-10 12:55:13 +00004569<p>All the channels are normalized in concert by the came amount so as to
4570preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004571setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004572setting will normalize the RGB channels independently.</p>
4573
cristydcca3fa2010-12-29 21:50:07 +00004574<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004575Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004576that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004577
4578<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004579
4580
4581<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004582 <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 +00004583</div>
4584
cristyd934d102009-10-10 12:55:13 +00004585<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
4586class="arg">threshold map</em> specified, and a uniform color map with the
4587given 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 +00004588
4589<p>You can choose from these standard threshold maps:</p>
4590
4591<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004592 threshold 1x1 Threshold 1x1 (non-dither)
4593 checks 2x1 Checkerboard 2x1 (dither)
4594 o2x2 2x2 Ordered 2x2 (dispersed)
4595 o3x3 3x3 Ordered 3x3 (dispersed)
4596 o4x4 4x4 Ordered 4x4 (dispersed)
4597 o8x8 8x8 Ordered 8x8 (dispersed)
4598 h4x4a 4x1 Halftone 4x4 (angled)
4599 h6x6a 6x1 Halftone 6x6 (angled)
4600 h8x8a 8x1 Halftone 8x8 (angled)
4601 h4x4o Halftone 4x4 (orthogonal)
4602 h6x6o Halftone 6x6 (orthogonal)
4603 h8x8o Halftone 8x8 (orthogonal)
4604 h16x16o Halftone 16x16 (orthogonal)
4605 c5x5b c5x5 Circles 5x5 (black)
4606 c5x5w Circles 5x5 (white)
4607 c6x6b c6x6 Circles 6x6 (black)
4608 c6x6w Circles 6x6 (white)
4609 c7x7b c7x7 Circles 7x7 (black)
4610 c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004611</pre>
4612
cristy945bb352011-04-01 15:39:28 +00004613<p> The <kbd>threshold</kbd> generated a simple 50% threshold of the image.
cristybaacd172011-04-30 23:11:03 +00004614This could be used with <em class="arg" >level</em> to do the equivalent of <a
cristy945bb352011-04-01 15:39:28 +00004615href="#posterize" >-posterize</a> to reduce an image to basic primary colors.
4616</p>
cristy3ed852e2009-09-05 21:47:34 +00004617
cristy945bb352011-04-01 15:39:28 +00004618<p>The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
4619pattern. That is a grayscale will become a pattern of solid black, solid
4620white, and mid-tone colors into a checkerboard pattern of black and white.
4621</p>
cristy3ed852e2009-09-05 21:47:34 +00004622
cristy945bb352011-04-01 15:39:28 +00004623<p>You can define your own <em class="arg" >threshold map</em> for ordered
4624dithering and halftoning your images, in either personal or system
4625<kbd>thresholds.xml</kbd> XML file. See <a href="resources.html" >Resources</A>
4626for more details of configuration files. </p>
cristy3ed852e2009-09-05 21:47:34 +00004627
cristy945bb352011-04-01 15:39:28 +00004628<p>To print a complete list of the thresholds that have been defined, use the
4629<a href="#list" >-list threshold</a> option.</p>
4630
4631<p>Note that at this time the same threshold dithering map is used for all
4632color channels, no attempt is made to offset or rotate the map for different
4633channels is made, to create an offset printing effect. Also as the maps are
4634simple threshold levels, the halftone and circle maps will create incomplete
4635circles along the edges of a colored area. Also all the effects are purely
4636on/off boolean effects, without anti-aliasing to make the circles smooth
4637looking. Large dots can be made to look better with a small amount of blurring
4638after being created. </p>
cristy3ed852e2009-09-05 21:47:34 +00004639
4640
4641<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004642 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004643</div>
4644
4645<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>
4646
cristyc54f5d42009-11-27 21:36:31 +00004647<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004648described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4649>-fuzz</a> setting can be used to match and replace colors similar to the one
4650given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004651
cristyb36feb22010-03-26 16:54:37 +00004652<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4653the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004654
cristyb36feb22010-03-26 16:54:37 +00004655<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4656as <a href="#opaque" >-opaque</a> but replaces the matching color with
4657transparency rather than the current <a href="#fill">-fill</a> color setting.
4658To ensure that it can do this it also ensures that the image has an alpha
4659channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4660the new transparent colors, and does not require you to modify the <a
4661href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004662
cristy3ed852e2009-09-05 21:47:34 +00004663
4664<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004665 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004666</div>
4667
4668<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>
4669
4670<p>Choose from these orientations:</p>
4671
4672<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004673 bottom-left
4674 bottom-right
4675 left-bottom
4676 left-top
4677 right-bottom
4678 right-top
4679 top-left
4680 top-right
4681 undefined
cristy3ed852e2009-09-05 21:47:34 +00004682</pre>
4683
cristyd934d102009-10-10 12:55:13 +00004684<p>To print a complete list of orientations, use the <a href="#list" >-list
4685orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004686
4687
4688<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004689 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004690 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4691 +page
4692 </h4>
4693</div>
4694
4695<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>
4696
4697<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>
4698
4699<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>
4700
4701<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>
4702<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4703<thead>
4704 <tr valign="top">
4705 <th align="center"><em class="arg">media</em></th>
4706 <th align="center"><em class="arg">width</em></th>
4707 <th align="center"><em class="arg">height</em></th>
4708 </tr>
4709</thead>
4710<tbody>
4711<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4712<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4713<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4714<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4715<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4716<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4717<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4718<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4719<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4720<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4721<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4722<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4723<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4724<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4725<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4726<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4727<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4728<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4729<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4730<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4731<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4732<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4733<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4734<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4735<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4736<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4737<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4738<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4739<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4740<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4741<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4742<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4743<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4744<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4745<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4746<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4747<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4748<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4749</tbody>
4750</table>
4751
4752
4753
4754
4755<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>
4756
4757<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>
4758
4759<p>The default page dimensions for a TEXT image is 612x792.</p>
4760
4761<p>This option is used in concert with <a href="#density">-density</a>.</p>
4762
4763<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4764
4765<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004766 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004767</div>
4768
4769<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate an oil painting.</td><td style='text-align:right;'></td></tr></table>
4770
4771<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>
4772
4773<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004774 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004775
4776<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>
4777
4778<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004779 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004780</div>
4781
4782<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>
4783
4784<p>Pause for the specified number of seconds before repeating the animation.</p>
4785
4786<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004787 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004788</div>
4789
4790<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>
4791
4792<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4793
4794<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004795 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004796</div>
4797
4798<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>
4799
4800<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004801 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004802</div>
4803
4804<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>
4805
4806<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004807 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004808</div>
4809
4810<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>
4811
4812<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4813
4814<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004815 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004816</div>
4817
4818<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>
4819
4820<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004821 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004822</div>
4823
4824<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>
4825
4826<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004827 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004828</div>
4829
4830<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>
4831
4832<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>
4833
4834<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004835 Rotate Shear Roll Hue
4836 Saturation Brightness Gamma Spiff
4837 Dull Grayscale Quantize Despeckle
4838 ReduceNoise Add Noise Sharpen Blur
4839 Threshold EdgeDetect Spread Shade
4840 Raise Segment Solarize Swirl
4841 Implode Wave OilPaint CharcoalDrawing
4842 JPEG
cristy3ed852e2009-09-05 21:47:34 +00004843</pre>
4844
4845<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4846
4847<p>The default preview is <kbd>JPEG</kbd>.</p>
4848
4849<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004850 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004851</div>
4852
4853<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>
4854
4855<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004856 <h4><a id="process"></a>-process <em class="arg">command</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004857</div>
4858
4859<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>
4860
4861<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>
4862
4863<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004864 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004865 +profile <em class="arg">profile_name</em></h4>
4866</div>
4867
4868<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>
4869
4870<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>
4871
4872<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>
4873
4874<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>
4875
4876<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>
4877
4878<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4879
4880<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4881<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>
4882
4883<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>
4884<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4885CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4886</p>
4887
4888<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004889 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004890</div>
4891
4892<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>
4893
cristy87a7f072011-07-01 00:08:52 +00004894<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and
4895highest compression) to 100 (best quality but least effective compression).
4896The default is to use the estimated quality of your input image if it can
4897be determined, otherwise 92. When the quality is greater than 90, then the
4898chroma channels are not downsampled.
4899Use the <a href="#sampling-factor">-sampling-factor</a> option to specify the
4900factors for chroma downsampling.</p>
cristy3ed852e2009-09-05 21:47:34 +00004901
4902<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>
4903
cristy851dbce2010-08-06 21:40:00 +00004904<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 +00004905
cristy87a7f072011-07-01 00:08:52 +00004906<p>For the MNG and PNG image formats, the quality value sets the zlib
4907compression level (quality / 10) and filter-type (quality % 10). The default
4908PNG "quality" is 75, which means compression level 7 with adaptive PNG
4909filtering, unless the image has a color map, in which case it means
4910compression level 7 with no PNG filtering.</p>
4911
4912<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 +00004913
cristya4dfb122011-07-07 19:01:57 +00004914<p>If filter-type is 4 or less, the specified PNG filter-type is used for
4915all scanlines:</p>
cristy3ed852e2009-09-05 21:47:34 +00004916
4917<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004918 0: none
4919 1: sub
4920 2: up
4921 3: average
4922 4: Paeth
cristy3ed852e2009-09-05 21:47:34 +00004923</pre>
4924
cristy87a7f072011-07-01 00:08:52 +00004925<p>If filter-type is 5, adaptive filtering is used when quality is greater
4926than 50 and the image does not have a color map, otherwise no filtering is
4927used.</p>
cristy3ed852e2009-09-05 21:47:34 +00004928
cristy87a7f072011-07-01 00:08:52 +00004929<p>If filter-type is 6, adaptive filtering
4930with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
cristy3ed852e2009-09-05 21:47:34 +00004931
cristy87a7f072011-07-01 00:08:52 +00004932<p>Only if the output is MNG, if filter-type is 7, the LOCO color
4933transformation (intrapixel differencing) and adaptive filtering
4934with <em class="arg">minimum-sum-of-absolute-values</em> are used.</p>
cristy3ed852e2009-09-05 21:47:34 +00004935
cristy87a7f072011-07-01 00:08:52 +00004936<p>If the filter-type is 8 the zlib Z_RLE compression strategy is used with
4937 no PNG filtering.</p>
cristy3ed852e2009-09-05 21:47:34 +00004938
cristy87a7f072011-07-01 00:08:52 +00004939<p>If the filter-type is 9 the zlib Z_RLE compression strategy is used with
4940 adaptive PNG filtering.</p>
4941
cristya4dfb122011-07-07 19:01:57 +00004942<p>The quality setting has no effect on the appearance or signature of PNG
4943and MNG images, since the compression is always lossless.</p>
4944
4945<p>Not all combinations of compression level, strategy, and PNG filter type
4946can be obtained using the -quality option. For more precise control,
4947you can use the PNG:compression-level=N, PNG:compression-strategy=N, and
4948PNG:compression-filter=N defines, respectively, instead.
4949See <a href="#define">-define</a>. Values from the defines take precedence
4950over values from the -quality option.</p>
cristy87a7f072011-07-01 00:08:52 +00004951
4952<p>For further information, see
4953the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
cristy3ed852e2009-09-05 21:47:34 +00004954
cristy3ed852e2009-09-05 21:47:34 +00004955<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004956 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004957</div>
4958
cristy3c98a4f2010-08-13 20:09:41 +00004959<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 +00004960
cristy3c98a4f2010-08-13 20:09:41 +00004961<p>This setting defines the colorspace used to sort out and reduce the number
4962of colors needed by an image (for later dithering) by operators such as <a
4963href="#colors" >-colors</a>, Note that color reducion also happens
4964automatically when saving images to color-limited image file formats, such as
4965GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004966
4967
4968<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004969 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004970</div>
4971
4972<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>
4973
4974<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004975 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004976</div>
4977
4978<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>
4979
4980<p>Note that this is actually a rotational blur rather than a radial and as
4981such actually mis-named. </p>
4982
4983<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4984pixels which are outside the image proper are blurred into the final result.
4985</p>
4986
4987
4988<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004989 <h4><a id="raise"></a>-raise <em class="arg">thickness</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%'>Lighten or darken image edges.</td><td style='text-align:right;'></td></tr></table>
4993
4994<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>.
4995</p>
4996
4997<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4998
4999<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005000 <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 +00005001</div>
5002
5003<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>
5004
5005<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005006 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005007</div>
5008
5009<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>
5010
5011<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005012 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00005013</div>
5014
5015<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Pay attention to warning messages.</td><td style='text-align:right;'></td></tr></table>
5016
5017<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005018 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005019</div>
5020
5021<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>
5022
5023<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
5024the given colors are dithered over the image as necessary, otherwise the closest
5025color (in RGB colorspace) is selected to replace that pixel in the image. </p>
5026
5027<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
5028images in the current image sequence, all the images will have the same color
5029table. That means that when saved to a file format such as GIF, it will use
5030that color table as a single common or global color table, for all the images,
5031without requiring extra local color tables. </p>
5032
5033<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
5034sequence to use a common color map over all the images. This equivalent to
5035appending all the images together (without extra background colors) and color
5036reducing those images using <a href="#colors">-colors</a> with a 256 color
5037limit, then <a href="#remap">-remap</a> those colors over the original list of
5038images. This ensures all the images follow a single color map. </p>
5039
5040<p>If the number of colors over all the images is less than 256, then <a
5041href="#remap">+remap</a> should not perform any color reduction or dithering, as
5042no color changes are needed. In that case, its only effect is to force the use
5043of a global color table. This recommended after using either <a
5044href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
5045reduce the number of colors in an animated image sequence. </p>
5046
5047<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005048 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005049</div>
5050
5051<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>
5052
5053<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>
5054
5055<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>
5056
5057<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005058 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00005059</div>
5060
5061<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>
5062
5063<p>The only command recognized is the name of an image file to load.</p>
5064
5065<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>
5066
5067<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005068 <h4><a id="render"></a>-render</h4>
cristy3ed852e2009-09-05 21:47:34 +00005069</div>
5070
5071<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>
5072
5073<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>
5074
5075<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005076<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005077</div>
5078
5079<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Adjust the canvas and offset information of the image.</td><td style='text-align:right;'></td></tr></table>
5080
5081<p>This option is like <a href="#page">-page</a> but acts as an image operator
5082rather than a setting. You can separately set the canvas size or the offset
5083of the image on that canvas by only providing those components. </p>
5084
5085<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>
5086
5087<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
5088offset to move the image relative to its previous position. This useful for
5089animation sequences. </p>
5090
5091<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
5092recalculate the canvas size so the image (at its current offset) will appear
5093completely on that canvas (unless it has a negative offset).</p>
5094
5095<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
5096canvas meta-data from the images. </p>
5097
5098<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
5099directly assign virtual canvas meta-data. </p>
5100
5101
5102<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005103 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005104</div>
5105
5106<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>
5107
5108<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>
5109
5110<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>
5111
5112<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005113 <h4><a id="resize"></a>-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005114</div>
5115
5116<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Resize an image.</td><td style='text-align:right;'></td></tr></table>
5117
5118<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>
5119
5120<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>
5121
cristy13538962010-02-26 17:53:04 +00005122<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>
5123
cristy4949d522010-03-12 18:41:34 +00005124<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 +00005125<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005126 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00005127</div>
5128
5129<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>
5130
5131<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005132 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005133</div>
5134
5135<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>
5136
5137
5138<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005139 <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 +00005140</div>
5141
5142<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>
5143
5144<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>
5145
5146
5147<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005148 <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 +00005149</div>
5150
5151<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>
5152
5153<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>
5154
5155<p>Empty triangles in the corners, left over from rotating the image, are
5156filled with the <kbd>background</kbd> color. </p>
5157
5158<p>See also the <a href="#distort">-distort</a> operator and specifically the
5159'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5160
5161
5162<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005163 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005164</div>
5165
cristyd0bd44a2010-09-24 12:38:11 +00005166<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 +00005167
cristyd0bd44a2010-09-24 12:38:11 +00005168<p>Change the image size simply by directly sampling the pixels original
5169image. When magnifying, pixels are replicated in blocks. When minifying,
5170pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005171
cristyd0bd44a2010-09-24 12:38:11 +00005172<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5173a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5174neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5175avoids all the filter processing of the image. As such it completely ignores
5176the current <a href="#filter">-filter</a> setting. </p>
5177
5178<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5179will be added to the resulting image, though some colors may disappear. </p>
5180
5181<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
5182ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005183
5184
5185<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005186 <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 +00005187</div>
5188
5189<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>
5190
5191<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>
5192
5193<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005194 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005195</div>
5196
cristyd0bd44a2010-09-24 12:38:11 +00005197<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 +00005198
cristyd0bd44a2010-09-24 12:38:11 +00005199<p>Change the image size simply by replacing pixels by averaging pixels
5200together when minifying, or replacing pixels when magnifing. </p>
5201
5202<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5203a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5204faster, as it avoids all the filter processing of the image. As such it
5205completely ignores the current <a href="#filter">-filter</a> setting. </p>
5206
5207<p>If when shrinking (minifying) images the original image is some integer
5208multiple of the new image size, the number of pixels avergaed together to
5209produce the new pixel color is the same across the whole image. This is
5210a special case known as 'binning' and is often used as a method of reducing
5211noise in image such as those generated by digital cameras, especially in low
5212light conditions. </p>
5213
cristy3ed852e2009-09-05 21:47:34 +00005214
5215<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005216 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005217</div>
5218
5219<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>
5220
5221<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5222
5223<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005224 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005225</div>
5226
5227<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>
5228
5229<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>
5230
5231<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005232 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005233</div>
5234
5235<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>
5236
5237<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005238 <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 +00005239</div>
5240
5241<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>
5242
5243<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>
5244
5245<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>
5246
5247<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5248of the color clusters is returned.</p>
5249
5250
5251<div style="margin: auto;">
cristy8b9dd952011-03-21 22:56:18 +00005252 <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 +00005253</div>
5254
cristy3ed852e2009-09-05 21:47:34 +00005255<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>
5256
cristy2e2662a2010-10-09 14:29:37 +00005257<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>
5258
cristy3ed852e2009-09-05 21:47:34 +00005259<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005260 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005261</div>
5262
5263<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>
5264
5265<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005266 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005267</div>
5268
5269<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>
5270
5271<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5272
5273<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>
5274
cristyd0bda5e2010-09-21 16:22:45 +00005275
5276
cristy3ed852e2009-09-05 21:47:34 +00005277<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005278 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5279 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005280</div>
5281
cristyd0bd44a2010-09-24 12:38:11 +00005282<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 +00005283image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005284
cristyd0bd44a2010-09-24 12:38:11 +00005285<p>This will assign (or modify) specific settings attached to all the images
5286in the current image sequence. Using the <a href="#set">+set</a> form of the
5287option will either remove, or reset that setting to a default state, as
5288appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005289
cristyd0bd44a2010-09-24 12:38:11 +00005290<p>For example, it will modify specific well known image meta-data
5291'attributes' such as those normally overridden by: the options <a
5292href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5293href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5294assigned before the image is read in, by using a <em class="arg">key</em> of
5295the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005296
cristyd0bd44a2010-09-24 12:38:11 +00005297<p>If the given <em class="arg">key</em> does not match a specific known
5298'attribute ', such as shown above, the setting is stored as a a free form
cristy323f35b2011-03-24 23:05:13 +00005299'property' string. Such settings are listed in <a href="#verbose"
cristyd0bda5e2010-09-21 16:22:45 +00005300>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5301</p>
5302
cristy84134182011-06-15 22:59:00 +00005303<p>This includes string 'properties' that are set by and assigned to images
cristyd0bd44a2010-09-24 12:38:11 +00005304using the options <a href="#comment" >-comment</a>, <a href="#label"
5305>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5306a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5307Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005308
cristyd0bd44a2010-09-24 12:38:11 +00005309<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>
5310<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5311Properties</a> in the defined value. For example:</p>
5312
5313<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 +00005314<p>Other well known 'properties' that are availible include:
cristyd0bd44a2010-09-24 12:38:11 +00005315'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5316'<kbd>signature</kbd>'. </p>
5317
5318<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5319the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5320see <a href="#repage">-page</a>). However it is designed to provide a finer
5321control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5322option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5323attribute. </p>
5324
5325<p>This option can also associate a colorspace or profile with your image.
5326For example,</p>
5327
5328<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 +00005329<p>Some 'properties' must be defined in a specific way to be used. For
5330example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5331modify the output filename of an image. For example</p>
5332
5333<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>
5334<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5335be saved as a global "Artifact" exactly as if it was set using the <a
cristyf9a6c462011-04-24 14:01:11 +00005336href="#define" >-define</a> option. As such settings are global in scope, they
cristy84134182011-06-15 22:59:00 +00005337can be used to pass 'attributes' and 'properties' of one specific image,
cristyd0bd44a2010-09-24 12:38:11 +00005338in a way that allows you to use them in a completely different image, even if
5339the original image has long since been modified or destroyed. For example: </p>
5340
5341<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>
5342<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5343a 'artifact' if the given <em class="arg">key</em> does not match an existing
cristy323f35b2011-03-24 23:05:13 +00005344'attribute' or 'property'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005345
5346<p>You can set the attributes of the image registry by prefixing the value
5347with <kbd>registry:</kbd>.</p>
5348
cristy84134182011-06-15 22:59:00 +00005349<p>The <a href="#set">-set profile</a> option can also be used to inject
5350previously-formatted ancillary chunks into the output PNG file, using
5351the commandline option as shown below or by setting the profile via a
5352programming interface:</p>
5353
5354<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>
5355<p>where <em>x</em> is a location flag and
5356<em class="arg">filename</em> is a file containing the chunk
5357name in the first 4 bytes, then a colon (":"), followed by the chunk data.
5358This encoder will compute the chunk length and CRC, so those must not
5359be included in the file.</p>
5360
5361<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
5362or "e" (end, i.e., after IDAT). If you want to write multiple chunks
5363of the same type, then add a short unique string after the "x" to prevent
5364subsequent profiles from overwriting the preceding ones, e.g.,</p>
5365
5366
5367<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -set profile PNG-chunk-b01:file01 / <br/>
5368 -profile PNG-chunk-b02:file02 out.png</span></p>
5369<p>&nbsp;</p>
cristyd0bda5e2010-09-21 16:22:45 +00005370
cristy3ed852e2009-09-05 21:47:34 +00005371
5372<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005373 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005374</div>
5375
5376<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>
5377
5378<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>
5379
5380<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005381 <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 +00005382</div>
5383
5384<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>
5385
5386<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005387 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005388id="shared-memory"></a>-shared-memory</h4>
5389</div>
5390
5391<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>
5392
5393<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>
5394
5395<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005396 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005397</div>
5398
5399<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>
5400
5401<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5402
5403<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005404 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005405</div>
5406
5407<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>
5408
5409<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>
5410
5411<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>
5412
5413<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005414 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005415</div>
5416
5417<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>
5418
5419<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>
5420
5421<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>
5422
5423<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>
5424
5425<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>
5426
5427<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>
5428<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>
5429
5430<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5431<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005432 <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 +00005433</div>
5434
5435<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>
5436
5437<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>
5438
5439<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005440 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005441</div>
5442
5443<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>operate silently.</td><td style='text-align:right;'></td></tr></table>
5444
5445<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005446 <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 +00005447</div>
5448
5449<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>
5450
5451<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>
5452
5453<p>For Photo CD images, choose from these sizes:</p>
5454
5455<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005456 192x128
5457 384x256
5458 768x512
5459 1536x1024
5460 3072x2048
cristy3ed852e2009-09-05 21:47:34 +00005461</pre>
5462
cristy3ed852e2009-09-05 21:47:34 +00005463<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005464 <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 +00005465</div>
5466
5467<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>
5468
5469<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>
5470
5471<div style="margin: auto;">
cristy2d67ddd2011-02-13 15:38:23 +00005472 <h4><a id="smush"></a>-smush <em class="arg">offset</em></h4>
5473</div>
5474
5475<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>
5476
5477<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005478 <h4><a id="snaps"></a>-snaps <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005479</div>
5480
5481<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>
5482
5483<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5484
5485<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005486 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005487</div>
5488
5489<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>
5490
5491<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5492
5493<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5494
5495<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005496 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005497 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5498</div>
5499
5500<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>
5501
5502
5503<table class="doc">
5504 <tbody>
5505 <tr valign="top">
5506 <th align="left" style="width: 8%">Method</th>
5507 <th align="left">Description</th>
5508 </tr>
5509
5510 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005511 <td valign="top">barycentric</td>
5512 <td valign="top">three point triangle of color given 3 points.
5513 Giving only 2 points will form a linear gradient between those points.
5514 The gradient generated extends beyond the triangle created by those
5515 3 points. </td>
5516 </tr>
5517
5518 <tr valign="top">
5519 <td valign="top">bilinear</td>
5520 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5521 fall back to barycentric. </td>
5522 </tr>
5523 <tr valign="top">
cristy3ed852e2009-09-05 21:47:34 +00005524 <td valign="top">voronoi</td>
5525 <td valign="top">Simply map each pixel to the to nearest color point
5526 given. The result are polygonal 'cells' of solid color. </td>
5527 </tr>
5528
5529 <tr valign="top">
5530 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005531 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005532 squared. Generating spots of color in a sea of the average of
5533 colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005534 </tr>
5535
5536 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005537 <td valign="top">inverse</td>
5538 <td valign="top">Colors points biased on the ratio of inverse distance.
5539 This generates sharper points of color rather than rounded spots of
5540 '<kbd>shepards</kbd>' Generating spots of color in a sea of the
5541 average of colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005542 </tr>
5543
5544 </tbody>
5545</table>
5546
5547<p>The points are placed according to the images location on the virtual
5548canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5549offset), and do not actually have to exist on the given image, but may be
5550some point beyond the edge of the image. All points are floating point values.
5551</p>
5552
5553<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
cristyacc04882011-05-04 23:03:43 +00005554modified, which means that by default matte/alpha transparency channel is not
5555effected. Typically transparency channel is turned off either before or after
5556the operation. </P>
5557
5558Of course if some color points are transparent to generate a transparent
5559gradient, then the image also requires transparency enabled to store the
5560values. </p>
cristy3ed852e2009-09-05 21:47:34 +00005561
5562<p>All the above methods when given a single point of color will replace all
5563the colors in the image with the color given, regardless of the point. This is
5564logical, and provides an alternative technique to recolor a image to some
5565default value. </p>
5566
5567
5568<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005569 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005570</div>
5571
5572<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>
5573
cristyacc04882011-05-04 23:03:43 +00005574<p>This will add rows and columns of the current <a
5575href="#background">-background</a> color into the given image according to the
5576given <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
5577image into four quadrants, separating them by the inserted rows and columns.
5578</P>
5579
5580If a dimension of geometry is zero no rows or columns will be added for that
5581dimension. Similarly using a zero offset with the appropriate <a
5582href="#gravity">-gravity</a> setting will add rows and columns to the edges of
5583the image, padding the image only along that one edge. Edge padding is what <a
5584href="#splice">-splice</a> is most commonly used for. </p>
5585
5586<p>If the exact same <em class="arg">geometry</em> and <a
5587href="#gravity">-gravity</a> is later used with <a href="#chop">-chop</a> the
5588added added all splices removed. </p>
cristy3ed852e2009-09-05 21:47:34 +00005589
5590<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005591 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005592</div>
5593
5594<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>
5595
5596<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>
5597
5598<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00005599 <h4><a id="statistic"></a>-statistic <em class="arg">type</em> <em class="arg">geometry</em></h4>
cristyb52981c2011-03-19 17:09:31 +00005600</div>
5601
5602<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>
5603
5604<p>Choose from these statistic types:</p>
5605<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005606 Gradient maximum difference in area
5607 Maximum maximum value per channel in neighborhood
5608 Minimum minimum value per channel in neighborhood
5609 Mean average value per channel in neighborhood
5610 Median median value per channel in neighborhood
5611 Mode mode (most frequent) value per channel in neighborhood
5612 Nonpeak value just before or after the median value per channel in neighborhood
cristyb52981c2011-03-19 17:09:31 +00005613</pre>
5614
5615<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005616 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005617</div>
5618
5619<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>
5620
5621<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>
5622
5623<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005624 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005625</div>
5626
5627<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>
5628
5629<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>
5630
5631<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005632 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005633</div>
5634
5635<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>
5636
5637<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005638 char unsigned characters
5639 double doubles
5640 float floats
5641 integer integers
5642 long longs
5643 quantum pixels in the native depth of your ImageMagick distribution
5644 short unsigned shorts
cristy3ed852e2009-09-05 21:47:34 +00005645</pre>
5646
5647<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5648values range from 0 to the maximum value the storage type can support.</p>
5649
5650<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005651 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005652</div>
5653
5654<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>
5655
5656<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>
5657
5658<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005659 Any
5660 Condensed
5661 Expanded
5662 ExtraCondensed
5663 ExtraExpanded
5664 Normal
5665 SemiCondensed
5666 SemiExpanded
5667 UltraCondensed
5668 UltraExpanded
cristy3ed852e2009-09-05 21:47:34 +00005669</pre>
5670
5671<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5672
5673<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>
5674
5675<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005676 <h4><a id="strip"></a>-strip</h4>
cristy3ed852e2009-09-05 21:47:34 +00005677</div>
5678
5679<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>
5680
5681<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005682 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005683</div>
5684
5685<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>
5686
5687<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5688
5689<p>See <a href="#draw">-draw</a> for further details.</p>
5690
5691<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005692 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005693</div>
5694
5695<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set the stroke width.</td><td style='text-align:right;'></td></tr></table>
5696
5697<p>See <a href="#draw">-draw</a> for further details.</p>
5698
5699<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005700 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005701</div>
5702
5703<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>
5704
cristy71a3f602010-09-15 12:38:16 +00005705<p>This setting suggests a font style that ImageMagick should try to apply to
5706the currently selected font family. Select <em class="arg">fontStyle</em> from
5707the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005708
5709<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005710 Any
5711 Italic
5712 Normal
5713 Oblique
cristy3ed852e2009-09-05 21:47:34 +00005714</pre>
5715
5716<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>
5717
5718<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005719 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005720</div>
5721
cristyd4d64ed2010-08-22 22:19:33 +00005722<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>
5723
cristy71a3f602010-09-15 12:38:16 +00005724<p>This option is required to have compare search for the best match location
5725of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005726(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005727be the "match score" image.</p>
5728
cristyd0bd44a2010-09-24 12:38:11 +00005729<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005730position of the top-left corner of the given sub-image. that is its size will
5731be the size of the larger_image - sub_image + 1. The brightest location in
5732this image is the location s the locate on the best match that is also
5733reported. Note that this may or may nor be a perfect match, and the actual
5734brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005735possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005736
cristyd0bda5e2010-09-21 16:22:45 +00005737<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005738location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005739sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005740
cristyae6203d2010-08-09 01:12:14 +00005741
5742<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005743 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005744</div>
5745
5746<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>
5747
cristy71a3f602010-09-15 12:38:16 +00005748<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5749images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5750the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005751
5752<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005753 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005754</div>
5755
5756<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>
5757
5758<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5759
5760<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005761 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005762</div>
5763
5764<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>
5765
5766<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005767 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005768</div>
5769
cristy5063d812010-10-19 16:28:10 +00005770<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 +00005771
5772<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005773 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005774</div>
5775
5776<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>
5777
5778<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>
5779
5780<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>
5781
5782<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005783 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005784</div>
5785
5786<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>name of texture to tile onto the image background.</td><td style='text-align:right;'></td></tr></table>
5787
5788<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005789 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005790</div>
5791
5792<!-- {<em class="arg">green,blue,opacity</em>}
5793<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>
5794-->
5795
5796<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>
5797
5798<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>
5799
5800<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.
5801</p>
5802
5803<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>
5804
5805<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5806<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>
5807
5808
5809<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>
5810<p>Note that the values of the transparency channel is treated as 'matte'
5811values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5812
5813<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>.
5814</p>
5815
5816<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005817 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005818</div>
5819
5820<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>
5821
5822<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>
5823
5824<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>
5825
5826<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005827 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005828</div>
5829
5830<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>
5831
5832<div style="margin: auto;">
5833 <h4>-tile <em class="arg">geometry</em></h4>
5834</div>
5835
5836<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>
5837
5838<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>
5839
5840<div style="margin: auto;">
5841 <h4>-tile</h4>
5842</div>
5843
5844<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>
5845
5846<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005847 <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 +00005848</div>
5849
5850<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>
5851
5852<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>
5853
5854<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>
5855
5856<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005857 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005858</div>
5859
5860<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>
5861
5862<p>Tint the image with the fill color.</p>
5863
5864<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>
5865
5866<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005867 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005868</div>
5869
5870<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>
5871
5872<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>
5873
5874<p>For example,</p>
5875
5876<p class="crtsnip">
5877 -title "%m:%f %wx%h"
5878</p>
5879
5880<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>
5881
5882
5883<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005884 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005885</div>
5886
5887<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>transform the image.</td><td style='text-align:right;'></td></tr></table>
5888
5889<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5890
5891<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 +00005892
5893<p>This operator has been now been superseded by the <a
5894href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5895
5896
cristy3ed852e2009-09-05 21:47:34 +00005897<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005898 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005899</div>
5900
5901<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>
5902
5903<p>The <em class="arg">color</em> argument is defined using the format
5904described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5905>-fuzz</a> setting can be used to match and replace colors similar to the one
5906given. </p>
5907
cristyb36feb22010-03-26 16:54:37 +00005908<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5909that is make all non-matching colors transparent. </p>
5910
cristy3ed852e2009-09-05 21:47:34 +00005911<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005912href="#transparent" >-transparent</a> but replaces the matching color with the
5913current <a href="#fill">-fill</a> color setting, rather than transparent.
5914However the <a href="#transparent" >-transparent</a> operator also ensures
5915that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5916>-alpha</a> set</kbd>", and does not require you to modify the <a
5917href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005918
cristyb36feb22010-03-26 16:54:37 +00005919<p>Note that this does not define the color as being the 'transparency color'
5920used for color-mapped image formats, such as GIF. For that use <a
5921href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005922
5923
5924<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005925 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005926</div>
5927
5928<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>
5929
5930<p>Sometimes this is used for saving to image formats such as
5931GIF and PNG8 which uses this color to represent boolean transparency. This
5932does not make a color transparent, it only defines what color the transparent
5933color is in the color palette of the saved image. Use <a
5934href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5935
5936<p>This option allows you to have both an opaque visible color, as well as a
5937transparent color of the same color value without conflict. That is, you can
5938use the same color for both the transparent and opaque color areas within an
5939image. This, in turn, frees to you to select a transparent color that is
5940appropriate when an image is displayed by an application that does not handle a
5941transparent color index, while allowing ImageMagick to correctly handle images of this
5942type. </p>
5943
5944<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5945
5946<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005947 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005948</div>
5949
5950<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Mirror the image along the top-left to bottom-right diagonal.</td><td style='text-align:right;'></td></tr></table>
5951
5952<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5953</p>
5954
5955<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005956 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005957</div>
5958
5959<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>
5960
5961
5962<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005963 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005964</div>
5965
5966<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>
5967
5968<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>
5969
5970<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>
5971
5972<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>
5973
5974<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005975 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00005976</div>
5977
5978<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>
5979
5980<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>
5981
5982<p>The page or virtual canvas information of the image is preserved allowing
5983you to extract the result of the <a href="#trim">-trim</a> operation from the
5984image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5985information if it is unwanted.</p>
5986
5987<p>If the trimmed image 'disappears' an warning is produced, and a special
5988single pixel transparent 'missed' image is returned, in the same way as when a
5989<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5990
5991
5992<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005993 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005994</div>
5995
5996<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 +00005997 <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 +00005998
5999<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>
6000
6001<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
6002<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>
6003
6004<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
6005
6006<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006007 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</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%'>set the color of the annotation bounding box.</td><td style='text-align:right;'></td></tr></table>
6011
6012<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
6013
6014<p>See <a href="#draw">-draw</a> for further details.</p>
6015
6016
6017<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006018 <h4><a id="update"></a>-update <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006019</div>
6020
6021<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>
6022
6023<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>
6024
6025
6026<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006027 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00006028</div>
6029
6030<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>
6031
6032
6033<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006034 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006035</div>
6036
6037<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>
6038
6039<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>
6040
6041
6042<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006043 <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 +00006044</div>
6045
6046<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>
6047
6048<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>
6049
6050<p>The parameters are:</p>
6051
6052<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006053 radius The radius of the Gaussian, in pixels, not counting the center
6054 pixel (default 0).
6055 sigma The standard deviation of the Gaussian, in pixels (default 1.0).
6056 amount The fraction of the difference between the original and the blur
6057 image that is added back into the original (default 1.0).
6058 threshold The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
6059 difference amount (default 0.05).
cristy3ed852e2009-09-05 21:47:34 +00006060</pre>
6061
6062
6063<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006064 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00006065</div>
6066
cristyd0bda5e2010-09-21 16:22:45 +00006067<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 +00006068
6069
6070<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006071 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00006072</div>
6073
6074<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>
6075
6076
6077<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006078 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006079</div>
6080
6081<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>
6082
6083
6084<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006085 <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 +00006086</div>
6087
6088<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>
6089
6090
6091<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006092 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006093</div>
6094
6095<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>
6096
6097<p>This option defines what color source should be used if and when a color
6098lookup completely 'misses' the source image. The color(s) that appear to
6099surround the source image. Generally this color is derived from the source
6100image, but could also be set to a specify background color. </p>
6101
6102<p>Choose from these methods:</p>
6103
6104<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006105 background the area surrounding the image is the background color
6106 black the area surrounding the image is black
6107 checker-tile alternate squares with image and background color
6108 dither non-random 32x32 dithered pattern
6109 edge extend the edge pixel toward infinity
6110 gray the area surrounding the image is gray
6111 horizontal-tile horizontally tile the image, background color above/below
6112 horizontal-tile-edge horizontally tile the image and replicate the side edge pixels
6113 mirror mirror tile the image
6114 random choose a random pixel from the image
6115 tile tile the image (default)
6116 transparent the area surrounding the image is transparent blackness
6117 vertical-tile vertically tile the image, sides are background color
6118 vertical-tile-edge vertically tile the image and replicate the side edge pixels
6119 white the area surrounding the image is white
cristy3ed852e2009-09-05 21:47:34 +00006120</pre>
6121
6122<p>The default value is "edge".</p>
6123
6124<p>This most important for distortion operators such as <a href="#distort"
6125>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
6126However it also effects operations that may access pixels just outside the
6127image proper, such as <a href="#convolve">-convolve</a>, <a
6128href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
6129
6130<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
6131
6132
6133<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006134 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006135</div>
6136
6137<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>
6138
6139<p>Choose from these visual classes:</p>
6140
6141<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006142 StaticGray
6143 GrayScale
6144 StaticColor
6145 PseudoColor
6146 TrueColor
6147 DirectColor
6148 default
6149 visual id
cristy3ed852e2009-09-05 21:47:34 +00006150</pre>
6151
6152<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>
6153
6154
6155<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006156 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00006157 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
6158</div>
6159
6160<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
6161saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
6162
6163<p>Take a grayscale image (with alpha mask) and modify the destination image's
6164brightness according to watermark image's grayscale value and the <em
6165class="arg">brightness</em> percentage. The destinations color saturation
6166attribute is just direct modified by the <em class="arg">saturation</em>
6167percentage, which defaults to 100 percent (no color change). </p>
6168
6169
6170<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006171 <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 +00006172</div>
6173
6174<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>
6175
6176<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
6177
6178<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006179 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006180</div>
6181
6182<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set a font weight for text.</td><td style='text-align:right;'></td></tr></table>
6183
6184<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>
6185
6186<table class="doc">
6187 <col width="25%" />
6188 <col width="75%" />
6189 <thead>
6190 <tr>
6191 <th><em class="arg">fontWeight</em></th>
6192 <th>Description</th>
6193 </tr>
6194 </thead>
6195 <tbody>
6196 <tr><td>All </td> <td>No effect. </td></tr>
6197 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
6198 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
6199 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
6200 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
6201 </tbody>
6202 </table>
6203
6204<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
6205
6206<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>
6207
6208<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006209 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006210</div>
6211
6212<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>
6213
6214<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006215 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006216</div>
6217
cristy5cadd612009-09-21 19:33:41 +00006218<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>
6219
6220<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.
6221</p>
cristy3ed852e2009-09-05 21:47:34 +00006222
6223<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006224 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006225</div>
6226
6227<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>
6228
6229<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>
6230
6231<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>
6232
6233<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>
6234
6235<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006236 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006237</div>
6238
6239<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>
6240
6241<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006242 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006243</div>
6244
6245<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>
6246 <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>
6247
6248<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006249</div>
6250</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006251
6252</div>
6253
6254<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006255 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006256 <span id="linkbar-center">
6257 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006258 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006259 </span>
6260 <span id="linkbar-east">&nbsp;</span>
6261 </div>
6262 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +00006263 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006264 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6265 </div>
6266 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006267 <script type="text/javascript">
6268 var _gaq = _gaq || [];
6269 _gaq.push(['_setAccount', 'UA-17690367-1']);
6270 _gaq.push(['_trackPageview']);
6271
6272 (function() {
6273 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6274 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6275 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6276 })();
6277 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006278</body>
6279</html>