blob: 6c6b84559610569c43b696be513cbd82693bd5e6 [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"/>
34 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +000035 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000036 <style type="text/css" media="all">
37 @import url("../www/magick.css");
38 </style>
cristydcca3fa2010-12-29 21:50:07 +000039 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000040 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
41 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
42 <script type="text/javascript">
43 $(document).ready(function() {
44 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
45 'transitionIn' : 'elastic',
46 'transitionOut' : 'elastic',
47 'overlayShow' : false,
48 'opacity' : true
49 });
50 });
51 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000052</head>
53
54<body id="www-imagemagick-org">
55<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +000056<div style="margin: 17px auto; float: left;">
57 <script type="text/javascript">
58 <!--
59 google_ad_client = "pub-3129977114552745";
60 google_ad_slot = "5439289906";
61 google_ad_width = 728;
62 google_ad_height = 90;
63 //-->
64 </script>
65 <script type="text/javascript"
66 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
67 </script>
68</div>
cristy3eaa0ef2010-03-06 20:35:26 +000069<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000070 <img src="../images/logo.jpg"
71 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000072 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000073<a href="../index.html">
cristyaf8d6652011-02-04 21:57:45 +000074 <img src="../images/sprite.jpg"
75 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000076 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
77</div>
78
cristyce69bb02010-07-27 19:49:46 +000079<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000080
cristy3ed852e2009-09-05 21:47:34 +000081<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000082 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000083</div>
cristy3eaa0ef2010-03-06 20:35:26 +000084<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000085<div class="menu">
cristybb503372010-05-27 20:51:26 +000086 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
87</div>
88<div class="sub">
89 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
90</div>
91<div class="sub">
92 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
93</div>
94<div class="sub">
cristye6e84152011-06-06 14:16:49 +000095 <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +000096</div>
97<div class="sub">
cristybb503372010-05-27 20:51:26 +000098 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
99</div>
100<div class="sep"></div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
107<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000108 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
110<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
113<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000114 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000115</div>
116<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000117 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000118</div>
119<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000120 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000121</div>
122<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000124</div>
125<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000126 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000127</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000128<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000129<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000131</div>
132<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000133 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000134</div>
135<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000136 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000137 </div>
138<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000140</div>
cristybb503372010-05-27 20:51:26 +0000141<div class="menu">
142 <a title="Architecture" href="../www/architecture.html">Architecture</a>
143</div>
cristy3ed852e2009-09-05 21:47:34 +0000144<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000145 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000148<div class="menu">
cristy52923442011-01-15 22:54:31 +0000149 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000150</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000151<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000152<div class="menu">
cristydcca3fa2010-12-29 21:50:07 +0000153 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000154</div>
155<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000156 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000157</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000158<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000159<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000160 <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000161
cristyb52981c2011-03-19 17:09:31 +0000162<a href="http://www.networkredux.com">
163 <img src="../images/networkredux.png" alt="[sponsor]"
164 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000165<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000166<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000167 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
168</div>
169<div class="sponsor">
170 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
171</div>
172<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000173 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
174</div>
175<div class="sponsor">
176 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
177</div>
178<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000179 <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 +0000180</div>
181<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000182 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000183</div>
184<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000185 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000186</div>
187<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000188 <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 +0000189</div>
190<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000191 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy7d52cd62010-10-01 17:26:59 +0000192</div>
193<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000194 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000195</div>
196<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000197 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
cristy851dbce2010-08-06 21:40:00 +0000198</div>
cristyec6b4752011-01-08 03:16:23 +0000199<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000200 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000201</div>
202<div class="sponsor">
cristy2dcd6822011-06-13 16:21:20 +0000203 <a rel="follow" title="Sponsor: Autoteile Online Shop" href="http://www.autoteile-carparts.de">Autoteile Online Shop</a><!-- 2011080100030 autoteile-Carparts-->
cristyec6b4752011-01-08 03:16:23 +0000204</div>
cristy3ed852e2009-09-05 21:47:34 +0000205</div>
206</div>
cristyce69bb02010-07-27 19:49:46 +0000207</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000208
cristyce69bb02010-07-27 19:49:46 +0000209<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000210
cristy3eaa0ef2010-03-06 20:35:26 +0000211</div>
212
213<div class="main">
214
cristydcca3fa2010-12-29 21:50:07 +0000215<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000216<p class="navigation-index">
cristy8b9dd952011-03-21 22:56:18 +0000217[ <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 +0000218
cristydcca3fa2010-12-29 21:50:07 +0000219<div class="doc-section">
220
cristyb36feb22010-03-26 16:54:37 +0000221<p>Below is list of command-line options recognized by the ImageMagick <a
222href="../www/command-line-tools.html">command-line
223tools</a>. If you want a description of a particular option, click on the
224option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000225otherwise 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 +0000226
227<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000228 <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 +0000229</div>
230
231<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 +0000232<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>
233
234<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000235 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000236</div>
237
238<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Resize the image using data-dependent triangulation.</td><td style='text-align:right;'></td></tr></table>
239
240<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>
241
242<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000243 <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 +0000244</div>
245
246<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>
247
248<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>
249
250<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000251 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000252</div>
253
254<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>
255
cristy30092792011-02-22 02:06:14 +0000256<p>This option is enabled by default. An attempt is made to save all images of
257an image sequence into the given output file. However, some formats, such as
258JPEG and PNG, do not support more than one image per file, and in that case
259ImageMagick is forced to write each image as a separate file. As such, if
260more than one image needs to be written, the filename given is modified by
261adding a <a href="#scene">-scene</a> number before the suffix, in order to
262make distinct names for each image. </p>
cristy3ed852e2009-09-05 21:47:34 +0000263
cristy30092792011-02-22 02:06:14 +0000264<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written to
265separate files, whether or not the file format allows multiple images per file
266(for example, GIF, MIFF, and TIFF). </p>
cristy3ed852e2009-09-05 21:47:34 +0000267
cristy30092792011-02-22 02:06:14 +0000268<p>Including a C-style integer format string in the output filename will
269automagically enable <a href="#adjoin">+adjoin</a> and are used to specify
270where the <a href="#scene">-scene</a> number is placed in the filenames. These
271strings, such as '<kbd>%d</kbd>' or '<kbd>%03d</kbd>', are familiar to those
272who have used the standard <kbd>printf()</kbd>' C-library function. As an
273example, the command</p>
cristy3ed852e2009-09-05 21:47:34 +0000274
275<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 +0000276<p>will create a sequence of 17 images (the two given plus 15 more created by
277<a href="#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
278my02morph.jpg, ..., my16morph.jpg. </p>
cristy3ed852e2009-09-05 21:47:34 +0000279
cristy30092792011-02-22 02:06:14 +0000280<p>In summary, ImageMagick tries to write all images to one file, but will
281save to multiple files, if any of the following conditions exist...
282<ol>
283<li>the output image's file format does not allow multi-image files,
284<li>the <a href="#adjoin">+adjoin</a> option is given, or
285<li>a printf() integer format string (eg: "%d") is present in the output
286 filename.
287</ol></p>
cristy3ed852e2009-09-05 21:47:34 +0000288
289
290<div style="margin: auto;">
cristy30092792011-02-22 02:06:14 +0000291 <h4><a id="affine"></a>-affine
292 <em class="arg">s<sub>x</sub></em>,<em class="arg">r<sub>x</sub></em>,<em
293 class="arg">r<sub>y</sub></em>,<em class="arg">s<sub>y</sub></em>[,<em
cristye9a32c32011-04-07 01:11:05 +0000294 class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000295</div>
296
297<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>
298
cristy30092792011-02-22 02:06:14 +0000299<p>This option sets a transformation matrix, for use by subsequent <a
300href="#draw">-draw</a> or <a href="#transform">-transform</a> options. </p>
cristy3ed852e2009-09-05 21:47:34 +0000301
cristy30092792011-02-22 02:06:14 +0000302<p>The matrix entries are entered as comma-separated numeric values either in
303quotes or without spaces. </p>
cristy3ed852e2009-09-05 21:47:34 +0000304
cristy30092792011-02-22 02:06:14 +0000305<p>Internally, the transformation matrix has 3x3 elements, but three of them
306are omitted from the input because they are constant. The new (transformed)
307coordinates (<em class="arg">x'</em>, <em class="arg">y'</em>) of a pixel at
308position (<em class="arg">x</em>, <em class="arg">y</em>) in the original
309image are calculated using the following matrix equation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000310
311<div class="eqn">
312<img alt="affine transformation" src="../images/affine.png"/>
313</div>
314
cristy30092792011-02-22 02:06:14 +0000315<p> The size of the resulting image is that of the smallest rectangle that
316contains the transformed source image. The parameters <em
317class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em>
318subsequently shift the image pixels so that those that are moved out of the
319image area are cut off.</p>
cristy3ed852e2009-09-05 21:47:34 +0000320
cristy30092792011-02-22 02:06:14 +0000321<p>The transformation matrix complies with the left-handed pixel coordinate
322system: positive <em class="arg">x</em> and <em class="arg">y</em> directions
323are rightward and downward, resp.; positive rotation is clockwise.</p>
cristy3ed852e2009-09-05 21:47:34 +0000324
cristy30092792011-02-22 02:06:14 +0000325<p> If the translation coefficients <em class="arg">t<sub>x</sub></em> and <em
326class="arg">t<sub>y</sub></em> are omotted they default to 0,0. Therefore,
327four parameters suffice for rotation and scaling without translation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000328
cristy30092792011-02-22 02:06:14 +0000329<p>Scaling by the factors <em class="arg">s<sub>x</sub></em> and <em
330class="arg">s<sub>y</sub></em> in the <em>x</em> and <em>y</em> directions,
331respectively, is accomplished with the following.</p>
332
333<p>See <a href="#transform">-transform</a>, and the <a
334href="#distort">-distort</a> method '<kbd>Affineprojection</kbd> for more
335information </p>
336
cristy3ed852e2009-09-05 21:47:34 +0000337
338<p class="crtsnip">
339 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
340</p>
341
342<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>
343
344<p class="crtsnip">
345 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
346</p>
347
348<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
349<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
350
351<p class="crtsnip">
352 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
353</p>
354
355<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>
356
357<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>
358
359<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000360 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000361</div>
362
363<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>
364
365<p>Used to set a flag on an image indicating whether or not to use existing alpha
366channel 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>
367
368
369<table class="doc">
370 <tbody>
371 <tr valign="top">
372 <th align="left" style="width: 8%">type</th>
373 <th align="left">Description</th>
374 </tr>
375
376 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000377 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000378 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000379 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
380 should be used instead of this, unless you specifically need to
381 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
382 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000383
384 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000385 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000386 <td valign="top">
387 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000388 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000389
390 <tr valign="top">
391 <td valign="top"><kbd>Set</kbd></td>
392 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000393 Activates the alpha/matte channel. If it was previously turned off
394 then it also resets the channel to opaque. If the image already had
395 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000396
397 <tr valign="top">
398 <td valign="top"><kbd>Opaque</kbd></td>
399 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000400 Enables the alpha/matte channel and forces it to be fully opaque.
401 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000402
403 <tr valign="top">
404 <td valign="top"><kbd>Transparent</kbd></td>
405 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000406 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000407 transparent. This effectively creates a fully transparent image the
408 same size as the original and with all its original RGB data still
409 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000410
411 <tr valign="top">
412 <td valign="top"><kbd>Extract</kbd></td>
413 <td valign="top">
414 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000415 '<kbd>Off</kbd>' the the image's transparency, so as to generate
416 a gray-scale mask of the image's shape. The alpha channel data is left
417 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
418 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000419
420 <tr valign="top">
421 <td valign="top"><kbd>Copy</kbd></td>
422 <td valign="top">
423 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000424 gray-scale intensity of the image, into the alpha channel, converting
425 a gray-scale mask into a transparent shaped mask ready to be colored
426 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000427
428 <tr valign="top">
429 <td valign="top"><kbd>Shape</kbd></td>
430 <td valign="top">
431 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000432 the current background color. That is the RGB color channels is
433 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000434 </td></tr>
435
436 <tr valign="top">
437 <td valign="top"><kbd>Background</kbd></td>
438 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000439 Set any fully-transparent pixel to the background color, while leaving
440 it fully-transparent. This can make some image file formats, such as
441 PNG, smaller as the RGB values of transparent pixels are more uniform,
442 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000443 </td></tr>
444 </tbody>
445</table>
446
447<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000448"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000449>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000450Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000451
452
453<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000454 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000455 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
456 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
457 -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>
458</div>
459
460<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>
461
462<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>
463
464
465<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>
466
467<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>
468
469<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>
470<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
471
472<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>
473
474<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>
475
476<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000477 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000478</div>
479
480<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
481drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
482
483<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
484drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
485antialiasing edge pixels. This will then reduce the number of colors added to
486an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000487are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000488
489<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000490 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000491</div>
492
493<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>
494
495<p>This option creates a single longer image image, by joining all the current
496images in sequence top-to-bottom. Use <a href="#append">+append</a> to
497stack images left-to-right. </p>
498
499<p>If they are not of the same width, narrower images are padded with the
500current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000501position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000502href="#gravity">-gravity</a> setting. </p>
503
504
505<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000506 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000507</div>
508
509<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>
510
511
512<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000513 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000514</div>
515
516<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Decrypt a PDF with a password.</td><td style='text-align:right;'></td></tr></table>
517
518<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>
519
520<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
521
cristyd934d102009-10-10 12:55:13 +0000522
523
cristy3ed852e2009-09-05 21:47:34 +0000524<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000525 <h4><a id="auto-gamma"></a>-auto-gamma</h4>
cristy3ed852e2009-09-05 21:47:34 +0000526</div>
527
528<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>
529
cristyd934d102009-10-10 12:55:13 +0000530<p>This calculates the mean values of an image, then applies a calculated <a
531href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
532image it will get a have a value of 50%. </p>
533
cristyd0bd44a2010-09-24 12:38:11 +0000534<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000535
536<p>This works well for real-life images with little or no extreme dark and
537light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000538dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000539</p>
540
541<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristy2dcd6822011-06-13 16:21:20 +0000542'<em>sync</em>' flag for channel synchronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000543values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000544>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000545together by the same gamma value, preserving colors. </p>
546
547
548
cristy3ed852e2009-09-05 21:47:34 +0000549<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000550 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000551</div>
552
553<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>
554
cristyd934d102009-10-10 12:55:13 +0000555<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000556minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000557href="#level" >-level</a> operator to stretch the values to the full range of
558values. </p>
559
cristy83543962009-10-16 19:04:28 +0000560<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000561JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
562for the <a href="#level" >-level</a> operation. On the other hand it is the
563right operator to use for color stretching gradient images being used to
564generate Color lookup tables, distortion maps, or other 'mathematically'
565defined images. </p>
566
567<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
568href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
569>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
570problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000571>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000572
573<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristy2dcd6822011-06-13 16:21:20 +0000574special '<em>sync</em>' flag for channel synchronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000575which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000576href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
577'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000578together by the same gamma value, preserving colors, and ignoring
579transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000580
581
cristy3ed852e2009-09-05 21:47:34 +0000582<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000583 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000584</div>
585
586<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>
587
cristy83543962009-10-16 19:04:28 +0000588<p>This operator reads and resets the EXIF image profile setting 'Orientation'
589and then performs the appropriate 90 degree rotation on the image to orient
590the image, for correct viewing. </p>
591
592<p>This EXIF profile setting is usually set using a gravity sensor in digital
593camara, however photos taken directly downward or upward may not have an
594appropriate value. Also images that have been orientation 'corrected' without
595reseting this setting, may be 'corrected' again resulting in a incorrect
596result. If the he EXIF profile was previously stripped, the <a
597href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
598
599
cristy3ed852e2009-09-05 21:47:34 +0000600<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000601 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000602</div>
603
604<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>
605
606<p>An error results if the images are not identically sized.</p>
607
cristy3ed852e2009-09-05 21:47:34 +0000608
609<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000610 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000611</div>
612
613<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>
614
615<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>
616
617<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000618 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000619</div>
620
621<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>
622
623<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>
624
625<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000626 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000627</div>
628
629<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>
630
cristye6378132009-10-26 20:05:17 +0000631<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 +0000632
cristye6378132009-10-26 20:05:17 +0000633<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>
634<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 +0000635
636<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000637 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000638</div>
639
640<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>
641
642<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>
643
644<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>
645
646<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
647negative results without clipping to the color value range
648(0..QuantumRange).</p>
649
650<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +0000651<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 +0000652</p>
653
654<div style="margin: auto;">
cristy37e0dfd2011-03-06 16:35:34 +0000655 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000656</div>
657
658<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>
659
660<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000661 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000662</div>
663
cristy5cadd612009-09-21 19:33:41 +0000664<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>
665
666<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.
667</p>
cristy3ed852e2009-09-05 21:47:34 +0000668
669
670<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000671 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000672</div>
673
cristy83a272e2010-05-07 20:40:35 +0000674<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 +0000675
676<p>Blend will average the images together ('plus') according to the
677percentages given and each pixels transparency. If only a single percentage
678value is given it sets the weight of the composite or 'source' image, while
679the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000680<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
681'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000682
683
684<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000685 <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 +0000686</div>
687
688<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>
689
690<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000691 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000692</div>
693
694<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</td><td style='text-align:right;'></td></tr></table>
695
696<div style="margin: auto;">
697
698<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000699 <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 +0000700</div>
701
702<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>
703
cristyb15553d2010-07-03 22:53:14 +0000704<p>Convolve the image with a Gaussian or normal distribution using the given
705<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000706
707<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
708</div>
709
cristyb15553d2010-07-03 22:53:14 +0000710<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000711determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000712
cristyb15553d2010-07-03 22:53:14 +0000713<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000714array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000715integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000716radius that will provide meaningful results for the Gaussian distribution.
717</p>
718
719<p>The larger the <em class="arg" >Radius</em> the radius the slower the
720operation is. However too small a <em class="arg" >Radius</em>, and sever
721aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
722should be at least twice the <em class="arg" >Sigma</em> value, though three
723times will produce a more accurite result. </p>
724
725<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
726by taking advantage of the separability properties of the distribution. Here
727we apply a single-dimensional Gaussian matrix in the horizontal direction,
728then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000729
730<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
731pixels which are outside the image proper are blurred into the final result.
732</p>
733
734
735<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000736 <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 +0000737</div>
738
739<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>
740
741<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
742Average (EWA) of the source image, scaled according to the grayscale
743mapping. </p>
744
745<p>The ellipse is weighted with sigma set to the given <em class="arg"
746>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
747defaults to the <em class="arg" >Width</em> for a normal circular Guassian
748weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
749horizontal clock-wise. </p>
750
751<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
752pixels which are outside the image proper are blurred into the final result.
753</p>
754
755
756<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000757 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000758</div>
759
760<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>
761
cristybc9539a2010-08-16 18:06:20 +0000762<p>Set the width and height using the <em class="arg">size</em> portion of the
763<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
764ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000765
cristybc9539a2010-08-16 18:06:20 +0000766<p>Set the border color by preceding with the <a
767href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000768
cristybc9539a2010-08-16 18:06:20 +0000769<p>The <a href="#border">-border</a> operation is affected by the current <a
770href="#compose">-compose</a> setting and assumes that this is using the default
771'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
772size colors by the current <a href="#bordercolor">-bordercolor</a> before
773overlaying the original image in the center of this net image. This means that
774with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000775be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000776<p>See also the <a href="#frame">-frame</a> option, which has more
777functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000778
779<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000780 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000781</div>
782
783<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>
784
785<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
786
787<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
788
789<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000790 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000791</div>
792
793<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>
794
795<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000796 <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 +0000797</div>
798
799<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>
800
cristyefb2bdb2010-11-20 19:35:22 +0000801<p>Brightness and Contrast values apply changes to the input image. They are
802not absolute settings. A brightness or contrast value of zero means no change.
803The range of values is -100 to +100 on each. Positive values increase the
804brightness or contrast and negative values decrease the brightness or contrast.
805To control only contrast, set the brightness=0. To control only brightness,
806set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000807
cristyefb2bdb2010-11-20 19:35:22 +0000808<p>You may also use <a href="#fill">-channel</a> to control which channels to
809apply the brightness and/or contrast change. The default is to apply the same
810transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000811
cristyefb2bdb2010-11-20 19:35:22 +0000812<p>Brightness and Contrast arguments are converted to offset and slope of a
813linear transform and applied
814using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000815
cristyefb2bdb2010-11-20 19:35:22 +0000816<p>The slope varies from 0 at contrast=-100 to almost vertical at
817contrast=+100. For brightness=0 and contrast=-100, the result are totally
818midgray. For brightness=0 and contrast=+100, the result will approach but
819not quite reach a threshold at midgray; that is the linear transformation
820is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000821
cristyefb2bdb2010-11-20 19:35:22 +0000822<p>Negative slopes, i.e. negating the image, are not possible with this
823function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000824
cristyefb2bdb2010-11-20 19:35:22 +0000825<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
826at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
827totally white. Similarly, when contrast=0 and brightness=-100, the result is
828totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000829
cristyefb2bdb2010-11-20 19:35:22 +0000830<p>As the range of values for the arguments are -100 to +100, adding the '%'
831symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000832
833<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000834 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000835</div>
836
837<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>
838
839<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000840 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000841</div>
842
843<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Assign a caption to an image.</td><td style='text-align:right;'></td></tr></table>
844
cristy71a3f602010-09-15 12:38:16 +0000845<p>This option sets the caption meta-data of an image read in after this
846option has been given. To modify a caption of images already in memory use
847"<kbd><a href="#set">-set</a> caption</kbd>". </p>
848
849<p>The caption can contain special format characters listed in the <a
850href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000851Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000852is finally assigned to the individual images. </p>
853
854<p>If the first character of <em class="arg">string</em> is <em
855class="arg">@</em>, the image caption is read from a file titled by the
856remaining characters in the string. Comments read in from a file are literal;
857no embedded formatting characters are recognized.</p>
858
859<p>Caption meta-data ais not visible on the image itself. To do that use the
860<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
861instead.</p>
862
863<p>For example,</p>
864
865<p class="crtsnip">
866 -caption "%m:%f %wx%h" bird.miff
867</p>
868
869<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
870that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
871480.</p>
872
873
cristy3ed852e2009-09-05 21:47:34 +0000874<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000875 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000876</div>
877
878<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>
879
880<p>Here is an example color correction collection:</p>
881
882<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000883&lt;?xml version="1.0" encoding="UTF-8"?&gt;
884&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
885 &lt;ColorCorrection id="cc06668"&gt;
886 &lt;SOPNode&gt;
887 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
888 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
889 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
890 &lt;/SOPNode&gt;
891 &lt;SATNode&gt;
892 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
893 &lt;/SATNode&gt;
894 &lt;/ColorCorrection&gt;
895&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000896</pre>
897
898<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000899 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000900</div>
901
902<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>
903
cristyefb2bdb2010-11-20 19:35:22 +0000904<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
905<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
906<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
907<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000908
cristy83a272e2010-05-07 20:40:35 +0000909<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000910abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
911'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
912'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000913
cristy83a272e2010-05-07 20:40:35 +0000914For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
915you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000916<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000917 -channel Red,Blue
918</p>
919<p>or you can use the short hand form</p>
920<p class="crtsnip">
921 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000922</p>
923
cristy2dcd6822011-06-13 16:21:20 +0000924<p>All the channels that are present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000925special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
926but generally any operators that are generally 'grey-scale' image operators,
927will understand this setting. See individual operator documentation. </p>
928
cristydcca3fa2010-12-29 21:50:07 +0000929<br />
cristy83a272e2010-05-07 20:40:35 +0000930
cristy2dcd6822011-06-13 16:21:20 +0000931<p>On top of the normal channel selection an extra flag can be specified,
cristy83a272e2010-05-07 20:40:35 +0000932'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000933operators that understand this flag should perform: cross-channel
cristy2dcd6822011-06-13 16:21:20 +0000934synchronization of the channels. If not specified, then most grey-scale
cristybac7a162010-06-15 19:57:29 +0000935operators will apply their image processing operations to each individual
936channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000937setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000938
939<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000940<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000941together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000942it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000943independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000944
cristydcca3fa2010-12-29 21:50:07 +0000945<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000946and the <a href="#compose">-compose</a> mathematical methods, also understands
947the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
948to the alpha channel (if present). That is to say it will modify the image
949processing with the understanding that fully-transparent colors should not
950contribute to the final result. </p>
951
cristy2dcd6822011-06-13 16:21:20 +0000952<p>Basically, by default, operators work with color channels in synchronous, and
cristybac7a162010-06-15 19:57:29 +0000953treats transparency as special, unless the <a href="#channel">-channel</a>
954setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
955How each operator does this depends on that operators current implementation.
956Not all operators understands this flag at this time, but that is changing.
957</p>
cristy83a272e2010-05-07 20:40:35 +0000958
959<p>To print a complete list of channel types, use <a href="#list">-list
960channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000961
cristydcca3fa2010-12-29 21:50:07 +0000962<br />
cristyd934d102009-10-10 12:55:13 +0000963
964<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000965'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
966channels except the transparency channel, and that all the color channels are
967to be modified in exactly the same way, with a understanding of transprancy
968(depending on the operation being applied). The 'plus' form <a
969href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000970
971<p>Options that are affected by the <a href="#channel" >-channel</a> setting
972include the following.
973
974<a href="#auto-gamma">-auto-gamma</a>,
975<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000976<a href="#black-threshold">-black-threshold</a>,
977<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000978<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000979<a href="#clut">-clut</a>,
980<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000981<a href="#composite">-composite</a> (Mathematical compose methods only),
982<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000983<a href="#contrast-stretch">-contrast-stretch</a>,
984<a href="#evaluate">-evaluate</a>,
985<a href="#function">-function</a>,
986<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000987<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000988<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000989<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000990<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000991<a href="#negate">-negate</a>,
992<a href="#normalize">-normalize</a>,
993<a href="#ordered-dither">-ordered-dither</a>,
994<a href="#radial-blur">-radial-blur</a>,
995<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000996<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000997<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000998<a href="#white-threshold">-white-threshold</a>.
999</p>
1000
cristyd0bda5e2010-09-21 16:22:45 +00001001<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +00001002>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +00001003href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +00001004default). These operators have yet to be made to understand the newer 'Sync'
1005flag. </p>
1006
cristybac7a162010-06-15 19:57:29 +00001007<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
1008the image before thresholding, if no <a href="#channel" >-channel</a> setting
1009has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +00001010
1011<p>Also some operators such as <a href="#blur">-blur</a>, <a
1012href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
1013color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
1014href="#channel" >-channel</a>. Generally this done to ensure that
1015fully-transparent colors are treated as being fully-transparent, and thus any
1016underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +00001017resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +00001018convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +00001019and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +00001020
cristybac7a162010-06-15 19:57:29 +00001021<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +00001022color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +00001023alpha channel present, and the <a href="#channel" >-channel</a> setting tells
1024the operator to apply the operation using alpha channels. The <a
1025href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +00001026
cristy3ed852e2009-09-05 21:47:34 +00001027
1028<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001029 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +00001030</div>
1031
1032<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>
1033
1034<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001035 <h4><a id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001036</div>
1037
1038<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>
1039
1040<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001041 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001042</div>
1043
1044<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Remove pixels from the interior of an image.</td><td style='text-align:right;'></td></tr></table>
1045
cristyefb2bdb2010-11-20 19:35:22 +00001046<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>
1047and <em class="arg">height</em> given in the of the <em class="arg">size</em>
1048portion of the <em class="arg">geometry</em> argument give the number of
1049columns and rows to remove. The <em class="arg">offset</em> portion of
1050the <em class="arg">geometry</em> argument is influenced by
1051a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +00001052
cristyefb2bdb2010-11-20 19:35:22 +00001053<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
1054and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00001055
cristyacc04882011-05-04 23:03:43 +00001056<p>While it can remove internal rows and columns of pixels, it is more
1057typically used with as <a href="#gravity">-gravity</a> setting and zero
1058offsets so as to remove a single edge from an image. Compare this to <a
1059href="#shave" >-shave</a> which removes equal numbers of pixels from oppisite
1060sides of the image. </p>
cristydcca3fa2010-12-29 21:50:07 +00001061
cristyacc04882011-05-04 23:03:43 +00001062<p>Using <a href="#chop">-chop</a> will effectivally undo the results of a <a
1063href="#splice">-splice</a> that was given the same <em
1064class="arg">geometry</em> and <a href="#gravity">-gravity</a> settings. </p>
cristydcca3fa2010-12-29 21:50:07 +00001065
1066
cristy3ed852e2009-09-05 21:47:34 +00001067<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001068 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001069</div>
1070
1071<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>
1072
1073<p>If a clipping path is present, it is applied to subsequent operations.</p>
1074
1075<p>For example, in the command</p>
1076
1077<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
1078<p>only the pixels within the clipping path are negated.</p>
1079
1080<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1081
1082<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001083 <h4><a id="clip-mask"></a>-clip-mask</h4>
cristy3ed852e2009-09-05 21:47:34 +00001084</div>
1085
1086<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>
1087
cristy30092792011-02-22 02:06:14 +00001088<p>Use the given image as a 'do-not-modify' mask of the current images in the
1089current image sequence. Assuming the clipmask is a greyscale image the same
1090size at the one already in memory, any areas that is white will not be
1091modified by any of the 'image processing operators' that follow, until the
1092mask is removed. Pixels in the black areas of the clip mask will be modified
1093as normal. </p>
1094
1095<p>In some ways this is similar to (though not the same) as defining
1096a rectangular <a href="#region" >-region</a>, or using the negative of the
1097mask (thrid) image in a three image <a href="#composite" >-composite</a>,
1098operation. </p>
1099
1100
cristy3ed852e2009-09-05 21:47:34 +00001101<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001102 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001103</div>
1104
1105<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>
1106
cristyd241f442011-03-29 13:50:49 +00001107<p>This is almost identical to <a href="#clip">-clip</a>. </p>
cristy30092792011-02-22 02:06:14 +00001108
1109
cristy3ed852e2009-09-05 21:47:34 +00001110<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001111 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001112</div>
1113
cristy8b9dd952011-03-21 22:56:18 +00001114<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 +00001115
cristydcca3fa2010-12-29 21:50:07 +00001116<p>Inside parenthesis (where the operator is normally used) it will make a
1117clone of the images from the last 'pushed' image sequence, and adds them to
1118the end of the current image sequence. Outside parenthesis
1119(not recommended) it clones the images from the current image sequence. </p>
1120
cristy3ed852e2009-09-05 21:47:34 +00001121<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000011220. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001123example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001124represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001125dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1126spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
cristy8b9dd952011-03-21 22:56:18 +00001127effectively clone all the images. </p>
cristydcca3fa2010-12-29 21:50:07 +00001128
1129<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
cristybaacd172011-04-30 23:11:03 +00001130in the image sequence, and is thus equivalent to using a argument of
cristydcca3fa2010-12-29 21:50:07 +00001131'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001132
1133<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001134 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001135</div>
1136
1137<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
1138corresponding channel in the second image as a <b>c</b>olor
1139<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1140
1141<p>The second (LUT) image is ordinarily a gradient image containing the
1142histogram mapping of how each channel should be modified. Typically it is a
1143either a single row or column image of replacement color values. If larger
1144than a single row or column, values are taken from a diagonal line from
1145top-left to bottom-right corners.</p>
1146
1147<p>The lookup is further controlled by the <a
1148href="#interpolate">-interpolate</a> setting, which is especially handy for an
1149LUT which is not the full length needed by the ImageMagick installed Quality
1150(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1151'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1152gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1153lookup of color values. </p>
1154
1155<p>This operator is especially suited to replacing a grayscale image with a
1156specific color gradient from the CLUT image. </p>
1157
1158<p>Only the channel values defined by the <a href="#channel">-channel</a>
1159setting will have their values replaced. In particular, since the default <a
1160href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1161transparency (alpha/matte channel) is not affected, unless the <a
1162href="#channel">-channel</a> setting is modified. When the alpha channel is
1163set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1164as the other channels, implying that alpha/matte values are replaced using the
1165alpha/matte values of the original image. </p>
1166
cristyd0bda5e2010-09-21 16:22:45 +00001167<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001168transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1169href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001170assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001171replacement alpha values. That is you can use a gray-scale CLUT image to
1172adjust a existing images alpha channel, or you can color a gray-scale image
1173using colors form CLUT containing the desired colors, including transparency.
1174</p>
1175
cristyefb2bdb2010-11-20 19:35:22 +00001176<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1177according to the lookup of the full color RGB value from a 2D representation
1178of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001179
1180
1181<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001182 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001183</div>
1184
1185<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>
1186
cristyefb2bdb2010-11-20 19:35:22 +00001187<p>Overlay each image in an image sequence according to
1188its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1189an animation at each point in the animation sequence. All images should be
1190the same size, and are assigned appropriate GIF disposal settings for the
1191animation to continue working as expected as a GIF animation. Such frames
1192are more easily viewed and processed than the highly optimized GIF overlay
1193images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001194
cristyefb2bdb2010-11-20 19:35:22 +00001195<p>The animation can be re-optimized after processing using
1196the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1197there is no guarantee that the restored GIF animation optimization is
1198better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001199
1200
1201<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001202 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001203</div>
1204
1205<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>
1206
cristyefb2bdb2010-11-20 19:35:22 +00001207<p>Specify the amount of colorization as a percentage. Separate colorization
1208values can be applied to the red, green, and blue channels of the image with
1209a comma-delimited list of colorization
1210values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001211
1212<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001213 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001214</div>
1215
1216<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>
1217
1218<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1219
cristyefb2bdb2010-11-20 19:35:22 +00001220<p>This option only applies when the default X server visual
1221is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1222to <a href="#visual">-visual</a> for more details. By default,
1223a shared colormap is allocated. The image shares colors with
1224other X clients. Some image colors could be approximated,
1225therefore your image may look very different than intended.
1226If <kbd>private</kbd> is chosen, the image colors appear exactly
1227as they are defined. However, other clients may go <em>technicolor</em>
1228when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001229
1230<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001231 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001232</div>
1233
1234<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>
1235
cristyefb2bdb2010-11-20 19:35:22 +00001236<p>The actual number of colors in the image may be less than your request,
1237but never more. Note that this a color reduction option. Images with fewer
1238unique colors than specified by <em class="arg">value</em> will have any
1239duplicate or unused colors removed. The ordering of an existing color
1240palette may be altered. When converting an image from color to grayscale,
1241it is more efficient to convert the image to the gray colorspace before
1242reducing the number of colors. Refer to
1243the <a href="../www/quantize.html">
1244color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001245
1246<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001247 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001248</div>
1249
1250<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>
1251
cristyefb2bdb2010-11-20 19:35:22 +00001252<p>This option permits saturation changes, hue rotation, luminance to alpha,
1253and various other effects. Although variable-sized transformation matrices
1254can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1255for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1256Adobe Flash except offsets are in column 6 rather than 5 (in support of
1257CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001258
1259<p>As an example, to add contrast to an image with offsets, try this command:</p>
1260
1261<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001262 convert kittens.jpg -color-matrix \
1263 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1264 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1265 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1266 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1267 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1268 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
cristy2c839602010-04-03 02:32:08 +00001269</pre>
1270<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001271 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001272</div>
1273
1274<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>
1275
1276<p>Choices are:</p>
1277
1278<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001279 CMY CMYK Gray HSB
1280 HSL HWB Lab Log
1281 OHTA Rec601Luma Rec601YCbCr Rec709Luma
1282 Rec709YCbCr RGB sRGB Transparent
1283 XYZ YCbCr YCC YIQ
1284 YPbPr YUV
cristy3ed852e2009-09-05 21:47:34 +00001285</pre>
1286
1287<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1288
1289<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>
1290
1291<table class="doc">
1292 <caption>Conversion Of RGB To Other Color Spaces</caption>
1293 <tr><th align="left" valign="middle">CMY</th></tr>
1294 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1295 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1296 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1297 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1298 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1299 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1300 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1301 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1302
1303 <tr><th align="left" valign="middle">Gray</th></tr>
1304 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1305
1306 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1307 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1308 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1309 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1310
1311 <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>
1312 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1313 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1314 <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>
1315
1316 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1317 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1318 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1319 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1320
1321 <tr><th align="left" valign="middle">LAB</th></tr>
1322 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1323 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1324 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1325
1326 <tr><th align="left" valign="middle">LOG</th></tr>
1327 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1328 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1329 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1330
1331 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1332 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1333 <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>
1334 <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>
1335
1336 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1337 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1338
1339 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1340 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1341 <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>
1342 <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>
1343
1344 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1345 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1346
1347 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1348 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1349 <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>
1350 <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>
1351
1352 <tr><th align="left" valign="middle">sRGB</th></tr>
cristyf9a6c462011-04-24 14:01:11 +00001353 <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>
1354 <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>
1355 <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 +00001356
1357 <tr><th align="left" valign="middle">XYZ</th></tr>
1358 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1359 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1360 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1361
1362 <tr><th align="left" valign="middle">YCC</th></tr>
1363 <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>
1364 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1365 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1366
1367 <tr><th align="left" valign="middle">YCbCr</th></tr>
1368 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1369 <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>
1370 <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>
1371
1372 <tr><th align="left" valign="middle">YIQ</th></tr>
1373 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1374 <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>
1375 <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>
1376
1377 <tr><th align="left" valign="middle">YPbPr</th></tr>
1378 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1379 <tr><td align="left" valign="middle">Pb=(&minus;0.168736*R&minus;0.331264*G+0.500000*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1380 <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>
1381
1382 <tr><th align="left" valign="middle">YUV</th></tr>
1383 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1384 <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>
1385 <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>
1386</table>
1387
1388<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001389 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001390</div>
1391
1392<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>
1393
1394<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>
1395
1396<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.
1397</p>
1398
cristy4949d522010-03-12 18:41:34 +00001399<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 +00001400<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001401 <h4><a id="comment"></a>-comment <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001402</div>
1403
1404<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>
1405
cristyd0bda5e2010-09-21 16:22:45 +00001406<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001407option has been given. To modify a comment of images already in memory use
1408"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001409
cristy71a3f602010-09-15 12:38:16 +00001410<p>The comment can contain special format characters listed in the <a
1411href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001412Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001413is finally assigned to the individual images. </p>
1414
1415<p>If the first character of <em class="arg">string</em> is <em
1416class="arg">@</em>, the image comment is read from a file titled by the
1417remaining characters in the string. Comments read in from a file are literal;
1418no embedded formatting characters are recognized.</p>
1419
1420<p>Comment meta-data are not visible on the image itself. To do that use the
1421<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1422instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001423
1424<p>For example,</p>
1425
1426<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001427 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001428</p>
1429
cristy71a3f602010-09-15 12:38:16 +00001430<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1431that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1432480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001433
1434<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001435 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001436</div>
1437
1438<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>
1439
cristybc9539a2010-08-16 18:06:20 +00001440<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1441a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001442
cristybc9539a2010-08-16 18:06:20 +00001443<p>This setting effects image processing operators that merge two (or more)
1444images together in some way. This includes the operators,
1445<a href="#composite">-composite</a>,
1446<a href="#layers">-layers</a> composite,
1447<a href="#flatten">-flatten</a>,
1448<a href="#mosaic">-mosaic</a>,
1449<a href="#layers">-layers</a> merge,
1450<a href="#border">-border</a>,
1451<a href="#frame">-frame</a>,
1452and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001453
cristybc9539a2010-08-16 18:06:20 +00001454<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1455command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001456
1457
1458<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001459 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001460</div>
1461
cristybc9539a2010-08-16 18:06:20 +00001462<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 +00001463
1464<p>Take the first image 'destination' and overlay the second 'source' image
1465according to the current <a href="#compose">-compose</a> setting. The location
1466of the 'source' or 'overlay' image is controlled according to <a
1467href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1468settings. </p>
1469
1470<p>If a third image is given this is treated as a gray-scale 'mask' image
1471relative to the first 'destination' image. This mask will limit what parts of
1472the destination can be modified by the image composition. However for the
1473'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1474Y-displacement image instead. </p>
1475
1476<p>If a <a href="#compose">-compose</a> method requires extra numerical
1477arguments or flags these can be provided by setting the <a
1478href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001479appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001480
1481<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1482image outside the overlay area. You can disable this by setting the special <a
1483href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1484to '<kbd>false</kbd>'. </p>
1485
1486
1487<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001488 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001489</div>
1490
1491<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>
1492
1493<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>
1494
1495<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1496
1497<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>
1498
1499<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>
1500
1501<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>
1502
1503<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>
1504
1505<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001506 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001507</div>
1508
1509<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>
1510
1511<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>
1512
1513<p>For a more pronounced effect you can repeat the option:</p>
1514
1515<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1516<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001517 <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 +00001518</div>
1519
1520<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>
1521
cristyd934d102009-10-10 12:55:13 +00001522<p>While performing the stretch, black-out at most <em
1523class="arg" >black-point</em> pixels and white-out at most <em
1524class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1525<em class="arg" >black-point %</em> pixels and white-out at most <em
1526class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001527
cristyd934d102009-10-10 12:55:13 +00001528<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1529>-contrast-stretch</a> will black-out at most <em class="arg"
1530>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1531minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1532class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1533>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001534
cristyd934d102009-10-10 12:55:13 +00001535<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1536the image's min and max values are stretched to 0 and <em class="QR"
1537>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1538clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001539>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001540prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001541
cristyd934d102009-10-10 12:55:13 +00001542<p>Internally operator works by creating a histogram bin, and then uses that
1543bin to modify the image. As such some colors may be merged together when they
1544originally fell into the same 'bin'. </p>
1545
1546<p>All the channels are normalized in concert by the came amount so as to
1547preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001548setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001549setting will normalize the RGB channels independently.</p>
1550
1551<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1552normalization of mathematical images. </p>
1553
1554<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001555
1556
1557<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001558 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001559</div>
1560
1561<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>
1562
cristy16ff93c2010-01-13 23:18:07 +00001563<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001564a comma-separated list of integers (with no spaces), ordered left-to right,
1565starting with the top row. Presently, only odd-dimensioned kernels are
1566supported, and therefore the number of entries in the specified <em
1567class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15687<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001569
cristyd934d102009-10-10 12:55:13 +00001570<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
1571positive and negative results are relative to a user-specified bias value.
1572This is important for non-HDRI compilations of ImageMagick when dealing with
1573convolutions that contain negative as well as positive values. This is
1574especially the case with convolutions involving high pass filters or edge
1575detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001576</p>
1577
cristyd934d102009-10-10 12:55:13 +00001578<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
1579negative results without clipping to the color value range (0..QuantumRange).
1580See the discussion on HDRI implementations of ImageMagick on the page <a
cristy47774982011-02-15 15:17:19 +00001581href="../www/high-dynamic-range.html">High
cristyd934d102009-10-10 12:55:13 +00001582Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1583href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1584<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1585entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001586
cristy3ed852e2009-09-05 21:47:34 +00001587
1588<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001589 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001590</div>
1591
1592<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>
1593
1594<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>
1595
1596<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>
1597
1598<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>
1599
1600<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>
1601
1602<p>By adding a exclamation character flag to the geometry argument, the
1603cropped images virtual canvas page size and offset is set as if the
1604geometry argument was a viewport or window. This means the canvas page size
1605is set to exactly the same size you specified, the image offset set
1606relative top left corner of the region cropped. </p>
1607
1608<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1609special single pixel transparent 'missed' image is returned, and a 'crop
1610missed' warning given. </p>
1611
cristy739df912009-10-24 16:10:18 +00001612<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 +00001613
1614<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001615 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001616</div>
1617
1618<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>
1619
1620<p><em class="arg">Amount</em> defines the number of positions each
1621colormap entry is shifted.</p>
1622
1623
1624<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001625 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001626</div>
1627
1628<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>
1629
1630<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>
1631
1632
1633<p>For example, to log cache and blob events, use.</p>
1634
1635<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1636<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1637
1638<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1639
1640<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1641
1642<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1643
1644<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>
1645
1646
1647<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001648 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001649</div>
1650
1651<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>
1652
1653<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1654
1655<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1656
1657
1658<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001659 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001660</div>
1661
1662<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>
1663
1664<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>
1665
1666<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>
1667
1668<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1669
1670
1671<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001672 <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 +00001673</div>
1674
cristyd0bd44a2010-09-24 12:38:11 +00001675<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 +00001676coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001677
cristyd0bda5e2010-09-21 16:22:45 +00001678<p>This option creates one or more definitions for coders and decoders to use
1679while reading and writing image data. Definitions are generally used to
1680control image file format coder modules, and image processing operations,
1681beyond what is provided by normal means. Defined settings are listed in <a
1682href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1683as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001684
cristyd0bda5e2010-09-21 16:22:45 +00001685<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1686definition of a flag is created with that name. This used to control on/off
1687options. Use <a href="#define">+define key</a> to remove definitions
1688previously created. Use <a href="#define">+define "*"</a> to remove all
1689existing definitions.</p>
1690
cristyd0bd44a2010-09-24 12:38:11 +00001691<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001692href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001693>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 +00001694Properties</a> in the defined value. </p>
1695
cristyefb2bdb2010-11-20 19:35:22 +00001696<p>The <em>option</em> and <em>key</em> are case-independent (they are
1697converted to lowercase for use within the decoders) while the <em>value</em>
1698is case-dependent.</p>
1699
cristyd0bda5e2010-09-21 16:22:45 +00001700<p>Such settings are global in scope, and effect all images and operations. </p>
1701
1702<p>The following definitions are just some of the artifacts that are
1703available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001704
cristydcca3fa2010-12-29 21:50:07 +00001705<dl>
cristy045bd902010-01-30 18:56:24 +00001706<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001707<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001708 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001709
cristy045bd902010-01-30 18:56:24 +00001710<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001711<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001712 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001713
cristy045bd902010-01-30 18:56:24 +00001714<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001715<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001716 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001717
cristy045bd902010-01-30 18:56:24 +00001718<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001719<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1720 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001721 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001722
cristy045bd902010-01-30 18:56:24 +00001723<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001724<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1725 compression factor is the reciprocal of the compression ratio. The valid
1726 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1727 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001728 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001729
cristy3ed852e2009-09-05 21:47:34 +00001730<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001731 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001732
cristy045bd902010-01-30 18:56:24 +00001733<dt>png:bit-depth=<em class="arg">value</em></dt>
1734<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001735<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1736 encoder to use a different bit-depth and color-type than it would have
1737 normally selected, but only if this does not cause any loss of image
1738 quality. Any attempt to reduce image quality is treated as an error and no
1739 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1740 can use these "defines" to cause it to be written as an 8-bit grayscale,
1741 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1742 you cannot force it to be written as a grayscale or indexed PNG. If you
1743 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1744 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1745 reduce the image quality prior to using the PNG encoder. Note that in
1746 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001747 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001748 8-bit depth.</dd>
1749
1750<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1751<dt>png:include-chunk=<em class="arg">value</em></dt>
1752<dd>ancillary chunks to be excluded from or included in PNG output.
1753
1754 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1755 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1756 or the word <em class="arg">all</em> or
1757 the word <em class="arg">none</em>. There must be no spaces in the
1758 list. Although PNG chunk-names are case-dependent, you can use
1759 all lowercase names if you prefer.</p>
1760
cristyd241f442011-03-29 13:50:49 +00001761 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
1762 of the PNG encoder and have no effect on the PNG decoder.</p>
1763
cristydcca3fa2010-12-29 21:50:07 +00001764 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1765 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1766 only be written if gamma is not 1/2.2, since most decoders assume
1767 sRGB and gamma=1/2.2 when no colorspace information is included in
1768 the PNG file. Because the list is processed from left to right, you
1769 can achieve this with a single define:</p>
1770
1771<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001772 -define png:include-chunk=none,gAMA
cristydcca3fa2010-12-29 21:50:07 +00001773</pre>
1774
1775 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
1776 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any of
1777 these entries appearing in the list will be ignored.</p>
1778
1779 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1780 image has transparency, the PNG colortype is forced to be 4 or 6
1781 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1782 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1783 on the PNG colortype of the output image.</p>
1784
1785 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1786 following for PNG output:</p>
1787
1788<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001789 -define png:include-chunk=none,gama
cristydcca3fa2010-12-29 21:50:07 +00001790</pre>
1791
1792 <p>The default behavior is to include all known PNG ancillary chunks
cristyf7964272011-01-30 03:49:12 +00001793 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk,
1794 and to exclude all PNG chunks that are unknown to ImageMagick,
1795 regardless of their PNG "copy-safe" status as described in the
1796 PNG specification.</p>
cristyd241f442011-03-29 13:50:49 +00001797
1798 <p>Any chunk names that are not known to ImageMagick are ignored
1799 if they appear in either the "include-chunk" or "exclude-chunk" list.
1800 The ancillary chunks currently known to ImageMagick are
1801 <kbd>bKGD</kbd>, <kbd>cHRM</kbd>, <kbd>gAMA</kbd>, <kbd>iCCP</kbd>,
1802 <kbd>oFFs</kbd>, <kbd>pHYs</kbd>, <kbd>sRGB</kbd>, <kbd>tEXt</kbd>,
1803 <kbd>tRNS</kbd>, <kbd>vpAg</kbd>, and <kbd>zTXt</kbd>.</p>
1804
cristyf9a6c462011-04-24 14:01:11 +00001805 <p>You can also put <kbd>date</kbd> in the list to include or exclude
1806 the "Date:create" and "Date:modify" text chunks that ImageMagick normally
1807 inserts in the output PNG.</p>
1808
1809</dd>
1810
1811<dt>png:preserve-colormap</dt>
1812 <dd>Use the existing image->colormap. Normally the PNG encoder will
1813 try to optimize the palette, eliminating unused entries and putting
1814 the transparent colors first. If this flag is set, that behavior
1815 is suppressed.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001816
cristy3ed852e2009-09-05 21:47:34 +00001817<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001818<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1819 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001820 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001821
cristy045bd902010-01-30 18:56:24 +00001822<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001823<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1824 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1825 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001826 included, the result is a single precision floating point format.
1827 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001828 double precision floating point format.</dd>
1829
cristydcca3fa2010-12-29 21:50:07 +00001830</dl>
cristy3ed852e2009-09-05 21:47:34 +00001831
cristyd0bda5e2010-09-21 16:22:45 +00001832<p>For example, to create a postscript file that will render only the black
1833pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001834
1835<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 +00001836<p>Set attributes of the image registry by prefixing the value with
1837<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1838use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001839
1840<p class="crtsnip">
1841-define registry:temporary-path=/data/tmp
1842</p>
1843
cristyd0bda5e2010-09-21 16:22:45 +00001844
1845
cristy3ed852e2009-09-05 21:47:34 +00001846<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001847 <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 +00001848</div>
1849
1850<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>
1851
1852<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>
1853
1854<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>
1855
1856
1857<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00001858 <h4><a id="delete"></a>-delete <em class="arg">indexes</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001859</div>
1860
1861<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>
1862
1863<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>
1864
1865
1866<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001867 <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 +00001868</div>
1869
1870<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>
1871
1872<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>
1873
1874<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>
1875
1876<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>
1877
1878<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>
1879
1880<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001881 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001882</div>
1883
1884<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>depth of the image.</td><td style='text-align:right;'></td></tr></table>
1885
1886<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>
1887
1888<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001889 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00001890</div>
1891
1892<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>
1893
1894<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001895 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001896</div>
1897
1898<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>straighten an image. A threshold of 40% works for most images.</td><td style='text-align:right;'></td></tr></table>
1899
1900<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>
1901
1902<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001903 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00001904</div>
1905
1906<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>
1907
1908<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001909 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001910</div>
1911
1912<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>
1913
1914<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001915 <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 +00001916</div>
1917
1918<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>
1919
1920<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001921is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001922what part of the 'background' image is seen at each point of the overlaid
1923area. Much like the displacement map is a 'lens' that redirects light shining
1924through it so as to present a distorted view the original 'background' image
1925behind it. </p>
1926
1927<p>Any perfect grey areas of the displacement map produce a zero
1928displacement of the image. Black areas produce the given maximum negative
1929displacement of the lookup point, while white produce a maximum positive
1930displacement of the lookup. </p>
1931
1932<p>Note that it is the lookup of the 'background' that is displaced, not a
1933displacement of the image itself. As such an area of the displacement map
1934containing 'white' will have the lookup point 'shifted' by a positive amount,
1935and thus generating a copy of the destination image to the right/downward from
1936the correct position. That is the image will look like it may have been
1937'shifted' in a negative left/upward direction. Understanding this is a very
1938important in understanding how displacement maps work. </p>
1939
1940<p>The given arguments define the maximum amount of displacement in pixels
1941that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001942it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001943outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001944easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001945into the overlay area. </p>
1946
1947<p>The '%' flag makes the displacement scale relative to the size of the
1948overlay image (100% = half width/height of image). Using '!' switches
1949percentage arguments to refer to the destination image size instead.
1950these flags were added as of IM v6.5.3-5.</p>
1951
1952<p>Normally a single grayscale displacement map is provided, which with the
1953given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001954displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001955specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001956the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001957displacement, while the <em class="arg">mask image</em> is used for vertical Y
1958displacement. This allows you to define completely different displacement
1959values for the X and Y directions, and allowing you to lookup any point within
1960the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001961any other nearby pixel, producing complex 2 dimensional displacements, rather
1962than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001963
cristyd0bda5e2010-09-21 16:22:45 +00001964<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001965you can use the 'red' channel of the overlay image to specify the horizontal
1966or X displacement, and the 'green' channel for the vertical or Y displacement.
1967</p>
1968
cristyd0bd44a2010-09-24 12:38:11 +00001969<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 +00001970mask the transparency of the destination image. However areas outside the
1971overlaid areas will not be effected. </p>
1972
1973
1974<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001975 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001976</div>
1977
1978<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>
1979
1980<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1981
1982<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001983 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001984</div>
1985
1986<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>
1987
1988<p>The layer disposal method defines the way each the displayed image is to be
1989modified after the current 'frame' of an animation has finished being
1990displayed (after its 'delay' period), but before the next frame on an
1991animation is to be overlaid onto the display. </p>
1992
1993<p>Here are the valid methods:</p>
1994
1995<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001996 Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
1997 None 1 Do not dispose, just overlay next frame image.
1998 Background 2 Clear the frame area with the background color.
1999 Previous 3 Clear to the image prior to this frames overlay.
cristy3ed852e2009-09-05 21:47:34 +00002000</pre>
2001
2002<p>You can also use the numbers given above, which is what the GIF format
2003uses internally to represent the above settings. </p>
2004
cristyd0bda5e2010-09-21 16:22:45 +00002005<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002006
2007<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
2008resetting the layer disposal methods of images being read in. </p>
2009
2010<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
2011disposal method for images already in memory.</p>
2012
2013<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002014 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002015</div>
2016
2017<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>
2018
2019
2020<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002021 <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 +00002022</div>
2023
2024<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>
2025
2026<p>The opacity of the composite image is multiplied by the given percent, then
2027it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00002028is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00002029transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
2030are given, each image are dissolved to the percentages given. </p>
2031
2032<p>Note that dissolve percentages do not add, two opaque images dissolved
2033'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2034images, you would need to use dissolve values of '50,100'. </p>
2035
2036<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002037 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002038</div>
2039
2040<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
2041
2042<p>The <em class="arg">arguments</em> is a single string containing a list
2043of floating point numbers separated by commas or spaces. The number of
2044and meaning of the floating point values depends on the distortion <em
2045class="arg">method</em> being used. </p>
2046
2047<p>Choose from these distortion types:</p>
2048
2049<table class="doc">
2050 <tr valign="top">
2051 <th align="left" style="width: 8%">Method</th>
2052 <th align="left">Description</th>
2053 </tr>
2054
2055 <tr valign="top">
2056 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
2057 <br/>or &nbsp; <kbd>SRT</kbd></td>
2058 <td valign="top">
2059 Distort image by first scaling and rotating about a given 'center',
2060 before translating that 'center' to the new location, in that order. It
2061 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
2062 distortion, but without shearing effects. It also provides a good way
2063 of rotating and displacing a smaller image for tiling onto a larger
2064 background (IE 2-dimensional animations). <br/>
2065
2066 The number of arguments determine the specific meaning of each
2067 argument for the scales, rotation, and translation operations. <br/>
2068
2069 <table style="margin-left:auto; margin-right:auto;">
2070 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
2071 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
2072 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00002073 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002074 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
2075 <tr><td>5:</td>
2076 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2077 <tr><td>6:</td>
2078 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
2079 <tr><td>7:</td>
2080 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
2081 &nbsp; NewX,NewY</em></td></tr>
2082 </table>
2083
cristyd0bda5e2010-09-21 16:22:45 +00002084 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00002085 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2086
2087 <tr valign="top">
2088 <td valign="top"><kbd>Affine</kbd></td>
2089 <td valign="top">
2090 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002091 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002092 point values are given allowing the image to be linearly scaled,
2093 rotated, sheared, and translated, according to those three points. See
2094 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2095 distortions. <br/>
2096
2097 More than 3 sets given control point pairs (12 numbers) is least
2098 squares fitted to best match a lineary affine distortion. If only 2
2099 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002100 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002101 flipping or changes in aspect ratio to the resulting image. If only one
2102 control point pair is provides the image is only translated, (which may
2103 be a floating point non-integer translation). <br/>
2104
2105 This distortion does not include any form of perspective distortion.
2106 </td>
2107
2108 </tr>
2109
2110 <tr valign="top">
2111 <td valign="top"><kbd>AffineProjection</kbd></td>
2112 <td valign="top">
2113 Linearly distort an image using the given Affine Matrix of 6
2114 pre-calculated coefficients forming a set of Affine Equations to map
2115 the source image to the destination image.
2116
2117 <div style="text-align: center"><em>
2118 s<sub>x</sub>, r<sub>x</sub>,
2119 r<sub>y</sub>, s<sub>y</sub>,
2120 t<sub>x</sub>, t<sub>y</sub>
2121 </em></div>
2122
2123 See <a href="#affine" >-affine</a> setting for more detail, and
2124 meanings of these coefficients. <br/>
2125
2126 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002127 alternative methods of defining this distortion, with ImageMagick doing
2128 the calculations needed to generate the required coefficients. You can
2129 see the internally generated coefficients, by using a <a
2130 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002131
2132 </tr>
2133
cristy3ed852e2009-09-05 21:47:34 +00002134 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002135 <td valign="top"><kbd>BilinearForward</kbd><br/>
2136 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002137 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002138 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2139 16 values (see below). Not that lines may not appear straight after
2140 distortion, though the distance between coordinates will remain
2141 consistent. <br/>
2142
2143 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2144 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2145 quadrilateral to a rectangle, while preserving the straigth line edges
2146 in each case. <br/>
2147
2148 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2149 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2150 color setting. Also if the quadraterial becomes 'flipped' the image
2151 may dissappear. <br/>
2152
2153 There are future plans to produce a true Bilinear distortion that will
2154 attempt to map any quadrilateral to any other quadrilateral, while
2155 preserving edges (and edge distance ratios).
2156
2157 </td>
cristy3ed852e2009-09-05 21:47:34 +00002158 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002159
2160 <tr valign="top">
2161 <td valign="top"><kbd>Perspective</kbd></td>
2162 <td valign="top">
2163 Perspective distort the images, using a list of 4 or more sets of
2164 control points (as defined below). More that 4 sets (16 numbers) of
2165 control points provide least squares fitting for more accurate
2166 distortions (for the purposes of image registration and panarama
2167 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2168 linear distortion. <br/>
2169
2170 Perspective Distorted images ensures that straight lines remain
2171 straight, but the scale of the distorted image will vary. The horizon
2172 is anti-aliased, and the 'sky' color may be set using the
2173 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2174 </tr>
2175
2176 <tr valign="top">
2177 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2178 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002179 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002180 pre-calculated coefficients. You can get these coefficients by looking
2181 at the <a href="#verbose" >-verbose</a> output of a
2182 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2183 If the last two perspective scaling coefficients are zero, the
2184 remaining 6 represents a transposed 'Affine Matrix'. </td>
2185
2186 </tr>
2187
2188 <tr valign="top">
2189 <td valign="top"><kbd>Arc</kbd></td>
2190 <td valign="top">
2191 Arc the image (variation of polar mapping) over the angle given around
2192 a circle. <br/>
2193 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2194 <tr valign="top"><td>Argument</td>
2195 <td>Meaning</td></tr>
2196 <tr valign="top"><td><em>arc_angle</em></td>
2197 <td>The angle over which to arc the image side-to-side</td></tr>
2198 <tr valign="top"><td><em>rotate_angle</em></td>
2199 <td>Angle to rotate resulting image from vertical center</td></tr>
2200 <tr valign="top"><td><em>top_radius</em></td>
2201 <td>Set top edge of source image at this radius</td></tr>
2202 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2203 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2204 </table>
2205
2206 The resulting image is always resized to best fit the resulting image,
2207 (as if using <a href="#distort" >+distort</a>) while attempting to
2208 preserve scale and aspect ratio of the original image as much as
2209 possible with the arguments given by the user. All four arguments will
2210 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2211
2212 This a variation of a polar distortion designed to try to preserve the
2213 aspect ratio of the image rather than direct Cartesian to Polar
2214 conversion. </td>
2215 </tr>
2216
2217 <tr valign="top">
2218 <td valign="top"><kbd>Polar</kbd></td>
2219 <td valign="top">
2220 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2221 the image. that is the height of the input image is mapped to the
2222 radius limits, while the width is wrapped around between the
2223 angle limits. <br/>
2224
2225 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2226
2227 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2228 center to the center of the image, and the angles going from -180 (top)
2229 to +180 (top). If <em>Rmax</em> is given the special value of
2230 '<code>0</code>', the the distance from the center to the nearest edge
2231 is used for the radius of the output image, which will ensure the whole
2232 image is visible (though scaled smaller). However a special value of
2233 '<code>-1</code>' will use the distance from the center to the furthest
2234 corner, This may 'clip' the corners from the input rectangular image,
2235 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2236 the same arguments. <br/>
2237
2238 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2239 output image center will default to <code>0,0</code> of the virtual
2240 canvas, and the image size adjusted to ensure the whole input image is
2241 made visible in the output image on the virtual canvas. </td>
2242
2243 </tr>
2244
2245 <tr valign="top">
2246 <td valign="top"><kbd>DePolar</kbd></td>
2247 <td valign="top">
2248 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2249 but generates the reverse Polar to Cartesian distortion. <br/>
2250
2251 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2252 the corners of the input image. However using the special
2253 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2254 distance) will ensure the whole distorted image is preserved in the
2255 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2256 reverse the distortion re-producing the original.
2257
2258 Note that as this distortion requires the area resampling of a circular
2259 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002260 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002261 form of 'super-sampling' image processing technique be used to produce
2262 a high quality result. </td>
2263
2264 </tr>
2265
2266 <tr valign="top">
2267 <td valign="top"><kbd>Barrel</kbd></td>
2268 <td valign="top">
2269 Given the four coefficients (A,B,C,D) as defined by <a
cristy6bcf48e2011-02-15 19:09:04 +00002270 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002271 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002272 correct radial lens distortions. That is in photographs, make straight
2273 lines straight again. <br/>
2274
2275 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2276 <em>X</em> , <em>Y</em> ] ] <br/>
2277 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2278 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2279 [ <em>X</em> , <em>Y</em> ] <br/>
2280 So that it forms the function <br/>
2281 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2282 <em>C</em>*r + <em>D</em> )<br/>
2283
2284 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2285 (defaulting to the center of the image). <br/>
2286 The second form is typically used to distort images, rather than
2287 correct lens distortions. <br/>
2288 </td>
2289
2290 </tr>
2291
2292 <tr valign="top">
2293 <td valign="top"><kbd>BarrelInverse</kbd></td>
2294 <td valign="top">
2295 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2296 arguments, and argument handling. However it uses the inverse
2297 of the radial polynomial,
2298 so that it forms the function <br/>
2299 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002300 <em>C</em>*r + <em>D</em> )<br/>
2301 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2302 distortion, just a different barrel-like radial distortion method.
2303
cristy3ed852e2009-09-05 21:47:34 +00002304 </td>
2305 </tr>
2306
2307 <tr valign="top">
2308 <td valign="top"><kbd>Shepards</kbd></td>
2309 <td valign="top">
2310 Distort the given list control points (any number) using an Inverse
2311 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002312 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2313 Method</a>). The control points in effect do 'localized' displacement
2314 of the image around the given control point (preserving the look and
2315 the rotation of the area near the control points. For best results
2316 extra control points should be added to 'lock' the positions of the
2317 corners, edges and other unchanging parts of the image, to prevent
2318 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002319
cristyd0bd44a2010-09-24 12:38:11 +00002320 The distortion has been likened to 'taffy pulling' using nails, or
2321 pins' stuck in a block of 'jelly' which is then moved to the new
2322 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002323
cristybaacd172011-04-30 23:11:03 +00002324 Internally it is equivalent to generating a displacement map (see <a
cristyd0bd44a2010-09-24 12:38:11 +00002325 href="#displace" >-displace</a>) for source image color look-up using
2326 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2327
2328 </td>
cristy3ed852e2009-09-05 21:47:34 +00002329 </tr>
2330
2331</table>
2332
cristyd0bd44a2010-09-24 12:38:11 +00002333<p>To print a complete list of distortion methods, use <a href="#list">-list
2334distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002335
2336<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2337'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2338defining how these points in the given image should be distorted in the
2339destination image. Each set of four floating point values represent a source
2340image coordinate, followed immediately by the destination image coordinate.
2341This produces a list of values such as...</p>
2342<div style="text-align: center"><em>
2343 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2344 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2345 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2346 ... &nbsp;
2347 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2348</em></div>
2349<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2350destination image. </p>
2351
2352<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2353needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2354perspective distortion of the built-in "rose:" image. Note how spaces were
2355used to group the 4 sets of coordinate pairs, to make it easier to read and
2356understand.</p>
2357
2358<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002359convert rose: -virtual-pixel black \<br/>
2360 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2361 rose_3d_rotated.gif</span></p>
2362<p>If more that the required number of coordinate pairs are given for
2363a distortion, the distortion method is 'least squares' fitted to produce the
2364best result for all the coordinate pairs given. If less than the ideal number
2365of points are given, the distort will generally fall back to a simpler form of
2366distortion that can handles the smaller number of coordinates (usally a linear
2367'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002368
cristyd0bda5e2010-09-21 16:22:45 +00002369<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002370find matching coordinate pairs in overlapping images, so as to improve the
2371'fit' of the distortion. Of course a bad coordinate pair can also make the
2372'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002373
2374<p>Colors are acquired from the source image according to the <a
2375href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002376magnified. However if the viewed image is minified (image becomes smaller),
2377a special area resampling function (added ImageMagick v6.3.5-9), is used to
2378produce a higher quality image. For example you can use
2379a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2380the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002381
cristyd0bd44a2010-09-24 12:38:11 +00002382<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2383convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2384 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2385 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002386<p>Note that a infinitely tiled perspective images involving the horizon can
2387be very slow to generate due to the use of the high quality 'area resampling'
2388function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2389using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2390(recommended if you plan to use super-sampling instead). </p>
2391
2392<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2393'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2394will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2395pixels. If you do not what these pixels to be visible, set the color to match
2396the rest of the ground. </p>
2397
2398<p>The output image size will by default be the same as the input image. This
2399means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002400the 'distorted space', those parts is clipped and lost. However if you use
2401the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2402will attempt (if possible) to show the whole of the distorted image, while
2403retaining a correct 'virtual canvas' offset, for image layering. This offset
2404may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2405is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002406
2407<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2408option:distort:viewport {geometry_string}</kbd>" setting which will specify
2409the size and the offset of the generated 'viewport' image of the distorted
2410image space.</p>
2411
2412<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2413{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2414that factor without changing the viewed contents of the distorted image. This
2415can be used either for 'super-sampling' the image for a higher quality result,
2416or for panning and zooming around the image (with appropriate viewport
2417changes, or post-distort cropping and resizing). </p>
2418
2419<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2420href="#distort" >-distort</a> to attempt to output the internal coefficients,
2421and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2422and debugging purposes. This many not be available for all distorts. </p>
2423
2424<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2425produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2426and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002427above settings. It is algorithmically slower however, though that may not be
2428the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002429
2430
2431<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002432 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002433</div>
2434
2435<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>
2436
cristyd0bda5e2010-09-21 16:22:45 +00002437<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 +00002438
2439<p>Dithering is turned on by default, to turn it off use the plus form of the
2440setting, <a href="#dither">+dither</a>. This will also also render PostScript
2441without text or graphic aliasing. Disabling dithering often (but not always)
2442leads to faster process, a smaller number of colors, but more cartoon like
2443image coloring. Generally resulting in 'color banding' effects in areas with
2444color gradients. </p>
2445
2446<p>The color reduction operators <a href="#colors">-colors</a>, <a
2447href="#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>
2448
2449<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>
2450
2451
2452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002453 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002454</div>
2455
2456<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>
2457
2458<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>
2459
2460<p>The shape primitives:</p>
2461
2462<pre class="text">
2463 point x,y
2464 line x0,y0 x1,y1
2465 rectangle x0,y0 x1,y1
2466 roundRectangle x0,y0 x1,y1 wc,hc
2467 arc x0,y0 x1,y1 a0,a1
2468 ellipse x0,y0 rx,ry a0,a1
2469 circle x0,y0 x1,y1
2470 polyline x0,y0 ... xn,yn
2471 polygon x0,y0 ... xn,yn
2472 bezier x0,y0 ... xn,yn
2473 path path specification
2474 image operator x0,y0 w,h filename
2475</pre>
2476
2477<p>The text primitive:</p>
2478
2479<pre class="text">
2480 text x0,y0 string
2481</pre>
2482<p>The text gravity primitive:</p>
2483
2484<pre class="text">
2485 gravity NorthWest, North, NorthEast, West, Center,
2486 East, SouthWest, South, or SouthEast
2487</pre>
2488
2489<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>
2490
2491<p>The transformation primitives:</p>
2492
2493<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002494 rotate degrees
2495 translate dx,dy
2496 scale sx,sy
2497 skewX degrees
2498 skewY degrees
cristy3ed852e2009-09-05 21:47:34 +00002499</pre>
2500
2501<p>The pixel operation primitives:</p>
2502
2503<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002504 color x0,y0 method
2505 matte x0,y0 method
cristy3ed852e2009-09-05 21:47:34 +00002506</pre>
2507
2508<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>
2509
2510<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>
2511
2512<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2513
2514<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2515
2516<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>
2517
2518<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2519
2520<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>
2521
2522<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>
2523
2524<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>.
2525</p>
2526
2527<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2528
2529<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2530
2531<p class="crtsnip">
2532 -draw 'circle 100,100 150,150'
2533</p>
2534
2535<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
2536draw 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>
2537
2538<p class="crtsnip">
2539 -draw 'bezier 20,50 45,100 45,0 70,50'
2540</p>
2541<p class="crtsnip">
2542 -draw 'bezier 70,50 95,100 95,0 120,50'
2543</p>
2544
2545
2546<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>
2547
2548<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>
2549
2550<p class="crtsnip">
2551 -draw 'image SrcOver 100,100 225,225 image.jpg'
2552</p>
2553
cristybc9539a2010-08-16 18:06:20 +00002554<p>You can use 0,0 for the image size, which means to use the actual
2555dimensions found in the image header. Otherwise, it is scaled to the given
2556dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
2557a detailed discussion of alpha composition methods that are available. </p>
cristy3ed852e2009-09-05 21:47:34 +00002558
2559<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>
2560
2561<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2562
2563<p class="crtsnip">
cristy4bf6e232011-05-21 01:43:33 +00002564 -draw "text 100,100 'Works like magick!' "
cristy3ed852e2009-09-05 21:47:34 +00002565</p>
2566
2567<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2568
2569<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>
2570
2571<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2572
2573<p>The <kbd>scale</kbd> primitive scales them.</p>
2574
2575<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>
2576
2577<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
2578matrix.</p>
2579
2580<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>
2581
2582<pre class="text">
2583 point
2584 replace
2585 floodfill
2586 filltoborder
2587 reset
2588</pre>
2589
2590<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>
2591
2592<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>
2593
2594<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>
2595
2596<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2597
2598<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2599
cristy2dcd6822011-06-13 16:21:20 +00002600
cristy8b9dd952011-03-21 22:56:18 +00002601<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00002602 <h4><a id="duplicate"></a>-duplicate <em class="arg">count,indexes</em></h4>
cristy8b9dd952011-03-21 22:56:18 +00002603</div>
2604
cristy323f35b2011-03-24 23:05:13 +00002605<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 +00002606
cristy323f35b2011-03-24 23:05:13 +00002607<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 +00002608
2609<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002610 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002611</div>
2612
2613<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>
2614
2615<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002616 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002617</div>
2618
2619<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>
2620
2621<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002622 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002623</div>
2624
2625<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>
2626
2627<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2628
2629<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2630
cristyd0bda5e2010-09-21 16:22:45 +00002631
2632
cristy3ed852e2009-09-05 21:47:34 +00002633<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002634 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002635</div>
2636
2637<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the text encoding.</td><td style='text-align:right;'></td></tr></table>
2638
2639<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>
2640
2641<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002642 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002643</div>
2644
2645<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify endianness (<kbd>MSB</kbd> or <kbd>LSB</kbd>) of the image.</td><td style='text-align:right;'></td></tr></table>
2646
2647<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2648
2649<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2650
2651
2652<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002653 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002654</div>
2655
2656<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>
2657
2658
2659<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002660 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002661</div>
2662
2663<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>perform histogram equalization on the image channel-by-channel.</td><td style='text-align:right;'></td></tr></table>
2664
2665<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>
2666
2667<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2668
2669<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>
2670
2671<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002672 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002673</div>
2674
2675<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>
2676
2677<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>
2678
2679<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>
2680
2681<table class="doc">
2682 <col width="25%" />
2683 <col width="75%" />
2684 <thead>
2685 <tr>
2686 <th><em class="arg">operator</em></th>
2687 <th>Summary (see further below for details)</th>
2688 </tr>
2689 </thead>
2690 <tbody>
2691
cristy3c98a4f2010-08-13 20:09:41 +00002692 <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 +00002693 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2694 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2695 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2696 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2697 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002698 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2699 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002700 <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>
2701 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2702 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002703 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002704 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002705 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2706 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2707 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2708 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2709 <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>
2710 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2711 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2712 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2713 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2714
2715 <tr><td>&nbsp;</td></tr>
2716
2717 <tr><td>Gaussian-noise</td></tr>
2718 <tr><td>Impulse-noise</td></tr>
2719 <tr><td>Laplacian-noise</td></tr>
2720 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2721 <tr><td>PoissonNoise</td></tr>
2722 <tr><td>Uniform-noise</td></tr>
2723
2724 <tr><td>&nbsp;</td></tr>
2725
2726 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2727 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2728 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2729 </tbody>
2730 </table>
2731
2732<p>The specified functions are applied only to each previously set <a
2733href="#channel" >-channel</a> in the image. If necessary, the results of the
2734calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2735class="QR">QuantumRange</em>]. The transparency channel of the image is
2736represented as a 'alpha' values (0 = fully transparent), so, for example, a
2737<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2738semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2739as a percentage of the <em class="QR">QuantumRange</em>.</p>
2740
2741<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2742<a href="#list">-list evaluate</a>.</p>
2743
2744<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2745<kbd>Multiply</kbd> methods can also be achieved using either the <a
2746href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2747appropriate argument, to linearly modify the overall range of color values.
2748Please note, however, that <a href="#level" >-level</a> treats transparency as
2749'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2750'alpha' values.</p>
2751
2752<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>
2753
cristyce66ab12010-10-21 23:36:32 +00002754<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>
2755
2756 <div style="text-align:center;">
2757 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2758 </div>
2759
2760<p> If the input image is squared, for example, using <a
2761href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2762
cristy3ed852e2009-09-05 21:47:34 +00002763<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>
2764
2765 <div style="text-align:center;">
2766 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2767 </div>
2768
2769<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2770normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2771href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2772to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2773with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2774with <kbd>Pow</kbd>.</p>
2775
2776<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2777converts the image values into a value according to a (co)sine wave function.
2778The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2779is biased 50% and normalized by 50% so as to fit in the respective color value
2780range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2781function (its frequency), and thus determines the number of 'waves' that will
2782be generated over the input color range. For example, if the <em
2783class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2784class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2785then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002786class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002787
2788 <div style="text-align:center;">
2789 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2790 </div>
2791
cristydcca3fa2010-12-29 21:50:07 +00002792<p>See also the <a href="#function" >-function</a> operator, which is a
2793multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002794
cristy63fed272010-03-07 19:08:45 +00002795<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002796 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002797</div>
2798
2799<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 +00002800
2801<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002802 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002803</div>
2804
2805<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>
2806
cristy3e2860c2010-01-24 01:36:30 +00002807<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 +00002808<p>This command reduces or expands a JPEG image to fit on an 800x600
2809display. If the aspect ratio of the input image isn't exactly 4:3, then the
2810image is centered on an 800x600 black canvas: </p>
2811
2812<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>
2813
cristy3ed852e2009-09-05 21:47:34 +00002814
2815<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>
2816
2817<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002818 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002819</div>
2820
2821<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>
2822
2823<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2824
cristy4949d522010-03-12 18:41:34 +00002825<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 +00002826
cristy4949d522010-03-12 18:41:34 +00002827<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 +00002828<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002829equivalent to:</p>
2830
2831<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>
2832<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>
2833
2834<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002835 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002836</div>
2837
2838<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>
2839
2840<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).
2841</p>
2842
2843<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>.
2844</p>
2845
2846<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002847 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002848</div>
2849
2850<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>
2851
2852<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002853 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002854</div>
2855
2856<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>implements the forward discrete Fourier transform (DFT).</td><td style='text-align:right;'></td></tr></table>
2857
cristydcca3fa2010-12-29 21:50:07 +00002858<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 +00002859
cristydcca3fa2010-12-29 21:50:07 +00002860<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 +00002861
2862<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>
2863
2864<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2865<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>
2866
2867<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2868<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>
2869
cristyd0bd44a2010-09-24 12:38:11 +00002870<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 +00002871
2872<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>
2873
2874<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2875 -evaluate log 1000 fft_image_spectrum.png</span></p>
2876<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>
2877
cristydcca3fa2010-12-29 21:50:07 +00002878<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 +00002879
2880<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>
2881
2882<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>
2883
cristydcca3fa2010-12-29 21:50:07 +00002884<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 +00002885
2886<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +00002887<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 +00002888</p>
2889
2890
2891<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002892 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002893</div>
2894
2895<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>
2896
2897<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>
2898
2899<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2900
2901<p>For example,</p>
2902
2903<p class="crtsnip">
2904 -fill blue
2905</p>
2906<p class="crtsnip">
2907 -fill "#ddddff"
2908</p>
2909<p class="crtsnip">
2910 -fill "rgb(255,255,255)"
2911</p>
2912
2913<p>See <a href="#draw">-draw</a> for further details.</p>
2914
2915<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2916
2917<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002918 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002919</div>
2920
cristyd0bda5e2010-09-21 16:22:45 +00002921<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
2922distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002923
cristyd0bda5e2010-09-21 16:22:45 +00002924<p>Use this option to affect the resizing operation of an image during
2925operations such as <a href="#resize">-resize</a> and <a href="#distort"
2926>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002927
2928<pre class="text">
2929 Point Hermite Cubic
2930 Box Gaussian Catrom
2931 Triangle Quadratic Mitchell
2932</pre>
2933
cristyd0bda5e2010-09-21 16:22:45 +00002934<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002935as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2936generally useless on their own as they are infinite filters that are being
2937clipped to the filters support size. Their direct use is not recommended
2938except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002939
cristydcca3fa2010-12-29 21:50:07 +00002940<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002941function that the <a href="#filter" >-filter</a> setting defines. That is
2942using these functions will define a 'Windowed' filter, appropriate to the
2943operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002944
2945<pre class="text">
2946 Lanczos Hamming Parzen
2947 Blackman Kaiser Welsh
2948 Hanning Bartlett Bohman
2949</pre>
2950
2951<p>Also one special self-windowing filter is also provided
2952<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2953on the current 'support' or 'lobes' expert settings (see below).</p>
2954
cristyd0bda5e2010-09-21 16:22:45 +00002955<p>If you do not select a filter with this option, the filter defaults to
2956<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2957if the image is enlarged. Otherwise the filter default to
2958<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002959
cristyd0bda5e2010-09-21 16:22:45 +00002960<p>To print a complete list of resize filters, use the <a href="#list">-list
2961filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002962
2963<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002964use of these expert settings (see also <a href="#define" >-define</a> and <a
2965href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002966
2967<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002968<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002969<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002970 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2971 Gaussian-like filters simple filters, or you may not get the expected
2972 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002973
cristyd0bda5e2010-09-21 16:22:45 +00002974<dt>-define filter:support=<em>radius</em></dt>
2975<dd>Set the filter support radius. Defines how large the filter should be and
2976 thus directly defines how slow the filtered resampling process is. All
2977 filters have a default 'prefered' support size. Some filters like
2978 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2979 this value. With simple filters this value either does nothing (but slow
2980 the resampling), or will clip the filter function in a detrimental way.
2981 </dd>
cristy3ed852e2009-09-05 21:47:34 +00002982
cristyd0bda5e2010-09-21 16:22:45 +00002983<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002984<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00002985 alternative way of specifying the 'support' range of the filter, that is
2986 designed to be more suited to windowed filters, especially when used for
2987 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002988
cristyd0bda5e2010-09-21 16:22:45 +00002989<dt>-define filter:b=<em>b-spline_factor</em></dt>
2990<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002991<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2992 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2993 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2994 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00002995 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00002996 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002997
cristyd0bda5e2010-09-21 16:22:45 +00002998<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002999<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00003000 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00003001 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00003002 'Bessel' functions. If defined, no windowing function is used, unless the
3003 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00003004
cristyd0bda5e2010-09-21 16:22:45 +00003005<dt>-define filter:window=<em>filter_function</em></dt>
3006<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
3007 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
3008 support range) with the given filter. This allows you to specify a filter
3009 function that is not normally used as a windowing function, such as
3010 <kbd>Box</kbd>, (which effectively turns off the windowing function),
3011 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
3012 </dd>
3013
3014<dt>-define filter:verbose=<em>1</em></dt>
3015<dd>This causes IM to print information on the final internal filter
3016 selection to standard output. This includes a commented header on the
3017 filter settings being used, and data allowing the filter weights to be
3018 easily graphed. </dd>
3019
3020<dd>Note however that some filters are internally defined in terms of other
3021 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
3022 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
3023 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
3024 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00003025
3026</dl>
3027
cristyd0bda5e2010-09-21 16:22:45 +00003028<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00003029
3030<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
3031 -set filter:window=bessel -set filter:lobes=8 \ <br/>
3032 -resize 150% image.jpg</span></p>
3033<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3034
3035<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
3036 -resize 150% image.jpg</span></p>
3037<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00003038filters, and 'verbose' for viewing the internal filter selection), are
3039provided for image processing experts who have studied and understood how
3040resize filters work. Without this knowledge, and an understanding of the
3041definition of the actual filters involved, using expert settings are more
3042likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00003043
3044
3045<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003046 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00003047</div>
3048
3049<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>
3050
3051
3052<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003053 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00003054</div>
3055
3056<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>
3057
cristy2dcd6822011-06-13 16:21:20 +00003058<p>reflect the scanlines in the vertical direction. The image will be mirrored
3059upside-down. </p>
3060
cristy3ed852e2009-09-05 21:47:34 +00003061
3062<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003063 <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 +00003064</div>
3065
cristy2dcd6822011-06-13 16:21:20 +00003066<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>
3067
3068<p>Flood fill starts from the given 'seed point' which is not gravity effected.
3069Any color that matches within <a href="#fuzz" >-fuzz</a> color distance of the
3070given <em class="arg">color</em> argument, connected to that 'seed point'
3071will be replaced with the current <a href="#fill" >-fill</a> color. </p>
3072
3073<p>Note that if the pixel at the 'seed point' does not itself match the given
3074<em class="arg">color</em> (according to <a href="#fuzz" >-fuzz</a>), then no
3075action will be taken. </p>
3076
3077<p>This operator works more like the <a href="#opaque" >-opaque</A> option, than
3078a 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>
3079
cristy3ed852e2009-09-05 21:47:34 +00003080
3081<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003082 <h4><a id="flop"></a>-flop</h4>
cristy3ed852e2009-09-05 21:47:34 +00003083</div>
3084
3085<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>
3086
cristy2dcd6822011-06-13 16:21:20 +00003087<p>Reflect the scanlines in the horizontal direction, just like the image in
3088a vertical mirror. </p>
cristy3ed852e2009-09-05 21:47:34 +00003089
3090
3091<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003092 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003093</div>
3094
3095<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>
3096
3097<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>
3098
3099<p>In addition to the fonts specified by the above pre-defined list, you can
3100also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
3101is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
3102<kbd>x:fixed</kbd> is X11 font.</p>
3103
3104<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>
3105
3106
3107<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003108 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003109</div>
3110
3111<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>
3112
3113<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3114
3115<p>The default foreground color is black.</p>
3116
3117<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003118 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003119</div>
3120
3121<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>
3122
cristy47774982011-02-15 15:17:19 +00003123<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 +00003124
3125<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>
3126
3127<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003128 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003129</div>
3130
3131<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>
3132
3133<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>
3134
3135<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003136 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003137</div>
3138
3139<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Surround the image with a border or beveled frame.</td><td style='text-align:right;'></td></tr></table>
3140
cristybc9539a2010-08-16 18:06:20 +00003141<p>The color of the border is specified with the <a href="#mattecolor"
3142>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003143
cristybc9539a2010-08-16 18:06:20 +00003144<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
3145class="arg">geometry</em> argument indicates the amount of extra width and
3146height that is added to the dimensions of the image. If no offsets are given
3147in the <em class="arg">geometry</em> argument, then the border added is
3148a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3149the width and height of the border is partitioned to form an outer bevel of
3150thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3151<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3152</p>
3153
3154<p>The <a href="#frame">-frame</a> option is affected by the current <a
3155href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003156'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003157size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3158draws the frame of four distinct colors close to the current <a
3159href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3160center of this image. This means that with the default compose method of
3161'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3162href="#bordercolor">-bordercolor</a> setting.</p>
3163
3164<p>The image composition is not
3165affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003166
3167
3168<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003169 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003170</div>
3171
3172<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>
3173
3174<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003175 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003176</div>
3177
3178<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>
3179
3180<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>
3181
3182<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>
3183
3184<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>
3185
3186<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003187 Polynomial
3188 Sinusoid
3189 Arcsin
3190 Arctan
cristy3ed852e2009-09-05 21:47:34 +00003191</pre>
3192
3193<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3194
3195<dl class="doc">
3196<dt><kbd>Polynomial</kbd></dt>
3197<dd>
3198<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>
3199
3200<div style="text-align: center">
3201 -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>
3202</div>
3203
3204<p>will invoke a polynomial function given by</p>
3205
3206<div style="text-align: center">
3207 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3208 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3209 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3210</div>
3211
3212<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3213
3214<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>
3215
3216<table class="doc">
3217 <col width="35%" />
3218 <col width="35%" />
3219 <col width="30%" />
3220 <tr>
3221 <td>-evaluate Set <em class="arg">value</em> </td>
3222 <td>-function Polynomial <em class="arg">value</em></td>
3223 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3224 </tr>
3225 <tr>
3226 <td>-evaluate Add <em class="arg">value</em> </td>
3227 <td>-function Polynomial 1,<em class="arg">value</em></td>
3228 </tr>
3229 <tr>
3230 <td>-evaluate Subtract <em class="arg">value</em> </td>
3231 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3232 </tr>
3233 <tr>
3234 <td>-evaluate Multiply <em class="arg">value</em> </td>
3235 <td>-function Polynomial <em class="arg">value</em>,0</td>
3236 </tr>
3237 <tr>
3238 <td>+level black% x white%</td>
3239 <td>-function Polynomial A,B</td>
3240 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3241 </tr>
3242</table>
3243
3244<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>
3245</dd>
3246
3247<dt><kbd>Sinusoid</kbd></dt>
3248<dd>
3249<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>
3250
3251<div style="text-align: center">
3252 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3253</div>
3254
3255<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>
3256
3257<div style="text-align: center">
3258<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>
3259</div>
3260
3261<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>
3262
3263<p class="crtsnip">
3264 -function Sinusoid 3,-90,.2,.7
3265</p>
3266
3267<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>
3268
3269<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>
3270
3271<table class="doc">
3272 <tr>
3273 <td>-evaluate Sin <em class="arg">freq</em> </td>
3274 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3275 </tr>
3276 <tr>
3277 <td>-evaluate Cos <em class="arg">freq</em> </td>
3278 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3279 </tr>
3280</table>
3281</dd>
3282
3283<dt><kbd>ArcSin</kbd></dt>
3284<dd>
3285<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3286and can be used to generate cylindrical distortion and displacement maps.
3287The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003288of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003289
cristydcca3fa2010-12-29 21:50:07 +00003290<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003291 -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 +00003292</p>
cristy3ed852e2009-09-05 21:47:34 +00003293
3294<p>with all values given in terms of noramlize color values (0.0 for black,
32951.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3296for bout input (<em class="arg">width</em>), and output (<em
3297class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3298
cristydcca3fa2010-12-29 21:50:07 +00003299<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003300<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 +00003301</p>
cristy3ed852e2009-09-05 21:47:34 +00003302
3303</dd>
3304
3305<dt><kbd>ArcTan</kbd></dt>
3306<dd>
3307<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3308limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003309All these values can be adjusted via the arguments.</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>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 +00003313</p>
cristy3ed852e2009-09-05 21:47:34 +00003314
3315<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3316</p>
3317
cristydcca3fa2010-12-29 21:50:07 +00003318<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003319<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 +00003320</p>
cristy3ed852e2009-09-05 21:47:34 +00003321
3322</dd>
3323
3324</dl>
3325
3326
3327<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003328 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003329</div>
3330
3331<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>
3332
3333<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>
3334
3335<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>
3336
3337
3338<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003339 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003340</div>
3341
3342<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>
3343
3344<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>
3345
3346<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3347
3348
3349<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003350 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003351</div>
3352
3353<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>
3354
3355<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>
3356
3357<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>
3358
3359<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>
3360
3361<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>
3362
3363<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3364
3365<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003366 <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 +00003367</div>
3368
3369<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>
3370
cristyb15553d2010-07-03 22:53:14 +00003371<p>Convolve the image with a Gaussian or normal distribution using the given
3372<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003373
3374<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3375</div>
3376
cristyb15553d2010-07-03 22:53:14 +00003377<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003378determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003379
3380<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003381array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003382integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003383radius that will provide meaningful results for the Gaussian distribution.
3384</p>
3385
3386<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3387operation is. However too small a <em class="arg" >Radius</em>, and sever
3388aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3389should be at least twice the <em class="arg" >Sigma</em> value, though three
3390times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003391
3392<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003393full 2-dimensional convolution is used to generate the weighted average of the
3394neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003395
3396<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3397pixels which are outside the image proper are blurred into the final result.
3398</p>
3399
3400
3401<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003402 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003403</div>
3404
3405<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>
3406
3407<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>
3408
3409<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003410 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003411</div>
3412
3413<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Sets the current gravity suggestion for various other settings and options.</td><td style='text-align:right;'></td></tr></table>
3414
3415<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3416<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3417<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3418list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3419installation.</p>
3420
3421<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>
3422
3423<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>
3424
3425<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>
3426
cristy4949d522010-03-12 18:41:34 +00003427<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 +00003428<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>
3429
3430<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>
3431
3432
3433<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003434 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003435</div>
3436
3437<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>
3438
3439
3440<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003441 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003442</div>
3443
3444<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>
3445
3446<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3447dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3448can apply any color transformation to the Hald image and then use this option
3449to apply the transform to the image. </p>
3450
3451<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3452<p>This option provides a convenient method for you to use Gimp or Photoshop
3453to make color corrections to the Hald CLUT image and subsequently apply them
3454to multiple images using an ImageMagick script. </p>
3455
3456<p>Note that the representation is only of the normal RGB color space and that
3457the whole color value triplet is used for the interpolated lookup of the
3458represented Hald color cube image. Because of this the operation is not <a
3459href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3460images transparency or alpha/matte channel.</p>
3461
3462<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3463of the individual color channels, usally involving a simplier gray-scale
3464image. E.g: gray-scale to color replacement, or modification by a histogram
3465mapping. </p>
3466
3467
3468<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003469 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003470</div>
3471
3472<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>
3473
3474<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003475 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003476</div>
3477
3478<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>
3479
3480<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003481 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003482</div>
3483
3484<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>
3485
3486<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>
3487
3488<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>
3489
3490<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003491 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003492</div>
3493
3494<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>
3495
3496<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003497 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003498</div>
3499
3500<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>
3501
3502<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>
3503
cristy47774982011-02-15 15:17:19 +00003504<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 +00003505
cristyd0bda5e2010-09-21 16:22:45 +00003506<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003507amounts of image properties are displayed including image statistics, profiles,
3508image histogram, and others.</p>
3509
3510<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003511 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003512</div>
3513
3514<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>
3515
cristydcca3fa2010-12-29 21:50:07 +00003516<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 +00003517
3518<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>
3519
3520<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3521<p>or</p>
3522
3523<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>
3524
cristydcca3fa2010-12-29 21:50:07 +00003525<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 +00003526
cristydcca3fa2010-12-29 21:50:07 +00003527<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 +00003528
cristydcca3fa2010-12-29 21:50:07 +00003529<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 +00003530
3531<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003532 <h4><a id="immutable"></a>-immutable</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%'>make image immutable.</td><td style='text-align:right;'></td></tr></table>
3536
3537<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003538 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003539</div>
3540
3541<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>
3542
3543<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003544 <h4><a id="insert"></a>-insert <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003545</div>
3546
3547<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>
3548
3549<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>
3550
3551<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>
3552
3553<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003554 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003555</div>
3556
3557<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>
3558
3559<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>
3560
3561<p>The default intent is undefined.</p>
3562
3563<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3564
3565<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003566 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003567</div>
3568
3569<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>
3570
3571<p>Choose from:</p>
3572
3573<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003574 none
3575 line
3576 plane
3577 partition
3578 JPEG
3579 GIF
3580 PNG
cristy3ed852e2009-09-05 21:47:34 +00003581</pre>
3582
3583<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>
3584
3585<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3586
3587<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3588
3589<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3590
3591<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3592image.G, and image.B).</p>
3593
3594<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>
3595image.</p>
3596
3597<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3598
3599<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003600 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003601</div>
3602
3603<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>
3604
cristyd0bda5e2010-09-21 16:22:45 +00003605<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003606value, you typically fall in between the pixel colors defined by the source
3607image. This setting determines how the color is determined from the colors of
3608the pixels surrounding that point. That is how to determine the color of a
3609point that falls between two, or even four different colored pixels. </p>
3610
3611<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003612 integer The color of the top-left pixel (floor function)
3613 nearest-neighbor The nearest pixel to the lookup point (rounded function)
3614 average The average color of the surrounding four pixels
3615 bilinear A double linear interpolation of pixels (the default)
3616 mesh Divide area into two flat triangular interpolations
3617 bicubic Fitted bicubic-spines of surrounding 16 pixels
3618 spline Direct spline curves (colors are blurred)
3619 filter Use resize <a href="#filter">-filter</a> settings
cristy3ed852e2009-09-05 21:47:34 +00003620</pre>
3621
3622<p>This most important for distortion operators such as <a href="#distort"
3623>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3624>-transform</a> and <a href="#fx" >-fx</a>. </p>
3625
3626<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3627
3628<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3629lookup for positions outside the boundaries of the image. </p>
3630
3631
3632<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003633 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003634</div>
3635
3636<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>
3637
3638<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003639 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003640</div>
3641
3642<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>
3643
3644<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003645 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003646</div>
3647
3648<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>
3649
3650<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003651 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003652</div>
3653
3654<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>
3655
cristy71a3f602010-09-15 12:38:16 +00003656<p>Use this option to assign a specific label to the image, as it is read in
3657or created. You can use the <a href="#set" >-set</a> operation to re-assign
3658a the labels of images already read in. Image formats such as TIFF, PNG,
3659MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003660
cristy71a3f602010-09-15 12:38:16 +00003661<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3662assigned to an image is used as a header string to print above the postscript
3663image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003664
cristybc9539a2010-08-16 18:06:20 +00003665<p>You can include the image filename, type, width, height, or other image
3666attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3667Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003668
3669<p>For example,</p>
3670
3671<p class="crtsnip">
3672 -label "%m:%f %wx%h" bird.miff
3673</p>
3674
cristy71a3f602010-09-15 12:38:16 +00003675<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3676"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3677is read in. If a <a href="#label">+label</a> option was used instead, any
3678existing label present in the image would be used. You can remove all labels
3679from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003680
cristy71a3f602010-09-15 12:38:16 +00003681<p>A label is not drawn on the image, but is embedded in the image datastream
3682via <em>Label</em> tag or similar mechanism. If you want the label to be
3683visible on the image itself, use the <a href="#draw">-draw</a> option, or
3684during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003685
cristy71a3f602010-09-15 12:38:16 +00003686<p>If the first character of <em class="arg">string</em> is <em
3687class="arg">@</em>, the image label is read from a file titled by the
3688remaining characters in the string. Labels in a file are literal, no embedded
3689formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003690
3691
3692<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003693 <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 +00003694</div>
3695
3696<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>
3697
3698<p>Adaptively threshold each pixel based on the value of pixels in a
3699surrounding window. If the current pixel is lighter than this average plus
3700the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3701black. Small variations in pixel values such as found in scanned documents
3702can be ignored if offset is positive. A negative offset will make it more
3703sensitive to those small variations. </p>
3704
3705<p>This is commonly used to threshold images with an uneven background. It is
3706based on the assumption that average color of the small window is the
3707the local background color, from which to separate the forground color. </p>
3708
3709
3710<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003711 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003712</div>
3713
3714<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>handle multiple images forming a set of image layers or animation frames.</td><td style='text-align:right;'></td></tr></table>
3715
3716<p>Perform various image operation methods to a ordered sequence of images
3717which may represent either a set of overlaid 'image layers', a GIF disposal
3718animation, or a fully-'coalesced' animation sequence. </p>
3719
3720<table class="doc">
3721 <tbody>
3722 <tr valign="top">
3723 <th align="left" style="width: 8%">Method</th>
3724 <th align="left">Description</th>
3725 </tr>
3726
3727 <tr valign="top">
3728 <td valign="top">compare-any</td>
3729 <td valign="top">Crop the second and later frames to the smallest rectangle
3730 that contains all the differences between the two images. No GIF <a
3731 href="#dispose" >-dispose</a> methods are taken into account. </td>
3732 </tr>
3733
3734 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3735 >-deconstruct</a> operator, and does not preserve animations normal
3736 working, especially when animation used layer disposal methods such as
3737 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3738 </tr>
3739
3740 <tr valign="top">
3741 <td valign="top">compare-clear</td>
3742 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3743 opaque pixels which become transparent in the second frame. That is the
3744 smallest image needed to mask or erase pixels for the next frame. </td>
3745 </tr>
3746
3747 <tr valign="top">
3748 <td valign="top">compare-overlay</td>
3749 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3750 extra color to the next image, as a result of overlaying color pixels.
3751 That is the smallest single overlaid image to add or change colors. </td>
3752 </tr>
3753
3754 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3755 composition method '<kbd>change-mask</kbd>', to reduce the image to
3756 just the pixels that need to be overlaid. </td>
3757 </tr>
3758
3759 <tr valign="top">
3760 <td valign="top">coalesce</td>
3761 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3762 >-coalesce</a> operator. Apply the layer disposal methods set in the
3763 current image sequence to form a fully defined animation sequence, as
3764 it should be displayed. Effectively converting a GIF animation into a
3765 'film strip'-like animation. </td>
3766 </tr>
3767
3768 <tr valign="top">
3769 <td valign="top">composite</td>
3770 <td valign="top">Alpha Composition of two image lists, separated by a
3771 "<kbd>null:</kbd>" image, with the destination image list first, and
3772 the source images last. An image from each list are composited
3773 together until one list is finished. The separator image and source
3774 image lists are removed. </td>
3775 </tr>
3776
3777
cristybac7a162010-06-15 19:57:29 +00003778 <tr><td></td>
3779 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3780 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3781 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003782 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003783 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003784
cristybac7a162010-06-15 19:57:29 +00003785 <tr><td></td>
3786 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003787 applied to all the images in the other image list, regardless of which
3788 list it is. In this case it is the image meta-data of the list which
3789 preserved. </td>
3790 </tr>
3791
3792
3793 <tr valign="top">
3794 <td valign="top">dispose</td>
3795 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3796 the animation after the layer disposal method has been applied, before
3797 the next sub-frame image is overlaid. That is the 'dispose' image that
3798 results from the application of the GIF <a href="#dispose"
3799 >-dispose</a> method. This allows you to check what
3800 is going wrong with a particular animation you may be developing.
3801 </td>
3802 </tr>
3803
3804 <tr valign="top">
3805 <td valign="top">flatten</td>
3806 <td valign="top">Create a canvas the size of the first images virtual
3807 canvas using the current <a href="#background" >-background</a> color,
3808 and <a href="#compose" >-compose</a> each image in turn onto that
3809 canvas. Images falling outside that canvas is clipped. Final
3810 image will have a zero virtual canvas offset. </td>
3811 </tr>
3812
cristybac7a162010-06-15 19:57:29 +00003813 <tr><td></td>
3814 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003815 overlaying all the prepared image layers into a final image. </td>
3816 </tr>
3817
cristybac7a162010-06-15 19:57:29 +00003818 <tr><td></td>
3819 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003820 canvas with real pixels, or to underlay a opaque color to remove
3821 transparency from an image.</td>
3822 </tr>
3823
3824
3825 <tr valign="top">
3826 <td valign="top">merge</td>
3827 <td valign="top">As 'flatten' method but merging all the given image
cristy10549a12011-05-15 19:04:46 +00003828 layers to create a new layer image just large enough to hold all the
3829 image without clipping or extra space. The new images virtual offset
3830 will preserve the position of the new layer, even if this offset is
3831 negative. The virtual canvas size of the first image is preserved.
cristy3ed852e2009-09-05 21:47:34 +00003832 </td>
cristy10549a12011-05-15 19:04:46 +00003833 </tr>
cristy3ed852e2009-09-05 21:47:34 +00003834
cristy10549a12011-05-15 19:04:46 +00003835 <tr><td></td><td>Caution is advised when handling image layers with
3836 negative offsets as few image file formats handle them correctly.
3837 Following this operation methd with <a href="#repage" >+repage</a>
3838 will remove the layer offset, and create a image in which all the
3839 overlaid image positions relative to each other is preserved, though
3840 not nessaraily exactly where you specified them.
3841 </td>
3842 </tr>
3843
3844 <tr><td></td><td>See also 'trim-bounds' below whcih is closely related but
3845 without doing the'flatten' to merge the images together. </td>
cristy3ed852e2009-09-05 21:47:34 +00003846 </tr>
3847
3848 <tr valign="top">
3849 <td valign="top">mosaic</td>
3850 <td valign="top">As 'flatten' method but expanding the initial canvas size
cristy10549a12011-05-15 19:04:46 +00003851 of the first image in a positive direction only so as to hold all the
3852 image layers. However as a virtual canvas is 'locked' to the origin,
3853 by its own definition, image layers with a negative offsets will still
3854 become clipped by the top and left edges. See 'merge' or 'trim-bounds'
3855 if this could be a problem. </td>
3856
cristy3ed852e2009-09-05 21:47:34 +00003857 </tr>
3858
cristy10549a12011-05-15 19:04:46 +00003859 <tr><td></td><td>This method is commonly used to layout individual image
3860 using various offset but without knowing the final canvas size. The
3861 resulting image will, like 'flatten' not have any virtual offset, so
3862 can be saved to any image file format. </td>
cristy3ed852e2009-09-05 21:47:34 +00003863 </tr>
3864
3865
3866 <tr valign="top">
3867 <td valign="top">optimize</td>
3868 <td valign="top">Optimize a coalesced animation, into GIF animation using
3869 a number of general techniques. This currently a short cut to
3870 apply both the '<kbd>optimize-frame</kbd>', and
3871 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3872 include other optimization methods as they are developed. </td>
3873 </tr>
3874
3875 <tr valign="top">
3876 <td valign="top">optimize-frame</td>
3877 <td valign="top">Optimize a coalesced animation, into GIF animation by
3878 reducing the number of pixels per frame as much as possible by
3879 attempting to pick the best layer disposal method to use, while ensuring
3880 the result will continue to animate properly. </td>
3881 </tr>
3882
cristy10549a12011-05-15 19:04:46 +00003883 <tr><td></td><td> There is no guarantee that the best optimization is found.
3884 But then no reasonably fast GIF optimization algorithm can do this.
cristy3ed852e2009-09-05 21:47:34 +00003885 However this does seem to do better than most other GIF frame
3886 optimizers seen. </td>
3887 </tr>
3888
3889 <tr valign="top">
3890 <td valign="top">optimize-plus</td>
3891 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3892 overall optimization by adding extra frames to the animation, without
3893 changing the final look or timing of the animation. The frames are
3894 added to attempt to separate the clearing of pixels from the
3895 overlaying of new additional pixels from one animation frame to the
3896 next. If this does not improve the optimization (for the next frame
3897 only), it will fall back to the results of the previous normal
3898 '<kbd>optimize-frame</kbd>' technique. </td>
3899 </tr>
3900
cristy10549a12011-05-15 19:04:46 +00003901 <tr><td></td><td>There is the possibility that the change in the disposal
3902 style will result in a worsening in the optimization of later frames,
3903 though this is unlikely. In other words there no guarantee that it is
3904 better than the normal '<kbd>optimize-frame</kbd>' technique. For some
3905 animations however you can get a vast improvement in the final
3906 animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003907 </tr>
3908
3909 <tr valign="top">
3910 <td valign="top">optimize-transparency</td>
3911 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3912 overlay images with transparency, if it does not change the resulting
3913 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3914 </td>
3915 </tr>
3916
cristy10549a12011-05-15 19:04:46 +00003917 <tr><td></td><td>This should allow a existing frame optimized GIF animation
3918 to compress into a smaller file size due to larger areas of one
3919 (transparent) color rather than a pattern of multiple colors repeating
3920 the current disposed image of the last frame. </td>
cristy3ed852e2009-09-05 21:47:34 +00003921 </tr>
3922
3923 <tr valign="top">
3924 <td valign="top">remove-dups</td>
3925 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3926 images, so as to simplify layer overlays of coalesced animations.
3927 </td>
3928 </tr>
3929
cristy10549a12011-05-15 19:04:46 +00003930 <tr><td></td><td>Usually this a result of using a constant time delay
3931 across the whole animation, or after a larger animation was split into
3932 smaller sub-animations. The duplicate frames could also have been
3933 used as part of some frame optimization methods. </td>
cristy3ed852e2009-09-05 21:47:34 +00003934 </tr>
3935
3936 <tr valign="top">
3937 <td valign="top">remove-zero</td>
3938 <td valign="top">Remove any image with a zero time delay, unless ALL the
3939 images have a zero time delay (and is not a proper timed animation, a
3940 warning is then issued). </td>
3941 </tr>
3942
cristy10549a12011-05-15 19:04:46 +00003943 <tr><td></td><td>In a GIF animation, such images are usually frames which
3944 provide partial intermediary updates between the frames that are
3945 actually displayed to users. These frames are usally added for
3946 improved frame optimization in GIF animations. </td>
cristy3ed852e2009-09-05 21:47:34 +00003947 </tr>
3948
3949 <tr valign="top">
3950 <td valign="top">trim-bounds</td>
3951 <td valign="top">Find the bounds of all the images in the current
3952 image sequence, then adjust the offsets so all images are contained on
cristy10549a12011-05-15 19:04:46 +00003953 a minimal positive canvas. None of the image data is modified or
3954 merged, only the individual image virtual canvas size and offset.
3955 All the images is given the same canvas size, and and will have
3956 a positive offset, but will remain in the same position relative to
3957 each other. As a result of the minimal canvas size at least one image
3958 will touch every edge of that canvas. The image data touching those
3959 edges however may be transparent. </td>
3960 </tr>
3961
3962 <tr><td></td><td>The result is much like if you used 'merge' followed by a
3963 <a href="#repage" >+repage</a> option, except that all the images
3964 have been kept separate. If 'flatten' is used after using
3965 'trim-bounds' you will get the same result. </td>
cristy3ed852e2009-09-05 21:47:34 +00003966 </tr>
3967
3968 </tbody>
3969</table>
3970
3971<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3972
3973<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3974>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
cristy10549a12011-05-15 19:04:46 +00003975>-mosaic</a> are only aliases for the above methods and may be depreciated in
3976the future. Also see <a href="#page" >-page</a>, <a href="#repage"
3977>-repage</a> operators, the <a href="#compose" >-compose</a> setting, and the
3978GIF <a href="#dispose" >-dispose</a> and <a href="#delay" >-delay</a>
3979settings. </p>
cristy3ed852e2009-09-05 21:47:34 +00003980
3981
3982<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003983 <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 +00003984</div>
3985
3986<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>
3987
3988<p>Given one, two or three values delimited with commas: black-point,
3989white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3990white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3991point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3992contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3993both black and white points are percentages of the full color range. Gamma
3994will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3995omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3996
3997<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3998the given '<kbd>black_point</kbd>' value in the original image is set to
3999zero (or black), while the given '<kbd>white_point</kbd>' value is set to
4000<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
4001to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
4002adjusted. </p>
4003
4004<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
4005adding the special '!' flag anywhere in the argument list, will cause the
4006operator to do the reverse of the level adjustment. That is a zero, or
4007<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
4008adjusted to the given level values, allowing you to de-contrast, or compress
4009the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
4010
4011<p>Only the channels defined by the current <a href="#channel">-channel</a>
4012setting are adjusted (defaults to RGB color channels only), allowing you to
4013limit the effect of this operator. </p>
4014
4015<p>Please note that the transparency channel is treated as 'matte'
4016values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
4017
4018
4019<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004020 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00004021 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
4022</div>
4023
cristyd0bda5e2010-09-21 16:22:45 +00004024<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 +00004025
4026<p>This function is exactly like <a href="#level">-level</a>, except that the
4027value value for each color channel is determined by the
4028'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
4029described under the <a href="#fill">-fill</a> option). </p>
4030
cristyd0bda5e2010-09-21 16:22:45 +00004031<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
4032is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00004033colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00004034adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00004035
4036<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
4037will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00004038respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00004039those colors. This can also be used to convert a plain gray-scale image into a
4040one using the gradient of colors specified. </p>
4041
4042<p>By supplying a single color with a comma separator either before or after
4043that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00004044respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00004045used for both the black and white color points, making the operator either
4046threshold the images around that color (- form) or set all colors to that
4047color (+ form). </p>
4048
4049
4050<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004051 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004052</div>
4053
4054<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>
4055
4056<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>
4057
cristy6b636652009-12-05 17:16:11 +00004058<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 +00004059
4060<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00004061 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00004062</p>
4063
4064<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
4065
cristydcca3fa2010-12-29 21:50:07 +00004066<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 +00004067 File Area Memory Map Disk Thread Time
4068 ------------------------------------------------------------------------------
4069 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
cristydcca3fa2010-12-29 21:50:07 +00004070</pre>
4071
cristy3ed852e2009-09-05 21:47:34 +00004072<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>
4073
4074<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>
4075
4076<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>
4077
4078<p class="crtsnip">
4079-limit area 10mb
4080</p>
4081
cristyd0bda5e2010-09-21 16:22:45 +00004082<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 +00004083
4084<p class="crtsnip">
4085-limit area 10mb -limit disk 500mb
4086</p>
4087
4088<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
4089
4090<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>
4091
4092<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.
4093</p>
4094
4095<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.
4096</p>
4097
4098<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004099 <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 +00004100</div>
4101
4102<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>
4103
cristyd934d102009-10-10 12:55:13 +00004104<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
4105and uses a 'histogram bin' to determine the range of color values that needs to
4106be stretched. However it then stretchs those colors using the <a
4107href="#level" >-level</a> operator.</p>
4108
4109<p>As such while the initial determination may have 'binning' round off
4110effects, the image colors are stretched mathematically, rather than using the
4111histogram bins. This makes the operator more accurate. </p>
4112
4113<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
4114'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
4115perfect stretch of the color range. </p>
4116
4117<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
4118normalization of mathematical images. </p>
4119
4120<p>This operator is under review for re-development. </p>
4121
4122
cristy3ed852e2009-09-05 21:47:34 +00004123<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004124 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00004125</div>
4126
4127<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the line width for subsequent draw operations.</td><td style='text-align:right;'></td></tr></table>
4128
4129<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004130 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004131</div>
4132
4133<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>
4134
4135<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>
4136
4137<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004138 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004139</div>
4140
4141<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
4142
4143<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004144 Align Alpha Boolean Channel
4145 Class ClipPath Coder Color
4146 Colorspace Command Compose Compress
4147 Configure DataType Debug Decoration
4148 Delegate Direction Dispose Distort
4149 Dither Endian Evaluate FillRule
4150 Filter Font Format Function
4151 Gravity ImageList Intent Interlace
4152 Interpolate Kernel Layers LineCap
4153 LineJoin List Locale LogEvent
4154 Log Magic Method Metric
4155 Mime Mode Morphology Module
4156 Noise Orientation Policy PolicyDomain
4157 PolicyRights Preview Primitive QuantumFormat
4158 Resource SparseColor Storage Stretch
4159 Style Threshold Type Units
4160 Validate VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004161</pre>
4162
cristybac7a162010-06-15 19:57:29 +00004163<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4164list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4165available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004166
4167<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4168<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004169 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004170</div>
4171
4172<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>
4173
cristybac7a162010-06-15 19:57:29 +00004174<p>This option specifies the format for the log printed when the <a
4175href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004176
cristybac7a162010-06-15 19:57:29 +00004177<p>You can display the following components by embedding special format
4178characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004179
4180<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004181 %d domain
4182 %e event
4183 %f function
4184 %l line
4185 %m module
4186 %p process ID
4187 %r real CPU time
4188 %t wall clock time
4189 %u user CPU time
4190 %% percent sign
4191 \n newline
4192 \r carriage return
cristy3ed852e2009-09-05 21:47:34 +00004193</pre>
4194
4195<p>For example:</p>
4196
4197<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>
4198<p>The default behavior is to print all of the components.</p>
4199
4200<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004201 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004202</div>
4203
4204<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>
4205
cristybac7a162010-06-15 19:57:29 +00004206<p>Set iterations to zero to repeat the animation an infinite number of times,
4207otherwise the animation repeats itself up to <em class="arg">iterations</em>
4208times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004209
4210<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004211 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004212</div>
4213
4214<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>
4215
4216<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004217 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004218</div>
4219
4220<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>
4221
4222
4223<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004224 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004225</div>
4226
4227<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>
4228
4229<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4230
4231<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004232 best
4233 default
4234 gray
4235 red
4236 green
4237 blue
cristy3ed852e2009-09-05 21:47:34 +00004238</pre>
4239
cristybac7a162010-06-15 19:57:29 +00004240<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4241Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4242the type and <kbd>display</kbd> searches the list of colormap types in
4243<kbd>top-to-bottom</kbd> order until one is located. See <em
4244class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004245
4246
4247<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004248 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004249</div>
4250
4251<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>
4252
4253<p>Here are the valid components of a map:</p>
4254
4255<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004256 r red pixel component
4257 g green pixel component
4258 b blue pixel component
4259 a alpha pixel component (0 is transparent)
4260 o opacity pixel component (0 is opaque)
4261 i grayscale intensity pixel component
4262 c cyan pixel component
4263 m magenta pixel component
4264 y yellow pixel component
4265 k black pixel component
4266 p pad component (always 0)
cristy3ed852e2009-09-05 21:47:34 +00004267</pre>
4268
cristybac7a162010-06-15 19:57:29 +00004269<p>You can specify as many of these components as needed in any order (e.g.
4270bgr). The components can repeat as well (e.g. rgbr).</p>
4271
cristy3ed852e2009-09-05 21:47:34 +00004272
4273<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004274 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004275<em class="arg">filename</em></h4>
4276</div>
4277
cristyacc04882011-05-04 23:03:43 +00004278<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 +00004279
cristyacc04882011-05-04 23:03:43 +00004280<p>This the same as using a mask used for composite masking operations, with
4281grayscale values causing blended updates of the image the mask is attached to.
4282</P>
4283
4284<p>Use <a href="#mask">+mask</a> to remove the mask from images.</p>
4285
4286<p>Also see <a href="#clip-mask">-clip-mask</a> which work in the same way,
4287but with strict boolean masking. </p>
cristy3ed852e2009-09-05 21:47:34 +00004288
4289<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004290 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004291</div>
4292
4293<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>
4294
4295<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4296
cristybac7a162010-06-15 19:57:29 +00004297<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4298style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004299
4300<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004301 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004302</div>
4303
4304<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>
4305
cristyacc04882011-05-04 23:03:43 +00004306<p>Select the 'maximum' value from all the surrounding pixels. </p>
4307
4308<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4309name. </p>
4310
cristyd2baf7d2010-03-06 04:26:44 +00004311<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004312 <h4><a id="median"></a>-median <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004313</div>
4314
4315<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>
4316
cristyacc04882011-05-04 23:03:43 +00004317<p>Select the 'middle' value from all the surrounding pixels. </p>
4318
4319<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4320name. </p>
4321
cristy3ed852e2009-09-05 21:47:34 +00004322<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004323 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004324</div>
4325
4326<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>
4327
4328<p>Choose from:</p>
4329
4330<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004331 AE absolute error count, number of different pixels (-fuzz effected)
4332 FUZZ mean color distance
4333 MAE mean absolute error (normalized), average channel error distance
4334 MEPP mean error per pixel (normalized mean error, normalized peak error)
4335 MSE mean error squared, average of the channel error squared
4336 NCC normalized cross correlation
4337 PAE peak absolute (normalize peak absolute)
4338 PSNR peak signal to noise ratio
4339 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004340</pre>
4341
cristy771f7a72010-11-27 21:42:59 +00004342<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4343with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4344only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004345size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004346'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004347for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004348
4349<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4350('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004351normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004352
cristybac7a162010-06-15 19:57:29 +00004353<p>To print a complete list of metrics, use the <a href="#list">-list
4354metrics</a> option.</p>
4355
cristy3ed852e2009-09-05 21:47:34 +00004356
cristyd2baf7d2010-03-06 04:26:44 +00004357<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004358 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004359</div>
4360
4361<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>
4362
cristyacc04882011-05-04 23:03:43 +00004363<p>Select the 'minimal' value from all the surrounding pixels. </p>
4364
4365<p>This is legacy option from the <a href="#statistic" >method</A> of the same
4366name. </p>
4367
4368
cristy3ed852e2009-09-05 21:47:34 +00004369
4370<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004371 <h4><a id="mode"></a>-mode <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004372</div>
4373
cristybe3c5be2011-03-05 17:35:07 +00004374<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>make each pixel the 'predominate 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>
4375
4376<div style="margin: auto;">
4377 <h4>-mode <em class="arg">value</em></h4>
4378</div>
4379
cristy3ed852e2009-09-05 21:47:34 +00004380<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>
4381
cristybac7a162010-06-15 19:57:29 +00004382<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4383Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004384
cristybac7a162010-06-15 19:57:29 +00004385<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4386for a list of <a href="#mode" >-mode</a> arguments available in your
4387ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004388
4389
4390<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004391 <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 +00004392</div>
4393
cristybac7a162010-06-15 19:57:29 +00004394<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
4395class="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 +00004396
cristyb36feb22010-03-26 16:54:37 +00004397<p>The arguments are given as a percentages of variation. A value of 100 means
4398no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004399
cristyb36feb22010-03-26 16:54:37 +00004400<p>The <em class="arg">brightness</em> is a multiplier of the overall
4401brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4402twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4403before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004404
cristyb36feb22010-03-26 16:54:37 +00004405<p>The <em class="arg">saturation</em> controls the amount of color in an
4406image. For example, 0 produce a grayscale image, while a large value such as
4407200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004408
cristyb36feb22010-03-26 16:54:37 +00004409<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4410within the image by the amount specified. For example, 50 results in
4411a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4412A value of either 0 or 200 results in a complete 180 degree rotation of the
4413image. Using a value of 300 is a 360 degree rotation resulting in no change to
4414the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004415
cristyb36feb22010-03-26 16:54:37 +00004416<p>For example, to increase the color brightness by 20% and decrease the color
4417saturation by 10% and leave the hue unchanged, use <a
4418href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004419
cristyb36feb22010-03-26 16:54:37 +00004420<p>Use <a href="#set">-set</a> attribute of '<kbd
4421class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4422modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4423<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004424
4425<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 +00004426
cristy3ed852e2009-09-05 21:47:34 +00004427<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004428 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004429</div>
4430
4431<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>
4432
4433
4434<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004435 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004436</div>
4437
4438<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>transform the image to black and white.</td><td style='text-align:right;'></td></tr></table>
4439
4440
4441<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004442 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004443</div>
4444
4445<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>
4446
4447<p>Both the image pixels and size are linearly interpolated to give the
4448appearance of a meta-morphosis from one image to the next, over all the images
4449in the current image list. The added images are the equivalent of a <a
4450href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4451argument determine how many images to interpolate between each image. </p>
4452
4453
4454<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004455 <h4><a id="morphology"></a>-morphology</h4>
4456 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004457</div>
4458
cristy2c839602010-04-03 02:32:08 +00004459<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 +00004460
cristydcca3fa2010-12-29 21:50:07 +00004461<p>Until I get around to writing a option summary for this, see <a
4462href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4463Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004464
4465
cristy488844c2010-01-22 14:02:05 +00004466<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004467 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004468</div>
4469
4470<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>an simple alias for the <a href="#layers" >-layers</a> method "mosaic"</td><td style='text-align:right;'></td></tr></table>
4471
4472
4473<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004474 <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 +00004475</div>
4476
4477<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>
4478
4479<p>Blur with the given radius, standard deviation (sigma), and angle. The
4480angle given is the angle toward which the image is blurred. That is the
4481direction people would consider the object is coming from. </p>
4482
4483<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004484definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004485
4486<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4487pixels which are outside the image proper are blurred into the final result.
4488</p>
4489
4490<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004491 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004492</div>
4493
4494<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>
4495<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004496 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004497</div>
4498
cristyb29bc032010-02-01 20:29:43 +00004499<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 +00004500
4501<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>
4502
4503<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004504 <h4><a id="noise"></a>-noise <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004505 +noise <em class="arg">type</em></h4>
4506</div>
4507
4508<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>
4509
4510<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>
4511
4512<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>
4513
4514<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>
4515
4516<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004517 Gaussian
4518 Impulse
4519 Laplacian
4520 Multiplicative
4521 Poisson
4522 Random
4523 Uniform
cristy3ed852e2009-09-05 21:47:34 +00004524</pre>
4525
4526<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4527
cristy83543962009-10-16 19:04:28 +00004528<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4529the use of a controlling value to specify teh amount of noise that should be
4530added to an image. </p>
4531
cristy3ed852e2009-09-05 21:47:34 +00004532
4533<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004534 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004535</div>
4536
4537<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>
4538
cristyd934d102009-10-10 12:55:13 +00004539<p>The intensity values are stretched to cover the entire range of possible
4540values. While doing so, black-out at most <em>2%</em> of the pixels and
4541white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004542
cristyd934d102009-10-10 12:55:13 +00004543<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4544is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4545(Before this version, it was equivalent to <a href="#contrast-stretch"
4546>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004547
cristyd934d102009-10-10 12:55:13 +00004548<p>All the channels are normalized in concert by the came amount so as to
4549preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004550setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004551setting will normalize the RGB channels independently.</p>
4552
cristydcca3fa2010-12-29 21:50:07 +00004553<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004554Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004555that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004556
4557<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004558
4559
4560<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004561 <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 +00004562</div>
4563
cristyd934d102009-10-10 12:55:13 +00004564<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
4565class="arg">threshold map</em> specified, and a uniform color map with the
4566given 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 +00004567
4568<p>You can choose from these standard threshold maps:</p>
4569
4570<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004571 threshold 1x1 Threshold 1x1 (non-dither)
4572 checks 2x1 Checkerboard 2x1 (dither)
4573 o2x2 2x2 Ordered 2x2 (dispersed)
4574 o3x3 3x3 Ordered 3x3 (dispersed)
4575 o4x4 4x4 Ordered 4x4 (dispersed)
4576 o8x8 8x8 Ordered 8x8 (dispersed)
4577 h4x4a 4x1 Halftone 4x4 (angled)
4578 h6x6a 6x1 Halftone 6x6 (angled)
4579 h8x8a 8x1 Halftone 8x8 (angled)
4580 h4x4o Halftone 4x4 (orthogonal)
4581 h6x6o Halftone 6x6 (orthogonal)
4582 h8x8o Halftone 8x8 (orthogonal)
4583 h16x16o Halftone 16x16 (orthogonal)
4584 c5x5b c5x5 Circles 5x5 (black)
4585 c5x5w Circles 5x5 (white)
4586 c6x6b c6x6 Circles 6x6 (black)
4587 c6x6w Circles 6x6 (white)
4588 c7x7b c7x7 Circles 7x7 (black)
4589 c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004590</pre>
4591
cristy945bb352011-04-01 15:39:28 +00004592<p> The <kbd>threshold</kbd> generated a simple 50% threshold of the image.
cristybaacd172011-04-30 23:11:03 +00004593This could be used with <em class="arg" >level</em> to do the equivalent of <a
cristy945bb352011-04-01 15:39:28 +00004594href="#posterize" >-posterize</a> to reduce an image to basic primary colors.
4595</p>
cristy3ed852e2009-09-05 21:47:34 +00004596
cristy945bb352011-04-01 15:39:28 +00004597<p>The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
4598pattern. That is a grayscale will become a pattern of solid black, solid
4599white, and mid-tone colors into a checkerboard pattern of black and white.
4600</p>
cristy3ed852e2009-09-05 21:47:34 +00004601
cristy945bb352011-04-01 15:39:28 +00004602<p>You can define your own <em class="arg" >threshold map</em> for ordered
4603dithering and halftoning your images, in either personal or system
4604<kbd>thresholds.xml</kbd> XML file. See <a href="resources.html" >Resources</A>
4605for more details of configuration files. </p>
cristy3ed852e2009-09-05 21:47:34 +00004606
cristy945bb352011-04-01 15:39:28 +00004607<p>To print a complete list of the thresholds that have been defined, use the
4608<a href="#list" >-list threshold</a> option.</p>
4609
4610<p>Note that at this time the same threshold dithering map is used for all
4611color channels, no attempt is made to offset or rotate the map for different
4612channels is made, to create an offset printing effect. Also as the maps are
4613simple threshold levels, the halftone and circle maps will create incomplete
4614circles along the edges of a colored area. Also all the effects are purely
4615on/off boolean effects, without anti-aliasing to make the circles smooth
4616looking. Large dots can be made to look better with a small amount of blurring
4617after being created. </p>
cristy3ed852e2009-09-05 21:47:34 +00004618
4619
4620<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004621 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004622</div>
4623
4624<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>
4625
cristyc54f5d42009-11-27 21:36:31 +00004626<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004627described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4628>-fuzz</a> setting can be used to match and replace colors similar to the one
4629given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004630
cristyb36feb22010-03-26 16:54:37 +00004631<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4632the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004633
cristyb36feb22010-03-26 16:54:37 +00004634<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4635as <a href="#opaque" >-opaque</a> but replaces the matching color with
4636transparency rather than the current <a href="#fill">-fill</a> color setting.
4637To ensure that it can do this it also ensures that the image has an alpha
4638channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4639the new transparent colors, and does not require you to modify the <a
4640href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004641
cristy3ed852e2009-09-05 21:47:34 +00004642
4643<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004644 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004645</div>
4646
4647<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>
4648
4649<p>Choose from these orientations:</p>
4650
4651<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004652 bottom-left
4653 bottom-right
4654 left-bottom
4655 left-top
4656 right-bottom
4657 right-top
4658 top-left
4659 top-right
4660 undefined
cristy3ed852e2009-09-05 21:47:34 +00004661</pre>
4662
cristyd934d102009-10-10 12:55:13 +00004663<p>To print a complete list of orientations, use the <a href="#list" >-list
4664orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004665
4666
4667<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004668 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004669 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4670 +page
4671 </h4>
4672</div>
4673
4674<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>
4675
4676<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>
4677
4678<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>
4679
4680<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>
4681<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4682<thead>
4683 <tr valign="top">
4684 <th align="center"><em class="arg">media</em></th>
4685 <th align="center"><em class="arg">width</em></th>
4686 <th align="center"><em class="arg">height</em></th>
4687 </tr>
4688</thead>
4689<tbody>
4690<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4691<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4692<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4693<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4694<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4695<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4696<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4697<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4698<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4699<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4700<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4701<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4702<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4703<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4704<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4705<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4706<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4707<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4708<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4709<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4710<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4711<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4712<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4713<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4714<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4715<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4716<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4717<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4718<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4719<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4720<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4721<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4722<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4723<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4724<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4725<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4726<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4727<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4728</tbody>
4729</table>
4730
4731
4732
4733
4734<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>
4735
4736<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>
4737
4738<p>The default page dimensions for a TEXT image is 612x792.</p>
4739
4740<p>This option is used in concert with <a href="#density">-density</a>.</p>
4741
4742<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4743
4744<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004745 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004746</div>
4747
4748<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>
4749
4750<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>
4751
4752<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004753 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004754
4755<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>
4756
4757<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004758 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004759</div>
4760
4761<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>
4762
4763<p>Pause for the specified number of seconds before repeating the animation.</p>
4764
4765<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004766 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004767</div>
4768
4769<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Pause between snapshots.</td><td style='text-align:right;'>[<a href="../www/import.html">import</a>]</td></tr></table>
4770
4771<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4772
4773<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004774 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004775</div>
4776
4777<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>efficiently determine image characteristics.</td><td style='text-align:right;'></td></tr></table>
4778
4779<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004780 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004781</div>
4782
4783<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>
4784
4785<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004786 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004787</div>
4788
4789<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>
4790
4791<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4792
4793<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004794 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004795</div>
4796
4797<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>reduce the image to a limited number of color levels.</td><td style='text-align:right;'></td></tr></table>
4798
4799<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004800 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004801</div>
4802
4803<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>
4804
4805<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004806 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004807</div>
4808
4809<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>
4810
4811<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>
4812
4813<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004814 Rotate Shear Roll Hue
4815 Saturation Brightness Gamma Spiff
4816 Dull Grayscale Quantize Despeckle
4817 ReduceNoise Add Noise Sharpen Blur
4818 Threshold EdgeDetect Spread Shade
4819 Raise Segment Solarize Swirl
4820 Implode Wave OilPaint CharcoalDrawing
4821 JPEG
cristy3ed852e2009-09-05 21:47:34 +00004822</pre>
4823
4824<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4825
4826<p>The default preview is <kbd>JPEG</kbd>.</p>
4827
4828<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004829 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004830</div>
4831
4832<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>
4833
4834<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004835 <h4><a id="process"></a>-process <em class="arg">command</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004836</div>
4837
4838<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>
4839
4840<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>
4841
4842<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004843 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004844 +profile <em class="arg">profile_name</em></h4>
4845</div>
4846
4847<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>
4848
4849<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>
4850
4851<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>
4852
4853<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>
4854
4855<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>
4856
4857<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4858
4859<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4860<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>
4861
4862<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>
4863<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4864CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4865</p>
4866
cristyf7964272011-01-30 03:49:12 +00004867<p>The <a href="#profile">-profile</a> option can also be used to inject
4868previously-formatted ancillary chunks into the output PNG file, using
4869the commandline option as shown below or by setting the profile via a
cristy2bd2a982011-02-15 00:52:58 +00004870programming interface:</p>
cristyf7964272011-01-30 03:49:12 +00004871
cristy2dcd6822011-06-13 16:21:20 +00004872<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -profile PNG-chunk-x:&lt;filename&gt; out.png</span></p>
cristy2bd2a982011-02-15 00:52:58 +00004873<p>where <em>x</em> is a location flag and
cristyf7964272011-01-30 03:49:12 +00004874<em class="arg">filename</em> is a file containing the chunk
4875name in the first 4 bytes, then a colon (":"), followed by the chunk data.
4876This encoder will compute the chunk length and CRC, so those must not
cristy2bd2a982011-02-15 00:52:58 +00004877be included in the file.</p>
cristyf7964272011-01-30 03:49:12 +00004878
cristy2bd2a982011-02-15 00:52:58 +00004879<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
cristyf7964272011-01-30 03:49:12 +00004880or "e" (end, i.e., after IDAT). If you want to write multiple chunks
4881of the same type, then add a short unique string after the "x" to prevent
cristy2bd2a982011-02-15 00:52:58 +00004882subsequent profiles from overwriting the preceding ones, e.g.,</p>
cristyf7964272011-01-30 03:49:12 +00004883
4884
cristy2dcd6822011-06-13 16:21:20 +00004885<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -profile PNG-chunk-b01:file01 / <br/>
4886 -profile PNG-chunk-b02:file02 out.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00004887<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004888 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004889</div>
4890
4891<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>JPEG/MIFF/PNG compression level.</td><td style='text-align:right;'></td></tr></table>
4892
cristy851dbce2010-08-06 21:40:00 +00004893<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and highest compression) to 100 (best quality but least effective compression). The default is to use the estimate quality of your input image otherwise 92. Use the <a href="#sampling-factor">-sampling-factor</a> option to specify the factors for chroma downsampling.</p>
cristy3ed852e2009-09-05 21:47:34 +00004894
4895<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>
4896
cristy851dbce2010-08-06 21:40:00 +00004897<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 +00004898
cristy3c98a4f2010-08-13 20:09:41 +00004899<p>For the MNG and PNG image formats, the quality value sets the zlib compression level (quality / 10) and filter-type (quality % 10). For compression level 0, the Huffman-only strategy is used, which is fastest but not necessarily the worst compression. The default PNG compression is 75.</p>
cristy3ed852e2009-09-05 21:47:34 +00004900
4901<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4902
4903<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004904 0: none
4905 1: sub
4906 2: up
4907 3: average
4908 4: Paeth
cristy3ed852e2009-09-05 21:47:34 +00004909</pre>
4910
4911<p>If filter-type is 5, adaptive filtering is used when quality is greater than 50 and the image does not have a color map, otherwise no filtering is used.</p>
4912
4913<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4914
4915<p>Only if the output is MNG, if filter-type is 7, the LOCO color transformation and adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> are used.</p>
4916
cristy3c98a4f2010-08-13 20:09:41 +00004917<p>The quality setting has no effect on the appearance of PNG and MNG images, since the compression is always lossless.</p>
cristy3ed852e2009-09-05 21:47:34 +00004918
4919<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4920
cristy3ed852e2009-09-05 21:47:34 +00004921<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004922 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004923</div>
4924
cristy3c98a4f2010-08-13 20:09:41 +00004925<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 +00004926
cristy3c98a4f2010-08-13 20:09:41 +00004927<p>This setting defines the colorspace used to sort out and reduce the number
4928of colors needed by an image (for later dithering) by operators such as <a
4929href="#colors" >-colors</a>, Note that color reducion also happens
4930automatically when saving images to color-limited image file formats, such as
4931GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004932
4933
4934<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004935 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004936</div>
4937
4938<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>
4939
4940<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004941 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004942</div>
4943
4944<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>
4945
4946<p>Note that this is actually a rotational blur rather than a radial and as
4947such actually mis-named. </p>
4948
4949<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4950pixels which are outside the image proper are blurred into the final result.
4951</p>
4952
4953
4954<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004955 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004956</div>
4957
4958<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>
4959
4960<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>.
4961</p>
4962
4963<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4964
4965<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004966 <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 +00004967</div>
4968
4969<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>
4970
4971<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004972 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004973</div>
4974
4975<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the red chromaticity primary point.</td><td style='text-align:right;'></td></tr></table>
4976
4977<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004978 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00004979</div>
4980
4981<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Pay attention to warning messages.</td><td style='text-align:right;'></td></tr></table>
4982
4983<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004984 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004985</div>
4986
4987<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>
4988
4989<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4990the given colors are dithered over the image as necessary, otherwise the closest
4991color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4992
4993<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4994images in the current image sequence, all the images will have the same color
4995table. That means that when saved to a file format such as GIF, it will use
4996that color table as a single common or global color table, for all the images,
4997without requiring extra local color tables. </p>
4998
4999<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
5000sequence to use a common color map over all the images. This equivalent to
5001appending all the images together (without extra background colors) and color
5002reducing those images using <a href="#colors">-colors</a> with a 256 color
5003limit, then <a href="#remap">-remap</a> those colors over the original list of
5004images. This ensures all the images follow a single color map. </p>
5005
5006<p>If the number of colors over all the images is less than 256, then <a
5007href="#remap">+remap</a> should not perform any color reduction or dithering, as
5008no color changes are needed. In that case, its only effect is to force the use
5009of a global color table. This recommended after using either <a
5010href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
5011reduce the number of colors in an animated image sequence. </p>
5012
5013<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005014 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005015</div>
5016
5017<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>
5018
5019<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>
5020
5021<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>
5022
5023<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005024 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00005025</div>
5026
5027<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>
5028
5029<p>The only command recognized is the name of an image file to load.</p>
5030
5031<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>
5032
5033<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005034 <h4><a id="render"></a>-render</h4>
cristy3ed852e2009-09-05 21:47:34 +00005035</div>
5036
5037<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>
5038
5039<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>
5040
5041<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005042<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005043</div>
5044
5045<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>
5046
5047<p>This option is like <a href="#page">-page</a> but acts as an image operator
5048rather than a setting. You can separately set the canvas size or the offset
5049of the image on that canvas by only providing those components. </p>
5050
5051<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>
5052
5053<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
5054offset to move the image relative to its previous position. This useful for
5055animation sequences. </p>
5056
5057<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
5058recalculate the canvas size so the image (at its current offset) will appear
5059completely on that canvas (unless it has a negative offset).</p>
5060
5061<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
5062canvas meta-data from the images. </p>
5063
5064<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
5065directly assign virtual canvas meta-data. </p>
5066
5067
5068<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005069 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005070</div>
5071
5072<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>
5073
5074<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>
5075
5076<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>
5077
5078<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005079 <h4><a id="resize"></a>-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005080</div>
5081
5082<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>
5083
5084<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>
5085
5086<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>
5087
cristy13538962010-02-26 17:53:04 +00005088<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>
5089
cristy4949d522010-03-12 18:41:34 +00005090<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 +00005091<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005092 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00005093</div>
5094
5095<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>settings remain in effect until parenthesis boundary.</td><td style='text-align:right;'></td></tr></table>
5096
5097<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005098 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005099</div>
5100
5101<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>
5102
5103
5104<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005105 <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 +00005106</div>
5107
5108<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>
5109
5110<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>
5111
5112
5113<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005114 <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 +00005115</div>
5116
5117<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>
5118
5119<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>
5120
5121<p>Empty triangles in the corners, left over from rotating the image, are
5122filled with the <kbd>background</kbd> color. </p>
5123
5124<p>See also the <a href="#distort">-distort</a> operator and specifically the
5125'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5126
5127
5128<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005129 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005130</div>
5131
cristyd0bd44a2010-09-24 12:38:11 +00005132<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 +00005133
cristyd0bd44a2010-09-24 12:38:11 +00005134<p>Change the image size simply by directly sampling the pixels original
5135image. When magnifying, pixels are replicated in blocks. When minifying,
5136pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005137
cristyd0bd44a2010-09-24 12:38:11 +00005138<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5139a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5140neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5141avoids all the filter processing of the image. As such it completely ignores
5142the current <a href="#filter">-filter</a> setting. </p>
5143
5144<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5145will be added to the resulting image, though some colors may disappear. </p>
5146
5147<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
5148ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005149
5150
5151<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005152 <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 +00005153</div>
5154
5155<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>
5156
5157<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>
5158
5159<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005160 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005161</div>
5162
cristyd0bd44a2010-09-24 12:38:11 +00005163<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 +00005164
cristyd0bd44a2010-09-24 12:38:11 +00005165<p>Change the image size simply by replacing pixels by averaging pixels
5166together when minifying, or replacing pixels when magnifing. </p>
5167
5168<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5169a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5170faster, as it avoids all the filter processing of the image. As such it
5171completely ignores the current <a href="#filter">-filter</a> setting. </p>
5172
5173<p>If when shrinking (minifying) images the original image is some integer
5174multiple of the new image size, the number of pixels avergaed together to
5175produce the new pixel color is the same across the whole image. This is
5176a special case known as 'binning' and is often used as a method of reducing
5177noise in image such as those generated by digital cameras, especially in low
5178light conditions. </p>
5179
cristy3ed852e2009-09-05 21:47:34 +00005180
5181<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005182 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005183</div>
5184
5185<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>
5186
5187<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5188
5189<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005190 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005191</div>
5192
5193<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the screen to capture.</td><td style='text-align:right;'></td></tr></table>
5194
5195<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>
5196
5197<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005198 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005199</div>
5200
5201<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>
5202
5203<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005204 <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 +00005205</div>
5206
5207<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>
5208
5209<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>
5210
5211<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>
5212
5213<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5214of the color clusters is returned.</p>
5215
5216
5217<div style="margin: auto;">
cristy8b9dd952011-03-21 22:56:18 +00005218 <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 +00005219</div>
5220
cristy3ed852e2009-09-05 21:47:34 +00005221<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>
5222
cristy2e2662a2010-10-09 14:29:37 +00005223<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>
5224
cristy3ed852e2009-09-05 21:47:34 +00005225<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005226 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005227</div>
5228
5229<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>
5230
5231<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005232 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></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%'>simulate a sepia-toned photo.</td><td style='text-align:right;'></td></tr></table>
5236
5237<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5238
5239<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>
5240
cristyd0bda5e2010-09-21 16:22:45 +00005241
5242
cristy3ed852e2009-09-05 21:47:34 +00005243<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005244 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5245 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005246</div>
5247
cristyd0bd44a2010-09-24 12:38:11 +00005248<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 +00005249image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005250
cristyd0bd44a2010-09-24 12:38:11 +00005251<p>This will assign (or modify) specific settings attached to all the images
5252in the current image sequence. Using the <a href="#set">+set</a> form of the
5253option will either remove, or reset that setting to a default state, as
5254appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005255
cristyd0bd44a2010-09-24 12:38:11 +00005256<p>For example, it will modify specific well known image meta-data
5257'attributes' such as those normally overridden by: the options <a
5258href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5259href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5260assigned before the image is read in, by using a <em class="arg">key</em> of
5261the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005262
cristyd0bd44a2010-09-24 12:38:11 +00005263<p>If the given <em class="arg">key</em> does not match a specific known
5264'attribute ', such as shown above, the setting is stored as a a free form
cristy323f35b2011-03-24 23:05:13 +00005265'property' string. Such settings are listed in <a href="#verbose"
cristyd0bda5e2010-09-21 16:22:45 +00005266>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5267</p>
5268
cristyd0bd44a2010-09-24 12:38:11 +00005269<p>This includes string 'properities' that are set by and assigned to images
5270using the options <a href="#comment" >-comment</a>, <a href="#label"
5271>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5272a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5273Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005274
cristyd0bd44a2010-09-24 12:38:11 +00005275<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>
5276<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5277Properties</a> in the defined value. For example:</p>
5278
5279<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>
5280<p>Other well known 'properities' that can be include:
5281'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5282'<kbd>signature</kbd>'. </p>
5283
5284<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5285the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5286see <a href="#repage">-page</a>). However it is designed to provide a finer
5287control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5288option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5289attribute. </p>
5290
5291<p>This option can also associate a colorspace or profile with your image.
5292For example,</p>
5293
5294<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 +00005295<p>Some 'properties' must be defined in a specific way to be used. For
5296example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5297modify the output filename of an image. For example</p>
5298
5299<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>
5300<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5301be saved as a global "Artifact" exactly as if it was set using the <a
cristyf9a6c462011-04-24 14:01:11 +00005302href="#define" >-define</a> option. As such settings are global in scope, they
cristyd0bd44a2010-09-24 12:38:11 +00005303can be used to pass 'attributes' and 'properities' of one specific image,
5304in a way that allows you to use them in a completely different image, even if
5305the original image has long since been modified or destroyed. For example: </p>
5306
5307<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>
5308<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5309a 'artifact' if the given <em class="arg">key</em> does not match an existing
cristy323f35b2011-03-24 23:05:13 +00005310'attribute' or 'property'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005311
5312<p>You can set the attributes of the image registry by prefixing the value
5313with <kbd>registry:</kbd>.</p>
5314
5315
cristy3ed852e2009-09-05 21:47:34 +00005316
5317<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005318 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005319</div>
5320
5321<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>
5322
5323<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>
5324
5325<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005326 <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 +00005327</div>
5328
5329<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>
5330
5331<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005332 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005333id="shared-memory"></a>-shared-memory</h4>
5334</div>
5335
5336<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>
5337
5338<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>
5339
5340<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005341 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005342</div>
5343
5344<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>
5345
5346<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5347
5348<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005349 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005350</div>
5351
5352<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>
5353
5354<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>
5355
5356<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>
5357
5358<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005359 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005360</div>
5361
5362<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>
5363
5364<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>
5365
5366<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>
5367
5368<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>
5369
5370<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>
5371
5372<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>
5373<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>
5374
5375<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5376<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005377 <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 +00005378</div>
5379
5380<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>
5381
5382<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>
5383
5384<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005385 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005386</div>
5387
5388<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>operate silently.</td><td style='text-align:right;'></td></tr></table>
5389
5390<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005391 <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 +00005392</div>
5393
5394<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>
5395
5396<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>
5397
5398<p>For Photo CD images, choose from these sizes:</p>
5399
5400<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005401 192x128
5402 384x256
5403 768x512
5404 1536x1024
5405 3072x2048
cristy3ed852e2009-09-05 21:47:34 +00005406</pre>
5407
cristy3ed852e2009-09-05 21:47:34 +00005408<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005409 <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 +00005410</div>
5411
5412<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>
5413
5414<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>
5415
5416<div style="margin: auto;">
cristy2d67ddd2011-02-13 15:38:23 +00005417 <h4><a id="smush"></a>-smush <em class="arg">offset</em></h4>
5418</div>
5419
5420<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>
5421
5422<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005423 <h4><a id="snaps"></a>-snaps <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005424</div>
5425
5426<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>
5427
5428<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5429
5430<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005431 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005432</div>
5433
5434<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>
5435
5436<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5437
5438<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5439
5440<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005441 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005442 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5443</div>
5444
5445<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>
5446
5447
5448<table class="doc">
5449 <tbody>
5450 <tr valign="top">
5451 <th align="left" style="width: 8%">Method</th>
5452 <th align="left">Description</th>
5453 </tr>
5454
5455 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005456 <td valign="top">barycentric</td>
5457 <td valign="top">three point triangle of color given 3 points.
5458 Giving only 2 points will form a linear gradient between those points.
5459 The gradient generated extends beyond the triangle created by those
5460 3 points. </td>
5461 </tr>
5462
5463 <tr valign="top">
5464 <td valign="top">bilinear</td>
5465 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5466 fall back to barycentric. </td>
5467 </tr>
5468 <tr valign="top">
cristy3ed852e2009-09-05 21:47:34 +00005469 <td valign="top">voronoi</td>
5470 <td valign="top">Simply map each pixel to the to nearest color point
5471 given. The result are polygonal 'cells' of solid color. </td>
5472 </tr>
5473
5474 <tr valign="top">
5475 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005476 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005477 squared. Generating spots of color in a sea of the average of
5478 colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005479 </tr>
5480
5481 <tr valign="top">
cristyacc04882011-05-04 23:03:43 +00005482 <td valign="top">inverse</td>
5483 <td valign="top">Colors points biased on the ratio of inverse distance.
5484 This generates sharper points of color rather than rounded spots of
5485 '<kbd>shepards</kbd>' Generating spots of color in a sea of the
5486 average of colors. </td>
cristy3ed852e2009-09-05 21:47:34 +00005487 </tr>
5488
5489 </tbody>
5490</table>
5491
5492<p>The points are placed according to the images location on the virtual
5493canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5494offset), and do not actually have to exist on the given image, but may be
5495some point beyond the edge of the image. All points are floating point values.
5496</p>
5497
5498<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
cristyacc04882011-05-04 23:03:43 +00005499modified, which means that by default matte/alpha transparency channel is not
5500effected. Typically transparency channel is turned off either before or after
5501the operation. </P>
5502
5503Of course if some color points are transparent to generate a transparent
5504gradient, then the image also requires transparency enabled to store the
5505values. </p>
cristy3ed852e2009-09-05 21:47:34 +00005506
5507<p>All the above methods when given a single point of color will replace all
5508the colors in the image with the color given, regardless of the point. This is
5509logical, and provides an alternative technique to recolor a image to some
5510default value. </p>
5511
5512
5513<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005514 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005515</div>
5516
5517<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>
5518
cristyacc04882011-05-04 23:03:43 +00005519<p>This will add rows and columns of the current <a
5520href="#background">-background</a> color into the given image according to the
5521given <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
5522image into four quadrants, separating them by the inserted rows and columns.
5523</P>
5524
5525If a dimension of geometry is zero no rows or columns will be added for that
5526dimension. Similarly using a zero offset with the appropriate <a
5527href="#gravity">-gravity</a> setting will add rows and columns to the edges of
5528the image, padding the image only along that one edge. Edge padding is what <a
5529href="#splice">-splice</a> is most commonly used for. </p>
5530
5531<p>If the exact same <em class="arg">geometry</em> and <a
5532href="#gravity">-gravity</a> is later used with <a href="#chop">-chop</a> the
5533added added all splices removed. </p>
cristy3ed852e2009-09-05 21:47:34 +00005534
5535<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005536 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005537</div>
5538
5539<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>
5540
5541<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>
5542
5543<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00005544 <h4><a id="statistic"></a>-statistic <em class="arg">type</em> <em class="arg">geometry</em></h4>
cristyb52981c2011-03-19 17:09:31 +00005545</div>
5546
5547<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>
5548
5549<p>Choose from these statistic types:</p>
5550<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005551 Gradient maximum difference in area
5552 Maximum maximum value per channel in neighborhood
5553 Minimum minimum value per channel in neighborhood
5554 Mean average value per channel in neighborhood
5555 Median median value per channel in neighborhood
5556 Mode mode (most frequent) value per channel in neighborhood
5557 Nonpeak value just before or after the median value per channel in neighborhood
cristyb52981c2011-03-19 17:09:31 +00005558</pre>
5559
5560<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005561 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005562</div>
5563
5564<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>
5565
5566<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>
5567
5568<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005569 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</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%'>composite two images to create a stereo anaglyph.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5573
5574<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>
5575
5576<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005577 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005578</div>
5579
5580<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>
5581
5582<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005583 char unsigned characters
5584 double doubles
5585 float floats
5586 integer integers
5587 long longs
5588 quantum pixels in the native depth of your ImageMagick distribution
5589 short unsigned shorts
cristy3ed852e2009-09-05 21:47:34 +00005590</pre>
5591
5592<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5593values range from 0 to the maximum value the storage type can support.</p>
5594
5595<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005596 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005597</div>
5598
5599<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>
5600
5601<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>
5602
5603<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005604 Any
5605 Condensed
5606 Expanded
5607 ExtraCondensed
5608 ExtraExpanded
5609 Normal
5610 SemiCondensed
5611 SemiExpanded
5612 UltraCondensed
5613 UltraExpanded
cristy3ed852e2009-09-05 21:47:34 +00005614</pre>
5615
5616<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5617
5618<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>
5619
5620<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005621 <h4><a id="strip"></a>-strip</h4>
cristy3ed852e2009-09-05 21:47:34 +00005622</div>
5623
5624<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>strip the image of any profiles or comments.</td><td style='text-align:right;'></td></tr></table>
5625
5626<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005627 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005628</div>
5629
5630<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>
5631
5632<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5633
5634<p>See <a href="#draw">-draw</a> for further details.</p>
5635
5636<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005637 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005638</div>
5639
5640<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>
5641
5642<p>See <a href="#draw">-draw</a> for further details.</p>
5643
5644<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005645 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005646</div>
5647
5648<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>
5649
cristy71a3f602010-09-15 12:38:16 +00005650<p>This setting suggests a font style that ImageMagick should try to apply to
5651the currently selected font family. Select <em class="arg">fontStyle</em> from
5652the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005653
5654<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005655 Any
5656 Italic
5657 Normal
5658 Oblique
cristy3ed852e2009-09-05 21:47:34 +00005659</pre>
5660
5661<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>
5662
5663<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005664 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005665</div>
5666
cristyd4d64ed2010-08-22 22:19:33 +00005667<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>
5668
cristy71a3f602010-09-15 12:38:16 +00005669<p>This option is required to have compare search for the best match location
5670of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005671(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005672be the "match score" image.</p>
5673
cristyd0bd44a2010-09-24 12:38:11 +00005674<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005675position of the top-left corner of the given sub-image. that is its size will
5676be the size of the larger_image - sub_image + 1. The brightest location in
5677this image is the location s the locate on the best match that is also
5678reported. Note that this may or may nor be a perfect match, and the actual
5679brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005680possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005681
cristyd0bda5e2010-09-21 16:22:45 +00005682<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005683location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005684sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005685
cristyae6203d2010-08-09 01:12:14 +00005686
5687<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005688 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005689</div>
5690
5691<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>
5692
cristy71a3f602010-09-15 12:38:16 +00005693<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5694images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5695the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005696
5697<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005698 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005699</div>
5700
5701<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>
5702
5703<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5704
5705<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005706 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005707</div>
5708
5709<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>
5710
5711<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005712 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005713</div>
5714
cristy5063d812010-10-19 16:28:10 +00005715<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 +00005716
5717<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005718 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005719</div>
5720
5721<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>
5722
5723<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>
5724
5725<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>
5726
5727<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005728 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005729</div>
5730
5731<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>
5732
5733<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005734 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005735</div>
5736
5737<!-- {<em class="arg">green,blue,opacity</em>}
5738<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>
5739-->
5740
5741<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>
5742
5743<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>
5744
5745<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.
5746</p>
5747
5748<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>
5749
5750<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5751<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>
5752
5753
5754<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>
5755<p>Note that the values of the transparency channel is treated as 'matte'
5756values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5757
5758<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>.
5759</p>
5760
5761<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005762 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005763</div>
5764
5765<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Create a thumbnail of the image.</td><td style='text-align:right;'></td></tr></table>
5766
5767<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>
5768
5769<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>
5770
5771<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005772 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005773</div>
5774
5775<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the tile image used for filling a subsequent graphic primitive.</td><td style='text-align:right;'></td></tr></table>
5776
5777<div style="margin: auto;">
5778 <h4>-tile <em class="arg">geometry</em></h4>
5779</div>
5780
5781<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>
5782
5783<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>
5784
5785<div style="margin: auto;">
5786 <h4>-tile</h4>
5787</div>
5788
5789<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>
5790
5791<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005792 <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 +00005793</div>
5794
5795<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>
5796
5797<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>
5798
5799<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>
5800
5801<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005802 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005803</div>
5804
5805<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>
5806
5807<p>Tint the image with the fill color.</p>
5808
5809<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>
5810
5811<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005812 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005813</div>
5814
5815<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>
5816
5817<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>
5818
5819<p>For example,</p>
5820
5821<p class="crtsnip">
5822 -title "%m:%f %wx%h"
5823</p>
5824
5825<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>
5826
5827
5828<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005829 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005830</div>
5831
5832<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>
5833
5834<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5835
5836<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 +00005837
5838<p>This operator has been now been superseded by the <a
5839href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5840
5841
cristy3ed852e2009-09-05 21:47:34 +00005842<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005843 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005844</div>
5845
5846<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>
5847
5848<p>The <em class="arg">color</em> argument is defined using the format
5849described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5850>-fuzz</a> setting can be used to match and replace colors similar to the one
5851given. </p>
5852
cristyb36feb22010-03-26 16:54:37 +00005853<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5854that is make all non-matching colors transparent. </p>
5855
cristy3ed852e2009-09-05 21:47:34 +00005856<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005857href="#transparent" >-transparent</a> but replaces the matching color with the
5858current <a href="#fill">-fill</a> color setting, rather than transparent.
5859However the <a href="#transparent" >-transparent</a> operator also ensures
5860that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5861>-alpha</a> set</kbd>", and does not require you to modify the <a
5862href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005863
cristyb36feb22010-03-26 16:54:37 +00005864<p>Note that this does not define the color as being the 'transparency color'
5865used for color-mapped image formats, such as GIF. For that use <a
5866href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005867
5868
5869<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005870 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005871</div>
5872
5873<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>
5874
5875<p>Sometimes this is used for saving to image formats such as
5876GIF and PNG8 which uses this color to represent boolean transparency. This
5877does not make a color transparent, it only defines what color the transparent
5878color is in the color palette of the saved image. Use <a
5879href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5880
5881<p>This option allows you to have both an opaque visible color, as well as a
5882transparent color of the same color value without conflict. That is, you can
5883use the same color for both the transparent and opaque color areas within an
5884image. This, in turn, frees to you to select a transparent color that is
5885appropriate when an image is displayed by an application that does not handle a
5886transparent color index, while allowing ImageMagick to correctly handle images of this
5887type. </p>
5888
5889<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5890
5891<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005892 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005893</div>
5894
5895<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>
5896
5897<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5898</p>
5899
5900<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005901 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005902</div>
5903
5904<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Mirror the image along the images bottom-left top-right diagonal. Equivalent to the operations <kbd>-flop -rotate 90</kbd>.</td><td style='text-align:right;'></td></tr></table>
5905
5906
5907<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005908 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005909</div>
5910
5911<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>
5912
5913<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>
5914
5915<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>
5916
5917<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>
5918
5919<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005920 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00005921</div>
5922
5923<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>
5924
5925<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>
5926
5927<p>The page or virtual canvas information of the image is preserved allowing
5928you to extract the result of the <a href="#trim">-trim</a> operation from the
5929image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5930information if it is unwanted.</p>
5931
5932<p>If the trimmed image 'disappears' an warning is produced, and a special
5933single pixel transparent 'missed' image is returned, in the same way as when a
5934<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5935
5936
5937<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005938 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005939</div>
5940
5941<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 +00005942 <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 +00005943
5944<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>
5945
5946<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5947<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>
5948
5949<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5950
5951<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005952 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005953</div>
5954
5955<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set the color of the annotation bounding box.</td><td style='text-align:right;'></td></tr></table>
5956
5957<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5958
5959<p>See <a href="#draw">-draw</a> for further details.</p>
5960
5961
5962<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005963 <h4><a id="update"></a>-update <em class="arg">seconds</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%'>detect when image file is modified and redisplay.</td><td style='text-align:right;'></td></tr></table>
5967
5968<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>
5969
5970
5971<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005972 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00005973</div>
5974
5975<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>discard all but one of any pixel color.</td><td style='text-align:right;'></td></tr></table>
5976
5977
5978<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005979 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005980</div>
5981
5982<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the units of image resolution.</td><td style='text-align:right;'></td></tr></table>
5983
5984<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>
5985
5986
5987<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005988 <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 +00005989</div>
5990
5991<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>
5992
5993<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>
5994
5995<p>The parameters are:</p>
5996
5997<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005998 radius The radius of the Gaussian, in pixels, not counting the center
5999 pixel (default 0).
6000 sigma The standard deviation of the Gaussian, in pixels (default 1.0).
6001 amount The fraction of the difference between the original and the blur
6002 image that is added back into the original (default 1.0).
6003 threshold The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
6004 difference amount (default 0.05).
cristy3ed852e2009-09-05 21:47:34 +00006005</pre>
6006
6007
6008<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006009 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00006010</div>
6011
cristyd0bda5e2010-09-21 16:22:45 +00006012<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 +00006013
6014
6015<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006016 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00006017</div>
6018
6019<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>print ImageMagick version string and exit.</td><td style='text-align:right;'></td></tr></table>
6020
6021
6022<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006023 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006024</div>
6025
6026<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>FlashPix viewing parameters.</td><td style='text-align:right;'></td></tr></table>
6027
6028
6029<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006030 <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 +00006031</div>
6032
6033<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>
6034
6035
6036<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006037 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006038</div>
6039
6040<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>
6041
6042<p>This option defines what color source should be used if and when a color
6043lookup completely 'misses' the source image. The color(s) that appear to
6044surround the source image. Generally this color is derived from the source
6045image, but could also be set to a specify background color. </p>
6046
6047<p>Choose from these methods:</p>
6048
6049<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006050 background the area surrounding the image is the background color
6051 black the area surrounding the image is black
6052 checker-tile alternate squares with image and background color
6053 dither non-random 32x32 dithered pattern
6054 edge extend the edge pixel toward infinity
6055 gray the area surrounding the image is gray
6056 horizontal-tile horizontally tile the image, background color above/below
6057 horizontal-tile-edge horizontally tile the image and replicate the side edge pixels
6058 mirror mirror tile the image
6059 random choose a random pixel from the image
6060 tile tile the image (default)
6061 transparent the area surrounding the image is transparent blackness
6062 vertical-tile vertically tile the image, sides are background color
6063 vertical-tile-edge vertically tile the image and replicate the side edge pixels
6064 white the area surrounding the image is white
cristy3ed852e2009-09-05 21:47:34 +00006065</pre>
6066
6067<p>The default value is "edge".</p>
6068
6069<p>This most important for distortion operators such as <a href="#distort"
6070>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
6071However it also effects operations that may access pixels just outside the
6072image proper, such as <a href="#convolve">-convolve</a>, <a
6073href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
6074
6075<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
6076
6077
6078<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006079 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006080</div>
6081
6082<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>
6083
6084<p>Choose from these visual classes:</p>
6085
6086<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00006087 StaticGray
6088 GrayScale
6089 StaticColor
6090 PseudoColor
6091 TrueColor
6092 DirectColor
6093 default
6094 visual id
cristy3ed852e2009-09-05 21:47:34 +00006095</pre>
6096
6097<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>
6098
6099
6100<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006101 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00006102 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
6103</div>
6104
6105<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
6106saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
6107
6108<p>Take a grayscale image (with alpha mask) and modify the destination image's
6109brightness according to watermark image's grayscale value and the <em
6110class="arg">brightness</em> percentage. The destinations color saturation
6111attribute is just direct modified by the <em class="arg">saturation</em>
6112percentage, which defaults to 100 percent (no color change). </p>
6113
6114
6115<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006116 <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 +00006117</div>
6118
6119<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>
6120
6121<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
6122
6123<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006124 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006125</div>
6126
6127<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>
6128
6129<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>
6130
6131<table class="doc">
6132 <col width="25%" />
6133 <col width="75%" />
6134 <thead>
6135 <tr>
6136 <th><em class="arg">fontWeight</em></th>
6137 <th>Description</th>
6138 </tr>
6139 </thead>
6140 <tbody>
6141 <tr><td>All </td> <td>No effect. </td></tr>
6142 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
6143 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
6144 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
6145 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
6146 </tbody>
6147 </table>
6148
6149<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
6150
6151<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>
6152
6153<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006154 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006155</div>
6156
6157<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>
6158
6159<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006160 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006161</div>
6162
cristy5cadd612009-09-21 19:33:41 +00006163<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>
6164
6165<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.
6166</p>
cristy3ed852e2009-09-05 21:47:34 +00006167
6168<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006169 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006170</div>
6171
6172<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>
6173
6174<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>
6175
6176<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>
6177
6178<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>
6179
6180<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006181 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006182</div>
6183
6184<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>
6185
6186<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006187 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006188</div>
6189
6190<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>
6191 <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>
6192
6193<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006194</div>
6195</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006196
6197</div>
6198
6199<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006200 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006201 <span id="linkbar-center">
6202 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006203 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006204 </span>
6205 <span id="linkbar-east">&nbsp;</span>
6206 </div>
6207 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +00006208 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006209 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6210 </div>
6211 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006212 <script type="text/javascript">
6213 var _gaq = _gaq || [];
6214 _gaq.push(['_setAccount', 'UA-17690367-1']);
6215 _gaq.push(['_trackPageview']);
6216
6217 (function() {
6218 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6219 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6220 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6221 })();
6222 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006223</body>
6224</html>