blob: 6b6ed8595c3e51aebb62a287771eeb448fb587ce [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"/>
cristyaf8d6652011-02-04 21:57:45 +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."/>
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"/>
23 <meta name="Keywords" content="command-line, options, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
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">
cristyda16f162011-02-19 23:52:17 +000095 <a title="Binary Release: iPhone" href="../www/binary-releases.html#iPhone">iPhone</a>
96</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">
cristy83a272e2010-05-07 20:40:35 +0000160 <a 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">
cristy45dbd322011-03-27 16:40:38 +0000167 <a title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
168</div>
169<div class="sponsor">
cristy4c54bbb2011-03-17 13:53:13 +0000170 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
171</div>
172<div class="sponsor">
cristybe3c5be2011-03-05 17:35:07 +0000173 <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
174</div>
175<div class="sponsor">
cristy45dbd322011-03-27 16:40:38 +0000176 <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201107010090 alexanian media -->
cristyaf8d6652011-02-04 21:57:45 +0000177</div>
178<div class="sponsor">
cristyee742642011-02-26 02:49:59 +0000179 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy7d52cd62010-10-01 17:26:59 +0000180</div>
181<div class="sponsor">
cristyee742642011-02-26 02:49:59 +0000182 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
183</div>
184<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000185 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
186</div>
cristyec6b4752011-01-08 03:16:23 +0000187<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000188 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
189</div>
190<div class="sponsor">
cristye9a32c32011-04-07 01:11:05 +0000191 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011080100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000192</div>
cristy3ed852e2009-09-05 21:47:34 +0000193</div>
194</div>
cristyce69bb02010-07-27 19:49:46 +0000195</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000196
cristyce69bb02010-07-27 19:49:46 +0000197<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000198
cristy3eaa0ef2010-03-06 20:35:26 +0000199</div>
200
201<div class="main">
202
cristydcca3fa2010-12-29 21:50:07 +0000203<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000204<p class="navigation-index">
cristy8b9dd952011-03-21 22:56:18 +0000205[ <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 +0000206
cristydcca3fa2010-12-29 21:50:07 +0000207<div class="doc-section">
208
cristyb36feb22010-03-26 16:54:37 +0000209<p>Below is list of command-line options recognized by the ImageMagick <a
210href="../www/command-line-tools.html">command-line
211tools</a>. If you want a description of a particular option, click on the
212option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000213otherwise 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 +0000214
215<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000216 <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 +0000217</div>
218
219<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 +0000220<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>
221
222<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000223 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000224</div>
225
226<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>
227
228<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>
229
230<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000231 <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 +0000232</div>
233
234<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>
235
236<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>
237
238<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000239 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000240</div>
241
242<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>
243
cristy30092792011-02-22 02:06:14 +0000244<p>This option is enabled by default. An attempt is made to save all images of
245an image sequence into the given output file. However, some formats, such as
246JPEG and PNG, do not support more than one image per file, and in that case
247ImageMagick is forced to write each image as a separate file. As such, if
248more than one image needs to be written, the filename given is modified by
249adding a <a href="#scene">-scene</a> number before the suffix, in order to
250make distinct names for each image. </p>
cristy3ed852e2009-09-05 21:47:34 +0000251
cristy30092792011-02-22 02:06:14 +0000252<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written to
253separate files, whether or not the file format allows multiple images per file
254(for example, GIF, MIFF, and TIFF). </p>
cristy3ed852e2009-09-05 21:47:34 +0000255
cristy30092792011-02-22 02:06:14 +0000256<p>Including a C-style integer format string in the output filename will
257automagically enable <a href="#adjoin">+adjoin</a> and are used to specify
258where the <a href="#scene">-scene</a> number is placed in the filenames. These
259strings, such as '<kbd>%d</kbd>' or '<kbd>%03d</kbd>', are familiar to those
260who have used the standard <kbd>printf()</kbd>' C-library function. As an
261example, the command</p>
cristy3ed852e2009-09-05 21:47:34 +0000262
263<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 +0000264<p>will create a sequence of 17 images (the two given plus 15 more created by
265<a href="#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
266my02morph.jpg, ..., my16morph.jpg. </p>
cristy3ed852e2009-09-05 21:47:34 +0000267
cristy30092792011-02-22 02:06:14 +0000268<p>In summary, ImageMagick tries to write all images to one file, but will
269save to multiple files, if any of the following conditions exist...
270<ol>
271<li>the output image's file format does not allow multi-image files,
272<li>the <a href="#adjoin">+adjoin</a> option is given, or
273<li>a printf() integer format string (eg: "%d") is present in the output
274 filename.
275</ol></p>
cristy3ed852e2009-09-05 21:47:34 +0000276
277
278<div style="margin: auto;">
cristy30092792011-02-22 02:06:14 +0000279 <h4><a id="affine"></a>-affine
280 <em class="arg">s<sub>x</sub></em>,<em class="arg">r<sub>x</sub></em>,<em
281 class="arg">r<sub>y</sub></em>,<em class="arg">s<sub>y</sub></em>[,<em
cristye9a32c32011-04-07 01:11:05 +0000282 class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000283</div>
284
285<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>
286
cristy30092792011-02-22 02:06:14 +0000287<p>This option sets a transformation matrix, for use by subsequent <a
288href="#draw">-draw</a> or <a href="#transform">-transform</a> options. </p>
cristy3ed852e2009-09-05 21:47:34 +0000289
cristy30092792011-02-22 02:06:14 +0000290<p>The matrix entries are entered as comma-separated numeric values either in
291quotes or without spaces. </p>
cristy3ed852e2009-09-05 21:47:34 +0000292
cristy30092792011-02-22 02:06:14 +0000293<p>Internally, the transformation matrix has 3x3 elements, but three of them
294are omitted from the input because they are constant. The new (transformed)
295coordinates (<em class="arg">x'</em>, <em class="arg">y'</em>) of a pixel at
296position (<em class="arg">x</em>, <em class="arg">y</em>) in the original
297image are calculated using the following matrix equation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000298
299<div class="eqn">
300<img alt="affine transformation" src="../images/affine.png"/>
301</div>
302
cristy30092792011-02-22 02:06:14 +0000303<p> The size of the resulting image is that of the smallest rectangle that
304contains the transformed source image. The parameters <em
305class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em>
306subsequently shift the image pixels so that those that are moved out of the
307image area are cut off.</p>
cristy3ed852e2009-09-05 21:47:34 +0000308
cristy30092792011-02-22 02:06:14 +0000309<p>The transformation matrix complies with the left-handed pixel coordinate
310system: positive <em class="arg">x</em> and <em class="arg">y</em> directions
311are rightward and downward, resp.; positive rotation is clockwise.</p>
cristy3ed852e2009-09-05 21:47:34 +0000312
cristy30092792011-02-22 02:06:14 +0000313<p> If the translation coefficients <em class="arg">t<sub>x</sub></em> and <em
314class="arg">t<sub>y</sub></em> are omotted they default to 0,0. Therefore,
315four parameters suffice for rotation and scaling without translation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000316
cristy30092792011-02-22 02:06:14 +0000317<p>Scaling by the factors <em class="arg">s<sub>x</sub></em> and <em
318class="arg">s<sub>y</sub></em> in the <em>x</em> and <em>y</em> directions,
319respectively, is accomplished with the following.</p>
320
321<p>See <a href="#transform">-transform</a>, and the <a
322href="#distort">-distort</a> method '<kbd>Affineprojection</kbd> for more
323information </p>
324
cristy3ed852e2009-09-05 21:47:34 +0000325
326<p class="crtsnip">
327 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
328</p>
329
330<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>
331
332<p class="crtsnip">
333 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
334</p>
335
336<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
337<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
338
339<p class="crtsnip">
340 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
341</p>
342
343<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>
344
345<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>
346
347<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000348 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000349</div>
350
351<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>
352
353<p>Used to set a flag on an image indicating whether or not to use existing alpha
354channel 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>
355
356
357<table class="doc">
358 <tbody>
359 <tr valign="top">
360 <th align="left" style="width: 8%">type</th>
361 <th align="left">Description</th>
362 </tr>
363
364 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000365 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000366 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000367 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
368 should be used instead of this, unless you specifically need to
369 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
370 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000371
372 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000373 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000374 <td valign="top">
375 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000376 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000377
378 <tr valign="top">
379 <td valign="top"><kbd>Set</kbd></td>
380 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000381 Activates the alpha/matte channel. If it was previously turned off
382 then it also resets the channel to opaque. If the image already had
383 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000384
385 <tr valign="top">
386 <td valign="top"><kbd>Opaque</kbd></td>
387 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000388 Enables the alpha/matte channel and forces it to be fully opaque.
389 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000390
391 <tr valign="top">
392 <td valign="top"><kbd>Transparent</kbd></td>
393 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000394 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000395 transparent. This effectively creates a fully transparent image the
396 same size as the original and with all its original RGB data still
397 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000398
399 <tr valign="top">
400 <td valign="top"><kbd>Extract</kbd></td>
401 <td valign="top">
402 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000403 '<kbd>Off</kbd>' the the image's transparency, so as to generate
404 a gray-scale mask of the image's shape. The alpha channel data is left
405 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
406 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000407
408 <tr valign="top">
409 <td valign="top"><kbd>Copy</kbd></td>
410 <td valign="top">
411 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000412 gray-scale intensity of the image, into the alpha channel, converting
413 a gray-scale mask into a transparent shaped mask ready to be colored
414 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000415
416 <tr valign="top">
417 <td valign="top"><kbd>Shape</kbd></td>
418 <td valign="top">
419 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000420 the current background color. That is the RGB color channels is
421 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000422 </td></tr>
423
424 <tr valign="top">
425 <td valign="top"><kbd>Background</kbd></td>
426 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000427 Set any fully-transparent pixel to the background color, while leaving
428 it fully-transparent. This can make some image file formats, such as
429 PNG, smaller as the RGB values of transparent pixels are more uniform,
430 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000431 </td></tr>
432 </tbody>
433</table>
434
435<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000436"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000437>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000438Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000439
440
441<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000442 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000443 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
444 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
445 -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>
446</div>
447
448<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>
449
450<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>
451
452
453<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>
454
455<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>
456
457<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>
458<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
459
460<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>
461
462<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>
463
464<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000465 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000466</div>
467
468<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
469drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
470
471<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
472drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
473antialiasing edge pixels. This will then reduce the number of colors added to
474an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000475are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000476
477<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000478 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000479</div>
480
481<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>
482
483<p>This option creates a single longer image image, by joining all the current
484images in sequence top-to-bottom. Use <a href="#append">+append</a> to
485stack images left-to-right. </p>
486
487<p>If they are not of the same width, narrower images are padded with the
488current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000489position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000490href="#gravity">-gravity</a> setting. </p>
491
492
493<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000494 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000495</div>
496
497<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>
498
499
500<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000501 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000502</div>
503
504<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>
505
506<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>
507
508<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
509
cristyd934d102009-10-10 12:55:13 +0000510
511
cristy3ed852e2009-09-05 21:47:34 +0000512<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000513 <h4><a id="auto-gamma"></a>-auto-gamma</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%'>Automagically adjust gamma level of image.</td><td style='text-align:right;'></td></tr></table>
517
cristyd934d102009-10-10 12:55:13 +0000518<p>This calculates the mean values of an image, then applies a calculated <a
519href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
520image it will get a have a value of 50%. </p>
521
cristyd0bd44a2010-09-24 12:38:11 +0000522<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000523
524<p>This works well for real-life images with little or no extreme dark and
525light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000526dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000527</p>
528
529<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000530'<em>sync</em>' flag for channel syncronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000531values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000532>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000533together by the same gamma value, preserving colors. </p>
534
535
536
cristy3ed852e2009-09-05 21:47:34 +0000537<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000538 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000539</div>
540
541<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>
542
cristyd934d102009-10-10 12:55:13 +0000543<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000544minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000545href="#level" >-level</a> operator to stretch the values to the full range of
546values. </p>
547
cristy83543962009-10-16 19:04:28 +0000548<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000549JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
550for the <a href="#level" >-level</a> operation. On the other hand it is the
551right operator to use for color stretching gradient images being used to
552generate Color lookup tables, distortion maps, or other 'mathematically'
553defined images. </p>
554
555<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
556href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
557>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
558problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000559>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000560
561<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000562special '<em>sync</em>' flag for channel syncronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000563which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000564href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
565'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000566together by the same gamma value, preserving colors, and ignoring
567transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000568
569
cristy3ed852e2009-09-05 21:47:34 +0000570<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000571 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000572</div>
573
574<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>
575
cristy83543962009-10-16 19:04:28 +0000576<p>This operator reads and resets the EXIF image profile setting 'Orientation'
577and then performs the appropriate 90 degree rotation on the image to orient
578the image, for correct viewing. </p>
579
580<p>This EXIF profile setting is usually set using a gravity sensor in digital
581camara, however photos taken directly downward or upward may not have an
582appropriate value. Also images that have been orientation 'corrected' without
583reseting this setting, may be 'corrected' again resulting in a incorrect
584result. If the he EXIF profile was previously stripped, the <a
585href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
586
587
cristy3ed852e2009-09-05 21:47:34 +0000588<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000589 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000590</div>
591
592<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Average a set of images.</td><td style='text-align:right;'></td></tr></table>
593
594<p>An error results if the images are not identically sized.</p>
595
cristy3ed852e2009-09-05 21:47:34 +0000596
597<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000598 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000599</div>
600
601<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>
602
603<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>
604
605<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000606 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000607</div>
608
609<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>
610
611<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>
612
613<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000614 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000615</div>
616
617<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>
618
cristye6378132009-10-26 20:05:17 +0000619<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 +0000620
cristye6378132009-10-26 20:05:17 +0000621<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>
622<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 +0000623
624<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000625 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000626</div>
627
628<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Add bias when convolving an image.</td><td style='text-align:right;'></td></tr></table>
629
630<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>
631
632<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>
633
634<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
635negative results without clipping to the color value range
636(0..QuantumRange).</p>
637
638<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +0000639<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 +0000640</p>
641
642<div style="margin: auto;">
cristy37e0dfd2011-03-06 16:35:34 +0000643 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000644</div>
645
646<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Use black point compensation.</td><td style='text-align:right;'></td></tr></table>
647
648<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000649 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000650</div>
651
cristy5cadd612009-09-21 19:33:41 +0000652<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>
653
654<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.
655</p>
cristy3ed852e2009-09-05 21:47:34 +0000656
657
658<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000659 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000660</div>
661
cristy83a272e2010-05-07 20:40:35 +0000662<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 +0000663
664<p>Blend will average the images together ('plus') according to the
665percentages given and each pixels transparency. If only a single percentage
666value is given it sets the weight of the composite or 'source' image, while
667the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000668<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
669'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000670
671
672<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000673 <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 +0000674</div>
675
676<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>
677
678<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000679 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000680</div>
681
682<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>
683
684<div style="margin: auto;">
685
686<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000687 <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 +0000688</div>
689
690<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>
691
cristyb15553d2010-07-03 22:53:14 +0000692<p>Convolve the image with a Gaussian or normal distribution using the given
693<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000694
695<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
696</div>
697
cristyb15553d2010-07-03 22:53:14 +0000698<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000699determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000700
cristyb15553d2010-07-03 22:53:14 +0000701<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000702array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000703integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000704radius that will provide meaningful results for the Gaussian distribution.
705</p>
706
707<p>The larger the <em class="arg" >Radius</em> the radius the slower the
708operation is. However too small a <em class="arg" >Radius</em>, and sever
709aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
710should be at least twice the <em class="arg" >Sigma</em> value, though three
711times will produce a more accurite result. </p>
712
713<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
714by taking advantage of the separability properties of the distribution. Here
715we apply a single-dimensional Gaussian matrix in the horizontal direction,
716then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000717
718<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
719pixels which are outside the image proper are blurred into the final result.
720</p>
721
722
723<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000724 <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 +0000725</div>
726
727<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>
728
729<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
730Average (EWA) of the source image, scaled according to the grayscale
731mapping. </p>
732
733<p>The ellipse is weighted with sigma set to the given <em class="arg"
734>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
735defaults to the <em class="arg" >Width</em> for a normal circular Guassian
736weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
737horizontal clock-wise. </p>
738
739<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
740pixels which are outside the image proper are blurred into the final result.
741</p>
742
743
744<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000745 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000746</div>
747
748<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>
749
cristybc9539a2010-08-16 18:06:20 +0000750<p>Set the width and height using the <em class="arg">size</em> portion of the
751<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
752ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000753
cristybc9539a2010-08-16 18:06:20 +0000754<p>Set the border color by preceding with the <a
755href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000756
cristybc9539a2010-08-16 18:06:20 +0000757<p>The <a href="#border">-border</a> operation is affected by the current <a
758href="#compose">-compose</a> setting and assumes that this is using the default
759'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
760size colors by the current <a href="#bordercolor">-bordercolor</a> before
761overlaying the original image in the center of this net image. This means that
762with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000763be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000764<p>See also the <a href="#frame">-frame</a> option, which has more
765functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000766
767<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000768 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000769</div>
770
771<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>
772
773<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
774
775<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
776
777<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000778 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000779</div>
780
781<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>
782
783<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000784 <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 +0000785</div>
786
787<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>
788
cristyefb2bdb2010-11-20 19:35:22 +0000789<p>Brightness and Contrast values apply changes to the input image. They are
790not absolute settings. A brightness or contrast value of zero means no change.
791The range of values is -100 to +100 on each. Positive values increase the
792brightness or contrast and negative values decrease the brightness or contrast.
793To control only contrast, set the brightness=0. To control only brightness,
794set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000795
cristyefb2bdb2010-11-20 19:35:22 +0000796<p>You may also use <a href="#fill">-channel</a> to control which channels to
797apply the brightness and/or contrast change. The default is to apply the same
798transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000799
cristyefb2bdb2010-11-20 19:35:22 +0000800<p>Brightness and Contrast arguments are converted to offset and slope of a
801linear transform and applied
802using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000803
cristyefb2bdb2010-11-20 19:35:22 +0000804<p>The slope varies from 0 at contrast=-100 to almost vertical at
805contrast=+100. For brightness=0 and contrast=-100, the result are totally
806midgray. For brightness=0 and contrast=+100, the result will approach but
807not quite reach a threshold at midgray; that is the linear transformation
808is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000809
cristyefb2bdb2010-11-20 19:35:22 +0000810<p>Negative slopes, i.e. negating the image, are not possible with this
811function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000812
cristyefb2bdb2010-11-20 19:35:22 +0000813<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
814at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
815totally white. Similarly, when contrast=0 and brightness=-100, the result is
816totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000817
cristyefb2bdb2010-11-20 19:35:22 +0000818<p>As the range of values for the arguments are -100 to +100, adding the '%'
819symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000820
821<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000822 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000823</div>
824
825<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>
826
827<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000828 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000829</div>
830
831<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>
832
cristy71a3f602010-09-15 12:38:16 +0000833<p>This option sets the caption meta-data of an image read in after this
834option has been given. To modify a caption of images already in memory use
835"<kbd><a href="#set">-set</a> caption</kbd>". </p>
836
837<p>The caption can contain special format characters listed in the <a
838href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000839Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000840is finally assigned to the individual images. </p>
841
842<p>If the first character of <em class="arg">string</em> is <em
843class="arg">@</em>, the image caption is read from a file titled by the
844remaining characters in the string. Comments read in from a file are literal;
845no embedded formatting characters are recognized.</p>
846
847<p>Caption meta-data ais not visible on the image itself. To do that use the
848<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
849instead.</p>
850
851<p>For example,</p>
852
853<p class="crtsnip">
854 -caption "%m:%f %wx%h" bird.miff
855</p>
856
857<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
858that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
859480.</p>
860
861
cristy3ed852e2009-09-05 21:47:34 +0000862<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000863 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000864</div>
865
866<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>
867
868<p>Here is an example color correction collection:</p>
869
870<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000871&lt;?xml version="1.0" encoding="UTF-8"?&gt;
872&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
873 &lt;ColorCorrection id="cc06668"&gt;
874 &lt;SOPNode&gt;
875 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
876 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
877 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
878 &lt;/SOPNode&gt;
879 &lt;SATNode&gt;
880 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
881 &lt;/SATNode&gt;
882 &lt;/ColorCorrection&gt;
883&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000884</pre>
885
886<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000887 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000888</div>
889
890<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>
891
cristyefb2bdb2010-11-20 19:35:22 +0000892<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
893<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
894<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
895<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000896
cristy83a272e2010-05-07 20:40:35 +0000897<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000898abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
899'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
900'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000901
cristy83a272e2010-05-07 20:40:35 +0000902For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
903you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000904<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000905 -channel Red,Blue
906</p>
907<p>or you can use the short hand form</p>
908<p class="crtsnip">
909 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000910</p>
911
cristy83a272e2010-05-07 20:40:35 +0000912<p>All the channels that is present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000913special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
914but generally any operators that are generally 'grey-scale' image operators,
915will understand this setting. See individual operator documentation. </p>
916
cristydcca3fa2010-12-29 21:50:07 +0000917<br />
cristy83a272e2010-05-07 20:40:35 +0000918
919<p>On top of the normal channel selection a extra flag can be specified,
920'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000921operators that understand this flag should perform: cross-channel
922syncronization of the channels. If not specified, then most grey-scale
923operators will apply their image processing operations to each individual
924channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000925setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000926
927<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000928<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000929together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000930it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000931independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000932
cristydcca3fa2010-12-29 21:50:07 +0000933<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000934and the <a href="#compose">-compose</a> mathematical methods, also understands
935the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
936to the alpha channel (if present). That is to say it will modify the image
937processing with the understanding that fully-transparent colors should not
938contribute to the final result. </p>
939
cristydcca3fa2010-12-29 21:50:07 +0000940<p>Basically, by default, operators work with color channels in syncronous, and
cristybac7a162010-06-15 19:57:29 +0000941treats transparency as special, unless the <a href="#channel">-channel</a>
942setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
943How each operator does this depends on that operators current implementation.
944Not all operators understands this flag at this time, but that is changing.
945</p>
cristy83a272e2010-05-07 20:40:35 +0000946
947<p>To print a complete list of channel types, use <a href="#list">-list
948channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000949
cristydcca3fa2010-12-29 21:50:07 +0000950<br />
cristyd934d102009-10-10 12:55:13 +0000951
952<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000953'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
954channels except the transparency channel, and that all the color channels are
955to be modified in exactly the same way, with a understanding of transprancy
956(depending on the operation being applied). The 'plus' form <a
957href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000958
959<p>Options that are affected by the <a href="#channel" >-channel</a> setting
960include the following.
961
962<a href="#auto-gamma">-auto-gamma</a>,
963<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000964<a href="#black-threshold">-black-threshold</a>,
965<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000966<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000967<a href="#clut">-clut</a>,
968<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000969<a href="#composite">-composite</a> (Mathematical compose methods only),
970<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000971<a href="#contrast-stretch">-contrast-stretch</a>,
972<a href="#evaluate">-evaluate</a>,
973<a href="#function">-function</a>,
974<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000975<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000976<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000977<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000978<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000979<a href="#negate">-negate</a>,
980<a href="#normalize">-normalize</a>,
981<a href="#ordered-dither">-ordered-dither</a>,
982<a href="#radial-blur">-radial-blur</a>,
983<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000984<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000985<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000986<a href="#white-threshold">-white-threshold</a>.
987</p>
988
cristyd0bda5e2010-09-21 16:22:45 +0000989<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +0000990>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +0000991href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +0000992default). These operators have yet to be made to understand the newer 'Sync'
993flag. </p>
994
cristybac7a162010-06-15 19:57:29 +0000995<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
996the image before thresholding, if no <a href="#channel" >-channel</a> setting
997has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +0000998
999<p>Also some operators such as <a href="#blur">-blur</a>, <a
1000href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
1001color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
1002href="#channel" >-channel</a>. Generally this done to ensure that
1003fully-transparent colors are treated as being fully-transparent, and thus any
1004underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +00001005resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +00001006convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +00001007and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +00001008
cristybac7a162010-06-15 19:57:29 +00001009<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +00001010color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +00001011alpha channel present, and the <a href="#channel" >-channel</a> setting tells
1012the operator to apply the operation using alpha channels. The <a
1013href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +00001014
cristy3ed852e2009-09-05 21:47:34 +00001015
1016<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001017 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +00001018</div>
1019
1020<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>
1021
1022<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001023 <h4><a id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001024</div>
1025
1026<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>
1027
1028<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001029 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001030</div>
1031
1032<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>
1033
cristyefb2bdb2010-11-20 19:35:22 +00001034<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>
1035and <em class="arg">height</em> given in the of the <em class="arg">size</em>
1036portion of the <em class="arg">geometry</em> argument give the number of
1037columns and rows to remove. The <em class="arg">offset</em> portion of
1038the <em class="arg">geometry</em> argument is influenced by
1039a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +00001040
cristyefb2bdb2010-11-20 19:35:22 +00001041<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
1042and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00001043
cristydcca3fa2010-12-29 21:50:07 +00001044<p>While it can remove internal rows and columns of pixels, it is more typically
1045used with as <a href="#gravity">-gravity</a> setting and a '<kbd>+0+0</kbd>' offset
1046so as to remove a single edge from an image. Compare this to <a href="#shave"
1047>-shave</a> whcih removes equal numbers of pixels from oppisite sides of the image.
1048</p>
1049
1050<p>Using <a href="#chop">-chop</a> will effectivally undo the results of a
1051<a href="#splice">-splice</a> that was given the same <em class="arg">geometry</em>
1052and <a href="#gravity">-gravity</a> settings. </p>
1053
1054
cristy3ed852e2009-09-05 21:47:34 +00001055<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001056 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001057</div>
1058
1059<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>
1060
1061<p>If a clipping path is present, it is applied to subsequent operations.</p>
1062
1063<p>For example, in the command</p>
1064
1065<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
1066<p>only the pixels within the clipping path are negated.</p>
1067
1068<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1069
1070<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001071 <h4><a id="clip-mask"></a>-clip-mask</h4>
cristy3ed852e2009-09-05 21:47:34 +00001072</div>
1073
1074<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Clip the image as defined by this mask.</td><td style='text-align:right;'></td></tr></table>
1075
cristy30092792011-02-22 02:06:14 +00001076<p>Use the given image as a 'do-not-modify' mask of the current images in the
1077current image sequence. Assuming the clipmask is a greyscale image the same
1078size at the one already in memory, any areas that is white will not be
1079modified by any of the 'image processing operators' that follow, until the
1080mask is removed. Pixels in the black areas of the clip mask will be modified
1081as normal. </p>
1082
1083<p>In some ways this is similar to (though not the same) as defining
1084a rectangular <a href="#region" >-region</a>, or using the negative of the
1085mask (thrid) image in a three image <a href="#composite" >-composite</a>,
1086operation. </p>
1087
1088
cristy3ed852e2009-09-05 21:47:34 +00001089<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001090 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001091</div>
1092
1093<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Clip along a named path from the 8BImageMagick profile.</td><td style='text-align:right;'></td></tr></table>
1094
cristyd241f442011-03-29 13:50:49 +00001095<p>This is almost identical to <a href="#clip">-clip</a>. </p>
cristy30092792011-02-22 02:06:14 +00001096
1097
cristy3ed852e2009-09-05 21:47:34 +00001098<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001099 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001100</div>
1101
cristy8b9dd952011-03-21 22:56:18 +00001102<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 +00001103
cristydcca3fa2010-12-29 21:50:07 +00001104<p>Inside parenthesis (where the operator is normally used) it will make a
1105clone of the images from the last 'pushed' image sequence, and adds them to
1106the end of the current image sequence. Outside parenthesis
1107(not recommended) it clones the images from the current image sequence. </p>
1108
cristy3ed852e2009-09-05 21:47:34 +00001109<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000011100. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001111example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001112represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001113dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1114spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
cristy8b9dd952011-03-21 22:56:18 +00001115effectively clone all the images. </p>
cristydcca3fa2010-12-29 21:50:07 +00001116
1117<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
1118in the image sequence, and is thus equivelent to using a argument of
1119'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001120
1121<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001122 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001123</div>
1124
1125<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
1126corresponding channel in the second image as a <b>c</b>olor
1127<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1128
1129<p>The second (LUT) image is ordinarily a gradient image containing the
1130histogram mapping of how each channel should be modified. Typically it is a
1131either a single row or column image of replacement color values. If larger
1132than a single row or column, values are taken from a diagonal line from
1133top-left to bottom-right corners.</p>
1134
1135<p>The lookup is further controlled by the <a
1136href="#interpolate">-interpolate</a> setting, which is especially handy for an
1137LUT which is not the full length needed by the ImageMagick installed Quality
1138(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1139'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1140gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1141lookup of color values. </p>
1142
1143<p>This operator is especially suited to replacing a grayscale image with a
1144specific color gradient from the CLUT image. </p>
1145
1146<p>Only the channel values defined by the <a href="#channel">-channel</a>
1147setting will have their values replaced. In particular, since the default <a
1148href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1149transparency (alpha/matte channel) is not affected, unless the <a
1150href="#channel">-channel</a> setting is modified. When the alpha channel is
1151set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1152as the other channels, implying that alpha/matte values are replaced using the
1153alpha/matte values of the original image. </p>
1154
cristyd0bda5e2010-09-21 16:22:45 +00001155<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001156transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1157href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001158assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001159replacement alpha values. That is you can use a gray-scale CLUT image to
1160adjust a existing images alpha channel, or you can color a gray-scale image
1161using colors form CLUT containing the desired colors, including transparency.
1162</p>
1163
cristyefb2bdb2010-11-20 19:35:22 +00001164<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1165according to the lookup of the full color RGB value from a 2D representation
1166of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001167
1168
1169<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001170 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001171</div>
1172
1173<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>
1174
cristyefb2bdb2010-11-20 19:35:22 +00001175<p>Overlay each image in an image sequence according to
1176its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1177an animation at each point in the animation sequence. All images should be
1178the same size, and are assigned appropriate GIF disposal settings for the
1179animation to continue working as expected as a GIF animation. Such frames
1180are more easily viewed and processed than the highly optimized GIF overlay
1181images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001182
cristyefb2bdb2010-11-20 19:35:22 +00001183<p>The animation can be re-optimized after processing using
1184the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1185there is no guarantee that the restored GIF animation optimization is
1186better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001187
1188
1189<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001190 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001191</div>
1192
1193<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>
1194
cristyefb2bdb2010-11-20 19:35:22 +00001195<p>Specify the amount of colorization as a percentage. Separate colorization
1196values can be applied to the red, green, and blue channels of the image with
1197a comma-delimited list of colorization
1198values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001199
1200<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001201 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001202</div>
1203
1204<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>
1205
1206<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1207
cristyefb2bdb2010-11-20 19:35:22 +00001208<p>This option only applies when the default X server visual
1209is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1210to <a href="#visual">-visual</a> for more details. By default,
1211a shared colormap is allocated. The image shares colors with
1212other X clients. Some image colors could be approximated,
1213therefore your image may look very different than intended.
1214If <kbd>private</kbd> is chosen, the image colors appear exactly
1215as they are defined. However, other clients may go <em>technicolor</em>
1216when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001217
1218<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001219 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001220</div>
1221
1222<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the preferred number of colors in the image.</td><td style='text-align:right;'></td></tr></table>
1223
cristyefb2bdb2010-11-20 19:35:22 +00001224<p>The actual number of colors in the image may be less than your request,
1225but never more. Note that this a color reduction option. Images with fewer
1226unique colors than specified by <em class="arg">value</em> will have any
1227duplicate or unused colors removed. The ordering of an existing color
1228palette may be altered. When converting an image from color to grayscale,
1229it is more efficient to convert the image to the gray colorspace before
1230reducing the number of colors. Refer to
1231the <a href="../www/quantize.html">
1232color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001233
1234<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001235 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001236</div>
1237
1238<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>
1239
cristyefb2bdb2010-11-20 19:35:22 +00001240<p>This option permits saturation changes, hue rotation, luminance to alpha,
1241and various other effects. Although variable-sized transformation matrices
1242can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1243for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1244Adobe Flash except offsets are in column 6 rather than 5 (in support of
1245CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001246
1247<p>As an example, to add contrast to an image with offsets, try this command:</p>
1248
1249<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001250 convert kittens.jpg -color-matrix \
1251 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1252 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1253 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1254 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1255 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1256 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
cristy2c839602010-04-03 02:32:08 +00001257</pre>
1258<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001259 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001260</div>
1261
1262<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>
1263
1264<p>Choices are:</p>
1265
1266<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001267 CMY CMYK Gray HSB
1268 HSL HWB Lab Log
1269 OHTA Rec601Luma Rec601YCbCr Rec709Luma
1270 Rec709YCbCr RGB sRGB Transparent
1271 XYZ YCbCr YCC YIQ
1272 YPbPr YUV
cristy3ed852e2009-09-05 21:47:34 +00001273</pre>
1274
1275<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1276
1277<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>
1278
1279<table class="doc">
1280 <caption>Conversion Of RGB To Other Color Spaces</caption>
1281 <tr><th align="left" valign="middle">CMY</th></tr>
1282 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1283 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1284 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1285 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1286 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1287 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1288 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1289 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1290
1291 <tr><th align="left" valign="middle">Gray</th></tr>
1292 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1293
1294 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1295 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1296 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1297 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1298
1299 <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>
1300 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1301 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1302 <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>
1303
1304 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1305 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1306 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1307 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1308
1309 <tr><th align="left" valign="middle">LAB</th></tr>
1310 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1311 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1312 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1313
1314 <tr><th align="left" valign="middle">LOG</th></tr>
1315 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1316 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1317 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1318
1319 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1320 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1321 <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>
1322 <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>
1323
1324 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1325 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1326
1327 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1328 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1329 <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>
1330 <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>
1331
1332 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1333 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1334
1335 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1336 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1337 <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>
1338 <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>
1339
1340 <tr><th align="left" valign="middle">sRGB</th></tr>
1341 <tr><td align="left" valign="middle">if Rs &le; .03928 then Rs=R/12.92 else Rs=((R+.055)/1.055)^2.4</td></tr>
1342 <tr><td align="left" valign="middle">if Gs &le; .03928 then Gs=B/12.92 else Gs=((G+.055)/1.055)^2.4</td></tr>
1343 <tr><td align="left" valign="middle">if Bs &le; .03928 then Bs=B/12.92 else Bs=((B+.055)/1.055)^2.4</td></tr>
1344
1345 <tr><th align="left" valign="middle">XYZ</th></tr>
1346 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1347 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1348 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1349
1350 <tr><th align="left" valign="middle">YCC</th></tr>
1351 <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>
1352 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1353 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1354
1355 <tr><th align="left" valign="middle">YCbCr</th></tr>
1356 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1357 <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>
1358 <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>
1359
1360 <tr><th align="left" valign="middle">YIQ</th></tr>
1361 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1362 <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>
1363 <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>
1364
1365 <tr><th align="left" valign="middle">YPbPr</th></tr>
1366 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1367 <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>
1368 <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>
1369
1370 <tr><th align="left" valign="middle">YUV</th></tr>
1371 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1372 <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>
1373 <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>
1374</table>
1375
1376<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001377 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001378</div>
1379
1380<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>
1381
1382<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>
1383
1384<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.
1385</p>
1386
cristy4949d522010-03-12 18:41:34 +00001387<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 +00001388<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001389 <h4><a id="comment"></a>-comment <em class="arg">string</em></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%'>Embed a comment in an image.</td><td style='text-align:right;'></td></tr></table>
1393
cristyd0bda5e2010-09-21 16:22:45 +00001394<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001395option has been given. To modify a comment of images already in memory use
1396"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001397
cristy71a3f602010-09-15 12:38:16 +00001398<p>The comment can contain special format characters listed in the <a
1399href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001400Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001401is finally assigned to the individual images. </p>
1402
1403<p>If the first character of <em class="arg">string</em> is <em
1404class="arg">@</em>, the image comment is read from a file titled by the
1405remaining characters in the string. Comments read in from a file are literal;
1406no embedded formatting characters are recognized.</p>
1407
1408<p>Comment meta-data are not visible on the image itself. To do that use the
1409<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1410instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001411
1412<p>For example,</p>
1413
1414<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001415 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001416</p>
1417
cristy71a3f602010-09-15 12:38:16 +00001418<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1419that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1420480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001421
1422<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001423 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001424</div>
1425
1426<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>
1427
cristybc9539a2010-08-16 18:06:20 +00001428<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1429a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001430
cristybc9539a2010-08-16 18:06:20 +00001431<p>This setting effects image processing operators that merge two (or more)
1432images together in some way. This includes the operators,
1433<a href="#composite">-composite</a>,
1434<a href="#layers">-layers</a> composite,
1435<a href="#flatten">-flatten</a>,
1436<a href="#mosaic">-mosaic</a>,
1437<a href="#layers">-layers</a> merge,
1438<a href="#border">-border</a>,
1439<a href="#frame">-frame</a>,
1440and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001441
cristybc9539a2010-08-16 18:06:20 +00001442<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1443command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001444
1445
1446<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001447 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001448</div>
1449
cristybc9539a2010-08-16 18:06:20 +00001450<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 +00001451
1452<p>Take the first image 'destination' and overlay the second 'source' image
1453according to the current <a href="#compose">-compose</a> setting. The location
1454of the 'source' or 'overlay' image is controlled according to <a
1455href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1456settings. </p>
1457
1458<p>If a third image is given this is treated as a gray-scale 'mask' image
1459relative to the first 'destination' image. This mask will limit what parts of
1460the destination can be modified by the image composition. However for the
1461'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1462Y-displacement image instead. </p>
1463
1464<p>If a <a href="#compose">-compose</a> method requires extra numerical
1465arguments or flags these can be provided by setting the <a
1466href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001467appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001468
1469<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1470image outside the overlay area. You can disable this by setting the special <a
1471href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1472to '<kbd>false</kbd>'. </p>
1473
1474
1475<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001476 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001477</div>
1478
1479<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>
1480
1481<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>
1482
1483<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1484
1485<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>
1486
1487<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>
1488
1489<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>
1490
1491<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>
1492
1493<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001494 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001495</div>
1496
1497<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Enhance or reduce the image contrast.</td><td style='text-align:right;'></td></tr></table>
1498
1499<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>
1500
1501<p>For a more pronounced effect you can repeat the option:</p>
1502
1503<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1504<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001505 <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 +00001506</div>
1507
1508<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>
1509
cristyd934d102009-10-10 12:55:13 +00001510<p>While performing the stretch, black-out at most <em
1511class="arg" >black-point</em> pixels and white-out at most <em
1512class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1513<em class="arg" >black-point %</em> pixels and white-out at most <em
1514class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001515
cristyd934d102009-10-10 12:55:13 +00001516<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1517>-contrast-stretch</a> will black-out at most <em class="arg"
1518>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1519minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1520class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1521>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001522
cristyd934d102009-10-10 12:55:13 +00001523<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1524the image's min and max values are stretched to 0 and <em class="QR"
1525>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1526clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001527>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001528prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001529
cristyd934d102009-10-10 12:55:13 +00001530<p>Internally operator works by creating a histogram bin, and then uses that
1531bin to modify the image. As such some colors may be merged together when they
1532originally fell into the same 'bin'. </p>
1533
1534<p>All the channels are normalized in concert by the came amount so as to
1535preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001536setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001537setting will normalize the RGB channels independently.</p>
1538
1539<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1540normalization of mathematical images. </p>
1541
1542<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001543
1544
1545<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001546 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001547</div>
1548
1549<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>
1550
cristy16ff93c2010-01-13 23:18:07 +00001551<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001552a comma-separated list of integers (with no spaces), ordered left-to right,
1553starting with the top row. Presently, only odd-dimensioned kernels are
1554supported, and therefore the number of entries in the specified <em
1555class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15567<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001557
cristyd934d102009-10-10 12:55:13 +00001558<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
1559positive and negative results are relative to a user-specified bias value.
1560This is important for non-HDRI compilations of ImageMagick when dealing with
1561convolutions that contain negative as well as positive values. This is
1562especially the case with convolutions involving high pass filters or edge
1563detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001564</p>
1565
cristyd934d102009-10-10 12:55:13 +00001566<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
1567negative results without clipping to the color value range (0..QuantumRange).
1568See the discussion on HDRI implementations of ImageMagick on the page <a
cristy47774982011-02-15 15:17:19 +00001569href="../www/high-dynamic-range.html">High
cristyd934d102009-10-10 12:55:13 +00001570Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1571href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1572<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1573entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001574
cristy3ed852e2009-09-05 21:47:34 +00001575
1576<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001577 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001578</div>
1579
1580<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>
1581
1582<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>
1583
1584<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>
1585
1586<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>
1587
1588<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>
1589
1590<p>By adding a exclamation character flag to the geometry argument, the
1591cropped images virtual canvas page size and offset is set as if the
1592geometry argument was a viewport or window. This means the canvas page size
1593is set to exactly the same size you specified, the image offset set
1594relative top left corner of the region cropped. </p>
1595
1596<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1597special single pixel transparent 'missed' image is returned, and a 'crop
1598missed' warning given. </p>
1599
cristy739df912009-10-24 16:10:18 +00001600<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 +00001601
1602<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001603 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001604</div>
1605
1606<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>
1607
1608<p><em class="arg">Amount</em> defines the number of positions each
1609colormap entry is shifted.</p>
1610
1611
1612<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001613 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001614</div>
1615
1616<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>
1617
1618<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>
1619
1620
1621<p>For example, to log cache and blob events, use.</p>
1622
1623<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1624<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1625
1626<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1627
1628<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1629
1630<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1631
1632<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>
1633
1634
1635<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001636 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001637</div>
1638
1639<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>
1640
1641<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1642
1643<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1644
1645
1646<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001647 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001648</div>
1649
1650<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>
1651
1652<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>
1653
1654<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>
1655
1656<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1657
1658
1659<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001660 <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 +00001661</div>
1662
cristyd0bd44a2010-09-24 12:38:11 +00001663<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 +00001664coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001665
cristyd0bda5e2010-09-21 16:22:45 +00001666<p>This option creates one or more definitions for coders and decoders to use
1667while reading and writing image data. Definitions are generally used to
1668control image file format coder modules, and image processing operations,
1669beyond what is provided by normal means. Defined settings are listed in <a
1670href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1671as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001672
cristyd0bda5e2010-09-21 16:22:45 +00001673<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1674definition of a flag is created with that name. This used to control on/off
1675options. Use <a href="#define">+define key</a> to remove definitions
1676previously created. Use <a href="#define">+define "*"</a> to remove all
1677existing definitions.</p>
1678
cristyd0bd44a2010-09-24 12:38:11 +00001679<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001680href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001681>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 +00001682Properties</a> in the defined value. </p>
1683
cristyefb2bdb2010-11-20 19:35:22 +00001684<p>The <em>option</em> and <em>key</em> are case-independent (they are
1685converted to lowercase for use within the decoders) while the <em>value</em>
1686is case-dependent.</p>
1687
cristyd0bda5e2010-09-21 16:22:45 +00001688<p>Such settings are global in scope, and effect all images and operations. </p>
1689
1690<p>The following definitions are just some of the artifacts that are
1691available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001692
cristydcca3fa2010-12-29 21:50:07 +00001693<dl>
cristy045bd902010-01-30 18:56:24 +00001694<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001695<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001696 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001697
cristy045bd902010-01-30 18:56:24 +00001698<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001699<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001700 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001701
cristy045bd902010-01-30 18:56:24 +00001702<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001703<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001704 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001705
cristy045bd902010-01-30 18:56:24 +00001706<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001707<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1708 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001709 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001710
cristy045bd902010-01-30 18:56:24 +00001711<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001712<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1713 compression factor is the reciprocal of the compression ratio. The valid
1714 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1715 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001716 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001717
cristy3ed852e2009-09-05 21:47:34 +00001718<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001719 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001720
cristy045bd902010-01-30 18:56:24 +00001721<dt>png:bit-depth=<em class="arg">value</em></dt>
1722<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001723<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1724 encoder to use a different bit-depth and color-type than it would have
1725 normally selected, but only if this does not cause any loss of image
1726 quality. Any attempt to reduce image quality is treated as an error and no
1727 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1728 can use these "defines" to cause it to be written as an 8-bit grayscale,
1729 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1730 you cannot force it to be written as a grayscale or indexed PNG. If you
1731 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1732 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1733 reduce the image quality prior to using the PNG encoder. Note that in
1734 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001735 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001736 8-bit depth.</dd>
1737
1738<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1739<dt>png:include-chunk=<em class="arg">value</em></dt>
1740<dd>ancillary chunks to be excluded from or included in PNG output.
1741
1742 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1743 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1744 or the word <em class="arg">all</em> or
1745 the word <em class="arg">none</em>. There must be no spaces in the
1746 list. Although PNG chunk-names are case-dependent, you can use
1747 all lowercase names if you prefer.</p>
1748
cristyd241f442011-03-29 13:50:49 +00001749 <p>The "include-chunk" and "exclude-chunk" lists only affect the behavior
1750 of the PNG encoder and have no effect on the PNG decoder.</p>
1751
cristydcca3fa2010-12-29 21:50:07 +00001752 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1753 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1754 only be written if gamma is not 1/2.2, since most decoders assume
1755 sRGB and gamma=1/2.2 when no colorspace information is included in
1756 the PNG file. Because the list is processed from left to right, you
1757 can achieve this with a single define:</p>
1758
1759<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001760 -define png:include-chunk=none,gAMA
cristydcca3fa2010-12-29 21:50:07 +00001761</pre>
1762
1763 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
1764 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any of
1765 these entries appearing in the list will be ignored.</p>
1766
1767 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1768 image has transparency, the PNG colortype is forced to be 4 or 6
1769 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1770 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1771 on the PNG colortype of the output image.</p>
1772
1773 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1774 following for PNG output:</p>
1775
1776<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001777 -define png:include-chunk=none,gama
cristydcca3fa2010-12-29 21:50:07 +00001778</pre>
1779
1780 <p>The default behavior is to include all known PNG ancillary chunks
cristyf7964272011-01-30 03:49:12 +00001781 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk,
1782 and to exclude all PNG chunks that are unknown to ImageMagick,
1783 regardless of their PNG "copy-safe" status as described in the
1784 PNG specification.</p>
cristyd241f442011-03-29 13:50:49 +00001785
1786 <p>Any chunk names that are not known to ImageMagick are ignored
1787 if they appear in either the "include-chunk" or "exclude-chunk" list.
1788 The ancillary chunks currently known to ImageMagick are
1789 <kbd>bKGD</kbd>, <kbd>cHRM</kbd>, <kbd>gAMA</kbd>, <kbd>iCCP</kbd>,
1790 <kbd>oFFs</kbd>, <kbd>pHYs</kbd>, <kbd>sRGB</kbd>, <kbd>tEXt</kbd>,
1791 <kbd>tRNS</kbd>, <kbd>vpAg</kbd>, and <kbd>zTXt</kbd>.</p>
1792
1793y</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001794
cristy3ed852e2009-09-05 21:47:34 +00001795<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001796<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1797 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001798 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001799
cristy045bd902010-01-30 18:56:24 +00001800<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001801<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1802 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1803 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001804 included, the result is a single precision floating point format.
1805 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001806 double precision floating point format.</dd>
1807
cristydcca3fa2010-12-29 21:50:07 +00001808</dl>
cristy3ed852e2009-09-05 21:47:34 +00001809
cristyd0bda5e2010-09-21 16:22:45 +00001810<p>For example, to create a postscript file that will render only the black
1811pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001812
1813<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 +00001814<p>Set attributes of the image registry by prefixing the value with
1815<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1816use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001817
1818<p class="crtsnip">
1819-define registry:temporary-path=/data/tmp
1820</p>
1821
cristyd0bda5e2010-09-21 16:22:45 +00001822
1823
cristy3ed852e2009-09-05 21:47:34 +00001824<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001825 <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 +00001826</div>
1827
1828<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>
1829
1830<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>
1831
1832<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>
1833
1834
1835<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00001836 <h4><a id="delete"></a>-delete <em class="arg">indexes</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001837</div>
1838
1839<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>
1840
1841<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>
1842
1843
1844<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001845 <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 +00001846</div>
1847
1848<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>
1849
1850<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>
1851
1852<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>
1853
1854<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>
1855
1856<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>
1857
1858<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001859 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001860</div>
1861
1862<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>
1863
1864<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>
1865
1866<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001867 <h4><a id="descend"></a>-descend</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%'>obtain image by descending window hierarchy.</td><td style='text-align:right;'></td></tr></table>
1871
1872<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001873 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001874</div>
1875
1876<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>straighten an image. A threshold of 40% works for most images.</td><td style='text-align:right;'></td></tr></table>
1877
1878<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>
1879
1880<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001881 <h4><a id="despeckle"></a>-despeckle</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%'>reduce the speckles within an image.</td><td style='text-align:right;'></td></tr></table>
1885
1886<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001887 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001888</div>
1889
1890<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>
1891
1892<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001893 <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 +00001894</div>
1895
1896<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>
1897
1898<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001899is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001900what part of the 'background' image is seen at each point of the overlaid
1901area. Much like the displacement map is a 'lens' that redirects light shining
1902through it so as to present a distorted view the original 'background' image
1903behind it. </p>
1904
1905<p>Any perfect grey areas of the displacement map produce a zero
1906displacement of the image. Black areas produce the given maximum negative
1907displacement of the lookup point, while white produce a maximum positive
1908displacement of the lookup. </p>
1909
1910<p>Note that it is the lookup of the 'background' that is displaced, not a
1911displacement of the image itself. As such an area of the displacement map
1912containing 'white' will have the lookup point 'shifted' by a positive amount,
1913and thus generating a copy of the destination image to the right/downward from
1914the correct position. That is the image will look like it may have been
1915'shifted' in a negative left/upward direction. Understanding this is a very
1916important in understanding how displacement maps work. </p>
1917
1918<p>The given arguments define the maximum amount of displacement in pixels
1919that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001920it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001921outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001922easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001923into the overlay area. </p>
1924
1925<p>The '%' flag makes the displacement scale relative to the size of the
1926overlay image (100% = half width/height of image). Using '!' switches
1927percentage arguments to refer to the destination image size instead.
1928these flags were added as of IM v6.5.3-5.</p>
1929
1930<p>Normally a single grayscale displacement map is provided, which with the
1931given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001932displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001933specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001934the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001935displacement, while the <em class="arg">mask image</em> is used for vertical Y
1936displacement. This allows you to define completely different displacement
1937values for the X and Y directions, and allowing you to lookup any point within
1938the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001939any other nearby pixel, producing complex 2 dimensional displacements, rather
1940than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001941
cristyd0bda5e2010-09-21 16:22:45 +00001942<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001943you can use the 'red' channel of the overlay image to specify the horizontal
1944or X displacement, and the 'green' channel for the vertical or Y displacement.
1945</p>
1946
cristyd0bd44a2010-09-24 12:38:11 +00001947<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 +00001948mask the transparency of the destination image. However areas outside the
1949overlaid areas will not be effected. </p>
1950
1951
1952<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001953 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001954</div>
1955
1956<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>
1957
1958<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1959
1960<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001961 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001962</div>
1963
1964<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>
1965
1966<p>The layer disposal method defines the way each the displayed image is to be
1967modified after the current 'frame' of an animation has finished being
1968displayed (after its 'delay' period), but before the next frame on an
1969animation is to be overlaid onto the display. </p>
1970
1971<p>Here are the valid methods:</p>
1972
1973<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00001974 Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
1975 None 1 Do not dispose, just overlay next frame image.
1976 Background 2 Clear the frame area with the background color.
1977 Previous 3 Clear to the image prior to this frames overlay.
cristy3ed852e2009-09-05 21:47:34 +00001978</pre>
1979
1980<p>You can also use the numbers given above, which is what the GIF format
1981uses internally to represent the above settings. </p>
1982
cristyd0bda5e2010-09-21 16:22:45 +00001983<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00001984
1985<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
1986resetting the layer disposal methods of images being read in. </p>
1987
1988<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
1989disposal method for images already in memory.</p>
1990
1991<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001992 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001993</div>
1994
1995<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>
1996
1997
1998<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001999 <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 +00002000</div>
2001
2002<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>
2003
2004<p>The opacity of the composite image is multiplied by the given percent, then
2005it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00002006is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00002007transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
2008are given, each image are dissolved to the percentages given. </p>
2009
2010<p>Note that dissolve percentages do not add, two opaque images dissolved
2011'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2012images, you would need to use dissolve values of '50,100'. </p>
2013
2014<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002015 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002016</div>
2017
2018<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>
2019
2020<p>The <em class="arg">arguments</em> is a single string containing a list
2021of floating point numbers separated by commas or spaces. The number of
2022and meaning of the floating point values depends on the distortion <em
2023class="arg">method</em> being used. </p>
2024
2025<p>Choose from these distortion types:</p>
2026
2027<table class="doc">
2028 <tr valign="top">
2029 <th align="left" style="width: 8%">Method</th>
2030 <th align="left">Description</th>
2031 </tr>
2032
2033 <tr valign="top">
2034 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
2035 <br/>or &nbsp; <kbd>SRT</kbd></td>
2036 <td valign="top">
2037 Distort image by first scaling and rotating about a given 'center',
2038 before translating that 'center' to the new location, in that order. It
2039 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
2040 distortion, but without shearing effects. It also provides a good way
2041 of rotating and displacing a smaller image for tiling onto a larger
2042 background (IE 2-dimensional animations). <br/>
2043
2044 The number of arguments determine the specific meaning of each
2045 argument for the scales, rotation, and translation operations. <br/>
2046
2047 <table style="margin-left:auto; margin-right:auto;">
2048 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
2049 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
2050 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00002051 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002052 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
2053 <tr><td>5:</td>
2054 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2055 <tr><td>6:</td>
2056 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
2057 <tr><td>7:</td>
2058 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
2059 &nbsp; NewX,NewY</em></td></tr>
2060 </table>
2061
cristyd0bda5e2010-09-21 16:22:45 +00002062 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00002063 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2064
2065 <tr valign="top">
2066 <td valign="top"><kbd>Affine</kbd></td>
2067 <td valign="top">
2068 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002069 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002070 point values are given allowing the image to be linearly scaled,
2071 rotated, sheared, and translated, according to those three points. See
2072 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2073 distortions. <br/>
2074
2075 More than 3 sets given control point pairs (12 numbers) is least
2076 squares fitted to best match a lineary affine distortion. If only 2
2077 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002078 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002079 flipping or changes in aspect ratio to the resulting image. If only one
2080 control point pair is provides the image is only translated, (which may
2081 be a floating point non-integer translation). <br/>
2082
2083 This distortion does not include any form of perspective distortion.
2084 </td>
2085
2086 </tr>
2087
2088 <tr valign="top">
2089 <td valign="top"><kbd>AffineProjection</kbd></td>
2090 <td valign="top">
2091 Linearly distort an image using the given Affine Matrix of 6
2092 pre-calculated coefficients forming a set of Affine Equations to map
2093 the source image to the destination image.
2094
2095 <div style="text-align: center"><em>
2096 s<sub>x</sub>, r<sub>x</sub>,
2097 r<sub>y</sub>, s<sub>y</sub>,
2098 t<sub>x</sub>, t<sub>y</sub>
2099 </em></div>
2100
2101 See <a href="#affine" >-affine</a> setting for more detail, and
2102 meanings of these coefficients. <br/>
2103
2104 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002105 alternative methods of defining this distortion, with ImageMagick doing
2106 the calculations needed to generate the required coefficients. You can
2107 see the internally generated coefficients, by using a <a
2108 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002109
2110 </tr>
2111
cristy3ed852e2009-09-05 21:47:34 +00002112 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002113 <td valign="top"><kbd>BilinearForward</kbd><br/>
2114 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002115 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002116 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2117 16 values (see below). Not that lines may not appear straight after
2118 distortion, though the distance between coordinates will remain
2119 consistent. <br/>
2120
2121 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2122 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2123 quadrilateral to a rectangle, while preserving the straigth line edges
2124 in each case. <br/>
2125
2126 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2127 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2128 color setting. Also if the quadraterial becomes 'flipped' the image
2129 may dissappear. <br/>
2130
2131 There are future plans to produce a true Bilinear distortion that will
2132 attempt to map any quadrilateral to any other quadrilateral, while
2133 preserving edges (and edge distance ratios).
2134
2135 </td>
cristy3ed852e2009-09-05 21:47:34 +00002136 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002137
2138 <tr valign="top">
2139 <td valign="top"><kbd>Perspective</kbd></td>
2140 <td valign="top">
2141 Perspective distort the images, using a list of 4 or more sets of
2142 control points (as defined below). More that 4 sets (16 numbers) of
2143 control points provide least squares fitting for more accurate
2144 distortions (for the purposes of image registration and panarama
2145 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2146 linear distortion. <br/>
2147
2148 Perspective Distorted images ensures that straight lines remain
2149 straight, but the scale of the distorted image will vary. The horizon
2150 is anti-aliased, and the 'sky' color may be set using the
2151 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2152 </tr>
2153
2154 <tr valign="top">
2155 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2156 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002157 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002158 pre-calculated coefficients. You can get these coefficients by looking
2159 at the <a href="#verbose" >-verbose</a> output of a
2160 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2161 If the last two perspective scaling coefficients are zero, the
2162 remaining 6 represents a transposed 'Affine Matrix'. </td>
2163
2164 </tr>
2165
2166 <tr valign="top">
2167 <td valign="top"><kbd>Arc</kbd></td>
2168 <td valign="top">
2169 Arc the image (variation of polar mapping) over the angle given around
2170 a circle. <br/>
2171 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2172 <tr valign="top"><td>Argument</td>
2173 <td>Meaning</td></tr>
2174 <tr valign="top"><td><em>arc_angle</em></td>
2175 <td>The angle over which to arc the image side-to-side</td></tr>
2176 <tr valign="top"><td><em>rotate_angle</em></td>
2177 <td>Angle to rotate resulting image from vertical center</td></tr>
2178 <tr valign="top"><td><em>top_radius</em></td>
2179 <td>Set top edge of source image at this radius</td></tr>
2180 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2181 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2182 </table>
2183
2184 The resulting image is always resized to best fit the resulting image,
2185 (as if using <a href="#distort" >+distort</a>) while attempting to
2186 preserve scale and aspect ratio of the original image as much as
2187 possible with the arguments given by the user. All four arguments will
2188 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2189
2190 This a variation of a polar distortion designed to try to preserve the
2191 aspect ratio of the image rather than direct Cartesian to Polar
2192 conversion. </td>
2193 </tr>
2194
2195 <tr valign="top">
2196 <td valign="top"><kbd>Polar</kbd></td>
2197 <td valign="top">
2198 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2199 the image. that is the height of the input image is mapped to the
2200 radius limits, while the width is wrapped around between the
2201 angle limits. <br/>
2202
2203 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2204
2205 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2206 center to the center of the image, and the angles going from -180 (top)
2207 to +180 (top). If <em>Rmax</em> is given the special value of
2208 '<code>0</code>', the the distance from the center to the nearest edge
2209 is used for the radius of the output image, which will ensure the whole
2210 image is visible (though scaled smaller). However a special value of
2211 '<code>-1</code>' will use the distance from the center to the furthest
2212 corner, This may 'clip' the corners from the input rectangular image,
2213 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2214 the same arguments. <br/>
2215
2216 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2217 output image center will default to <code>0,0</code> of the virtual
2218 canvas, and the image size adjusted to ensure the whole input image is
2219 made visible in the output image on the virtual canvas. </td>
2220
2221 </tr>
2222
2223 <tr valign="top">
2224 <td valign="top"><kbd>DePolar</kbd></td>
2225 <td valign="top">
2226 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2227 but generates the reverse Polar to Cartesian distortion. <br/>
2228
2229 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2230 the corners of the input image. However using the special
2231 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2232 distance) will ensure the whole distorted image is preserved in the
2233 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2234 reverse the distortion re-producing the original.
2235
2236 Note that as this distortion requires the area resampling of a circular
2237 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002238 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002239 form of 'super-sampling' image processing technique be used to produce
2240 a high quality result. </td>
2241
2242 </tr>
2243
2244 <tr valign="top">
2245 <td valign="top"><kbd>Barrel</kbd></td>
2246 <td valign="top">
2247 Given the four coefficients (A,B,C,D) as defined by <a
cristy6bcf48e2011-02-15 19:09:04 +00002248 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002249 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002250 correct radial lens distortions. That is in photographs, make straight
2251 lines straight again. <br/>
2252
2253 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2254 <em>X</em> , <em>Y</em> ] ] <br/>
2255 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2256 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2257 [ <em>X</em> , <em>Y</em> ] <br/>
2258 So that it forms the function <br/>
2259 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2260 <em>C</em>*r + <em>D</em> )<br/>
2261
2262 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2263 (defaulting to the center of the image). <br/>
2264 The second form is typically used to distort images, rather than
2265 correct lens distortions. <br/>
2266 </td>
2267
2268 </tr>
2269
2270 <tr valign="top">
2271 <td valign="top"><kbd>BarrelInverse</kbd></td>
2272 <td valign="top">
2273 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2274 arguments, and argument handling. However it uses the inverse
2275 of the radial polynomial,
2276 so that it forms the function <br/>
2277 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002278 <em>C</em>*r + <em>D</em> )<br/>
2279 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2280 distortion, just a different barrel-like radial distortion method.
2281
cristy3ed852e2009-09-05 21:47:34 +00002282 </td>
2283 </tr>
2284
2285 <tr valign="top">
2286 <td valign="top"><kbd>Shepards</kbd></td>
2287 <td valign="top">
2288 Distort the given list control points (any number) using an Inverse
2289 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002290 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2291 Method</a>). The control points in effect do 'localized' displacement
2292 of the image around the given control point (preserving the look and
2293 the rotation of the area near the control points. For best results
2294 extra control points should be added to 'lock' the positions of the
2295 corners, edges and other unchanging parts of the image, to prevent
2296 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002297
cristyd0bd44a2010-09-24 12:38:11 +00002298 The distortion has been likened to 'taffy pulling' using nails, or
2299 pins' stuck in a block of 'jelly' which is then moved to the new
2300 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002301
cristyd0bd44a2010-09-24 12:38:11 +00002302 Internally it is equivelent to generating a displacement map (see <a
2303 href="#displace" >-displace</a>) for source image color look-up using
2304 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2305
2306 </td>
cristy3ed852e2009-09-05 21:47:34 +00002307 </tr>
2308
2309</table>
2310
cristyd0bd44a2010-09-24 12:38:11 +00002311<p>To print a complete list of distortion methods, use <a href="#list">-list
2312distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002313
2314<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2315'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2316defining how these points in the given image should be distorted in the
2317destination image. Each set of four floating point values represent a source
2318image coordinate, followed immediately by the destination image coordinate.
2319This produces a list of values such as...</p>
2320<div style="text-align: center"><em>
2321 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2322 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2323 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2324 ... &nbsp;
2325 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2326</em></div>
2327<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2328destination image. </p>
2329
2330<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2331needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2332perspective distortion of the built-in "rose:" image. Note how spaces were
2333used to group the 4 sets of coordinate pairs, to make it easier to read and
2334understand.</p>
2335
2336<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002337convert rose: -virtual-pixel black \<br/>
2338 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2339 rose_3d_rotated.gif</span></p>
2340<p>If more that the required number of coordinate pairs are given for
2341a distortion, the distortion method is 'least squares' fitted to produce the
2342best result for all the coordinate pairs given. If less than the ideal number
2343of points are given, the distort will generally fall back to a simpler form of
2344distortion that can handles the smaller number of coordinates (usally a linear
2345'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002346
cristyd0bda5e2010-09-21 16:22:45 +00002347<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002348find matching coordinate pairs in overlapping images, so as to improve the
2349'fit' of the distortion. Of course a bad coordinate pair can also make the
2350'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002351
2352<p>Colors are acquired from the source image according to the <a
2353href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002354magnified. However if the viewed image is minified (image becomes smaller),
2355a special area resampling function (added ImageMagick v6.3.5-9), is used to
2356produce a higher quality image. For example you can use
2357a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2358the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002359
cristyd0bd44a2010-09-24 12:38:11 +00002360<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2361convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2362 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2363 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002364<p>Note that a infinitely tiled perspective images involving the horizon can
2365be very slow to generate due to the use of the high quality 'area resampling'
2366function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2367using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2368(recommended if you plan to use super-sampling instead). </p>
2369
2370<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2371'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2372will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2373pixels. If you do not what these pixels to be visible, set the color to match
2374the rest of the ground. </p>
2375
2376<p>The output image size will by default be the same as the input image. This
2377means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002378the 'distorted space', those parts is clipped and lost. However if you use
2379the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2380will attempt (if possible) to show the whole of the distorted image, while
2381retaining a correct 'virtual canvas' offset, for image layering. This offset
2382may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2383is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002384
2385<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2386option:distort:viewport {geometry_string}</kbd>" setting which will specify
2387the size and the offset of the generated 'viewport' image of the distorted
2388image space.</p>
2389
2390<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2391{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2392that factor without changing the viewed contents of the distorted image. This
2393can be used either for 'super-sampling' the image for a higher quality result,
2394or for panning and zooming around the image (with appropriate viewport
2395changes, or post-distort cropping and resizing). </p>
2396
2397<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2398href="#distort" >-distort</a> to attempt to output the internal coefficients,
2399and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2400and debugging purposes. This many not be available for all distorts. </p>
2401
2402<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2403produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2404and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002405above settings. It is algorithmically slower however, though that may not be
2406the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002407
2408
2409<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002410 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002411</div>
2412
2413<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>
2414
cristyd0bda5e2010-09-21 16:22:45 +00002415<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 +00002416
2417<p>Dithering is turned on by default, to turn it off use the plus form of the
2418setting, <a href="#dither">+dither</a>. This will also also render PostScript
2419without text or graphic aliasing. Disabling dithering often (but not always)
2420leads to faster process, a smaller number of colors, but more cartoon like
2421image coloring. Generally resulting in 'color banding' effects in areas with
2422color gradients. </p>
2423
2424<p>The color reduction operators <a href="#colors">-colors</a>, <a
2425href="#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>
2426
2427<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>
2428
2429
2430<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002431 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002432</div>
2433
2434<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>
2435
2436<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>
2437
2438<p>The shape primitives:</p>
2439
2440<pre class="text">
2441 point x,y
2442 line x0,y0 x1,y1
2443 rectangle x0,y0 x1,y1
2444 roundRectangle x0,y0 x1,y1 wc,hc
2445 arc x0,y0 x1,y1 a0,a1
2446 ellipse x0,y0 rx,ry a0,a1
2447 circle x0,y0 x1,y1
2448 polyline x0,y0 ... xn,yn
2449 polygon x0,y0 ... xn,yn
2450 bezier x0,y0 ... xn,yn
2451 path path specification
2452 image operator x0,y0 w,h filename
2453</pre>
2454
2455<p>The text primitive:</p>
2456
2457<pre class="text">
2458 text x0,y0 string
2459</pre>
2460<p>The text gravity primitive:</p>
2461
2462<pre class="text">
2463 gravity NorthWest, North, NorthEast, West, Center,
2464 East, SouthWest, South, or SouthEast
2465</pre>
2466
2467<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>
2468
2469<p>The transformation primitives:</p>
2470
2471<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002472 rotate degrees
2473 translate dx,dy
2474 scale sx,sy
2475 skewX degrees
2476 skewY degrees
cristy3ed852e2009-09-05 21:47:34 +00002477</pre>
2478
2479<p>The pixel operation primitives:</p>
2480
2481<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00002482 color x0,y0 method
2483 matte x0,y0 method
cristy3ed852e2009-09-05 21:47:34 +00002484</pre>
2485
2486<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>
2487
2488<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>
2489
2490<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2491
2492<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2493
2494<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>
2495
2496<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2497
2498<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>
2499
2500<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>
2501
2502<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>.
2503</p>
2504
2505<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2506
2507<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2508
2509<p class="crtsnip">
2510 -draw 'circle 100,100 150,150'
2511</p>
2512
2513<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
2514draw 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>
2515
2516<p class="crtsnip">
2517 -draw 'bezier 20,50 45,100 45,0 70,50'
2518</p>
2519<p class="crtsnip">
2520 -draw 'bezier 70,50 95,100 95,0 120,50'
2521</p>
2522
2523
2524<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>
2525
2526<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>
2527
2528<p class="crtsnip">
2529 -draw 'image SrcOver 100,100 225,225 image.jpg'
2530</p>
2531
cristybc9539a2010-08-16 18:06:20 +00002532<p>You can use 0,0 for the image size, which means to use the actual
2533dimensions found in the image header. Otherwise, it is scaled to the given
2534dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
2535a detailed discussion of alpha composition methods that are available. </p>
cristy3ed852e2009-09-05 21:47:34 +00002536
2537<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>
2538
2539<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2540
2541<p class="crtsnip">
2542 -draw 'text 100,100 "Works like magick!"'
2543</p>
2544
2545<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2546
2547<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>
2548
2549<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2550
2551<p>The <kbd>scale</kbd> primitive scales them.</p>
2552
2553<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>
2554
2555<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
2556matrix.</p>
2557
2558<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>
2559
2560<pre class="text">
2561 point
2562 replace
2563 floodfill
2564 filltoborder
2565 reset
2566</pre>
2567
2568<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>
2569
2570<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>
2571
2572<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>
2573
2574<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2575
2576<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2577
cristy8b9dd952011-03-21 22:56:18 +00002578<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00002579 <h4><a id="duplicate"></a>-duplicate <em class="arg">count,indexes</em></h4>
cristy8b9dd952011-03-21 22:56:18 +00002580</div>
2581
cristy323f35b2011-03-24 23:05:13 +00002582<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 +00002583
cristy323f35b2011-03-24 23:05:13 +00002584<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 +00002585
2586<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002587 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002588</div>
2589
2590<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>
2591
2592<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002593 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002594</div>
2595
2596<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>
2597
2598<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002599 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002600</div>
2601
2602<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>
2603
2604<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2605
2606<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2607
cristyd0bda5e2010-09-21 16:22:45 +00002608
2609
cristy3ed852e2009-09-05 21:47:34 +00002610<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002611 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002612</div>
2613
2614<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>
2615
2616<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>
2617
2618<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002619 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002620</div>
2621
2622<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>
2623
2624<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2625
2626<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2627
2628
2629<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002630 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002631</div>
2632
2633<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Apply a digital filter to enhance a noisy image.</td><td style='text-align:right;'></td></tr></table>
2634
2635
2636<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002637 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002638</div>
2639
2640<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>perform histogram equalization on the image channel-by-channel.</td><td style='text-align:right;'></td></tr></table>
2641
2642<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>
2643
2644<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2645
2646<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>
2647
2648<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002649 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002650</div>
2651
2652<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>
2653
2654<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>
2655
2656<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>
2657
2658<table class="doc">
2659 <col width="25%" />
2660 <col width="75%" />
2661 <thead>
2662 <tr>
2663 <th><em class="arg">operator</em></th>
2664 <th>Summary (see further below for details)</th>
2665 </tr>
2666 </thead>
2667 <tbody>
2668
cristy3c98a4f2010-08-13 20:09:41 +00002669 <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 +00002670 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2671 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2672 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2673 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2674 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002675 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2676 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002677 <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>
2678 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2679 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002680 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002681 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002682 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2683 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2684 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2685 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2686 <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>
2687 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2688 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2689 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2690 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2691
2692 <tr><td>&nbsp;</td></tr>
2693
2694 <tr><td>Gaussian-noise</td></tr>
2695 <tr><td>Impulse-noise</td></tr>
2696 <tr><td>Laplacian-noise</td></tr>
2697 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2698 <tr><td>PoissonNoise</td></tr>
2699 <tr><td>Uniform-noise</td></tr>
2700
2701 <tr><td>&nbsp;</td></tr>
2702
2703 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2704 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2705 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2706 </tbody>
2707 </table>
2708
2709<p>The specified functions are applied only to each previously set <a
2710href="#channel" >-channel</a> in the image. If necessary, the results of the
2711calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2712class="QR">QuantumRange</em>]. The transparency channel of the image is
2713represented as a 'alpha' values (0 = fully transparent), so, for example, a
2714<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2715semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2716as a percentage of the <em class="QR">QuantumRange</em>.</p>
2717
2718<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2719<a href="#list">-list evaluate</a>.</p>
2720
2721<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2722<kbd>Multiply</kbd> methods can also be achieved using either the <a
2723href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2724appropriate argument, to linearly modify the overall range of color values.
2725Please note, however, that <a href="#level" >-level</a> treats transparency as
2726'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2727'alpha' values.</p>
2728
2729<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>
2730
cristyce66ab12010-10-21 23:36:32 +00002731<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>
2732
2733 <div style="text-align:center;">
2734 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2735 </div>
2736
2737<p> If the input image is squared, for example, using <a
2738href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2739
cristy3ed852e2009-09-05 21:47:34 +00002740<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>
2741
2742 <div style="text-align:center;">
2743 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2744 </div>
2745
2746<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2747normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2748href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2749to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2750with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2751with <kbd>Pow</kbd>.</p>
2752
2753<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2754converts the image values into a value according to a (co)sine wave function.
2755The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2756is biased 50% and normalized by 50% so as to fit in the respective color value
2757range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2758function (its frequency), and thus determines the number of 'waves' that will
2759be generated over the input color range. For example, if the <em
2760class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2761class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2762then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002763class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002764
2765 <div style="text-align:center;">
2766 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2767 </div>
2768
cristydcca3fa2010-12-29 21:50:07 +00002769<p>See also the <a href="#function" >-function</a> operator, which is a
2770multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002771
cristy63fed272010-03-07 19:08:45 +00002772<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002773 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002774</div>
2775
2776<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 +00002777
2778<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002779 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002780</div>
2781
2782<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>
2783
cristy3e2860c2010-01-24 01:36:30 +00002784<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 +00002785<p>This command reduces or expands a JPEG image to fit on an 800x600
2786display. If the aspect ratio of the input image isn't exactly 4:3, then the
2787image is centered on an 800x600 black canvas: </p>
2788
2789<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>
2790
cristy3ed852e2009-09-05 21:47:34 +00002791
2792<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>
2793
2794<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002795 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002796</div>
2797
2798<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>
2799
2800<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2801
cristy4949d522010-03-12 18:41:34 +00002802<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 +00002803
cristy4949d522010-03-12 18:41:34 +00002804<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 +00002805<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002806equivalent to:</p>
2807
2808<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>
2809<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>
2810
2811<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002812 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002813</div>
2814
2815<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>
2816
2817<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).
2818</p>
2819
2820<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>.
2821</p>
2822
2823<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002824 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002825</div>
2826
2827<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>
2828
2829<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002830 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002831</div>
2832
2833<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>
2834
cristydcca3fa2010-12-29 21:50:07 +00002835<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 +00002836
cristydcca3fa2010-12-29 21:50:07 +00002837<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 +00002838
2839<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>
2840
2841<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2842<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>
2843
2844<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2845<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>
2846
cristyd0bd44a2010-09-24 12:38:11 +00002847<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 +00002848
2849<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>
2850
2851<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2852 -evaluate log 1000 fft_image_spectrum.png</span></p>
2853<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>
2854
cristydcca3fa2010-12-29 21:50:07 +00002855<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 +00002856
2857<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>
2858
2859<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>
2860
cristydcca3fa2010-12-29 21:50:07 +00002861<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 +00002862
2863<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +00002864<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 +00002865</p>
2866
2867
2868<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002869 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002870</div>
2871
2872<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>
2873
2874<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>
2875
2876<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2877
2878<p>For example,</p>
2879
2880<p class="crtsnip">
2881 -fill blue
2882</p>
2883<p class="crtsnip">
2884 -fill "#ddddff"
2885</p>
2886<p class="crtsnip">
2887 -fill "rgb(255,255,255)"
2888</p>
2889
2890<p>See <a href="#draw">-draw</a> for further details.</p>
2891
2892<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2893
2894<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002895 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002896</div>
2897
cristyd0bda5e2010-09-21 16:22:45 +00002898<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
2899distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002900
cristyd0bda5e2010-09-21 16:22:45 +00002901<p>Use this option to affect the resizing operation of an image during
2902operations such as <a href="#resize">-resize</a> and <a href="#distort"
2903>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002904
2905<pre class="text">
2906 Point Hermite Cubic
2907 Box Gaussian Catrom
2908 Triangle Quadratic Mitchell
2909</pre>
2910
cristyd0bda5e2010-09-21 16:22:45 +00002911<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002912as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2913generally useless on their own as they are infinite filters that are being
2914clipped to the filters support size. Their direct use is not recommended
2915except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002916
cristydcca3fa2010-12-29 21:50:07 +00002917<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002918function that the <a href="#filter" >-filter</a> setting defines. That is
2919using these functions will define a 'Windowed' filter, appropriate to the
2920operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002921
2922<pre class="text">
2923 Lanczos Hamming Parzen
2924 Blackman Kaiser Welsh
2925 Hanning Bartlett Bohman
2926</pre>
2927
2928<p>Also one special self-windowing filter is also provided
2929<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2930on the current 'support' or 'lobes' expert settings (see below).</p>
2931
cristyd0bda5e2010-09-21 16:22:45 +00002932<p>If you do not select a filter with this option, the filter defaults to
2933<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2934if the image is enlarged. Otherwise the filter default to
2935<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002936
cristyd0bda5e2010-09-21 16:22:45 +00002937<p>To print a complete list of resize filters, use the <a href="#list">-list
2938filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002939
2940<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002941use of these expert settings (see also <a href="#define" >-define</a> and <a
2942href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002943
2944<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002945<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002946<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002947 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2948 Gaussian-like filters simple filters, or you may not get the expected
2949 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002950
cristyd0bda5e2010-09-21 16:22:45 +00002951<dt>-define filter:support=<em>radius</em></dt>
2952<dd>Set the filter support radius. Defines how large the filter should be and
2953 thus directly defines how slow the filtered resampling process is. All
2954 filters have a default 'prefered' support size. Some filters like
2955 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2956 this value. With simple filters this value either does nothing (but slow
2957 the resampling), or will clip the filter function in a detrimental way.
2958 </dd>
cristy3ed852e2009-09-05 21:47:34 +00002959
cristyd0bda5e2010-09-21 16:22:45 +00002960<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002961<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00002962 alternative way of specifying the 'support' range of the filter, that is
2963 designed to be more suited to windowed filters, especially when used for
2964 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002965
cristyd0bda5e2010-09-21 16:22:45 +00002966<dt>-define filter:b=<em>b-spline_factor</em></dt>
2967<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002968<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2969 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2970 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2971 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00002972 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00002973 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002974
cristyd0bda5e2010-09-21 16:22:45 +00002975<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002976<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00002977 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00002978 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00002979 'Bessel' functions. If defined, no windowing function is used, unless the
2980 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002981
cristyd0bda5e2010-09-21 16:22:45 +00002982<dt>-define filter:window=<em>filter_function</em></dt>
2983<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
2984 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
2985 support range) with the given filter. This allows you to specify a filter
2986 function that is not normally used as a windowing function, such as
2987 <kbd>Box</kbd>, (which effectively turns off the windowing function),
2988 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
2989 </dd>
2990
2991<dt>-define filter:verbose=<em>1</em></dt>
2992<dd>This causes IM to print information on the final internal filter
2993 selection to standard output. This includes a commented header on the
2994 filter settings being used, and data allowing the filter weights to be
2995 easily graphed. </dd>
2996
2997<dd>Note however that some filters are internally defined in terms of other
2998 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
2999 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
3000 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
3001 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00003002
3003</dl>
3004
cristyd0bda5e2010-09-21 16:22:45 +00003005<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00003006
3007<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
3008 -set filter:window=bessel -set filter:lobes=8 \ <br/>
3009 -resize 150% image.jpg</span></p>
3010<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3011
3012<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
3013 -resize 150% image.jpg</span></p>
3014<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00003015filters, and 'verbose' for viewing the internal filter selection), are
3016provided for image processing experts who have studied and understood how
3017resize filters work. Without this knowledge, and an understanding of the
3018definition of the actual filters involved, using expert settings are more
3019likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00003020
3021
3022<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003023 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00003024</div>
3025
3026<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>
3027
3028
3029<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003030 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00003031</div>
3032
3033<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>
3034
3035<p>reflect the scanlines in the vertical direction.</p>
3036
3037<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003038 <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 +00003039</div>
3040
3041<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. Using <a href="#fuzz" >-fuzz</a> to floodfill pixels which only change by a small amount.</td><td style='text-align:right;'></td></tr></table>
3042
3043<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003044 <h4><a id="flop"></a>-flop</h4>
cristy3ed852e2009-09-05 21:47:34 +00003045</div>
3046
3047<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>
3048
3049<p>reflect the scanlines in the horizontal direction.</p>
3050
3051
3052<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003053 <h4><a id="font"></a>-font <em class="arg">name</em></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%'>set the font to use when annotating images with text, or creating labels.</td><td style='text-align:right;'></td></tr></table>
3057
3058<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>
3059
3060<p>In addition to the fonts specified by the above pre-defined list, you can
3061also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
3062is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
3063<kbd>x:fixed</kbd> is X11 font.</p>
3064
3065<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>
3066
3067
3068<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003069 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003070</div>
3071
3072<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>
3073
3074<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3075
3076<p>The default foreground color is black.</p>
3077
3078<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003079 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003080</div>
3081
3082<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>
3083
cristy47774982011-02-15 15:17:19 +00003084<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 +00003085
3086<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>
3087
3088<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003089 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003090</div>
3091
3092<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>
3093
3094<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>
3095
3096<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003097 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003098</div>
3099
3100<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>
3101
cristybc9539a2010-08-16 18:06:20 +00003102<p>The color of the border is specified with the <a href="#mattecolor"
3103>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003104
cristybc9539a2010-08-16 18:06:20 +00003105<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
3106class="arg">geometry</em> argument indicates the amount of extra width and
3107height that is added to the dimensions of the image. If no offsets are given
3108in the <em class="arg">geometry</em> argument, then the border added is
3109a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3110the width and height of the border is partitioned to form an outer bevel of
3111thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3112<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3113</p>
3114
3115<p>The <a href="#frame">-frame</a> option is affected by the current <a
3116href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003117'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003118size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3119draws the frame of four distinct colors close to the current <a
3120href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3121center of this image. This means that with the default compose method of
3122'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3123href="#bordercolor">-bordercolor</a> setting.</p>
3124
3125<p>The image composition is not
3126affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003127
3128
3129<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003130 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003131</div>
3132
3133<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>
3134
3135<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003136 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</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%'>Apply a function to channel values.</td><td style='text-align:right;'></td></tr></table>
3140
3141<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>
3142
3143<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>
3144
3145<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>
3146
3147<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003148 Polynomial
3149 Sinusoid
3150 Arcsin
3151 Arctan
cristy3ed852e2009-09-05 21:47:34 +00003152</pre>
3153
3154<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3155
3156<dl class="doc">
3157<dt><kbd>Polynomial</kbd></dt>
3158<dd>
3159<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>
3160
3161<div style="text-align: center">
3162 -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>
3163</div>
3164
3165<p>will invoke a polynomial function given by</p>
3166
3167<div style="text-align: center">
3168 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3169 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3170 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3171</div>
3172
3173<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3174
3175<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>
3176
3177<table class="doc">
3178 <col width="35%" />
3179 <col width="35%" />
3180 <col width="30%" />
3181 <tr>
3182 <td>-evaluate Set <em class="arg">value</em> </td>
3183 <td>-function Polynomial <em class="arg">value</em></td>
3184 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3185 </tr>
3186 <tr>
3187 <td>-evaluate Add <em class="arg">value</em> </td>
3188 <td>-function Polynomial 1,<em class="arg">value</em></td>
3189 </tr>
3190 <tr>
3191 <td>-evaluate Subtract <em class="arg">value</em> </td>
3192 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3193 </tr>
3194 <tr>
3195 <td>-evaluate Multiply <em class="arg">value</em> </td>
3196 <td>-function Polynomial <em class="arg">value</em>,0</td>
3197 </tr>
3198 <tr>
3199 <td>+level black% x white%</td>
3200 <td>-function Polynomial A,B</td>
3201 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3202 </tr>
3203</table>
3204
3205<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>
3206</dd>
3207
3208<dt><kbd>Sinusoid</kbd></dt>
3209<dd>
3210<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>
3211
3212<div style="text-align: center">
3213 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3214</div>
3215
3216<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>
3217
3218<div style="text-align: center">
3219<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>
3220</div>
3221
3222<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>
3223
3224<p class="crtsnip">
3225 -function Sinusoid 3,-90,.2,.7
3226</p>
3227
3228<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>
3229
3230<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>
3231
3232<table class="doc">
3233 <tr>
3234 <td>-evaluate Sin <em class="arg">freq</em> </td>
3235 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3236 </tr>
3237 <tr>
3238 <td>-evaluate Cos <em class="arg">freq</em> </td>
3239 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3240 </tr>
3241</table>
3242</dd>
3243
3244<dt><kbd>ArcSin</kbd></dt>
3245<dd>
3246<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3247and can be used to generate cylindrical distortion and displacement maps.
3248The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003249of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003250
cristydcca3fa2010-12-29 21:50:07 +00003251<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003252 -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 +00003253</p>
cristy3ed852e2009-09-05 21:47:34 +00003254
3255<p>with all values given in terms of noramlize color values (0.0 for black,
32561.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3257for bout input (<em class="arg">width</em>), and output (<em
3258class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3259
cristydcca3fa2010-12-29 21:50:07 +00003260<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003261<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 +00003262</p>
cristy3ed852e2009-09-05 21:47:34 +00003263
3264</dd>
3265
3266<dt><kbd>ArcTan</kbd></dt>
3267<dd>
3268<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3269limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003270All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003271
cristydcca3fa2010-12-29 21:50:07 +00003272<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003273 -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 +00003274</p>
cristy3ed852e2009-09-05 21:47:34 +00003275
3276<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3277</p>
3278
cristydcca3fa2010-12-29 21:50:07 +00003279<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003280<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 +00003281</p>
cristy3ed852e2009-09-05 21:47:34 +00003282
3283</dd>
3284
3285</dl>
3286
3287
3288<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003289 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003290</div>
3291
3292<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>
3293
3294<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>
3295
3296<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>
3297
3298
3299<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003300 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003301</div>
3302
3303<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>
3304
3305<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>
3306
3307<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3308
3309
3310<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003311 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003312</div>
3313
3314<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>
3315
3316<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>
3317
3318<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>
3319
3320<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>
3321
3322<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>
3323
3324<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3325
3326<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003327 <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 +00003328</div>
3329
3330<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>
3331
cristyb15553d2010-07-03 22:53:14 +00003332<p>Convolve the image with a Gaussian or normal distribution using the given
3333<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003334
3335<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3336</div>
3337
cristyb15553d2010-07-03 22:53:14 +00003338<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003339determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003340
3341<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003342array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003343integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003344radius that will provide meaningful results for the Gaussian distribution.
3345</p>
3346
3347<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3348operation is. However too small a <em class="arg" >Radius</em>, and sever
3349aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3350should be at least twice the <em class="arg" >Sigma</em> value, though three
3351times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003352
3353<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003354full 2-dimensional convolution is used to generate the weighted average of the
3355neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003356
3357<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3358pixels which are outside the image proper are blurred into the final result.
3359</p>
3360
3361
3362<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003363 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003364</div>
3365
3366<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>
3367
3368<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>
3369
3370<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003371 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003372</div>
3373
3374<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Sets the current gravity suggestion for various other settings and options.</td><td style='text-align:right;'></td></tr></table>
3375
3376<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3377<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3378<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3379list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3380installation.</p>
3381
3382<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>
3383
3384<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>
3385
3386<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>
3387
cristy4949d522010-03-12 18:41:34 +00003388<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 +00003389<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>
3390
3391<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>
3392
3393
3394<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003395 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003396</div>
3397
3398<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>
3399
3400
3401<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003402 <h4><a id="hald-clut"></a>-hald-clut</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%'>apply a Hald color lookup table to the image.</td><td style='text-align:right;'></td></tr></table>
3406
3407<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3408dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3409can apply any color transformation to the Hald image and then use this option
3410to apply the transform to the image. </p>
3411
3412<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3413<p>This option provides a convenient method for you to use Gimp or Photoshop
3414to make color corrections to the Hald CLUT image and subsequently apply them
3415to multiple images using an ImageMagick script. </p>
3416
3417<p>Note that the representation is only of the normal RGB color space and that
3418the whole color value triplet is used for the interpolated lookup of the
3419represented Hald color cube image. Because of this the operation is not <a
3420href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3421images transparency or alpha/matte channel.</p>
3422
3423<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3424of the individual color channels, usally involving a simplier gray-scale
3425image. E.g: gray-scale to color replacement, or modification by a histogram
3426mapping. </p>
3427
3428
3429<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003430 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003431</div>
3432
3433<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>
3434
3435<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003436 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003437</div>
3438
3439<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>
3440
3441<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003442 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003443</div>
3444
3445<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the icon geometry.</td><td style='text-align:right;'></td></tr></table>
3446
3447<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>
3448
3449<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>
3450
3451<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003452 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003453</div>
3454
3455<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>iconic animation.</td><td style='text-align:right;'></td></tr></table>
3456
3457<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003458 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003459</div>
3460
3461<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>
3462
3463<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>
3464
cristy47774982011-02-15 15:17:19 +00003465<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 +00003466
cristyd0bda5e2010-09-21 16:22:45 +00003467<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003468amounts of image properties are displayed including image statistics, profiles,
3469image histogram, and others.</p>
3470
3471<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003472 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003473</div>
3474
3475<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>
3476
cristydcca3fa2010-12-29 21:50:07 +00003477<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 +00003478
3479<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>
3480
3481<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3482<p>or</p>
3483
3484<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>
3485
cristydcca3fa2010-12-29 21:50:07 +00003486<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 +00003487
cristydcca3fa2010-12-29 21:50:07 +00003488<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 +00003489
cristydcca3fa2010-12-29 21:50:07 +00003490<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 +00003491
3492<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003493 <h4><a id="immutable"></a>-immutable</h4>
cristy3ed852e2009-09-05 21:47:34 +00003494</div>
3495
3496<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>make image immutable.</td><td style='text-align:right;'></td></tr></table>
3497
3498<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003499 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003500</div>
3501
3502<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>implode image pixels about the center.</td><td style='text-align:right;'></td></tr></table>
3503
3504<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003505 <h4><a id="insert"></a>-insert <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003506</div>
3507
3508<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>insert the last image into the image sequence.</td><td style='text-align:right;'></td></tr></table>
3509
3510<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>
3511
3512<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>
3513
3514<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003515 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003516</div>
3517
3518<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>use this type of rendering intent when managing the image color.</td><td style='text-align:right;'></td></tr></table>
3519
3520<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>
3521
3522<p>The default intent is undefined.</p>
3523
3524<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3525
3526<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003527 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003528</div>
3529
3530<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>
3531
3532<p>Choose from:</p>
3533
3534<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003535 none
3536 line
3537 plane
3538 partition
3539 JPEG
3540 GIF
3541 PNG
cristy3ed852e2009-09-05 21:47:34 +00003542</pre>
3543
3544<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>
3545
3546<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3547
3548<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3549
3550<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3551
3552<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3553image.G, and image.B).</p>
3554
3555<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>
3556image.</p>
3557
3558<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3559
3560<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003561 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003562</div>
3563
3564<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>
3565
cristyd0bda5e2010-09-21 16:22:45 +00003566<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003567value, you typically fall in between the pixel colors defined by the source
3568image. This setting determines how the color is determined from the colors of
3569the pixels surrounding that point. That is how to determine the color of a
3570point that falls between two, or even four different colored pixels. </p>
3571
3572<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00003573 integer The color of the top-left pixel (floor function)
3574 nearest-neighbor The nearest pixel to the lookup point (rounded function)
3575 average The average color of the surrounding four pixels
3576 bilinear A double linear interpolation of pixels (the default)
3577 mesh Divide area into two flat triangular interpolations
3578 bicubic Fitted bicubic-spines of surrounding 16 pixels
3579 spline Direct spline curves (colors are blurred)
3580 filter Use resize <a href="#filter">-filter</a> settings
cristy3ed852e2009-09-05 21:47:34 +00003581</pre>
3582
3583<p>This most important for distortion operators such as <a href="#distort"
3584>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3585>-transform</a> and <a href="#fx" >-fx</a>. </p>
3586
3587<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3588
3589<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3590lookup for positions outside the boundaries of the image. </p>
3591
3592
3593<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003594 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003595</div>
3596
3597<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>
3598
3599<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003600 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</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%'>the space between two words.</td><td style='text-align:right;'></td></tr></table>
3604
3605<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003606 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003607</div>
3608
3609<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>
3610
3611<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003612 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003613</div>
3614
3615<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>
3616
cristy71a3f602010-09-15 12:38:16 +00003617<p>Use this option to assign a specific label to the image, as it is read in
3618or created. You can use the <a href="#set" >-set</a> operation to re-assign
3619a the labels of images already read in. Image formats such as TIFF, PNG,
3620MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003621
cristy71a3f602010-09-15 12:38:16 +00003622<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3623assigned to an image is used as a header string to print above the postscript
3624image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003625
cristybc9539a2010-08-16 18:06:20 +00003626<p>You can include the image filename, type, width, height, or other image
3627attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3628Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003629
3630<p>For example,</p>
3631
3632<p class="crtsnip">
3633 -label "%m:%f %wx%h" bird.miff
3634</p>
3635
cristy71a3f602010-09-15 12:38:16 +00003636<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3637"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3638is read in. If a <a href="#label">+label</a> option was used instead, any
3639existing label present in the image would be used. You can remove all labels
3640from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003641
cristy71a3f602010-09-15 12:38:16 +00003642<p>A label is not drawn on the image, but is embedded in the image datastream
3643via <em>Label</em> tag or similar mechanism. If you want the label to be
3644visible on the image itself, use the <a href="#draw">-draw</a> option, or
3645during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003646
cristy71a3f602010-09-15 12:38:16 +00003647<p>If the first character of <em class="arg">string</em> is <em
3648class="arg">@</em>, the image label is read from a file titled by the
3649remaining characters in the string. Labels in a file are literal, no embedded
3650formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003651
3652
3653<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003654 <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 +00003655</div>
3656
3657<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>
3658
3659<p>Adaptively threshold each pixel based on the value of pixels in a
3660surrounding window. If the current pixel is lighter than this average plus
3661the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3662black. Small variations in pixel values such as found in scanned documents
3663can be ignored if offset is positive. A negative offset will make it more
3664sensitive to those small variations. </p>
3665
3666<p>This is commonly used to threshold images with an uneven background. It is
3667based on the assumption that average color of the small window is the
3668the local background color, from which to separate the forground color. </p>
3669
3670
3671<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003672 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003673</div>
3674
3675<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>handle multiple images forming a set of image layers or animation frames.</td><td style='text-align:right;'></td></tr></table>
3676
3677<p>Perform various image operation methods to a ordered sequence of images
3678which may represent either a set of overlaid 'image layers', a GIF disposal
3679animation, or a fully-'coalesced' animation sequence. </p>
3680
3681<table class="doc">
3682 <tbody>
3683 <tr valign="top">
3684 <th align="left" style="width: 8%">Method</th>
3685 <th align="left">Description</th>
3686 </tr>
3687
3688 <tr valign="top">
3689 <td valign="top">compare-any</td>
3690 <td valign="top">Crop the second and later frames to the smallest rectangle
3691 that contains all the differences between the two images. No GIF <a
3692 href="#dispose" >-dispose</a> methods are taken into account. </td>
3693 </tr>
3694
3695 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3696 >-deconstruct</a> operator, and does not preserve animations normal
3697 working, especially when animation used layer disposal methods such as
3698 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3699 </tr>
3700
3701 <tr valign="top">
3702 <td valign="top">compare-clear</td>
3703 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3704 opaque pixels which become transparent in the second frame. That is the
3705 smallest image needed to mask or erase pixels for the next frame. </td>
3706 </tr>
3707
3708 <tr valign="top">
3709 <td valign="top">compare-overlay</td>
3710 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3711 extra color to the next image, as a result of overlaying color pixels.
3712 That is the smallest single overlaid image to add or change colors. </td>
3713 </tr>
3714
3715 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3716 composition method '<kbd>change-mask</kbd>', to reduce the image to
3717 just the pixels that need to be overlaid. </td>
3718 </tr>
3719
3720 <tr valign="top">
3721 <td valign="top">coalesce</td>
3722 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3723 >-coalesce</a> operator. Apply the layer disposal methods set in the
3724 current image sequence to form a fully defined animation sequence, as
3725 it should be displayed. Effectively converting a GIF animation into a
3726 'film strip'-like animation. </td>
3727 </tr>
3728
3729 <tr valign="top">
3730 <td valign="top">composite</td>
3731 <td valign="top">Alpha Composition of two image lists, separated by a
3732 "<kbd>null:</kbd>" image, with the destination image list first, and
3733 the source images last. An image from each list are composited
3734 together until one list is finished. The separator image and source
3735 image lists are removed. </td>
3736 </tr>
3737
3738
cristybac7a162010-06-15 19:57:29 +00003739 <tr><td></td>
3740 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3741 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3742 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003743 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003744 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003745
cristybac7a162010-06-15 19:57:29 +00003746 <tr><td></td>
3747 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003748 applied to all the images in the other image list, regardless of which
3749 list it is. In this case it is the image meta-data of the list which
3750 preserved. </td>
3751 </tr>
3752
3753
3754 <tr valign="top">
3755 <td valign="top">dispose</td>
3756 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3757 the animation after the layer disposal method has been applied, before
3758 the next sub-frame image is overlaid. That is the 'dispose' image that
3759 results from the application of the GIF <a href="#dispose"
3760 >-dispose</a> method. This allows you to check what
3761 is going wrong with a particular animation you may be developing.
3762 </td>
3763 </tr>
3764
3765 <tr valign="top">
3766 <td valign="top">flatten</td>
3767 <td valign="top">Create a canvas the size of the first images virtual
3768 canvas using the current <a href="#background" >-background</a> color,
3769 and <a href="#compose" >-compose</a> each image in turn onto that
3770 canvas. Images falling outside that canvas is clipped. Final
3771 image will have a zero virtual canvas offset. </td>
3772 </tr>
3773
cristybac7a162010-06-15 19:57:29 +00003774 <tr><td></td>
3775 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003776 overlaying all the prepared image layers into a final image. </td>
3777 </tr>
3778
cristybac7a162010-06-15 19:57:29 +00003779 <tr><td></td>
3780 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003781 canvas with real pixels, or to underlay a opaque color to remove
3782 transparency from an image.</td>
3783 </tr>
3784
3785
3786 <tr valign="top">
3787 <td valign="top">merge</td>
3788 <td valign="top">As 'flatten' method but merging all the given image
3789 layers into a new layer image just large enough to hold all the image
3790 without clipping or extra space. The new images virtual offset will
3791 prevere the position of the new layer, even if this offset is
3792 negative. the virtual canvas size of the first image is preserved.
3793 </td>
3794 </tr>
3795
3796 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3797 as few image file formats handle them correctly. </td>
3798 </tr>
3799
3800 <tr valign="top">
3801 <td valign="top">mosaic</td>
3802 <td valign="top">As 'flatten' method but expanding the initial canvas size
3803 of the first image so as to hold all the image layers. However as a
cristyd0bda5e2010-09-21 16:22:45 +00003804 virtual canvas is 'locked' to the origin, by definition, image layers
cristy3ed852e2009-09-05 21:47:34 +00003805 with a negative offsets will still be clipped by the top and left
3806 edges.</td>
3807 </tr>
3808
3809 <tr><td></td><td>This method is commonly used to layout individual image using various
cristyd0bda5e2010-09-21 16:22:45 +00003810 offset but without knowing the final canvas size. The resulting image
cristy3ed852e2009-09-05 21:47:34 +00003811 will, like 'flatten' not have any virtual offset, so can be saved to
3812 any image file format. </td>
3813 </tr>
3814
3815
3816 <tr valign="top">
3817 <td valign="top">optimize</td>
3818 <td valign="top">Optimize a coalesced animation, into GIF animation using
3819 a number of general techniques. This currently a short cut to
3820 apply both the '<kbd>optimize-frame</kbd>', and
3821 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3822 include other optimization methods as they are developed. </td>
3823 </tr>
3824
3825 <tr valign="top">
3826 <td valign="top">optimize-frame</td>
3827 <td valign="top">Optimize a coalesced animation, into GIF animation by
3828 reducing the number of pixels per frame as much as possible by
3829 attempting to pick the best layer disposal method to use, while ensuring
3830 the result will continue to animate properly. </td>
3831 </tr>
3832
3833 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3834 then no reasonably fast GIF optimization algorithm can do this.
3835 However this does seem to do better than most other GIF frame
3836 optimizers seen. </td>
3837 </tr>
3838
3839 <tr valign="top">
3840 <td valign="top">optimize-plus</td>
3841 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3842 overall optimization by adding extra frames to the animation, without
3843 changing the final look or timing of the animation. The frames are
3844 added to attempt to separate the clearing of pixels from the
3845 overlaying of new additional pixels from one animation frame to the
3846 next. If this does not improve the optimization (for the next frame
3847 only), it will fall back to the results of the previous normal
3848 '<kbd>optimize-frame</kbd>' technique. </td>
3849 </tr>
3850
3851 <tr><td></td><td>There is the possibility that the change in the disposal style will
3852 result in a worsening in the optimization of later frames, though this
3853 is unlikely. In other words there no guarantee that it is better than
3854 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
cristyd0bda5e2010-09-21 16:22:45 +00003855 however you can get a vast improvement in the final animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003856 </tr>
3857
3858 <tr valign="top">
3859 <td valign="top">optimize-transparency</td>
3860 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3861 overlay images with transparency, if it does not change the resulting
3862 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3863 </td>
3864 </tr>
3865
3866 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3867 into a smaller file size due to larger areas of one (transparent)
3868 color rather than a pattern of multiple colors repeating the current
3869 disposed image of the last frame. </td>
3870 </tr>
3871
3872 <tr valign="top">
3873 <td valign="top">remove-dups</td>
3874 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3875 images, so as to simplify layer overlays of coalesced animations.
3876 </td>
3877 </tr>
3878
3879 <tr><td></td><td>Usually this a result of using a constant time delay across the
3880 whole animation, or after a larger animation was split into smaller
3881 sub-animations. The duplicate frames could also have been used as
3882 part of some frame optimization methods. </td>
3883 </tr>
3884
3885 <tr valign="top">
3886 <td valign="top">remove-zero</td>
3887 <td valign="top">Remove any image with a zero time delay, unless ALL the
3888 images have a zero time delay (and is not a proper timed animation, a
3889 warning is then issued). </td>
3890 </tr>
3891
3892 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3893 partial intermediary updates between the frames that are actually
3894 displayed to users. These frames are usally added for improved frame
3895 optimization in GIF animations. </td>
3896 </tr>
3897
3898 <tr valign="top">
3899 <td valign="top">trim-bounds</td>
3900 <td valign="top">Find the bounds of all the images in the current
3901 image sequence, then adjust the offsets so all images are contained on
3902 a minimal positive canvas. None of the image data is modified, only
3903 there virtual canvas size and offset. The all the image is given
3904 the same canvas size, and and will have a positive offset, but will
3905 remain in the same position relative to each other. As a result of the
3906 minimal canvas size at least one image will touch every edge of that
3907 canvas. The image data however may be transparent.
3908 </td>
3909 </tr>
3910
3911 </tbody>
3912</table>
3913
3914<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3915
3916<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3917>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3918>-mosaic</a> are only aliases for the above methods. Also see <a
3919href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3920href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3921>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3922
3923
3924<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003925 <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 +00003926</div>
3927
3928<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>
3929
3930<p>Given one, two or three values delimited with commas: black-point,
3931white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3932white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3933point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3934contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3935both black and white points are percentages of the full color range. Gamma
3936will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3937omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3938
3939<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3940the given '<kbd>black_point</kbd>' value in the original image is set to
3941zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3942<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3943to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3944adjusted. </p>
3945
3946<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3947adding the special '!' flag anywhere in the argument list, will cause the
3948operator to do the reverse of the level adjustment. That is a zero, or
3949<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
3950adjusted to the given level values, allowing you to de-contrast, or compress
3951the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
3952
3953<p>Only the channels defined by the current <a href="#channel">-channel</a>
3954setting are adjusted (defaults to RGB color channels only), allowing you to
3955limit the effect of this operator. </p>
3956
3957<p>Please note that the transparency channel is treated as 'matte'
3958values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
3959
3960
3961<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003962 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00003963 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
3964</div>
3965
cristyd0bda5e2010-09-21 16:22:45 +00003966<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 +00003967
3968<p>This function is exactly like <a href="#level">-level</a>, except that the
3969value value for each color channel is determined by the
3970'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
3971described under the <a href="#fill">-fill</a> option). </p>
3972
cristyd0bda5e2010-09-21 16:22:45 +00003973<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
3974is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00003975colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00003976adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00003977
3978<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
3979will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00003980respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00003981those colors. This can also be used to convert a plain gray-scale image into a
3982one using the gradient of colors specified. </p>
3983
3984<p>By supplying a single color with a comma separator either before or after
3985that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00003986respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00003987used for both the black and white color points, making the operator either
3988threshold the images around that color (- form) or set all colors to that
3989color (+ form). </p>
3990
3991
3992<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003993 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003994</div>
3995
3996<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>
3997
3998<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>
3999
cristy6b636652009-12-05 17:16:11 +00004000<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 +00004001
4002<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00004003 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00004004</p>
4005
4006<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
4007
cristydcca3fa2010-12-29 21:50:07 +00004008<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 +00004009 File Area Memory Map Disk Thread Time
4010 ------------------------------------------------------------------------------
4011 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
cristydcca3fa2010-12-29 21:50:07 +00004012</pre>
4013
cristy3ed852e2009-09-05 21:47:34 +00004014<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>
4015
4016<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>
4017
4018<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>
4019
4020<p class="crtsnip">
4021-limit area 10mb
4022</p>
4023
cristyd0bda5e2010-09-21 16:22:45 +00004024<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 +00004025
4026<p class="crtsnip">
4027-limit area 10mb -limit disk 500mb
4028</p>
4029
4030<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
4031
4032<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>
4033
4034<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.
4035</p>
4036
4037<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.
4038</p>
4039
4040<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004041 <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 +00004042</div>
4043
4044<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>
4045
cristyd934d102009-10-10 12:55:13 +00004046<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
4047and uses a 'histogram bin' to determine the range of color values that needs to
4048be stretched. However it then stretchs those colors using the <a
4049href="#level" >-level</a> operator.</p>
4050
4051<p>As such while the initial determination may have 'binning' round off
4052effects, the image colors are stretched mathematically, rather than using the
4053histogram bins. This makes the operator more accurate. </p>
4054
4055<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
4056'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
4057perfect stretch of the color range. </p>
4058
4059<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
4060normalization of mathematical images. </p>
4061
4062<p>This operator is under review for re-development. </p>
4063
4064
cristy3ed852e2009-09-05 21:47:34 +00004065<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004066 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00004067</div>
4068
4069<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>
4070
4071<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004072 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004073</div>
4074
4075<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>rescale image with seam-carving.</td><td style='text-align:right;'></td></tr></table>
4076
4077<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>
4078
4079<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004080 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004081</div>
4082
4083<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>
4084
4085<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004086 Align Alpha Boolean Channel
4087 Class ClipPath Coder Color
4088 Colorspace Command Compose Compress
4089 Configure DataType Debug Decoration
4090 Delegate Direction Dispose Distort
4091 Dither Endian Evaluate FillRule
4092 Filter Font Format Function
4093 Gravity ImageList Intent Interlace
4094 Interpolate Kernel Layers LineCap
4095 LineJoin List Locale LogEvent
4096 Log Magic Method Metric
4097 Mime Mode Morphology Module
4098 Noise Orientation Policy PolicyDomain
4099 PolicyRights Preview Primitive QuantumFormat
4100 Resource SparseColor Storage Stretch
4101 Style Threshold Type Units
4102 Validate VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004103</pre>
4104
cristybac7a162010-06-15 19:57:29 +00004105<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4106list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4107available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004108
4109<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4110<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004111 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004112</div>
4113
4114<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>
4115
cristybac7a162010-06-15 19:57:29 +00004116<p>This option specifies the format for the log printed when the <a
4117href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004118
cristybac7a162010-06-15 19:57:29 +00004119<p>You can display the following components by embedding special format
4120characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004121
4122<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004123 %d domain
4124 %e event
4125 %f function
4126 %l line
4127 %m module
4128 %p process ID
4129 %r real CPU time
4130 %t wall clock time
4131 %u user CPU time
4132 %% percent sign
4133 \n newline
4134 \r carriage return
cristy3ed852e2009-09-05 21:47:34 +00004135</pre>
4136
4137<p>For example:</p>
4138
4139<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>
4140<p>The default behavior is to print all of the components.</p>
4141
4142<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004143 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004144</div>
4145
4146<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>
4147
cristybac7a162010-06-15 19:57:29 +00004148<p>Set iterations to zero to repeat the animation an infinite number of times,
4149otherwise the animation repeats itself up to <em class="arg">iterations</em>
4150times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004151
4152<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004153 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004154</div>
4155
4156<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>
4157
4158<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004159 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004160</div>
4161
4162<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>magnify the image.</td><td style='text-align:right;'></td></tr></table>
4163
4164
4165<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004166 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004167</div>
4168
4169<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>
4170
4171<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4172
4173<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004174 best
4175 default
4176 gray
4177 red
4178 green
4179 blue
cristy3ed852e2009-09-05 21:47:34 +00004180</pre>
4181
cristybac7a162010-06-15 19:57:29 +00004182<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4183Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4184the type and <kbd>display</kbd> searches the list of colormap types in
4185<kbd>top-to-bottom</kbd> order until one is located. See <em
4186class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004187
4188
4189<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004190 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004191</div>
4192
4193<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>pixel map.</td><td style='text-align:right;'>[<a href="../www/stream.html">stream</a>]</td></tr></table>
4194
4195<p>Here are the valid components of a map:</p>
4196
4197<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004198 r red pixel component
4199 g green pixel component
4200 b blue pixel component
4201 a alpha pixel component (0 is transparent)
4202 o opacity pixel component (0 is opaque)
4203 i grayscale intensity pixel component
4204 c cyan pixel component
4205 m magenta pixel component
4206 y yellow pixel component
4207 k black pixel component
4208 p pad component (always 0)
cristy3ed852e2009-09-05 21:47:34 +00004209</pre>
4210
cristybac7a162010-06-15 19:57:29 +00004211<p>You can specify as many of these components as needed in any order (e.g.
4212bgr). The components can repeat as well (e.g. rgbr).</p>
4213
cristy3ed852e2009-09-05 21:47:34 +00004214
4215<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004216 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004217<em class="arg">filename</em></h4>
4218</div>
4219
4220<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Composite the image pixels as defined by the mask.</td><td style='text-align:right;'></td></tr></table>
4221
4222<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
4223
4224<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004225 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004226</div>
4227
4228<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify the color to be used with the <a href="#frame">-frame</a> option.</td><td style='text-align:right;'></td></tr></table>
4229
4230<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4231
cristybac7a162010-06-15 19:57:29 +00004232<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4233style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004234
4235<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004236 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004237</div>
4238
4239<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>
4240
4241<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004242 <h4><a id="median"></a>-median <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004243</div>
4244
4245<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>apply a median filter to the image.</td><td style='text-align:right;'></td></tr></table>
4246
4247<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004248 <h4><a id="metric"></a>-metric <em class="arg">type</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%'>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>
4252
4253<p>Choose from:</p>
4254
4255<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004256 AE absolute error count, number of different pixels (-fuzz effected)
4257 FUZZ mean color distance
4258 MAE mean absolute error (normalized), average channel error distance
4259 MEPP mean error per pixel (normalized mean error, normalized peak error)
4260 MSE mean error squared, average of the channel error squared
4261 NCC normalized cross correlation
4262 PAE peak absolute (normalize peak absolute)
4263 PSNR peak signal to noise ratio
4264 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004265</pre>
4266
cristy771f7a72010-11-27 21:42:59 +00004267<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4268with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4269only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004270size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004271'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004272for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004273
4274<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4275('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004276normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004277
cristybac7a162010-06-15 19:57:29 +00004278<p>To print a complete list of metrics, use the <a href="#list">-list
4279metrics</a> option.</p>
4280
cristy3ed852e2009-09-05 21:47:34 +00004281
cristyd2baf7d2010-03-06 04:26:44 +00004282<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004283 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004284</div>
4285
4286<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>
4287
cristy3ed852e2009-09-05 21:47:34 +00004288
4289<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004290 <h4><a id="mode"></a>-mode <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004291</div>
4292
cristybe3c5be2011-03-05 17:35:07 +00004293<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>
4294
4295<div style="margin: auto;">
4296 <h4>-mode <em class="arg">value</em></h4>
4297</div>
4298
cristy3ed852e2009-09-05 21:47:34 +00004299<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>
4300
cristybac7a162010-06-15 19:57:29 +00004301<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4302Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004303
cristybac7a162010-06-15 19:57:29 +00004304<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4305for a list of <a href="#mode" >-mode</a> arguments available in your
4306ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004307
4308
4309<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004310 <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 +00004311</div>
4312
cristybac7a162010-06-15 19:57:29 +00004313<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
4314class="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 +00004315
cristyb36feb22010-03-26 16:54:37 +00004316<p>The arguments are given as a percentages of variation. A value of 100 means
4317no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004318
cristyb36feb22010-03-26 16:54:37 +00004319<p>The <em class="arg">brightness</em> is a multiplier of the overall
4320brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4321twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4322before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004323
cristyb36feb22010-03-26 16:54:37 +00004324<p>The <em class="arg">saturation</em> controls the amount of color in an
4325image. For example, 0 produce a grayscale image, while a large value such as
4326200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004327
cristyb36feb22010-03-26 16:54:37 +00004328<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4329within the image by the amount specified. For example, 50 results in
4330a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4331A value of either 0 or 200 results in a complete 180 degree rotation of the
4332image. Using a value of 300 is a 360 degree rotation resulting in no change to
4333the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004334
cristyb36feb22010-03-26 16:54:37 +00004335<p>For example, to increase the color brightness by 20% and decrease the color
4336saturation by 10% and leave the hue unchanged, use <a
4337href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004338
cristyb36feb22010-03-26 16:54:37 +00004339<p>Use <a href="#set">-set</a> attribute of '<kbd
4340class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4341modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4342<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004343
4344<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 +00004345
cristy3ed852e2009-09-05 21:47:34 +00004346<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004347 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004348</div>
4349
4350<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>
4351
4352
4353<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004354 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004355</div>
4356
4357<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>
4358
4359
4360<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004361 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004362</div>
4363
4364<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>
4365
4366<p>Both the image pixels and size are linearly interpolated to give the
4367appearance of a meta-morphosis from one image to the next, over all the images
4368in the current image list. The added images are the equivalent of a <a
4369href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4370argument determine how many images to interpolate between each image. </p>
4371
4372
4373<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004374 <h4><a id="morphology"></a>-morphology</h4>
4375 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004376</div>
4377
cristy2c839602010-04-03 02:32:08 +00004378<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 +00004379
cristydcca3fa2010-12-29 21:50:07 +00004380<p>Until I get around to writing a option summary for this, see <a
4381href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4382Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004383
4384
cristy488844c2010-01-22 14:02:05 +00004385<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004386 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004387</div>
4388
4389<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>
4390
4391
4392<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004393 <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 +00004394</div>
4395
4396<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>
4397
4398<p>Blur with the given radius, standard deviation (sigma), and angle. The
4399angle given is the angle toward which the image is blurred. That is the
4400direction people would consider the object is coming from. </p>
4401
4402<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004403definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004404
4405<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4406pixels which are outside the image proper are blurred into the final result.
4407</p>
4408
4409<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004410 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004411</div>
4412
4413<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>
4414<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004415 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004416</div>
4417
cristyb29bc032010-02-01 20:29:43 +00004418<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 +00004419
4420<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>
4421
4422<div style="margin: auto;">
cristye9a32c32011-04-07 01:11:05 +00004423 <h4><a id="noise"></a>-noise <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004424 +noise <em class="arg">type</em></h4>
4425</div>
4426
4427<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>
4428
4429<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>
4430
4431<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>
4432
4433<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>
4434
4435<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004436 Gaussian
4437 Impulse
4438 Laplacian
4439 Multiplicative
4440 Poisson
4441 Random
4442 Uniform
cristy3ed852e2009-09-05 21:47:34 +00004443</pre>
4444
4445<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4446
cristy83543962009-10-16 19:04:28 +00004447<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4448the use of a controlling value to specify teh amount of noise that should be
4449added to an image. </p>
4450
cristy3ed852e2009-09-05 21:47:34 +00004451
4452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004453 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004454</div>
4455
4456<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Increase the contrast in an image by <em>stretching</em> the range of intensity values.</td><td style='text-align:right;'></td></tr></table>
4457
cristyd934d102009-10-10 12:55:13 +00004458<p>The intensity values are stretched to cover the entire range of possible
4459values. While doing so, black-out at most <em>2%</em> of the pixels and
4460white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004461
cristyd934d102009-10-10 12:55:13 +00004462<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4463is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4464(Before this version, it was equivalent to <a href="#contrast-stretch"
4465>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004466
cristyd934d102009-10-10 12:55:13 +00004467<p>All the channels are normalized in concert by the came amount so as to
4468preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004469setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004470setting will normalize the RGB channels independently.</p>
4471
cristydcca3fa2010-12-29 21:50:07 +00004472<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004473Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004474that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004475
4476<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004477
4478
4479<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004480 <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 +00004481</div>
4482
cristyd934d102009-10-10 12:55:13 +00004483<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
4484class="arg">threshold map</em> specified, and a uniform color map with the
4485given 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 +00004486
4487<p>You can choose from these standard threshold maps:</p>
4488
4489<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004490 threshold 1x1 Threshold 1x1 (non-dither)
4491 checks 2x1 Checkerboard 2x1 (dither)
4492 o2x2 2x2 Ordered 2x2 (dispersed)
4493 o3x3 3x3 Ordered 3x3 (dispersed)
4494 o4x4 4x4 Ordered 4x4 (dispersed)
4495 o8x8 8x8 Ordered 8x8 (dispersed)
4496 h4x4a 4x1 Halftone 4x4 (angled)
4497 h6x6a 6x1 Halftone 6x6 (angled)
4498 h8x8a 8x1 Halftone 8x8 (angled)
4499 h4x4o Halftone 4x4 (orthogonal)
4500 h6x6o Halftone 6x6 (orthogonal)
4501 h8x8o Halftone 8x8 (orthogonal)
4502 h16x16o Halftone 16x16 (orthogonal)
4503 c5x5b c5x5 Circles 5x5 (black)
4504 c5x5w Circles 5x5 (white)
4505 c6x6b c6x6 Circles 6x6 (black)
4506 c6x6w Circles 6x6 (white)
4507 c7x7b c7x7 Circles 7x7 (black)
4508 c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004509</pre>
4510
cristy945bb352011-04-01 15:39:28 +00004511<p> The <kbd>threshold</kbd> generated a simple 50% threshold of the image.
4512This could be used with <em class="arg" >level</em> to do the equivelent of <a
4513href="#posterize" >-posterize</a> to reduce an image to basic primary colors.
4514</p>
cristy3ed852e2009-09-05 21:47:34 +00004515
cristy945bb352011-04-01 15:39:28 +00004516<p>The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
4517pattern. That is a grayscale will become a pattern of solid black, solid
4518white, and mid-tone colors into a checkerboard pattern of black and white.
4519</p>
cristy3ed852e2009-09-05 21:47:34 +00004520
cristy945bb352011-04-01 15:39:28 +00004521<p>You can define your own <em class="arg" >threshold map</em> for ordered
4522dithering and halftoning your images, in either personal or system
4523<kbd>thresholds.xml</kbd> XML file. See <a href="resources.html" >Resources</A>
4524for more details of configuration files. </p>
cristy3ed852e2009-09-05 21:47:34 +00004525
cristy945bb352011-04-01 15:39:28 +00004526<p>To print a complete list of the thresholds that have been defined, use the
4527<a href="#list" >-list threshold</a> option.</p>
4528
4529<p>Note that at this time the same threshold dithering map is used for all
4530color channels, no attempt is made to offset or rotate the map for different
4531channels is made, to create an offset printing effect. Also as the maps are
4532simple threshold levels, the halftone and circle maps will create incomplete
4533circles along the edges of a colored area. Also all the effects are purely
4534on/off boolean effects, without anti-aliasing to make the circles smooth
4535looking. Large dots can be made to look better with a small amount of blurring
4536after being created. </p>
cristy3ed852e2009-09-05 21:47:34 +00004537
4538
4539<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004540 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004541</div>
4542
4543<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>
4544
cristyc54f5d42009-11-27 21:36:31 +00004545<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004546described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4547>-fuzz</a> setting can be used to match and replace colors similar to the one
4548given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004549
cristyb36feb22010-03-26 16:54:37 +00004550<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4551the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004552
cristyb36feb22010-03-26 16:54:37 +00004553<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4554as <a href="#opaque" >-opaque</a> but replaces the matching color with
4555transparency rather than the current <a href="#fill">-fill</a> color setting.
4556To ensure that it can do this it also ensures that the image has an alpha
4557channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4558the new transparent colors, and does not require you to modify the <a
4559href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004560
cristy3ed852e2009-09-05 21:47:34 +00004561
4562<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004563 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004564</div>
4565
4566<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>
4567
4568<p>Choose from these orientations:</p>
4569
4570<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004571 bottom-left
4572 bottom-right
4573 left-bottom
4574 left-top
4575 right-bottom
4576 right-top
4577 top-left
4578 top-right
4579 undefined
cristy3ed852e2009-09-05 21:47:34 +00004580</pre>
4581
cristyd934d102009-10-10 12:55:13 +00004582<p>To print a complete list of orientations, use the <a href="#list" >-list
4583orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004584
4585
4586<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004587 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004588 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4589 +page
4590 </h4>
4591</div>
4592
4593<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>
4594
4595<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>
4596
4597<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>
4598
4599<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>
4600<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4601<thead>
4602 <tr valign="top">
4603 <th align="center"><em class="arg">media</em></th>
4604 <th align="center"><em class="arg">width</em></th>
4605 <th align="center"><em class="arg">height</em></th>
4606 </tr>
4607</thead>
4608<tbody>
4609<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4610<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4611<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4612<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4613<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4614<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4615<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4616<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4617<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4618<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4619<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4620<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4621<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4622<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4623<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4624<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4625<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4626<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4627<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4628<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4629<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4630<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4631<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4632<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4633<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4634<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4635<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4636<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4637<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4638<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4639<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4640<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4641<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4642<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4643<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4644<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4645<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4646<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4647</tbody>
4648</table>
4649
4650
4651
4652
4653<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>
4654
4655<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>
4656
4657<p>The default page dimensions for a TEXT image is 612x792.</p>
4658
4659<p>This option is used in concert with <a href="#density">-density</a>.</p>
4660
4661<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4662
4663<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004664 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004665</div>
4666
4667<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>
4668
4669<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>
4670
4671<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004672 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004673
4674<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>
4675
4676<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004677 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004678</div>
4679
4680<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>
4681
4682<p>Pause for the specified number of seconds before repeating the animation.</p>
4683
4684<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004685 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004686</div>
4687
4688<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>
4689
4690<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4691
4692<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004693 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004694</div>
4695
4696<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>
4697
4698<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004699 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004700</div>
4701
4702<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>
4703
4704<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004705 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004706</div>
4707
4708<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>
4709
4710<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4711
4712<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004713 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004714</div>
4715
4716<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>
4717
4718<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004719 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004720</div>
4721
4722<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>
4723
4724<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004725 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004726</div>
4727
4728<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>
4729
4730<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>
4731
4732<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004733 Rotate Shear Roll Hue
4734 Saturation Brightness Gamma Spiff
4735 Dull Grayscale Quantize Despeckle
4736 ReduceNoise Add Noise Sharpen Blur
4737 Threshold EdgeDetect Spread Shade
4738 Raise Segment Solarize Swirl
4739 Implode Wave OilPaint CharcoalDrawing
4740 JPEG
cristy3ed852e2009-09-05 21:47:34 +00004741</pre>
4742
4743<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4744
4745<p>The default preview is <kbd>JPEG</kbd>.</p>
4746
4747<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004748 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004749</div>
4750
4751<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>
4752
4753<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004754 <h4><a id="process"></a>-process <em class="arg">command</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004755</div>
4756
4757<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>
4758
4759<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>
4760
4761<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004762 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004763 +profile <em class="arg">profile_name</em></h4>
4764</div>
4765
4766<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>
4767
4768<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>
4769
4770<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>
4771
4772<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>
4773
4774<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>
4775
4776<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4777
4778<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4779<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>
4780
4781<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>
4782<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4783CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4784</p>
4785
cristyf7964272011-01-30 03:49:12 +00004786<p>The <a href="#profile">-profile</a> option can also be used to inject
4787previously-formatted ancillary chunks into the output PNG file, using
4788the commandline option as shown below or by setting the profile via a
cristy2bd2a982011-02-15 00:52:58 +00004789programming interface:</p>
cristyf7964272011-01-30 03:49:12 +00004790
cristy2bd2a982011-02-15 00:52:58 +00004791<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>-profile PNG-chunk-x:&lt;filename&gt;</span></p>
4792<p>where <em>x</em> is a location flag and
cristyf7964272011-01-30 03:49:12 +00004793<em class="arg">filename</em> is a file containing the chunk
4794name in the first 4 bytes, then a colon (":"), followed by the chunk data.
4795This encoder will compute the chunk length and CRC, so those must not
cristy2bd2a982011-02-15 00:52:58 +00004796be included in the file.</p>
cristyf7964272011-01-30 03:49:12 +00004797
cristy2bd2a982011-02-15 00:52:58 +00004798<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
cristyf7964272011-01-30 03:49:12 +00004799or "e" (end, i.e., after IDAT). If you want to write multiple chunks
4800of the same type, then add a short unique string after the "x" to prevent
cristy2bd2a982011-02-15 00:52:58 +00004801subsequent profiles from overwriting the preceding ones, e.g.,</p>
cristyf7964272011-01-30 03:49:12 +00004802
4803
4804<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>-profile PNG-chunk-b01:file01 -profile PNG-chunk-b02:file02</span></p>
cristy3ed852e2009-09-05 21:47:34 +00004805<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004806 <h4><a id="quality"></a>-quality <em class="arg">value</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%'>JPEG/MIFF/PNG compression level.</td><td style='text-align:right;'></td></tr></table>
4810
cristy851dbce2010-08-06 21:40:00 +00004811<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 +00004812
4813<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>
4814
cristy851dbce2010-08-06 21:40:00 +00004815<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 +00004816
cristy3c98a4f2010-08-13 20:09:41 +00004817<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 +00004818
4819<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4820
4821<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00004822 0: none
4823 1: sub
4824 2: up
4825 3: average
4826 4: Paeth
cristy3ed852e2009-09-05 21:47:34 +00004827</pre>
4828
4829<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>
4830
4831<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4832
4833<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>
4834
cristy3c98a4f2010-08-13 20:09:41 +00004835<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 +00004836
4837<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4838
cristy3ed852e2009-09-05 21:47:34 +00004839<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004840 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004841</div>
4842
cristy3c98a4f2010-08-13 20:09:41 +00004843<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 +00004844
cristy3c98a4f2010-08-13 20:09:41 +00004845<p>This setting defines the colorspace used to sort out and reduce the number
4846of colors needed by an image (for later dithering) by operators such as <a
4847href="#colors" >-colors</a>, Note that color reducion also happens
4848automatically when saving images to color-limited image file formats, such as
4849GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004850
4851
4852<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004853 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004854</div>
4855
4856<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>suppress all warning messages. Error messages are still reported.</td><td style='text-align:right;'></td></tr></table>
4857
4858<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004859 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004860</div>
4861
4862<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>
4863
4864<p>Note that this is actually a rotational blur rather than a radial and as
4865such actually mis-named. </p>
4866
4867<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4868pixels which are outside the image proper are blurred into the final result.
4869</p>
4870
4871
4872<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004873 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004874</div>
4875
4876<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>
4877
4878<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>.
4879</p>
4880
4881<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4882
4883<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004884 <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 +00004885</div>
4886
4887<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>
4888
4889<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004890 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004891</div>
4892
4893<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>
4894
4895<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004896 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00004897</div>
4898
4899<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>
4900
4901<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004902 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004903</div>
4904
4905<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>
4906
4907<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4908the given colors are dithered over the image as necessary, otherwise the closest
4909color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4910
4911<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4912images in the current image sequence, all the images will have the same color
4913table. That means that when saved to a file format such as GIF, it will use
4914that color table as a single common or global color table, for all the images,
4915without requiring extra local color tables. </p>
4916
4917<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4918sequence to use a common color map over all the images. This equivalent to
4919appending all the images together (without extra background colors) and color
4920reducing those images using <a href="#colors">-colors</a> with a 256 color
4921limit, then <a href="#remap">-remap</a> those colors over the original list of
4922images. This ensures all the images follow a single color map. </p>
4923
4924<p>If the number of colors over all the images is less than 256, then <a
4925href="#remap">+remap</a> should not perform any color reduction or dithering, as
4926no color changes are needed. In that case, its only effect is to force the use
4927of a global color table. This recommended after using either <a
4928href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
4929reduce the number of colors in an animated image sequence. </p>
4930
4931<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004932 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004933</div>
4934
4935<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>
4936
4937<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>
4938
4939<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>
4940
4941<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004942 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00004943</div>
4944
4945<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>
4946
4947<p>The only command recognized is the name of an image file to load.</p>
4948
4949<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>
4950
4951<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004952 <h4><a id="render"></a>-render</h4>
cristy3ed852e2009-09-05 21:47:34 +00004953</div>
4954
4955<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>
4956
4957<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>
4958
4959<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004960<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004961</div>
4962
4963<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Adjust the canvas and offset information of the image.</td><td style='text-align:right;'></td></tr></table>
4964
4965<p>This option is like <a href="#page">-page</a> but acts as an image operator
4966rather than a setting. You can separately set the canvas size or the offset
4967of the image on that canvas by only providing those components. </p>
4968
4969<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>
4970
4971<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
4972offset to move the image relative to its previous position. This useful for
4973animation sequences. </p>
4974
4975<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
4976recalculate the canvas size so the image (at its current offset) will appear
4977completely on that canvas (unless it has a negative offset).</p>
4978
4979<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
4980canvas meta-data from the images. </p>
4981
4982<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
4983directly assign virtual canvas meta-data. </p>
4984
4985
4986<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004987 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004988</div>
4989
4990<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>
4991
4992<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>
4993
4994<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>
4995
4996<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004997 <h4><a id="resize"></a>-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004998</div>
4999
5000<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>
5001
5002<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>
5003
5004<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>
5005
cristy13538962010-02-26 17:53:04 +00005006<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>
5007
cristy4949d522010-03-12 18:41:34 +00005008<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 +00005009<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005010 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00005011</div>
5012
5013<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>settings remain in effect until parenthesis boundary.</td><td style='text-align:right;'></td></tr></table>
5014
5015<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005016 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005017</div>
5018
5019<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Reverse the order of images in the current image list.</td><td style='text-align:right;'></td></tr></table>
5020
5021
5022<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005023 <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 +00005024</div>
5025
5026<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>
5027
5028<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>
5029
5030
5031<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005032 <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 +00005033</div>
5034
5035<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>
5036
5037<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>
5038
5039<p>Empty triangles in the corners, left over from rotating the image, are
5040filled with the <kbd>background</kbd> color. </p>
5041
5042<p>See also the <a href="#distort">-distort</a> operator and specifically the
5043'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5044
5045
5046<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005047 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005048</div>
5049
cristyd0bd44a2010-09-24 12:38:11 +00005050<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 +00005051
cristyd0bd44a2010-09-24 12:38:11 +00005052<p>Change the image size simply by directly sampling the pixels original
5053image. When magnifying, pixels are replicated in blocks. When minifying,
5054pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005055
cristyd0bd44a2010-09-24 12:38:11 +00005056<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5057a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5058neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5059avoids all the filter processing of the image. As such it completely ignores
5060the current <a href="#filter">-filter</a> setting. </p>
5061
5062<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5063will be added to the resulting image, though some colors may disappear. </p>
5064
5065<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
5066ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005067
5068
5069<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005070 <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 +00005071</div>
5072
5073<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>
5074
5075<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>
5076
5077<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005078 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005079</div>
5080
cristyd0bd44a2010-09-24 12:38:11 +00005081<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 +00005082
cristyd0bd44a2010-09-24 12:38:11 +00005083<p>Change the image size simply by replacing pixels by averaging pixels
5084together when minifying, or replacing pixels when magnifing. </p>
5085
5086<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5087a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5088faster, as it avoids all the filter processing of the image. As such it
5089completely ignores the current <a href="#filter">-filter</a> setting. </p>
5090
5091<p>If when shrinking (minifying) images the original image is some integer
5092multiple of the new image size, the number of pixels avergaed together to
5093produce the new pixel color is the same across the whole image. This is
5094a special case known as 'binning' and is often used as a method of reducing
5095noise in image such as those generated by digital cameras, especially in low
5096light conditions. </p>
5097
cristy3ed852e2009-09-05 21:47:34 +00005098
5099<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005100 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005101</div>
5102
5103<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>
5104
5105<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5106
5107<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005108 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005109</div>
5110
5111<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>
5112
5113<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>
5114
5115<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005116 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005117</div>
5118
5119<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>
5120
5121<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005122 <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 +00005123</div>
5124
5125<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>
5126
5127<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>
5128
5129<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>
5130
5131<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5132of the color clusters is returned.</p>
5133
5134
5135<div style="margin: auto;">
cristy8b9dd952011-03-21 22:56:18 +00005136 <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 +00005137</div>
5138
cristy3ed852e2009-09-05 21:47:34 +00005139<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>
5140
cristy2e2662a2010-10-09 14:29:37 +00005141<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>
5142
cristy3ed852e2009-09-05 21:47:34 +00005143<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005144 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005145</div>
5146
5147<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>
5148
5149<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005150 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005151</div>
5152
5153<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>
5154
5155<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5156
5157<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>
5158
cristyd0bda5e2010-09-21 16:22:45 +00005159
5160
cristy3ed852e2009-09-05 21:47:34 +00005161<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005162 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5163 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005164</div>
5165
cristyd0bd44a2010-09-24 12:38:11 +00005166<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>sets image attributes and properties for images in the current
cristyd0bda5e2010-09-21 16:22:45 +00005167image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005168
cristyd0bd44a2010-09-24 12:38:11 +00005169<p>This will assign (or modify) specific settings attached to all the images
5170in the current image sequence. Using the <a href="#set">+set</a> form of the
5171option will either remove, or reset that setting to a default state, as
5172appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005173
cristyd0bd44a2010-09-24 12:38:11 +00005174<p>For example, it will modify specific well known image meta-data
5175'attributes' such as those normally overridden by: the options <a
5176href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5177href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5178assigned before the image is read in, by using a <em class="arg">key</em> of
5179the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005180
cristyd0bd44a2010-09-24 12:38:11 +00005181<p>If the given <em class="arg">key</em> does not match a specific known
5182'attribute ', such as shown above, the setting is stored as a a free form
cristy323f35b2011-03-24 23:05:13 +00005183'property' string. Such settings are listed in <a href="#verbose"
cristyd0bda5e2010-09-21 16:22:45 +00005184>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5185</p>
5186
cristyd0bd44a2010-09-24 12:38:11 +00005187<p>This includes string 'properities' that are set by and assigned to images
5188using the options <a href="#comment" >-comment</a>, <a href="#label"
5189>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5190a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5191Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005192
cristyd0bd44a2010-09-24 12:38:11 +00005193<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>
5194<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5195Properties</a> in the defined value. For example:</p>
5196
5197<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>
5198<p>Other well known 'properities' that can be include:
5199'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5200'<kbd>signature</kbd>'. </p>
5201
5202<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5203the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5204see <a href="#repage">-page</a>). However it is designed to provide a finer
5205control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5206option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5207attribute. </p>
5208
5209<p>This option can also associate a colorspace or profile with your image.
5210For example,</p>
5211
5212<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 +00005213<p>Some 'properties' must be defined in a specific way to be used. For
5214example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5215modify the output filename of an image. For example</p>
5216
5217<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>
5218<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5219be saved as a global "Artifact" exactly as if it was set using the <a
cristyd0bd44a2010-09-24 12:38:11 +00005220href="#define" >-define</a> option. As such settings are globel in scope, they
5221can be used to pass 'attributes' and 'properities' of one specific image,
5222in a way that allows you to use them in a completely different image, even if
5223the original image has long since been modified or destroyed. For example: </p>
5224
5225<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>
5226<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5227a 'artifact' if the given <em class="arg">key</em> does not match an existing
cristy323f35b2011-03-24 23:05:13 +00005228'attribute' or 'property'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005229
5230<p>You can set the attributes of the image registry by prefixing the value
5231with <kbd>registry:</kbd>.</p>
5232
5233
cristy3ed852e2009-09-05 21:47:34 +00005234
5235<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005236 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005237</div>
5238
5239<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>shade the image using a distant light source.</td><td style='text-align:right;'></td></tr></table>
5240
5241<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>
5242
5243<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005244 <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 +00005245</div>
5246
5247<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>
5248
5249<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005250 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005251id="shared-memory"></a>-shared-memory</h4>
5252</div>
5253
5254<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>
5255
5256<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>
5257
5258<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005259 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005260</div>
5261
5262<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>
5263
5264<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5265
5266<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005267 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005268</div>
5269
5270<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>
5271
5272<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>
5273
5274<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>
5275
5276<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005277 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005278</div>
5279
5280<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>
5281
5282<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>
5283
5284<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>
5285
5286<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>
5287
5288<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>
5289
5290<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>
5291<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>
5292
5293<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5294<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005295 <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 +00005296</div>
5297
5298<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>
5299
5300<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>
5301
5302<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005303 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005304</div>
5305
5306<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>
5307
5308<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005309 <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 +00005310</div>
5311
5312<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>
5313
5314<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>
5315
5316<p>For Photo CD images, choose from these sizes:</p>
5317
5318<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005319 192x128
5320 384x256
5321 768x512
5322 1536x1024
5323 3072x2048
cristy3ed852e2009-09-05 21:47:34 +00005324</pre>
5325
cristy3ed852e2009-09-05 21:47:34 +00005326<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005327 <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 +00005328</div>
5329
5330<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>
5331
5332<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>
5333
5334<div style="margin: auto;">
cristy2d67ddd2011-02-13 15:38:23 +00005335 <h4><a id="smush"></a>-smush <em class="arg">offset</em></h4>
5336</div>
5337
5338<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>
5339
5340<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005341 <h4><a id="snaps"></a>-snaps <em class="arg">value</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%'>Set the number of screen snapshots.</td><td style='text-align:right;'>[<a href="../www/import.html">import</a>]</td></tr></table>
5345
5346<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5347
5348<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005349 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</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%'>negate all pixels above the threshold level.</td><td style='text-align:right;'></td></tr></table>
5353
5354<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5355
5356<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5357
5358<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005359 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005360 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5361</div>
5362
5363<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>
5364
5365
5366<table class="doc">
5367 <tbody>
5368 <tr valign="top">
5369 <th align="left" style="width: 8%">Method</th>
5370 <th align="left">Description</th>
5371 </tr>
5372
5373 <tr valign="top">
5374 <td valign="top">voronoi</td>
5375 <td valign="top">Simply map each pixel to the to nearest color point
5376 given. The result are polygonal 'cells' of solid color. </td>
5377 </tr>
5378
5379 <tr valign="top">
5380 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005381 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005382 squared. Generating spots of color in a sea of the average of
5383 colors. </td>
5384 </tr>
5385
5386 <tr valign="top">
5387 <td valign="top">barycentric</td>
5388 <td valign="top">three point triangle of color given 3 points.
5389 Giving only 2 points will form a linear gradient between those points.
5390 Gradient is however not restricted to just the triangle or line. </td>
5391 </tr>
5392
5393 <tr valign="top">
5394 <td valign="top">bilinear</td>
5395 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5396 fall back to barycentric. </td>
5397 </tr>
5398
5399 </tbody>
5400</table>
5401
5402<p>The points are placed according to the images location on the virtual
5403canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5404offset), and do not actually have to exist on the given image, but may be
5405some point beyond the edge of the image. All points are floating point values.
5406</p>
5407
5408<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
5409modified, whcih means the matte/alpha transparency channel is not effected by
5410default. If enabled, the image also needs a the matte/alpha channel to be
5411enabled for this operator to effect an images transparency. This is typical
5412transparency handling for images. </p>
5413
5414<p>All the above methods when given a single point of color will replace all
5415the colors in the image with the color given, regardless of the point. This is
5416logical, and provides an alternative technique to recolor a image to some
5417default value. </p>
5418
5419
5420<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005421 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005422</div>
5423
5424<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Splice the current background color into the image.</td><td style='text-align:right;'></td></tr></table>
5425
5426<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. See <a href="#background">-background</a> to reset the background color.</p>
5427
5428<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005429 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005430</div>
5431
5432<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>displace image pixels by a random amount.</td><td style='text-align:right;'></td></tr></table>
5433
5434<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>
5435
5436<div style="margin: auto;">
cristy323f35b2011-03-24 23:05:13 +00005437 <h4><a id="statistic"></a>-statistic <em class="arg">type</em> <em class="arg">geometry</em></h4>
cristyb52981c2011-03-19 17:09:31 +00005438</div>
5439
5440<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>
5441
5442<p>Choose from these statistic types:</p>
5443<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005444 Gradient maximum difference in area
5445 Maximum maximum value per channel in neighborhood
5446 Minimum minimum value per channel in neighborhood
5447 Mean average value per channel in neighborhood
5448 Median median value per channel in neighborhood
5449 Mode mode (most frequent) value per channel in neighborhood
5450 Nonpeak value just before or after the median value per channel in neighborhood
cristyb52981c2011-03-19 17:09:31 +00005451</pre>
5452
5453<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005454 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005455</div>
5456
5457<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>
5458
5459<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>
5460
5461<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005462 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005463</div>
5464
5465<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>
5466
5467<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>
5468
5469<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005470 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005471</div>
5472
5473<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>
5474
5475<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005476 char unsigned characters
5477 double doubles
5478 float floats
5479 integer integers
5480 long longs
5481 quantum pixels in the native depth of your ImageMagick distribution
5482 short unsigned shorts
cristy3ed852e2009-09-05 21:47:34 +00005483</pre>
5484
5485<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5486values range from 0 to the maximum value the storage type can support.</p>
5487
5488<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005489 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005490</div>
5491
5492<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>
5493
5494<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>
5495
5496<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005497 Any
5498 Condensed
5499 Expanded
5500 ExtraCondensed
5501 ExtraExpanded
5502 Normal
5503 SemiCondensed
5504 SemiExpanded
5505 UltraCondensed
5506 UltraExpanded
cristy3ed852e2009-09-05 21:47:34 +00005507</pre>
5508
5509<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5510
5511<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>
5512
5513<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005514 <h4><a id="strip"></a>-strip</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%'>strip the image of any profiles or comments.</td><td style='text-align:right;'></td></tr></table>
5518
5519<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005520 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005521</div>
5522
5523<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>
5524
5525<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5526
5527<p>See <a href="#draw">-draw</a> for further details.</p>
5528
5529<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005530 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005531</div>
5532
5533<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>
5534
5535<p>See <a href="#draw">-draw</a> for further details.</p>
5536
5537<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005538 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005539</div>
5540
5541<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>
5542
cristy71a3f602010-09-15 12:38:16 +00005543<p>This setting suggests a font style that ImageMagick should try to apply to
5544the currently selected font family. Select <em class="arg">fontStyle</em> from
5545the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005546
5547<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005548 Any
5549 Italic
5550 Normal
5551 Oblique
cristy3ed852e2009-09-05 21:47:34 +00005552</pre>
5553
5554<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>
5555
5556<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005557 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005558</div>
5559
cristyd4d64ed2010-08-22 22:19:33 +00005560<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>
5561
cristy71a3f602010-09-15 12:38:16 +00005562<p>This option is required to have compare search for the best match location
5563of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005564(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005565be the "match score" image.</p>
5566
cristyd0bd44a2010-09-24 12:38:11 +00005567<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005568position of the top-left corner of the given sub-image. that is its size will
5569be the size of the larger_image - sub_image + 1. The brightest location in
5570this image is the location s the locate on the best match that is also
5571reported. Note that this may or may nor be a perfect match, and the actual
5572brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005573possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005574
cristyd0bda5e2010-09-21 16:22:45 +00005575<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005576location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005577sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005578
cristyae6203d2010-08-09 01:12:14 +00005579
5580<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005581 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005582</div>
5583
5584<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>
5585
cristy71a3f602010-09-15 12:38:16 +00005586<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5587images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5588the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005589
5590<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005591 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005592</div>
5593
5594<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>swirl image pixels about the center.</td><td style='text-align:right;'></td></tr></table>
5595
5596<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5597
5598<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005599 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005600</div>
5601
5602<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>
5603
5604<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005605 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005606</div>
5607
cristy5063d812010-10-19 16:28:10 +00005608<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 +00005609
5610<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005611 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005612</div>
5613
5614<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>
5615
5616<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>
5617
5618<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>
5619
5620<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005621 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005622</div>
5623
5624<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>name of texture to tile onto the image background.</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="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005628</div>
5629
5630<!-- {<em class="arg">green,blue,opacity</em>}
5631<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>
5632-->
5633
5634<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>
5635
5636<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>
5637
5638<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.
5639</p>
5640
5641<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>
5642
5643<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5644<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>
5645
5646
5647<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>
5648<p>Note that the values of the transparency channel is treated as 'matte'
5649values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5650
5651<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>.
5652</p>
5653
5654<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005655 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005656</div>
5657
5658<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Create a thumbnail of the image.</td><td style='text-align:right;'></td></tr></table>
5659
5660<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>
5661
5662<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>
5663
5664<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005665 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005666</div>
5667
5668<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the tile image used for filling a subsequent graphic primitive.</td><td style='text-align:right;'></td></tr></table>
5669
5670<div style="margin: auto;">
5671 <h4>-tile <em class="arg">geometry</em></h4>
5672</div>
5673
5674<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>
5675
5676<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>
5677
5678<div style="margin: auto;">
5679 <h4>-tile</h4>
5680</div>
5681
5682<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>
5683
5684<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005685 <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 +00005686</div>
5687
5688<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>
5689
5690<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>
5691
5692<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>
5693
5694<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005695 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005696</div>
5697
5698<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>
5699
5700<p>Tint the image with the fill color.</p>
5701
5702<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>
5703
5704<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005705 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005706</div>
5707
5708<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>
5709
5710<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>
5711
5712<p>For example,</p>
5713
5714<p class="crtsnip">
5715 -title "%m:%f %wx%h"
5716</p>
5717
5718<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>
5719
5720
5721<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005722 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005723</div>
5724
5725<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>
5726
5727<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5728
5729<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 +00005730
5731<p>This operator has been now been superseded by the <a
5732href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5733
5734
cristy3ed852e2009-09-05 21:47:34 +00005735<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005736 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005737</div>
5738
5739<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>
5740
5741<p>The <em class="arg">color</em> argument is defined using the format
5742described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5743>-fuzz</a> setting can be used to match and replace colors similar to the one
5744given. </p>
5745
cristyb36feb22010-03-26 16:54:37 +00005746<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5747that is make all non-matching colors transparent. </p>
5748
cristy3ed852e2009-09-05 21:47:34 +00005749<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005750href="#transparent" >-transparent</a> but replaces the matching color with the
5751current <a href="#fill">-fill</a> color setting, rather than transparent.
5752However the <a href="#transparent" >-transparent</a> operator also ensures
5753that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5754>-alpha</a> set</kbd>", and does not require you to modify the <a
5755href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005756
cristyb36feb22010-03-26 16:54:37 +00005757<p>Note that this does not define the color as being the 'transparency color'
5758used for color-mapped image formats, such as GIF. For that use <a
5759href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005760
5761
5762<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005763 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005764</div>
5765
5766<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>
5767
5768<p>Sometimes this is used for saving to image formats such as
5769GIF and PNG8 which uses this color to represent boolean transparency. This
5770does not make a color transparent, it only defines what color the transparent
5771color is in the color palette of the saved image. Use <a
5772href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5773
5774<p>This option allows you to have both an opaque visible color, as well as a
5775transparent color of the same color value without conflict. That is, you can
5776use the same color for both the transparent and opaque color areas within an
5777image. This, in turn, frees to you to select a transparent color that is
5778appropriate when an image is displayed by an application that does not handle a
5779transparent color index, while allowing ImageMagick to correctly handle images of this
5780type. </p>
5781
5782<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5783
5784<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005785 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005786</div>
5787
5788<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>
5789
5790<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5791</p>
5792
5793<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005794 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005795</div>
5796
5797<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>
5798
5799
5800<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005801 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005802</div>
5803
5804<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>tree depth for the color reduction algorithm.</td><td style='text-align:right;'></td></tr></table>
5805
5806<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>
5807
5808<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>
5809
5810<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>
5811
5812<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005813 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00005814</div>
5815
5816<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>
5817
5818<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>
5819
5820<p>The page or virtual canvas information of the image is preserved allowing
5821you to extract the result of the <a href="#trim">-trim</a> operation from the
5822image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5823information if it is unwanted.</p>
5824
5825<p>If the trimmed image 'disappears' an warning is produced, and a special
5826single pixel transparent 'missed' image is returned, in the same way as when a
5827<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5828
5829
5830<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005831 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005832</div>
5833
5834<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the image type.</td><td style='text-align:right;'></td></tr></table>
cristyefb2bdb2010-11-20 19:35:22 +00005835 <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 +00005836
5837<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>
5838
5839<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5840<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>
5841
5842<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5843
5844<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005845 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005846</div>
5847
5848<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>
5849
5850<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5851
5852<p>See <a href="#draw">-draw</a> for further details.</p>
5853
5854
5855<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005856 <h4><a id="update"></a>-update <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005857</div>
5858
5859<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>detect when image file is modified and redisplay.</td><td style='text-align:right;'></td></tr></table>
5860
5861<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>
5862
5863
5864<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005865 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00005866</div>
5867
5868<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>
5869
5870
5871<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005872 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005873</div>
5874
5875<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>
5876
5877<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>
5878
5879
5880<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005881 <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 +00005882</div>
5883
5884<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>
5885
5886<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>
5887
5888<p>The parameters are:</p>
5889
5890<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005891 radius The radius of the Gaussian, in pixels, not counting the center
5892 pixel (default 0).
5893 sigma The standard deviation of the Gaussian, in pixels (default 1.0).
5894 amount The fraction of the difference between the original and the blur
5895 image that is added back into the original (default 1.0).
5896 threshold The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5897 difference amount (default 0.05).
cristy3ed852e2009-09-05 21:47:34 +00005898</pre>
5899
5900
5901<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005902 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005903</div>
5904
cristyd0bda5e2010-09-21 16:22:45 +00005905<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 +00005906
5907
5908<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005909 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00005910</div>
5911
5912<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>
5913
5914
5915<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005916 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005917</div>
5918
5919<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>
5920
5921
5922<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005923 <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 +00005924</div>
5925
5926<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>
5927
5928
5929<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005930 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005931</div>
5932
5933<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>
5934
5935<p>This option defines what color source should be used if and when a color
5936lookup completely 'misses' the source image. The color(s) that appear to
5937surround the source image. Generally this color is derived from the source
5938image, but could also be set to a specify background color. </p>
5939
5940<p>Choose from these methods:</p>
5941
5942<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005943 background the area surrounding the image is the background color
5944 black the area surrounding the image is black
5945 checker-tile alternate squares with image and background color
5946 dither non-random 32x32 dithered pattern
5947 edge extend the edge pixel toward infinity
5948 gray the area surrounding the image is gray
5949 horizontal-tile horizontally tile the image, background color above/below
5950 horizontal-tile-edge horizontally tile the image and replicate the side edge pixels
5951 mirror mirror tile the image
5952 random choose a random pixel from the image
5953 tile tile the image (default)
5954 transparent the area surrounding the image is transparent blackness
5955 vertical-tile vertically tile the image, sides are background color
5956 vertical-tile-edge vertically tile the image and replicate the side edge pixels
5957 white the area surrounding the image is white
cristy3ed852e2009-09-05 21:47:34 +00005958</pre>
5959
5960<p>The default value is "edge".</p>
5961
5962<p>This most important for distortion operators such as <a href="#distort"
5963>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
5964However it also effects operations that may access pixels just outside the
5965image proper, such as <a href="#convolve">-convolve</a>, <a
5966href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
5967
5968<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
5969
5970
5971<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005972 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005973</div>
5974
5975<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
5976
5977<p>Choose from these visual classes:</p>
5978
5979<pre class="text">
cristye9a32c32011-04-07 01:11:05 +00005980 StaticGray
5981 GrayScale
5982 StaticColor
5983 PseudoColor
5984 TrueColor
5985 DirectColor
5986 default
5987 visual id
cristy3ed852e2009-09-05 21:47:34 +00005988</pre>
5989
5990<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>
5991
5992
5993<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005994 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00005995 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
5996</div>
5997
5998<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
5999saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
6000
6001<p>Take a grayscale image (with alpha mask) and modify the destination image's
6002brightness according to watermark image's grayscale value and the <em
6003class="arg">brightness</em> percentage. The destinations color saturation
6004attribute is just direct modified by the <em class="arg">saturation</em>
6005percentage, which defaults to 100 percent (no color change). </p>
6006
6007
6008<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006009 <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 +00006010</div>
6011
6012<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>
6013
6014<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
6015
6016<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006017 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006018</div>
6019
6020<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>
6021
6022<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>
6023
6024<table class="doc">
6025 <col width="25%" />
6026 <col width="75%" />
6027 <thead>
6028 <tr>
6029 <th><em class="arg">fontWeight</em></th>
6030 <th>Description</th>
6031 </tr>
6032 </thead>
6033 <tbody>
6034 <tr><td>All </td> <td>No effect. </td></tr>
6035 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
6036 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
6037 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
6038 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
6039 </tbody>
6040 </table>
6041
6042<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
6043
6044<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>
6045
6046<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006047 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006048</div>
6049
6050<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>chromaticity white point.</td><td style='text-align:right;'></td></tr></table>
6051
6052<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006053 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006054</div>
6055
cristy5cadd612009-09-21 19:33:41 +00006056<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>
6057
6058<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.
6059</p>
cristy3ed852e2009-09-05 21:47:34 +00006060
6061<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006062 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006063</div>
6064
6065<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>
6066
6067<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>
6068
6069<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>
6070
6071<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>
6072
6073<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006074 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006075</div>
6076
6077<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the window group.</td><td style='text-align:right;'></td></tr></table>
6078
6079<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006080 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006081</div>
6082
6083<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>
6084 <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>
6085
6086<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006087</div>
6088</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006089
6090</div>
6091
6092<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006093 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006094 <span id="linkbar-center">
6095 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006096 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006097 </span>
6098 <span id="linkbar-east">&nbsp;</span>
6099 </div>
6100 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +00006101 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006102 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6103 </div>
6104 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006105 <script type="text/javascript">
6106 var _gaq = _gaq || [];
6107 _gaq.push(['_setAccount', 'UA-17690367-1']);
6108 _gaq.push(['_trackPageview']);
6109
6110 (function() {
6111 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6112 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6113 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6114 })();
6115 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006116</body>
6117</html>