blob: 797a0f53d54e48d617e1077d515c8f9e57cc861b [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">
56<a href="../index.html">
57 <img src="../images/script.png" alt="[ImageMagick]"
58 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
59<a href="http://www.networkredux.com">
60 <img src="../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000061 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000062<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000063 <img src="../images/logo.jpg"
64 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000065 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000066<a href="../index.html">
cristyaf8d6652011-02-04 21:57:45 +000067 <img src="../images/sprite.jpg"
68 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000069 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
70</div>
71
cristyce69bb02010-07-27 19:49:46 +000072<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000073
cristy3ed852e2009-09-05 21:47:34 +000074<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000075 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000076</div>
cristy3eaa0ef2010-03-06 20:35:26 +000077<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000078<div class="menu">
cristybb503372010-05-27 20:51:26 +000079 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
80</div>
81<div class="sub">
82 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
83</div>
84<div class="sub">
85 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
86</div>
87<div class="sub">
cristyda16f162011-02-19 23:52:17 +000088 <a title="Binary Release: iPhone" href="../www/binary-releases.html#iPhone">iPhone</a>
89</div>
90<div class="sub">
cristybb503372010-05-27 20:51:26 +000091 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
92</div>
93<div class="sep"></div>
94<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000095 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000096</div>
97<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000098 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000099</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000101 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000102</div>
103<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000104 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000105</div>
106<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000107 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000108</div>
109<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000110 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000113 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
118<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000119 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000124</div>
125<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000127</div>
128<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000129 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000130 </div>
131<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000132 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000133</div>
cristybb503372010-05-27 20:51:26 +0000134<div class="menu">
135 <a title="Architecture" href="../www/architecture.html">Architecture</a>
136</div>
cristy3ed852e2009-09-05 21:47:34 +0000137<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000138 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000139</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000140<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000141<div class="menu">
cristy52923442011-01-15 22:54:31 +0000142 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000145<div class="menu">
cristydcca3fa2010-12-29 21:50:07 +0000146 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000147</div>
148<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000149 <a title="Site Map: Links" href="../www/links.html">Links</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">
cristy83a272e2010-05-07 20:40:35 +0000153 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000154
155<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000156<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000157 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
158</div>
159<div class="sponsor">
160 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
161</div>
162<div class="sponsor">
cristy2bd2a982011-02-15 00:52:58 +0000163 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
cristy178edaf2011-01-23 03:42:39 +0000164</div>
cristyec6b4752011-01-08 03:16:23 +0000165<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000166 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000167</div>
168<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000169 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
170</div>
171<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000172 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
173</div>
cristyec6b4752011-01-08 03:16:23 +0000174<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000175 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
176</div>
177<div class="sponsor">
cristy30092792011-02-22 02:06:14 +0000178 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000179</div>
cristy3ed852e2009-09-05 21:47:34 +0000180</div>
181</div>
cristyce69bb02010-07-27 19:49:46 +0000182</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000183
cristyce69bb02010-07-27 19:49:46 +0000184<div class="eastbar">
185 <script type="text/javascript">
186 <!--
187 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000188 google_ad_slot = "0574824969";
189 google_ad_width = 160;
190 google_ad_height = 600;
191 //-->
192 </script>
193 <script type="text/javascript"
194 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
195 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000196</div>
197
198<div class="main">
199
cristydcca3fa2010-12-29 21:50:07 +0000200<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000201<p class="navigation-index">
cristy2d67ddd2011-02-13 15:38:23 +0000202[ <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#blackpoint-compensation">&#x2011;blackpoint&#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#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#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 +0000203
cristydcca3fa2010-12-29 21:50:07 +0000204<div class="doc-section">
205
cristyb36feb22010-03-26 16:54:37 +0000206<p>Below is list of command-line options recognized by the ImageMagick <a
207href="../www/command-line-tools.html">command-line
208tools</a>. If you want a description of a particular option, click on the
209option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000210otherwise 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 +0000211
212<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000213 <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 +0000214</div>
215
216<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 +0000217<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>
218
219<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000220 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000221</div>
222
223<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>
224
225<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>
226
227<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000228 <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 +0000229</div>
230
231<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>
232
233<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>
234
235<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000236 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000237</div>
238
239<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>
240
cristy30092792011-02-22 02:06:14 +0000241<p>This option is enabled by default. An attempt is made to save all images of
242an image sequence into the given output file. However, some formats, such as
243JPEG and PNG, do not support more than one image per file, and in that case
244ImageMagick is forced to write each image as a separate file. As such, if
245more than one image needs to be written, the filename given is modified by
246adding a <a href="#scene">-scene</a> number before the suffix, in order to
247make distinct names for each image. </p>
cristy3ed852e2009-09-05 21:47:34 +0000248
cristy30092792011-02-22 02:06:14 +0000249<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written to
250separate files, whether or not the file format allows multiple images per file
251(for example, GIF, MIFF, and TIFF). </p>
cristy3ed852e2009-09-05 21:47:34 +0000252
cristy30092792011-02-22 02:06:14 +0000253<p>Including a C-style integer format string in the output filename will
254automagically enable <a href="#adjoin">+adjoin</a> and are used to specify
255where the <a href="#scene">-scene</a> number is placed in the filenames. These
256strings, such as '<kbd>%d</kbd>' or '<kbd>%03d</kbd>', are familiar to those
257who have used the standard <kbd>printf()</kbd>' C-library function. As an
258example, the command</p>
cristy3ed852e2009-09-05 21:47:34 +0000259
260<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 +0000261<p>will create a sequence of 17 images (the two given plus 15 more created by
262<a href="#morph">-morph</a>), named: my00morph.jpg, my01morph.jpg,
263my02morph.jpg, ..., my16morph.jpg. </p>
cristy3ed852e2009-09-05 21:47:34 +0000264
cristy30092792011-02-22 02:06:14 +0000265<p>In summary, ImageMagick tries to write all images to one file, but will
266save to multiple files, if any of the following conditions exist...
267<ol>
268<li>the output image's file format does not allow multi-image files,
269<li>the <a href="#adjoin">+adjoin</a> option is given, or
270<li>a printf() integer format string (eg: "%d") is present in the output
271 filename.
272</ol></p>
cristy3ed852e2009-09-05 21:47:34 +0000273
274
275<div style="margin: auto;">
cristy30092792011-02-22 02:06:14 +0000276 <h4><a id="affine"></a>-affine
277 <em class="arg">s<sub>x</sub></em>,<em class="arg">r<sub>x</sub></em>,<em
278 class="arg">r<sub>y</sub></em>,<em class="arg">s<sub>y</sub></em>[,<em
279 class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>]
cristy3ed852e2009-09-05 21:47:34 +0000280</div>
281
282<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>
283
cristy30092792011-02-22 02:06:14 +0000284<p>This option sets a transformation matrix, for use by subsequent <a
285href="#draw">-draw</a> or <a href="#transform">-transform</a> options. </p>
cristy3ed852e2009-09-05 21:47:34 +0000286
cristy30092792011-02-22 02:06:14 +0000287<p>The matrix entries are entered as comma-separated numeric values either in
288quotes or without spaces. </p>
cristy3ed852e2009-09-05 21:47:34 +0000289
cristy30092792011-02-22 02:06:14 +0000290<p>Internally, the transformation matrix has 3x3 elements, but three of them
291are omitted from the input because they are constant. The new (transformed)
292coordinates (<em class="arg">x'</em>, <em class="arg">y'</em>) of a pixel at
293position (<em class="arg">x</em>, <em class="arg">y</em>) in the original
294image are calculated using the following matrix equation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000295
296<div class="eqn">
297<img alt="affine transformation" src="../images/affine.png"/>
298</div>
299
cristy30092792011-02-22 02:06:14 +0000300<p> The size of the resulting image is that of the smallest rectangle that
301contains the transformed source image. The parameters <em
302class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em>
303subsequently shift the image pixels so that those that are moved out of the
304image area are cut off.</p>
cristy3ed852e2009-09-05 21:47:34 +0000305
cristy30092792011-02-22 02:06:14 +0000306<p>The transformation matrix complies with the left-handed pixel coordinate
307system: positive <em class="arg">x</em> and <em class="arg">y</em> directions
308are rightward and downward, resp.; positive rotation is clockwise.</p>
cristy3ed852e2009-09-05 21:47:34 +0000309
cristy30092792011-02-22 02:06:14 +0000310<p> If the translation coefficients <em class="arg">t<sub>x</sub></em> and <em
311class="arg">t<sub>y</sub></em> are omotted they default to 0,0. Therefore,
312four parameters suffice for rotation and scaling without translation.</p>
cristy3ed852e2009-09-05 21:47:34 +0000313
cristy30092792011-02-22 02:06:14 +0000314<p>Scaling by the factors <em class="arg">s<sub>x</sub></em> and <em
315class="arg">s<sub>y</sub></em> in the <em>x</em> and <em>y</em> directions,
316respectively, is accomplished with the following.</p>
317
318<p>See <a href="#transform">-transform</a>, and the <a
319href="#distort">-distort</a> method '<kbd>Affineprojection</kbd> for more
320information </p>
321
cristy3ed852e2009-09-05 21:47:34 +0000322
323<p class="crtsnip">
324 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
325</p>
326
327<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>
328
329<p class="crtsnip">
330 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
331</p>
332
333<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
334<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
335
336<p class="crtsnip">
337 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
338</p>
339
340<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>
341
342<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>
343
344<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000345 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000346</div>
347
348<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>
349
350<p>Used to set a flag on an image indicating whether or not to use existing alpha
351channel 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>
352
353
354<table class="doc">
355 <tbody>
356 <tr valign="top">
357 <th align="left" style="width: 8%">type</th>
358 <th align="left">Description</th>
359 </tr>
360
361 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000362 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000363 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000364 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
365 should be used instead of this, unless you specifically need to
366 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
367 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000368
369 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000370 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000371 <td valign="top">
372 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000373 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000374
375 <tr valign="top">
376 <td valign="top"><kbd>Set</kbd></td>
377 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000378 Activates the alpha/matte channel. If it was previously turned off
379 then it also resets the channel to opaque. If the image already had
380 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000381
382 <tr valign="top">
383 <td valign="top"><kbd>Opaque</kbd></td>
384 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000385 Enables the alpha/matte channel and forces it to be fully opaque.
386 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000387
388 <tr valign="top">
389 <td valign="top"><kbd>Transparent</kbd></td>
390 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000391 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000392 transparent. This effectively creates a fully transparent image the
393 same size as the original and with all its original RGB data still
394 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000395
396 <tr valign="top">
397 <td valign="top"><kbd>Extract</kbd></td>
398 <td valign="top">
399 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000400 '<kbd>Off</kbd>' the the image's transparency, so as to generate
401 a gray-scale mask of the image's shape. The alpha channel data is left
402 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
403 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000404
405 <tr valign="top">
406 <td valign="top"><kbd>Copy</kbd></td>
407 <td valign="top">
408 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000409 gray-scale intensity of the image, into the alpha channel, converting
410 a gray-scale mask into a transparent shaped mask ready to be colored
411 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000412
413 <tr valign="top">
414 <td valign="top"><kbd>Shape</kbd></td>
415 <td valign="top">
416 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000417 the current background color. That is the RGB color channels is
418 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000419 </td></tr>
420
421 <tr valign="top">
422 <td valign="top"><kbd>Background</kbd></td>
423 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000424 Set any fully-transparent pixel to the background color, while leaving
425 it fully-transparent. This can make some image file formats, such as
426 PNG, smaller as the RGB values of transparent pixels are more uniform,
427 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000428 </td></tr>
429 </tbody>
430</table>
431
432<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000433"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000434>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000435Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000436
437
438<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000439 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000440 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
441 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
442 -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>
443</div>
444
445<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>
446
447<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>
448
449
450<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>
451
452<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>
453
454<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>
455<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
456
457<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>
458
459<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>
460
461<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000462 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000463</div>
464
465<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
466drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
467
468<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
469drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
470antialiasing edge pixels. This will then reduce the number of colors added to
471an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000472are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000473
474<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000475 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000476</div>
477
478<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>
479
480<p>This option creates a single longer image image, by joining all the current
481images in sequence top-to-bottom. Use <a href="#append">+append</a> to
482stack images left-to-right. </p>
483
484<p>If they are not of the same width, narrower images are padded with the
485current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000486position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000487href="#gravity">-gravity</a> setting. </p>
488
489
490<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000491 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000492</div>
493
494<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>
495
496
497<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000498 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000499</div>
500
501<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>
502
503<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>
504
505<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
506
cristyd934d102009-10-10 12:55:13 +0000507
508
cristy3ed852e2009-09-05 21:47:34 +0000509<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000510 <h4><a id="auto-gamma"></a>-auto-gamma</h4>
cristy3ed852e2009-09-05 21:47:34 +0000511</div>
512
513<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>
514
cristyd934d102009-10-10 12:55:13 +0000515<p>This calculates the mean values of an image, then applies a calculated <a
516href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
517image it will get a have a value of 50%. </p>
518
cristyd0bd44a2010-09-24 12:38:11 +0000519<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000520
521<p>This works well for real-life images with little or no extreme dark and
522light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000523dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000524</p>
525
526<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000527'<em>sync</em>' flag for channel syncronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000528values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000529>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000530together by the same gamma value, preserving colors. </p>
531
532
533
cristy3ed852e2009-09-05 21:47:34 +0000534<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000535 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000536</div>
537
538<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>
539
cristyd934d102009-10-10 12:55:13 +0000540<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000541minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000542href="#level" >-level</a> operator to stretch the values to the full range of
543values. </p>
544
cristy83543962009-10-16 19:04:28 +0000545<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000546JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
547for the <a href="#level" >-level</a> operation. On the other hand it is the
548right operator to use for color stretching gradient images being used to
549generate Color lookup tables, distortion maps, or other 'mathematically'
550defined images. </p>
551
552<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
553href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
554>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
555problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000556>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000557
558<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000559special '<em>sync</em>' flag for channel syncronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000560which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000561href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
562'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000563together by the same gamma value, preserving colors, and ignoring
564transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000565
566
cristy3ed852e2009-09-05 21:47:34 +0000567<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000568 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000569</div>
570
571<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>
572
cristy83543962009-10-16 19:04:28 +0000573<p>This operator reads and resets the EXIF image profile setting 'Orientation'
574and then performs the appropriate 90 degree rotation on the image to orient
575the image, for correct viewing. </p>
576
577<p>This EXIF profile setting is usually set using a gravity sensor in digital
578camara, however photos taken directly downward or upward may not have an
579appropriate value. Also images that have been orientation 'corrected' without
580reseting this setting, may be 'corrected' again resulting in a incorrect
581result. If the he EXIF profile was previously stripped, the <a
582href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
583
584
cristy3ed852e2009-09-05 21:47:34 +0000585<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000586 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000587</div>
588
589<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Average a set of images.</td><td style='text-align:right;'></td></tr></table>
590
591<p>An error results if the images are not identically sized.</p>
592
cristy3ed852e2009-09-05 21:47:34 +0000593
594<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000595 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000596</div>
597
598<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>
599
600<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>
601
602<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000603 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000604</div>
605
606<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>
607
608<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>
609
610<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000611 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000612</div>
613
614<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>
615
cristye6378132009-10-26 20:05:17 +0000616<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 +0000617
cristye6378132009-10-26 20:05:17 +0000618<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>
619<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 +0000620
621<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000622 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000623</div>
624
625<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>
626
627<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>
628
629<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>
630
631<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
632negative results without clipping to the color value range
633(0..QuantumRange).</p>
634
635<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +0000636<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 +0000637</p>
638
639<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000640 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000641</div>
642
643<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Use black point compensation.</td><td style='text-align:right;'></td></tr></table>
644
645<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000646 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000647</div>
648
cristy5cadd612009-09-21 19:33:41 +0000649<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>
650
651<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.
652</p>
cristy3ed852e2009-09-05 21:47:34 +0000653
654
655<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000656 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000657</div>
658
cristy83a272e2010-05-07 20:40:35 +0000659<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 +0000660
661<p>Blend will average the images together ('plus') according to the
662percentages given and each pixels transparency. If only a single percentage
663value is given it sets the weight of the composite or 'source' image, while
664the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000665<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
666'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000667
668
669<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000670 <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 +0000671</div>
672
673<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>
674
675<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000676 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000677</div>
678
679<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>
680
681<div style="margin: auto;">
682
683<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000684 <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 +0000685</div>
686
687<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>
688
cristyb15553d2010-07-03 22:53:14 +0000689<p>Convolve the image with a Gaussian or normal distribution using the given
690<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000691
692<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
693</div>
694
cristyb15553d2010-07-03 22:53:14 +0000695<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000696determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000697
cristyb15553d2010-07-03 22:53:14 +0000698<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000699array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000700integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000701radius that will provide meaningful results for the Gaussian distribution.
702</p>
703
704<p>The larger the <em class="arg" >Radius</em> the radius the slower the
705operation is. However too small a <em class="arg" >Radius</em>, and sever
706aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
707should be at least twice the <em class="arg" >Sigma</em> value, though three
708times will produce a more accurite result. </p>
709
710<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
711by taking advantage of the separability properties of the distribution. Here
712we apply a single-dimensional Gaussian matrix in the horizontal direction,
713then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000714
715<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
716pixels which are outside the image proper are blurred into the final result.
717</p>
718
719
720<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000721 <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 +0000722</div>
723
724<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>
725
726<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
727Average (EWA) of the source image, scaled according to the grayscale
728mapping. </p>
729
730<p>The ellipse is weighted with sigma set to the given <em class="arg"
731>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
732defaults to the <em class="arg" >Width</em> for a normal circular Guassian
733weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
734horizontal clock-wise. </p>
735
736<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
737pixels which are outside the image proper are blurred into the final result.
738</p>
739
740
741<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000742 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000743</div>
744
745<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Surround the image with a border of color. </td><td style='text-align:right;'></td></tr></table>
746
cristybc9539a2010-08-16 18:06:20 +0000747<p>Set the width and height using the <em class="arg">size</em> portion of the
748<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
749ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000750
cristybc9539a2010-08-16 18:06:20 +0000751<p>Set the border color by preceding with the <a
752href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000753
cristybc9539a2010-08-16 18:06:20 +0000754<p>The <a href="#border">-border</a> operation is affected by the current <a
755href="#compose">-compose</a> setting and assumes that this is using the default
756'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
757size colors by the current <a href="#bordercolor">-bordercolor</a> before
758overlaying the original image in the center of this net image. This means that
759with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000760be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000761<p>See also the <a href="#frame">-frame</a> option, which has more
762functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000763
764<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000765 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000766</div>
767
768<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>
769
770<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
771
772<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
773
774<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000775 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000776</div>
777
778<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>
779
780<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000781 <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 +0000782</div>
783
784<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>
785
cristyefb2bdb2010-11-20 19:35:22 +0000786<p>Brightness and Contrast values apply changes to the input image. They are
787not absolute settings. A brightness or contrast value of zero means no change.
788The range of values is -100 to +100 on each. Positive values increase the
789brightness or contrast and negative values decrease the brightness or contrast.
790To control only contrast, set the brightness=0. To control only brightness,
791set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000792
cristyefb2bdb2010-11-20 19:35:22 +0000793<p>You may also use <a href="#fill">-channel</a> to control which channels to
794apply the brightness and/or contrast change. The default is to apply the same
795transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000796
cristyefb2bdb2010-11-20 19:35:22 +0000797<p>Brightness and Contrast arguments are converted to offset and slope of a
798linear transform and applied
799using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000800
cristyefb2bdb2010-11-20 19:35:22 +0000801<p>The slope varies from 0 at contrast=-100 to almost vertical at
802contrast=+100. For brightness=0 and contrast=-100, the result are totally
803midgray. For brightness=0 and contrast=+100, the result will approach but
804not quite reach a threshold at midgray; that is the linear transformation
805is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000806
cristyefb2bdb2010-11-20 19:35:22 +0000807<p>Negative slopes, i.e. negating the image, are not possible with this
808function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000809
cristyefb2bdb2010-11-20 19:35:22 +0000810<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
811at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
812totally white. Similarly, when contrast=0 and brightness=-100, the result is
813totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000814
cristyefb2bdb2010-11-20 19:35:22 +0000815<p>As the range of values for the arguments are -100 to +100, adding the '%'
816symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000817
818<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000819 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000820</div>
821
822<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>
823
824<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000825 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000826</div>
827
828<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>
829
cristy71a3f602010-09-15 12:38:16 +0000830<p>This option sets the caption meta-data of an image read in after this
831option has been given. To modify a caption of images already in memory use
832"<kbd><a href="#set">-set</a> caption</kbd>". </p>
833
834<p>The caption can contain special format characters listed in the <a
835href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000836Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000837is finally assigned to the individual images. </p>
838
839<p>If the first character of <em class="arg">string</em> is <em
840class="arg">@</em>, the image caption is read from a file titled by the
841remaining characters in the string. Comments read in from a file are literal;
842no embedded formatting characters are recognized.</p>
843
844<p>Caption meta-data ais not visible on the image itself. To do that use the
845<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
846instead.</p>
847
848<p>For example,</p>
849
850<p class="crtsnip">
851 -caption "%m:%f %wx%h" bird.miff
852</p>
853
854<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
855that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
856480.</p>
857
858
cristy3ed852e2009-09-05 21:47:34 +0000859<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000860 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000861</div>
862
863<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>
864
865<p>Here is an example color correction collection:</p>
866
867<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000868&lt;?xml version="1.0" encoding="UTF-8"?&gt;
869&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
870 &lt;ColorCorrection id="cc06668"&gt;
871 &lt;SOPNode&gt;
872 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
873 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
874 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
875 &lt;/SOPNode&gt;
876 &lt;SATNode&gt;
877 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
878 &lt;/SATNode&gt;
879 &lt;/ColorCorrection&gt;
880&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000881</pre>
882
883<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000884 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000885</div>
886
887<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>
888
cristyefb2bdb2010-11-20 19:35:22 +0000889<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
890<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
891<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
892<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000893
cristy83a272e2010-05-07 20:40:35 +0000894<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000895abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
896'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
897'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000898
cristy83a272e2010-05-07 20:40:35 +0000899For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
900you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000901<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000902 -channel Red,Blue
903</p>
904<p>or you can use the short hand form</p>
905<p class="crtsnip">
906 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000907</p>
908
cristy83a272e2010-05-07 20:40:35 +0000909<p>All the channels that is present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000910special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
911but generally any operators that are generally 'grey-scale' image operators,
912will understand this setting. See individual operator documentation. </p>
913
cristydcca3fa2010-12-29 21:50:07 +0000914<br />
cristy83a272e2010-05-07 20:40:35 +0000915
916<p>On top of the normal channel selection a extra flag can be specified,
917'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000918operators that understand this flag should perform: cross-channel
919syncronization of the channels. If not specified, then most grey-scale
920operators will apply their image processing operations to each individual
921channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000922setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000923
924<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000925<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000926together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000927it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000928independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000929
cristydcca3fa2010-12-29 21:50:07 +0000930<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000931and the <a href="#compose">-compose</a> mathematical methods, also understands
932the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
933to the alpha channel (if present). That is to say it will modify the image
934processing with the understanding that fully-transparent colors should not
935contribute to the final result. </p>
936
cristydcca3fa2010-12-29 21:50:07 +0000937<p>Basically, by default, operators work with color channels in syncronous, and
cristybac7a162010-06-15 19:57:29 +0000938treats transparency as special, unless the <a href="#channel">-channel</a>
939setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
940How each operator does this depends on that operators current implementation.
941Not all operators understands this flag at this time, but that is changing.
942</p>
cristy83a272e2010-05-07 20:40:35 +0000943
944<p>To print a complete list of channel types, use <a href="#list">-list
945channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000946
cristydcca3fa2010-12-29 21:50:07 +0000947<br />
cristyd934d102009-10-10 12:55:13 +0000948
949<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000950'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
951channels except the transparency channel, and that all the color channels are
952to be modified in exactly the same way, with a understanding of transprancy
953(depending on the operation being applied). The 'plus' form <a
954href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000955
956<p>Options that are affected by the <a href="#channel" >-channel</a> setting
957include the following.
958
959<a href="#auto-gamma">-auto-gamma</a>,
960<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000961<a href="#black-threshold">-black-threshold</a>,
962<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000963<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000964<a href="#clut">-clut</a>,
965<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000966<a href="#composite">-composite</a> (Mathematical compose methods only),
967<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000968<a href="#contrast-stretch">-contrast-stretch</a>,
969<a href="#evaluate">-evaluate</a>,
970<a href="#function">-function</a>,
971<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000972<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000973<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000974<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000975<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000976<a href="#negate">-negate</a>,
977<a href="#normalize">-normalize</a>,
978<a href="#ordered-dither">-ordered-dither</a>,
979<a href="#radial-blur">-radial-blur</a>,
980<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000981<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000982<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000983<a href="#white-threshold">-white-threshold</a>.
984</p>
985
cristyd0bda5e2010-09-21 16:22:45 +0000986<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +0000987>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +0000988href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +0000989default). These operators have yet to be made to understand the newer 'Sync'
990flag. </p>
991
cristybac7a162010-06-15 19:57:29 +0000992<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
993the image before thresholding, if no <a href="#channel" >-channel</a> setting
994has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +0000995
996<p>Also some operators such as <a href="#blur">-blur</a>, <a
997href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
998color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
999href="#channel" >-channel</a>. Generally this done to ensure that
1000fully-transparent colors are treated as being fully-transparent, and thus any
1001underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +00001002resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +00001003convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +00001004and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +00001005
cristybac7a162010-06-15 19:57:29 +00001006<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +00001007color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +00001008alpha channel present, and the <a href="#channel" >-channel</a> setting tells
1009the operator to apply the operation using alpha channels. The <a
1010href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +00001011
cristy3ed852e2009-09-05 21:47:34 +00001012
1013<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001014 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +00001015</div>
1016
1017<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>
1018
1019<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001020 <h4><a id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001021</div>
1022
1023<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>
1024
1025<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001026 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001027</div>
1028
1029<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>
1030
cristyefb2bdb2010-11-20 19:35:22 +00001031<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>
1032and <em class="arg">height</em> given in the of the <em class="arg">size</em>
1033portion of the <em class="arg">geometry</em> argument give the number of
1034columns and rows to remove. The <em class="arg">offset</em> portion of
1035the <em class="arg">geometry</em> argument is influenced by
1036a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +00001037
cristyefb2bdb2010-11-20 19:35:22 +00001038<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
1039and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00001040
cristydcca3fa2010-12-29 21:50:07 +00001041<p>While it can remove internal rows and columns of pixels, it is more typically
1042used with as <a href="#gravity">-gravity</a> setting and a '<kbd>+0+0</kbd>' offset
1043so as to remove a single edge from an image. Compare this to <a href="#shave"
1044>-shave</a> whcih removes equal numbers of pixels from oppisite sides of the image.
1045</p>
1046
1047<p>Using <a href="#chop">-chop</a> will effectivally undo the results of a
1048<a href="#splice">-splice</a> that was given the same <em class="arg">geometry</em>
1049and <a href="#gravity">-gravity</a> settings. </p>
1050
1051
cristy3ed852e2009-09-05 21:47:34 +00001052<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001053 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001054</div>
1055
1056<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>
1057
1058<p>If a clipping path is present, it is applied to subsequent operations.</p>
1059
1060<p>For example, in the command</p>
1061
1062<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
1063<p>only the pixels within the clipping path are negated.</p>
1064
1065<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1066
1067<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001068 <h4><a id="clip-mask"></a>-clip-mask</h4>
cristy3ed852e2009-09-05 21:47:34 +00001069</div>
1070
1071<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Clip the image as defined by this mask.</td><td style='text-align:right;'></td></tr></table>
1072
cristy30092792011-02-22 02:06:14 +00001073<p>Use the given image as a 'do-not-modify' mask of the current images in the
1074current image sequence. Assuming the clipmask is a greyscale image the same
1075size at the one already in memory, any areas that is white will not be
1076modified by any of the 'image processing operators' that follow, until the
1077mask is removed. Pixels in the black areas of the clip mask will be modified
1078as normal. </p>
1079
1080<p>In some ways this is similar to (though not the same) as defining
1081a rectangular <a href="#region" >-region</a>, or using the negative of the
1082mask (thrid) image in a three image <a href="#composite" >-composite</a>,
1083operation. </p>
1084
1085
cristy3ed852e2009-09-05 21:47:34 +00001086<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001087 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001088</div>
1089
1090<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>
1091
cristy30092792011-02-22 02:06:14 +00001092<p>This is almost identicate to <a href="#clip">-clip</a>. </p>
1093
1094
cristy3ed852e2009-09-05 21:47:34 +00001095<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001096 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001097</div>
1098
1099<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Make a copy of an image (or images).</td><td style='text-align:right;'></td></tr></table>
1100
cristydcca3fa2010-12-29 21:50:07 +00001101<p>Inside parenthesis (where the operator is normally used) it will make a
1102clone of the images from the last 'pushed' image sequence, and adds them to
1103the end of the current image sequence. Outside parenthesis
1104(not recommended) it clones the images from the current image sequence. </p>
1105
cristy3ed852e2009-09-05 21:47:34 +00001106<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000011070. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001108example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001109represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001110dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1111spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
1112effectivally clone all the images. </p>
1113
1114<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
1115in the image sequence, and is thus equivelent to using a argument of
1116'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001117
1118<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001119 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001120</div>
1121
1122<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
1123corresponding channel in the second image as a <b>c</b>olor
1124<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1125
1126<p>The second (LUT) image is ordinarily a gradient image containing the
1127histogram mapping of how each channel should be modified. Typically it is a
1128either a single row or column image of replacement color values. If larger
1129than a single row or column, values are taken from a diagonal line from
1130top-left to bottom-right corners.</p>
1131
1132<p>The lookup is further controlled by the <a
1133href="#interpolate">-interpolate</a> setting, which is especially handy for an
1134LUT which is not the full length needed by the ImageMagick installed Quality
1135(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1136'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1137gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1138lookup of color values. </p>
1139
1140<p>This operator is especially suited to replacing a grayscale image with a
1141specific color gradient from the CLUT image. </p>
1142
1143<p>Only the channel values defined by the <a href="#channel">-channel</a>
1144setting will have their values replaced. In particular, since the default <a
1145href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1146transparency (alpha/matte channel) is not affected, unless the <a
1147href="#channel">-channel</a> setting is modified. When the alpha channel is
1148set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1149as the other channels, implying that alpha/matte values are replaced using the
1150alpha/matte values of the original image. </p>
1151
cristyd0bda5e2010-09-21 16:22:45 +00001152<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001153transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1154href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001155assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001156replacement alpha values. That is you can use a gray-scale CLUT image to
1157adjust a existing images alpha channel, or you can color a gray-scale image
1158using colors form CLUT containing the desired colors, including transparency.
1159</p>
1160
cristyefb2bdb2010-11-20 19:35:22 +00001161<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1162according to the lookup of the full color RGB value from a 2D representation
1163of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001164
1165
1166<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001167 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001168</div>
1169
1170<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>
1171
cristyefb2bdb2010-11-20 19:35:22 +00001172<p>Overlay each image in an image sequence according to
1173its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1174an animation at each point in the animation sequence. All images should be
1175the same size, and are assigned appropriate GIF disposal settings for the
1176animation to continue working as expected as a GIF animation. Such frames
1177are more easily viewed and processed than the highly optimized GIF overlay
1178images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001179
cristyefb2bdb2010-11-20 19:35:22 +00001180<p>The animation can be re-optimized after processing using
1181the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1182there is no guarantee that the restored GIF animation optimization is
1183better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001184
1185
1186<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001187 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001188</div>
1189
1190<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>
1191
cristyefb2bdb2010-11-20 19:35:22 +00001192<p>Specify the amount of colorization as a percentage. Separate colorization
1193values can be applied to the red, green, and blue channels of the image with
1194a comma-delimited list of colorization
1195values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001196
1197<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001198 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001199</div>
1200
1201<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>
1202
1203<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1204
cristyefb2bdb2010-11-20 19:35:22 +00001205<p>This option only applies when the default X server visual
1206is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1207to <a href="#visual">-visual</a> for more details. By default,
1208a shared colormap is allocated. The image shares colors with
1209other X clients. Some image colors could be approximated,
1210therefore your image may look very different than intended.
1211If <kbd>private</kbd> is chosen, the image colors appear exactly
1212as they are defined. However, other clients may go <em>technicolor</em>
1213when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001214
1215<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001216 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001217</div>
1218
1219<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the preferred number of colors in the image.</td><td style='text-align:right;'></td></tr></table>
1220
cristyefb2bdb2010-11-20 19:35:22 +00001221<p>The actual number of colors in the image may be less than your request,
1222but never more. Note that this a color reduction option. Images with fewer
1223unique colors than specified by <em class="arg">value</em> will have any
1224duplicate or unused colors removed. The ordering of an existing color
1225palette may be altered. When converting an image from color to grayscale,
1226it is more efficient to convert the image to the gray colorspace before
1227reducing the number of colors. Refer to
1228the <a href="../www/quantize.html">
1229color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001230
1231<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001232 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001233</div>
1234
1235<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>
1236
cristyefb2bdb2010-11-20 19:35:22 +00001237<p>This option permits saturation changes, hue rotation, luminance to alpha,
1238and various other effects. Although variable-sized transformation matrices
1239can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1240for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1241Adobe Flash except offsets are in column 6 rather than 5 (in support of
1242CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001243
1244<p>As an example, to add contrast to an image with offsets, try this command:</p>
1245
1246<pre class="text">
1247convert kittens.jpg -color-matrix \
1248 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1249 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1250 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1251 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1252 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1253 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1254</pre>
1255<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001256 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001257</div>
1258
1259<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>
1260
1261<p>Choices are:</p>
1262
1263<pre class="text">
1264 CMY
1265 CMYK
1266 Gray
1267 HSB
1268 HSL
1269 HWB
1270 Lab
1271 Log
1272 OHTA
1273 Rec601Luma
1274 Rec601YCbCr
1275 Rec709Luma
1276 Rec709YCbCr
1277 RGB
1278 sRGB
1279 Transparent
1280 XYZ
1281 YCbCr
1282 YCC
1283 YIQ
1284 YPbPr
1285 YUV
1286</pre>
1287
1288<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1289
1290<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>
1291
1292<table class="doc">
1293 <caption>Conversion Of RGB To Other Color Spaces</caption>
1294 <tr><th align="left" valign="middle">CMY</th></tr>
1295 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1296 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1297 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1298 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1299 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1300 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1301 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1302 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1303
1304 <tr><th align="left" valign="middle">Gray</th></tr>
1305 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1306
1307 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1308 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1309 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1310 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1311
1312 <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>
1313 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1314 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1315 <tr><td align="left" valign="middle">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>
1316
1317 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1318 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1319 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1320 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1321
1322 <tr><th align="left" valign="middle">LAB</th></tr>
1323 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1324 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1325 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1326
1327 <tr><th align="left" valign="middle">LOG</th></tr>
1328 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1329 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1330 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1331
1332 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1333 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1334 <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>
1335 <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>
1336
1337 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1338 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1339
1340 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1341 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1342 <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>
1343 <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>
1344
1345 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1346 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1347
1348 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1349 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1350 <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>
1351 <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>
1352
1353 <tr><th align="left" valign="middle">sRGB</th></tr>
1354 <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>
1355 <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>
1356 <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>
1357
1358 <tr><th align="left" valign="middle">XYZ</th></tr>
1359 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1360 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1361 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1362
1363 <tr><th align="left" valign="middle">YCC</th></tr>
1364 <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>
1365 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1366 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1367
1368 <tr><th align="left" valign="middle">YCbCr</th></tr>
1369 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1370 <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>
1371 <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>
1372
1373 <tr><th align="left" valign="middle">YIQ</th></tr>
1374 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1375 <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>
1376 <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>
1377
1378 <tr><th align="left" valign="middle">YPbPr</th></tr>
1379 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1380 <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>
1381 <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>
1382
1383 <tr><th align="left" valign="middle">YUV</th></tr>
1384 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1385 <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>
1386 <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>
1387</table>
1388
1389<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001390 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001391</div>
1392
1393<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>
1394
1395<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>
1396
1397<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.
1398</p>
1399
cristy4949d522010-03-12 18:41:34 +00001400<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 +00001401<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001402 <h4><a id="comment"></a>-comment <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001403</div>
1404
1405<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>
1406
cristyd0bda5e2010-09-21 16:22:45 +00001407<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001408option has been given. To modify a comment of images already in memory use
1409"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001410
cristy71a3f602010-09-15 12:38:16 +00001411<p>The comment can contain special format characters listed in the <a
1412href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001413Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001414is finally assigned to the individual images. </p>
1415
1416<p>If the first character of <em class="arg">string</em> is <em
1417class="arg">@</em>, the image comment is read from a file titled by the
1418remaining characters in the string. Comments read in from a file are literal;
1419no embedded formatting characters are recognized.</p>
1420
1421<p>Comment meta-data are not visible on the image itself. To do that use the
1422<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1423instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001424
1425<p>For example,</p>
1426
1427<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001428 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001429</p>
1430
cristy71a3f602010-09-15 12:38:16 +00001431<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1432that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1433480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001434
1435<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001436 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001437</div>
1438
1439<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>
1440
cristybc9539a2010-08-16 18:06:20 +00001441<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1442a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001443
cristybc9539a2010-08-16 18:06:20 +00001444<p>This setting effects image processing operators that merge two (or more)
1445images together in some way. This includes the operators,
1446<a href="#composite">-composite</a>,
1447<a href="#layers">-layers</a> composite,
1448<a href="#flatten">-flatten</a>,
1449<a href="#mosaic">-mosaic</a>,
1450<a href="#layers">-layers</a> merge,
1451<a href="#border">-border</a>,
1452<a href="#frame">-frame</a>,
1453and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001454
cristybc9539a2010-08-16 18:06:20 +00001455<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1456command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001457
1458
1459<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001460 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001461</div>
1462
cristybc9539a2010-08-16 18:06:20 +00001463<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 +00001464
1465<p>Take the first image 'destination' and overlay the second 'source' image
1466according to the current <a href="#compose">-compose</a> setting. The location
1467of the 'source' or 'overlay' image is controlled according to <a
1468href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1469settings. </p>
1470
1471<p>If a third image is given this is treated as a gray-scale 'mask' image
1472relative to the first 'destination' image. This mask will limit what parts of
1473the destination can be modified by the image composition. However for the
1474'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1475Y-displacement image instead. </p>
1476
1477<p>If a <a href="#compose">-compose</a> method requires extra numerical
1478arguments or flags these can be provided by setting the <a
1479href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001480appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001481
1482<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1483image outside the overlay area. You can disable this by setting the special <a
1484href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1485to '<kbd>false</kbd>'. </p>
1486
1487
1488<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001489 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001490</div>
1491
1492<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>
1493
1494<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>
1495
1496<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1497
1498<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>
1499
1500<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>
1501
1502<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>
1503
1504<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>
1505
1506<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001507 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001508</div>
1509
1510<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>
1511
1512<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>
1513
1514<p>For a more pronounced effect you can repeat the option:</p>
1515
1516<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1517<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001518 <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 +00001519</div>
1520
1521<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>
1522
cristyd934d102009-10-10 12:55:13 +00001523<p>While performing the stretch, black-out at most <em
1524class="arg" >black-point</em> pixels and white-out at most <em
1525class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1526<em class="arg" >black-point %</em> pixels and white-out at most <em
1527class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001528
cristyd934d102009-10-10 12:55:13 +00001529<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1530>-contrast-stretch</a> will black-out at most <em class="arg"
1531>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1532minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1533class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1534>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001535
cristyd934d102009-10-10 12:55:13 +00001536<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1537the image's min and max values are stretched to 0 and <em class="QR"
1538>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1539clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001540>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001541prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001542
cristyd934d102009-10-10 12:55:13 +00001543<p>Internally operator works by creating a histogram bin, and then uses that
1544bin to modify the image. As such some colors may be merged together when they
1545originally fell into the same 'bin'. </p>
1546
1547<p>All the channels are normalized in concert by the came amount so as to
1548preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001549setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001550setting will normalize the RGB channels independently.</p>
1551
1552<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1553normalization of mathematical images. </p>
1554
1555<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001556
1557
1558<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001559 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001560</div>
1561
1562<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>
1563
cristy16ff93c2010-01-13 23:18:07 +00001564<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001565a comma-separated list of integers (with no spaces), ordered left-to right,
1566starting with the top row. Presently, only odd-dimensioned kernels are
1567supported, and therefore the number of entries in the specified <em
1568class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15697<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001570
cristyd934d102009-10-10 12:55:13 +00001571<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
1572positive and negative results are relative to a user-specified bias value.
1573This is important for non-HDRI compilations of ImageMagick when dealing with
1574convolutions that contain negative as well as positive values. This is
1575especially the case with convolutions involving high pass filters or edge
1576detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001577</p>
1578
cristyd934d102009-10-10 12:55:13 +00001579<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
1580negative results without clipping to the color value range (0..QuantumRange).
1581See the discussion on HDRI implementations of ImageMagick on the page <a
cristy47774982011-02-15 15:17:19 +00001582href="../www/high-dynamic-range.html">High
cristyd934d102009-10-10 12:55:13 +00001583Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1584href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1585<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1586entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001587
cristy3ed852e2009-09-05 21:47:34 +00001588
1589<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001590 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001591</div>
1592
1593<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>
1594
1595<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>
1596
1597<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>
1598
1599<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>
1600
1601<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>
1602
1603<p>By adding a exclamation character flag to the geometry argument, the
1604cropped images virtual canvas page size and offset is set as if the
1605geometry argument was a viewport or window. This means the canvas page size
1606is set to exactly the same size you specified, the image offset set
1607relative top left corner of the region cropped. </p>
1608
1609<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1610special single pixel transparent 'missed' image is returned, and a 'crop
1611missed' warning given. </p>
1612
cristy739df912009-10-24 16:10:18 +00001613<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 +00001614
1615<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001616 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001617</div>
1618
1619<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>
1620
1621<p><em class="arg">Amount</em> defines the number of positions each
1622colormap entry is shifted.</p>
1623
1624
1625<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001626 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001627</div>
1628
1629<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>
1630
1631<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>
1632
1633
1634<p>For example, to log cache and blob events, use.</p>
1635
1636<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1637<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1638
1639<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1640
1641<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1642
1643<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1644
1645<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>
1646
1647
1648<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001649 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001650</div>
1651
1652<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>
1653
1654<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1655
1656<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1657
1658
1659<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001660 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001661</div>
1662
1663<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>
1664
1665<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>
1666
1667<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>
1668
1669<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1670
1671
1672<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001673 <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 +00001674</div>
1675
cristyd0bd44a2010-09-24 12:38:11 +00001676<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 +00001677coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001678
cristyd0bda5e2010-09-21 16:22:45 +00001679<p>This option creates one or more definitions for coders and decoders to use
1680while reading and writing image data. Definitions are generally used to
1681control image file format coder modules, and image processing operations,
1682beyond what is provided by normal means. Defined settings are listed in <a
1683href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1684as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001685
cristyd0bda5e2010-09-21 16:22:45 +00001686<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1687definition of a flag is created with that name. This used to control on/off
1688options. Use <a href="#define">+define key</a> to remove definitions
1689previously created. Use <a href="#define">+define "*"</a> to remove all
1690existing definitions.</p>
1691
cristyd0bd44a2010-09-24 12:38:11 +00001692<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001693href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001694>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 +00001695Properties</a> in the defined value. </p>
1696
cristyefb2bdb2010-11-20 19:35:22 +00001697<p>The <em>option</em> and <em>key</em> are case-independent (they are
1698converted to lowercase for use within the decoders) while the <em>value</em>
1699is case-dependent.</p>
1700
cristyd0bda5e2010-09-21 16:22:45 +00001701<p>Such settings are global in scope, and effect all images and operations. </p>
1702
1703<p>The following definitions are just some of the artifacts that are
1704available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001705
cristydcca3fa2010-12-29 21:50:07 +00001706<dl>
cristy045bd902010-01-30 18:56:24 +00001707<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001708<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001709 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001710
cristy045bd902010-01-30 18:56:24 +00001711<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001712<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001713 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001714
cristy045bd902010-01-30 18:56:24 +00001715<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001716<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001717 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001718
cristy045bd902010-01-30 18:56:24 +00001719<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001720<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1721 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001722 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001723
cristy045bd902010-01-30 18:56:24 +00001724<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001725<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1726 compression factor is the reciprocal of the compression ratio. The valid
1727 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1728 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001729 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001730
cristy3ed852e2009-09-05 21:47:34 +00001731<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001732 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001733
cristy045bd902010-01-30 18:56:24 +00001734<dt>png:bit-depth=<em class="arg">value</em></dt>
1735<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001736<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1737 encoder to use a different bit-depth and color-type than it would have
1738 normally selected, but only if this does not cause any loss of image
1739 quality. Any attempt to reduce image quality is treated as an error and no
1740 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1741 can use these "defines" to cause it to be written as an 8-bit grayscale,
1742 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1743 you cannot force it to be written as a grayscale or indexed PNG. If you
1744 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1745 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1746 reduce the image quality prior to using the PNG encoder. Note that in
1747 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001748 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001749 8-bit depth.</dd>
1750
1751<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1752<dt>png:include-chunk=<em class="arg">value</em></dt>
1753<dd>ancillary chunks to be excluded from or included in PNG output.
1754
1755 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1756 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1757 or the word <em class="arg">all</em> or
1758 the word <em class="arg">none</em>. There must be no spaces in the
1759 list. Although PNG chunk-names are case-dependent, you can use
1760 all lowercase names if you prefer.</p>
1761
1762 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1763 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1764 only be written if gamma is not 1/2.2, since most decoders assume
1765 sRGB and gamma=1/2.2 when no colorspace information is included in
1766 the PNG file. Because the list is processed from left to right, you
1767 can achieve this with a single define:</p>
1768
1769<pre class="text">
1770 -define png:include-chunk=none,gAMA
1771</pre>
1772
1773 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
1774 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any of
1775 these entries appearing in the list will be ignored.</p>
1776
1777 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1778 image has transparency, the PNG colortype is forced to be 4 or 6
1779 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1780 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1781 on the PNG colortype of the output image.</p>
1782
1783 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1784 following for PNG output:</p>
1785
1786<pre class="text">
1787 -define png:include-chunk=none,gama
1788</pre>
1789
1790 <p>The default behavior is to include all known PNG ancillary chunks
cristyf7964272011-01-30 03:49:12 +00001791 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk,
1792 and to exclude all PNG chunks that are unknown to ImageMagick,
1793 regardless of their PNG "copy-safe" status as described in the
1794 PNG specification.</p>
cristydcca3fa2010-12-29 21:50:07 +00001795 </dd>
cristyd0bda5e2010-09-21 16:22:45 +00001796
cristy3ed852e2009-09-05 21:47:34 +00001797<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001798<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1799 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001800 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001801
cristy045bd902010-01-30 18:56:24 +00001802<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001803<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1804 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1805 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001806 included, the result is a single precision floating point format.
1807 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001808 double precision floating point format.</dd>
1809
cristydcca3fa2010-12-29 21:50:07 +00001810</dl>
cristy3ed852e2009-09-05 21:47:34 +00001811
cristyd0bda5e2010-09-21 16:22:45 +00001812<p>For example, to create a postscript file that will render only the black
1813pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001814
1815<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 +00001816<p>Set attributes of the image registry by prefixing the value with
1817<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1818use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001819
1820<p class="crtsnip">
1821-define registry:temporary-path=/data/tmp
1822</p>
1823
cristyd0bda5e2010-09-21 16:22:45 +00001824
1825
cristy3ed852e2009-09-05 21:47:34 +00001826<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001827 <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 +00001828</div>
1829
1830<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>
1831
1832<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>
1833
1834<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>
1835
1836
1837<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001838 <h4><a id="delete"></a>-delete <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001839</div>
1840
1841<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>
1842
1843<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>
1844
1845
1846<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001847 <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 +00001848</div>
1849
1850<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>
1851
1852<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>
1853
1854<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>
1855
1856<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>
1857
1858<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>
1859
1860<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001861 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001862</div>
1863
1864<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>
1865
1866<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>
1867
1868<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001869 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00001870</div>
1871
1872<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>
1873
1874<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001875 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001876</div>
1877
1878<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>
1879
1880<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>
1881
1882<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001883 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00001884</div>
1885
1886<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>reduce the speckles within an image.</td><td style='text-align:right;'></td></tr></table>
1887
1888<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001889 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001890</div>
1891
1892<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>
1893
1894<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001895 <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 +00001896</div>
1897
1898<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>
1899
1900<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001901is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001902what part of the 'background' image is seen at each point of the overlaid
1903area. Much like the displacement map is a 'lens' that redirects light shining
1904through it so as to present a distorted view the original 'background' image
1905behind it. </p>
1906
1907<p>Any perfect grey areas of the displacement map produce a zero
1908displacement of the image. Black areas produce the given maximum negative
1909displacement of the lookup point, while white produce a maximum positive
1910displacement of the lookup. </p>
1911
1912<p>Note that it is the lookup of the 'background' that is displaced, not a
1913displacement of the image itself. As such an area of the displacement map
1914containing 'white' will have the lookup point 'shifted' by a positive amount,
1915and thus generating a copy of the destination image to the right/downward from
1916the correct position. That is the image will look like it may have been
1917'shifted' in a negative left/upward direction. Understanding this is a very
1918important in understanding how displacement maps work. </p>
1919
1920<p>The given arguments define the maximum amount of displacement in pixels
1921that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001922it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001923outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001924easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001925into the overlay area. </p>
1926
1927<p>The '%' flag makes the displacement scale relative to the size of the
1928overlay image (100% = half width/height of image). Using '!' switches
1929percentage arguments to refer to the destination image size instead.
1930these flags were added as of IM v6.5.3-5.</p>
1931
1932<p>Normally a single grayscale displacement map is provided, which with the
1933given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001934displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001935specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001936the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001937displacement, while the <em class="arg">mask image</em> is used for vertical Y
1938displacement. This allows you to define completely different displacement
1939values for the X and Y directions, and allowing you to lookup any point within
1940the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001941any other nearby pixel, producing complex 2 dimensional displacements, rather
1942than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001943
cristyd0bda5e2010-09-21 16:22:45 +00001944<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001945you can use the 'red' channel of the overlay image to specify the horizontal
1946or X displacement, and the 'green' channel for the vertical or Y displacement.
1947</p>
1948
cristyd0bd44a2010-09-24 12:38:11 +00001949<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 +00001950mask the transparency of the destination image. However areas outside the
1951overlaid areas will not be effected. </p>
1952
1953
1954<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001955 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001956</div>
1957
1958<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>
1959
1960<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1961
1962<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001963 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001964</div>
1965
1966<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>
1967
1968<p>The layer disposal method defines the way each the displayed image is to be
1969modified after the current 'frame' of an animation has finished being
1970displayed (after its 'delay' period), but before the next frame on an
1971animation is to be overlaid onto the display. </p>
1972
1973<p>Here are the valid methods:</p>
1974
1975<pre class="text">
1976Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
1977None 1 Do not dispose, just overlay next frame image.
1978Background 2 Clear the frame area with the background color.
1979Previous 3 Clear to the image prior to this frames overlay.
1980</pre>
1981
1982<p>You can also use the numbers given above, which is what the GIF format
1983uses internally to represent the above settings. </p>
1984
cristyd0bda5e2010-09-21 16:22:45 +00001985<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00001986
1987<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
1988resetting the layer disposal methods of images being read in. </p>
1989
1990<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
1991disposal method for images already in memory.</p>
1992
1993<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001994 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001995</div>
1996
1997<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>maximum RMSE for subimage match (default 0.2).</td><td style='text-align:right;'>[<a href="../www/compare.html">compare</a>]</td></tr></table>
1998
1999
2000<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002001 <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 +00002002</div>
2003
2004<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>
2005
2006<p>The opacity of the composite image is multiplied by the given percent, then
2007it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00002008is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00002009transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
2010are given, each image are dissolved to the percentages given. </p>
2011
2012<p>Note that dissolve percentages do not add, two opaque images dissolved
2013'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2014images, you would need to use dissolve values of '50,100'. </p>
2015
2016<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002017 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002018</div>
2019
2020<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>
2021
2022<p>The <em class="arg">arguments</em> is a single string containing a list
2023of floating point numbers separated by commas or spaces. The number of
2024and meaning of the floating point values depends on the distortion <em
2025class="arg">method</em> being used. </p>
2026
2027<p>Choose from these distortion types:</p>
2028
2029<table class="doc">
2030 <tr valign="top">
2031 <th align="left" style="width: 8%">Method</th>
2032 <th align="left">Description</th>
2033 </tr>
2034
2035 <tr valign="top">
2036 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
2037 <br/>or &nbsp; <kbd>SRT</kbd></td>
2038 <td valign="top">
2039 Distort image by first scaling and rotating about a given 'center',
2040 before translating that 'center' to the new location, in that order. It
2041 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
2042 distortion, but without shearing effects. It also provides a good way
2043 of rotating and displacing a smaller image for tiling onto a larger
2044 background (IE 2-dimensional animations). <br/>
2045
2046 The number of arguments determine the specific meaning of each
2047 argument for the scales, rotation, and translation operations. <br/>
2048
2049 <table style="margin-left:auto; margin-right:auto;">
2050 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
2051 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
2052 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00002053 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002054 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
2055 <tr><td>5:</td>
2056 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2057 <tr><td>6:</td>
2058 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
2059 <tr><td>7:</td>
2060 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
2061 &nbsp; NewX,NewY</em></td></tr>
2062 </table>
2063
cristyd0bda5e2010-09-21 16:22:45 +00002064 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00002065 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2066
2067 <tr valign="top">
2068 <td valign="top"><kbd>Affine</kbd></td>
2069 <td valign="top">
2070 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002071 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002072 point values are given allowing the image to be linearly scaled,
2073 rotated, sheared, and translated, according to those three points. See
2074 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2075 distortions. <br/>
2076
2077 More than 3 sets given control point pairs (12 numbers) is least
2078 squares fitted to best match a lineary affine distortion. If only 2
2079 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002080 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002081 flipping or changes in aspect ratio to the resulting image. If only one
2082 control point pair is provides the image is only translated, (which may
2083 be a floating point non-integer translation). <br/>
2084
2085 This distortion does not include any form of perspective distortion.
2086 </td>
2087
2088 </tr>
2089
2090 <tr valign="top">
2091 <td valign="top"><kbd>AffineProjection</kbd></td>
2092 <td valign="top">
2093 Linearly distort an image using the given Affine Matrix of 6
2094 pre-calculated coefficients forming a set of Affine Equations to map
2095 the source image to the destination image.
2096
2097 <div style="text-align: center"><em>
2098 s<sub>x</sub>, r<sub>x</sub>,
2099 r<sub>y</sub>, s<sub>y</sub>,
2100 t<sub>x</sub>, t<sub>y</sub>
2101 </em></div>
2102
2103 See <a href="#affine" >-affine</a> setting for more detail, and
2104 meanings of these coefficients. <br/>
2105
2106 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002107 alternative methods of defining this distortion, with ImageMagick doing
2108 the calculations needed to generate the required coefficients. You can
2109 see the internally generated coefficients, by using a <a
2110 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002111
2112 </tr>
2113
cristy3ed852e2009-09-05 21:47:34 +00002114 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002115 <td valign="top"><kbd>BilinearForward</kbd><br/>
2116 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002117 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002118 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2119 16 values (see below). Not that lines may not appear straight after
2120 distortion, though the distance between coordinates will remain
2121 consistent. <br/>
2122
2123 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2124 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2125 quadrilateral to a rectangle, while preserving the straigth line edges
2126 in each case. <br/>
2127
2128 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2129 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2130 color setting. Also if the quadraterial becomes 'flipped' the image
2131 may dissappear. <br/>
2132
2133 There are future plans to produce a true Bilinear distortion that will
2134 attempt to map any quadrilateral to any other quadrilateral, while
2135 preserving edges (and edge distance ratios).
2136
2137 </td>
cristy3ed852e2009-09-05 21:47:34 +00002138 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002139
2140 <tr valign="top">
2141 <td valign="top"><kbd>Perspective</kbd></td>
2142 <td valign="top">
2143 Perspective distort the images, using a list of 4 or more sets of
2144 control points (as defined below). More that 4 sets (16 numbers) of
2145 control points provide least squares fitting for more accurate
2146 distortions (for the purposes of image registration and panarama
2147 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2148 linear distortion. <br/>
2149
2150 Perspective Distorted images ensures that straight lines remain
2151 straight, but the scale of the distorted image will vary. The horizon
2152 is anti-aliased, and the 'sky' color may be set using the
2153 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2154 </tr>
2155
2156 <tr valign="top">
2157 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2158 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002159 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002160 pre-calculated coefficients. You can get these coefficients by looking
2161 at the <a href="#verbose" >-verbose</a> output of a
2162 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2163 If the last two perspective scaling coefficients are zero, the
2164 remaining 6 represents a transposed 'Affine Matrix'. </td>
2165
2166 </tr>
2167
2168 <tr valign="top">
2169 <td valign="top"><kbd>Arc</kbd></td>
2170 <td valign="top">
2171 Arc the image (variation of polar mapping) over the angle given around
2172 a circle. <br/>
2173 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2174 <tr valign="top"><td>Argument</td>
2175 <td>Meaning</td></tr>
2176 <tr valign="top"><td><em>arc_angle</em></td>
2177 <td>The angle over which to arc the image side-to-side</td></tr>
2178 <tr valign="top"><td><em>rotate_angle</em></td>
2179 <td>Angle to rotate resulting image from vertical center</td></tr>
2180 <tr valign="top"><td><em>top_radius</em></td>
2181 <td>Set top edge of source image at this radius</td></tr>
2182 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2183 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2184 </table>
2185
2186 The resulting image is always resized to best fit the resulting image,
2187 (as if using <a href="#distort" >+distort</a>) while attempting to
2188 preserve scale and aspect ratio of the original image as much as
2189 possible with the arguments given by the user. All four arguments will
2190 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2191
2192 This a variation of a polar distortion designed to try to preserve the
2193 aspect ratio of the image rather than direct Cartesian to Polar
2194 conversion. </td>
2195 </tr>
2196
2197 <tr valign="top">
2198 <td valign="top"><kbd>Polar</kbd></td>
2199 <td valign="top">
2200 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2201 the image. that is the height of the input image is mapped to the
2202 radius limits, while the width is wrapped around between the
2203 angle limits. <br/>
2204
2205 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2206
2207 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2208 center to the center of the image, and the angles going from -180 (top)
2209 to +180 (top). If <em>Rmax</em> is given the special value of
2210 '<code>0</code>', the the distance from the center to the nearest edge
2211 is used for the radius of the output image, which will ensure the whole
2212 image is visible (though scaled smaller). However a special value of
2213 '<code>-1</code>' will use the distance from the center to the furthest
2214 corner, This may 'clip' the corners from the input rectangular image,
2215 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2216 the same arguments. <br/>
2217
2218 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2219 output image center will default to <code>0,0</code> of the virtual
2220 canvas, and the image size adjusted to ensure the whole input image is
2221 made visible in the output image on the virtual canvas. </td>
2222
2223 </tr>
2224
2225 <tr valign="top">
2226 <td valign="top"><kbd>DePolar</kbd></td>
2227 <td valign="top">
2228 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2229 but generates the reverse Polar to Cartesian distortion. <br/>
2230
2231 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2232 the corners of the input image. However using the special
2233 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2234 distance) will ensure the whole distorted image is preserved in the
2235 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2236 reverse the distortion re-producing the original.
2237
2238 Note that as this distortion requires the area resampling of a circular
2239 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002240 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002241 form of 'super-sampling' image processing technique be used to produce
2242 a high quality result. </td>
2243
2244 </tr>
2245
2246 <tr valign="top">
2247 <td valign="top"><kbd>Barrel</kbd></td>
2248 <td valign="top">
2249 Given the four coefficients (A,B,C,D) as defined by <a
cristy6bcf48e2011-02-15 19:09:04 +00002250 href="http://wiki.panotools.org/Lens_correction_model" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002251 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002252 correct radial lens distortions. That is in photographs, make straight
2253 lines straight again. <br/>
2254
2255 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2256 <em>X</em> , <em>Y</em> ] ] <br/>
2257 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2258 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2259 [ <em>X</em> , <em>Y</em> ] <br/>
2260 So that it forms the function <br/>
2261 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2262 <em>C</em>*r + <em>D</em> )<br/>
2263
2264 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2265 (defaulting to the center of the image). <br/>
2266 The second form is typically used to distort images, rather than
2267 correct lens distortions. <br/>
2268 </td>
2269
2270 </tr>
2271
2272 <tr valign="top">
2273 <td valign="top"><kbd>BarrelInverse</kbd></td>
2274 <td valign="top">
2275 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2276 arguments, and argument handling. However it uses the inverse
2277 of the radial polynomial,
2278 so that it forms the function <br/>
2279 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002280 <em>C</em>*r + <em>D</em> )<br/>
2281 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2282 distortion, just a different barrel-like radial distortion method.
2283
cristy3ed852e2009-09-05 21:47:34 +00002284 </td>
2285 </tr>
2286
2287 <tr valign="top">
2288 <td valign="top"><kbd>Shepards</kbd></td>
2289 <td valign="top">
2290 Distort the given list control points (any number) using an Inverse
2291 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002292 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2293 Method</a>). The control points in effect do 'localized' displacement
2294 of the image around the given control point (preserving the look and
2295 the rotation of the area near the control points. For best results
2296 extra control points should be added to 'lock' the positions of the
2297 corners, edges and other unchanging parts of the image, to prevent
2298 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002299
cristyd0bd44a2010-09-24 12:38:11 +00002300 The distortion has been likened to 'taffy pulling' using nails, or
2301 pins' stuck in a block of 'jelly' which is then moved to the new
2302 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002303
cristyd0bd44a2010-09-24 12:38:11 +00002304 Internally it is equivelent to generating a displacement map (see <a
2305 href="#displace" >-displace</a>) for source image color look-up using
2306 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2307
2308 </td>
cristy3ed852e2009-09-05 21:47:34 +00002309 </tr>
2310
2311</table>
2312
cristyd0bd44a2010-09-24 12:38:11 +00002313<p>To print a complete list of distortion methods, use <a href="#list">-list
2314distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002315
2316<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2317'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2318defining how these points in the given image should be distorted in the
2319destination image. Each set of four floating point values represent a source
2320image coordinate, followed immediately by the destination image coordinate.
2321This produces a list of values such as...</p>
2322<div style="text-align: center"><em>
2323 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2324 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2325 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2326 ... &nbsp;
2327 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2328</em></div>
2329<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2330destination image. </p>
2331
2332<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2333needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2334perspective distortion of the built-in "rose:" image. Note how spaces were
2335used to group the 4 sets of coordinate pairs, to make it easier to read and
2336understand.</p>
2337
2338<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002339convert rose: -virtual-pixel black \<br/>
2340 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2341 rose_3d_rotated.gif</span></p>
2342<p>If more that the required number of coordinate pairs are given for
2343a distortion, the distortion method is 'least squares' fitted to produce the
2344best result for all the coordinate pairs given. If less than the ideal number
2345of points are given, the distort will generally fall back to a simpler form of
2346distortion that can handles the smaller number of coordinates (usally a linear
2347'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002348
cristyd0bda5e2010-09-21 16:22:45 +00002349<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002350find matching coordinate pairs in overlapping images, so as to improve the
2351'fit' of the distortion. Of course a bad coordinate pair can also make the
2352'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002353
2354<p>Colors are acquired from the source image according to the <a
2355href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002356magnified. However if the viewed image is minified (image becomes smaller),
2357a special area resampling function (added ImageMagick v6.3.5-9), is used to
2358produce a higher quality image. For example you can use
2359a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2360the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002361
cristyd0bd44a2010-09-24 12:38:11 +00002362<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2363convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2364 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2365 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002366<p>Note that a infinitely tiled perspective images involving the horizon can
2367be very slow to generate due to the use of the high quality 'area resampling'
2368function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2369using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2370(recommended if you plan to use super-sampling instead). </p>
2371
2372<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2373'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2374will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2375pixels. If you do not what these pixels to be visible, set the color to match
2376the rest of the ground. </p>
2377
2378<p>The output image size will by default be the same as the input image. This
2379means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002380the 'distorted space', those parts is clipped and lost. However if you use
2381the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2382will attempt (if possible) to show the whole of the distorted image, while
2383retaining a correct 'virtual canvas' offset, for image layering. This offset
2384may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2385is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002386
2387<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2388option:distort:viewport {geometry_string}</kbd>" setting which will specify
2389the size and the offset of the generated 'viewport' image of the distorted
2390image space.</p>
2391
2392<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2393{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2394that factor without changing the viewed contents of the distorted image. This
2395can be used either for 'super-sampling' the image for a higher quality result,
2396or for panning and zooming around the image (with appropriate viewport
2397changes, or post-distort cropping and resizing). </p>
2398
2399<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2400href="#distort" >-distort</a> to attempt to output the internal coefficients,
2401and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2402and debugging purposes. This many not be available for all distorts. </p>
2403
2404<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2405produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2406and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002407above settings. It is algorithmically slower however, though that may not be
2408the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002409
2410
2411<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002412 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002413</div>
2414
2415<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>
2416
cristyd0bda5e2010-09-21 16:22:45 +00002417<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 +00002418
2419<p>Dithering is turned on by default, to turn it off use the plus form of the
2420setting, <a href="#dither">+dither</a>. This will also also render PostScript
2421without text or graphic aliasing. Disabling dithering often (but not always)
2422leads to faster process, a smaller number of colors, but more cartoon like
2423image coloring. Generally resulting in 'color banding' effects in areas with
2424color gradients. </p>
2425
2426<p>The color reduction operators <a href="#colors">-colors</a>, <a
2427href="#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>
2428
2429<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>
2430
2431
2432<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002433 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002434</div>
2435
2436<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>
2437
2438<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>
2439
2440<p>The shape primitives:</p>
2441
2442<pre class="text">
2443 point x,y
2444 line x0,y0 x1,y1
2445 rectangle x0,y0 x1,y1
2446 roundRectangle x0,y0 x1,y1 wc,hc
2447 arc x0,y0 x1,y1 a0,a1
2448 ellipse x0,y0 rx,ry a0,a1
2449 circle x0,y0 x1,y1
2450 polyline x0,y0 ... xn,yn
2451 polygon x0,y0 ... xn,yn
2452 bezier x0,y0 ... xn,yn
2453 path path specification
2454 image operator x0,y0 w,h filename
2455</pre>
2456
2457<p>The text primitive:</p>
2458
2459<pre class="text">
2460 text x0,y0 string
2461</pre>
2462<p>The text gravity primitive:</p>
2463
2464<pre class="text">
2465 gravity NorthWest, North, NorthEast, West, Center,
2466 East, SouthWest, South, or SouthEast
2467</pre>
2468
2469<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>
2470
2471<p>The transformation primitives:</p>
2472
2473<pre class="text">
2474 rotate degrees
2475 translate dx,dy
2476 scale sx,sy
2477 skewX degrees
2478 skewY degrees
2479</pre>
2480
2481<p>The pixel operation primitives:</p>
2482
2483<pre class="text">
2484 color x0,y0 method
2485 matte x0,y0 method
2486</pre>
2487
2488<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>
2489
2490<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>
2491
2492<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2493
2494<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2495
2496<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>
2497
2498<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2499
2500<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>
2501
2502<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>
2503
2504<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>.
2505</p>
2506
2507<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2508
2509<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2510
2511<p class="crtsnip">
2512 -draw 'circle 100,100 150,150'
2513</p>
2514
2515<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
2516draw 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>
2517
2518<p class="crtsnip">
2519 -draw 'bezier 20,50 45,100 45,0 70,50'
2520</p>
2521<p class="crtsnip">
2522 -draw 'bezier 70,50 95,100 95,0 120,50'
2523</p>
2524
2525
2526<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>
2527
2528<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>
2529
2530<p class="crtsnip">
2531 -draw 'image SrcOver 100,100 225,225 image.jpg'
2532</p>
2533
cristybc9539a2010-08-16 18:06:20 +00002534<p>You can use 0,0 for the image size, which means to use the actual
2535dimensions found in the image header. Otherwise, it is scaled to the given
2536dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
2537a detailed discussion of alpha composition methods that are available. </p>
cristy3ed852e2009-09-05 21:47:34 +00002538
2539<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>
2540
2541<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2542
2543<p class="crtsnip">
2544 -draw 'text 100,100 "Works like magick!"'
2545</p>
2546
2547<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2548
2549<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>
2550
2551<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2552
2553<p>The <kbd>scale</kbd> primitive scales them.</p>
2554
2555<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>
2556
2557<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
2558matrix.</p>
2559
2560<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>
2561
2562<pre class="text">
2563 point
2564 replace
2565 floodfill
2566 filltoborder
2567 reset
2568</pre>
2569
2570<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>
2571
2572<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>
2573
2574<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>
2575
2576<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2577
2578<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2579
2580
2581<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002582 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002583</div>
2584
2585<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>
2586
2587<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002588 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002589</div>
2590
2591<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>
2592
2593<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002594 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002595</div>
2596
2597<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>
2598
2599<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2600
2601<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2602
cristyd0bda5e2010-09-21 16:22:45 +00002603
2604
cristy3ed852e2009-09-05 21:47:34 +00002605<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002606 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002607</div>
2608
2609<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>
2610
2611<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>
2612
2613<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002614 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002615</div>
2616
2617<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>
2618
2619<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2620
2621<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2622
2623
2624<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002625 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002626</div>
2627
2628<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>
2629
2630
2631<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002632 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002633</div>
2634
2635<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>
2636
2637<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>
2638
2639<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2640
2641<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>
2642
2643<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002644 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002645</div>
2646
2647<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>
2648
2649<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>
2650
2651<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>
2652
2653<table class="doc">
2654 <col width="25%" />
2655 <col width="75%" />
2656 <thead>
2657 <tr>
2658 <th><em class="arg">operator</em></th>
2659 <th>Summary (see further below for details)</th>
2660 </tr>
2661 </thead>
2662 <tbody>
2663
cristy3c98a4f2010-08-13 20:09:41 +00002664 <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 +00002665 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2666 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2667 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2668 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2669 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002670 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2671 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002672 <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>
2673 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2674 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002675 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002676 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002677 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2678 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2679 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2680 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2681 <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>
2682 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2683 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2684 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2685 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2686
2687 <tr><td>&nbsp;</td></tr>
2688
2689 <tr><td>Gaussian-noise</td></tr>
2690 <tr><td>Impulse-noise</td></tr>
2691 <tr><td>Laplacian-noise</td></tr>
2692 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2693 <tr><td>PoissonNoise</td></tr>
2694 <tr><td>Uniform-noise</td></tr>
2695
2696 <tr><td>&nbsp;</td></tr>
2697
2698 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2699 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2700 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2701 </tbody>
2702 </table>
2703
2704<p>The specified functions are applied only to each previously set <a
2705href="#channel" >-channel</a> in the image. If necessary, the results of the
2706calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2707class="QR">QuantumRange</em>]. The transparency channel of the image is
2708represented as a 'alpha' values (0 = fully transparent), so, for example, a
2709<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2710semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2711as a percentage of the <em class="QR">QuantumRange</em>.</p>
2712
2713<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2714<a href="#list">-list evaluate</a>.</p>
2715
2716<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2717<kbd>Multiply</kbd> methods can also be achieved using either the <a
2718href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2719appropriate argument, to linearly modify the overall range of color values.
2720Please note, however, that <a href="#level" >-level</a> treats transparency as
2721'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2722'alpha' values.</p>
2723
2724<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>
2725
cristyce66ab12010-10-21 23:36:32 +00002726<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>
2727
2728 <div style="text-align:center;">
2729 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2730 </div>
2731
2732<p> If the input image is squared, for example, using <a
2733href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2734
cristy3ed852e2009-09-05 21:47:34 +00002735<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>
2736
2737 <div style="text-align:center;">
2738 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2739 </div>
2740
2741<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2742normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2743href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2744to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2745with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2746with <kbd>Pow</kbd>.</p>
2747
2748<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2749converts the image values into a value according to a (co)sine wave function.
2750The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2751is biased 50% and normalized by 50% so as to fit in the respective color value
2752range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2753function (its frequency), and thus determines the number of 'waves' that will
2754be generated over the input color range. For example, if the <em
2755class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2756class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2757then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002758class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002759
2760 <div style="text-align:center;">
2761 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2762 </div>
2763
cristydcca3fa2010-12-29 21:50:07 +00002764<p>See also the <a href="#function" >-function</a> operator, which is a
2765multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002766
cristy63fed272010-03-07 19:08:45 +00002767<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002768 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002769</div>
2770
2771<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 +00002772
2773<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002774 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002775</div>
2776
2777<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>
2778
cristy3e2860c2010-01-24 01:36:30 +00002779<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 +00002780<p>This command reduces or expands a JPEG image to fit on an 800x600
2781display. If the aspect ratio of the input image isn't exactly 4:3, then the
2782image is centered on an 800x600 black canvas: </p>
2783
2784<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>
2785
cristy3ed852e2009-09-05 21:47:34 +00002786
2787<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>
2788
2789<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002790 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002791</div>
2792
2793<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>
2794
2795<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2796
cristy4949d522010-03-12 18:41:34 +00002797<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 +00002798
cristy4949d522010-03-12 18:41:34 +00002799<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 +00002800<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002801equivalent to:</p>
2802
2803<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>
2804<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>
2805
2806<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002807 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002808</div>
2809
2810<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>
2811
2812<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).
2813</p>
2814
2815<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>.
2816</p>
2817
2818<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002819 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002820</div>
2821
2822<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>
2823
2824<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002825 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002826</div>
2827
2828<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>
2829
cristydcca3fa2010-12-29 21:50:07 +00002830<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 +00002831
cristydcca3fa2010-12-29 21:50:07 +00002832<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 +00002833
2834<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>
2835
2836<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2837<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>
2838
2839<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2840<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>
2841
cristyd0bd44a2010-09-24 12:38:11 +00002842<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 +00002843
2844<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>
2845
2846<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2847 -evaluate log 1000 fft_image_spectrum.png</span></p>
2848<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>
2849
cristydcca3fa2010-12-29 21:50:07 +00002850<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 +00002851
2852<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>
2853
2854<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>
2855
cristydcca3fa2010-12-29 21:50:07 +00002856<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 +00002857
2858<p>See the discussion on HDRI implementations of ImageMagick on the page
cristy47774982011-02-15 15:17:19 +00002859<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 +00002860</p>
2861
2862
2863<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002864 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002865</div>
2866
2867<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>
2868
2869<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>
2870
2871<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2872
2873<p>For example,</p>
2874
2875<p class="crtsnip">
2876 -fill blue
2877</p>
2878<p class="crtsnip">
2879 -fill "#ddddff"
2880</p>
2881<p class="crtsnip">
2882 -fill "rgb(255,255,255)"
2883</p>
2884
2885<p>See <a href="#draw">-draw</a> for further details.</p>
2886
2887<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2888
2889<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002890 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002891</div>
2892
cristyd0bda5e2010-09-21 16:22:45 +00002893<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
2894distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002895
cristyd0bda5e2010-09-21 16:22:45 +00002896<p>Use this option to affect the resizing operation of an image during
2897operations such as <a href="#resize">-resize</a> and <a href="#distort"
2898>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002899
2900<pre class="text">
2901 Point Hermite Cubic
2902 Box Gaussian Catrom
2903 Triangle Quadratic Mitchell
2904</pre>
2905
cristyd0bda5e2010-09-21 16:22:45 +00002906<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002907as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2908generally useless on their own as they are infinite filters that are being
2909clipped to the filters support size. Their direct use is not recommended
2910except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002911
cristydcca3fa2010-12-29 21:50:07 +00002912<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002913function that the <a href="#filter" >-filter</a> setting defines. That is
2914using these functions will define a 'Windowed' filter, appropriate to the
2915operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002916
2917<pre class="text">
2918 Lanczos Hamming Parzen
2919 Blackman Kaiser Welsh
2920 Hanning Bartlett Bohman
2921</pre>
2922
2923<p>Also one special self-windowing filter is also provided
2924<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2925on the current 'support' or 'lobes' expert settings (see below).</p>
2926
cristyd0bda5e2010-09-21 16:22:45 +00002927<p>If you do not select a filter with this option, the filter defaults to
2928<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2929if the image is enlarged. Otherwise the filter default to
2930<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002931
cristyd0bda5e2010-09-21 16:22:45 +00002932<p>To print a complete list of resize filters, use the <a href="#list">-list
2933filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002934
2935<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002936use of these expert settings (see also <a href="#define" >-define</a> and <a
2937href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002938
2939<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002940<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002941<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002942 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2943 Gaussian-like filters simple filters, or you may not get the expected
2944 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002945
cristyd0bda5e2010-09-21 16:22:45 +00002946<dt>-define filter:support=<em>radius</em></dt>
2947<dd>Set the filter support radius. Defines how large the filter should be and
2948 thus directly defines how slow the filtered resampling process is. All
2949 filters have a default 'prefered' support size. Some filters like
2950 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2951 this value. With simple filters this value either does nothing (but slow
2952 the resampling), or will clip the filter function in a detrimental way.
2953 </dd>
cristy3ed852e2009-09-05 21:47:34 +00002954
cristyd0bda5e2010-09-21 16:22:45 +00002955<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002956<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00002957 alternative way of specifying the 'support' range of the filter, that is
2958 designed to be more suited to windowed filters, especially when used for
2959 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002960
cristyd0bda5e2010-09-21 16:22:45 +00002961<dt>-define filter:b=<em>b-spline_factor</em></dt>
2962<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002963<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2964 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2965 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2966 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00002967 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00002968 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002969
cristyd0bda5e2010-09-21 16:22:45 +00002970<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002971<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00002972 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00002973 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00002974 'Bessel' functions. If defined, no windowing function is used, unless the
2975 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002976
cristyd0bda5e2010-09-21 16:22:45 +00002977<dt>-define filter:window=<em>filter_function</em></dt>
2978<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
2979 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
2980 support range) with the given filter. This allows you to specify a filter
2981 function that is not normally used as a windowing function, such as
2982 <kbd>Box</kbd>, (which effectively turns off the windowing function),
2983 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
2984 </dd>
2985
2986<dt>-define filter:verbose=<em>1</em></dt>
2987<dd>This causes IM to print information on the final internal filter
2988 selection to standard output. This includes a commented header on the
2989 filter settings being used, and data allowing the filter weights to be
2990 easily graphed. </dd>
2991
2992<dd>Note however that some filters are internally defined in terms of other
2993 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
2994 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
2995 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
2996 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002997
2998</dl>
2999
cristyd0bda5e2010-09-21 16:22:45 +00003000<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00003001
3002<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
3003 -set filter:window=bessel -set filter:lobes=8 \ <br/>
3004 -resize 150% image.jpg</span></p>
3005<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3006
3007<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
3008 -resize 150% image.jpg</span></p>
3009<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00003010filters, and 'verbose' for viewing the internal filter selection), are
3011provided for image processing experts who have studied and understood how
3012resize filters work. Without this knowledge, and an understanding of the
3013definition of the actual filters involved, using expert settings are more
3014likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00003015
3016
3017<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003018 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00003019</div>
3020
3021<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>
3022
3023
3024<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003025 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00003026</div>
3027
3028<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>
3029
3030<p>reflect the scanlines in the vertical direction.</p>
3031
3032<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003033 <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 +00003034</div>
3035
3036<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>
3037
3038<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003039 <h4><a id="flop"></a>-flop</h4>
cristy3ed852e2009-09-05 21:47:34 +00003040</div>
3041
3042<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>
3043
3044<p>reflect the scanlines in the horizontal direction.</p>
3045
3046
3047<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003048 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003049</div>
3050
3051<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>
3052
3053<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>
3054
3055<p>In addition to the fonts specified by the above pre-defined list, you can
3056also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
3057is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
3058<kbd>x:fixed</kbd> is X11 font.</p>
3059
3060<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>
3061
3062
3063<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003064 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003065</div>
3066
3067<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Define the foreground color.</td><td style='text-align:right;'></td></tr></table>
3068
3069<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3070
3071<p>The default foreground color is black.</p>
3072
3073<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003074 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003075</div>
3076
3077<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the image format type.</td><td style='text-align:right;'></td></tr></table>
3078
cristy47774982011-02-15 15:17:19 +00003079<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 +00003080
3081<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>
3082
3083<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003084 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003085</div>
3086
3087<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>
3088
3089<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>
3090
3091<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003092 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003093</div>
3094
3095<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Surround the image with a border or beveled frame.</td><td style='text-align:right;'></td></tr></table>
3096
cristybc9539a2010-08-16 18:06:20 +00003097<p>The color of the border is specified with the <a href="#mattecolor"
3098>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003099
cristybc9539a2010-08-16 18:06:20 +00003100<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
3101class="arg">geometry</em> argument indicates the amount of extra width and
3102height that is added to the dimensions of the image. If no offsets are given
3103in the <em class="arg">geometry</em> argument, then the border added is
3104a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3105the width and height of the border is partitioned to form an outer bevel of
3106thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3107<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3108</p>
3109
3110<p>The <a href="#frame">-frame</a> option is affected by the current <a
3111href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003112'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003113size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3114draws the frame of four distinct colors close to the current <a
3115href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3116center of this image. This means that with the default compose method of
3117'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3118href="#bordercolor">-bordercolor</a> setting.</p>
3119
3120<p>The image composition is not
3121affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003122
3123
3124<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003125 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003126</div>
3127
3128<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>
3129
3130<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003131 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003132</div>
3133
3134<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>
3135
3136<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>
3137
3138<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>
3139
3140<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>
3141
3142<pre class="text">
3143 Polynomial
3144 Sinusoid
3145 Arcsin
3146 Arctan
3147</pre>
3148
3149<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3150
3151<dl class="doc">
3152<dt><kbd>Polynomial</kbd></dt>
3153<dd>
3154<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>
3155
3156<div style="text-align: center">
3157 -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>
3158</div>
3159
3160<p>will invoke a polynomial function given by</p>
3161
3162<div style="text-align: center">
3163 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3164 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3165 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3166</div>
3167
3168<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3169
3170<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>
3171
3172<table class="doc">
3173 <col width="35%" />
3174 <col width="35%" />
3175 <col width="30%" />
3176 <tr>
3177 <td>-evaluate Set <em class="arg">value</em> </td>
3178 <td>-function Polynomial <em class="arg">value</em></td>
3179 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3180 </tr>
3181 <tr>
3182 <td>-evaluate Add <em class="arg">value</em> </td>
3183 <td>-function Polynomial 1,<em class="arg">value</em></td>
3184 </tr>
3185 <tr>
3186 <td>-evaluate Subtract <em class="arg">value</em> </td>
3187 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3188 </tr>
3189 <tr>
3190 <td>-evaluate Multiply <em class="arg">value</em> </td>
3191 <td>-function Polynomial <em class="arg">value</em>,0</td>
3192 </tr>
3193 <tr>
3194 <td>+level black% x white%</td>
3195 <td>-function Polynomial A,B</td>
3196 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3197 </tr>
3198</table>
3199
3200<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>
3201</dd>
3202
3203<dt><kbd>Sinusoid</kbd></dt>
3204<dd>
3205<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>
3206
3207<div style="text-align: center">
3208 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3209</div>
3210
3211<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>
3212
3213<div style="text-align: center">
3214<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>
3215</div>
3216
3217<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>
3218
3219<p class="crtsnip">
3220 -function Sinusoid 3,-90,.2,.7
3221</p>
3222
3223<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>
3224
3225<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>
3226
3227<table class="doc">
3228 <tr>
3229 <td>-evaluate Sin <em class="arg">freq</em> </td>
3230 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3231 </tr>
3232 <tr>
3233 <td>-evaluate Cos <em class="arg">freq</em> </td>
3234 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3235 </tr>
3236</table>
3237</dd>
3238
3239<dt><kbd>ArcSin</kbd></dt>
3240<dd>
3241<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3242and can be used to generate cylindrical distortion and displacement maps.
3243The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003244of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003245
cristydcca3fa2010-12-29 21:50:07 +00003246<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003247 -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 +00003248</p>
cristy3ed852e2009-09-05 21:47:34 +00003249
3250<p>with all values given in terms of noramlize color values (0.0 for black,
32511.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3252for bout input (<em class="arg">width</em>), and output (<em
3253class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3254
cristydcca3fa2010-12-29 21:50:07 +00003255<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003256<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 +00003257</p>
cristy3ed852e2009-09-05 21:47:34 +00003258
3259</dd>
3260
3261<dt><kbd>ArcTan</kbd></dt>
3262<dd>
3263<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3264limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003265All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003266
cristydcca3fa2010-12-29 21:50:07 +00003267<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003268 -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 +00003269</p>
cristy3ed852e2009-09-05 21:47:34 +00003270
3271<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3272</p>
3273
cristydcca3fa2010-12-29 21:50:07 +00003274<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003275<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 +00003276</p>
cristy3ed852e2009-09-05 21:47:34 +00003277
3278</dd>
3279
3280</dl>
3281
3282
3283<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003284 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003285</div>
3286
3287<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>
3288
3289<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>
3290
3291<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>
3292
3293
3294<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003295 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003296</div>
3297
3298<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>
3299
3300<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>
3301
3302<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3303
3304
3305<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003306 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003307</div>
3308
3309<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>
3310
3311<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>
3312
3313<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>
3314
3315<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>
3316
3317<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>
3318
3319<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3320
3321<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003322 <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 +00003323</div>
3324
3325<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>
3326
cristyb15553d2010-07-03 22:53:14 +00003327<p>Convolve the image with a Gaussian or normal distribution using the given
3328<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003329
3330<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3331</div>
3332
cristyb15553d2010-07-03 22:53:14 +00003333<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003334determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003335
3336<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003337array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003338integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003339radius that will provide meaningful results for the Gaussian distribution.
3340</p>
3341
3342<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3343operation is. However too small a <em class="arg" >Radius</em>, and sever
3344aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3345should be at least twice the <em class="arg" >Sigma</em> value, though three
3346times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003347
3348<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003349full 2-dimensional convolution is used to generate the weighted average of the
3350neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003351
3352<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3353pixels which are outside the image proper are blurred into the final result.
3354</p>
3355
3356
3357<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003358 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003359</div>
3360
3361<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the preferred size and location of the image.</td><td style='text-align:right;'></td></tr></table>
3362
3363<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>
3364
3365<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003366 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003367</div>
3368
3369<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Sets the current gravity suggestion for various other settings and options.</td><td style='text-align:right;'></td></tr></table>
3370
3371<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3372<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3373<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3374list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3375installation.</p>
3376
3377<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>
3378
3379<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>
3380
3381<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>
3382
cristy4949d522010-03-12 18:41:34 +00003383<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 +00003384<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>
3385
3386<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>
3387
3388
3389<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003390 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003391</div>
3392
3393<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>
3394
3395
3396<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003397 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003398</div>
3399
3400<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>
3401
3402<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3403dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3404can apply any color transformation to the Hald image and then use this option
3405to apply the transform to the image. </p>
3406
3407<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3408<p>This option provides a convenient method for you to use Gimp or Photoshop
3409to make color corrections to the Hald CLUT image and subsequently apply them
3410to multiple images using an ImageMagick script. </p>
3411
3412<p>Note that the representation is only of the normal RGB color space and that
3413the whole color value triplet is used for the interpolated lookup of the
3414represented Hald color cube image. Because of this the operation is not <a
3415href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3416images transparency or alpha/matte channel.</p>
3417
3418<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3419of the individual color channels, usally involving a simplier gray-scale
3420image. E.g: gray-scale to color replacement, or modification by a histogram
3421mapping. </p>
3422
3423
3424<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003425 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003426</div>
3427
3428<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>
3429
3430<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003431 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003432</div>
3433
3434<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>when comparing images, emphasize pixel differences with this color.</td><td style='text-align:right;'></td></tr></table>
3435
3436<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003437 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003438</div>
3439
3440<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>
3441
3442<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>
3443
3444<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>
3445
3446<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003447 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003448</div>
3449
3450<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>
3451
3452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003453 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003454</div>
3455
3456<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>
3457
3458<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>
3459
cristy47774982011-02-15 15:17:19 +00003460<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 +00003461
cristyd0bda5e2010-09-21 16:22:45 +00003462<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003463amounts of image properties are displayed including image statistics, profiles,
3464image histogram, and others.</p>
3465
3466<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003467 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003468</div>
3469
3470<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>
3471
cristydcca3fa2010-12-29 21:50:07 +00003472<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 +00003473
3474<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>
3475
3476<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3477<p>or</p>
3478
3479<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>
3480
cristydcca3fa2010-12-29 21:50:07 +00003481<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 +00003482
cristydcca3fa2010-12-29 21:50:07 +00003483<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 +00003484
cristydcca3fa2010-12-29 21:50:07 +00003485<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 +00003486
3487<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003488 <h4><a id="immutable"></a>-immutable</h4>
cristy3ed852e2009-09-05 21:47:34 +00003489</div>
3490
3491<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>
3492
3493<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003494 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003495</div>
3496
3497<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>
3498
3499<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003500 <h4><a id="insert"></a>-insert <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003501</div>
3502
3503<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>
3504
3505<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>
3506
3507<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>
3508
3509<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003510 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003511</div>
3512
3513<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>
3514
3515<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>
3516
3517<p>The default intent is undefined.</p>
3518
3519<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3520
3521<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003522 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003523</div>
3524
3525<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>
3526
3527<p>Choose from:</p>
3528
3529<pre class="text">
3530 none
3531 line
3532 plane
3533 partition
3534 JPEG
3535 GIF
3536 PNG
3537</pre>
3538
3539<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>
3540
3541<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3542
3543<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3544
3545<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3546
3547<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3548image.G, and image.B).</p>
3549
3550<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>
3551image.</p>
3552
3553<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3554
3555<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003556 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003557</div>
3558
3559<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
3560
cristyd0bda5e2010-09-21 16:22:45 +00003561<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003562value, you typically fall in between the pixel colors defined by the source
3563image. This setting determines how the color is determined from the colors of
3564the pixels surrounding that point. That is how to determine the color of a
3565point that falls between two, or even four different colored pixels. </p>
3566
3567<pre class="text">
3568 integer: The color of the top-left pixel (floor function)
3569 nearest-neighbor: The nearest pixel to the lookup point (rounded function)
3570 average: The average color of the surrounding four pixels
3571 bilinear A double linear interpolation of pixels (the default)
3572 mesh Divide area into two flat triangular interpolations
3573 bicubic Fitted bicubic-spines of surrounding 16 pixels
3574 spline Direct spline curves (colors are blurred)
3575 filter Use resize <a href="#filter">-filter</a> settings
3576</pre>
3577
3578<p>This most important for distortion operators such as <a href="#distort"
3579>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3580>-transform</a> and <a href="#fx" >-fx</a>. </p>
3581
3582<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3583
3584<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3585lookup for positions outside the boundaries of the image. </p>
3586
3587
3588<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003589 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003590</div>
3591
3592<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>
3593
3594<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003595 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003596</div>
3597
3598<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>
3599
3600<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003601 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003602</div>
3603
3604<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>
3605
3606<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003607 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003608</div>
3609
3610<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>
3611
cristy71a3f602010-09-15 12:38:16 +00003612<p>Use this option to assign a specific label to the image, as it is read in
3613or created. You can use the <a href="#set" >-set</a> operation to re-assign
3614a the labels of images already read in. Image formats such as TIFF, PNG,
3615MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003616
cristy71a3f602010-09-15 12:38:16 +00003617<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3618assigned to an image is used as a header string to print above the postscript
3619image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003620
cristybc9539a2010-08-16 18:06:20 +00003621<p>You can include the image filename, type, width, height, or other image
3622attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3623Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003624
3625<p>For example,</p>
3626
3627<p class="crtsnip">
3628 -label "%m:%f %wx%h" bird.miff
3629</p>
3630
cristy71a3f602010-09-15 12:38:16 +00003631<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3632"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3633is read in. If a <a href="#label">+label</a> option was used instead, any
3634existing label present in the image would be used. You can remove all labels
3635from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003636
cristy71a3f602010-09-15 12:38:16 +00003637<p>A label is not drawn on the image, but is embedded in the image datastream
3638via <em>Label</em> tag or similar mechanism. If you want the label to be
3639visible on the image itself, use the <a href="#draw">-draw</a> option, or
3640during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003641
cristy71a3f602010-09-15 12:38:16 +00003642<p>If the first character of <em class="arg">string</em> is <em
3643class="arg">@</em>, the image label is read from a file titled by the
3644remaining characters in the string. Labels in a file are literal, no embedded
3645formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003646
3647
3648<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003649 <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 +00003650</div>
3651
3652<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>
3653
3654<p>Adaptively threshold each pixel based on the value of pixels in a
3655surrounding window. If the current pixel is lighter than this average plus
3656the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3657black. Small variations in pixel values such as found in scanned documents
3658can be ignored if offset is positive. A negative offset will make it more
3659sensitive to those small variations. </p>
3660
3661<p>This is commonly used to threshold images with an uneven background. It is
3662based on the assumption that average color of the small window is the
3663the local background color, from which to separate the forground color. </p>
3664
3665
3666<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003667 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003668</div>
3669
3670<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>
3671
3672<p>Perform various image operation methods to a ordered sequence of images
3673which may represent either a set of overlaid 'image layers', a GIF disposal
3674animation, or a fully-'coalesced' animation sequence. </p>
3675
3676<table class="doc">
3677 <tbody>
3678 <tr valign="top">
3679 <th align="left" style="width: 8%">Method</th>
3680 <th align="left">Description</th>
3681 </tr>
3682
3683 <tr valign="top">
3684 <td valign="top">compare-any</td>
3685 <td valign="top">Crop the second and later frames to the smallest rectangle
3686 that contains all the differences between the two images. No GIF <a
3687 href="#dispose" >-dispose</a> methods are taken into account. </td>
3688 </tr>
3689
3690 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3691 >-deconstruct</a> operator, and does not preserve animations normal
3692 working, especially when animation used layer disposal methods such as
3693 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3694 </tr>
3695
3696 <tr valign="top">
3697 <td valign="top">compare-clear</td>
3698 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3699 opaque pixels which become transparent in the second frame. That is the
3700 smallest image needed to mask or erase pixels for the next frame. </td>
3701 </tr>
3702
3703 <tr valign="top">
3704 <td valign="top">compare-overlay</td>
3705 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3706 extra color to the next image, as a result of overlaying color pixels.
3707 That is the smallest single overlaid image to add or change colors. </td>
3708 </tr>
3709
3710 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3711 composition method '<kbd>change-mask</kbd>', to reduce the image to
3712 just the pixels that need to be overlaid. </td>
3713 </tr>
3714
3715 <tr valign="top">
3716 <td valign="top">coalesce</td>
3717 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3718 >-coalesce</a> operator. Apply the layer disposal methods set in the
3719 current image sequence to form a fully defined animation sequence, as
3720 it should be displayed. Effectively converting a GIF animation into a
3721 'film strip'-like animation. </td>
3722 </tr>
3723
3724 <tr valign="top">
3725 <td valign="top">composite</td>
3726 <td valign="top">Alpha Composition of two image lists, separated by a
3727 "<kbd>null:</kbd>" image, with the destination image list first, and
3728 the source images last. An image from each list are composited
3729 together until one list is finished. The separator image and source
3730 image lists are removed. </td>
3731 </tr>
3732
3733
cristybac7a162010-06-15 19:57:29 +00003734 <tr><td></td>
3735 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3736 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3737 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003738 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003739 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003740
cristybac7a162010-06-15 19:57:29 +00003741 <tr><td></td>
3742 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003743 applied to all the images in the other image list, regardless of which
3744 list it is. In this case it is the image meta-data of the list which
3745 preserved. </td>
3746 </tr>
3747
3748
3749 <tr valign="top">
3750 <td valign="top">dispose</td>
3751 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3752 the animation after the layer disposal method has been applied, before
3753 the next sub-frame image is overlaid. That is the 'dispose' image that
3754 results from the application of the GIF <a href="#dispose"
3755 >-dispose</a> method. This allows you to check what
3756 is going wrong with a particular animation you may be developing.
3757 </td>
3758 </tr>
3759
3760 <tr valign="top">
3761 <td valign="top">flatten</td>
3762 <td valign="top">Create a canvas the size of the first images virtual
3763 canvas using the current <a href="#background" >-background</a> color,
3764 and <a href="#compose" >-compose</a> each image in turn onto that
3765 canvas. Images falling outside that canvas is clipped. Final
3766 image will have a zero virtual canvas offset. </td>
3767 </tr>
3768
cristybac7a162010-06-15 19:57:29 +00003769 <tr><td></td>
3770 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003771 overlaying all the prepared image layers into a final image. </td>
3772 </tr>
3773
cristybac7a162010-06-15 19:57:29 +00003774 <tr><td></td>
3775 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003776 canvas with real pixels, or to underlay a opaque color to remove
3777 transparency from an image.</td>
3778 </tr>
3779
3780
3781 <tr valign="top">
3782 <td valign="top">merge</td>
3783 <td valign="top">As 'flatten' method but merging all the given image
3784 layers into a new layer image just large enough to hold all the image
3785 without clipping or extra space. The new images virtual offset will
3786 prevere the position of the new layer, even if this offset is
3787 negative. the virtual canvas size of the first image is preserved.
3788 </td>
3789 </tr>
3790
3791 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3792 as few image file formats handle them correctly. </td>
3793 </tr>
3794
3795 <tr valign="top">
3796 <td valign="top">mosaic</td>
3797 <td valign="top">As 'flatten' method but expanding the initial canvas size
3798 of the first image so as to hold all the image layers. However as a
cristyd0bda5e2010-09-21 16:22:45 +00003799 virtual canvas is 'locked' to the origin, by definition, image layers
cristy3ed852e2009-09-05 21:47:34 +00003800 with a negative offsets will still be clipped by the top and left
3801 edges.</td>
3802 </tr>
3803
3804 <tr><td></td><td>This method is commonly used to layout individual image using various
cristyd0bda5e2010-09-21 16:22:45 +00003805 offset but without knowing the final canvas size. The resulting image
cristy3ed852e2009-09-05 21:47:34 +00003806 will, like 'flatten' not have any virtual offset, so can be saved to
3807 any image file format. </td>
3808 </tr>
3809
3810
3811 <tr valign="top">
3812 <td valign="top">optimize</td>
3813 <td valign="top">Optimize a coalesced animation, into GIF animation using
3814 a number of general techniques. This currently a short cut to
3815 apply both the '<kbd>optimize-frame</kbd>', and
3816 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3817 include other optimization methods as they are developed. </td>
3818 </tr>
3819
3820 <tr valign="top">
3821 <td valign="top">optimize-frame</td>
3822 <td valign="top">Optimize a coalesced animation, into GIF animation by
3823 reducing the number of pixels per frame as much as possible by
3824 attempting to pick the best layer disposal method to use, while ensuring
3825 the result will continue to animate properly. </td>
3826 </tr>
3827
3828 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3829 then no reasonably fast GIF optimization algorithm can do this.
3830 However this does seem to do better than most other GIF frame
3831 optimizers seen. </td>
3832 </tr>
3833
3834 <tr valign="top">
3835 <td valign="top">optimize-plus</td>
3836 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3837 overall optimization by adding extra frames to the animation, without
3838 changing the final look or timing of the animation. The frames are
3839 added to attempt to separate the clearing of pixels from the
3840 overlaying of new additional pixels from one animation frame to the
3841 next. If this does not improve the optimization (for the next frame
3842 only), it will fall back to the results of the previous normal
3843 '<kbd>optimize-frame</kbd>' technique. </td>
3844 </tr>
3845
3846 <tr><td></td><td>There is the possibility that the change in the disposal style will
3847 result in a worsening in the optimization of later frames, though this
3848 is unlikely. In other words there no guarantee that it is better than
3849 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
cristyd0bda5e2010-09-21 16:22:45 +00003850 however you can get a vast improvement in the final animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003851 </tr>
3852
3853 <tr valign="top">
3854 <td valign="top">optimize-transparency</td>
3855 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3856 overlay images with transparency, if it does not change the resulting
3857 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3858 </td>
3859 </tr>
3860
3861 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3862 into a smaller file size due to larger areas of one (transparent)
3863 color rather than a pattern of multiple colors repeating the current
3864 disposed image of the last frame. </td>
3865 </tr>
3866
3867 <tr valign="top">
3868 <td valign="top">remove-dups</td>
3869 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3870 images, so as to simplify layer overlays of coalesced animations.
3871 </td>
3872 </tr>
3873
3874 <tr><td></td><td>Usually this a result of using a constant time delay across the
3875 whole animation, or after a larger animation was split into smaller
3876 sub-animations. The duplicate frames could also have been used as
3877 part of some frame optimization methods. </td>
3878 </tr>
3879
3880 <tr valign="top">
3881 <td valign="top">remove-zero</td>
3882 <td valign="top">Remove any image with a zero time delay, unless ALL the
3883 images have a zero time delay (and is not a proper timed animation, a
3884 warning is then issued). </td>
3885 </tr>
3886
3887 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3888 partial intermediary updates between the frames that are actually
3889 displayed to users. These frames are usally added for improved frame
3890 optimization in GIF animations. </td>
3891 </tr>
3892
3893 <tr valign="top">
3894 <td valign="top">trim-bounds</td>
3895 <td valign="top">Find the bounds of all the images in the current
3896 image sequence, then adjust the offsets so all images are contained on
3897 a minimal positive canvas. None of the image data is modified, only
3898 there virtual canvas size and offset. The all the image is given
3899 the same canvas size, and and will have a positive offset, but will
3900 remain in the same position relative to each other. As a result of the
3901 minimal canvas size at least one image will touch every edge of that
3902 canvas. The image data however may be transparent.
3903 </td>
3904 </tr>
3905
3906 </tbody>
3907</table>
3908
3909<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3910
3911<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3912>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3913>-mosaic</a> are only aliases for the above methods. Also see <a
3914href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3915href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3916>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3917
3918
3919<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003920 <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 +00003921</div>
3922
3923<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>
3924
3925<p>Given one, two or three values delimited with commas: black-point,
3926white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3927white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3928point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3929contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3930both black and white points are percentages of the full color range. Gamma
3931will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3932omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3933
3934<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3935the given '<kbd>black_point</kbd>' value in the original image is set to
3936zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3937<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3938to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3939adjusted. </p>
3940
3941<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3942adding the special '!' flag anywhere in the argument list, will cause the
3943operator to do the reverse of the level adjustment. That is a zero, or
3944<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
3945adjusted to the given level values, allowing you to de-contrast, or compress
3946the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
3947
3948<p>Only the channels defined by the current <a href="#channel">-channel</a>
3949setting are adjusted (defaults to RGB color channels only), allowing you to
3950limit the effect of this operator. </p>
3951
3952<p>Please note that the transparency channel is treated as 'matte'
3953values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
3954
3955
3956<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003957 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00003958 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
3959</div>
3960
cristyd0bda5e2010-09-21 16:22:45 +00003961<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 +00003962
3963<p>This function is exactly like <a href="#level">-level</a>, except that the
3964value value for each color channel is determined by the
3965'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
3966described under the <a href="#fill">-fill</a> option). </p>
3967
cristyd0bda5e2010-09-21 16:22:45 +00003968<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
3969is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00003970colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00003971adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00003972
3973<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
3974will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00003975respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00003976those colors. This can also be used to convert a plain gray-scale image into a
3977one using the gradient of colors specified. </p>
3978
3979<p>By supplying a single color with a comma separator either before or after
3980that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00003981respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00003982used for both the black and white color points, making the operator either
3983threshold the images around that color (- form) or set all colors to that
3984color (+ form). </p>
3985
3986
3987<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003988 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003989</div>
3990
3991<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>
3992
3993<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>
3994
cristy6b636652009-12-05 17:16:11 +00003995<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 +00003996
3997<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00003998 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00003999</p>
4000
4001<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
4002
cristydcca3fa2010-12-29 21:50:07 +00004003<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list resource</span><span class='crtout'></span></p><pre class="text">
4004File Area Memory Map Disk Thread Time
cristy6b636652009-12-05 17:16:11 +00004005------------------------------------------------------------------------------
cristydcca3fa2010-12-29 21:50:07 +00004006 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
4007</pre>
4008
cristy3ed852e2009-09-05 21:47:34 +00004009<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>
4010
4011<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>
4012
4013<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>
4014
4015<p class="crtsnip">
4016-limit area 10mb
4017</p>
4018
cristyd0bda5e2010-09-21 16:22:45 +00004019<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 +00004020
4021<p class="crtsnip">
4022-limit area 10mb -limit disk 500mb
4023</p>
4024
4025<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
4026
4027<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>
4028
4029<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.
4030</p>
4031
4032<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.
4033</p>
4034
4035<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004036 <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 +00004037</div>
4038
4039<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>
4040
cristyd934d102009-10-10 12:55:13 +00004041<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
4042and uses a 'histogram bin' to determine the range of color values that needs to
4043be stretched. However it then stretchs those colors using the <a
4044href="#level" >-level</a> operator.</p>
4045
4046<p>As such while the initial determination may have 'binning' round off
4047effects, the image colors are stretched mathematically, rather than using the
4048histogram bins. This makes the operator more accurate. </p>
4049
4050<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
4051'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
4052perfect stretch of the color range. </p>
4053
4054<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
4055normalization of mathematical images. </p>
4056
4057<p>This operator is under review for re-development. </p>
4058
4059
cristy3ed852e2009-09-05 21:47:34 +00004060<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004061 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00004062</div>
4063
4064<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>
4065
4066<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004067 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004068</div>
4069
4070<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>
4071
4072<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>
4073
4074<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004075 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004076</div>
4077
4078<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>
4079
4080<pre class="text">
cristyc1aee832010-05-08 00:36:47 +00004081 Align
4082 Alpha
4083 Boolean
4084 Channel
4085 Class
4086 ClipPath
4087 Coder
4088 Color
4089 Colorspace
4090 Command
4091 Compose
4092 Compress
4093 Configure
4094 DataType
4095 Debug
4096 Decoration
4097 Delegate
4098 Direction
4099 Dispose
4100 Distort
4101 Dither
4102 Endian
4103 Evaluate
4104 FillRule
4105 Filter
4106 Font
4107 Format
4108 Function
4109 Gravity
4110 ImageList
4111 Intent
4112 Interlace
4113 Interpolate
4114 Kernel
cristy787d4352010-03-06 13:55:58 +00004115 Layers
4116 LineCap
4117 LineJoin
4118 List
4119 Locale
4120 LogEvent
4121 Log
4122 Magic
4123 Method
4124 Metric
4125 Mime
4126 Mode
4127 Morphology
4128 Module
4129 Noise
4130 Orientation
4131 Policy
4132 PolicyDomain
4133 PolicyRights
4134 Preview
4135 Primitive
4136 QuantumFormat
4137 Resource
4138 SparseColor
4139 Storage
4140 Stretch
4141 Style
4142 Threshold
4143 Type
4144 Units
4145 Validate
4146 VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004147</pre>
4148
cristybac7a162010-06-15 19:57:29 +00004149<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4150list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4151available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004152
4153<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4154<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004155 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004156</div>
4157
4158<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>
4159
cristybac7a162010-06-15 19:57:29 +00004160<p>This option specifies the format for the log printed when the <a
4161href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004162
cristybac7a162010-06-15 19:57:29 +00004163<p>You can display the following components by embedding special format
4164characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004165
4166<pre class="text">
4167 %d domain
4168 %e event
4169 %f function
4170 %l line
4171 %m module
4172 %p process ID
4173 %r real CPU time
4174 %t wall clock time
4175 %u user CPU time
4176 %% percent sign
4177 \n newline
4178 \r carriage return
4179</pre>
4180
4181<p>For example:</p>
4182
4183<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>
4184<p>The default behavior is to print all of the components.</p>
4185
4186<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004187 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004188</div>
4189
4190<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>add Netscape loop extension to your GIF animation.</td><td style='text-align:right;'></td></tr></table>
4191
cristybac7a162010-06-15 19:57:29 +00004192<p>Set iterations to zero to repeat the animation an infinite number of times,
4193otherwise the animation repeats itself up to <em class="arg">iterations</em>
4194times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004195
4196<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004197 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004198</div>
4199
4200<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>
4201
4202<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004203 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004204</div>
4205
4206<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>
4207
4208
4209<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004210 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004211</div>
4212
4213<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>
4214
4215<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4216
4217<pre class="text">
4218 best
4219 default
4220 gray
4221 red
4222 green
4223 blue
4224</pre>
4225
cristybac7a162010-06-15 19:57:29 +00004226<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4227Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4228the type and <kbd>display</kbd> searches the list of colormap types in
4229<kbd>top-to-bottom</kbd> order until one is located. See <em
4230class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004231
4232
4233<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004234 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004235</div>
4236
4237<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>
4238
4239<p>Here are the valid components of a map:</p>
4240
4241<pre class="text">
4242 r red pixel component
4243 g green pixel component
4244 b blue pixel component
4245 a alpha pixel component (0 is transparent)
4246 o opacity pixel component (0 is opaque)
4247 i grayscale intensity pixel component
4248 c cyan pixel component
4249 m magenta pixel component
4250 y yellow pixel component
4251 k black pixel component
4252 p pad component (always 0)
4253</pre>
4254
cristybac7a162010-06-15 19:57:29 +00004255<p>You can specify as many of these components as needed in any order (e.g.
4256bgr). The components can repeat as well (e.g. rgbr).</p>
4257
cristy3ed852e2009-09-05 21:47:34 +00004258
4259<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004260 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004261<em class="arg">filename</em></h4>
4262</div>
4263
4264<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>
4265
4266<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
4267
4268<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004269 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004270</div>
4271
4272<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify the color to be used with the <a href="#frame">-frame</a> option.</td><td style='text-align:right;'></td></tr></table>
4273
4274<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4275
cristybac7a162010-06-15 19:57:29 +00004276<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4277style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004278
4279<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004280 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004281</div>
4282
4283<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>
4284
4285<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004286 <h4><a id="median"></a>-median <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004287</div>
4288
4289<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>
4290
4291<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004292 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004293</div>
4294
4295<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>
4296
4297<p>Choose from:</p>
4298
4299<pre class="text">
cristybac7a162010-06-15 19:57:29 +00004300 AE absolute error count, number of different pixels (-fuzz effected)
cristya20e3f92010-12-13 01:52:32 +00004301 FUZZ mean color distance
cristybac7a162010-06-15 19:57:29 +00004302 MAE mean absolute error (normalized), average channel error distance
4303 MEPP mean error per pixel (normalized mean error, normalized peak error)
4304 MSE mean error squared, average of the channel error squared
cristya20e3f92010-12-13 01:52:32 +00004305 NCC normalized cross correlation
cristybac7a162010-06-15 19:57:29 +00004306 PAE peak absolute (normalize peak absolute)
4307 PSNR peak signal to noise ratio
4308 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004309</pre>
4310
cristy771f7a72010-11-27 21:42:59 +00004311<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4312with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4313only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004314size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004315'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004316for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004317
4318<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4319('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004320normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004321
cristybac7a162010-06-15 19:57:29 +00004322<p>To print a complete list of metrics, use the <a href="#list">-list
4323metrics</a> option.</p>
4324
cristy3ed852e2009-09-05 21:47:34 +00004325
cristyd2baf7d2010-03-06 04:26:44 +00004326<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004327 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004328</div>
4329
4330<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>
4331
cristy3ed852e2009-09-05 21:47:34 +00004332
4333<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004334 <h4><a id="mode"></a>-mode <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004335</div>
4336
4337<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>
4338
cristybac7a162010-06-15 19:57:29 +00004339<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4340Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004341
cristybac7a162010-06-15 19:57:29 +00004342<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4343for a list of <a href="#mode" >-mode</a> arguments available in your
4344ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004345
4346
4347<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004348 <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 +00004349</div>
4350
cristybac7a162010-06-15 19:57:29 +00004351<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
4352class="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 +00004353
cristyb36feb22010-03-26 16:54:37 +00004354<p>The arguments are given as a percentages of variation. A value of 100 means
4355no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004356
cristyb36feb22010-03-26 16:54:37 +00004357<p>The <em class="arg">brightness</em> is a multiplier of the overall
4358brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4359twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4360before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004361
cristyb36feb22010-03-26 16:54:37 +00004362<p>The <em class="arg">saturation</em> controls the amount of color in an
4363image. For example, 0 produce a grayscale image, while a large value such as
4364200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004365
cristyb36feb22010-03-26 16:54:37 +00004366<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4367within the image by the amount specified. For example, 50 results in
4368a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4369A value of either 0 or 200 results in a complete 180 degree rotation of the
4370image. Using a value of 300 is a 360 degree rotation resulting in no change to
4371the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004372
cristyb36feb22010-03-26 16:54:37 +00004373<p>For example, to increase the color brightness by 20% and decrease the color
4374saturation by 10% and leave the hue unchanged, use <a
4375href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004376
cristyb36feb22010-03-26 16:54:37 +00004377<p>Use <a href="#set">-set</a> attribute of '<kbd
4378class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4379modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4380<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004381
4382<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 +00004383
cristy3ed852e2009-09-05 21:47:34 +00004384<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004385 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004386</div>
4387
4388<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>
4389
4390
4391<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004392 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004393</div>
4394
4395<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>
4396
4397
4398<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004399 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004400</div>
4401
4402<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>
4403
4404<p>Both the image pixels and size are linearly interpolated to give the
4405appearance of a meta-morphosis from one image to the next, over all the images
4406in the current image list. The added images are the equivalent of a <a
4407href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4408argument determine how many images to interpolate between each image. </p>
4409
4410
4411<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004412 <h4><a id="morphology"></a>-morphology</h4>
4413 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004414</div>
4415
cristy2c839602010-04-03 02:32:08 +00004416<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 +00004417
cristydcca3fa2010-12-29 21:50:07 +00004418<p>Until I get around to writing a option summary for this, see <a
4419href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4420Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004421
4422
cristy488844c2010-01-22 14:02:05 +00004423<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004424 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004425</div>
4426
4427<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>
4428
4429
4430<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004431 <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 +00004432</div>
4433
4434<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>
4435
4436<p>Blur with the given radius, standard deviation (sigma), and angle. The
4437angle given is the angle toward which the image is blurred. That is the
4438direction people would consider the object is coming from. </p>
4439
4440<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004441definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004442
4443<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4444pixels which are outside the image proper are blurred into the final result.
4445</p>
4446
4447<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004448 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004449</div>
4450
4451<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>
4452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004453 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004454</div>
4455
cristyb29bc032010-02-01 20:29:43 +00004456<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 +00004457
4458<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>
4459
4460<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004461 <h4><a id="noise"></a>-noise <em class="arg">radius</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004462 +noise <em class="arg">type</em></h4>
4463</div>
4464
4465<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>
4466
4467<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>
4468
4469<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>
4470
4471<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>
4472
4473<pre class="text">
4474Gaussian
4475Impulse
4476Laplacian
4477Multiplicative
4478Poisson
4479Random
4480Uniform
4481</pre>
4482
4483<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4484
cristy83543962009-10-16 19:04:28 +00004485<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4486the use of a controlling value to specify teh amount of noise that should be
4487added to an image. </p>
4488
cristy3ed852e2009-09-05 21:47:34 +00004489
4490<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004491 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004492</div>
4493
4494<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Increase the contrast in an image by <em>stretching</em> the range of intensity values.</td><td style='text-align:right;'></td></tr></table>
4495
cristyd934d102009-10-10 12:55:13 +00004496<p>The intensity values are stretched to cover the entire range of possible
4497values. While doing so, black-out at most <em>2%</em> of the pixels and
4498white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004499
cristyd934d102009-10-10 12:55:13 +00004500<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4501is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4502(Before this version, it was equivalent to <a href="#contrast-stretch"
4503>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004504
cristyd934d102009-10-10 12:55:13 +00004505<p>All the channels are normalized in concert by the came amount so as to
4506preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004507setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004508setting will normalize the RGB channels independently.</p>
4509
cristydcca3fa2010-12-29 21:50:07 +00004510<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004511Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004512that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004513
4514<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004515
4516
4517<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004518 <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 +00004519</div>
4520
cristyd934d102009-10-10 12:55:13 +00004521<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
4522class="arg">threshold map</em> specified, and a uniform color map with the
4523given 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 +00004524
4525<p>You can choose from these standard threshold maps:</p>
4526
4527<pre class="text">
cristya6d7cf72010-11-07 15:58:34 +00004528threshold 1x1 Threshold 1x1 (non-dither)
4529checks 2x1 Checkerboard 2x1 (dither)
4530o2x2 2x2 Ordered 2x2 (dispersed)
4531o3x3 3x3 Ordered 3x3 (dispersed)
4532o4x4 4x4 Ordered 4x4 (dispersed)
4533o8x8 8x8 Ordered 8x8 (dispersed)
4534h4x4a 4x1 Halftone 4x4 (angled)
4535h6x6a 6x1 Halftone 6x6 (angled)
4536h8x8a 8x1 Halftone 8x8 (angled)
4537h4x4o Halftone 4x4 (orthogonal)
4538h6x6o Halftone 6x6 (orthogonal)
4539h8x8o Halftone 8x8 (orthogonal)
4540h16x16o Halftone 16x16 (orthogonal)
4541c5x5b c5x5 Circles 5x5 (black)
4542c5x5w Circles 5x5 (white)
4543c6x6b c6x6 Circles 6x6 (black)
4544c6x6w Circles 6x6 (white)
4545c7x7b c7x7 Circles 7x7 (black)
4546c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004547</pre>
4548
cristyde368992010-11-05 14:32:14 +00004549<p> The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
cristyd934d102009-10-10 12:55:13 +00004550pattern. Or you can define your own <em class="arg" >threshold map</em> in a
cristyde368992010-11-05 14:32:14 +00004551personal or system <kbd>thresholds.xml</kbd> XML file. </p>
cristy3ed852e2009-09-05 21:47:34 +00004552
cristyd934d102009-10-10 12:55:13 +00004553<p>To print a complete list of threshold, use the <a href="#list" >-list
4554threshold</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004555
cristyd934d102009-10-10 12:55:13 +00004556<p>It is recommended that the <a href="#map" >+map</a> operator be used after
4557applying <a href="#ordered-dither" >-ordered-dither</a> to reduce the number of
cristy3ed852e2009-09-05 21:47:34 +00004558colors an animated image sequence, to less that 256 colors. This ensures that
4559a common or global color table is used when saving the result to a color
4560limited file format such as GIF. </p>
4561
cristyd934d102009-10-10 12:55:13 +00004562<p>Note that at this time the exact same threshold dithering map is used for
4563all color channels, no attempt is made to offset or rotate the map for
4564different channels is made, to create an offset printing effect. (possible
4565future expansion) </p>
cristy3ed852e2009-09-05 21:47:34 +00004566
4567
4568<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004569 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004570</div>
4571
4572<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>
4573
cristyc54f5d42009-11-27 21:36:31 +00004574<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004575described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4576>-fuzz</a> setting can be used to match and replace colors similar to the one
4577given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004578
cristyb36feb22010-03-26 16:54:37 +00004579<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4580the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004581
cristyb36feb22010-03-26 16:54:37 +00004582<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4583as <a href="#opaque" >-opaque</a> but replaces the matching color with
4584transparency rather than the current <a href="#fill">-fill</a> color setting.
4585To ensure that it can do this it also ensures that the image has an alpha
4586channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4587the new transparent colors, and does not require you to modify the <a
4588href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004589
cristy3ed852e2009-09-05 21:47:34 +00004590
4591<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004592 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004593</div>
4594
4595<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>
4596
4597<p>Choose from these orientations:</p>
4598
4599<pre class="text">
4600 bottom-left
4601 bottom-right
4602 left-bottom
4603 left-top
4604 right-bottom
4605 right-top
4606 top-left
4607 top-right
4608 undefined
4609</pre>
4610
cristyd934d102009-10-10 12:55:13 +00004611<p>To print a complete list of orientations, use the <a href="#list" >-list
4612orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004613
4614
4615<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004616 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004617 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4618 +page
4619 </h4>
4620</div>
4621
4622<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>
4623
4624<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>
4625
4626<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>
4627
4628<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>
4629<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4630<thead>
4631 <tr valign="top">
4632 <th align="center"><em class="arg">media</em></th>
4633 <th align="center"><em class="arg">width</em></th>
4634 <th align="center"><em class="arg">height</em></th>
4635 </tr>
4636</thead>
4637<tbody>
4638<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4639<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4640<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4641<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4642<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4643<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4644<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4645<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4646<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4647<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4648<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4649<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4650<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4651<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4652<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4653<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4654<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4655<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4656<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4657<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4658<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4659<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4660<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4661<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4662<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4663<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4664<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4665<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4666<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4667<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4668<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4669<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4670<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4671<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4672<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4673<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4674<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4675<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4676</tbody>
4677</table>
4678
4679
4680
4681
4682<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>
4683
4684<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>
4685
4686<p>The default page dimensions for a TEXT image is 612x792.</p>
4687
4688<p>This option is used in concert with <a href="#density">-density</a>.</p>
4689
4690<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4691
4692<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004693 <h4><a id="paint"></a>-paint <em class="arg">radius</em></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%'>simulate an oil painting.</td><td style='text-align:right;'></td></tr></table>
4697
4698<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>
4699
4700<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004701 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004702
4703<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>
4704
4705<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004706 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004707</div>
4708
4709<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>
4710
4711<p>Pause for the specified number of seconds before repeating the animation.</p>
4712
4713<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004714 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004715</div>
4716
4717<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>
4718
4719<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4720
4721<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004722 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004723</div>
4724
4725<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>
4726
4727<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004728 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004729</div>
4730
4731<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>
4732
4733<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004734 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004735</div>
4736
4737<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>
4738
4739<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4740
4741<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004742 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004743</div>
4744
4745<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>
4746
4747<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004748 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004749</div>
4750
4751<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>
4752
4753<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004754 <h4><a id="preview"></a>-preview <em class="arg">type</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%'>image preview type.</td><td style='text-align:right;'></td></tr></table>
4758
4759<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>
4760
4761<pre class="text">
4762 Rotate
4763 Shear
4764 Roll
4765 Hue
4766 Saturation
4767 Brightness
4768 Gamma
4769 Spiff
4770 Dull
4771 Grayscale
4772 Quantize
4773 Despeckle
4774 ReduceNoise
4775 Add Noise
4776 Sharpen
4777 Blur
4778 Threshold
4779 EdgeDetect
4780 Spread
4781 Shade
4782 Raise
4783 Segment
4784 Solarize
4785 Swirl
4786 Implode
4787 Wave
4788 OilPaint
4789 CharcoalDrawing
4790 JPEG
4791</pre>
4792
4793<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4794
4795<p>The default preview is <kbd>JPEG</kbd>.</p>
4796
4797<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004798 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004799</div>
4800
4801<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>interpret string and print to console.</td><td style='text-align:right;'></td></tr></table>
4802
4803<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004804 <h4><a id="process"></a>-process <em class="arg">command</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004805</div>
4806
4807<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>process the image with a custom image filter.</td><td style='text-align:right;'></td></tr></table>
4808
4809<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>
4810
4811<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004812 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004813 +profile <em class="arg">profile_name</em></h4>
4814</div>
4815
4816<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>
4817
4818<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>
4819
4820<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>
4821
4822<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>
4823
4824<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>
4825
4826<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4827
4828<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4829<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>
4830
4831<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>
4832<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4833CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4834</p>
4835
cristyf7964272011-01-30 03:49:12 +00004836<p>The <a href="#profile">-profile</a> option can also be used to inject
4837previously-formatted ancillary chunks into the output PNG file, using
4838the commandline option as shown below or by setting the profile via a
cristy2bd2a982011-02-15 00:52:58 +00004839programming interface:</p>
cristyf7964272011-01-30 03:49:12 +00004840
cristy2bd2a982011-02-15 00:52:58 +00004841<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>-profile PNG-chunk-x:&lt;filename&gt;</span></p>
4842<p>where <em>x</em> is a location flag and
cristyf7964272011-01-30 03:49:12 +00004843<em class="arg">filename</em> is a file containing the chunk
4844name in the first 4 bytes, then a colon (":"), followed by the chunk data.
4845This encoder will compute the chunk length and CRC, so those must not
cristy2bd2a982011-02-15 00:52:58 +00004846be included in the file.</p>
cristyf7964272011-01-30 03:49:12 +00004847
cristy2bd2a982011-02-15 00:52:58 +00004848<p>"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
cristyf7964272011-01-30 03:49:12 +00004849or "e" (end, i.e., after IDAT). If you want to write multiple chunks
4850of the same type, then add a short unique string after the "x" to prevent
cristy2bd2a982011-02-15 00:52:58 +00004851subsequent profiles from overwriting the preceding ones, e.g.,</p>
cristyf7964272011-01-30 03:49:12 +00004852
4853
4854<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 +00004855<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004856 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004857</div>
4858
4859<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>JPEG/MIFF/PNG compression level.</td><td style='text-align:right;'></td></tr></table>
4860
cristy851dbce2010-08-06 21:40:00 +00004861<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 +00004862
4863<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>
4864
cristy851dbce2010-08-06 21:40:00 +00004865<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 +00004866
cristy3c98a4f2010-08-13 20:09:41 +00004867<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 +00004868
4869<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4870
4871<pre class="text">
4872 0: none
4873 1: sub
4874 2: up
4875 3: average
4876 4: Paeth
4877</pre>
4878
4879<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>
4880
4881<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4882
4883<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>
4884
cristy3c98a4f2010-08-13 20:09:41 +00004885<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 +00004886
4887<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4888
cristy3ed852e2009-09-05 21:47:34 +00004889<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004890 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004891</div>
4892
cristy3c98a4f2010-08-13 20:09:41 +00004893<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 +00004894
cristy3c98a4f2010-08-13 20:09:41 +00004895<p>This setting defines the colorspace used to sort out and reduce the number
4896of colors needed by an image (for later dithering) by operators such as <a
4897href="#colors" >-colors</a>, Note that color reducion also happens
4898automatically when saving images to color-limited image file formats, such as
4899GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004900
4901
4902<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004903 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004904</div>
4905
4906<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>
4907
4908<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004909 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004910</div>
4911
4912<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>
4913
4914<p>Note that this is actually a rotational blur rather than a radial and as
4915such actually mis-named. </p>
4916
4917<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4918pixels which are outside the image proper are blurred into the final result.
4919</p>
4920
4921
4922<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004923 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004924</div>
4925
4926<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Lighten or darken image edges.</td><td style='text-align:right;'></td></tr></table>
4927
4928<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>.
4929</p>
4930
4931<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4932
4933<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004934 <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 +00004935</div>
4936
4937<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>
4938
4939<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004940 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004941</div>
4942
4943<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>
4944
4945<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004946 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00004947</div>
4948
4949<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>
4950
4951<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004952 <h4><a id="remap"></a>-remap <em class="arg">filename</em></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%'>Reduce the number of colors in an image to the colors used by this image.</td><td style='text-align:right;'></td></tr></table>
4956
4957<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4958the given colors are dithered over the image as necessary, otherwise the closest
4959color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4960
4961<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4962images in the current image sequence, all the images will have the same color
4963table. That means that when saved to a file format such as GIF, it will use
4964that color table as a single common or global color table, for all the images,
4965without requiring extra local color tables. </p>
4966
4967<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4968sequence to use a common color map over all the images. This equivalent to
4969appending all the images together (without extra background colors) and color
4970reducing those images using <a href="#colors">-colors</a> with a 256 color
4971limit, then <a href="#remap">-remap</a> those colors over the original list of
4972images. This ensures all the images follow a single color map. </p>
4973
4974<p>If the number of colors over all the images is less than 256, then <a
4975href="#remap">+remap</a> should not perform any color reduction or dithering, as
4976no color changes are needed. In that case, its only effect is to force the use
4977of a global color table. This recommended after using either <a
4978href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
4979reduce the number of colors in an animated image sequence. </p>
4980
4981<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004982 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004983</div>
4984
4985<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>
4986
4987<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>
4988
4989<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>
4990
4991<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004992 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00004993</div>
4994
4995<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>
4996
4997<p>The only command recognized is the name of an image file to load.</p>
4998
4999<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>
5000
5001<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005002 <h4><a id="render"></a>-render</h4>
cristy3ed852e2009-09-05 21:47:34 +00005003</div>
5004
5005<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>render vector operations.</td><td style='text-align:right;'></td></tr></table>
5006
5007<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>
5008
5009<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005010<h4><a id="repage"></a>-repage <em class="arg">geometry</em></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%'>Adjust the canvas and offset information of the image.</td><td style='text-align:right;'></td></tr></table>
5014
5015<p>This option is like <a href="#page">-page</a> but acts as an image operator
5016rather than a setting. You can separately set the canvas size or the offset
5017of the image on that canvas by only providing those components. </p>
5018
5019<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>
5020
5021<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
5022offset to move the image relative to its previous position. This useful for
5023animation sequences. </p>
5024
5025<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
5026recalculate the canvas size so the image (at its current offset) will appear
5027completely on that canvas (unless it has a negative offset).</p>
5028
5029<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
5030canvas meta-data from the images. </p>
5031
5032<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
5033directly assign virtual canvas meta-data. </p>
5034
5035
5036<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005037 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005038</div>
5039
5040<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Resample image to specified horizontal and vertical resolution.</td><td style='text-align:right;'></td></tr></table>
5041
5042<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>
5043
5044<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>
5045
5046<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005047 <h4><a id="resize"></a>-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005048</div>
5049
5050<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Resize an image.</td><td style='text-align:right;'></td></tr></table>
5051
5052<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>
5053
5054<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>
5055
cristy13538962010-02-26 17:53:04 +00005056<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>
5057
cristy4949d522010-03-12 18:41:34 +00005058<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 +00005059<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005060 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00005061</div>
5062
5063<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>
5064
5065<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005066 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005067</div>
5068
5069<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>
5070
5071
5072<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005073 <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 +00005074</div>
5075
5076<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>
5077
5078<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>
5079
5080
5081<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005082 <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 +00005083</div>
5084
5085<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>
5086
5087<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>
5088
5089<p>Empty triangles in the corners, left over from rotating the image, are
5090filled with the <kbd>background</kbd> color. </p>
5091
5092<p>See also the <a href="#distort">-distort</a> operator and specifically the
5093'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5094
5095
5096<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005097 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005098</div>
5099
cristyd0bd44a2010-09-24 12:38:11 +00005100<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 +00005101
cristyd0bd44a2010-09-24 12:38:11 +00005102<p>Change the image size simply by directly sampling the pixels original
5103image. When magnifying, pixels are replicated in blocks. When minifying,
5104pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005105
cristyd0bd44a2010-09-24 12:38:11 +00005106<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5107a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5108neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5109avoids all the filter processing of the image. As such it completely ignores
5110the current <a href="#filter">-filter</a> setting. </p>
5111
5112<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5113will be added to the resulting image, though some colors may disappear. </p>
5114
5115<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
5116ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005117
5118
5119<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005120 <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 +00005121</div>
5122
5123<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>
5124
5125<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>
5126
5127<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005128 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005129</div>
5130
cristyd0bd44a2010-09-24 12:38:11 +00005131<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 +00005132
cristyd0bd44a2010-09-24 12:38:11 +00005133<p>Change the image size simply by replacing pixels by averaging pixels
5134together when minifying, or replacing pixels when magnifing. </p>
5135
5136<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5137a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5138faster, as it avoids all the filter processing of the image. As such it
5139completely ignores the current <a href="#filter">-filter</a> setting. </p>
5140
5141<p>If when shrinking (minifying) images the original image is some integer
5142multiple of the new image size, the number of pixels avergaed together to
5143produce the new pixel color is the same across the whole image. This is
5144a special case known as 'binning' and is often used as a method of reducing
5145noise in image such as those generated by digital cameras, especially in low
5146light conditions. </p>
5147
cristy3ed852e2009-09-05 21:47:34 +00005148
5149<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005150 <h4><a id="scene"></a>-scene <em class="arg">value</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%'>set scene number.</td><td style='text-align:right;'></td></tr></table>
5154
5155<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5156
5157<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005158 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005159</div>
5160
5161<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>
5162
5163<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>
5164
5165<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005166 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005167</div>
5168
5169<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>
5170
5171<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005172 <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 +00005173</div>
5174
5175<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>
5176
5177<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>
5178
5179<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>
5180
5181<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5182of the color clusters is returned.</p>
5183
5184
5185<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005186 <h4><a id="selective-blur"></a>-selective-blur <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005187</div>
5188
cristy2e2662a2010-10-09 14:29:37 +00005189<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005190 <h4>-selective-blur <em class="arg">radius</em><br />-unsharp <em class="arg">radius</em>x<em class="arg">sigma</em>{<em class="arg">+threshold</em>}</h4>
cristy2e2662a2010-10-09 14:29:37 +00005191</div>
5192
cristy3ed852e2009-09-05 21:47:34 +00005193<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>
5194
cristy2e2662a2010-10-09 14:29:37 +00005195<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>
5196
cristy3ed852e2009-09-05 21:47:34 +00005197<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005198 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005199</div>
5200
5201<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
5202
5203<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005204 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005205</div>
5206
5207<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate a sepia-toned photo.</td><td style='text-align:right;'></td></tr></table>
5208
5209<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5210
5211<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>
5212
cristyd0bda5e2010-09-21 16:22:45 +00005213
5214
cristy3ed852e2009-09-05 21:47:34 +00005215<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005216 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5217 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005218</div>
5219
cristyd0bd44a2010-09-24 12:38:11 +00005220<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 +00005221image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005222
cristyd0bd44a2010-09-24 12:38:11 +00005223<p>This will assign (or modify) specific settings attached to all the images
5224in the current image sequence. Using the <a href="#set">+set</a> form of the
5225option will either remove, or reset that setting to a default state, as
5226appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005227
cristyd0bd44a2010-09-24 12:38:11 +00005228<p>For example, it will modify specific well known image meta-data
5229'attributes' such as those normally overridden by: the options <a
5230href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5231href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5232assigned before the image is read in, by using a <em class="arg">key</em> of
5233the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005234
cristyd0bd44a2010-09-24 12:38:11 +00005235<p>If the given <em class="arg">key</em> does not match a specific known
5236'attribute ', such as shown above, the setting is stored as a a free form
cristyd0bda5e2010-09-21 16:22:45 +00005237'properity' string. Such settings are listed in <a href="#verbose"
5238>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5239</p>
5240
cristyd0bd44a2010-09-24 12:38:11 +00005241<p>This includes string 'properities' that are set by and assigned to images
5242using the options <a href="#comment" >-comment</a>, <a href="#label"
5243>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5244a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5245Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005246
cristyd0bd44a2010-09-24 12:38:11 +00005247<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>
5248<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5249Properties</a> in the defined value. For example:</p>
5250
5251<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>
5252<p>Other well known 'properities' that can be include:
5253'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5254'<kbd>signature</kbd>'. </p>
5255
5256<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5257the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5258see <a href="#repage">-page</a>). However it is designed to provide a finer
5259control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5260option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5261attribute. </p>
5262
5263<p>This option can also associate a colorspace or profile with your image.
5264For example,</p>
5265
5266<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 +00005267<p>Some 'properties' must be defined in a specific way to be used. For
5268example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5269modify the output filename of an image. For example</p>
5270
5271<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>
5272<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5273be saved as a global "Artifact" exactly as if it was set using the <a
cristyd0bd44a2010-09-24 12:38:11 +00005274href="#define" >-define</a> option. As such settings are globel in scope, they
5275can be used to pass 'attributes' and 'properities' of one specific image,
5276in a way that allows you to use them in a completely different image, even if
5277the original image has long since been modified or destroyed. For example: </p>
5278
5279<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>
5280<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5281a 'artifact' if the given <em class="arg">key</em> does not match an existing
5282'attribute' or 'properity'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005283
5284<p>You can set the attributes of the image registry by prefixing the value
5285with <kbd>registry:</kbd>.</p>
5286
5287
cristy3ed852e2009-09-05 21:47:34 +00005288
5289<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005290 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005291</div>
5292
5293<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>
5294
5295<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>
5296
5297<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005298 <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 +00005299</div>
5300
5301<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>
5302
5303<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005304 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005305id="shared-memory"></a>-shared-memory</h4>
5306</div>
5307
5308<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>
5309
5310<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>
5311
5312<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005313 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005314</div>
5315
5316<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>
5317
5318<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5319
5320<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005321 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005322</div>
5323
5324<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>
5325
5326<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>
5327
5328<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>
5329
5330<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005331 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005332</div>
5333
5334<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>
5335
5336<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>
5337
5338<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>
5339
5340<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>
5341
5342<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>
5343
5344<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>
5345<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>
5346
5347<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5348<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005349 <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 +00005350</div>
5351
5352<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>
5353
5354<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>
5355
5356<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005357 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005358</div>
5359
5360<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>
5361
5362<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005363 <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 +00005364</div>
5365
5366<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>
5367
5368<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>
5369
5370<p>For Photo CD images, choose from these sizes:</p>
5371
5372<pre class="text">
5373 192x128
5374 384x256
5375 768x512
5376 1536x1024
5377 3072x2048
5378</pre>
5379
cristy3ed852e2009-09-05 21:47:34 +00005380<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005381 <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 +00005382</div>
5383
5384<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>
5385
5386<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>
5387
5388<div style="margin: auto;">
cristy2d67ddd2011-02-13 15:38:23 +00005389 <h4><a id="smush"></a>-smush <em class="arg">offset</em></h4>
5390</div>
5391
5392<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>
5393
5394<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005395 <h4><a id="snaps"></a>-snaps <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005396</div>
5397
5398<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>
5399
5400<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5401
5402<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005403 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005404</div>
5405
5406<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>negate all pixels above the threshold level.</td><td style='text-align:right;'></td></tr></table>
5407
5408<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5409
5410<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5411
5412<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005413 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005414 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5415</div>
5416
5417<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>
5418
5419
5420<table class="doc">
5421 <tbody>
5422 <tr valign="top">
5423 <th align="left" style="width: 8%">Method</th>
5424 <th align="left">Description</th>
5425 </tr>
5426
5427 <tr valign="top">
5428 <td valign="top">voronoi</td>
5429 <td valign="top">Simply map each pixel to the to nearest color point
5430 given. The result are polygonal 'cells' of solid color. </td>
5431 </tr>
5432
5433 <tr valign="top">
5434 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005435 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005436 squared. Generating spots of color in a sea of the average of
5437 colors. </td>
5438 </tr>
5439
5440 <tr valign="top">
5441 <td valign="top">barycentric</td>
5442 <td valign="top">three point triangle of color given 3 points.
5443 Giving only 2 points will form a linear gradient between those points.
5444 Gradient is however not restricted to just the triangle or line. </td>
5445 </tr>
5446
5447 <tr valign="top">
5448 <td valign="top">bilinear</td>
5449 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5450 fall back to barycentric. </td>
5451 </tr>
5452
5453 </tbody>
5454</table>
5455
5456<p>The points are placed according to the images location on the virtual
5457canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5458offset), and do not actually have to exist on the given image, but may be
5459some point beyond the edge of the image. All points are floating point values.
5460</p>
5461
5462<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
5463modified, whcih means the matte/alpha transparency channel is not effected by
5464default. If enabled, the image also needs a the matte/alpha channel to be
5465enabled for this operator to effect an images transparency. This is typical
5466transparency handling for images. </p>
5467
5468<p>All the above methods when given a single point of color will replace all
5469the colors in the image with the color given, regardless of the point. This is
5470logical, and provides an alternative technique to recolor a image to some
5471default value. </p>
5472
5473
5474<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005475 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005476</div>
5477
5478<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Splice the current background color into the image.</td><td style='text-align:right;'></td></tr></table>
5479
5480<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>
5481
5482<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005483 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005484</div>
5485
5486<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>
5487
5488<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>
5489
5490<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005491 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005492</div>
5493
5494<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>
5495
5496<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>
5497
5498<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005499 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005500</div>
5501
5502<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>
5503
5504<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>
5505
5506<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005507 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005508</div>
5509
5510<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>
5511
5512<pre class="text">
5513 char store pixels as unsigned characters
5514 double store pixels as doubles
5515 float store pixels as floats
5516 integer store pixels as integers
5517 long store pixels as longs
5518 quantum store pixels in the native depth of your ImageMagick distribution
5519 short store pixels as unsigned shorts
5520</pre>
5521
5522<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5523values range from 0 to the maximum value the storage type can support.</p>
5524
5525<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005526 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005527</div>
5528
5529<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>
5530
5531<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>
5532
5533<pre class="text">
5534 Any
5535 Condensed
5536 Expanded
5537 ExtraCondensed
5538 ExtraExpanded
5539 Normal
5540 SemiCondensed
5541 SemiExpanded
5542 UltraCondensed
5543 UltraExpanded
5544</pre>
5545
5546<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5547
5548<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>
5549
5550<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005551 <h4><a id="strip"></a>-strip</h4>
cristy3ed852e2009-09-05 21:47:34 +00005552</div>
5553
5554<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>
5555
5556<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005557 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005558</div>
5559
5560<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>
5561
5562<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5563
5564<p>See <a href="#draw">-draw</a> for further details.</p>
5565
5566<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005567 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005568</div>
5569
5570<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>
5571
5572<p>See <a href="#draw">-draw</a> for further details.</p>
5573
5574<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005575 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005576</div>
5577
5578<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>
5579
cristy71a3f602010-09-15 12:38:16 +00005580<p>This setting suggests a font style that ImageMagick should try to apply to
5581the currently selected font family. Select <em class="arg">fontStyle</em> from
5582the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005583
5584<pre class="text">
5585 Any
5586 Italic
5587 Normal
5588 Oblique
5589</pre>
5590
5591<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>
5592
5593<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005594 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005595</div>
5596
cristyd4d64ed2010-08-22 22:19:33 +00005597<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>
5598
cristy71a3f602010-09-15 12:38:16 +00005599<p>This option is required to have compare search for the best match location
5600of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005601(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005602be the "match score" image.</p>
5603
cristyd0bd44a2010-09-24 12:38:11 +00005604<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005605position of the top-left corner of the given sub-image. that is its size will
5606be the size of the larger_image - sub_image + 1. The brightest location in
5607this image is the location s the locate on the best match that is also
5608reported. Note that this may or may nor be a perfect match, and the actual
5609brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005610possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005611
cristyd0bda5e2010-09-21 16:22:45 +00005612<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005613location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005614sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005615
cristyae6203d2010-08-09 01:12:14 +00005616
5617<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005618 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005619</div>
5620
5621<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>
5622
cristy71a3f602010-09-15 12:38:16 +00005623<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5624images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5625the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005626
5627<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005628 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005629</div>
5630
5631<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>
5632
5633<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5634
5635<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005636 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005637</div>
5638
5639<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>
5640
5641<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005642 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005643</div>
5644
cristy5063d812010-10-19 16:28:10 +00005645<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 +00005646
5647<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005648 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005649</div>
5650
5651<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>
5652
5653<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>
5654
5655<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>
5656
5657<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005658 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005659</div>
5660
5661<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>
5662
5663<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005664 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005665</div>
5666
5667<!-- {<em class="arg">green,blue,opacity</em>}
5668<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>
5669-->
5670
5671<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>
5672
5673<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>
5674
5675<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.
5676</p>
5677
5678<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>
5679
5680<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5681<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>
5682
5683
5684<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>
5685<p>Note that the values of the transparency channel is treated as 'matte'
5686values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5687
5688<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>.
5689</p>
5690
5691<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005692 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005693</div>
5694
5695<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Create a thumbnail of the image.</td><td style='text-align:right;'></td></tr></table>
5696
5697<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>
5698
5699<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>
5700
5701<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005702 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005703</div>
5704
5705<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>
5706
5707<div style="margin: auto;">
5708 <h4>-tile <em class="arg">geometry</em></h4>
5709</div>
5710
5711<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>
5712
5713<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>
5714
5715<div style="margin: auto;">
5716 <h4>-tile</h4>
5717</div>
5718
5719<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>
5720
5721<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005722 <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 +00005723</div>
5724
5725<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>
5726
5727<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>
5728
5729<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>
5730
5731<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005732 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005733</div>
5734
5735<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Tint the image with the fill color.</td><td style='text-align:right;'></td></tr></table>
5736
5737<p>Tint the image with the fill color.</p>
5738
5739<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>
5740
5741<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005742 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005743</div>
5744
5745<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
5746
5747<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>
5748
5749<p>For example,</p>
5750
5751<p class="crtsnip">
5752 -title "%m:%f %wx%h"
5753</p>
5754
5755<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>
5756
5757
5758<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005759 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005760</div>
5761
5762<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>
5763
5764<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5765
5766<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 +00005767
5768<p>This operator has been now been superseded by the <a
5769href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5770
5771
cristy3ed852e2009-09-05 21:47:34 +00005772<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005773 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005774</div>
5775
5776<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Make this color transparent within the image.</td><td style='text-align:right;'></td></tr></table>
5777
5778<p>The <em class="arg">color</em> argument is defined using the format
5779described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5780>-fuzz</a> setting can be used to match and replace colors similar to the one
5781given. </p>
5782
cristyb36feb22010-03-26 16:54:37 +00005783<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5784that is make all non-matching colors transparent. </p>
5785
cristy3ed852e2009-09-05 21:47:34 +00005786<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005787href="#transparent" >-transparent</a> but replaces the matching color with the
5788current <a href="#fill">-fill</a> color setting, rather than transparent.
5789However the <a href="#transparent" >-transparent</a> operator also ensures
5790that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5791>-alpha</a> set</kbd>", and does not require you to modify the <a
5792href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005793
cristyb36feb22010-03-26 16:54:37 +00005794<p>Note that this does not define the color as being the 'transparency color'
5795used for color-mapped image formats, such as GIF. For that use <a
5796href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005797
5798
5799<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005800 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005801</div>
5802
5803<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>
5804
5805<p>Sometimes this is used for saving to image formats such as
5806GIF and PNG8 which uses this color to represent boolean transparency. This
5807does not make a color transparent, it only defines what color the transparent
5808color is in the color palette of the saved image. Use <a
5809href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5810
5811<p>This option allows you to have both an opaque visible color, as well as a
5812transparent color of the same color value without conflict. That is, you can
5813use the same color for both the transparent and opaque color areas within an
5814image. This, in turn, frees to you to select a transparent color that is
5815appropriate when an image is displayed by an application that does not handle a
5816transparent color index, while allowing ImageMagick to correctly handle images of this
5817type. </p>
5818
5819<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5820
5821<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005822 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005823</div>
5824
5825<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>
5826
5827<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5828</p>
5829
5830<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005831 <h4><a id="transverse"></a>-transverse</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%'>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>
5835
5836
5837<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005838 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005839</div>
5840
5841<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>tree depth for the color reduction algorithm.</td><td style='text-align:right;'></td></tr></table>
5842
5843<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>
5844
5845<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>
5846
5847<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>
5848
5849<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005850 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00005851</div>
5852
5853<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>
5854
5855<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>
5856
5857<p>The page or virtual canvas information of the image is preserved allowing
5858you to extract the result of the <a href="#trim">-trim</a> operation from the
5859image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5860information if it is unwanted.</p>
5861
5862<p>If the trimmed image 'disappears' an warning is produced, and a special
5863single pixel transparent 'missed' image is returned, in the same way as when a
5864<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5865
5866
5867<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005868 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005869</div>
5870
5871<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 +00005872 <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 +00005873
5874<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>
5875
5876<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5877<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>
5878
5879<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5880
5881<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005882 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005883</div>
5884
5885<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>
5886
5887<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5888
5889<p>See <a href="#draw">-draw</a> for further details.</p>
5890
5891
5892<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005893 <h4><a id="update"></a>-update <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005894</div>
5895
5896<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>
5897
5898<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>
5899
5900
5901<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005902 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00005903</div>
5904
5905<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>
5906
5907
5908<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005909 <h4><a id="units"></a>-units <em class="arg">type</em></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%'>the units of image resolution.</td><td style='text-align:right;'></td></tr></table>
5913
5914<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>
5915
5916
5917<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005918 <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 +00005919</div>
5920
5921<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>
5922
5923<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>
5924
5925<p>The parameters are:</p>
5926
5927<pre class="text">
5928 radius: The radius of the Gaussian, in pixels, not counting the center
5929 pixel (default 0).
5930 sigma: The standard deviation of the Gaussian, in pixels (default 1.0).
5931 amount: The fraction of the difference between the original and the blur
5932 image that is added back into the original (default 1.0).
5933 threshold: The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5934 difference amount (default 0.05).
5935</pre>
5936
5937
5938<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005939 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005940</div>
5941
cristyd0bda5e2010-09-21 16:22:45 +00005942<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 +00005943
5944
5945<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005946 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00005947</div>
5948
5949<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>
5950
5951
5952<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005953 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005954</div>
5955
5956<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>
5957
5958
5959<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005960 <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 +00005961</div>
5962
5963<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>
5964
5965
5966<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005967 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005968</div>
5969
5970<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>
5971
5972<p>This option defines what color source should be used if and when a color
5973lookup completely 'misses' the source image. The color(s) that appear to
5974surround the source image. Generally this color is derived from the source
5975image, but could also be set to a specify background color. </p>
5976
5977<p>Choose from these methods:</p>
5978
5979<pre class="text">
5980 background: the area surrounding the image is the background color
5981 black: the area surrounding the image is black
5982 checker-tile: alternate squares with image and background color
5983 dither: non-random 32x32 dithered pattern
5984 edge: extend the edge pixel toward infinity
5985 gray: the area surrounding the image is gray
5986 horizontal-tile: horizontally tile the image, background color above/below
5987 horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
5988 mirror: mirror tile the image
5989 random: choose a random pixel from the image
5990 tile: tile the image (default)
5991 transparent: the area surrounding the image is transparent blackness
5992 vertical-tile: vertically tile the image, sides are background color
5993 vertical-tile-edge: vertically tile the image and replicate the side edge pixels
5994 white: the area surrounding the image is white
5995</pre>
5996
5997<p>The default value is "edge".</p>
5998
5999<p>This most important for distortion operators such as <a href="#distort"
6000>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
6001However it also effects operations that may access pixels just outside the
6002image proper, such as <a href="#convolve">-convolve</a>, <a
6003href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
6004
6005<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
6006
6007
6008<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006009 <h4><a id="visual"></a>-visual <em class="arg">type</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%'>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>
6013
6014<p>Choose from these visual classes:</p>
6015
6016<pre class="text">
6017 StaticGray
6018 GrayScale
6019 StaticColor
6020 PseudoColor
6021 TrueColor
6022 DirectColor
6023 default
6024 visual id
6025</pre>
6026
6027<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>
6028
6029
6030<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006031 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00006032 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
6033</div>
6034
6035<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
6036saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
6037
6038<p>Take a grayscale image (with alpha mask) and modify the destination image's
6039brightness according to watermark image's grayscale value and the <em
6040class="arg">brightness</em> percentage. The destinations color saturation
6041attribute is just direct modified by the <em class="arg">saturation</em>
6042percentage, which defaults to 100 percent (no color change). </p>
6043
6044
6045<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006046 <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 +00006047</div>
6048
6049<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>
6050
6051<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
6052
6053<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006054 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006055</div>
6056
6057<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>
6058
6059<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>
6060
6061<table class="doc">
6062 <col width="25%" />
6063 <col width="75%" />
6064 <thead>
6065 <tr>
6066 <th><em class="arg">fontWeight</em></th>
6067 <th>Description</th>
6068 </tr>
6069 </thead>
6070 <tbody>
6071 <tr><td>All </td> <td>No effect. </td></tr>
6072 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
6073 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
6074 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
6075 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
6076 </tbody>
6077 </table>
6078
6079<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
6080
6081<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>
6082
6083<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006084 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006085</div>
6086
6087<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>
6088
6089<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006090 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006091</div>
6092
cristy5cadd612009-09-21 19:33:41 +00006093<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>
6094
6095<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.
6096</p>
cristy3ed852e2009-09-05 21:47:34 +00006097
6098<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006099 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006100</div>
6101
6102<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>
6103
6104<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>
6105
6106<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>
6107
6108<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>
6109
6110<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006111 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006112</div>
6113
6114<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>
6115
6116<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006117 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006118</div>
6119
6120<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>
6121 <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>
6122
6123<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006124</div>
6125</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006126
6127</div>
6128
6129<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006130 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006131 <span id="linkbar-center">
6132 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006133 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006134 </span>
6135 <span id="linkbar-east">&nbsp;</span>
6136 </div>
6137 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +00006138 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006139 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6140 </div>
6141 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006142 <script type="text/javascript">
6143 var _gaq = _gaq || [];
6144 _gaq.push(['_setAccount', 'UA-17690367-1']);
6145 _gaq.push(['_trackPageview']);
6146
6147 (function() {
6148 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6149 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6150 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6151 })();
6152 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006153</body>
6154</html>