blob: 6aef369226a0236569795c90e1a115505b8119e5 [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">
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00008<head>
cristy3c98a4f2010-08-13 20:09:41 +00009 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristydcca3fa2010-12-29 21:50:07 +000011 <title>ImageMagick: Command-line Options</title>
cristy3ed852e2009-09-05 21:47:34 +000012 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000015 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +000016 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000017 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000018 <meta name="Generator" content="PHP"/>
19 <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 +000020 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy7e41fe82010-12-04 23:12:08 +000026 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000027 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000028 <link rel="icon" href="../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000029 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +000031 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000032 <style type="text/css" media="all">
33 @import url("../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +000035 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000036 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000048</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
52<a href="../index.html">
53 <img src="../images/script.png" alt="[ImageMagick]"
54 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
55<a href="http://www.networkredux.com">
56 <img src="../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000057 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000058<a href="http://www.imagemagick.org/discourse-server/">
59 <img src="../images/logo.jpg" alt=""
cristy178edaf2011-01-23 03:42:39 +000060 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000061<a href="../index.html">
62 <img src="../images/sprite.jpg" alt=""
63 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
64</div>
65
cristyce69bb02010-07-27 19:49:46 +000066<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000067
cristy3ed852e2009-09-05 21:47:34 +000068<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000069 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000070</div>
cristy3eaa0ef2010-03-06 20:35:26 +000071<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000072<div class="menu">
cristybb503372010-05-27 20:51:26 +000073 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
74</div>
75<div class="sub">
76 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
77</div>
78<div class="sub">
79 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
80</div>
81<div class="sub">
82 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
83</div>
84<div class="sep"></div>
85<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000092 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000093</div>
94<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000095 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000096</div>
97<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000098 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000099</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000101 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000102</div>
103<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000104 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000105</div>
106<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000107 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000108</div>
109<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000110 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000111</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000112<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000113<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000114 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000115</div>
116<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000117 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000118</div>
119<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000120 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000121 </div>
122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000124</div>
cristybb503372010-05-27 20:51:26 +0000125<div class="menu">
126 <a title="Architecture" href="../www/architecture.html">Architecture</a>
127</div>
cristy3ed852e2009-09-05 21:47:34 +0000128<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000129 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000132<div class="menu">
cristy52923442011-01-15 22:54:31 +0000133 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000134</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000135<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000136<div class="menu">
cristydcca3fa2010-12-29 21:50:07 +0000137 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000138</div>
139<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000140 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000141</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000142<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000143<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000144 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000145
146<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000147<div class="sponsor">
148 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
149</div>
cristyec6b4752011-01-08 03:16:23 +0000150<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000151 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000152</div>
153<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000154 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
155</div>
156<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000157 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
158</div>
cristyec6b4752011-01-08 03:16:23 +0000159<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000160 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
161</div>
162<div class="sponsor">
cristyf7964272011-01-30 03:49:12 +0000163 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristyec6b4752011-01-08 03:16:23 +0000164</div>
cristy3ed852e2009-09-05 21:47:34 +0000165</div>
166</div>
cristyce69bb02010-07-27 19:49:46 +0000167</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000168
cristyce69bb02010-07-27 19:49:46 +0000169<div class="eastbar">
170 <script type="text/javascript">
171 <!--
172 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000173 google_ad_slot = "0574824969";
174 google_ad_width = 160;
175 google_ad_height = 600;
176 //-->
177 </script>
178 <script type="text/javascript"
179 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
180 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000181</div>
182
183<div class="main">
184
cristydcca3fa2010-12-29 21:50:07 +0000185<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000186<p class="navigation-index">
cristy5063d812010-10-19 16:28:10 +0000187[ <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#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 +0000188
cristydcca3fa2010-12-29 21:50:07 +0000189<div class="doc-section">
190
cristyb36feb22010-03-26 16:54:37 +0000191<p>Below is list of command-line options recognized by the ImageMagick <a
192href="../www/command-line-tools.html">command-line
193tools</a>. If you want a description of a particular option, click on the
194option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000195otherwise 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 +0000196
197<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000198 <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 +0000199</div>
200
201<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 +0000202<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>
203
204<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000205 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000206</div>
207
208<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>
209
210<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>
211
212<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000213 <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 +0000214</div>
215
216<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>
217
218<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>
219
220<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000221 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000222</div>
223
224<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>
225
226<p>This option is enabled by default. An attempt is made to save all
227images of an image sequence into the given output file.
228However, some formats, such as JPEG and PNG, do not support more than one
229image per file, and in that case ImageMagick is forced to write each image as a separate file. As
230such, if more than one image needs to be written, the filename given is
231modified by adding a <a href="#scene">-scene</a> number before the
232suffix, in order to make distinct names for each image. </p>
233
234<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written
235to separate files, whether or not the file format allows multiple images
236per file (for example, GIF, MIFF, and TIFF). </p>
237
238<p>Including a C-style integer format string in the output filename will automagically enable <a href="#adjoin">+adjoin</a> and are used to specify where the <a href="#scene">-scene</a> number is placed in the filenames. These strings, such as '<kbd>%d</kbd>' or '<kbd>%03d</kbd>', are familiar to those who have used the standard <kbd>printf()</kbd>' C-library function. As an example, the command</p>
239
240<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: rose: -morph 15 my%02dmorph.jpg</span></p>
241<p>will create a sequence of 17 images named my00morph.jpg, my01morph.jpg, my02morph.jpg, ..., my16morph.jpg.
242</p>
243
244<p>In summary, ImageMagick tries to write all images to one file, but will use
cristydcca3fa2010-12-29 21:50:07 +0000245multiple files if either<br />
246 (1) the output image's file format does not allow multi-image files,<br />
247 (2) the <a href="#adjoin">+adjoin</a> option is given, or<br />
248 (3) a printf() integer format string (eg: "%d") is present in the output filename. </p>
cristy3ed852e2009-09-05 21:47:34 +0000249
250
251<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000252 <h4><a id="affine"></a>-affine <em class="arg">s<sub>x</sub></em>,<em class="arg">r<sub>x</sub></em>,<em class="arg">r<sub>y</sub></em>,<em class="arg">s<sub>y</sub></em>,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em><br/>
cristy3ed852e2009-09-05 21:47:34 +0000253 -affine <em class="arg">s<sub>x</sub></em>,<em class="arg">r<sub>x</sub></em>,<em class="arg">r<sub>y</sub></em>,<em class="arg">s<sub>y</sub></em></h4>
254</div>
255
256<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>
257
258<p>This option sets a transformation matrix, encoded as (<em class="arg">s<sub>x</sub></em>, <em class="arg">r<sub>x</sub></em>, <em class="arg">r<sub>y</sub></em>, <em class="arg">s<sub>y</sub></em>, <em class="arg">t<sub>x</sub></em>, <em class="arg">t<sub>y</sub></em>), for use by subsequent <a href="#draw">-draw</a> or <a href="#transform">-transform</a> options.</p>
259
260<p>The matrix entries are entered as comma-separated numeric values <i>with no spaces</i>. </p>
261
262<p>Internally, the transformation matrix has 3x3 elements, but three of them are omitted from the input because they are constant. 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 original image are calculated using the following matrix equation.</p>
263
264<div class="eqn">
265<img alt="affine transformation" src="../images/affine.png"/>
266</div>
267
268<p>
269The size of the resulting image is that of the smallest rectangle that contains the transformed source image. The parameters <em class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em> subsequently shift the image pixels so that those that are moved out of the image area are cut off.</p>
270
271<p>The transformation matrix complies with the left-handed pixel coordinate system: positive <em class="arg">x</em> and <em class="arg">y</em> directions are rightward and downward, resp.; positive rotation is clockwise.</p>
272
273<p> If the translation coefficients <em class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em> are omotted they default to 0,0. Therefore, four parameters suffice for rotation and scaling without translation.</p>
274
275<p>Scaling by the factors <em class="arg">s<sub>x</sub></em> and <em class="arg">s<sub>y</sub></em> in the <em>x</em> and <em>y</em> directions, respectively, is accomplished with the following.</p>
276
277<p class="crtsnip">
278 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
279</p>
280
281<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>
282
283<p class="crtsnip">
284 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
285</p>
286
287<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
288<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
289
290<p class="crtsnip">
291 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
292</p>
293
294<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>
295
296<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>
297
298<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000299 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000300</div>
301
302<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>
303
304<p>Used to set a flag on an image indicating whether or not to use existing alpha
305channel 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>
306
307
308<table class="doc">
309 <tbody>
310 <tr valign="top">
311 <th align="left" style="width: 8%">type</th>
312 <th align="left">Description</th>
313 </tr>
314
315 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000316 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000317 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000318 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
319 should be used instead of this, unless you specifically need to
320 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
321 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000322
323 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000324 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000325 <td valign="top">
326 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000327 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000328
329 <tr valign="top">
330 <td valign="top"><kbd>Set</kbd></td>
331 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000332 Activates the alpha/matte channel. If it was previously turned off
333 then it also resets the channel to opaque. If the image already had
334 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000335
336 <tr valign="top">
337 <td valign="top"><kbd>Opaque</kbd></td>
338 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000339 Enables the alpha/matte channel and forces it to be fully opaque.
340 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000341
342 <tr valign="top">
343 <td valign="top"><kbd>Transparent</kbd></td>
344 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000345 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000346 transparent. This effectively creates a fully transparent image the
347 same size as the original and with all its original RGB data still
348 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000349
350 <tr valign="top">
351 <td valign="top"><kbd>Extract</kbd></td>
352 <td valign="top">
353 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000354 '<kbd>Off</kbd>' the the image's transparency, so as to generate
355 a gray-scale mask of the image's shape. The alpha channel data is left
356 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
357 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000358
359 <tr valign="top">
360 <td valign="top"><kbd>Copy</kbd></td>
361 <td valign="top">
362 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000363 gray-scale intensity of the image, into the alpha channel, converting
364 a gray-scale mask into a transparent shaped mask ready to be colored
365 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000366
367 <tr valign="top">
368 <td valign="top"><kbd>Shape</kbd></td>
369 <td valign="top">
370 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000371 the current background color. That is the RGB color channels is
372 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000373 </td></tr>
374
375 <tr valign="top">
376 <td valign="top"><kbd>Background</kbd></td>
377 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000378 Set any fully-transparent pixel to the background color, while leaving
379 it fully-transparent. This can make some image file formats, such as
380 PNG, smaller as the RGB values of transparent pixels are more uniform,
381 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000382 </td></tr>
383 </tbody>
384</table>
385
386<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000387"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000388>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000389Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000390
391
392<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000393 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000394 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
395 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
396 -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>
397</div>
398
399<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>
400
401<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>
402
403
404<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>
405
406<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>
407
408<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>
409<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
410
411<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>
412
413<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>
414
415<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000416 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000417</div>
418
419<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
420drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
421
422<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
423drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
424antialiasing edge pixels. This will then reduce the number of colors added to
425an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000426are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000427
428<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000429 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000430</div>
431
432<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>
433
434<p>This option creates a single longer image image, by joining all the current
435images in sequence top-to-bottom. Use <a href="#append">+append</a> to
436stack images left-to-right. </p>
437
438<p>If they are not of the same width, narrower images are padded with the
439current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000440position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000441href="#gravity">-gravity</a> setting. </p>
442
443
444<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000445 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000446</div>
447
448<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>
449
450
451<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000452 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000453</div>
454
455<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>
456
457<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>
458
459<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
460
cristyd934d102009-10-10 12:55:13 +0000461
462
cristy3ed852e2009-09-05 21:47:34 +0000463<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000464 <h4><a id="auto-gamma"></a>-auto-gamma</h4>
cristy3ed852e2009-09-05 21:47:34 +0000465</div>
466
467<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>
468
cristyd934d102009-10-10 12:55:13 +0000469<p>This calculates the mean values of an image, then applies a calculated <a
470href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
471image it will get a have a value of 50%. </p>
472
cristyd0bd44a2010-09-24 12:38:11 +0000473<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000474
475<p>This works well for real-life images with little or no extreme dark and
476light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000477dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000478</p>
479
480<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000481'<em>sync</em>' flag for channel syncronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000482values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000483>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000484together by the same gamma value, preserving colors. </p>
485
486
487
cristy3ed852e2009-09-05 21:47:34 +0000488<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000489 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000490</div>
491
492<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>
493
cristyd934d102009-10-10 12:55:13 +0000494<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000495minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000496href="#level" >-level</a> operator to stretch the values to the full range of
497values. </p>
498
cristy83543962009-10-16 19:04:28 +0000499<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000500JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
501for the <a href="#level" >-level</a> operation. On the other hand it is the
502right operator to use for color stretching gradient images being used to
503generate Color lookup tables, distortion maps, or other 'mathematically'
504defined images. </p>
505
506<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
507href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
508>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
509problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000510>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000511
512<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000513special '<em>sync</em>' flag for channel syncronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000514which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000515href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
516'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000517together by the same gamma value, preserving colors, and ignoring
518transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000519
520
cristy3ed852e2009-09-05 21:47:34 +0000521<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000522 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000523</div>
524
525<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>
526
cristy83543962009-10-16 19:04:28 +0000527<p>This operator reads and resets the EXIF image profile setting 'Orientation'
528and then performs the appropriate 90 degree rotation on the image to orient
529the image, for correct viewing. </p>
530
531<p>This EXIF profile setting is usually set using a gravity sensor in digital
532camara, however photos taken directly downward or upward may not have an
533appropriate value. Also images that have been orientation 'corrected' without
534reseting this setting, may be 'corrected' again resulting in a incorrect
535result. If the he EXIF profile was previously stripped, the <a
536href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
537
538
cristy3ed852e2009-09-05 21:47:34 +0000539<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000540 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000541</div>
542
543<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>
544
545<p>An error results if the images are not identically sized.</p>
546
cristy3ed852e2009-09-05 21:47:34 +0000547
548<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000549 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000550</div>
551
552<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>
553
554<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>
555
556<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000557 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000558</div>
559
560<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>
561
562<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>
563
564<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000565 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000566</div>
567
568<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>
569
cristye6378132009-10-26 20:05:17 +0000570<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 +0000571
cristye6378132009-10-26 20:05:17 +0000572<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>
573<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 +0000574
575<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000576 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000577</div>
578
579<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>
580
581<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>
582
583<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>
584
585<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
586negative results without clipping to the color value range
587(0..QuantumRange).</p>
588
589<p>See the discussion on HDRI implementations of ImageMagick on the page
590<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.
591</p>
592
593<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000594 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000595</div>
596
597<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>
598
599<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000600 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000601</div>
602
cristy5cadd612009-09-21 19:33:41 +0000603<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>
604
605<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.
606</p>
cristy3ed852e2009-09-05 21:47:34 +0000607
608
609<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000610 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000611</div>
612
cristy83a272e2010-05-07 20:40:35 +0000613<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 +0000614
615<p>Blend will average the images together ('plus') according to the
616percentages given and each pixels transparency. If only a single percentage
617value is given it sets the weight of the composite or 'source' image, while
618the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000619<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
620'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000621
622
623<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000624 <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 +0000625</div>
626
627<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>
628
629<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000630 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000631</div>
632
633<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>
634
635<div style="margin: auto;">
636
637<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000638 <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 +0000639</div>
640
641<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>
642
cristyb15553d2010-07-03 22:53:14 +0000643<p>Convolve the image with a Gaussian or normal distribution using the given
644<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000645
646<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
647</div>
648
cristyb15553d2010-07-03 22:53:14 +0000649<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000650determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000651
cristyb15553d2010-07-03 22:53:14 +0000652<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000653array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000654integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000655radius that will provide meaningful results for the Gaussian distribution.
656</p>
657
658<p>The larger the <em class="arg" >Radius</em> the radius the slower the
659operation is. However too small a <em class="arg" >Radius</em>, and sever
660aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
661should be at least twice the <em class="arg" >Sigma</em> value, though three
662times will produce a more accurite result. </p>
663
664<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
665by taking advantage of the separability properties of the distribution. Here
666we apply a single-dimensional Gaussian matrix in the horizontal direction,
667then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000668
669<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
670pixels which are outside the image proper are blurred into the final result.
671</p>
672
673
674<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000675 <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 +0000676</div>
677
678<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>
679
680<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
681Average (EWA) of the source image, scaled according to the grayscale
682mapping. </p>
683
684<p>The ellipse is weighted with sigma set to the given <em class="arg"
685>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
686defaults to the <em class="arg" >Width</em> for a normal circular Guassian
687weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
688horizontal clock-wise. </p>
689
690<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
691pixels which are outside the image proper are blurred into the final result.
692</p>
693
694
695<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000696 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000697</div>
698
699<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>
700
cristybc9539a2010-08-16 18:06:20 +0000701<p>Set the width and height using the <em class="arg">size</em> portion of the
702<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
703ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000704
cristybc9539a2010-08-16 18:06:20 +0000705<p>Set the border color by preceding with the <a
706href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000707
cristybc9539a2010-08-16 18:06:20 +0000708<p>The <a href="#border">-border</a> operation is affected by the current <a
709href="#compose">-compose</a> setting and assumes that this is using the default
710'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
711size colors by the current <a href="#bordercolor">-bordercolor</a> before
712overlaying the original image in the center of this net image. This means that
713with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000714be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000715<p>See also the <a href="#frame">-frame</a> option, which has more
716functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000717
718<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000719 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000720</div>
721
722<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>
723
724<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
725
726<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
727
728<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000729 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000730</div>
731
732<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>
733
734<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000735 <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 +0000736</div>
737
738<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>
739
cristyefb2bdb2010-11-20 19:35:22 +0000740<p>Brightness and Contrast values apply changes to the input image. They are
741not absolute settings. A brightness or contrast value of zero means no change.
742The range of values is -100 to +100 on each. Positive values increase the
743brightness or contrast and negative values decrease the brightness or contrast.
744To control only contrast, set the brightness=0. To control only brightness,
745set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000746
cristyefb2bdb2010-11-20 19:35:22 +0000747<p>You may also use <a href="#fill">-channel</a> to control which channels to
748apply the brightness and/or contrast change. The default is to apply the same
749transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000750
cristyefb2bdb2010-11-20 19:35:22 +0000751<p>Brightness and Contrast arguments are converted to offset and slope of a
752linear transform and applied
753using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000754
cristyefb2bdb2010-11-20 19:35:22 +0000755<p>The slope varies from 0 at contrast=-100 to almost vertical at
756contrast=+100. For brightness=0 and contrast=-100, the result are totally
757midgray. For brightness=0 and contrast=+100, the result will approach but
758not quite reach a threshold at midgray; that is the linear transformation
759is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000760
cristyefb2bdb2010-11-20 19:35:22 +0000761<p>Negative slopes, i.e. negating the image, are not possible with this
762function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000763
cristyefb2bdb2010-11-20 19:35:22 +0000764<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
765at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
766totally white. Similarly, when contrast=0 and brightness=-100, the result is
767totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000768
cristyefb2bdb2010-11-20 19:35:22 +0000769<p>As the range of values for the arguments are -100 to +100, adding the '%'
770symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000771
772<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000773 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000774</div>
775
776<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>
777
778<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000779 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000780</div>
781
782<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>
783
cristy71a3f602010-09-15 12:38:16 +0000784<p>This option sets the caption meta-data of an image read in after this
785option has been given. To modify a caption of images already in memory use
786"<kbd><a href="#set">-set</a> caption</kbd>". </p>
787
788<p>The caption can contain special format characters listed in the <a
789href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000790Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000791is finally assigned to the individual images. </p>
792
793<p>If the first character of <em class="arg">string</em> is <em
794class="arg">@</em>, the image caption is read from a file titled by the
795remaining characters in the string. Comments read in from a file are literal;
796no embedded formatting characters are recognized.</p>
797
798<p>Caption meta-data ais not visible on the image itself. To do that use the
799<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
800instead.</p>
801
802<p>For example,</p>
803
804<p class="crtsnip">
805 -caption "%m:%f %wx%h" bird.miff
806</p>
807
808<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
809that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
810480.</p>
811
812
cristy3ed852e2009-09-05 21:47:34 +0000813<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000814 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000815</div>
816
817<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>
818
819<p>Here is an example color correction collection:</p>
820
821<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000822&lt;?xml version="1.0" encoding="UTF-8"?&gt;
823&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
824 &lt;ColorCorrection id="cc06668"&gt;
825 &lt;SOPNode&gt;
826 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
827 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
828 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
829 &lt;/SOPNode&gt;
830 &lt;SATNode&gt;
831 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
832 &lt;/SATNode&gt;
833 &lt;/ColorCorrection&gt;
834&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000835</pre>
836
837<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000838 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000839</div>
840
841<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>
842
cristyefb2bdb2010-11-20 19:35:22 +0000843<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
844<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
845<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
846<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000847
cristy83a272e2010-05-07 20:40:35 +0000848<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000849abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
850'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
851'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000852
cristy83a272e2010-05-07 20:40:35 +0000853For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
854you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000855<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000856 -channel Red,Blue
857</p>
858<p>or you can use the short hand form</p>
859<p class="crtsnip">
860 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000861</p>
862
cristy83a272e2010-05-07 20:40:35 +0000863<p>All the channels that is present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000864special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
865but generally any operators that are generally 'grey-scale' image operators,
866will understand this setting. See individual operator documentation. </p>
867
cristydcca3fa2010-12-29 21:50:07 +0000868<br />
cristy83a272e2010-05-07 20:40:35 +0000869
870<p>On top of the normal channel selection a extra flag can be specified,
871'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000872operators that understand this flag should perform: cross-channel
873syncronization of the channels. If not specified, then most grey-scale
874operators will apply their image processing operations to each individual
875channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000876setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000877
878<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000879<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000880together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000881it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000882independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000883
cristydcca3fa2010-12-29 21:50:07 +0000884<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000885and the <a href="#compose">-compose</a> mathematical methods, also understands
886the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
887to the alpha channel (if present). That is to say it will modify the image
888processing with the understanding that fully-transparent colors should not
889contribute to the final result. </p>
890
cristydcca3fa2010-12-29 21:50:07 +0000891<p>Basically, by default, operators work with color channels in syncronous, and
cristybac7a162010-06-15 19:57:29 +0000892treats transparency as special, unless the <a href="#channel">-channel</a>
893setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
894How each operator does this depends on that operators current implementation.
895Not all operators understands this flag at this time, but that is changing.
896</p>
cristy83a272e2010-05-07 20:40:35 +0000897
898<p>To print a complete list of channel types, use <a href="#list">-list
899channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000900
cristydcca3fa2010-12-29 21:50:07 +0000901<br />
cristyd934d102009-10-10 12:55:13 +0000902
903<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000904'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
905channels except the transparency channel, and that all the color channels are
906to be modified in exactly the same way, with a understanding of transprancy
907(depending on the operation being applied). The 'plus' form <a
908href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000909
910<p>Options that are affected by the <a href="#channel" >-channel</a> setting
911include the following.
912
913<a href="#auto-gamma">-auto-gamma</a>,
914<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000915<a href="#black-threshold">-black-threshold</a>,
916<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000917<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000918<a href="#clut">-clut</a>,
919<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000920<a href="#composite">-composite</a> (Mathematical compose methods only),
921<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000922<a href="#contrast-stretch">-contrast-stretch</a>,
923<a href="#evaluate">-evaluate</a>,
924<a href="#function">-function</a>,
925<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000926<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000927<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000928<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000929<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000930<a href="#negate">-negate</a>,
931<a href="#normalize">-normalize</a>,
932<a href="#ordered-dither">-ordered-dither</a>,
933<a href="#radial-blur">-radial-blur</a>,
934<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000935<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000936<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000937<a href="#white-threshold">-white-threshold</a>.
938</p>
939
cristyd0bda5e2010-09-21 16:22:45 +0000940<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +0000941>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +0000942href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +0000943default). These operators have yet to be made to understand the newer 'Sync'
944flag. </p>
945
cristybac7a162010-06-15 19:57:29 +0000946<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
947the image before thresholding, if no <a href="#channel" >-channel</a> setting
948has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +0000949
950<p>Also some operators such as <a href="#blur">-blur</a>, <a
951href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
952color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
953href="#channel" >-channel</a>. Generally this done to ensure that
954fully-transparent colors are treated as being fully-transparent, and thus any
955underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +0000956resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +0000957convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +0000958and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +0000959
cristybac7a162010-06-15 19:57:29 +0000960<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +0000961color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +0000962alpha channel present, and the <a href="#channel" >-channel</a> setting tells
963the operator to apply the operation using alpha channels. The <a
964href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +0000965
cristy3ed852e2009-09-05 21:47:34 +0000966
967<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000968 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +0000969</div>
970
971<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>
972
973<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000974 <h4><a id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000975</div>
976
977<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>
978
979<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000980 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000981</div>
982
983<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>
984
cristyefb2bdb2010-11-20 19:35:22 +0000985<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>
986and <em class="arg">height</em> given in the of the <em class="arg">size</em>
987portion of the <em class="arg">geometry</em> argument give the number of
988columns and rows to remove. The <em class="arg">offset</em> portion of
989the <em class="arg">geometry</em> argument is influenced by
990a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +0000991
cristyefb2bdb2010-11-20 19:35:22 +0000992<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
993and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +0000994
cristydcca3fa2010-12-29 21:50:07 +0000995<p>While it can remove internal rows and columns of pixels, it is more typically
996used with as <a href="#gravity">-gravity</a> setting and a '<kbd>+0+0</kbd>' offset
997so as to remove a single edge from an image. Compare this to <a href="#shave"
998>-shave</a> whcih removes equal numbers of pixels from oppisite sides of the image.
999</p>
1000
1001<p>Using <a href="#chop">-chop</a> will effectivally undo the results of a
1002<a href="#splice">-splice</a> that was given the same <em class="arg">geometry</em>
1003and <a href="#gravity">-gravity</a> settings. </p>
1004
1005
cristy3ed852e2009-09-05 21:47:34 +00001006<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001007 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001008</div>
1009
1010<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>
1011
1012<p>If a clipping path is present, it is applied to subsequent operations.</p>
1013
1014<p>For example, in the command</p>
1015
1016<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
1017<p>only the pixels within the clipping path are negated.</p>
1018
1019<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1020
1021<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001022 <h4><a id="clip-mask"></a>-clip-mask</h4>
cristy3ed852e2009-09-05 21:47:34 +00001023</div>
1024
1025<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>
1026
1027<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001028 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001029</div>
1030
1031<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>
1032
1033<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001034 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001035</div>
1036
1037<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>
1038
cristydcca3fa2010-12-29 21:50:07 +00001039<p>Inside parenthesis (where the operator is normally used) it will make a
1040clone of the images from the last 'pushed' image sequence, and adds them to
1041the end of the current image sequence. Outside parenthesis
1042(not recommended) it clones the images from the current image sequence. </p>
1043
cristy3ed852e2009-09-05 21:47:34 +00001044<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000010450. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001046example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001047represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001048dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1049spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
1050effectivally clone all the images. </p>
1051
1052<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
1053in the image sequence, and is thus equivelent to using a argument of
1054'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001055
1056<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001057 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001058</div>
1059
1060<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
1061corresponding channel in the second image as a <b>c</b>olor
1062<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1063
1064<p>The second (LUT) image is ordinarily a gradient image containing the
1065histogram mapping of how each channel should be modified. Typically it is a
1066either a single row or column image of replacement color values. If larger
1067than a single row or column, values are taken from a diagonal line from
1068top-left to bottom-right corners.</p>
1069
1070<p>The lookup is further controlled by the <a
1071href="#interpolate">-interpolate</a> setting, which is especially handy for an
1072LUT which is not the full length needed by the ImageMagick installed Quality
1073(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1074'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1075gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1076lookup of color values. </p>
1077
1078<p>This operator is especially suited to replacing a grayscale image with a
1079specific color gradient from the CLUT image. </p>
1080
1081<p>Only the channel values defined by the <a href="#channel">-channel</a>
1082setting will have their values replaced. In particular, since the default <a
1083href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1084transparency (alpha/matte channel) is not affected, unless the <a
1085href="#channel">-channel</a> setting is modified. When the alpha channel is
1086set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1087as the other channels, implying that alpha/matte values are replaced using the
1088alpha/matte values of the original image. </p>
1089
cristyd0bda5e2010-09-21 16:22:45 +00001090<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001091transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1092href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001093assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001094replacement alpha values. That is you can use a gray-scale CLUT image to
1095adjust a existing images alpha channel, or you can color a gray-scale image
1096using colors form CLUT containing the desired colors, including transparency.
1097</p>
1098
cristyefb2bdb2010-11-20 19:35:22 +00001099<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1100according to the lookup of the full color RGB value from a 2D representation
1101of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001102
1103
1104<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001105 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001106</div>
1107
1108<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
1109
cristyefb2bdb2010-11-20 19:35:22 +00001110<p>Overlay each image in an image sequence according to
1111its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1112an animation at each point in the animation sequence. All images should be
1113the same size, and are assigned appropriate GIF disposal settings for the
1114animation to continue working as expected as a GIF animation. Such frames
1115are more easily viewed and processed than the highly optimized GIF overlay
1116images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001117
cristyefb2bdb2010-11-20 19:35:22 +00001118<p>The animation can be re-optimized after processing using
1119the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1120there is no guarantee that the restored GIF animation optimization is
1121better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001122
1123
1124<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001125 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001126</div>
1127
1128<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>
1129
cristyefb2bdb2010-11-20 19:35:22 +00001130<p>Specify the amount of colorization as a percentage. Separate colorization
1131values can be applied to the red, green, and blue channels of the image with
1132a comma-delimited list of colorization
1133values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001134
1135<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001136 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001137</div>
1138
1139<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>
1140
1141<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1142
cristyefb2bdb2010-11-20 19:35:22 +00001143<p>This option only applies when the default X server visual
1144is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1145to <a href="#visual">-visual</a> for more details. By default,
1146a shared colormap is allocated. The image shares colors with
1147other X clients. Some image colors could be approximated,
1148therefore your image may look very different than intended.
1149If <kbd>private</kbd> is chosen, the image colors appear exactly
1150as they are defined. However, other clients may go <em>technicolor</em>
1151when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001152
1153<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001154 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001155</div>
1156
1157<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>
1158
cristyefb2bdb2010-11-20 19:35:22 +00001159<p>The actual number of colors in the image may be less than your request,
1160but never more. Note that this a color reduction option. Images with fewer
1161unique colors than specified by <em class="arg">value</em> will have any
1162duplicate or unused colors removed. The ordering of an existing color
1163palette may be altered. When converting an image from color to grayscale,
1164it is more efficient to convert the image to the gray colorspace before
1165reducing the number of colors. Refer to
1166the <a href="../www/quantize.html">
1167color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001168
1169<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001170 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001171</div>
1172
1173<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>
1174
cristyefb2bdb2010-11-20 19:35:22 +00001175<p>This option permits saturation changes, hue rotation, luminance to alpha,
1176and various other effects. Although variable-sized transformation matrices
1177can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1178for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1179Adobe Flash except offsets are in column 6 rather than 5 (in support of
1180CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001181
1182<p>As an example, to add contrast to an image with offsets, try this command:</p>
1183
1184<pre class="text">
1185convert kittens.jpg -color-matrix \
1186 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1187 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1188 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1189 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1190 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1191 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1192</pre>
1193<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001194 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001195</div>
1196
1197<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>
1198
1199<p>Choices are:</p>
1200
1201<pre class="text">
1202 CMY
1203 CMYK
1204 Gray
1205 HSB
1206 HSL
1207 HWB
1208 Lab
1209 Log
1210 OHTA
1211 Rec601Luma
1212 Rec601YCbCr
1213 Rec709Luma
1214 Rec709YCbCr
1215 RGB
1216 sRGB
1217 Transparent
1218 XYZ
1219 YCbCr
1220 YCC
1221 YIQ
1222 YPbPr
1223 YUV
1224</pre>
1225
1226<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1227
1228<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>
1229
1230<table class="doc">
1231 <caption>Conversion Of RGB To Other Color Spaces</caption>
1232 <tr><th align="left" valign="middle">CMY</th></tr>
1233 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1234 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1235 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1236 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1237 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1238 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1239 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1240 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1241
1242 <tr><th align="left" valign="middle">Gray</th></tr>
1243 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1244
1245 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1246 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1247 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1248 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1249
1250 <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>
1251 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1252 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1253 <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>
1254
1255 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1256 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1257 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1258 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1259
1260 <tr><th align="left" valign="middle">LAB</th></tr>
1261 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1262 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1263 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1264
1265 <tr><th align="left" valign="middle">LOG</th></tr>
1266 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1267 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1268 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1269
1270 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1271 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1272 <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>
1273 <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>
1274
1275 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1276 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1277
1278 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1279 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1280 <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>
1281 <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>
1282
1283 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1284 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1285
1286 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1287 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1288 <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>
1289 <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>
1290
1291 <tr><th align="left" valign="middle">sRGB</th></tr>
1292 <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>
1293 <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>
1294 <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>
1295
1296 <tr><th align="left" valign="middle">XYZ</th></tr>
1297 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1298 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1299 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1300
1301 <tr><th align="left" valign="middle">YCC</th></tr>
1302 <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>
1303 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1304 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1305
1306 <tr><th align="left" valign="middle">YCbCr</th></tr>
1307 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1308 <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>
1309 <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>
1310
1311 <tr><th align="left" valign="middle">YIQ</th></tr>
1312 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1313 <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>
1314 <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>
1315
1316 <tr><th align="left" valign="middle">YPbPr</th></tr>
1317 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1318 <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>
1319 <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>
1320
1321 <tr><th align="left" valign="middle">YUV</th></tr>
1322 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1323 <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>
1324 <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>
1325</table>
1326
1327<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001328 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001329</div>
1330
1331<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>
1332
1333<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>
1334
1335<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.
1336</p>
1337
cristy4949d522010-03-12 18:41:34 +00001338<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 +00001339<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001340 <h4><a id="comment"></a>-comment <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001341</div>
1342
1343<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>
1344
cristyd0bda5e2010-09-21 16:22:45 +00001345<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001346option has been given. To modify a comment of images already in memory use
1347"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001348
cristy71a3f602010-09-15 12:38:16 +00001349<p>The comment can contain special format characters listed in the <a
1350href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001351Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001352is finally assigned to the individual images. </p>
1353
1354<p>If the first character of <em class="arg">string</em> is <em
1355class="arg">@</em>, the image comment is read from a file titled by the
1356remaining characters in the string. Comments read in from a file are literal;
1357no embedded formatting characters are recognized.</p>
1358
1359<p>Comment meta-data are not visible on the image itself. To do that use the
1360<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1361instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001362
1363<p>For example,</p>
1364
1365<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001366 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001367</p>
1368
cristy71a3f602010-09-15 12:38:16 +00001369<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1370that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1371480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001372
1373<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001374 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001375</div>
1376
1377<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>
1378
cristybc9539a2010-08-16 18:06:20 +00001379<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1380a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001381
cristybc9539a2010-08-16 18:06:20 +00001382<p>This setting effects image processing operators that merge two (or more)
1383images together in some way. This includes the operators,
1384<a href="#composite">-composite</a>,
1385<a href="#layers">-layers</a> composite,
1386<a href="#flatten">-flatten</a>,
1387<a href="#mosaic">-mosaic</a>,
1388<a href="#layers">-layers</a> merge,
1389<a href="#border">-border</a>,
1390<a href="#frame">-frame</a>,
1391and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001392
cristybc9539a2010-08-16 18:06:20 +00001393<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1394command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001395
1396
1397<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001398 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001399</div>
1400
cristybc9539a2010-08-16 18:06:20 +00001401<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 +00001402
1403<p>Take the first image 'destination' and overlay the second 'source' image
1404according to the current <a href="#compose">-compose</a> setting. The location
1405of the 'source' or 'overlay' image is controlled according to <a
1406href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1407settings. </p>
1408
1409<p>If a third image is given this is treated as a gray-scale 'mask' image
1410relative to the first 'destination' image. This mask will limit what parts of
1411the destination can be modified by the image composition. However for the
1412'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1413Y-displacement image instead. </p>
1414
1415<p>If a <a href="#compose">-compose</a> method requires extra numerical
1416arguments or flags these can be provided by setting the <a
1417href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001418appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001419
1420<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1421image outside the overlay area. You can disable this by setting the special <a
1422href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1423to '<kbd>false</kbd>'. </p>
1424
1425
1426<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001427 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001428</div>
1429
1430<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>
1431
1432<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>
1433
1434<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1435
1436<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>
1437
1438<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>
1439
1440<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>
1441
1442<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>
1443
1444<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001445 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001446</div>
1447
1448<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>
1449
1450<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>
1451
1452<p>For a more pronounced effect you can repeat the option:</p>
1453
1454<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1455<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001456 <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 +00001457</div>
1458
1459<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>
1460
cristyd934d102009-10-10 12:55:13 +00001461<p>While performing the stretch, black-out at most <em
1462class="arg" >black-point</em> pixels and white-out at most <em
1463class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1464<em class="arg" >black-point %</em> pixels and white-out at most <em
1465class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001466
cristyd934d102009-10-10 12:55:13 +00001467<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1468>-contrast-stretch</a> will black-out at most <em class="arg"
1469>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1470minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1471class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1472>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001473
cristyd934d102009-10-10 12:55:13 +00001474<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1475the image's min and max values are stretched to 0 and <em class="QR"
1476>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1477clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001478>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001479prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001480
cristyd934d102009-10-10 12:55:13 +00001481<p>Internally operator works by creating a histogram bin, and then uses that
1482bin to modify the image. As such some colors may be merged together when they
1483originally fell into the same 'bin'. </p>
1484
1485<p>All the channels are normalized in concert by the came amount so as to
1486preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001487setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001488setting will normalize the RGB channels independently.</p>
1489
1490<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1491normalization of mathematical images. </p>
1492
1493<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001494
1495
1496<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001497 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001498</div>
1499
1500<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>
1501
cristy16ff93c2010-01-13 23:18:07 +00001502<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001503a comma-separated list of integers (with no spaces), ordered left-to right,
1504starting with the top row. Presently, only odd-dimensioned kernels are
1505supported, and therefore the number of entries in the specified <em
1506class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15077<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001508
cristyd934d102009-10-10 12:55:13 +00001509<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
1510positive and negative results are relative to a user-specified bias value.
1511This is important for non-HDRI compilations of ImageMagick when dealing with
1512convolutions that contain negative as well as positive values. This is
1513especially the case with convolutions involving high pass filters or edge
1514detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001515</p>
1516
cristyd934d102009-10-10 12:55:13 +00001517<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
1518negative results without clipping to the color value range (0..QuantumRange).
1519See the discussion on HDRI implementations of ImageMagick on the page <a
1520href="/www/high-dynamic-range.html">High
1521Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1522href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1523<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1524entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001525
cristy3ed852e2009-09-05 21:47:34 +00001526
1527<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001528 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001529</div>
1530
1531<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>
1532
1533<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>
1534
1535<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>
1536
1537<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>
1538
1539<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>
1540
1541<p>By adding a exclamation character flag to the geometry argument, the
1542cropped images virtual canvas page size and offset is set as if the
1543geometry argument was a viewport or window. This means the canvas page size
1544is set to exactly the same size you specified, the image offset set
1545relative top left corner of the region cropped. </p>
1546
1547<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1548special single pixel transparent 'missed' image is returned, and a 'crop
1549missed' warning given. </p>
1550
cristy739df912009-10-24 16:10:18 +00001551<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 +00001552
1553<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001554 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001555</div>
1556
1557<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>
1558
1559<p><em class="arg">Amount</em> defines the number of positions each
1560colormap entry is shifted.</p>
1561
1562
1563<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001564 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001565</div>
1566
1567<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>
1568
1569<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>
1570
1571
1572<p>For example, to log cache and blob events, use.</p>
1573
1574<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1575<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1576
1577<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1578
1579<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1580
1581<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1582
1583<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>
1584
1585
1586<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001587 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001588</div>
1589
1590<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>
1591
1592<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1593
1594<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1595
1596
1597<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001598 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001599</div>
1600
1601<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>
1602
1603<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>
1604
1605<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>
1606
1607<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1608
1609
1610<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001611 <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 +00001612</div>
1613
cristyd0bd44a2010-09-24 12:38:11 +00001614<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 +00001615coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001616
cristyd0bda5e2010-09-21 16:22:45 +00001617<p>This option creates one or more definitions for coders and decoders to use
1618while reading and writing image data. Definitions are generally used to
1619control image file format coder modules, and image processing operations,
1620beyond what is provided by normal means. Defined settings are listed in <a
1621href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1622as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001623
cristyd0bda5e2010-09-21 16:22:45 +00001624<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1625definition of a flag is created with that name. This used to control on/off
1626options. Use <a href="#define">+define key</a> to remove definitions
1627previously created. Use <a href="#define">+define "*"</a> to remove all
1628existing definitions.</p>
1629
cristyd0bd44a2010-09-24 12:38:11 +00001630<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001631href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001632>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 +00001633Properties</a> in the defined value. </p>
1634
cristyefb2bdb2010-11-20 19:35:22 +00001635<p>The <em>option</em> and <em>key</em> are case-independent (they are
1636converted to lowercase for use within the decoders) while the <em>value</em>
1637is case-dependent.</p>
1638
cristyd0bda5e2010-09-21 16:22:45 +00001639<p>Such settings are global in scope, and effect all images and operations. </p>
1640
1641<p>The following definitions are just some of the artifacts that are
1642available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001643
cristydcca3fa2010-12-29 21:50:07 +00001644<dl>
cristy045bd902010-01-30 18:56:24 +00001645<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001646<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001647 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001648
cristy045bd902010-01-30 18:56:24 +00001649<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001650<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001651 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001652
cristy045bd902010-01-30 18:56:24 +00001653<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001654<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001655 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001656
cristy045bd902010-01-30 18:56:24 +00001657<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001658<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1659 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001660 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001661
cristy045bd902010-01-30 18:56:24 +00001662<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001663<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1664 compression factor is the reciprocal of the compression ratio. The valid
1665 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1666 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001667 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001668
cristy3ed852e2009-09-05 21:47:34 +00001669<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001670 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001671
cristy045bd902010-01-30 18:56:24 +00001672<dt>png:bit-depth=<em class="arg">value</em></dt>
1673<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001674<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1675 encoder to use a different bit-depth and color-type than it would have
1676 normally selected, but only if this does not cause any loss of image
1677 quality. Any attempt to reduce image quality is treated as an error and no
1678 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1679 can use these "defines" to cause it to be written as an 8-bit grayscale,
1680 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1681 you cannot force it to be written as a grayscale or indexed PNG. If you
1682 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1683 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1684 reduce the image quality prior to using the PNG encoder. Note that in
1685 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001686 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001687 8-bit depth.</dd>
1688
1689<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1690<dt>png:include-chunk=<em class="arg">value</em></dt>
1691<dd>ancillary chunks to be excluded from or included in PNG output.
1692
1693 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1694 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1695 or the word <em class="arg">all</em> or
1696 the word <em class="arg">none</em>. There must be no spaces in the
1697 list. Although PNG chunk-names are case-dependent, you can use
1698 all lowercase names if you prefer.</p>
1699
1700 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1701 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1702 only be written if gamma is not 1/2.2, since most decoders assume
1703 sRGB and gamma=1/2.2 when no colorspace information is included in
1704 the PNG file. Because the list is processed from left to right, you
1705 can achieve this with a single define:</p>
1706
1707<pre class="text">
1708 -define png:include-chunk=none,gAMA
1709</pre>
1710
1711 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
1712 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any of
1713 these entries appearing in the list will be ignored.</p>
1714
1715 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1716 image has transparency, the PNG colortype is forced to be 4 or 6
1717 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1718 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1719 on the PNG colortype of the output image.</p>
1720
1721 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1722 following for PNG output:</p>
1723
1724<pre class="text">
1725 -define png:include-chunk=none,gama
1726</pre>
1727
1728 <p>The default behavior is to include all known PNG ancillary chunks
cristyf7964272011-01-30 03:49:12 +00001729 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk,
1730 and to exclude all PNG chunks that are unknown to ImageMagick,
1731 regardless of their PNG "copy-safe" status as described in the
1732 PNG specification.</p>
cristydcca3fa2010-12-29 21:50:07 +00001733 </dd>
cristyd0bda5e2010-09-21 16:22:45 +00001734
cristy3ed852e2009-09-05 21:47:34 +00001735<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001736<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1737 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001738 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001739
cristy045bd902010-01-30 18:56:24 +00001740<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001741<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1742 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1743 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001744 included, the result is a single precision floating point format.
1745 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001746 double precision floating point format.</dd>
1747
cristydcca3fa2010-12-29 21:50:07 +00001748</dl>
cristy3ed852e2009-09-05 21:47:34 +00001749
cristyd0bda5e2010-09-21 16:22:45 +00001750<p>For example, to create a postscript file that will render only the black
1751pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001752
1753<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 +00001754<p>Set attributes of the image registry by prefixing the value with
1755<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1756use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001757
1758<p class="crtsnip">
1759-define registry:temporary-path=/data/tmp
1760</p>
1761
cristyd0bda5e2010-09-21 16:22:45 +00001762
1763
cristy3ed852e2009-09-05 21:47:34 +00001764<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001765 <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 +00001766</div>
1767
1768<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>
1769
1770<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>
1771
1772<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>
1773
1774
1775<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001776 <h4><a id="delete"></a>-delete <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001777</div>
1778
1779<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>
1780
1781<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>
1782
1783
1784<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001785 <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 +00001786</div>
1787
1788<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>
1789
1790<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>
1791
1792<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>
1793
1794<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>
1795
1796<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>
1797
1798<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001799 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001800</div>
1801
1802<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>
1803
1804<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>
1805
1806<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001807 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00001808</div>
1809
1810<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>
1811
1812<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001813 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001814</div>
1815
1816<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>
1817
1818<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>
1819
1820<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001821 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00001822</div>
1823
1824<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>
1825
1826<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001827 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001828</div>
1829
1830<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>
1831
1832<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001833 <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 +00001834</div>
1835
1836<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>
1837
1838<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001839is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001840what part of the 'background' image is seen at each point of the overlaid
1841area. Much like the displacement map is a 'lens' that redirects light shining
1842through it so as to present a distorted view the original 'background' image
1843behind it. </p>
1844
1845<p>Any perfect grey areas of the displacement map produce a zero
1846displacement of the image. Black areas produce the given maximum negative
1847displacement of the lookup point, while white produce a maximum positive
1848displacement of the lookup. </p>
1849
1850<p>Note that it is the lookup of the 'background' that is displaced, not a
1851displacement of the image itself. As such an area of the displacement map
1852containing 'white' will have the lookup point 'shifted' by a positive amount,
1853and thus generating a copy of the destination image to the right/downward from
1854the correct position. That is the image will look like it may have been
1855'shifted' in a negative left/upward direction. Understanding this is a very
1856important in understanding how displacement maps work. </p>
1857
1858<p>The given arguments define the maximum amount of displacement in pixels
1859that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001860it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001861outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001862easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001863into the overlay area. </p>
1864
1865<p>The '%' flag makes the displacement scale relative to the size of the
1866overlay image (100% = half width/height of image). Using '!' switches
1867percentage arguments to refer to the destination image size instead.
1868these flags were added as of IM v6.5.3-5.</p>
1869
1870<p>Normally a single grayscale displacement map is provided, which with the
1871given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001872displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001873specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001874the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001875displacement, while the <em class="arg">mask image</em> is used for vertical Y
1876displacement. This allows you to define completely different displacement
1877values for the X and Y directions, and allowing you to lookup any point within
1878the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001879any other nearby pixel, producing complex 2 dimensional displacements, rather
1880than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001881
cristyd0bda5e2010-09-21 16:22:45 +00001882<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001883you can use the 'red' channel of the overlay image to specify the horizontal
1884or X displacement, and the 'green' channel for the vertical or Y displacement.
1885</p>
1886
cristyd0bd44a2010-09-24 12:38:11 +00001887<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 +00001888mask the transparency of the destination image. However areas outside the
1889overlaid areas will not be effected. </p>
1890
1891
1892<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001893 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001894</div>
1895
1896<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
1897
1898<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1899
1900<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001901 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001902</div>
1903
1904<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>
1905
1906<p>The layer disposal method defines the way each the displayed image is to be
1907modified after the current 'frame' of an animation has finished being
1908displayed (after its 'delay' period), but before the next frame on an
1909animation is to be overlaid onto the display. </p>
1910
1911<p>Here are the valid methods:</p>
1912
1913<pre class="text">
1914Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
1915None 1 Do not dispose, just overlay next frame image.
1916Background 2 Clear the frame area with the background color.
1917Previous 3 Clear to the image prior to this frames overlay.
1918</pre>
1919
1920<p>You can also use the numbers given above, which is what the GIF format
1921uses internally to represent the above settings. </p>
1922
cristyd0bda5e2010-09-21 16:22:45 +00001923<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00001924
1925<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
1926resetting the layer disposal methods of images being read in. </p>
1927
1928<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
1929disposal method for images already in memory.</p>
1930
1931<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001932 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001933</div>
1934
1935<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>
1936
1937
1938<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001939 <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 +00001940</div>
1941
1942<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>
1943
1944<p>The opacity of the composite image is multiplied by the given percent, then
1945it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00001946is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00001947transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
1948are given, each image are dissolved to the percentages given. </p>
1949
1950<p>Note that dissolve percentages do not add, two opaque images dissolved
1951'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
1952images, you would need to use dissolve values of '50,100'. </p>
1953
1954<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001955 <h4><a id="distort"></a>-distort <em class="arg">method arguments</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%'>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>
1959
1960<p>The <em class="arg">arguments</em> is a single string containing a list
1961of floating point numbers separated by commas or spaces. The number of
1962and meaning of the floating point values depends on the distortion <em
1963class="arg">method</em> being used. </p>
1964
1965<p>Choose from these distortion types:</p>
1966
1967<table class="doc">
1968 <tr valign="top">
1969 <th align="left" style="width: 8%">Method</th>
1970 <th align="left">Description</th>
1971 </tr>
1972
1973 <tr valign="top">
1974 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
1975 <br/>or &nbsp; <kbd>SRT</kbd></td>
1976 <td valign="top">
1977 Distort image by first scaling and rotating about a given 'center',
1978 before translating that 'center' to the new location, in that order. It
1979 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
1980 distortion, but without shearing effects. It also provides a good way
1981 of rotating and displacing a smaller image for tiling onto a larger
1982 background (IE 2-dimensional animations). <br/>
1983
1984 The number of arguments determine the specific meaning of each
1985 argument for the scales, rotation, and translation operations. <br/>
1986
1987 <table style="margin-left:auto; margin-right:auto;">
1988 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
1989 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
1990 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00001991 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00001992 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
1993 <tr><td>5:</td>
1994 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
1995 <tr><td>6:</td>
1996 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
1997 <tr><td>7:</td>
1998 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
1999 &nbsp; NewX,NewY</em></td></tr>
2000 </table>
2001
cristyd0bda5e2010-09-21 16:22:45 +00002002 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00002003 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2004
2005 <tr valign="top">
2006 <td valign="top"><kbd>Affine</kbd></td>
2007 <td valign="top">
2008 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002009 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002010 point values are given allowing the image to be linearly scaled,
2011 rotated, sheared, and translated, according to those three points. See
2012 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2013 distortions. <br/>
2014
2015 More than 3 sets given control point pairs (12 numbers) is least
2016 squares fitted to best match a lineary affine distortion. If only 2
2017 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002018 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002019 flipping or changes in aspect ratio to the resulting image. If only one
2020 control point pair is provides the image is only translated, (which may
2021 be a floating point non-integer translation). <br/>
2022
2023 This distortion does not include any form of perspective distortion.
2024 </td>
2025
2026 </tr>
2027
2028 <tr valign="top">
2029 <td valign="top"><kbd>AffineProjection</kbd></td>
2030 <td valign="top">
2031 Linearly distort an image using the given Affine Matrix of 6
2032 pre-calculated coefficients forming a set of Affine Equations to map
2033 the source image to the destination image.
2034
2035 <div style="text-align: center"><em>
2036 s<sub>x</sub>, r<sub>x</sub>,
2037 r<sub>y</sub>, s<sub>y</sub>,
2038 t<sub>x</sub>, t<sub>y</sub>
2039 </em></div>
2040
2041 See <a href="#affine" >-affine</a> setting for more detail, and
2042 meanings of these coefficients. <br/>
2043
2044 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002045 alternative methods of defining this distortion, with ImageMagick doing
2046 the calculations needed to generate the required coefficients. You can
2047 see the internally generated coefficients, by using a <a
2048 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002049
2050 </tr>
2051
cristy3ed852e2009-09-05 21:47:34 +00002052 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002053 <td valign="top"><kbd>BilinearForward</kbd><br/>
2054 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002055 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002056 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2057 16 values (see below). Not that lines may not appear straight after
2058 distortion, though the distance between coordinates will remain
2059 consistent. <br/>
2060
2061 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2062 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2063 quadrilateral to a rectangle, while preserving the straigth line edges
2064 in each case. <br/>
2065
2066 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2067 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2068 color setting. Also if the quadraterial becomes 'flipped' the image
2069 may dissappear. <br/>
2070
2071 There are future plans to produce a true Bilinear distortion that will
2072 attempt to map any quadrilateral to any other quadrilateral, while
2073 preserving edges (and edge distance ratios).
2074
2075 </td>
cristy3ed852e2009-09-05 21:47:34 +00002076 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002077
2078 <tr valign="top">
2079 <td valign="top"><kbd>Perspective</kbd></td>
2080 <td valign="top">
2081 Perspective distort the images, using a list of 4 or more sets of
2082 control points (as defined below). More that 4 sets (16 numbers) of
2083 control points provide least squares fitting for more accurate
2084 distortions (for the purposes of image registration and panarama
2085 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2086 linear distortion. <br/>
2087
2088 Perspective Distorted images ensures that straight lines remain
2089 straight, but the scale of the distorted image will vary. The horizon
2090 is anti-aliased, and the 'sky' color may be set using the
2091 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2092 </tr>
2093
2094 <tr valign="top">
2095 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2096 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002097 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002098 pre-calculated coefficients. You can get these coefficients by looking
2099 at the <a href="#verbose" >-verbose</a> output of a
2100 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2101 If the last two perspective scaling coefficients are zero, the
2102 remaining 6 represents a transposed 'Affine Matrix'. </td>
2103
2104 </tr>
2105
2106 <tr valign="top">
2107 <td valign="top"><kbd>Arc</kbd></td>
2108 <td valign="top">
2109 Arc the image (variation of polar mapping) over the angle given around
2110 a circle. <br/>
2111 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2112 <tr valign="top"><td>Argument</td>
2113 <td>Meaning</td></tr>
2114 <tr valign="top"><td><em>arc_angle</em></td>
2115 <td>The angle over which to arc the image side-to-side</td></tr>
2116 <tr valign="top"><td><em>rotate_angle</em></td>
2117 <td>Angle to rotate resulting image from vertical center</td></tr>
2118 <tr valign="top"><td><em>top_radius</em></td>
2119 <td>Set top edge of source image at this radius</td></tr>
2120 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2121 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2122 </table>
2123
2124 The resulting image is always resized to best fit the resulting image,
2125 (as if using <a href="#distort" >+distort</a>) while attempting to
2126 preserve scale and aspect ratio of the original image as much as
2127 possible with the arguments given by the user. All four arguments will
2128 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2129
2130 This a variation of a polar distortion designed to try to preserve the
2131 aspect ratio of the image rather than direct Cartesian to Polar
2132 conversion. </td>
2133 </tr>
2134
2135 <tr valign="top">
2136 <td valign="top"><kbd>Polar</kbd></td>
2137 <td valign="top">
2138 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2139 the image. that is the height of the input image is mapped to the
2140 radius limits, while the width is wrapped around between the
2141 angle limits. <br/>
2142
2143 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2144
2145 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2146 center to the center of the image, and the angles going from -180 (top)
2147 to +180 (top). If <em>Rmax</em> is given the special value of
2148 '<code>0</code>', the the distance from the center to the nearest edge
2149 is used for the radius of the output image, which will ensure the whole
2150 image is visible (though scaled smaller). However a special value of
2151 '<code>-1</code>' will use the distance from the center to the furthest
2152 corner, This may 'clip' the corners from the input rectangular image,
2153 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2154 the same arguments. <br/>
2155
2156 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2157 output image center will default to <code>0,0</code> of the virtual
2158 canvas, and the image size adjusted to ensure the whole input image is
2159 made visible in the output image on the virtual canvas. </td>
2160
2161 </tr>
2162
2163 <tr valign="top">
2164 <td valign="top"><kbd>DePolar</kbd></td>
2165 <td valign="top">
2166 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2167 but generates the reverse Polar to Cartesian distortion. <br/>
2168
2169 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2170 the corners of the input image. However using the special
2171 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2172 distance) will ensure the whole distorted image is preserved in the
2173 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2174 reverse the distortion re-producing the original.
2175
2176 Note that as this distortion requires the area resampling of a circular
2177 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002178 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002179 form of 'super-sampling' image processing technique be used to produce
2180 a high quality result. </td>
2181
2182 </tr>
2183
2184 <tr valign="top">
2185 <td valign="top"><kbd>Barrel</kbd></td>
2186 <td valign="top">
2187 Given the four coefficients (A,B,C,D) as defined by <a
2188 href="http://www.all-in-one.ee/~dersch/barrel/barrel.html" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002189 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002190 correct radial lens distortions. That is in photographs, make straight
2191 lines straight again. <br/>
2192
2193 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2194 <em>X</em> , <em>Y</em> ] ] <br/>
2195 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2196 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2197 [ <em>X</em> , <em>Y</em> ] <br/>
2198 So that it forms the function <br/>
2199 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2200 <em>C</em>*r + <em>D</em> )<br/>
2201
2202 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2203 (defaulting to the center of the image). <br/>
2204 The second form is typically used to distort images, rather than
2205 correct lens distortions. <br/>
2206 </td>
2207
2208 </tr>
2209
2210 <tr valign="top">
2211 <td valign="top"><kbd>BarrelInverse</kbd></td>
2212 <td valign="top">
2213 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2214 arguments, and argument handling. However it uses the inverse
2215 of the radial polynomial,
2216 so that it forms the function <br/>
2217 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002218 <em>C</em>*r + <em>D</em> )<br/>
2219 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2220 distortion, just a different barrel-like radial distortion method.
2221
cristy3ed852e2009-09-05 21:47:34 +00002222 </td>
2223 </tr>
2224
2225 <tr valign="top">
2226 <td valign="top"><kbd>Shepards</kbd></td>
2227 <td valign="top">
2228 Distort the given list control points (any number) using an Inverse
2229 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002230 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2231 Method</a>). The control points in effect do 'localized' displacement
2232 of the image around the given control point (preserving the look and
2233 the rotation of the area near the control points. For best results
2234 extra control points should be added to 'lock' the positions of the
2235 corners, edges and other unchanging parts of the image, to prevent
2236 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002237
cristyd0bd44a2010-09-24 12:38:11 +00002238 The distortion has been likened to 'taffy pulling' using nails, or
2239 pins' stuck in a block of 'jelly' which is then moved to the new
2240 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002241
cristyd0bd44a2010-09-24 12:38:11 +00002242 Internally it is equivelent to generating a displacement map (see <a
2243 href="#displace" >-displace</a>) for source image color look-up using
2244 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2245
2246 </td>
cristy3ed852e2009-09-05 21:47:34 +00002247 </tr>
2248
2249</table>
2250
cristyd0bd44a2010-09-24 12:38:11 +00002251<p>To print a complete list of distortion methods, use <a href="#list">-list
2252distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002253
2254<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2255'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2256defining how these points in the given image should be distorted in the
2257destination image. Each set of four floating point values represent a source
2258image coordinate, followed immediately by the destination image coordinate.
2259This produces a list of values such as...</p>
2260<div style="text-align: center"><em>
2261 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2262 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2263 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2264 ... &nbsp;
2265 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2266</em></div>
2267<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2268destination image. </p>
2269
2270<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2271needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2272perspective distortion of the built-in "rose:" image. Note how spaces were
2273used to group the 4 sets of coordinate pairs, to make it easier to read and
2274understand.</p>
2275
2276<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002277convert rose: -virtual-pixel black \<br/>
2278 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2279 rose_3d_rotated.gif</span></p>
2280<p>If more that the required number of coordinate pairs are given for
2281a distortion, the distortion method is 'least squares' fitted to produce the
2282best result for all the coordinate pairs given. If less than the ideal number
2283of points are given, the distort will generally fall back to a simpler form of
2284distortion that can handles the smaller number of coordinates (usally a linear
2285'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002286
cristyd0bda5e2010-09-21 16:22:45 +00002287<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002288find matching coordinate pairs in overlapping images, so as to improve the
2289'fit' of the distortion. Of course a bad coordinate pair can also make the
2290'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002291
2292<p>Colors are acquired from the source image according to the <a
2293href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002294magnified. However if the viewed image is minified (image becomes smaller),
2295a special area resampling function (added ImageMagick v6.3.5-9), is used to
2296produce a higher quality image. For example you can use
2297a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2298the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002299
cristyd0bd44a2010-09-24 12:38:11 +00002300<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2301convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2302 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2303 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002304<p>Note that a infinitely tiled perspective images involving the horizon can
2305be very slow to generate due to the use of the high quality 'area resampling'
2306function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2307using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2308(recommended if you plan to use super-sampling instead). </p>
2309
2310<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2311'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2312will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2313pixels. If you do not what these pixels to be visible, set the color to match
2314the rest of the ground. </p>
2315
2316<p>The output image size will by default be the same as the input image. This
2317means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002318the 'distorted space', those parts is clipped and lost. However if you use
2319the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2320will attempt (if possible) to show the whole of the distorted image, while
2321retaining a correct 'virtual canvas' offset, for image layering. This offset
2322may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2323is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002324
2325<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2326option:distort:viewport {geometry_string}</kbd>" setting which will specify
2327the size and the offset of the generated 'viewport' image of the distorted
2328image space.</p>
2329
2330<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2331{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2332that factor without changing the viewed contents of the distorted image. This
2333can be used either for 'super-sampling' the image for a higher quality result,
2334or for panning and zooming around the image (with appropriate viewport
2335changes, or post-distort cropping and resizing). </p>
2336
2337<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2338href="#distort" >-distort</a> to attempt to output the internal coefficients,
2339and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2340and debugging purposes. This many not be available for all distorts. </p>
2341
2342<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2343produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2344and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002345above settings. It is algorithmically slower however, though that may not be
2346the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002347
2348
2349<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002350 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002351</div>
2352
2353<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>
2354
cristyd0bda5e2010-09-21 16:22:45 +00002355<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 +00002356
2357<p>Dithering is turned on by default, to turn it off use the plus form of the
2358setting, <a href="#dither">+dither</a>. This will also also render PostScript
2359without text or graphic aliasing. Disabling dithering often (but not always)
2360leads to faster process, a smaller number of colors, but more cartoon like
2361image coloring. Generally resulting in 'color banding' effects in areas with
2362color gradients. </p>
2363
2364<p>The color reduction operators <a href="#colors">-colors</a>, <a
2365href="#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>
2366
2367<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>
2368
2369
2370<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002371 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002372</div>
2373
2374<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>
2375
2376<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>
2377
2378<p>The shape primitives:</p>
2379
2380<pre class="text">
2381 point x,y
2382 line x0,y0 x1,y1
2383 rectangle x0,y0 x1,y1
2384 roundRectangle x0,y0 x1,y1 wc,hc
2385 arc x0,y0 x1,y1 a0,a1
2386 ellipse x0,y0 rx,ry a0,a1
2387 circle x0,y0 x1,y1
2388 polyline x0,y0 ... xn,yn
2389 polygon x0,y0 ... xn,yn
2390 bezier x0,y0 ... xn,yn
2391 path path specification
2392 image operator x0,y0 w,h filename
2393</pre>
2394
2395<p>The text primitive:</p>
2396
2397<pre class="text">
2398 text x0,y0 string
2399</pre>
2400<p>The text gravity primitive:</p>
2401
2402<pre class="text">
2403 gravity NorthWest, North, NorthEast, West, Center,
2404 East, SouthWest, South, or SouthEast
2405</pre>
2406
2407<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>
2408
2409<p>The transformation primitives:</p>
2410
2411<pre class="text">
2412 rotate degrees
2413 translate dx,dy
2414 scale sx,sy
2415 skewX degrees
2416 skewY degrees
2417</pre>
2418
2419<p>The pixel operation primitives:</p>
2420
2421<pre class="text">
2422 color x0,y0 method
2423 matte x0,y0 method
2424</pre>
2425
2426<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>
2427
2428<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>
2429
2430<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2431
2432<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2433
2434<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>
2435
2436<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2437
2438<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>
2439
2440<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>
2441
2442<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>.
2443</p>
2444
2445<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2446
2447<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2448
2449<p class="crtsnip">
2450 -draw 'circle 100,100 150,150'
2451</p>
2452
2453<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
2454draw 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>
2455
2456<p class="crtsnip">
2457 -draw 'bezier 20,50 45,100 45,0 70,50'
2458</p>
2459<p class="crtsnip">
2460 -draw 'bezier 70,50 95,100 95,0 120,50'
2461</p>
2462
2463
2464<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>
2465
2466<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>
2467
2468<p class="crtsnip">
2469 -draw 'image SrcOver 100,100 225,225 image.jpg'
2470</p>
2471
cristybc9539a2010-08-16 18:06:20 +00002472<p>You can use 0,0 for the image size, which means to use the actual
2473dimensions found in the image header. Otherwise, it is scaled to the given
2474dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
2475a detailed discussion of alpha composition methods that are available. </p>
cristy3ed852e2009-09-05 21:47:34 +00002476
2477<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>
2478
2479<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2480
2481<p class="crtsnip">
2482 -draw 'text 100,100 "Works like magick!"'
2483</p>
2484
2485<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2486
2487<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>
2488
2489<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2490
2491<p>The <kbd>scale</kbd> primitive scales them.</p>
2492
2493<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>
2494
2495<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
2496matrix.</p>
2497
2498<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>
2499
2500<pre class="text">
2501 point
2502 replace
2503 floodfill
2504 filltoborder
2505 reset
2506</pre>
2507
2508<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>
2509
2510<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>
2511
2512<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>
2513
2514<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2515
2516<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2517
2518
2519<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002520 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002521</div>
2522
2523<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>
2524
2525<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002526 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002527</div>
2528
2529<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>
2530
2531<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002532 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002533</div>
2534
2535<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>
2536
2537<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2538
2539<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2540
cristyd0bda5e2010-09-21 16:22:45 +00002541
2542
cristy3ed852e2009-09-05 21:47:34 +00002543<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002544 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002545</div>
2546
2547<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>
2548
2549<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>
2550
2551<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002552 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002553</div>
2554
2555<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>
2556
2557<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2558
2559<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2560
2561
2562<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002563 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002564</div>
2565
2566<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>
2567
2568
2569<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002570 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002571</div>
2572
2573<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>
2574
2575<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>
2576
2577<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2578
2579<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>
2580
2581<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002582 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</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%'>Alter channel pixels by evaluating an arithmetic, relational, or logical expression.</td><td style='text-align:right;'></td></tr></table>
2586
2587<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>
2588
2589<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>
2590
2591<table class="doc">
2592 <col width="25%" />
2593 <col width="75%" />
2594 <thead>
2595 <tr>
2596 <th><em class="arg">operator</em></th>
2597 <th>Summary (see further below for details)</th>
2598 </tr>
2599 </thead>
2600 <tbody>
2601
cristy3c98a4f2010-08-13 20:09:41 +00002602 <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 +00002603 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2604 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2605 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2606 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2607 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002608 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2609 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002610 <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>
2611 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2612 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002613 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002614 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002615 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2616 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2617 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2618 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2619 <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>
2620 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2621 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2622 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2623 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2624
2625 <tr><td>&nbsp;</td></tr>
2626
2627 <tr><td>Gaussian-noise</td></tr>
2628 <tr><td>Impulse-noise</td></tr>
2629 <tr><td>Laplacian-noise</td></tr>
2630 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2631 <tr><td>PoissonNoise</td></tr>
2632 <tr><td>Uniform-noise</td></tr>
2633
2634 <tr><td>&nbsp;</td></tr>
2635
2636 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2637 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2638 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2639 </tbody>
2640 </table>
2641
2642<p>The specified functions are applied only to each previously set <a
2643href="#channel" >-channel</a> in the image. If necessary, the results of the
2644calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2645class="QR">QuantumRange</em>]. The transparency channel of the image is
2646represented as a 'alpha' values (0 = fully transparent), so, for example, a
2647<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2648semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2649as a percentage of the <em class="QR">QuantumRange</em>.</p>
2650
2651<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2652<a href="#list">-list evaluate</a>.</p>
2653
2654<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2655<kbd>Multiply</kbd> methods can also be achieved using either the <a
2656href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2657appropriate argument, to linearly modify the overall range of color values.
2658Please note, however, that <a href="#level" >-level</a> treats transparency as
2659'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2660'alpha' values.</p>
2661
2662<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>
2663
cristyce66ab12010-10-21 23:36:32 +00002664<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>
2665
2666 <div style="text-align:center;">
2667 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2668 </div>
2669
2670<p> If the input image is squared, for example, using <a
2671href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2672
cristy3ed852e2009-09-05 21:47:34 +00002673<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>
2674
2675 <div style="text-align:center;">
2676 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2677 </div>
2678
2679<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2680normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2681href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2682to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2683with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2684with <kbd>Pow</kbd>.</p>
2685
2686<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2687converts the image values into a value according to a (co)sine wave function.
2688The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2689is biased 50% and normalized by 50% so as to fit in the respective color value
2690range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2691function (its frequency), and thus determines the number of 'waves' that will
2692be generated over the input color range. For example, if the <em
2693class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2694class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2695then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002696class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002697
2698 <div style="text-align:center;">
2699 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2700 </div>
2701
cristydcca3fa2010-12-29 21:50:07 +00002702<p>See also the <a href="#function" >-function</a> operator, which is a
2703multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002704
cristy63fed272010-03-07 19:08:45 +00002705<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002706 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002707</div>
2708
2709<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 +00002710
2711<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002712 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002713</div>
2714
2715<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>
2716
cristy3e2860c2010-01-24 01:36:30 +00002717<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 +00002718<p>This command reduces or expands a JPEG image to fit on an 800x600
2719display. If the aspect ratio of the input image isn't exactly 4:3, then the
2720image is centered on an 800x600 black canvas: </p>
2721
2722<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>
2723
cristy3ed852e2009-09-05 21:47:34 +00002724
2725<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>
2726
2727<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002728 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002729</div>
2730
2731<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>
2732
2733<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2734
cristy4949d522010-03-12 18:41:34 +00002735<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 +00002736
cristy4949d522010-03-12 18:41:34 +00002737<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 +00002738<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002739equivalent to:</p>
2740
2741<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>
2742<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>
2743
2744<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002745 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002746</div>
2747
2748<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>
2749
2750<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).
2751</p>
2752
2753<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>.
2754</p>
2755
2756<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002757 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002758</div>
2759
2760<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>
2761
2762<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002763 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002764</div>
2765
2766<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>
2767
cristydcca3fa2010-12-29 21:50:07 +00002768<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 +00002769
cristydcca3fa2010-12-29 21:50:07 +00002770<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 +00002771
2772<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>
2773
2774<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2775<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>
2776
2777<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2778<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>
2779
cristyd0bd44a2010-09-24 12:38:11 +00002780<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 +00002781
2782<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>
2783
2784<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2785 -evaluate log 1000 fft_image_spectrum.png</span></p>
2786<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>
2787
cristydcca3fa2010-12-29 21:50:07 +00002788<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 +00002789
2790<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>
2791
2792<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>
2793
cristydcca3fa2010-12-29 21:50:07 +00002794<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 +00002795
2796<p>See the discussion on HDRI implementations of ImageMagick on the page
2797<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.
2798</p>
2799
2800
2801<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002802 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002803</div>
2804
2805<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>color to use when filling a graphic primitive.</td><td style='text-align:right;'></td></tr></table>
2806
2807<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>
2808
2809<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2810
2811<p>For example,</p>
2812
2813<p class="crtsnip">
2814 -fill blue
2815</p>
2816<p class="crtsnip">
2817 -fill "#ddddff"
2818</p>
2819<p class="crtsnip">
2820 -fill "rgb(255,255,255)"
2821</p>
2822
2823<p>See <a href="#draw">-draw</a> for further details.</p>
2824
2825<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2826
2827<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002828 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002829</div>
2830
cristyd0bda5e2010-09-21 16:22:45 +00002831<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
2832distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002833
cristyd0bda5e2010-09-21 16:22:45 +00002834<p>Use this option to affect the resizing operation of an image during
2835operations such as <a href="#resize">-resize</a> and <a href="#distort"
2836>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002837
2838<pre class="text">
2839 Point Hermite Cubic
2840 Box Gaussian Catrom
2841 Triangle Quadratic Mitchell
2842</pre>
2843
cristyd0bda5e2010-09-21 16:22:45 +00002844<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002845as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2846generally useless on their own as they are infinite filters that are being
2847clipped to the filters support size. Their direct use is not recommended
2848except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002849
cristydcca3fa2010-12-29 21:50:07 +00002850<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002851function that the <a href="#filter" >-filter</a> setting defines. That is
2852using these functions will define a 'Windowed' filter, appropriate to the
2853operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002854
2855<pre class="text">
2856 Lanczos Hamming Parzen
2857 Blackman Kaiser Welsh
2858 Hanning Bartlett Bohman
2859</pre>
2860
2861<p>Also one special self-windowing filter is also provided
2862<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2863on the current 'support' or 'lobes' expert settings (see below).</p>
2864
cristyd0bda5e2010-09-21 16:22:45 +00002865<p>If you do not select a filter with this option, the filter defaults to
2866<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2867if the image is enlarged. Otherwise the filter default to
2868<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002869
cristyd0bda5e2010-09-21 16:22:45 +00002870<p>To print a complete list of resize filters, use the <a href="#list">-list
2871filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002872
2873<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002874use of these expert settings (see also <a href="#define" >-define</a> and <a
2875href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002876
2877<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002878<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002879<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002880 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2881 Gaussian-like filters simple filters, or you may not get the expected
2882 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002883
cristyd0bda5e2010-09-21 16:22:45 +00002884<dt>-define filter:support=<em>radius</em></dt>
2885<dd>Set the filter support radius. Defines how large the filter should be and
2886 thus directly defines how slow the filtered resampling process is. All
2887 filters have a default 'prefered' support size. Some filters like
2888 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2889 this value. With simple filters this value either does nothing (but slow
2890 the resampling), or will clip the filter function in a detrimental way.
2891 </dd>
cristy3ed852e2009-09-05 21:47:34 +00002892
cristyd0bda5e2010-09-21 16:22:45 +00002893<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002894<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00002895 alternative way of specifying the 'support' range of the filter, that is
2896 designed to be more suited to windowed filters, especially when used for
2897 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002898
cristyd0bda5e2010-09-21 16:22:45 +00002899<dt>-define filter:b=<em>b-spline_factor</em></dt>
2900<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002901<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2902 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2903 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2904 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00002905 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00002906 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002907
cristyd0bda5e2010-09-21 16:22:45 +00002908<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002909<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00002910 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00002911 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00002912 'Bessel' functions. If defined, no windowing function is used, unless the
2913 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002914
cristyd0bda5e2010-09-21 16:22:45 +00002915<dt>-define filter:window=<em>filter_function</em></dt>
2916<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
2917 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
2918 support range) with the given filter. This allows you to specify a filter
2919 function that is not normally used as a windowing function, such as
2920 <kbd>Box</kbd>, (which effectively turns off the windowing function),
2921 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
2922 </dd>
2923
2924<dt>-define filter:verbose=<em>1</em></dt>
2925<dd>This causes IM to print information on the final internal filter
2926 selection to standard output. This includes a commented header on the
2927 filter settings being used, and data allowing the filter weights to be
2928 easily graphed. </dd>
2929
2930<dd>Note however that some filters are internally defined in terms of other
2931 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
2932 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
2933 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
2934 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002935
2936</dl>
2937
cristyd0bda5e2010-09-21 16:22:45 +00002938<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00002939
2940<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
2941 -set filter:window=bessel -set filter:lobes=8 \ <br/>
2942 -resize 150% image.jpg</span></p>
2943<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
2944
2945<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
2946 -resize 150% image.jpg</span></p>
2947<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00002948filters, and 'verbose' for viewing the internal filter selection), are
2949provided for image processing experts who have studied and understood how
2950resize filters work. Without this knowledge, and an understanding of the
2951definition of the actual filters involved, using expert settings are more
2952likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00002953
2954
2955<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002956 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00002957</div>
2958
2959<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>
2960
2961
2962<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002963 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00002964</div>
2965
2966<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>
2967
2968<p>reflect the scanlines in the vertical direction.</p>
2969
2970<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002971 <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 +00002972</div>
2973
2974<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>
2975
2976<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002977 <h4><a id="flop"></a>-flop</h4>
cristy3ed852e2009-09-05 21:47:34 +00002978</div>
2979
2980<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>
2981
2982<p>reflect the scanlines in the horizontal direction.</p>
2983
2984
2985<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002986 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002987</div>
2988
2989<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>
2990
2991<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>
2992
2993<p>In addition to the fonts specified by the above pre-defined list, you can
2994also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
2995is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
2996<kbd>x:fixed</kbd> is X11 font.</p>
2997
2998<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>
2999
3000
3001<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003002 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003003</div>
3004
3005<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>
3006
3007<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3008
3009<p>The default foreground color is black.</p>
3010
3011<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003012 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003013</div>
3014
3015<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>
3016
3017<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>
3018
3019<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>
3020
3021<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003022 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003023</div>
3024
3025<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>
3026
3027<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>
3028
3029<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003030 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003031</div>
3032
3033<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Surround the image with a border or beveled frame.</td><td style='text-align:right;'></td></tr></table>
3034
cristybc9539a2010-08-16 18:06:20 +00003035<p>The color of the border is specified with the <a href="#mattecolor"
3036>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003037
cristybc9539a2010-08-16 18:06:20 +00003038<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
3039class="arg">geometry</em> argument indicates the amount of extra width and
3040height that is added to the dimensions of the image. If no offsets are given
3041in the <em class="arg">geometry</em> argument, then the border added is
3042a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3043the width and height of the border is partitioned to form an outer bevel of
3044thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3045<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3046</p>
3047
3048<p>The <a href="#frame">-frame</a> option is affected by the current <a
3049href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003050'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003051size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3052draws the frame of four distinct colors close to the current <a
3053href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3054center of this image. This means that with the default compose method of
3055'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3056href="#bordercolor">-bordercolor</a> setting.</p>
3057
3058<p>The image composition is not
3059affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003060
3061
3062<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003063 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003064</div>
3065
3066<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>
3067
3068<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003069 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003070</div>
3071
3072<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Apply a function to channel values.</td><td style='text-align:right;'></td></tr></table>
3073
3074<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>
3075
3076<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>
3077
3078<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>
3079
3080<pre class="text">
3081 Polynomial
3082 Sinusoid
3083 Arcsin
3084 Arctan
3085</pre>
3086
3087<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3088
3089<dl class="doc">
3090<dt><kbd>Polynomial</kbd></dt>
3091<dd>
3092<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>
3093
3094<div style="text-align: center">
3095 -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>
3096</div>
3097
3098<p>will invoke a polynomial function given by</p>
3099
3100<div style="text-align: center">
3101 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3102 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3103 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3104</div>
3105
3106<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3107
3108<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>
3109
3110<table class="doc">
3111 <col width="35%" />
3112 <col width="35%" />
3113 <col width="30%" />
3114 <tr>
3115 <td>-evaluate Set <em class="arg">value</em> </td>
3116 <td>-function Polynomial <em class="arg">value</em></td>
3117 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3118 </tr>
3119 <tr>
3120 <td>-evaluate Add <em class="arg">value</em> </td>
3121 <td>-function Polynomial 1,<em class="arg">value</em></td>
3122 </tr>
3123 <tr>
3124 <td>-evaluate Subtract <em class="arg">value</em> </td>
3125 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3126 </tr>
3127 <tr>
3128 <td>-evaluate Multiply <em class="arg">value</em> </td>
3129 <td>-function Polynomial <em class="arg">value</em>,0</td>
3130 </tr>
3131 <tr>
3132 <td>+level black% x white%</td>
3133 <td>-function Polynomial A,B</td>
3134 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3135 </tr>
3136</table>
3137
3138<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>
3139</dd>
3140
3141<dt><kbd>Sinusoid</kbd></dt>
3142<dd>
3143<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>
3144
3145<div style="text-align: center">
3146 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3147</div>
3148
3149<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>
3150
3151<div style="text-align: center">
3152<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>
3153</div>
3154
3155<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>
3156
3157<p class="crtsnip">
3158 -function Sinusoid 3,-90,.2,.7
3159</p>
3160
3161<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>
3162
3163<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>
3164
3165<table class="doc">
3166 <tr>
3167 <td>-evaluate Sin <em class="arg">freq</em> </td>
3168 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3169 </tr>
3170 <tr>
3171 <td>-evaluate Cos <em class="arg">freq</em> </td>
3172 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3173 </tr>
3174</table>
3175</dd>
3176
3177<dt><kbd>ArcSin</kbd></dt>
3178<dd>
3179<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3180and can be used to generate cylindrical distortion and displacement maps.
3181The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003182of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003183
cristydcca3fa2010-12-29 21:50:07 +00003184<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003185 -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 +00003186</p>
cristy3ed852e2009-09-05 21:47:34 +00003187
3188<p>with all values given in terms of noramlize color values (0.0 for black,
31891.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3190for bout input (<em class="arg">width</em>), and output (<em
3191class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3192
cristydcca3fa2010-12-29 21:50:07 +00003193<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003194<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 +00003195</p>
cristy3ed852e2009-09-05 21:47:34 +00003196
3197</dd>
3198
3199<dt><kbd>ArcTan</kbd></dt>
3200<dd>
3201<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3202limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003203All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003204
cristydcca3fa2010-12-29 21:50:07 +00003205<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003206 -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 +00003207</p>
cristy3ed852e2009-09-05 21:47:34 +00003208
3209<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3210</p>
3211
cristydcca3fa2010-12-29 21:50:07 +00003212<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003213<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 +00003214</p>
cristy3ed852e2009-09-05 21:47:34 +00003215
3216</dd>
3217
3218</dl>
3219
3220
3221<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003222 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003223</div>
3224
3225<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>
3226
3227<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>
3228
3229<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>
3230
3231
3232<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003233 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003234</div>
3235
3236<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>
3237
3238<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>
3239
3240<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3241
3242
3243<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003244 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003245</div>
3246
3247<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>
3248
3249<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>
3250
3251<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>
3252
3253<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>
3254
3255<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>
3256
3257<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3258
3259<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003260 <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 +00003261</div>
3262
3263<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>
3264
cristyb15553d2010-07-03 22:53:14 +00003265<p>Convolve the image with a Gaussian or normal distribution using the given
3266<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003267
3268<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3269</div>
3270
cristyb15553d2010-07-03 22:53:14 +00003271<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003272determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003273
3274<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003275array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003276integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003277radius that will provide meaningful results for the Gaussian distribution.
3278</p>
3279
3280<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3281operation is. However too small a <em class="arg" >Radius</em>, and sever
3282aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3283should be at least twice the <em class="arg" >Sigma</em> value, though three
3284times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003285
3286<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003287full 2-dimensional convolution is used to generate the weighted average of the
3288neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003289
3290<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3291pixels which are outside the image proper are blurred into the final result.
3292</p>
3293
3294
3295<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003296 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003297</div>
3298
3299<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>
3300
3301<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>
3302
3303<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003304 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003305</div>
3306
3307<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>
3308
3309<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3310<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3311<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3312list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3313installation.</p>
3314
3315<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>
3316
3317<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>
3318
3319<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>
3320
cristy4949d522010-03-12 18:41:34 +00003321<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 +00003322<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>
3323
3324<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>
3325
3326
3327<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003328 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003329</div>
3330
3331<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>green chromaticity primary point.</td><td style='text-align:right;'></td></tr></table>
3332
3333
3334<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003335 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003336</div>
3337
3338<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>
3339
3340<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3341dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3342can apply any color transformation to the Hald image and then use this option
3343to apply the transform to the image. </p>
3344
3345<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3346<p>This option provides a convenient method for you to use Gimp or Photoshop
3347to make color corrections to the Hald CLUT image and subsequently apply them
3348to multiple images using an ImageMagick script. </p>
3349
3350<p>Note that the representation is only of the normal RGB color space and that
3351the whole color value triplet is used for the interpolated lookup of the
3352represented Hald color cube image. Because of this the operation is not <a
3353href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3354images transparency or alpha/matte channel.</p>
3355
3356<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3357of the individual color channels, usally involving a simplier gray-scale
3358image. E.g: gray-scale to color replacement, or modification by a histogram
3359mapping. </p>
3360
3361
3362<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003363 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003364</div>
3365
3366<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>print usage instructions.</td><td style='text-align:right;'></td></tr></table>
3367
3368<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003369 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003370</div>
3371
3372<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>
3373
3374<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003375 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003376</div>
3377
3378<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>
3379
3380<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>
3381
3382<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>
3383
3384<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003385 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003386</div>
3387
3388<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>
3389
3390<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003391 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003392</div>
3393
3394<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>
3395
3396<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>
3397
3398<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>
3399
cristyd0bda5e2010-09-21 16:22:45 +00003400<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003401amounts of image properties are displayed including image statistics, profiles,
3402image histogram, and others.</p>
3403
3404<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003405 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003406</div>
3407
3408<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>
3409
cristydcca3fa2010-12-29 21:50:07 +00003410<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 +00003411
3412<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>
3413
3414<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3415<p>or</p>
3416
3417<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>
3418
cristydcca3fa2010-12-29 21:50:07 +00003419<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 +00003420
cristydcca3fa2010-12-29 21:50:07 +00003421<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 +00003422
cristydcca3fa2010-12-29 21:50:07 +00003423<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 +00003424
3425<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003426 <h4><a id="immutable"></a>-immutable</h4>
cristy3ed852e2009-09-05 21:47:34 +00003427</div>
3428
3429<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>
3430
3431<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003432 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003433</div>
3434
3435<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>
3436
3437<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003438 <h4><a id="insert"></a>-insert <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003439</div>
3440
3441<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>
3442
3443<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>
3444
3445<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>
3446
3447<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003448 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003449</div>
3450
3451<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>
3452
3453<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>
3454
3455<p>The default intent is undefined.</p>
3456
3457<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3458
3459<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003460 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003461</div>
3462
3463<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>
3464
3465<p>Choose from:</p>
3466
3467<pre class="text">
3468 none
3469 line
3470 plane
3471 partition
3472 JPEG
3473 GIF
3474 PNG
3475</pre>
3476
3477<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>
3478
3479<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3480
3481<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3482
3483<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3484
3485<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3486image.G, and image.B).</p>
3487
3488<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>
3489image.</p>
3490
3491<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3492
3493<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003494 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</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%'>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>
3498
cristyd0bda5e2010-09-21 16:22:45 +00003499<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003500value, you typically fall in between the pixel colors defined by the source
3501image. This setting determines how the color is determined from the colors of
3502the pixels surrounding that point. That is how to determine the color of a
3503point that falls between two, or even four different colored pixels. </p>
3504
3505<pre class="text">
3506 integer: The color of the top-left pixel (floor function)
3507 nearest-neighbor: The nearest pixel to the lookup point (rounded function)
3508 average: The average color of the surrounding four pixels
3509 bilinear A double linear interpolation of pixels (the default)
3510 mesh Divide area into two flat triangular interpolations
3511 bicubic Fitted bicubic-spines of surrounding 16 pixels
3512 spline Direct spline curves (colors are blurred)
3513 filter Use resize <a href="#filter">-filter</a> settings
3514</pre>
3515
3516<p>This most important for distortion operators such as <a href="#distort"
3517>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3518>-transform</a> and <a href="#fx" >-fx</a>. </p>
3519
3520<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3521
3522<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3523lookup for positions outside the boundaries of the image. </p>
3524
3525
3526<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003527 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003528</div>
3529
3530<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>
3531
3532<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003533 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003534</div>
3535
3536<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>
3537
3538<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003539 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003540</div>
3541
3542<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>
3543
3544<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003545 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003546</div>
3547
3548<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>
3549
cristy71a3f602010-09-15 12:38:16 +00003550<p>Use this option to assign a specific label to the image, as it is read in
3551or created. You can use the <a href="#set" >-set</a> operation to re-assign
3552a the labels of images already read in. Image formats such as TIFF, PNG,
3553MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003554
cristy71a3f602010-09-15 12:38:16 +00003555<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3556assigned to an image is used as a header string to print above the postscript
3557image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003558
cristybc9539a2010-08-16 18:06:20 +00003559<p>You can include the image filename, type, width, height, or other image
3560attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3561Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003562
3563<p>For example,</p>
3564
3565<p class="crtsnip">
3566 -label "%m:%f %wx%h" bird.miff
3567</p>
3568
cristy71a3f602010-09-15 12:38:16 +00003569<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3570"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3571is read in. If a <a href="#label">+label</a> option was used instead, any
3572existing label present in the image would be used. You can remove all labels
3573from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003574
cristy71a3f602010-09-15 12:38:16 +00003575<p>A label is not drawn on the image, but is embedded in the image datastream
3576via <em>Label</em> tag or similar mechanism. If you want the label to be
3577visible on the image itself, use the <a href="#draw">-draw</a> option, or
3578during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003579
cristy71a3f602010-09-15 12:38:16 +00003580<p>If the first character of <em class="arg">string</em> is <em
3581class="arg">@</em>, the image label is read from a file titled by the
3582remaining characters in the string. Labels in a file are literal, no embedded
3583formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003584
3585
3586<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003587 <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 +00003588</div>
3589
3590<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>
3591
3592<p>Adaptively threshold each pixel based on the value of pixels in a
3593surrounding window. If the current pixel is lighter than this average plus
3594the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3595black. Small variations in pixel values such as found in scanned documents
3596can be ignored if offset is positive. A negative offset will make it more
3597sensitive to those small variations. </p>
3598
3599<p>This is commonly used to threshold images with an uneven background. It is
3600based on the assumption that average color of the small window is the
3601the local background color, from which to separate the forground color. </p>
3602
3603
3604<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003605 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003606</div>
3607
3608<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>
3609
3610<p>Perform various image operation methods to a ordered sequence of images
3611which may represent either a set of overlaid 'image layers', a GIF disposal
3612animation, or a fully-'coalesced' animation sequence. </p>
3613
3614<table class="doc">
3615 <tbody>
3616 <tr valign="top">
3617 <th align="left" style="width: 8%">Method</th>
3618 <th align="left">Description</th>
3619 </tr>
3620
3621 <tr valign="top">
3622 <td valign="top">compare-any</td>
3623 <td valign="top">Crop the second and later frames to the smallest rectangle
3624 that contains all the differences between the two images. No GIF <a
3625 href="#dispose" >-dispose</a> methods are taken into account. </td>
3626 </tr>
3627
3628 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3629 >-deconstruct</a> operator, and does not preserve animations normal
3630 working, especially when animation used layer disposal methods such as
3631 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3632 </tr>
3633
3634 <tr valign="top">
3635 <td valign="top">compare-clear</td>
3636 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3637 opaque pixels which become transparent in the second frame. That is the
3638 smallest image needed to mask or erase pixels for the next frame. </td>
3639 </tr>
3640
3641 <tr valign="top">
3642 <td valign="top">compare-overlay</td>
3643 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3644 extra color to the next image, as a result of overlaying color pixels.
3645 That is the smallest single overlaid image to add or change colors. </td>
3646 </tr>
3647
3648 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3649 composition method '<kbd>change-mask</kbd>', to reduce the image to
3650 just the pixels that need to be overlaid. </td>
3651 </tr>
3652
3653 <tr valign="top">
3654 <td valign="top">coalesce</td>
3655 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3656 >-coalesce</a> operator. Apply the layer disposal methods set in the
3657 current image sequence to form a fully defined animation sequence, as
3658 it should be displayed. Effectively converting a GIF animation into a
3659 'film strip'-like animation. </td>
3660 </tr>
3661
3662 <tr valign="top">
3663 <td valign="top">composite</td>
3664 <td valign="top">Alpha Composition of two image lists, separated by a
3665 "<kbd>null:</kbd>" image, with the destination image list first, and
3666 the source images last. An image from each list are composited
3667 together until one list is finished. The separator image and source
3668 image lists are removed. </td>
3669 </tr>
3670
3671
cristybac7a162010-06-15 19:57:29 +00003672 <tr><td></td>
3673 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3674 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3675 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003676 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003677 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003678
cristybac7a162010-06-15 19:57:29 +00003679 <tr><td></td>
3680 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003681 applied to all the images in the other image list, regardless of which
3682 list it is. In this case it is the image meta-data of the list which
3683 preserved. </td>
3684 </tr>
3685
3686
3687 <tr valign="top">
3688 <td valign="top">dispose</td>
3689 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3690 the animation after the layer disposal method has been applied, before
3691 the next sub-frame image is overlaid. That is the 'dispose' image that
3692 results from the application of the GIF <a href="#dispose"
3693 >-dispose</a> method. This allows you to check what
3694 is going wrong with a particular animation you may be developing.
3695 </td>
3696 </tr>
3697
3698 <tr valign="top">
3699 <td valign="top">flatten</td>
3700 <td valign="top">Create a canvas the size of the first images virtual
3701 canvas using the current <a href="#background" >-background</a> color,
3702 and <a href="#compose" >-compose</a> each image in turn onto that
3703 canvas. Images falling outside that canvas is clipped. Final
3704 image will have a zero virtual canvas offset. </td>
3705 </tr>
3706
cristybac7a162010-06-15 19:57:29 +00003707 <tr><td></td>
3708 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003709 overlaying all the prepared image layers into a final image. </td>
3710 </tr>
3711
cristybac7a162010-06-15 19:57:29 +00003712 <tr><td></td>
3713 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003714 canvas with real pixels, or to underlay a opaque color to remove
3715 transparency from an image.</td>
3716 </tr>
3717
3718
3719 <tr valign="top">
3720 <td valign="top">merge</td>
3721 <td valign="top">As 'flatten' method but merging all the given image
3722 layers into a new layer image just large enough to hold all the image
3723 without clipping or extra space. The new images virtual offset will
3724 prevere the position of the new layer, even if this offset is
3725 negative. the virtual canvas size of the first image is preserved.
3726 </td>
3727 </tr>
3728
3729 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3730 as few image file formats handle them correctly. </td>
3731 </tr>
3732
3733 <tr valign="top">
3734 <td valign="top">mosaic</td>
3735 <td valign="top">As 'flatten' method but expanding the initial canvas size
3736 of the first image so as to hold all the image layers. However as a
cristyd0bda5e2010-09-21 16:22:45 +00003737 virtual canvas is 'locked' to the origin, by definition, image layers
cristy3ed852e2009-09-05 21:47:34 +00003738 with a negative offsets will still be clipped by the top and left
3739 edges.</td>
3740 </tr>
3741
3742 <tr><td></td><td>This method is commonly used to layout individual image using various
cristyd0bda5e2010-09-21 16:22:45 +00003743 offset but without knowing the final canvas size. The resulting image
cristy3ed852e2009-09-05 21:47:34 +00003744 will, like 'flatten' not have any virtual offset, so can be saved to
3745 any image file format. </td>
3746 </tr>
3747
3748
3749 <tr valign="top">
3750 <td valign="top">optimize</td>
3751 <td valign="top">Optimize a coalesced animation, into GIF animation using
3752 a number of general techniques. This currently a short cut to
3753 apply both the '<kbd>optimize-frame</kbd>', and
3754 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3755 include other optimization methods as they are developed. </td>
3756 </tr>
3757
3758 <tr valign="top">
3759 <td valign="top">optimize-frame</td>
3760 <td valign="top">Optimize a coalesced animation, into GIF animation by
3761 reducing the number of pixels per frame as much as possible by
3762 attempting to pick the best layer disposal method to use, while ensuring
3763 the result will continue to animate properly. </td>
3764 </tr>
3765
3766 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3767 then no reasonably fast GIF optimization algorithm can do this.
3768 However this does seem to do better than most other GIF frame
3769 optimizers seen. </td>
3770 </tr>
3771
3772 <tr valign="top">
3773 <td valign="top">optimize-plus</td>
3774 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3775 overall optimization by adding extra frames to the animation, without
3776 changing the final look or timing of the animation. The frames are
3777 added to attempt to separate the clearing of pixels from the
3778 overlaying of new additional pixels from one animation frame to the
3779 next. If this does not improve the optimization (for the next frame
3780 only), it will fall back to the results of the previous normal
3781 '<kbd>optimize-frame</kbd>' technique. </td>
3782 </tr>
3783
3784 <tr><td></td><td>There is the possibility that the change in the disposal style will
3785 result in a worsening in the optimization of later frames, though this
3786 is unlikely. In other words there no guarantee that it is better than
3787 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
cristyd0bda5e2010-09-21 16:22:45 +00003788 however you can get a vast improvement in the final animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003789 </tr>
3790
3791 <tr valign="top">
3792 <td valign="top">optimize-transparency</td>
3793 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3794 overlay images with transparency, if it does not change the resulting
3795 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3796 </td>
3797 </tr>
3798
3799 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3800 into a smaller file size due to larger areas of one (transparent)
3801 color rather than a pattern of multiple colors repeating the current
3802 disposed image of the last frame. </td>
3803 </tr>
3804
3805 <tr valign="top">
3806 <td valign="top">remove-dups</td>
3807 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3808 images, so as to simplify layer overlays of coalesced animations.
3809 </td>
3810 </tr>
3811
3812 <tr><td></td><td>Usually this a result of using a constant time delay across the
3813 whole animation, or after a larger animation was split into smaller
3814 sub-animations. The duplicate frames could also have been used as
3815 part of some frame optimization methods. </td>
3816 </tr>
3817
3818 <tr valign="top">
3819 <td valign="top">remove-zero</td>
3820 <td valign="top">Remove any image with a zero time delay, unless ALL the
3821 images have a zero time delay (and is not a proper timed animation, a
3822 warning is then issued). </td>
3823 </tr>
3824
3825 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3826 partial intermediary updates between the frames that are actually
3827 displayed to users. These frames are usally added for improved frame
3828 optimization in GIF animations. </td>
3829 </tr>
3830
3831 <tr valign="top">
3832 <td valign="top">trim-bounds</td>
3833 <td valign="top">Find the bounds of all the images in the current
3834 image sequence, then adjust the offsets so all images are contained on
3835 a minimal positive canvas. None of the image data is modified, only
3836 there virtual canvas size and offset. The all the image is given
3837 the same canvas size, and and will have a positive offset, but will
3838 remain in the same position relative to each other. As a result of the
3839 minimal canvas size at least one image will touch every edge of that
3840 canvas. The image data however may be transparent.
3841 </td>
3842 </tr>
3843
3844 </tbody>
3845</table>
3846
3847<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3848
3849<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3850>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3851>-mosaic</a> are only aliases for the above methods. Also see <a
3852href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3853href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3854>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3855
3856
3857<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003858 <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 +00003859</div>
3860
3861<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>
3862
3863<p>Given one, two or three values delimited with commas: black-point,
3864white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3865white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3866point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3867contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3868both black and white points are percentages of the full color range. Gamma
3869will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3870omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3871
3872<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3873the given '<kbd>black_point</kbd>' value in the original image is set to
3874zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3875<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3876to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3877adjusted. </p>
3878
3879<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3880adding the special '!' flag anywhere in the argument list, will cause the
3881operator to do the reverse of the level adjustment. That is a zero, or
3882<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
3883adjusted to the given level values, allowing you to de-contrast, or compress
3884the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
3885
3886<p>Only the channels defined by the current <a href="#channel">-channel</a>
3887setting are adjusted (defaults to RGB color channels only), allowing you to
3888limit the effect of this operator. </p>
3889
3890<p>Please note that the transparency channel is treated as 'matte'
3891values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
3892
3893
3894<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003895 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00003896 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
3897</div>
3898
cristyd0bda5e2010-09-21 16:22:45 +00003899<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 +00003900
3901<p>This function is exactly like <a href="#level">-level</a>, except that the
3902value value for each color channel is determined by the
3903'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
3904described under the <a href="#fill">-fill</a> option). </p>
3905
cristyd0bda5e2010-09-21 16:22:45 +00003906<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
3907is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00003908colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00003909adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00003910
3911<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
3912will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00003913respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00003914those colors. This can also be used to convert a plain gray-scale image into a
3915one using the gradient of colors specified. </p>
3916
3917<p>By supplying a single color with a comma separator either before or after
3918that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00003919respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00003920used for both the black and white color points, making the operator either
3921threshold the images around that color (- form) or set all colors to that
3922color (+ form). </p>
3923
3924
3925<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003926 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003927</div>
3928
3929<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>
3930
3931<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>
3932
cristy6b636652009-12-05 17:16:11 +00003933<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 +00003934
3935<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00003936 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00003937</p>
3938
3939<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
3940
cristydcca3fa2010-12-29 21:50:07 +00003941<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list resource</span><span class='crtout'></span></p><pre class="text">
3942File Area Memory Map Disk Thread Time
cristy6b636652009-12-05 17:16:11 +00003943------------------------------------------------------------------------------
cristydcca3fa2010-12-29 21:50:07 +00003944 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
3945</pre>
3946
cristy3ed852e2009-09-05 21:47:34 +00003947<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>
3948
3949<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>
3950
3951<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>
3952
3953<p class="crtsnip">
3954-limit area 10mb
3955</p>
3956
cristyd0bda5e2010-09-21 16:22:45 +00003957<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 +00003958
3959<p class="crtsnip">
3960-limit area 10mb -limit disk 500mb
3961</p>
3962
3963<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
3964
3965<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>
3966
3967<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.
3968</p>
3969
3970<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.
3971</p>
3972
3973<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003974 <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 +00003975</div>
3976
3977<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>
3978
cristyd934d102009-10-10 12:55:13 +00003979<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
3980and uses a 'histogram bin' to determine the range of color values that needs to
3981be stretched. However it then stretchs those colors using the <a
3982href="#level" >-level</a> operator.</p>
3983
3984<p>As such while the initial determination may have 'binning' round off
3985effects, the image colors are stretched mathematically, rather than using the
3986histogram bins. This makes the operator more accurate. </p>
3987
3988<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
3989'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
3990perfect stretch of the color range. </p>
3991
3992<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
3993normalization of mathematical images. </p>
3994
3995<p>This operator is under review for re-development. </p>
3996
3997
cristy3ed852e2009-09-05 21:47:34 +00003998<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003999 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00004000</div>
4001
4002<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>
4003
4004<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004005 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004006</div>
4007
4008<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>
4009
4010<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>
4011
4012<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004013 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004014</div>
4015
4016<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>
4017
4018<pre class="text">
cristyc1aee832010-05-08 00:36:47 +00004019 Align
4020 Alpha
4021 Boolean
4022 Channel
4023 Class
4024 ClipPath
4025 Coder
4026 Color
4027 Colorspace
4028 Command
4029 Compose
4030 Compress
4031 Configure
4032 DataType
4033 Debug
4034 Decoration
4035 Delegate
4036 Direction
4037 Dispose
4038 Distort
4039 Dither
4040 Endian
4041 Evaluate
4042 FillRule
4043 Filter
4044 Font
4045 Format
4046 Function
4047 Gravity
4048 ImageList
4049 Intent
4050 Interlace
4051 Interpolate
4052 Kernel
cristy787d4352010-03-06 13:55:58 +00004053 Layers
4054 LineCap
4055 LineJoin
4056 List
4057 Locale
4058 LogEvent
4059 Log
4060 Magic
4061 Method
4062 Metric
4063 Mime
4064 Mode
4065 Morphology
4066 Module
4067 Noise
4068 Orientation
4069 Policy
4070 PolicyDomain
4071 PolicyRights
4072 Preview
4073 Primitive
4074 QuantumFormat
4075 Resource
4076 SparseColor
4077 Storage
4078 Stretch
4079 Style
4080 Threshold
4081 Type
4082 Units
4083 Validate
4084 VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004085</pre>
4086
cristybac7a162010-06-15 19:57:29 +00004087<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4088list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4089available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004090
4091<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4092<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004093 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004094</div>
4095
4096<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>
4097
cristybac7a162010-06-15 19:57:29 +00004098<p>This option specifies the format for the log printed when the <a
4099href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004100
cristybac7a162010-06-15 19:57:29 +00004101<p>You can display the following components by embedding special format
4102characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004103
4104<pre class="text">
4105 %d domain
4106 %e event
4107 %f function
4108 %l line
4109 %m module
4110 %p process ID
4111 %r real CPU time
4112 %t wall clock time
4113 %u user CPU time
4114 %% percent sign
4115 \n newline
4116 \r carriage return
4117</pre>
4118
4119<p>For example:</p>
4120
4121<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>
4122<p>The default behavior is to print all of the components.</p>
4123
4124<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004125 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004126</div>
4127
4128<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>
4129
cristybac7a162010-06-15 19:57:29 +00004130<p>Set iterations to zero to repeat the animation an infinite number of times,
4131otherwise the animation repeats itself up to <em class="arg">iterations</em>
4132times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004133
4134<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004135 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004136</div>
4137
4138<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>
4139
4140<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004141 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004142</div>
4143
4144<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>
4145
4146
4147<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004148 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004149</div>
4150
4151<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
4152
4153<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4154
4155<pre class="text">
4156 best
4157 default
4158 gray
4159 red
4160 green
4161 blue
4162</pre>
4163
cristybac7a162010-06-15 19:57:29 +00004164<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4165Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4166the type and <kbd>display</kbd> searches the list of colormap types in
4167<kbd>top-to-bottom</kbd> order until one is located. See <em
4168class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004169
4170
4171<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004172 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004173</div>
4174
4175<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>
4176
4177<p>Here are the valid components of a map:</p>
4178
4179<pre class="text">
4180 r red pixel component
4181 g green pixel component
4182 b blue pixel component
4183 a alpha pixel component (0 is transparent)
4184 o opacity pixel component (0 is opaque)
4185 i grayscale intensity pixel component
4186 c cyan pixel component
4187 m magenta pixel component
4188 y yellow pixel component
4189 k black pixel component
4190 p pad component (always 0)
4191</pre>
4192
cristybac7a162010-06-15 19:57:29 +00004193<p>You can specify as many of these components as needed in any order (e.g.
4194bgr). The components can repeat as well (e.g. rgbr).</p>
4195
cristy3ed852e2009-09-05 21:47:34 +00004196
4197<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004198 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004199<em class="arg">filename</em></h4>
4200</div>
4201
4202<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>
4203
4204<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
4205
4206<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004207 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004208</div>
4209
4210<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>
4211
4212<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4213
cristybac7a162010-06-15 19:57:29 +00004214<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4215style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004216
4217<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004218 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004219</div>
4220
4221<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>
4222
4223<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004224 <h4><a id="median"></a>-median <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004225</div>
4226
4227<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>apply a median filter to the image.</td><td style='text-align:right;'></td></tr></table>
4228
4229<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004230 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004231</div>
4232
4233<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>
4234
4235<p>Choose from:</p>
4236
4237<pre class="text">
cristybac7a162010-06-15 19:57:29 +00004238 AE absolute error count, number of different pixels (-fuzz effected)
cristya20e3f92010-12-13 01:52:32 +00004239 FUZZ mean color distance
cristybac7a162010-06-15 19:57:29 +00004240 MAE mean absolute error (normalized), average channel error distance
4241 MEPP mean error per pixel (normalized mean error, normalized peak error)
4242 MSE mean error squared, average of the channel error squared
cristya20e3f92010-12-13 01:52:32 +00004243 NCC normalized cross correlation
cristybac7a162010-06-15 19:57:29 +00004244 PAE peak absolute (normalize peak absolute)
4245 PSNR peak signal to noise ratio
4246 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004247</pre>
4248
cristy771f7a72010-11-27 21:42:59 +00004249<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4250with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4251only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004252size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004253'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004254for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004255
4256<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4257('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004258normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004259
cristybac7a162010-06-15 19:57:29 +00004260<p>To print a complete list of metrics, use the <a href="#list">-list
4261metrics</a> option.</p>
4262
cristy3ed852e2009-09-05 21:47:34 +00004263
cristyd2baf7d2010-03-06 04:26:44 +00004264<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004265 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004266</div>
4267
4268<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>
4269
cristy3ed852e2009-09-05 21:47:34 +00004270
4271<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004272 <h4><a id="mode"></a>-mode <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004273</div>
4274
4275<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>
4276
cristybac7a162010-06-15 19:57:29 +00004277<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4278Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004279
cristybac7a162010-06-15 19:57:29 +00004280<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4281for a list of <a href="#mode" >-mode</a> arguments available in your
4282ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004283
4284
4285<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004286 <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 +00004287</div>
4288
cristybac7a162010-06-15 19:57:29 +00004289<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
4290class="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 +00004291
cristyb36feb22010-03-26 16:54:37 +00004292<p>The arguments are given as a percentages of variation. A value of 100 means
4293no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004294
cristyb36feb22010-03-26 16:54:37 +00004295<p>The <em class="arg">brightness</em> is a multiplier of the overall
4296brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4297twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4298before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004299
cristyb36feb22010-03-26 16:54:37 +00004300<p>The <em class="arg">saturation</em> controls the amount of color in an
4301image. For example, 0 produce a grayscale image, while a large value such as
4302200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004303
cristyb36feb22010-03-26 16:54:37 +00004304<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4305within the image by the amount specified. For example, 50 results in
4306a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4307A value of either 0 or 200 results in a complete 180 degree rotation of the
4308image. Using a value of 300 is a 360 degree rotation resulting in no change to
4309the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004310
cristyb36feb22010-03-26 16:54:37 +00004311<p>For example, to increase the color brightness by 20% and decrease the color
4312saturation by 10% and leave the hue unchanged, use <a
4313href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004314
cristyb36feb22010-03-26 16:54:37 +00004315<p>Use <a href="#set">-set</a> attribute of '<kbd
4316class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4317modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4318<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004319
4320<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 +00004321
cristy3ed852e2009-09-05 21:47:34 +00004322<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004323 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004324</div>
4325
4326<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>monitor progress.</td><td style='text-align:right;'></td></tr></table>
4327
4328
4329<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004330 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004331</div>
4332
4333<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>transform the image to black and white.</td><td style='text-align:right;'></td></tr></table>
4334
4335
4336<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004337 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004338</div>
4339
4340<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>
4341
4342<p>Both the image pixels and size are linearly interpolated to give the
4343appearance of a meta-morphosis from one image to the next, over all the images
4344in the current image list. The added images are the equivalent of a <a
4345href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4346argument determine how many images to interpolate between each image. </p>
4347
4348
4349<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004350 <h4><a id="morphology"></a>-morphology</h4>
4351 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004352</div>
4353
cristy2c839602010-04-03 02:32:08 +00004354<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 +00004355
cristydcca3fa2010-12-29 21:50:07 +00004356<p>Until I get around to writing a option summary for this, see <a
4357href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4358Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004359
4360
cristy488844c2010-01-22 14:02:05 +00004361<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004362 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004363</div>
4364
4365<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>
4366
4367
4368<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004369 <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 +00004370</div>
4371
4372<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>
4373
4374<p>Blur with the given radius, standard deviation (sigma), and angle. The
4375angle given is the angle toward which the image is blurred. That is the
4376direction people would consider the object is coming from. </p>
4377
4378<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004379definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004380
4381<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4382pixels which are outside the image proper are blurred into the final result.
4383</p>
4384
4385<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004386 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004387</div>
4388
4389<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>name an image.</td><td style='text-align:right;'></td></tr></table>
4390<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004391 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004392</div>
4393
cristyb29bc032010-02-01 20:29:43 +00004394<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 +00004395
4396<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>
4397
4398<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004399 <h4><a id="noise"></a>-noise <em class="arg">radius</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004400 +noise <em class="arg">type</em></h4>
4401</div>
4402
4403<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>
4404
4405<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>
4406
4407<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>
4408
4409<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>
4410
4411<pre class="text">
4412Gaussian
4413Impulse
4414Laplacian
4415Multiplicative
4416Poisson
4417Random
4418Uniform
4419</pre>
4420
4421<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4422
cristy83543962009-10-16 19:04:28 +00004423<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4424the use of a controlling value to specify teh amount of noise that should be
4425added to an image. </p>
4426
cristy3ed852e2009-09-05 21:47:34 +00004427
4428<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004429 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004430</div>
4431
4432<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>
4433
cristyd934d102009-10-10 12:55:13 +00004434<p>The intensity values are stretched to cover the entire range of possible
4435values. While doing so, black-out at most <em>2%</em> of the pixels and
4436white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004437
cristyd934d102009-10-10 12:55:13 +00004438<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4439is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4440(Before this version, it was equivalent to <a href="#contrast-stretch"
4441>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004442
cristyd934d102009-10-10 12:55:13 +00004443<p>All the channels are normalized in concert by the came amount so as to
4444preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004445setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004446setting will normalize the RGB channels independently.</p>
4447
cristydcca3fa2010-12-29 21:50:07 +00004448<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004449Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004450that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004451
4452<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004453
4454
4455<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004456 <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 +00004457</div>
4458
cristyd934d102009-10-10 12:55:13 +00004459<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
4460class="arg">threshold map</em> specified, and a uniform color map with the
4461given 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 +00004462
4463<p>You can choose from these standard threshold maps:</p>
4464
4465<pre class="text">
cristya6d7cf72010-11-07 15:58:34 +00004466threshold 1x1 Threshold 1x1 (non-dither)
4467checks 2x1 Checkerboard 2x1 (dither)
4468o2x2 2x2 Ordered 2x2 (dispersed)
4469o3x3 3x3 Ordered 3x3 (dispersed)
4470o4x4 4x4 Ordered 4x4 (dispersed)
4471o8x8 8x8 Ordered 8x8 (dispersed)
4472h4x4a 4x1 Halftone 4x4 (angled)
4473h6x6a 6x1 Halftone 6x6 (angled)
4474h8x8a 8x1 Halftone 8x8 (angled)
4475h4x4o Halftone 4x4 (orthogonal)
4476h6x6o Halftone 6x6 (orthogonal)
4477h8x8o Halftone 8x8 (orthogonal)
4478h16x16o Halftone 16x16 (orthogonal)
4479c5x5b c5x5 Circles 5x5 (black)
4480c5x5w Circles 5x5 (white)
4481c6x6b c6x6 Circles 6x6 (black)
4482c6x6w Circles 6x6 (white)
4483c7x7b c7x7 Circles 7x7 (black)
4484c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004485</pre>
4486
cristyde368992010-11-05 14:32:14 +00004487<p> The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
cristyd934d102009-10-10 12:55:13 +00004488pattern. Or you can define your own <em class="arg" >threshold map</em> in a
cristyde368992010-11-05 14:32:14 +00004489personal or system <kbd>thresholds.xml</kbd> XML file. </p>
cristy3ed852e2009-09-05 21:47:34 +00004490
cristyd934d102009-10-10 12:55:13 +00004491<p>To print a complete list of threshold, use the <a href="#list" >-list
4492threshold</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004493
cristyd934d102009-10-10 12:55:13 +00004494<p>It is recommended that the <a href="#map" >+map</a> operator be used after
4495applying <a href="#ordered-dither" >-ordered-dither</a> to reduce the number of
cristy3ed852e2009-09-05 21:47:34 +00004496colors an animated image sequence, to less that 256 colors. This ensures that
4497a common or global color table is used when saving the result to a color
4498limited file format such as GIF. </p>
4499
cristyd934d102009-10-10 12:55:13 +00004500<p>Note that at this time the exact same threshold dithering map is used for
4501all color channels, no attempt is made to offset or rotate the map for
4502different channels is made, to create an offset printing effect. (possible
4503future expansion) </p>
cristy3ed852e2009-09-05 21:47:34 +00004504
4505
4506<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004507 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004508</div>
4509
4510<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>
4511
cristyc54f5d42009-11-27 21:36:31 +00004512<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004513described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4514>-fuzz</a> setting can be used to match and replace colors similar to the one
4515given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004516
cristyb36feb22010-03-26 16:54:37 +00004517<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4518the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004519
cristyb36feb22010-03-26 16:54:37 +00004520<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4521as <a href="#opaque" >-opaque</a> but replaces the matching color with
4522transparency rather than the current <a href="#fill">-fill</a> color setting.
4523To ensure that it can do this it also ensures that the image has an alpha
4524channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4525the new transparent colors, and does not require you to modify the <a
4526href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004527
cristy3ed852e2009-09-05 21:47:34 +00004528
4529<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004530 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004531</div>
4532
4533<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>
4534
4535<p>Choose from these orientations:</p>
4536
4537<pre class="text">
4538 bottom-left
4539 bottom-right
4540 left-bottom
4541 left-top
4542 right-bottom
4543 right-top
4544 top-left
4545 top-right
4546 undefined
4547</pre>
4548
cristyd934d102009-10-10 12:55:13 +00004549<p>To print a complete list of orientations, use the <a href="#list" >-list
4550orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004551
4552
4553<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004554 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004555 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4556 +page
4557 </h4>
4558</div>
4559
4560<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>
4561
4562<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>
4563
4564<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>
4565
4566<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>
4567<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4568<thead>
4569 <tr valign="top">
4570 <th align="center"><em class="arg">media</em></th>
4571 <th align="center"><em class="arg">width</em></th>
4572 <th align="center"><em class="arg">height</em></th>
4573 </tr>
4574</thead>
4575<tbody>
4576<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4577<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4578<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4579<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4580<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4581<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4582<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4583<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4584<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4585<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4586<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4587<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4588<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4589<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4590<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4591<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4592<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4593<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4594<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4595<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4596<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4597<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4598<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4599<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4600<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4601<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4602<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4603<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4604<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4605<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4606<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4607<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4608<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4609<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4610<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4611<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4612<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4613<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4614</tbody>
4615</table>
4616
4617
4618
4619
4620<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>
4621
4622<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>
4623
4624<p>The default page dimensions for a TEXT image is 612x792.</p>
4625
4626<p>This option is used in concert with <a href="#density">-density</a>.</p>
4627
4628<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4629
4630<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004631 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004632</div>
4633
4634<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>
4635
4636<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>
4637
4638<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004639 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004640
4641<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>
4642
4643<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004644 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004645</div>
4646
4647<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Pause between animation loops.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>]</td></tr></table>
4648
4649<p>Pause for the specified number of seconds before repeating the animation.</p>
4650
4651<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004652 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004653</div>
4654
4655<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>
4656
4657<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4658
4659<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004660 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004661</div>
4662
4663<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>
4664
4665<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004666 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004667</div>
4668
4669<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>
4670
4671<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004672 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004673</div>
4674
4675<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>
4676
4677<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4678
4679<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004680 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004681</div>
4682
4683<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>
4684
4685<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004686 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004687</div>
4688
4689<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>
4690
4691<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004692 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004693</div>
4694
4695<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>
4696
4697<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>
4698
4699<pre class="text">
4700 Rotate
4701 Shear
4702 Roll
4703 Hue
4704 Saturation
4705 Brightness
4706 Gamma
4707 Spiff
4708 Dull
4709 Grayscale
4710 Quantize
4711 Despeckle
4712 ReduceNoise
4713 Add Noise
4714 Sharpen
4715 Blur
4716 Threshold
4717 EdgeDetect
4718 Spread
4719 Shade
4720 Raise
4721 Segment
4722 Solarize
4723 Swirl
4724 Implode
4725 Wave
4726 OilPaint
4727 CharcoalDrawing
4728 JPEG
4729</pre>
4730
4731<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4732
4733<p>The default preview is <kbd>JPEG</kbd>.</p>
4734
4735<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004736 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004737</div>
4738
4739<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>
4740
4741<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004742 <h4><a id="process"></a>-process <em class="arg">command</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%'>process the image with a custom image filter.</td><td style='text-align:right;'></td></tr></table>
4746
4747<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>
4748
4749<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004750 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004751 +profile <em class="arg">profile_name</em></h4>
4752</div>
4753
4754<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>
4755
4756<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>
4757
4758<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>
4759
4760<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>
4761
4762<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>
4763
4764<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4765
4766<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4767<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>
4768
4769<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>
4770<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4771CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4772</p>
4773
cristyf7964272011-01-30 03:49:12 +00004774<p>The <a href="#profile">-profile</a> option can also be used to inject
4775previously-formatted ancillary chunks into the output PNG file, using
4776the commandline option as shown below or by setting the profile via a
4777programming interface:
4778
4779<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>-profile PNG-chunk-x:<filename></span></p>
4780where <em>x</em> is a location flag and
4781<em class="arg">filename</em> is a file containing the chunk
4782name in the first 4 bytes, then a colon (":"), followed by the chunk data.
4783This encoder will compute the chunk length and CRC, so those must not
4784be included in the file.
4785
4786"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
4787or "e" (end, i.e., after IDAT). If you want to write multiple chunks
4788of the same type, then add a short unique string after the "x" to prevent
4789subsequent profiles from overwriting the preceding ones, e.g.,
4790
4791
4792<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 +00004793<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004794 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004795</div>
4796
4797<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>JPEG/MIFF/PNG compression level.</td><td style='text-align:right;'></td></tr></table>
4798
cristy851dbce2010-08-06 21:40:00 +00004799<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 +00004800
4801<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>
4802
cristy851dbce2010-08-06 21:40:00 +00004803<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 +00004804
cristy3c98a4f2010-08-13 20:09:41 +00004805<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 +00004806
4807<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4808
4809<pre class="text">
4810 0: none
4811 1: sub
4812 2: up
4813 3: average
4814 4: Paeth
4815</pre>
4816
4817<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>
4818
4819<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4820
4821<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>
4822
cristy3c98a4f2010-08-13 20:09:41 +00004823<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 +00004824
4825<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4826
cristy3ed852e2009-09-05 21:47:34 +00004827<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004828 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004829</div>
4830
cristy3c98a4f2010-08-13 20:09:41 +00004831<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 +00004832
cristy3c98a4f2010-08-13 20:09:41 +00004833<p>This setting defines the colorspace used to sort out and reduce the number
4834of colors needed by an image (for later dithering) by operators such as <a
4835href="#colors" >-colors</a>, Note that color reducion also happens
4836automatically when saving images to color-limited image file formats, such as
4837GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004838
4839
4840<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004841 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004842</div>
4843
4844<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>
4845
4846<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004847 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004848</div>
4849
4850<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Blur around the center of the image.</td><td style='text-align:right;'></td></tr></table>
4851
4852<p>Note that this is actually a rotational blur rather than a radial and as
4853such actually mis-named. </p>
4854
4855<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4856pixels which are outside the image proper are blurred into the final result.
4857</p>
4858
4859
4860<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004861 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004862</div>
4863
4864<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>
4865
4866<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>.
4867</p>
4868
4869<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4870
4871<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004872 <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 +00004873</div>
4874
4875<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>
4876
4877<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004878 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004879</div>
4880
4881<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>
4882
4883<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004884 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00004885</div>
4886
4887<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Pay attention to warning messages.</td><td style='text-align:right;'></td></tr></table>
4888
4889<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004890 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004891</div>
4892
4893<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Reduce the number of colors in an image to the colors used by this image.</td><td style='text-align:right;'></td></tr></table>
4894
4895<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4896the given colors are dithered over the image as necessary, otherwise the closest
4897color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4898
4899<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4900images in the current image sequence, all the images will have the same color
4901table. That means that when saved to a file format such as GIF, it will use
4902that color table as a single common or global color table, for all the images,
4903without requiring extra local color tables. </p>
4904
4905<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4906sequence to use a common color map over all the images. This equivalent to
4907appending all the images together (without extra background colors) and color
4908reducing those images using <a href="#colors">-colors</a> with a 256 color
4909limit, then <a href="#remap">-remap</a> those colors over the original list of
4910images. This ensures all the images follow a single color map. </p>
4911
4912<p>If the number of colors over all the images is less than 256, then <a
4913href="#remap">+remap</a> should not perform any color reduction or dithering, as
4914no color changes are needed. In that case, its only effect is to force the use
4915of a global color table. This recommended after using either <a
4916href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
4917reduce the number of colors in an animated image sequence. </p>
4918
4919<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004920 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004921</div>
4922
4923<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>
4924
4925<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>
4926
4927<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>
4928
4929<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004930 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00004931</div>
4932
4933<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>
4934
4935<p>The only command recognized is the name of an image file to load.</p>
4936
4937<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>
4938
4939<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004940 <h4><a id="render"></a>-render</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%'>render vector operations.</td><td style='text-align:right;'></td></tr></table>
4944
4945<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>
4946
4947<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004948<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004949</div>
4950
4951<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>
4952
4953<p>This option is like <a href="#page">-page</a> but acts as an image operator
4954rather than a setting. You can separately set the canvas size or the offset
4955of the image on that canvas by only providing those components. </p>
4956
4957<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>
4958
4959<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
4960offset to move the image relative to its previous position. This useful for
4961animation sequences. </p>
4962
4963<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
4964recalculate the canvas size so the image (at its current offset) will appear
4965completely on that canvas (unless it has a negative offset).</p>
4966
4967<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
4968canvas meta-data from the images. </p>
4969
4970<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
4971directly assign virtual canvas meta-data. </p>
4972
4973
4974<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004975 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004976</div>
4977
4978<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Resample image to specified horizontal and vertical resolution.</td><td style='text-align:right;'></td></tr></table>
4979
4980<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>
4981
4982<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>
4983
4984<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004985 <h4><a id="resize"></a>-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004986</div>
4987
4988<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>
4989
4990<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>
4991
4992<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>
4993
cristy13538962010-02-26 17:53:04 +00004994<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>
4995
cristy4949d522010-03-12 18:41:34 +00004996<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 +00004997<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004998 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00004999</div>
5000
5001<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>
5002
5003<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005004 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005005</div>
5006
5007<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>
5008
5009
5010<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005011 <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 +00005012</div>
5013
5014<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>
5015
5016<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>
5017
5018
5019<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005020 <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 +00005021</div>
5022
5023<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>
5024
5025<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>
5026
5027<p>Empty triangles in the corners, left over from rotating the image, are
5028filled with the <kbd>background</kbd> color. </p>
5029
5030<p>See also the <a href="#distort">-distort</a> operator and specifically the
5031'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5032
5033
5034<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005035 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005036</div>
5037
cristyd0bd44a2010-09-24 12:38:11 +00005038<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 +00005039
cristyd0bd44a2010-09-24 12:38:11 +00005040<p>Change the image size simply by directly sampling the pixels original
5041image. When magnifying, pixels are replicated in blocks. When minifying,
5042pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005043
cristyd0bd44a2010-09-24 12:38:11 +00005044<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5045a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5046neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5047avoids all the filter processing of the image. As such it completely ignores
5048the current <a href="#filter">-filter</a> setting. </p>
5049
5050<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5051will be added to the resulting image, though some colors may disappear. </p>
5052
5053<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
5054ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005055
5056
5057<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005058 <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 +00005059</div>
5060
5061<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>
5062
5063<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>
5064
5065<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005066 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005067</div>
5068
cristyd0bd44a2010-09-24 12:38:11 +00005069<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 +00005070
cristyd0bd44a2010-09-24 12:38:11 +00005071<p>Change the image size simply by replacing pixels by averaging pixels
5072together when minifying, or replacing pixels when magnifing. </p>
5073
5074<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5075a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5076faster, as it avoids all the filter processing of the image. As such it
5077completely ignores the current <a href="#filter">-filter</a> setting. </p>
5078
5079<p>If when shrinking (minifying) images the original image is some integer
5080multiple of the new image size, the number of pixels avergaed together to
5081produce the new pixel color is the same across the whole image. This is
5082a special case known as 'binning' and is often used as a method of reducing
5083noise in image such as those generated by digital cameras, especially in low
5084light conditions. </p>
5085
cristy3ed852e2009-09-05 21:47:34 +00005086
5087<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005088 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005089</div>
5090
5091<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>
5092
5093<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5094
5095<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005096 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005097</div>
5098
5099<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>
5100
5101<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>
5102
5103<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005104 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005105</div>
5106
5107<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>
5108
5109<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005110 <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 +00005111</div>
5112
5113<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>
5114
5115<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>
5116
5117<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>
5118
5119<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5120of the color clusters is returned.</p>
5121
5122
5123<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005124 <h4><a id="selective-blur"></a>-selective-blur <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005125</div>
5126
cristy2e2662a2010-10-09 14:29:37 +00005127<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005128 <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 +00005129</div>
5130
cristy3ed852e2009-09-05 21:47:34 +00005131<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>
5132
cristy2e2662a2010-10-09 14:29:37 +00005133<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>
5134
cristy3ed852e2009-09-05 21:47:34 +00005135<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005136 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005137</div>
5138
5139<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>
5140
5141<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005142 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005143</div>
5144
5145<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>
5146
5147<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5148
5149<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>
5150
cristyd0bda5e2010-09-21 16:22:45 +00005151
5152
cristy3ed852e2009-09-05 21:47:34 +00005153<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005154 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5155 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005156</div>
5157
cristyd0bd44a2010-09-24 12:38:11 +00005158<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 +00005159image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005160
cristyd0bd44a2010-09-24 12:38:11 +00005161<p>This will assign (or modify) specific settings attached to all the images
5162in the current image sequence. Using the <a href="#set">+set</a> form of the
5163option will either remove, or reset that setting to a default state, as
5164appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005165
cristyd0bd44a2010-09-24 12:38:11 +00005166<p>For example, it will modify specific well known image meta-data
5167'attributes' such as those normally overridden by: the options <a
5168href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5169href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5170assigned before the image is read in, by using a <em class="arg">key</em> of
5171the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005172
cristyd0bd44a2010-09-24 12:38:11 +00005173<p>If the given <em class="arg">key</em> does not match a specific known
5174'attribute ', such as shown above, the setting is stored as a a free form
cristyd0bda5e2010-09-21 16:22:45 +00005175'properity' string. Such settings are listed in <a href="#verbose"
5176>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5177</p>
5178
cristyd0bd44a2010-09-24 12:38:11 +00005179<p>This includes string 'properities' that are set by and assigned to images
5180using the options <a href="#comment" >-comment</a>, <a href="#label"
5181>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5182a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5183Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005184
cristyd0bd44a2010-09-24 12:38:11 +00005185<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>
5186<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5187Properties</a> in the defined value. For example:</p>
5188
5189<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>
5190<p>Other well known 'properities' that can be include:
5191'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5192'<kbd>signature</kbd>'. </p>
5193
5194<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5195the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5196see <a href="#repage">-page</a>). However it is designed to provide a finer
5197control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5198option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5199attribute. </p>
5200
5201<p>This option can also associate a colorspace or profile with your image.
5202For example,</p>
5203
5204<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 +00005205<p>Some 'properties' must be defined in a specific way to be used. For
5206example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5207modify the output filename of an image. For example</p>
5208
5209<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>
5210<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5211be saved as a global "Artifact" exactly as if it was set using the <a
cristyd0bd44a2010-09-24 12:38:11 +00005212href="#define" >-define</a> option. As such settings are globel in scope, they
5213can be used to pass 'attributes' and 'properities' of one specific image,
5214in a way that allows you to use them in a completely different image, even if
5215the original image has long since been modified or destroyed. For example: </p>
5216
5217<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>
5218<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5219a 'artifact' if the given <em class="arg">key</em> does not match an existing
5220'attribute' or 'properity'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005221
5222<p>You can set the attributes of the image registry by prefixing the value
5223with <kbd>registry:</kbd>.</p>
5224
5225
cristy3ed852e2009-09-05 21:47:34 +00005226
5227<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005228 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005229</div>
5230
5231<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>
5232
5233<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>
5234
5235<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005236 <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 +00005237</div>
5238
5239<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>
5240
5241<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005242 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005243id="shared-memory"></a>-shared-memory</h4>
5244</div>
5245
5246<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>
5247
5248<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>
5249
5250<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005251 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005252</div>
5253
5254<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>
5255
5256<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5257
5258<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005259 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005260</div>
5261
5262<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Shave pixels from the image edges.</td><td style='text-align:right;'></td></tr></table>
5263
5264<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>
5265
5266<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>
5267
5268<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005269 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005270</div>
5271
5272<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>
5273
5274<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>
5275
5276<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>
5277
5278<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>
5279
5280<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>
5281
5282<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>
5283<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>
5284
5285<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5286<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005287 <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 +00005288</div>
5289
5290<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>
5291
5292<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>
5293
5294<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005295 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005296</div>
5297
5298<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>operate silently.</td><td style='text-align:right;'></td></tr></table>
5299
5300<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005301 <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 +00005302</div>
5303
5304<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>
5305
5306<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>
5307
5308<p>For Photo CD images, choose from these sizes:</p>
5309
5310<pre class="text">
5311 192x128
5312 384x256
5313 768x512
5314 1536x1024
5315 3072x2048
5316</pre>
5317
cristy3ed852e2009-09-05 21:47:34 +00005318<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005319 <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 +00005320</div>
5321
5322<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>
5323
5324<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>
5325
5326<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005327 <h4><a id="snaps"></a>-snaps <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005328</div>
5329
5330<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the number of screen snapshots.</td><td style='text-align:right;'>[<a href="../www/import.html">import</a>]</td></tr></table>
5331
5332<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5333
5334<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005335 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005336</div>
5337
5338<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>
5339
5340<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5341
5342<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5343
5344<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005345 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005346 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5347</div>
5348
5349<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>
5350
5351
5352<table class="doc">
5353 <tbody>
5354 <tr valign="top">
5355 <th align="left" style="width: 8%">Method</th>
5356 <th align="left">Description</th>
5357 </tr>
5358
5359 <tr valign="top">
5360 <td valign="top">voronoi</td>
5361 <td valign="top">Simply map each pixel to the to nearest color point
5362 given. The result are polygonal 'cells' of solid color. </td>
5363 </tr>
5364
5365 <tr valign="top">
5366 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005367 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005368 squared. Generating spots of color in a sea of the average of
5369 colors. </td>
5370 </tr>
5371
5372 <tr valign="top">
5373 <td valign="top">barycentric</td>
5374 <td valign="top">three point triangle of color given 3 points.
5375 Giving only 2 points will form a linear gradient between those points.
5376 Gradient is however not restricted to just the triangle or line. </td>
5377 </tr>
5378
5379 <tr valign="top">
5380 <td valign="top">bilinear</td>
5381 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5382 fall back to barycentric. </td>
5383 </tr>
5384
5385 </tbody>
5386</table>
5387
5388<p>The points are placed according to the images location on the virtual
5389canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5390offset), and do not actually have to exist on the given image, but may be
5391some point beyond the edge of the image. All points are floating point values.
5392</p>
5393
5394<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
5395modified, whcih means the matte/alpha transparency channel is not effected by
5396default. If enabled, the image also needs a the matte/alpha channel to be
5397enabled for this operator to effect an images transparency. This is typical
5398transparency handling for images. </p>
5399
5400<p>All the above methods when given a single point of color will replace all
5401the colors in the image with the color given, regardless of the point. This is
5402logical, and provides an alternative technique to recolor a image to some
5403default value. </p>
5404
5405
5406<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005407 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005408</div>
5409
5410<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>
5411
5412<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>
5413
5414<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005415 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005416</div>
5417
5418<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>
5419
5420<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>
5421
5422<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005423 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005424</div>
5425
5426<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>hide watermark within an image.</td><td style='text-align:right;'></td></tr></table>
5427
5428<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>
5429
5430<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005431 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005432</div>
5433
5434<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>composite two images to create a stereo anaglyph.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5435
5436<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>
5437
5438<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005439 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005440</div>
5441
5442<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>
5443
5444<pre class="text">
5445 char store pixels as unsigned characters
5446 double store pixels as doubles
5447 float store pixels as floats
5448 integer store pixels as integers
5449 long store pixels as longs
5450 quantum store pixels in the native depth of your ImageMagick distribution
5451 short store pixels as unsigned shorts
5452</pre>
5453
5454<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5455values range from 0 to the maximum value the storage type can support.</p>
5456
5457<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005458 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005459</div>
5460
5461<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>
5462
5463<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>
5464
5465<pre class="text">
5466 Any
5467 Condensed
5468 Expanded
5469 ExtraCondensed
5470 ExtraExpanded
5471 Normal
5472 SemiCondensed
5473 SemiExpanded
5474 UltraCondensed
5475 UltraExpanded
5476</pre>
5477
5478<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5479
5480<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>
5481
5482<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005483 <h4><a id="strip"></a>-strip</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%'>strip the image of any profiles or comments.</td><td style='text-align:right;'></td></tr></table>
5487
5488<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005489 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005490</div>
5491
5492<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>color to use when stroking a graphic primitive.</td><td style='text-align:right;'></td></tr></table>
5493
5494<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5495
5496<p>See <a href="#draw">-draw</a> for further details.</p>
5497
5498<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005499 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</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%'>set the stroke width.</td><td style='text-align:right;'></td></tr></table>
5503
5504<p>See <a href="#draw">-draw</a> for further details.</p>
5505
5506<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005507 <h4><a id="style"></a>-style <em class="arg">fontStyle</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%'>Set a font style for text.</td><td style='text-align:right;'></td></tr></table>
5511
cristy71a3f602010-09-15 12:38:16 +00005512<p>This setting suggests a font style that ImageMagick should try to apply to
5513the currently selected font family. Select <em class="arg">fontStyle</em> from
5514the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005515
5516<pre class="text">
5517 Any
5518 Italic
5519 Normal
5520 Oblique
5521</pre>
5522
5523<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>
5524
5525<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005526 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005527</div>
5528
cristyd4d64ed2010-08-22 22:19:33 +00005529<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>
5530
cristy71a3f602010-09-15 12:38:16 +00005531<p>This option is required to have compare search for the best match location
5532of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005533(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005534be the "match score" image.</p>
5535
cristyd0bd44a2010-09-24 12:38:11 +00005536<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005537position of the top-left corner of the given sub-image. that is its size will
5538be the size of the larger_image - sub_image + 1. The brightest location in
5539this image is the location s the locate on the best match that is also
5540reported. Note that this may or may nor be a perfect match, and the actual
5541brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005542possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005543
cristyd0bda5e2010-09-21 16:22:45 +00005544<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005545location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005546sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005547
cristyae6203d2010-08-09 01:12:14 +00005548
5549<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005550 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005551</div>
5552
5553<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>
5554
cristy71a3f602010-09-15 12:38:16 +00005555<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5556images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5557the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005558
5559<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005560 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005561</div>
5562
5563<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>
5564
5565<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5566
5567<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005568 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005569</div>
5570
5571<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>
5572
5573<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005574 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005575</div>
5576
cristy5063d812010-10-19 16:28:10 +00005577<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 +00005578
5579<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005580 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005581</div>
5582
5583<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>font for writing fixed-width text.</td><td style='text-align:right;'></td></tr></table>
5584
5585<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>
5586
5587<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>
5588
5589<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005590 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005591</div>
5592
5593<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>
5594
5595<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005596 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005597</div>
5598
5599<!-- {<em class="arg">green,blue,opacity</em>}
5600<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>
5601-->
5602
5603<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>
5604
5605<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>
5606
5607<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.
5608</p>
5609
5610<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>
5611
5612<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5613<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>
5614
5615
5616<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>
5617<p>Note that the values of the transparency channel is treated as 'matte'
5618values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5619
5620<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>.
5621</p>
5622
5623<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005624 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005625</div>
5626
5627<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Create a thumbnail of the image.</td><td style='text-align:right;'></td></tr></table>
5628
5629<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>
5630
5631<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>
5632
5633<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005634 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005635</div>
5636
5637<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>
5638
5639<div style="margin: auto;">
5640 <h4>-tile <em class="arg">geometry</em></h4>
5641</div>
5642
5643<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>
5644
5645<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>
5646
5647<div style="margin: auto;">
5648 <h4>-tile</h4>
5649</div>
5650
5651<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>
5652
5653<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005654 <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 +00005655</div>
5656
5657<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>
5658
5659<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>
5660
5661<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>
5662
5663<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005664 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005665</div>
5666
5667<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>
5668
5669<p>Tint the image with the fill color.</p>
5670
5671<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>
5672
5673<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005674 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005675</div>
5676
5677<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>
5678
5679<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>
5680
5681<p>For example,</p>
5682
5683<p class="crtsnip">
5684 -title "%m:%f %wx%h"
5685</p>
5686
5687<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>
5688
5689
5690<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005691 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005692</div>
5693
5694<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>
5695
5696<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5697
5698<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 +00005699
5700<p>This operator has been now been superseded by the <a
5701href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5702
5703
cristy3ed852e2009-09-05 21:47:34 +00005704<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005705 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005706</div>
5707
5708<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Make this color transparent within the image.</td><td style='text-align:right;'></td></tr></table>
5709
5710<p>The <em class="arg">color</em> argument is defined using the format
5711described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5712>-fuzz</a> setting can be used to match and replace colors similar to the one
5713given. </p>
5714
cristyb36feb22010-03-26 16:54:37 +00005715<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5716that is make all non-matching colors transparent. </p>
5717
cristy3ed852e2009-09-05 21:47:34 +00005718<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005719href="#transparent" >-transparent</a> but replaces the matching color with the
5720current <a href="#fill">-fill</a> color setting, rather than transparent.
5721However the <a href="#transparent" >-transparent</a> operator also ensures
5722that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5723>-alpha</a> set</kbd>", and does not require you to modify the <a
5724href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005725
cristyb36feb22010-03-26 16:54:37 +00005726<p>Note that this does not define the color as being the 'transparency color'
5727used for color-mapped image formats, such as GIF. For that use <a
5728href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005729
5730
5731<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005732 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</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%'>Set the transparent color.</td><td style='text-align:right;'></td></tr></table>
5736
5737<p>Sometimes this is used for saving to image formats such as
5738GIF and PNG8 which uses this color to represent boolean transparency. This
5739does not make a color transparent, it only defines what color the transparent
5740color is in the color palette of the saved image. Use <a
5741href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5742
5743<p>This option allows you to have both an opaque visible color, as well as a
5744transparent color of the same color value without conflict. That is, you can
5745use the same color for both the transparent and opaque color areas within an
5746image. This, in turn, frees to you to select a transparent color that is
5747appropriate when an image is displayed by an application that does not handle a
5748transparent color index, while allowing ImageMagick to correctly handle images of this
5749type. </p>
5750
5751<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5752
5753<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005754 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005755</div>
5756
5757<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>
5758
5759<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5760</p>
5761
5762<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005763 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005764</div>
5765
5766<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
5767
5768
5769<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005770 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005771</div>
5772
5773<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>
5774
5775<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>
5776
5777<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>
5778
5779<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>
5780
5781<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005782 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00005783</div>
5784
5785<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>
5786
5787<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>
5788
5789<p>The page or virtual canvas information of the image is preserved allowing
5790you to extract the result of the <a href="#trim">-trim</a> operation from the
5791image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5792information if it is unwanted.</p>
5793
5794<p>If the trimmed image 'disappears' an warning is produced, and a special
5795single pixel transparent 'missed' image is returned, in the same way as when a
5796<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5797
5798
5799<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005800 <h4><a id="type"></a>-type <em class="arg">type</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%'>the image type.</td><td style='text-align:right;'></td></tr></table>
cristyefb2bdb2010-11-20 19:35:22 +00005804 <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 +00005805
5806<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>
5807
5808<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5809<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>
5810
5811<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5812
5813<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005814 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005815</div>
5816
5817<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>
5818
5819<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5820
5821<p>See <a href="#draw">-draw</a> for further details.</p>
5822
5823
5824<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005825 <h4><a id="update"></a>-update <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005826</div>
5827
5828<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>
5829
5830<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>
5831
5832
5833<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005834 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00005835</div>
5836
5837<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>
5838
5839
5840<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005841 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005842</div>
5843
5844<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>
5845
5846<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>
5847
5848
5849<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005850 <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 +00005851</div>
5852
5853<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>
5854
5855<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>
5856
5857<p>The parameters are:</p>
5858
5859<pre class="text">
5860 radius: The radius of the Gaussian, in pixels, not counting the center
5861 pixel (default 0).
5862 sigma: The standard deviation of the Gaussian, in pixels (default 1.0).
5863 amount: The fraction of the difference between the original and the blur
5864 image that is added back into the original (default 1.0).
5865 threshold: The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5866 difference amount (default 0.05).
5867</pre>
5868
5869
5870<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005871 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005872</div>
5873
cristyd0bda5e2010-09-21 16:22:45 +00005874<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 +00005875
5876
5877<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005878 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00005879</div>
5880
5881<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>
5882
5883
5884<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005885 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005886</div>
5887
5888<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>
5889
5890
5891<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005892 <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 +00005893</div>
5894
5895<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>
5896
5897
5898<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005899 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005900</div>
5901
5902<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>
5903
5904<p>This option defines what color source should be used if and when a color
5905lookup completely 'misses' the source image. The color(s) that appear to
5906surround the source image. Generally this color is derived from the source
5907image, but could also be set to a specify background color. </p>
5908
5909<p>Choose from these methods:</p>
5910
5911<pre class="text">
5912 background: the area surrounding the image is the background color
5913 black: the area surrounding the image is black
5914 checker-tile: alternate squares with image and background color
5915 dither: non-random 32x32 dithered pattern
5916 edge: extend the edge pixel toward infinity
5917 gray: the area surrounding the image is gray
5918 horizontal-tile: horizontally tile the image, background color above/below
5919 horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
5920 mirror: mirror tile the image
5921 random: choose a random pixel from the image
5922 tile: tile the image (default)
5923 transparent: the area surrounding the image is transparent blackness
5924 vertical-tile: vertically tile the image, sides are background color
5925 vertical-tile-edge: vertically tile the image and replicate the side edge pixels
5926 white: the area surrounding the image is white
5927</pre>
5928
5929<p>The default value is "edge".</p>
5930
5931<p>This most important for distortion operators such as <a href="#distort"
5932>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
5933However it also effects operations that may access pixels just outside the
5934image proper, such as <a href="#convolve">-convolve</a>, <a
5935href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
5936
5937<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
5938
5939
5940<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005941 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005942</div>
5943
5944<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>
5945
5946<p>Choose from these visual classes:</p>
5947
5948<pre class="text">
5949 StaticGray
5950 GrayScale
5951 StaticColor
5952 PseudoColor
5953 TrueColor
5954 DirectColor
5955 default
5956 visual id
5957</pre>
5958
5959<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>
5960
5961
5962<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005963 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00005964 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
5965</div>
5966
5967<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
5968saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5969
5970<p>Take a grayscale image (with alpha mask) and modify the destination image's
5971brightness according to watermark image's grayscale value and the <em
5972class="arg">brightness</em> percentage. The destinations color saturation
5973attribute is just direct modified by the <em class="arg">saturation</em>
5974percentage, which defaults to 100 percent (no color change). </p>
5975
5976
5977<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005978 <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 +00005979</div>
5980
5981<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>
5982
5983<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
5984
5985<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005986 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005987</div>
5988
5989<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>
5990
5991<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>
5992
5993<table class="doc">
5994 <col width="25%" />
5995 <col width="75%" />
5996 <thead>
5997 <tr>
5998 <th><em class="arg">fontWeight</em></th>
5999 <th>Description</th>
6000 </tr>
6001 </thead>
6002 <tbody>
6003 <tr><td>All </td> <td>No effect. </td></tr>
6004 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
6005 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
6006 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
6007 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
6008 </tbody>
6009 </table>
6010
6011<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
6012
6013<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>
6014
6015<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006016 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006017</div>
6018
6019<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>chromaticity white point.</td><td style='text-align:right;'></td></tr></table>
6020
6021<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006022 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006023</div>
6024
cristy5cadd612009-09-21 19:33:41 +00006025<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>
6026
6027<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.
6028</p>
cristy3ed852e2009-09-05 21:47:34 +00006029
6030<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006031 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006032</div>
6033
6034<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>
6035
6036<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>
6037
6038<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>
6039
6040<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>
6041
6042<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006043 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006044</div>
6045
6046<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the window group.</td><td style='text-align:right;'></td></tr></table>
6047
6048<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006049 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006050</div>
6051
6052<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>
6053 <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>
6054
6055<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006056</div>
6057</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006058
6059</div>
6060
6061<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006062 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006063 <span id="linkbar-center">
6064 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006065 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006066 </span>
6067 <span id="linkbar-east">&nbsp;</span>
6068 </div>
6069 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +00006070 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006071 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6072 </div>
6073 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006074 <script type="text/javascript">
6075 var _gaq = _gaq || [];
6076 _gaq.push(['_setAccount', 'UA-17690367-1']);
6077 _gaq.push(['_trackPageview']);
6078
6079 (function() {
6080 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6081 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6082 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6083 })();
6084 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006085</body>
6086</html>