blob: 0871e16ee6023d2dd2de9d1277e9e9ed2ba49817 [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=""
60 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
61<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">
cristyec6b4752011-01-08 03:16:23 +0000147<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000148 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000149</div>
150<div class="sponsor">
151 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +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">
cristy7a40ba82011-01-08 20:31:18 +0000160 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristyec6b4752011-01-08 03:16:23 +0000161</div>
cristy3ed852e2009-09-05 21:47:34 +0000162</div>
163</div>
cristyce69bb02010-07-27 19:49:46 +0000164</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000165
cristyce69bb02010-07-27 19:49:46 +0000166<div class="eastbar">
167 <script type="text/javascript">
168 <!--
169 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000170 google_ad_slot = "0574824969";
171 google_ad_width = 160;
172 google_ad_height = 600;
173 //-->
174 </script>
175 <script type="text/javascript"
176 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
177 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000178</div>
179
180<div class="main">
181
cristydcca3fa2010-12-29 21:50:07 +0000182<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000183<p class="navigation-index">
cristy5063d812010-10-19 16:28:10 +0000184[ <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 +0000185
cristydcca3fa2010-12-29 21:50:07 +0000186<div class="doc-section">
187
cristyb36feb22010-03-26 16:54:37 +0000188<p>Below is list of command-line options recognized by the ImageMagick <a
189href="../www/command-line-tools.html">command-line
190tools</a>. If you want a description of a particular option, click on the
191option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000192otherwise 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 +0000193
194<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000195 <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 +0000196</div>
197
198<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 +0000199<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>
200
201<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000202 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000203</div>
204
205<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>
206
207<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>
208
209<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000210 <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 +0000211</div>
212
213<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>
214
215<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>
216
217<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000218 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000219</div>
220
221<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>
222
223<p>This option is enabled by default. An attempt is made to save all
224images of an image sequence into the given output file.
225However, some formats, such as JPEG and PNG, do not support more than one
226image per file, and in that case ImageMagick is forced to write each image as a separate file. As
227such, if more than one image needs to be written, the filename given is
228modified by adding a <a href="#scene">-scene</a> number before the
229suffix, in order to make distinct names for each image. </p>
230
231<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written
232to separate files, whether or not the file format allows multiple images
233per file (for example, GIF, MIFF, and TIFF). </p>
234
235<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>
236
237<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: rose: -morph 15 my%02dmorph.jpg</span></p>
238<p>will create a sequence of 17 images named my00morph.jpg, my01morph.jpg, my02morph.jpg, ..., my16morph.jpg.
239</p>
240
241<p>In summary, ImageMagick tries to write all images to one file, but will use
cristydcca3fa2010-12-29 21:50:07 +0000242multiple files if either<br />
243 (1) the output image's file format does not allow multi-image files,<br />
244 (2) the <a href="#adjoin">+adjoin</a> option is given, or<br />
245 (3) a printf() integer format string (eg: "%d") is present in the output filename. </p>
cristy3ed852e2009-09-05 21:47:34 +0000246
247
248<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000249 <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 +0000250 -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>
251</div>
252
253<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>
254
255<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>
256
257<p>The matrix entries are entered as comma-separated numeric values <i>with no spaces</i>. </p>
258
259<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>
260
261<div class="eqn">
262<img alt="affine transformation" src="../images/affine.png"/>
263</div>
264
265<p>
266The 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>
267
268<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>
269
270<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>
271
272<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>
273
274<p class="crtsnip">
275 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
276</p>
277
278<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>
279
280<p class="crtsnip">
281 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
282</p>
283
284<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
285<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
286
287<p class="crtsnip">
288 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
289</p>
290
291<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>
292
293<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>
294
295<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000296 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000297</div>
298
299<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>
300
301<p>Used to set a flag on an image indicating whether or not to use existing alpha
302channel 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>
303
304
305<table class="doc">
306 <tbody>
307 <tr valign="top">
308 <th align="left" style="width: 8%">type</th>
309 <th align="left">Description</th>
310 </tr>
311
312 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000313 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000314 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000315 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
316 should be used instead of this, unless you specifically need to
317 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
318 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000319
320 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000321 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000322 <td valign="top">
323 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000324 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000325
326 <tr valign="top">
327 <td valign="top"><kbd>Set</kbd></td>
328 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000329 Activates the alpha/matte channel. If it was previously turned off
330 then it also resets the channel to opaque. If the image already had
331 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000332
333 <tr valign="top">
334 <td valign="top"><kbd>Opaque</kbd></td>
335 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000336 Enables the alpha/matte channel and forces it to be fully opaque.
337 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000338
339 <tr valign="top">
340 <td valign="top"><kbd>Transparent</kbd></td>
341 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000342 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000343 transparent. This effectively creates a fully transparent image the
344 same size as the original and with all its original RGB data still
345 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000346
347 <tr valign="top">
348 <td valign="top"><kbd>Extract</kbd></td>
349 <td valign="top">
350 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000351 '<kbd>Off</kbd>' the the image's transparency, so as to generate
352 a gray-scale mask of the image's shape. The alpha channel data is left
353 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
354 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000355
356 <tr valign="top">
357 <td valign="top"><kbd>Copy</kbd></td>
358 <td valign="top">
359 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000360 gray-scale intensity of the image, into the alpha channel, converting
361 a gray-scale mask into a transparent shaped mask ready to be colored
362 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000363
364 <tr valign="top">
365 <td valign="top"><kbd>Shape</kbd></td>
366 <td valign="top">
367 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000368 the current background color. That is the RGB color channels is
369 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000370 </td></tr>
371
372 <tr valign="top">
373 <td valign="top"><kbd>Background</kbd></td>
374 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000375 Set any fully-transparent pixel to the background color, while leaving
376 it fully-transparent. This can make some image file formats, such as
377 PNG, smaller as the RGB values of transparent pixels are more uniform,
378 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000379 </td></tr>
380 </tbody>
381</table>
382
383<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000384"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000385>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000386Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000387
388
389<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000390 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000391 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
392 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
393 -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>
394</div>
395
396<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>
397
398<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>
399
400
401<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>
402
403<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>
404
405<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>
406<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
407
408<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>
409
410<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>
411
412<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000413 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000414</div>
415
416<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
417drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
418
419<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
420drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
421antialiasing edge pixels. This will then reduce the number of colors added to
422an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000423are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000424
425<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000426 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000427</div>
428
429<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>
430
431<p>This option creates a single longer image image, by joining all the current
432images in sequence top-to-bottom. Use <a href="#append">+append</a> to
433stack images left-to-right. </p>
434
435<p>If they are not of the same width, narrower images are padded with the
436current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000437position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000438href="#gravity">-gravity</a> setting. </p>
439
440
441<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000442 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000443</div>
444
445<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>
446
447
448<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000449 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000450</div>
451
452<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>
453
454<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>
455
456<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
457
cristyd934d102009-10-10 12:55:13 +0000458
459
cristy3ed852e2009-09-05 21:47:34 +0000460<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000461 <h4><a id="auto-gamma"></a>-auto-gamma</h4>
cristy3ed852e2009-09-05 21:47:34 +0000462</div>
463
464<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>
465
cristyd934d102009-10-10 12:55:13 +0000466<p>This calculates the mean values of an image, then applies a calculated <a
467href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
468image it will get a have a value of 50%. </p>
469
cristyd0bd44a2010-09-24 12:38:11 +0000470<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000471
472<p>This works well for real-life images with little or no extreme dark and
473light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000474dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000475</p>
476
477<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000478'<em>sync</em>' flag for channel syncronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000479values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000480>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000481together by the same gamma value, preserving colors. </p>
482
483
484
cristy3ed852e2009-09-05 21:47:34 +0000485<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000486 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000487</div>
488
489<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>
490
cristyd934d102009-10-10 12:55:13 +0000491<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000492minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000493href="#level" >-level</a> operator to stretch the values to the full range of
494values. </p>
495
cristy83543962009-10-16 19:04:28 +0000496<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000497JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
498for the <a href="#level" >-level</a> operation. On the other hand it is the
499right operator to use for color stretching gradient images being used to
500generate Color lookup tables, distortion maps, or other 'mathematically'
501defined images. </p>
502
503<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
504href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
505>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
506problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000507>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000508
509<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000510special '<em>sync</em>' flag for channel syncronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000511which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000512href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
513'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000514together by the same gamma value, preserving colors, and ignoring
515transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000516
517
cristy3ed852e2009-09-05 21:47:34 +0000518<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000519 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000520</div>
521
522<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>
523
cristy83543962009-10-16 19:04:28 +0000524<p>This operator reads and resets the EXIF image profile setting 'Orientation'
525and then performs the appropriate 90 degree rotation on the image to orient
526the image, for correct viewing. </p>
527
528<p>This EXIF profile setting is usually set using a gravity sensor in digital
529camara, however photos taken directly downward or upward may not have an
530appropriate value. Also images that have been orientation 'corrected' without
531reseting this setting, may be 'corrected' again resulting in a incorrect
532result. If the he EXIF profile was previously stripped, the <a
533href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
534
535
cristy3ed852e2009-09-05 21:47:34 +0000536<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000537 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000538</div>
539
540<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>
541
542<p>An error results if the images are not identically sized.</p>
543
cristy3ed852e2009-09-05 21:47:34 +0000544
545<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000546 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000547</div>
548
549<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>
550
551<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>
552
553<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000554 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000555</div>
556
557<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>
558
559<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>
560
561<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000562 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000563</div>
564
565<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>
566
cristye6378132009-10-26 20:05:17 +0000567<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 +0000568
cristye6378132009-10-26 20:05:17 +0000569<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>
570<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 +0000571
572<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000573 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000574</div>
575
576<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>
577
578<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>
579
580<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>
581
582<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
583negative results without clipping to the color value range
584(0..QuantumRange).</p>
585
586<p>See the discussion on HDRI implementations of ImageMagick on the page
587<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.
588</p>
589
590<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000591 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000592</div>
593
594<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>
595
596<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000597 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000598</div>
599
cristy5cadd612009-09-21 19:33:41 +0000600<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>
601
602<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.
603</p>
cristy3ed852e2009-09-05 21:47:34 +0000604
605
606<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000607 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000608</div>
609
cristy83a272e2010-05-07 20:40:35 +0000610<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 +0000611
612<p>Blend will average the images together ('plus') according to the
613percentages given and each pixels transparency. If only a single percentage
614value is given it sets the weight of the composite or 'source' image, while
615the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000616<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
617'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000618
619
620<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000621 <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 +0000622</div>
623
624<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>
625
626<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000627 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000628</div>
629
630<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>
631
632<div style="margin: auto;">
633
634<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000635 <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 +0000636</div>
637
638<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>
639
cristyb15553d2010-07-03 22:53:14 +0000640<p>Convolve the image with a Gaussian or normal distribution using the given
641<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000642
643<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
644</div>
645
cristyb15553d2010-07-03 22:53:14 +0000646<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000647determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000648
cristyb15553d2010-07-03 22:53:14 +0000649<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000650array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000651integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000652radius that will provide meaningful results for the Gaussian distribution.
653</p>
654
655<p>The larger the <em class="arg" >Radius</em> the radius the slower the
656operation is. However too small a <em class="arg" >Radius</em>, and sever
657aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
658should be at least twice the <em class="arg" >Sigma</em> value, though three
659times will produce a more accurite result. </p>
660
661<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
662by taking advantage of the separability properties of the distribution. Here
663we apply a single-dimensional Gaussian matrix in the horizontal direction,
664then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000665
666<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
667pixels which are outside the image proper are blurred into the final result.
668</p>
669
670
671<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000672 <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 +0000673</div>
674
675<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>
676
677<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
678Average (EWA) of the source image, scaled according to the grayscale
679mapping. </p>
680
681<p>The ellipse is weighted with sigma set to the given <em class="arg"
682>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
683defaults to the <em class="arg" >Width</em> for a normal circular Guassian
684weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
685horizontal clock-wise. </p>
686
687<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
688pixels which are outside the image proper are blurred into the final result.
689</p>
690
691
692<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000693 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000694</div>
695
696<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>
697
cristybc9539a2010-08-16 18:06:20 +0000698<p>Set the width and height using the <em class="arg">size</em> portion of the
699<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
700ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000701
cristybc9539a2010-08-16 18:06:20 +0000702<p>Set the border color by preceding with the <a
703href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000704
cristybc9539a2010-08-16 18:06:20 +0000705<p>The <a href="#border">-border</a> operation is affected by the current <a
706href="#compose">-compose</a> setting and assumes that this is using the default
707'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
708size colors by the current <a href="#bordercolor">-bordercolor</a> before
709overlaying the original image in the center of this net image. This means that
710with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000711be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000712<p>See also the <a href="#frame">-frame</a> option, which has more
713functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000714
715<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000716 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000717</div>
718
719<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>
720
721<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
722
723<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
724
725<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000726 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000727</div>
728
729<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>
730
731<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000732 <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 +0000733</div>
734
735<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>
736
cristyefb2bdb2010-11-20 19:35:22 +0000737<p>Brightness and Contrast values apply changes to the input image. They are
738not absolute settings. A brightness or contrast value of zero means no change.
739The range of values is -100 to +100 on each. Positive values increase the
740brightness or contrast and negative values decrease the brightness or contrast.
741To control only contrast, set the brightness=0. To control only brightness,
742set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000743
cristyefb2bdb2010-11-20 19:35:22 +0000744<p>You may also use <a href="#fill">-channel</a> to control which channels to
745apply the brightness and/or contrast change. The default is to apply the same
746transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000747
cristyefb2bdb2010-11-20 19:35:22 +0000748<p>Brightness and Contrast arguments are converted to offset and slope of a
749linear transform and applied
750using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000751
cristyefb2bdb2010-11-20 19:35:22 +0000752<p>The slope varies from 0 at contrast=-100 to almost vertical at
753contrast=+100. For brightness=0 and contrast=-100, the result are totally
754midgray. For brightness=0 and contrast=+100, the result will approach but
755not quite reach a threshold at midgray; that is the linear transformation
756is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000757
cristyefb2bdb2010-11-20 19:35:22 +0000758<p>Negative slopes, i.e. negating the image, are not possible with this
759function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000760
cristyefb2bdb2010-11-20 19:35:22 +0000761<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
762at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
763totally white. Similarly, when contrast=0 and brightness=-100, the result is
764totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000765
cristyefb2bdb2010-11-20 19:35:22 +0000766<p>As the range of values for the arguments are -100 to +100, adding the '%'
767symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000768
769<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000770 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000771</div>
772
773<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>
774
775<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000776 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000777</div>
778
779<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>
780
cristy71a3f602010-09-15 12:38:16 +0000781<p>This option sets the caption meta-data of an image read in after this
782option has been given. To modify a caption of images already in memory use
783"<kbd><a href="#set">-set</a> caption</kbd>". </p>
784
785<p>The caption can contain special format characters listed in the <a
786href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000787Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000788is finally assigned to the individual images. </p>
789
790<p>If the first character of <em class="arg">string</em> is <em
791class="arg">@</em>, the image caption is read from a file titled by the
792remaining characters in the string. Comments read in from a file are literal;
793no embedded formatting characters are recognized.</p>
794
795<p>Caption meta-data ais not visible on the image itself. To do that use the
796<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
797instead.</p>
798
799<p>For example,</p>
800
801<p class="crtsnip">
802 -caption "%m:%f %wx%h" bird.miff
803</p>
804
805<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
806that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
807480.</p>
808
809
cristy3ed852e2009-09-05 21:47:34 +0000810<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000811 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000812</div>
813
814<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>
815
816<p>Here is an example color correction collection:</p>
817
818<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000819&lt;?xml version="1.0" encoding="UTF-8"?&gt;
820&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
821 &lt;ColorCorrection id="cc06668"&gt;
822 &lt;SOPNode&gt;
823 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
824 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
825 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
826 &lt;/SOPNode&gt;
827 &lt;SATNode&gt;
828 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
829 &lt;/SATNode&gt;
830 &lt;/ColorCorrection&gt;
831&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000832</pre>
833
834<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000835 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000836</div>
837
838<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>
839
cristyefb2bdb2010-11-20 19:35:22 +0000840<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
841<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
842<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
843<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000844
cristy83a272e2010-05-07 20:40:35 +0000845<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000846abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
847'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
848'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000849
cristy83a272e2010-05-07 20:40:35 +0000850For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
851you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000852<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000853 -channel Red,Blue
854</p>
855<p>or you can use the short hand form</p>
856<p class="crtsnip">
857 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000858</p>
859
cristy83a272e2010-05-07 20:40:35 +0000860<p>All the channels that is present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000861special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
862but generally any operators that are generally 'grey-scale' image operators,
863will understand this setting. See individual operator documentation. </p>
864
cristydcca3fa2010-12-29 21:50:07 +0000865<br />
cristy83a272e2010-05-07 20:40:35 +0000866
867<p>On top of the normal channel selection a extra flag can be specified,
868'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000869operators that understand this flag should perform: cross-channel
870syncronization of the channels. If not specified, then most grey-scale
871operators will apply their image processing operations to each individual
872channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000873setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000874
875<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000876<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000877together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000878it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000879independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000880
cristydcca3fa2010-12-29 21:50:07 +0000881<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000882and the <a href="#compose">-compose</a> mathematical methods, also understands
883the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
884to the alpha channel (if present). That is to say it will modify the image
885processing with the understanding that fully-transparent colors should not
886contribute to the final result. </p>
887
cristydcca3fa2010-12-29 21:50:07 +0000888<p>Basically, by default, operators work with color channels in syncronous, and
cristybac7a162010-06-15 19:57:29 +0000889treats transparency as special, unless the <a href="#channel">-channel</a>
890setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
891How each operator does this depends on that operators current implementation.
892Not all operators understands this flag at this time, but that is changing.
893</p>
cristy83a272e2010-05-07 20:40:35 +0000894
895<p>To print a complete list of channel types, use <a href="#list">-list
896channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000897
cristydcca3fa2010-12-29 21:50:07 +0000898<br />
cristyd934d102009-10-10 12:55:13 +0000899
900<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000901'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
902channels except the transparency channel, and that all the color channels are
903to be modified in exactly the same way, with a understanding of transprancy
904(depending on the operation being applied). The 'plus' form <a
905href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000906
907<p>Options that are affected by the <a href="#channel" >-channel</a> setting
908include the following.
909
910<a href="#auto-gamma">-auto-gamma</a>,
911<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000912<a href="#black-threshold">-black-threshold</a>,
913<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000914<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000915<a href="#clut">-clut</a>,
916<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000917<a href="#composite">-composite</a> (Mathematical compose methods only),
918<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000919<a href="#contrast-stretch">-contrast-stretch</a>,
920<a href="#evaluate">-evaluate</a>,
921<a href="#function">-function</a>,
922<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000923<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000924<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000925<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000926<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000927<a href="#negate">-negate</a>,
928<a href="#normalize">-normalize</a>,
929<a href="#ordered-dither">-ordered-dither</a>,
930<a href="#radial-blur">-radial-blur</a>,
931<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000932<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000933<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000934<a href="#white-threshold">-white-threshold</a>.
935</p>
936
cristyd0bda5e2010-09-21 16:22:45 +0000937<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +0000938>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +0000939href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +0000940default). These operators have yet to be made to understand the newer 'Sync'
941flag. </p>
942
cristybac7a162010-06-15 19:57:29 +0000943<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
944the image before thresholding, if no <a href="#channel" >-channel</a> setting
945has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +0000946
947<p>Also some operators such as <a href="#blur">-blur</a>, <a
948href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
949color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
950href="#channel" >-channel</a>. Generally this done to ensure that
951fully-transparent colors are treated as being fully-transparent, and thus any
952underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +0000953resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +0000954convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +0000955and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +0000956
cristybac7a162010-06-15 19:57:29 +0000957<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +0000958color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +0000959alpha channel present, and the <a href="#channel" >-channel</a> setting tells
960the operator to apply the operation using alpha channels. The <a
961href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +0000962
cristy3ed852e2009-09-05 21:47:34 +0000963
964<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000965 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +0000966</div>
967
968<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>
969
970<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000971 <h4><a id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000972</div>
973
974<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>
975
976<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000977 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000978</div>
979
980<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>
981
cristyefb2bdb2010-11-20 19:35:22 +0000982<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>
983and <em class="arg">height</em> given in the of the <em class="arg">size</em>
984portion of the <em class="arg">geometry</em> argument give the number of
985columns and rows to remove. The <em class="arg">offset</em> portion of
986the <em class="arg">geometry</em> argument is influenced by
987a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +0000988
cristyefb2bdb2010-11-20 19:35:22 +0000989<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
990and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +0000991
cristydcca3fa2010-12-29 21:50:07 +0000992<p>While it can remove internal rows and columns of pixels, it is more typically
993used with as <a href="#gravity">-gravity</a> setting and a '<kbd>+0+0</kbd>' offset
994so as to remove a single edge from an image. Compare this to <a href="#shave"
995>-shave</a> whcih removes equal numbers of pixels from oppisite sides of the image.
996</p>
997
998<p>Using <a href="#chop">-chop</a> will effectivally undo the results of a
999<a href="#splice">-splice</a> that was given the same <em class="arg">geometry</em>
1000and <a href="#gravity">-gravity</a> settings. </p>
1001
1002
cristy3ed852e2009-09-05 21:47:34 +00001003<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001004 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001005</div>
1006
1007<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>
1008
1009<p>If a clipping path is present, it is applied to subsequent operations.</p>
1010
1011<p>For example, in the command</p>
1012
1013<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
1014<p>only the pixels within the clipping path are negated.</p>
1015
1016<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1017
1018<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001019 <h4><a id="clip-mask"></a>-clip-mask</h4>
cristy3ed852e2009-09-05 21:47:34 +00001020</div>
1021
1022<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>
1023
1024<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001025 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001026</div>
1027
1028<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>
1029
1030<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001031 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001032</div>
1033
1034<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>
1035
cristydcca3fa2010-12-29 21:50:07 +00001036<p>Inside parenthesis (where the operator is normally used) it will make a
1037clone of the images from the last 'pushed' image sequence, and adds them to
1038the end of the current image sequence. Outside parenthesis
1039(not recommended) it clones the images from the current image sequence. </p>
1040
cristy3ed852e2009-09-05 21:47:34 +00001041<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000010420. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001043example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001044represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001045dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1046spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
1047effectivally clone all the images. </p>
1048
1049<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
1050in the image sequence, and is thus equivelent to using a argument of
1051'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001052
1053<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001054 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001055</div>
1056
1057<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
1058corresponding channel in the second image as a <b>c</b>olor
1059<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1060
1061<p>The second (LUT) image is ordinarily a gradient image containing the
1062histogram mapping of how each channel should be modified. Typically it is a
1063either a single row or column image of replacement color values. If larger
1064than a single row or column, values are taken from a diagonal line from
1065top-left to bottom-right corners.</p>
1066
1067<p>The lookup is further controlled by the <a
1068href="#interpolate">-interpolate</a> setting, which is especially handy for an
1069LUT which is not the full length needed by the ImageMagick installed Quality
1070(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1071'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1072gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1073lookup of color values. </p>
1074
1075<p>This operator is especially suited to replacing a grayscale image with a
1076specific color gradient from the CLUT image. </p>
1077
1078<p>Only the channel values defined by the <a href="#channel">-channel</a>
1079setting will have their values replaced. In particular, since the default <a
1080href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1081transparency (alpha/matte channel) is not affected, unless the <a
1082href="#channel">-channel</a> setting is modified. When the alpha channel is
1083set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1084as the other channels, implying that alpha/matte values are replaced using the
1085alpha/matte values of the original image. </p>
1086
cristyd0bda5e2010-09-21 16:22:45 +00001087<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001088transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1089href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001090assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001091replacement alpha values. That is you can use a gray-scale CLUT image to
1092adjust a existing images alpha channel, or you can color a gray-scale image
1093using colors form CLUT containing the desired colors, including transparency.
1094</p>
1095
cristyefb2bdb2010-11-20 19:35:22 +00001096<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1097according to the lookup of the full color RGB value from a 2D representation
1098of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001099
1100
1101<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001102 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001103</div>
1104
1105<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
1106
cristyefb2bdb2010-11-20 19:35:22 +00001107<p>Overlay each image in an image sequence according to
1108its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1109an animation at each point in the animation sequence. All images should be
1110the same size, and are assigned appropriate GIF disposal settings for the
1111animation to continue working as expected as a GIF animation. Such frames
1112are more easily viewed and processed than the highly optimized GIF overlay
1113images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001114
cristyefb2bdb2010-11-20 19:35:22 +00001115<p>The animation can be re-optimized after processing using
1116the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1117there is no guarantee that the restored GIF animation optimization is
1118better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001119
1120
1121<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001122 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001123</div>
1124
1125<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
1126
cristyefb2bdb2010-11-20 19:35:22 +00001127<p>Specify the amount of colorization as a percentage. Separate colorization
1128values can be applied to the red, green, and blue channels of the image with
1129a comma-delimited list of colorization
1130values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001131
1132<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001133 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001134</div>
1135
1136<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>
1137
1138<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1139
cristyefb2bdb2010-11-20 19:35:22 +00001140<p>This option only applies when the default X server visual
1141is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1142to <a href="#visual">-visual</a> for more details. By default,
1143a shared colormap is allocated. The image shares colors with
1144other X clients. Some image colors could be approximated,
1145therefore your image may look very different than intended.
1146If <kbd>private</kbd> is chosen, the image colors appear exactly
1147as they are defined. However, other clients may go <em>technicolor</em>
1148when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001149
1150<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001151 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001152</div>
1153
1154<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>
1155
cristyefb2bdb2010-11-20 19:35:22 +00001156<p>The actual number of colors in the image may be less than your request,
1157but never more. Note that this a color reduction option. Images with fewer
1158unique colors than specified by <em class="arg">value</em> will have any
1159duplicate or unused colors removed. The ordering of an existing color
1160palette may be altered. When converting an image from color to grayscale,
1161it is more efficient to convert the image to the gray colorspace before
1162reducing the number of colors. Refer to
1163the <a href="../www/quantize.html">
1164color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001165
1166<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001167 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001168</div>
1169
1170<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>
1171
cristyefb2bdb2010-11-20 19:35:22 +00001172<p>This option permits saturation changes, hue rotation, luminance to alpha,
1173and various other effects. Although variable-sized transformation matrices
1174can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1175for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1176Adobe Flash except offsets are in column 6 rather than 5 (in support of
1177CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001178
1179<p>As an example, to add contrast to an image with offsets, try this command:</p>
1180
1181<pre class="text">
1182convert kittens.jpg -color-matrix \
1183 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1184 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1185 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1186 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1187 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1188 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1189</pre>
1190<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001191 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001192</div>
1193
1194<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>
1195
1196<p>Choices are:</p>
1197
1198<pre class="text">
1199 CMY
1200 CMYK
1201 Gray
1202 HSB
1203 HSL
1204 HWB
1205 Lab
1206 Log
1207 OHTA
1208 Rec601Luma
1209 Rec601YCbCr
1210 Rec709Luma
1211 Rec709YCbCr
1212 RGB
1213 sRGB
1214 Transparent
1215 XYZ
1216 YCbCr
1217 YCC
1218 YIQ
1219 YPbPr
1220 YUV
1221</pre>
1222
1223<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1224
1225<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>
1226
1227<table class="doc">
1228 <caption>Conversion Of RGB To Other Color Spaces</caption>
1229 <tr><th align="left" valign="middle">CMY</th></tr>
1230 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1231 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1232 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1233 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1234 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1235 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1236 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1237 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1238
1239 <tr><th align="left" valign="middle">Gray</th></tr>
1240 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1241
1242 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1243 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1244 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1245 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1246
1247 <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>
1248 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1249 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1250 <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>
1251
1252 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1253 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1254 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1255 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1256
1257 <tr><th align="left" valign="middle">LAB</th></tr>
1258 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1259 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1260 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1261
1262 <tr><th align="left" valign="middle">LOG</th></tr>
1263 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1264 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1265 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1266
1267 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1268 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1269 <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>
1270 <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>
1271
1272 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1273 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1274
1275 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1276 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1277 <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>
1278 <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>
1279
1280 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1281 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1282
1283 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1284 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1285 <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>
1286 <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>
1287
1288 <tr><th align="left" valign="middle">sRGB</th></tr>
1289 <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>
1290 <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>
1291 <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>
1292
1293 <tr><th align="left" valign="middle">XYZ</th></tr>
1294 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1295 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1296 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1297
1298 <tr><th align="left" valign="middle">YCC</th></tr>
1299 <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>
1300 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1301 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1302
1303 <tr><th align="left" valign="middle">YCbCr</th></tr>
1304 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1305 <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>
1306 <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>
1307
1308 <tr><th align="left" valign="middle">YIQ</th></tr>
1309 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1310 <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>
1311 <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>
1312
1313 <tr><th align="left" valign="middle">YPbPr</th></tr>
1314 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1315 <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>
1316 <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>
1317
1318 <tr><th align="left" valign="middle">YUV</th></tr>
1319 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1320 <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>
1321 <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>
1322</table>
1323
1324<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001325 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001326</div>
1327
1328<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>
1329
1330<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>
1331
1332<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.
1333</p>
1334
cristy4949d522010-03-12 18:41:34 +00001335<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 +00001336<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001337 <h4><a id="comment"></a>-comment <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001338</div>
1339
1340<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>
1341
cristyd0bda5e2010-09-21 16:22:45 +00001342<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001343option has been given. To modify a comment of images already in memory use
1344"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001345
cristy71a3f602010-09-15 12:38:16 +00001346<p>The comment can contain special format characters listed in the <a
1347href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001348Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001349is finally assigned to the individual images. </p>
1350
1351<p>If the first character of <em class="arg">string</em> is <em
1352class="arg">@</em>, the image comment is read from a file titled by the
1353remaining characters in the string. Comments read in from a file are literal;
1354no embedded formatting characters are recognized.</p>
1355
1356<p>Comment meta-data are not visible on the image itself. To do that use the
1357<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1358instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001359
1360<p>For example,</p>
1361
1362<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001363 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001364</p>
1365
cristy71a3f602010-09-15 12:38:16 +00001366<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1367that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1368480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001369
1370<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001371 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001372</div>
1373
1374<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>
1375
cristybc9539a2010-08-16 18:06:20 +00001376<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1377a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001378
cristybc9539a2010-08-16 18:06:20 +00001379<p>This setting effects image processing operators that merge two (or more)
1380images together in some way. This includes the operators,
1381<a href="#composite">-composite</a>,
1382<a href="#layers">-layers</a> composite,
1383<a href="#flatten">-flatten</a>,
1384<a href="#mosaic">-mosaic</a>,
1385<a href="#layers">-layers</a> merge,
1386<a href="#border">-border</a>,
1387<a href="#frame">-frame</a>,
1388and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001389
cristybc9539a2010-08-16 18:06:20 +00001390<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1391command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001392
1393
1394<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001395 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001396</div>
1397
cristybc9539a2010-08-16 18:06:20 +00001398<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 +00001399
1400<p>Take the first image 'destination' and overlay the second 'source' image
1401according to the current <a href="#compose">-compose</a> setting. The location
1402of the 'source' or 'overlay' image is controlled according to <a
1403href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1404settings. </p>
1405
1406<p>If a third image is given this is treated as a gray-scale 'mask' image
1407relative to the first 'destination' image. This mask will limit what parts of
1408the destination can be modified by the image composition. However for the
1409'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1410Y-displacement image instead. </p>
1411
1412<p>If a <a href="#compose">-compose</a> method requires extra numerical
1413arguments or flags these can be provided by setting the <a
1414href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001415appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001416
1417<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1418image outside the overlay area. You can disable this by setting the special <a
1419href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1420to '<kbd>false</kbd>'. </p>
1421
1422
1423<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001424 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001425</div>
1426
1427<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>
1428
1429<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>
1430
1431<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1432
1433<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>
1434
1435<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>
1436
1437<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>
1438
1439<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>
1440
1441<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001442 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001443</div>
1444
1445<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>
1446
1447<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>
1448
1449<p>For a more pronounced effect you can repeat the option:</p>
1450
1451<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001453 <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 +00001454</div>
1455
1456<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>
1457
cristyd934d102009-10-10 12:55:13 +00001458<p>While performing the stretch, black-out at most <em
1459class="arg" >black-point</em> pixels and white-out at most <em
1460class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1461<em class="arg" >black-point %</em> pixels and white-out at most <em
1462class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001463
cristyd934d102009-10-10 12:55:13 +00001464<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1465>-contrast-stretch</a> will black-out at most <em class="arg"
1466>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1467minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1468class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1469>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001470
cristyd934d102009-10-10 12:55:13 +00001471<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1472the image's min and max values are stretched to 0 and <em class="QR"
1473>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1474clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001475>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001476prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001477
cristyd934d102009-10-10 12:55:13 +00001478<p>Internally operator works by creating a histogram bin, and then uses that
1479bin to modify the image. As such some colors may be merged together when they
1480originally fell into the same 'bin'. </p>
1481
1482<p>All the channels are normalized in concert by the came amount so as to
1483preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001484setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001485setting will normalize the RGB channels independently.</p>
1486
1487<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1488normalization of mathematical images. </p>
1489
1490<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001491
1492
1493<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001494 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001495</div>
1496
1497<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Convolve an image with a user-supplied convolution kernel.</td><td style='text-align:right;'></td></tr></table>
1498
cristy16ff93c2010-01-13 23:18:07 +00001499<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001500a comma-separated list of integers (with no spaces), ordered left-to right,
1501starting with the top row. Presently, only odd-dimensioned kernels are
1502supported, and therefore the number of entries in the specified <em
1503class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15047<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001505
cristyd934d102009-10-10 12:55:13 +00001506<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
1507positive and negative results are relative to a user-specified bias value.
1508This is important for non-HDRI compilations of ImageMagick when dealing with
1509convolutions that contain negative as well as positive values. This is
1510especially the case with convolutions involving high pass filters or edge
1511detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001512</p>
1513
cristyd934d102009-10-10 12:55:13 +00001514<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
1515negative results without clipping to the color value range (0..QuantumRange).
1516See the discussion on HDRI implementations of ImageMagick on the page <a
1517href="/www/high-dynamic-range.html">High
1518Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1519href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1520<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1521entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001522
cristy3ed852e2009-09-05 21:47:34 +00001523
1524<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001525 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001526</div>
1527
1528<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>
1529
1530<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>
1531
1532<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>
1533
1534<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>
1535
1536<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>
1537
1538<p>By adding a exclamation character flag to the geometry argument, the
1539cropped images virtual canvas page size and offset is set as if the
1540geometry argument was a viewport or window. This means the canvas page size
1541is set to exactly the same size you specified, the image offset set
1542relative top left corner of the region cropped. </p>
1543
1544<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1545special single pixel transparent 'missed' image is returned, and a 'crop
1546missed' warning given. </p>
1547
cristy739df912009-10-24 16:10:18 +00001548<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 +00001549
1550<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001551 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001552</div>
1553
1554<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>
1555
1556<p><em class="arg">Amount</em> defines the number of positions each
1557colormap entry is shifted.</p>
1558
1559
1560<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001561 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001562</div>
1563
1564<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>enable debug printout.</td><td style='text-align:right;'></td></tr></table>
1565
1566<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>
1567
1568
1569<p>For example, to log cache and blob events, use.</p>
1570
1571<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1572<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1573
1574<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1575
1576<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1577
1578<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1579
1580<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>
1581
1582
1583<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001584 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001585</div>
1586
1587<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>
1588
1589<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1590
1591<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1592
1593
1594<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001595 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001596</div>
1597
1598<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>
1599
1600<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>
1601
1602<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>
1603
1604<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1605
1606
1607<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001608 <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 +00001609</div>
1610
cristyd0bd44a2010-09-24 12:38:11 +00001611<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 +00001612coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001613
cristyd0bda5e2010-09-21 16:22:45 +00001614<p>This option creates one or more definitions for coders and decoders to use
1615while reading and writing image data. Definitions are generally used to
1616control image file format coder modules, and image processing operations,
1617beyond what is provided by normal means. Defined settings are listed in <a
1618href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1619as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001620
cristyd0bda5e2010-09-21 16:22:45 +00001621<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1622definition of a flag is created with that name. This used to control on/off
1623options. Use <a href="#define">+define key</a> to remove definitions
1624previously created. Use <a href="#define">+define "*"</a> to remove all
1625existing definitions.</p>
1626
cristyd0bd44a2010-09-24 12:38:11 +00001627<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001628href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001629>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 +00001630Properties</a> in the defined value. </p>
1631
cristyefb2bdb2010-11-20 19:35:22 +00001632<p>The <em>option</em> and <em>key</em> are case-independent (they are
1633converted to lowercase for use within the decoders) while the <em>value</em>
1634is case-dependent.</p>
1635
cristyd0bda5e2010-09-21 16:22:45 +00001636<p>Such settings are global in scope, and effect all images and operations. </p>
1637
1638<p>The following definitions are just some of the artifacts that are
1639available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001640
cristydcca3fa2010-12-29 21:50:07 +00001641<dl>
cristy045bd902010-01-30 18:56:24 +00001642<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001643<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001644 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001645
cristy045bd902010-01-30 18:56:24 +00001646<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001647<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001648 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001649
cristy045bd902010-01-30 18:56:24 +00001650<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001651<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001652 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001653
cristy045bd902010-01-30 18:56:24 +00001654<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001655<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1656 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001657 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001658
cristy045bd902010-01-30 18:56:24 +00001659<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001660<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1661 compression factor is the reciprocal of the compression ratio. The valid
1662 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1663 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001664 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001665
cristy3ed852e2009-09-05 21:47:34 +00001666<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001667 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001668
cristy045bd902010-01-30 18:56:24 +00001669<dt>png:bit-depth=<em class="arg">value</em></dt>
1670<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001671<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1672 encoder to use a different bit-depth and color-type than it would have
1673 normally selected, but only if this does not cause any loss of image
1674 quality. Any attempt to reduce image quality is treated as an error and no
1675 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1676 can use these "defines" to cause it to be written as an 8-bit grayscale,
1677 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1678 you cannot force it to be written as a grayscale or indexed PNG. If you
1679 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1680 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1681 reduce the image quality prior to using the PNG encoder. Note that in
1682 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001683 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001684 8-bit depth.</dd>
1685
1686<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1687<dt>png:include-chunk=<em class="arg">value</em></dt>
1688<dd>ancillary chunks to be excluded from or included in PNG output.
1689
1690 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1691 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1692 or the word <em class="arg">all</em> or
1693 the word <em class="arg">none</em>. There must be no spaces in the
1694 list. Although PNG chunk-names are case-dependent, you can use
1695 all lowercase names if you prefer.</p>
1696
1697 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1698 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1699 only be written if gamma is not 1/2.2, since most decoders assume
1700 sRGB and gamma=1/2.2 when no colorspace information is included in
1701 the PNG file. Because the list is processed from left to right, you
1702 can achieve this with a single define:</p>
1703
1704<pre class="text">
1705 -define png:include-chunk=none,gAMA
1706</pre>
1707
1708 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
1709 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any of
1710 these entries appearing in the list will be ignored.</p>
1711
1712 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1713 image has transparency, the PNG colortype is forced to be 4 or 6
1714 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1715 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1716 on the PNG colortype of the output image.</p>
1717
1718 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1719 following for PNG output:</p>
1720
1721<pre class="text">
1722 -define png:include-chunk=none,gama
1723</pre>
1724
1725 <p>The default behavior is to include all known PNG ancillary chunks
1726 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk.</p>
1727 </dd>
cristyd0bda5e2010-09-21 16:22:45 +00001728
cristy3ed852e2009-09-05 21:47:34 +00001729<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001730<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1731 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001732 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001733
cristy045bd902010-01-30 18:56:24 +00001734<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001735<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1736 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1737 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001738 included, the result is a single precision floating point format.
1739 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001740 double precision floating point format.</dd>
1741
cristydcca3fa2010-12-29 21:50:07 +00001742</dl>
cristy3ed852e2009-09-05 21:47:34 +00001743
cristyd0bda5e2010-09-21 16:22:45 +00001744<p>For example, to create a postscript file that will render only the black
1745pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001746
1747<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 +00001748<p>Set attributes of the image registry by prefixing the value with
1749<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1750use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001751
1752<p class="crtsnip">
1753-define registry:temporary-path=/data/tmp
1754</p>
1755
cristyd0bda5e2010-09-21 16:22:45 +00001756
1757
cristy3ed852e2009-09-05 21:47:34 +00001758<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001759 <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 +00001760</div>
1761
1762<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>
1763
1764<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>
1765
1766<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>
1767
1768
1769<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001770 <h4><a id="delete"></a>-delete <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001771</div>
1772
1773<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>
1774
1775<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>
1776
1777
1778<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001779 <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 +00001780</div>
1781
1782<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>
1783
1784<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>
1785
1786<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>
1787
1788<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>
1789
1790<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>
1791
1792<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001793 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001794</div>
1795
1796<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>
1797
1798<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>
1799
1800<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001801 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00001802</div>
1803
1804<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>
1805
1806<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001807 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></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%'>straighten an image. A threshold of 40% works for most images.</td><td style='text-align:right;'></td></tr></table>
1811
1812<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>
1813
1814<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001815 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00001816</div>
1817
1818<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>
1819
1820<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001821 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001822</div>
1823
1824<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>
1825
1826<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001827 <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 +00001828</div>
1829
1830<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>
1831
1832<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001833is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001834what part of the 'background' image is seen at each point of the overlaid
1835area. Much like the displacement map is a 'lens' that redirects light shining
1836through it so as to present a distorted view the original 'background' image
1837behind it. </p>
1838
1839<p>Any perfect grey areas of the displacement map produce a zero
1840displacement of the image. Black areas produce the given maximum negative
1841displacement of the lookup point, while white produce a maximum positive
1842displacement of the lookup. </p>
1843
1844<p>Note that it is the lookup of the 'background' that is displaced, not a
1845displacement of the image itself. As such an area of the displacement map
1846containing 'white' will have the lookup point 'shifted' by a positive amount,
1847and thus generating a copy of the destination image to the right/downward from
1848the correct position. That is the image will look like it may have been
1849'shifted' in a negative left/upward direction. Understanding this is a very
1850important in understanding how displacement maps work. </p>
1851
1852<p>The given arguments define the maximum amount of displacement in pixels
1853that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001854it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001855outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001856easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001857into the overlay area. </p>
1858
1859<p>The '%' flag makes the displacement scale relative to the size of the
1860overlay image (100% = half width/height of image). Using '!' switches
1861percentage arguments to refer to the destination image size instead.
1862these flags were added as of IM v6.5.3-5.</p>
1863
1864<p>Normally a single grayscale displacement map is provided, which with the
1865given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001866displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001867specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001868the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001869displacement, while the <em class="arg">mask image</em> is used for vertical Y
1870displacement. This allows you to define completely different displacement
1871values for the X and Y directions, and allowing you to lookup any point within
1872the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001873any other nearby pixel, producing complex 2 dimensional displacements, rather
1874than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001875
cristyd0bda5e2010-09-21 16:22:45 +00001876<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001877you can use the 'red' channel of the overlay image to specify the horizontal
1878or X displacement, and the 'green' channel for the vertical or Y displacement.
1879</p>
1880
cristyd0bd44a2010-09-24 12:38:11 +00001881<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 +00001882mask the transparency of the destination image. However areas outside the
1883overlaid areas will not be effected. </p>
1884
1885
1886<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001887 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001888</div>
1889
1890<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>
1891
1892<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1893
1894<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001895 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001896</div>
1897
1898<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>define the GIF disposal image setting for images that are being created or read in. </td><td style='text-align:right;'></td></tr></table>
1899
1900<p>The layer disposal method defines the way each the displayed image is to be
1901modified after the current 'frame' of an animation has finished being
1902displayed (after its 'delay' period), but before the next frame on an
1903animation is to be overlaid onto the display. </p>
1904
1905<p>Here are the valid methods:</p>
1906
1907<pre class="text">
1908Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
1909None 1 Do not dispose, just overlay next frame image.
1910Background 2 Clear the frame area with the background color.
1911Previous 3 Clear to the image prior to this frames overlay.
1912</pre>
1913
1914<p>You can also use the numbers given above, which is what the GIF format
1915uses internally to represent the above settings. </p>
1916
cristyd0bda5e2010-09-21 16:22:45 +00001917<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00001918
1919<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
1920resetting the layer disposal methods of images being read in. </p>
1921
1922<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
1923disposal method for images already in memory.</p>
1924
1925<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001926 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001927</div>
1928
1929<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>
1930
1931
1932<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001933 <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 +00001934</div>
1935
1936<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>
1937
1938<p>The opacity of the composite image is multiplied by the given percent, then
1939it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00001940is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00001941transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
1942are given, each image are dissolved to the percentages given. </p>
1943
1944<p>Note that dissolve percentages do not add, two opaque images dissolved
1945'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
1946images, you would need to use dissolve values of '50,100'. </p>
1947
1948<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001949 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001950</div>
1951
1952<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>
1953
1954<p>The <em class="arg">arguments</em> is a single string containing a list
1955of floating point numbers separated by commas or spaces. The number of
1956and meaning of the floating point values depends on the distortion <em
1957class="arg">method</em> being used. </p>
1958
1959<p>Choose from these distortion types:</p>
1960
1961<table class="doc">
1962 <tr valign="top">
1963 <th align="left" style="width: 8%">Method</th>
1964 <th align="left">Description</th>
1965 </tr>
1966
1967 <tr valign="top">
1968 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
1969 <br/>or &nbsp; <kbd>SRT</kbd></td>
1970 <td valign="top">
1971 Distort image by first scaling and rotating about a given 'center',
1972 before translating that 'center' to the new location, in that order. It
1973 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
1974 distortion, but without shearing effects. It also provides a good way
1975 of rotating and displacing a smaller image for tiling onto a larger
1976 background (IE 2-dimensional animations). <br/>
1977
1978 The number of arguments determine the specific meaning of each
1979 argument for the scales, rotation, and translation operations. <br/>
1980
1981 <table style="margin-left:auto; margin-right:auto;">
1982 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
1983 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
1984 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00001985 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00001986 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
1987 <tr><td>5:</td>
1988 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
1989 <tr><td>6:</td>
1990 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
1991 <tr><td>7:</td>
1992 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
1993 &nbsp; NewX,NewY</em></td></tr>
1994 </table>
1995
cristyd0bda5e2010-09-21 16:22:45 +00001996 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00001997 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
1998
1999 <tr valign="top">
2000 <td valign="top"><kbd>Affine</kbd></td>
2001 <td valign="top">
2002 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002003 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002004 point values are given allowing the image to be linearly scaled,
2005 rotated, sheared, and translated, according to those three points. See
2006 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2007 distortions. <br/>
2008
2009 More than 3 sets given control point pairs (12 numbers) is least
2010 squares fitted to best match a lineary affine distortion. If only 2
2011 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002012 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002013 flipping or changes in aspect ratio to the resulting image. If only one
2014 control point pair is provides the image is only translated, (which may
2015 be a floating point non-integer translation). <br/>
2016
2017 This distortion does not include any form of perspective distortion.
2018 </td>
2019
2020 </tr>
2021
2022 <tr valign="top">
2023 <td valign="top"><kbd>AffineProjection</kbd></td>
2024 <td valign="top">
2025 Linearly distort an image using the given Affine Matrix of 6
2026 pre-calculated coefficients forming a set of Affine Equations to map
2027 the source image to the destination image.
2028
2029 <div style="text-align: center"><em>
2030 s<sub>x</sub>, r<sub>x</sub>,
2031 r<sub>y</sub>, s<sub>y</sub>,
2032 t<sub>x</sub>, t<sub>y</sub>
2033 </em></div>
2034
2035 See <a href="#affine" >-affine</a> setting for more detail, and
2036 meanings of these coefficients. <br/>
2037
2038 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002039 alternative methods of defining this distortion, with ImageMagick doing
2040 the calculations needed to generate the required coefficients. You can
2041 see the internally generated coefficients, by using a <a
2042 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002043
2044 </tr>
2045
cristy3ed852e2009-09-05 21:47:34 +00002046 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002047 <td valign="top"><kbd>BilinearForward</kbd><br/>
2048 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002049 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002050 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2051 16 values (see below). Not that lines may not appear straight after
2052 distortion, though the distance between coordinates will remain
2053 consistent. <br/>
2054
2055 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2056 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2057 quadrilateral to a rectangle, while preserving the straigth line edges
2058 in each case. <br/>
2059
2060 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2061 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2062 color setting. Also if the quadraterial becomes 'flipped' the image
2063 may dissappear. <br/>
2064
2065 There are future plans to produce a true Bilinear distortion that will
2066 attempt to map any quadrilateral to any other quadrilateral, while
2067 preserving edges (and edge distance ratios).
2068
2069 </td>
cristy3ed852e2009-09-05 21:47:34 +00002070 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002071
2072 <tr valign="top">
2073 <td valign="top"><kbd>Perspective</kbd></td>
2074 <td valign="top">
2075 Perspective distort the images, using a list of 4 or more sets of
2076 control points (as defined below). More that 4 sets (16 numbers) of
2077 control points provide least squares fitting for more accurate
2078 distortions (for the purposes of image registration and panarama
2079 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2080 linear distortion. <br/>
2081
2082 Perspective Distorted images ensures that straight lines remain
2083 straight, but the scale of the distorted image will vary. The horizon
2084 is anti-aliased, and the 'sky' color may be set using the
2085 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2086 </tr>
2087
2088 <tr valign="top">
2089 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2090 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002091 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002092 pre-calculated coefficients. You can get these coefficients by looking
2093 at the <a href="#verbose" >-verbose</a> output of a
2094 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2095 If the last two perspective scaling coefficients are zero, the
2096 remaining 6 represents a transposed 'Affine Matrix'. </td>
2097
2098 </tr>
2099
2100 <tr valign="top">
2101 <td valign="top"><kbd>Arc</kbd></td>
2102 <td valign="top">
2103 Arc the image (variation of polar mapping) over the angle given around
2104 a circle. <br/>
2105 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2106 <tr valign="top"><td>Argument</td>
2107 <td>Meaning</td></tr>
2108 <tr valign="top"><td><em>arc_angle</em></td>
2109 <td>The angle over which to arc the image side-to-side</td></tr>
2110 <tr valign="top"><td><em>rotate_angle</em></td>
2111 <td>Angle to rotate resulting image from vertical center</td></tr>
2112 <tr valign="top"><td><em>top_radius</em></td>
2113 <td>Set top edge of source image at this radius</td></tr>
2114 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2115 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2116 </table>
2117
2118 The resulting image is always resized to best fit the resulting image,
2119 (as if using <a href="#distort" >+distort</a>) while attempting to
2120 preserve scale and aspect ratio of the original image as much as
2121 possible with the arguments given by the user. All four arguments will
2122 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2123
2124 This a variation of a polar distortion designed to try to preserve the
2125 aspect ratio of the image rather than direct Cartesian to Polar
2126 conversion. </td>
2127 </tr>
2128
2129 <tr valign="top">
2130 <td valign="top"><kbd>Polar</kbd></td>
2131 <td valign="top">
2132 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2133 the image. that is the height of the input image is mapped to the
2134 radius limits, while the width is wrapped around between the
2135 angle limits. <br/>
2136
2137 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2138
2139 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2140 center to the center of the image, and the angles going from -180 (top)
2141 to +180 (top). If <em>Rmax</em> is given the special value of
2142 '<code>0</code>', the the distance from the center to the nearest edge
2143 is used for the radius of the output image, which will ensure the whole
2144 image is visible (though scaled smaller). However a special value of
2145 '<code>-1</code>' will use the distance from the center to the furthest
2146 corner, This may 'clip' the corners from the input rectangular image,
2147 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2148 the same arguments. <br/>
2149
2150 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2151 output image center will default to <code>0,0</code> of the virtual
2152 canvas, and the image size adjusted to ensure the whole input image is
2153 made visible in the output image on the virtual canvas. </td>
2154
2155 </tr>
2156
2157 <tr valign="top">
2158 <td valign="top"><kbd>DePolar</kbd></td>
2159 <td valign="top">
2160 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2161 but generates the reverse Polar to Cartesian distortion. <br/>
2162
2163 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2164 the corners of the input image. However using the special
2165 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2166 distance) will ensure the whole distorted image is preserved in the
2167 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2168 reverse the distortion re-producing the original.
2169
2170 Note that as this distortion requires the area resampling of a circular
2171 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002172 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002173 form of 'super-sampling' image processing technique be used to produce
2174 a high quality result. </td>
2175
2176 </tr>
2177
2178 <tr valign="top">
2179 <td valign="top"><kbd>Barrel</kbd></td>
2180 <td valign="top">
2181 Given the four coefficients (A,B,C,D) as defined by <a
2182 href="http://www.all-in-one.ee/~dersch/barrel/barrel.html" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002183 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002184 correct radial lens distortions. That is in photographs, make straight
2185 lines straight again. <br/>
2186
2187 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2188 <em>X</em> , <em>Y</em> ] ] <br/>
2189 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2190 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2191 [ <em>X</em> , <em>Y</em> ] <br/>
2192 So that it forms the function <br/>
2193 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2194 <em>C</em>*r + <em>D</em> )<br/>
2195
2196 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2197 (defaulting to the center of the image). <br/>
2198 The second form is typically used to distort images, rather than
2199 correct lens distortions. <br/>
2200 </td>
2201
2202 </tr>
2203
2204 <tr valign="top">
2205 <td valign="top"><kbd>BarrelInverse</kbd></td>
2206 <td valign="top">
2207 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2208 arguments, and argument handling. However it uses the inverse
2209 of the radial polynomial,
2210 so that it forms the function <br/>
2211 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002212 <em>C</em>*r + <em>D</em> )<br/>
2213 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2214 distortion, just a different barrel-like radial distortion method.
2215
cristy3ed852e2009-09-05 21:47:34 +00002216 </td>
2217 </tr>
2218
2219 <tr valign="top">
2220 <td valign="top"><kbd>Shepards</kbd></td>
2221 <td valign="top">
2222 Distort the given list control points (any number) using an Inverse
2223 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002224 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2225 Method</a>). The control points in effect do 'localized' displacement
2226 of the image around the given control point (preserving the look and
2227 the rotation of the area near the control points. For best results
2228 extra control points should be added to 'lock' the positions of the
2229 corners, edges and other unchanging parts of the image, to prevent
2230 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002231
cristyd0bd44a2010-09-24 12:38:11 +00002232 The distortion has been likened to 'taffy pulling' using nails, or
2233 pins' stuck in a block of 'jelly' which is then moved to the new
2234 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002235
cristyd0bd44a2010-09-24 12:38:11 +00002236 Internally it is equivelent to generating a displacement map (see <a
2237 href="#displace" >-displace</a>) for source image color look-up using
2238 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2239
2240 </td>
cristy3ed852e2009-09-05 21:47:34 +00002241 </tr>
2242
2243</table>
2244
cristyd0bd44a2010-09-24 12:38:11 +00002245<p>To print a complete list of distortion methods, use <a href="#list">-list
2246distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002247
2248<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2249'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2250defining how these points in the given image should be distorted in the
2251destination image. Each set of four floating point values represent a source
2252image coordinate, followed immediately by the destination image coordinate.
2253This produces a list of values such as...</p>
2254<div style="text-align: center"><em>
2255 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2256 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2257 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2258 ... &nbsp;
2259 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2260</em></div>
2261<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2262destination image. </p>
2263
2264<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2265needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2266perspective distortion of the built-in "rose:" image. Note how spaces were
2267used to group the 4 sets of coordinate pairs, to make it easier to read and
2268understand.</p>
2269
2270<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002271convert rose: -virtual-pixel black \<br/>
2272 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2273 rose_3d_rotated.gif</span></p>
2274<p>If more that the required number of coordinate pairs are given for
2275a distortion, the distortion method is 'least squares' fitted to produce the
2276best result for all the coordinate pairs given. If less than the ideal number
2277of points are given, the distort will generally fall back to a simpler form of
2278distortion that can handles the smaller number of coordinates (usally a linear
2279'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002280
cristyd0bda5e2010-09-21 16:22:45 +00002281<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002282find matching coordinate pairs in overlapping images, so as to improve the
2283'fit' of the distortion. Of course a bad coordinate pair can also make the
2284'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002285
2286<p>Colors are acquired from the source image according to the <a
2287href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002288magnified. However if the viewed image is minified (image becomes smaller),
2289a special area resampling function (added ImageMagick v6.3.5-9), is used to
2290produce a higher quality image. For example you can use
2291a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2292the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002293
cristyd0bd44a2010-09-24 12:38:11 +00002294<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2295convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2296 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2297 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002298<p>Note that a infinitely tiled perspective images involving the horizon can
2299be very slow to generate due to the use of the high quality 'area resampling'
2300function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2301using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2302(recommended if you plan to use super-sampling instead). </p>
2303
2304<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2305'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2306will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2307pixels. If you do not what these pixels to be visible, set the color to match
2308the rest of the ground. </p>
2309
2310<p>The output image size will by default be the same as the input image. This
2311means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002312the 'distorted space', those parts is clipped and lost. However if you use
2313the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2314will attempt (if possible) to show the whole of the distorted image, while
2315retaining a correct 'virtual canvas' offset, for image layering. This offset
2316may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2317is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002318
2319<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2320option:distort:viewport {geometry_string}</kbd>" setting which will specify
2321the size and the offset of the generated 'viewport' image of the distorted
2322image space.</p>
2323
2324<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2325{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2326that factor without changing the viewed contents of the distorted image. This
2327can be used either for 'super-sampling' the image for a higher quality result,
2328or for panning and zooming around the image (with appropriate viewport
2329changes, or post-distort cropping and resizing). </p>
2330
2331<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2332href="#distort" >-distort</a> to attempt to output the internal coefficients,
2333and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2334and debugging purposes. This many not be available for all distorts. </p>
2335
2336<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2337produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2338and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002339above settings. It is algorithmically slower however, though that may not be
2340the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002341
2342
2343<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002344 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002345</div>
2346
2347<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>
2348
cristyd0bda5e2010-09-21 16:22:45 +00002349<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 +00002350
2351<p>Dithering is turned on by default, to turn it off use the plus form of the
2352setting, <a href="#dither">+dither</a>. This will also also render PostScript
2353without text or graphic aliasing. Disabling dithering often (but not always)
2354leads to faster process, a smaller number of colors, but more cartoon like
2355image coloring. Generally resulting in 'color banding' effects in areas with
2356color gradients. </p>
2357
2358<p>The color reduction operators <a href="#colors">-colors</a>, <a
2359href="#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>
2360
2361<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>
2362
2363
2364<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002365 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002366</div>
2367
2368<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>
2369
2370<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>
2371
2372<p>The shape primitives:</p>
2373
2374<pre class="text">
2375 point x,y
2376 line x0,y0 x1,y1
2377 rectangle x0,y0 x1,y1
2378 roundRectangle x0,y0 x1,y1 wc,hc
2379 arc x0,y0 x1,y1 a0,a1
2380 ellipse x0,y0 rx,ry a0,a1
2381 circle x0,y0 x1,y1
2382 polyline x0,y0 ... xn,yn
2383 polygon x0,y0 ... xn,yn
2384 bezier x0,y0 ... xn,yn
2385 path path specification
2386 image operator x0,y0 w,h filename
2387</pre>
2388
2389<p>The text primitive:</p>
2390
2391<pre class="text">
2392 text x0,y0 string
2393</pre>
2394<p>The text gravity primitive:</p>
2395
2396<pre class="text">
2397 gravity NorthWest, North, NorthEast, West, Center,
2398 East, SouthWest, South, or SouthEast
2399</pre>
2400
2401<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>
2402
2403<p>The transformation primitives:</p>
2404
2405<pre class="text">
2406 rotate degrees
2407 translate dx,dy
2408 scale sx,sy
2409 skewX degrees
2410 skewY degrees
2411</pre>
2412
2413<p>The pixel operation primitives:</p>
2414
2415<pre class="text">
2416 color x0,y0 method
2417 matte x0,y0 method
2418</pre>
2419
2420<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>
2421
2422<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>
2423
2424<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2425
2426<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2427
2428<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>
2429
2430<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2431
2432<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>
2433
2434<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>
2435
2436<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>.
2437</p>
2438
2439<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2440
2441<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2442
2443<p class="crtsnip">
2444 -draw 'circle 100,100 150,150'
2445</p>
2446
2447<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
2448draw 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>
2449
2450<p class="crtsnip">
2451 -draw 'bezier 20,50 45,100 45,0 70,50'
2452</p>
2453<p class="crtsnip">
2454 -draw 'bezier 70,50 95,100 95,0 120,50'
2455</p>
2456
2457
2458<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>
2459
2460<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>
2461
2462<p class="crtsnip">
2463 -draw 'image SrcOver 100,100 225,225 image.jpg'
2464</p>
2465
cristybc9539a2010-08-16 18:06:20 +00002466<p>You can use 0,0 for the image size, which means to use the actual
2467dimensions found in the image header. Otherwise, it is scaled to the given
2468dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
2469a detailed discussion of alpha composition methods that are available. </p>
cristy3ed852e2009-09-05 21:47:34 +00002470
2471<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>
2472
2473<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2474
2475<p class="crtsnip">
2476 -draw 'text 100,100 "Works like magick!"'
2477</p>
2478
2479<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2480
2481<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>
2482
2483<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2484
2485<p>The <kbd>scale</kbd> primitive scales them.</p>
2486
2487<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>
2488
2489<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
2490matrix.</p>
2491
2492<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>
2493
2494<pre class="text">
2495 point
2496 replace
2497 floodfill
2498 filltoborder
2499 reset
2500</pre>
2501
2502<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>
2503
2504<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>
2505
2506<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>
2507
2508<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2509
2510<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2511
2512
2513<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002514 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002515</div>
2516
2517<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>
2518
2519<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002520 <h4><a id="emboss"></a>-emboss <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%'>emboss 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="encipher"></a>-encipher <em class="arg">filename</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%'>Encipher pixels for later deciphering by <a href="#decipher">-decipher</a>.</td><td style='text-align:right;'></td></tr></table>
2530
2531<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2532
2533<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2534
cristyd0bda5e2010-09-21 16:22:45 +00002535
2536
cristy3ed852e2009-09-05 21:47:34 +00002537<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002538 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002539</div>
2540
2541<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>
2542
2543<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>
2544
2545<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002546 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002547</div>
2548
2549<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>
2550
2551<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2552
2553<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2554
2555
2556<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002557 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002558</div>
2559
2560<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>
2561
2562
2563<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002564 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002565</div>
2566
2567<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>
2568
2569<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>
2570
2571<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2572
2573<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>
2574
2575<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002576 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002577</div>
2578
2579<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>
2580
2581<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>
2582
2583<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>
2584
2585<table class="doc">
2586 <col width="25%" />
2587 <col width="75%" />
2588 <thead>
2589 <tr>
2590 <th><em class="arg">operator</em></th>
2591 <th>Summary (see further below for details)</th>
2592 </tr>
2593 </thead>
2594 <tbody>
2595
cristy3c98a4f2010-08-13 20:09:41 +00002596 <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 +00002597 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2598 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2599 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2600 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2601 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002602 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2603 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002604 <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>
2605 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2606 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002607 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002608 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002609 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2610 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2611 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2612 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2613 <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>
2614 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2615 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2616 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2617 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2618
2619 <tr><td>&nbsp;</td></tr>
2620
2621 <tr><td>Gaussian-noise</td></tr>
2622 <tr><td>Impulse-noise</td></tr>
2623 <tr><td>Laplacian-noise</td></tr>
2624 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2625 <tr><td>PoissonNoise</td></tr>
2626 <tr><td>Uniform-noise</td></tr>
2627
2628 <tr><td>&nbsp;</td></tr>
2629
2630 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2631 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2632 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2633 </tbody>
2634 </table>
2635
2636<p>The specified functions are applied only to each previously set <a
2637href="#channel" >-channel</a> in the image. If necessary, the results of the
2638calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2639class="QR">QuantumRange</em>]. The transparency channel of the image is
2640represented as a 'alpha' values (0 = fully transparent), so, for example, a
2641<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2642semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2643as a percentage of the <em class="QR">QuantumRange</em>.</p>
2644
2645<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2646<a href="#list">-list evaluate</a>.</p>
2647
2648<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2649<kbd>Multiply</kbd> methods can also be achieved using either the <a
2650href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2651appropriate argument, to linearly modify the overall range of color values.
2652Please note, however, that <a href="#level" >-level</a> treats transparency as
2653'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2654'alpha' values.</p>
2655
2656<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>
2657
cristyce66ab12010-10-21 23:36:32 +00002658<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>
2659
2660 <div style="text-align:center;">
2661 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2662 </div>
2663
2664<p> If the input image is squared, for example, using <a
2665href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2666
cristy3ed852e2009-09-05 21:47:34 +00002667<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>
2668
2669 <div style="text-align:center;">
2670 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2671 </div>
2672
2673<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2674normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2675href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2676to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2677with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2678with <kbd>Pow</kbd>.</p>
2679
2680<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2681converts the image values into a value according to a (co)sine wave function.
2682The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2683is biased 50% and normalized by 50% so as to fit in the respective color value
2684range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2685function (its frequency), and thus determines the number of 'waves' that will
2686be generated over the input color range. For example, if the <em
2687class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2688class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2689then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002690class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002691
2692 <div style="text-align:center;">
2693 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2694 </div>
2695
cristydcca3fa2010-12-29 21:50:07 +00002696<p>See also the <a href="#function" >-function</a> operator, which is a
2697multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002698
cristy63fed272010-03-07 19:08:45 +00002699<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002700 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002701</div>
2702
2703<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 +00002704
2705<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002706 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002707</div>
2708
2709<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>
2710
cristy3e2860c2010-01-24 01:36:30 +00002711<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 +00002712<p>This command reduces or expands a JPEG image to fit on an 800x600
2713display. If the aspect ratio of the input image isn't exactly 4:3, then the
2714image is centered on an 800x600 black canvas: </p>
2715
2716<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>
2717
cristy3ed852e2009-09-05 21:47:34 +00002718
2719<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>
2720
2721<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002722 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002723</div>
2724
2725<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>
2726
2727<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2728
cristy4949d522010-03-12 18:41:34 +00002729<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 +00002730
cristy4949d522010-03-12 18:41:34 +00002731<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 +00002732<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002733equivalent to:</p>
2734
2735<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>
2736<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>
2737
2738<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002739 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002740</div>
2741
2742<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>
2743
2744<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).
2745</p>
2746
2747<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>.
2748</p>
2749
2750<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002751 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002752</div>
2753
2754<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>
2755
2756<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002757 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002758</div>
2759
2760<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>
2761
cristydcca3fa2010-12-29 21:50:07 +00002762<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 +00002763
cristydcca3fa2010-12-29 21:50:07 +00002764<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 +00002765
2766<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>
2767
2768<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2769<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>
2770
2771<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2772<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>
2773
cristyd0bd44a2010-09-24 12:38:11 +00002774<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 +00002775
2776<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>
2777
2778<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2779 -evaluate log 1000 fft_image_spectrum.png</span></p>
2780<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>
2781
cristydcca3fa2010-12-29 21:50:07 +00002782<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 +00002783
2784<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>
2785
2786<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>
2787
cristydcca3fa2010-12-29 21:50:07 +00002788<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 +00002789
2790<p>See the discussion on HDRI implementations of ImageMagick on the page
2791<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.
2792</p>
2793
2794
2795<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002796 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002797</div>
2798
2799<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>
2800
2801<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>
2802
2803<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2804
2805<p>For example,</p>
2806
2807<p class="crtsnip">
2808 -fill blue
2809</p>
2810<p class="crtsnip">
2811 -fill "#ddddff"
2812</p>
2813<p class="crtsnip">
2814 -fill "rgb(255,255,255)"
2815</p>
2816
2817<p>See <a href="#draw">-draw</a> for further details.</p>
2818
2819<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2820
2821<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002822 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002823</div>
2824
cristyd0bda5e2010-09-21 16:22:45 +00002825<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
2826distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002827
cristyd0bda5e2010-09-21 16:22:45 +00002828<p>Use this option to affect the resizing operation of an image during
2829operations such as <a href="#resize">-resize</a> and <a href="#distort"
2830>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002831
2832<pre class="text">
2833 Point Hermite Cubic
2834 Box Gaussian Catrom
2835 Triangle Quadratic Mitchell
2836</pre>
2837
cristyd0bda5e2010-09-21 16:22:45 +00002838<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002839as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2840generally useless on their own as they are infinite filters that are being
2841clipped to the filters support size. Their direct use is not recommended
2842except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002843
cristydcca3fa2010-12-29 21:50:07 +00002844<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002845function that the <a href="#filter" >-filter</a> setting defines. That is
2846using these functions will define a 'Windowed' filter, appropriate to the
2847operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002848
2849<pre class="text">
2850 Lanczos Hamming Parzen
2851 Blackman Kaiser Welsh
2852 Hanning Bartlett Bohman
2853</pre>
2854
2855<p>Also one special self-windowing filter is also provided
2856<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2857on the current 'support' or 'lobes' expert settings (see below).</p>
2858
cristyd0bda5e2010-09-21 16:22:45 +00002859<p>If you do not select a filter with this option, the filter defaults to
2860<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2861if the image is enlarged. Otherwise the filter default to
2862<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002863
cristyd0bda5e2010-09-21 16:22:45 +00002864<p>To print a complete list of resize filters, use the <a href="#list">-list
2865filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002866
2867<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002868use of these expert settings (see also <a href="#define" >-define</a> and <a
2869href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002870
2871<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002872<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002873<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002874 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2875 Gaussian-like filters simple filters, or you may not get the expected
2876 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002877
cristyd0bda5e2010-09-21 16:22:45 +00002878<dt>-define filter:support=<em>radius</em></dt>
2879<dd>Set the filter support radius. Defines how large the filter should be and
2880 thus directly defines how slow the filtered resampling process is. All
2881 filters have a default 'prefered' support size. Some filters like
2882 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2883 this value. With simple filters this value either does nothing (but slow
2884 the resampling), or will clip the filter function in a detrimental way.
2885 </dd>
cristy3ed852e2009-09-05 21:47:34 +00002886
cristyd0bda5e2010-09-21 16:22:45 +00002887<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002888<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00002889 alternative way of specifying the 'support' range of the filter, that is
2890 designed to be more suited to windowed filters, especially when used for
2891 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002892
cristyd0bda5e2010-09-21 16:22:45 +00002893<dt>-define filter:b=<em>b-spline_factor</em></dt>
2894<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002895<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2896 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2897 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2898 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00002899 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00002900 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002901
cristyd0bda5e2010-09-21 16:22:45 +00002902<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002903<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00002904 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00002905 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00002906 'Bessel' functions. If defined, no windowing function is used, unless the
2907 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002908
cristyd0bda5e2010-09-21 16:22:45 +00002909<dt>-define filter:window=<em>filter_function</em></dt>
2910<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
2911 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
2912 support range) with the given filter. This allows you to specify a filter
2913 function that is not normally used as a windowing function, such as
2914 <kbd>Box</kbd>, (which effectively turns off the windowing function),
2915 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
2916 </dd>
2917
2918<dt>-define filter:verbose=<em>1</em></dt>
2919<dd>This causes IM to print information on the final internal filter
2920 selection to standard output. This includes a commented header on the
2921 filter settings being used, and data allowing the filter weights to be
2922 easily graphed. </dd>
2923
2924<dd>Note however that some filters are internally defined in terms of other
2925 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
2926 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
2927 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
2928 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002929
2930</dl>
2931
cristyd0bda5e2010-09-21 16:22:45 +00002932<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00002933
2934<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
2935 -set filter:window=bessel -set filter:lobes=8 \ <br/>
2936 -resize 150% image.jpg</span></p>
2937<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
2938
2939<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
2940 -resize 150% image.jpg</span></p>
2941<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00002942filters, and 'verbose' for viewing the internal filter selection), are
2943provided for image processing experts who have studied and understood how
2944resize filters work. Without this knowledge, and an understanding of the
2945definition of the actual filters involved, using expert settings are more
2946likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00002947
2948
2949<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002950 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00002951</div>
2952
2953<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>
2954
2955
2956<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002957 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00002958</div>
2959
2960<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>
2961
2962<p>reflect the scanlines in the vertical direction.</p>
2963
2964<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002965 <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 +00002966</div>
2967
2968<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>
2969
2970<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002971 <h4><a id="flop"></a>-flop</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%'>create a <em>mirror image</em>.</td><td style='text-align:right;'></td></tr></table>
2975
2976<p>reflect the scanlines in the horizontal direction.</p>
2977
2978
2979<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002980 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002981</div>
2982
2983<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>
2984
2985<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>
2986
2987<p>In addition to the fonts specified by the above pre-defined list, you can
2988also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
2989is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
2990<kbd>x:fixed</kbd> is X11 font.</p>
2991
2992<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>
2993
2994
2995<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002996 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002997</div>
2998
2999<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>
3000
3001<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3002
3003<p>The default foreground color is black.</p>
3004
3005<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003006 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003007</div>
3008
3009<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>
3010
3011<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>
3012
3013<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>
3014
3015<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003016 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003017</div>
3018
3019<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>
3020
3021<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>
3022
3023<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003024 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003025</div>
3026
3027<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>
3028
cristybc9539a2010-08-16 18:06:20 +00003029<p>The color of the border is specified with the <a href="#mattecolor"
3030>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003031
cristybc9539a2010-08-16 18:06:20 +00003032<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
3033class="arg">geometry</em> argument indicates the amount of extra width and
3034height that is added to the dimensions of the image. If no offsets are given
3035in the <em class="arg">geometry</em> argument, then the border added is
3036a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3037the width and height of the border is partitioned to form an outer bevel of
3038thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3039<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3040</p>
3041
3042<p>The <a href="#frame">-frame</a> option is affected by the current <a
3043href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003044'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003045size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3046draws the frame of four distinct colors close to the current <a
3047href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3048center of this image. This means that with the default compose method of
3049'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3050href="#bordercolor">-bordercolor</a> setting.</p>
3051
3052<p>The image composition is not
3053affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003054
3055
3056<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003057 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003058</div>
3059
3060<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>
3061
3062<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003063 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></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%'>Apply a function to channel values.</td><td style='text-align:right;'></td></tr></table>
3067
3068<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>
3069
3070<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>
3071
3072<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>
3073
3074<pre class="text">
3075 Polynomial
3076 Sinusoid
3077 Arcsin
3078 Arctan
3079</pre>
3080
3081<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3082
3083<dl class="doc">
3084<dt><kbd>Polynomial</kbd></dt>
3085<dd>
3086<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>
3087
3088<div style="text-align: center">
3089 -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>
3090</div>
3091
3092<p>will invoke a polynomial function given by</p>
3093
3094<div style="text-align: center">
3095 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3096 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3097 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3098</div>
3099
3100<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3101
3102<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>
3103
3104<table class="doc">
3105 <col width="35%" />
3106 <col width="35%" />
3107 <col width="30%" />
3108 <tr>
3109 <td>-evaluate Set <em class="arg">value</em> </td>
3110 <td>-function Polynomial <em class="arg">value</em></td>
3111 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3112 </tr>
3113 <tr>
3114 <td>-evaluate Add <em class="arg">value</em> </td>
3115 <td>-function Polynomial 1,<em class="arg">value</em></td>
3116 </tr>
3117 <tr>
3118 <td>-evaluate Subtract <em class="arg">value</em> </td>
3119 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3120 </tr>
3121 <tr>
3122 <td>-evaluate Multiply <em class="arg">value</em> </td>
3123 <td>-function Polynomial <em class="arg">value</em>,0</td>
3124 </tr>
3125 <tr>
3126 <td>+level black% x white%</td>
3127 <td>-function Polynomial A,B</td>
3128 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3129 </tr>
3130</table>
3131
3132<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>
3133</dd>
3134
3135<dt><kbd>Sinusoid</kbd></dt>
3136<dd>
3137<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>
3138
3139<div style="text-align: center">
3140 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3141</div>
3142
3143<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>
3144
3145<div style="text-align: center">
3146<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>
3147</div>
3148
3149<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>
3150
3151<p class="crtsnip">
3152 -function Sinusoid 3,-90,.2,.7
3153</p>
3154
3155<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>
3156
3157<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>
3158
3159<table class="doc">
3160 <tr>
3161 <td>-evaluate Sin <em class="arg">freq</em> </td>
3162 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3163 </tr>
3164 <tr>
3165 <td>-evaluate Cos <em class="arg">freq</em> </td>
3166 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3167 </tr>
3168</table>
3169</dd>
3170
3171<dt><kbd>ArcSin</kbd></dt>
3172<dd>
3173<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3174and can be used to generate cylindrical distortion and displacement maps.
3175The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003176of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003177
cristydcca3fa2010-12-29 21:50:07 +00003178<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003179 -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 +00003180</p>
cristy3ed852e2009-09-05 21:47:34 +00003181
3182<p>with all values given in terms of noramlize color values (0.0 for black,
31831.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3184for bout input (<em class="arg">width</em>), and output (<em
3185class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3186
cristydcca3fa2010-12-29 21:50:07 +00003187<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003188<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 +00003189</p>
cristy3ed852e2009-09-05 21:47:34 +00003190
3191</dd>
3192
3193<dt><kbd>ArcTan</kbd></dt>
3194<dd>
3195<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3196limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003197All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003198
cristydcca3fa2010-12-29 21:50:07 +00003199<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003200 -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 +00003201</p>
cristy3ed852e2009-09-05 21:47:34 +00003202
3203<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3204</p>
3205
cristydcca3fa2010-12-29 21:50:07 +00003206<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003207<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 +00003208</p>
cristy3ed852e2009-09-05 21:47:34 +00003209
3210</dd>
3211
3212</dl>
3213
3214
3215<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003216 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003217</div>
3218
3219<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>
3220
3221<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>
3222
3223<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>
3224
3225
3226<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003227 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003228</div>
3229
3230<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>
3231
3232<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>
3233
3234<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3235
3236
3237<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003238 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003239</div>
3240
3241<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>
3242
3243<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>
3244
3245<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>
3246
3247<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>
3248
3249<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>
3250
3251<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3252
3253<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003254 <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 +00003255</div>
3256
3257<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>
3258
cristyb15553d2010-07-03 22:53:14 +00003259<p>Convolve the image with a Gaussian or normal distribution using the given
3260<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003261
3262<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3263</div>
3264
cristyb15553d2010-07-03 22:53:14 +00003265<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003266determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003267
3268<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003269array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003270integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003271radius that will provide meaningful results for the Gaussian distribution.
3272</p>
3273
3274<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3275operation is. However too small a <em class="arg" >Radius</em>, and sever
3276aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3277should be at least twice the <em class="arg" >Sigma</em> value, though three
3278times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003279
3280<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003281full 2-dimensional convolution is used to generate the weighted average of the
3282neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003283
3284<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3285pixels which are outside the image proper are blurred into the final result.
3286</p>
3287
3288
3289<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003290 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003291</div>
3292
3293<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>
3294
3295<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>
3296
3297<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003298 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003299</div>
3300
3301<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>
3302
3303<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3304<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3305<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3306list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3307installation.</p>
3308
3309<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>
3310
3311<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>
3312
3313<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>
3314
cristy4949d522010-03-12 18:41:34 +00003315<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 +00003316<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>
3317
3318<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>
3319
3320
3321<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003322 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003323</div>
3324
3325<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>green chromaticity primary point.</td><td style='text-align:right;'></td></tr></table>
3326
3327
3328<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003329 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003330</div>
3331
3332<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>
3333
3334<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3335dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3336can apply any color transformation to the Hald image and then use this option
3337to apply the transform to the image. </p>
3338
3339<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3340<p>This option provides a convenient method for you to use Gimp or Photoshop
3341to make color corrections to the Hald CLUT image and subsequently apply them
3342to multiple images using an ImageMagick script. </p>
3343
3344<p>Note that the representation is only of the normal RGB color space and that
3345the whole color value triplet is used for the interpolated lookup of the
3346represented Hald color cube image. Because of this the operation is not <a
3347href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3348images transparency or alpha/matte channel.</p>
3349
3350<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3351of the individual color channels, usally involving a simplier gray-scale
3352image. E.g: gray-scale to color replacement, or modification by a histogram
3353mapping. </p>
3354
3355
3356<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003357 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003358</div>
3359
3360<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>
3361
3362<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003363 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003364</div>
3365
3366<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>when comparing images, emphasize pixel differences with this color.</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="iconGeometry"></a>-iconGeometry <em class="arg">geometry</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%'>specify the icon geometry.</td><td style='text-align:right;'></td></tr></table>
3373
3374<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>
3375
3376<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>
3377
3378<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003379 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003380</div>
3381
3382<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>
3383
3384<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003385 <h4><a id="identify"></a>-identify</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%'>identify the format and characteristics of the image.</td><td style='text-align:right;'></td></tr></table>
3389
3390<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>
3391
3392<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>
3393
cristyd0bda5e2010-09-21 16:22:45 +00003394<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003395amounts of image properties are displayed including image statistics, profiles,
3396image histogram, and others.</p>
3397
3398<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003399 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003400</div>
3401
3402<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>
3403
cristydcca3fa2010-12-29 21:50:07 +00003404<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 +00003405
3406<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>
3407
3408<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3409<p>or</p>
3410
3411<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>
3412
cristydcca3fa2010-12-29 21:50:07 +00003413<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 +00003414
cristydcca3fa2010-12-29 21:50:07 +00003415<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 +00003416
cristydcca3fa2010-12-29 21:50:07 +00003417<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 +00003418
3419<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003420 <h4><a id="immutable"></a>-immutable</h4>
cristy3ed852e2009-09-05 21:47:34 +00003421</div>
3422
3423<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>
3424
3425<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003426 <h4><a id="implode"></a>-implode <em class="arg">factor</em></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%'>implode image pixels about the center.</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="insert"></a>-insert <em class="arg">index</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%'>insert the last image into the image sequence.</td><td style='text-align:right;'></td></tr></table>
3436
3437<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>
3438
3439<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>
3440
3441<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003442 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003443</div>
3444
3445<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>use this type of rendering intent when managing the image color.</td><td style='text-align:right;'></td></tr></table>
3446
3447<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>
3448
3449<p>The default intent is undefined.</p>
3450
3451<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3452
3453<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003454 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003455</div>
3456
3457<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>
3458
3459<p>Choose from:</p>
3460
3461<pre class="text">
3462 none
3463 line
3464 plane
3465 partition
3466 JPEG
3467 GIF
3468 PNG
3469</pre>
3470
3471<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>
3472
3473<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3474
3475<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3476
3477<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3478
3479<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3480image.G, and image.B).</p>
3481
3482<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>
3483image.</p>
3484
3485<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3486
3487<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003488 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003489</div>
3490
3491<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
3492
cristyd0bda5e2010-09-21 16:22:45 +00003493<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003494value, you typically fall in between the pixel colors defined by the source
3495image. This setting determines how the color is determined from the colors of
3496the pixels surrounding that point. That is how to determine the color of a
3497point that falls between two, or even four different colored pixels. </p>
3498
3499<pre class="text">
3500 integer: The color of the top-left pixel (floor function)
3501 nearest-neighbor: The nearest pixel to the lookup point (rounded function)
3502 average: The average color of the surrounding four pixels
3503 bilinear A double linear interpolation of pixels (the default)
3504 mesh Divide area into two flat triangular interpolations
3505 bicubic Fitted bicubic-spines of surrounding 16 pixels
3506 spline Direct spline curves (colors are blurred)
3507 filter Use resize <a href="#filter">-filter</a> settings
3508</pre>
3509
3510<p>This most important for distortion operators such as <a href="#distort"
3511>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3512>-transform</a> and <a href="#fx" >-fx</a>. </p>
3513
3514<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3515
3516<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3517lookup for positions outside the boundaries of the image. </p>
3518
3519
3520<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003521 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003522</div>
3523
3524<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>
3525
3526<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003527 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003528</div>
3529
3530<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the space between two words.</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="kerning"></a>-kerning <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 letters.</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="label"></a>-label <em class="arg">name</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%'>assign a label to an image.</td><td style='text-align:right;'></td></tr></table>
3543
cristy71a3f602010-09-15 12:38:16 +00003544<p>Use this option to assign a specific label to the image, as it is read in
3545or created. You can use the <a href="#set" >-set</a> operation to re-assign
3546a the labels of images already read in. Image formats such as TIFF, PNG,
3547MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003548
cristy71a3f602010-09-15 12:38:16 +00003549<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3550assigned to an image is used as a header string to print above the postscript
3551image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003552
cristybc9539a2010-08-16 18:06:20 +00003553<p>You can include the image filename, type, width, height, or other image
3554attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3555Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003556
3557<p>For example,</p>
3558
3559<p class="crtsnip">
3560 -label "%m:%f %wx%h" bird.miff
3561</p>
3562
cristy71a3f602010-09-15 12:38:16 +00003563<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3564"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3565is read in. If a <a href="#label">+label</a> option was used instead, any
3566existing label present in the image would be used. You can remove all labels
3567from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003568
cristy71a3f602010-09-15 12:38:16 +00003569<p>A label is not drawn on the image, but is embedded in the image datastream
3570via <em>Label</em> tag or similar mechanism. If you want the label to be
3571visible on the image itself, use the <a href="#draw">-draw</a> option, or
3572during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003573
cristy71a3f602010-09-15 12:38:16 +00003574<p>If the first character of <em class="arg">string</em> is <em
3575class="arg">@</em>, the image label is read from a file titled by the
3576remaining characters in the string. Labels in a file are literal, no embedded
3577formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003578
3579
3580<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003581 <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 +00003582</div>
3583
3584<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>
3585
3586<p>Adaptively threshold each pixel based on the value of pixels in a
3587surrounding window. If the current pixel is lighter than this average plus
3588the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3589black. Small variations in pixel values such as found in scanned documents
3590can be ignored if offset is positive. A negative offset will make it more
3591sensitive to those small variations. </p>
3592
3593<p>This is commonly used to threshold images with an uneven background. It is
3594based on the assumption that average color of the small window is the
3595the local background color, from which to separate the forground color. </p>
3596
3597
3598<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003599 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003600</div>
3601
3602<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>
3603
3604<p>Perform various image operation methods to a ordered sequence of images
3605which may represent either a set of overlaid 'image layers', a GIF disposal
3606animation, or a fully-'coalesced' animation sequence. </p>
3607
3608<table class="doc">
3609 <tbody>
3610 <tr valign="top">
3611 <th align="left" style="width: 8%">Method</th>
3612 <th align="left">Description</th>
3613 </tr>
3614
3615 <tr valign="top">
3616 <td valign="top">compare-any</td>
3617 <td valign="top">Crop the second and later frames to the smallest rectangle
3618 that contains all the differences between the two images. No GIF <a
3619 href="#dispose" >-dispose</a> methods are taken into account. </td>
3620 </tr>
3621
3622 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3623 >-deconstruct</a> operator, and does not preserve animations normal
3624 working, especially when animation used layer disposal methods such as
3625 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3626 </tr>
3627
3628 <tr valign="top">
3629 <td valign="top">compare-clear</td>
3630 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3631 opaque pixels which become transparent in the second frame. That is the
3632 smallest image needed to mask or erase pixels for the next frame. </td>
3633 </tr>
3634
3635 <tr valign="top">
3636 <td valign="top">compare-overlay</td>
3637 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3638 extra color to the next image, as a result of overlaying color pixels.
3639 That is the smallest single overlaid image to add or change colors. </td>
3640 </tr>
3641
3642 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3643 composition method '<kbd>change-mask</kbd>', to reduce the image to
3644 just the pixels that need to be overlaid. </td>
3645 </tr>
3646
3647 <tr valign="top">
3648 <td valign="top">coalesce</td>
3649 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3650 >-coalesce</a> operator. Apply the layer disposal methods set in the
3651 current image sequence to form a fully defined animation sequence, as
3652 it should be displayed. Effectively converting a GIF animation into a
3653 'film strip'-like animation. </td>
3654 </tr>
3655
3656 <tr valign="top">
3657 <td valign="top">composite</td>
3658 <td valign="top">Alpha Composition of two image lists, separated by a
3659 "<kbd>null:</kbd>" image, with the destination image list first, and
3660 the source images last. An image from each list are composited
3661 together until one list is finished. The separator image and source
3662 image lists are removed. </td>
3663 </tr>
3664
3665
cristybac7a162010-06-15 19:57:29 +00003666 <tr><td></td>
3667 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3668 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3669 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003670 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003671 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003672
cristybac7a162010-06-15 19:57:29 +00003673 <tr><td></td>
3674 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003675 applied to all the images in the other image list, regardless of which
3676 list it is. In this case it is the image meta-data of the list which
3677 preserved. </td>
3678 </tr>
3679
3680
3681 <tr valign="top">
3682 <td valign="top">dispose</td>
3683 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3684 the animation after the layer disposal method has been applied, before
3685 the next sub-frame image is overlaid. That is the 'dispose' image that
3686 results from the application of the GIF <a href="#dispose"
3687 >-dispose</a> method. This allows you to check what
3688 is going wrong with a particular animation you may be developing.
3689 </td>
3690 </tr>
3691
3692 <tr valign="top">
3693 <td valign="top">flatten</td>
3694 <td valign="top">Create a canvas the size of the first images virtual
3695 canvas using the current <a href="#background" >-background</a> color,
3696 and <a href="#compose" >-compose</a> each image in turn onto that
3697 canvas. Images falling outside that canvas is clipped. Final
3698 image will have a zero virtual canvas offset. </td>
3699 </tr>
3700
cristybac7a162010-06-15 19:57:29 +00003701 <tr><td></td>
3702 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003703 overlaying all the prepared image layers into a final image. </td>
3704 </tr>
3705
cristybac7a162010-06-15 19:57:29 +00003706 <tr><td></td>
3707 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003708 canvas with real pixels, or to underlay a opaque color to remove
3709 transparency from an image.</td>
3710 </tr>
3711
3712
3713 <tr valign="top">
3714 <td valign="top">merge</td>
3715 <td valign="top">As 'flatten' method but merging all the given image
3716 layers into a new layer image just large enough to hold all the image
3717 without clipping or extra space. The new images virtual offset will
3718 prevere the position of the new layer, even if this offset is
3719 negative. the virtual canvas size of the first image is preserved.
3720 </td>
3721 </tr>
3722
3723 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3724 as few image file formats handle them correctly. </td>
3725 </tr>
3726
3727 <tr valign="top">
3728 <td valign="top">mosaic</td>
3729 <td valign="top">As 'flatten' method but expanding the initial canvas size
3730 of the first image so as to hold all the image layers. However as a
cristyd0bda5e2010-09-21 16:22:45 +00003731 virtual canvas is 'locked' to the origin, by definition, image layers
cristy3ed852e2009-09-05 21:47:34 +00003732 with a negative offsets will still be clipped by the top and left
3733 edges.</td>
3734 </tr>
3735
3736 <tr><td></td><td>This method is commonly used to layout individual image using various
cristyd0bda5e2010-09-21 16:22:45 +00003737 offset but without knowing the final canvas size. The resulting image
cristy3ed852e2009-09-05 21:47:34 +00003738 will, like 'flatten' not have any virtual offset, so can be saved to
3739 any image file format. </td>
3740 </tr>
3741
3742
3743 <tr valign="top">
3744 <td valign="top">optimize</td>
3745 <td valign="top">Optimize a coalesced animation, into GIF animation using
3746 a number of general techniques. This currently a short cut to
3747 apply both the '<kbd>optimize-frame</kbd>', and
3748 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3749 include other optimization methods as they are developed. </td>
3750 </tr>
3751
3752 <tr valign="top">
3753 <td valign="top">optimize-frame</td>
3754 <td valign="top">Optimize a coalesced animation, into GIF animation by
3755 reducing the number of pixels per frame as much as possible by
3756 attempting to pick the best layer disposal method to use, while ensuring
3757 the result will continue to animate properly. </td>
3758 </tr>
3759
3760 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3761 then no reasonably fast GIF optimization algorithm can do this.
3762 However this does seem to do better than most other GIF frame
3763 optimizers seen. </td>
3764 </tr>
3765
3766 <tr valign="top">
3767 <td valign="top">optimize-plus</td>
3768 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3769 overall optimization by adding extra frames to the animation, without
3770 changing the final look or timing of the animation. The frames are
3771 added to attempt to separate the clearing of pixels from the
3772 overlaying of new additional pixels from one animation frame to the
3773 next. If this does not improve the optimization (for the next frame
3774 only), it will fall back to the results of the previous normal
3775 '<kbd>optimize-frame</kbd>' technique. </td>
3776 </tr>
3777
3778 <tr><td></td><td>There is the possibility that the change in the disposal style will
3779 result in a worsening in the optimization of later frames, though this
3780 is unlikely. In other words there no guarantee that it is better than
3781 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
cristyd0bda5e2010-09-21 16:22:45 +00003782 however you can get a vast improvement in the final animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003783 </tr>
3784
3785 <tr valign="top">
3786 <td valign="top">optimize-transparency</td>
3787 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3788 overlay images with transparency, if it does not change the resulting
3789 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3790 </td>
3791 </tr>
3792
3793 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3794 into a smaller file size due to larger areas of one (transparent)
3795 color rather than a pattern of multiple colors repeating the current
3796 disposed image of the last frame. </td>
3797 </tr>
3798
3799 <tr valign="top">
3800 <td valign="top">remove-dups</td>
3801 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3802 images, so as to simplify layer overlays of coalesced animations.
3803 </td>
3804 </tr>
3805
3806 <tr><td></td><td>Usually this a result of using a constant time delay across the
3807 whole animation, or after a larger animation was split into smaller
3808 sub-animations. The duplicate frames could also have been used as
3809 part of some frame optimization methods. </td>
3810 </tr>
3811
3812 <tr valign="top">
3813 <td valign="top">remove-zero</td>
3814 <td valign="top">Remove any image with a zero time delay, unless ALL the
3815 images have a zero time delay (and is not a proper timed animation, a
3816 warning is then issued). </td>
3817 </tr>
3818
3819 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3820 partial intermediary updates between the frames that are actually
3821 displayed to users. These frames are usally added for improved frame
3822 optimization in GIF animations. </td>
3823 </tr>
3824
3825 <tr valign="top">
3826 <td valign="top">trim-bounds</td>
3827 <td valign="top">Find the bounds of all the images in the current
3828 image sequence, then adjust the offsets so all images are contained on
3829 a minimal positive canvas. None of the image data is modified, only
3830 there virtual canvas size and offset. The all the image is given
3831 the same canvas size, and and will have a positive offset, but will
3832 remain in the same position relative to each other. As a result of the
3833 minimal canvas size at least one image will touch every edge of that
3834 canvas. The image data however may be transparent.
3835 </td>
3836 </tr>
3837
3838 </tbody>
3839</table>
3840
3841<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3842
3843<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3844>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3845>-mosaic</a> are only aliases for the above methods. Also see <a
3846href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3847href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3848>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3849
3850
3851<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003852 <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 +00003853</div>
3854
3855<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>
3856
3857<p>Given one, two or three values delimited with commas: black-point,
3858white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3859white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3860point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3861contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3862both black and white points are percentages of the full color range. Gamma
3863will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3864omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3865
3866<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3867the given '<kbd>black_point</kbd>' value in the original image is set to
3868zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3869<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3870to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3871adjusted. </p>
3872
3873<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3874adding the special '!' flag anywhere in the argument list, will cause the
3875operator to do the reverse of the level adjustment. That is a zero, or
3876<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
3877adjusted to the given level values, allowing you to de-contrast, or compress
3878the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
3879
3880<p>Only the channels defined by the current <a href="#channel">-channel</a>
3881setting are adjusted (defaults to RGB color channels only), allowing you to
3882limit the effect of this operator. </p>
3883
3884<p>Please note that the transparency channel is treated as 'matte'
3885values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
3886
3887
3888<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003889 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00003890 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
3891</div>
3892
cristyd0bda5e2010-09-21 16:22:45 +00003893<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 +00003894
3895<p>This function is exactly like <a href="#level">-level</a>, except that the
3896value value for each color channel is determined by the
3897'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
3898described under the <a href="#fill">-fill</a> option). </p>
3899
cristyd0bda5e2010-09-21 16:22:45 +00003900<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
3901is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00003902colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00003903adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00003904
3905<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
3906will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00003907respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00003908those colors. This can also be used to convert a plain gray-scale image into a
3909one using the gradient of colors specified. </p>
3910
3911<p>By supplying a single color with a comma separator either before or after
3912that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00003913respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00003914used for both the black and white color points, making the operator either
3915threshold the images around that color (- form) or set all colors to that
3916color (+ form). </p>
3917
3918
3919<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003920 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003921</div>
3922
3923<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the pixel cache resource limit.</td><td style='text-align:right;'></td></tr></table>
3924
3925<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>
3926
cristy6b636652009-12-05 17:16:11 +00003927<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 +00003928
3929<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00003930 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00003931</p>
3932
3933<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
3934
cristydcca3fa2010-12-29 21:50:07 +00003935<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list resource</span><span class='crtout'></span></p><pre class="text">
3936File Area Memory Map Disk Thread Time
cristy6b636652009-12-05 17:16:11 +00003937------------------------------------------------------------------------------
cristydcca3fa2010-12-29 21:50:07 +00003938 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
3939</pre>
3940
cristy3ed852e2009-09-05 21:47:34 +00003941<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>
3942
3943<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>
3944
3945<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>
3946
3947<p class="crtsnip">
3948-limit area 10mb
3949</p>
3950
cristyd0bda5e2010-09-21 16:22:45 +00003951<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 +00003952
3953<p class="crtsnip">
3954-limit area 10mb -limit disk 500mb
3955</p>
3956
3957<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
3958
3959<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>
3960
3961<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.
3962</p>
3963
3964<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.
3965</p>
3966
3967<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003968 <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 +00003969</div>
3970
3971<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>
3972
cristyd934d102009-10-10 12:55:13 +00003973<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
3974and uses a 'histogram bin' to determine the range of color values that needs to
3975be stretched. However it then stretchs those colors using the <a
3976href="#level" >-level</a> operator.</p>
3977
3978<p>As such while the initial determination may have 'binning' round off
3979effects, the image colors are stretched mathematically, rather than using the
3980histogram bins. This makes the operator more accurate. </p>
3981
3982<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
3983'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
3984perfect stretch of the color range. </p>
3985
3986<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
3987normalization of mathematical images. </p>
3988
3989<p>This operator is under review for re-development. </p>
3990
3991
cristy3ed852e2009-09-05 21:47:34 +00003992<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003993 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00003994</div>
3995
3996<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the line width for subsequent draw operations.</td><td style='text-align:right;'></td></tr></table>
3997
3998<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003999 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></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%'>rescale image with seam-carving.</td><td style='text-align:right;'></td></tr></table>
4003
4004<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>
4005
4006<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004007 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004008</div>
4009
4010<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>
4011
4012<pre class="text">
cristyc1aee832010-05-08 00:36:47 +00004013 Align
4014 Alpha
4015 Boolean
4016 Channel
4017 Class
4018 ClipPath
4019 Coder
4020 Color
4021 Colorspace
4022 Command
4023 Compose
4024 Compress
4025 Configure
4026 DataType
4027 Debug
4028 Decoration
4029 Delegate
4030 Direction
4031 Dispose
4032 Distort
4033 Dither
4034 Endian
4035 Evaluate
4036 FillRule
4037 Filter
4038 Font
4039 Format
4040 Function
4041 Gravity
4042 ImageList
4043 Intent
4044 Interlace
4045 Interpolate
4046 Kernel
cristy787d4352010-03-06 13:55:58 +00004047 Layers
4048 LineCap
4049 LineJoin
4050 List
4051 Locale
4052 LogEvent
4053 Log
4054 Magic
4055 Method
4056 Metric
4057 Mime
4058 Mode
4059 Morphology
4060 Module
4061 Noise
4062 Orientation
4063 Policy
4064 PolicyDomain
4065 PolicyRights
4066 Preview
4067 Primitive
4068 QuantumFormat
4069 Resource
4070 SparseColor
4071 Storage
4072 Stretch
4073 Style
4074 Threshold
4075 Type
4076 Units
4077 Validate
4078 VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004079</pre>
4080
cristybac7a162010-06-15 19:57:29 +00004081<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4082list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4083available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004084
4085<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4086<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004087 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004088</div>
4089
4090<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>
4091
cristybac7a162010-06-15 19:57:29 +00004092<p>This option specifies the format for the log printed when the <a
4093href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004094
cristybac7a162010-06-15 19:57:29 +00004095<p>You can display the following components by embedding special format
4096characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004097
4098<pre class="text">
4099 %d domain
4100 %e event
4101 %f function
4102 %l line
4103 %m module
4104 %p process ID
4105 %r real CPU time
4106 %t wall clock time
4107 %u user CPU time
4108 %% percent sign
4109 \n newline
4110 \r carriage return
4111</pre>
4112
4113<p>For example:</p>
4114
4115<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>
4116<p>The default behavior is to print all of the components.</p>
4117
4118<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004119 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004120</div>
4121
4122<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>
4123
cristybac7a162010-06-15 19:57:29 +00004124<p>Set iterations to zero to repeat the animation an infinite number of times,
4125otherwise the animation repeats itself up to <em class="arg">iterations</em>
4126times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004127
4128<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004129 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004130</div>
4131
4132<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>
4133
4134<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004135 <h4><a id="magnify"></a>-magnify <em class="arg">factor</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%'>magnify the image.</td><td style='text-align:right;'></td></tr></table>
4139
4140
4141<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004142 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004143</div>
4144
4145<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>
4146
4147<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4148
4149<pre class="text">
4150 best
4151 default
4152 gray
4153 red
4154 green
4155 blue
4156</pre>
4157
cristybac7a162010-06-15 19:57:29 +00004158<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4159Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4160the type and <kbd>display</kbd> searches the list of colormap types in
4161<kbd>top-to-bottom</kbd> order until one is located. See <em
4162class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004163
4164
4165<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004166 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004167</div>
4168
4169<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>pixel map.</td><td style='text-align:right;'>[<a href="../www/stream.html">stream</a>]</td></tr></table>
4170
4171<p>Here are the valid components of a map:</p>
4172
4173<pre class="text">
4174 r red pixel component
4175 g green pixel component
4176 b blue pixel component
4177 a alpha pixel component (0 is transparent)
4178 o opacity pixel component (0 is opaque)
4179 i grayscale intensity pixel component
4180 c cyan pixel component
4181 m magenta pixel component
4182 y yellow pixel component
4183 k black pixel component
4184 p pad component (always 0)
4185</pre>
4186
cristybac7a162010-06-15 19:57:29 +00004187<p>You can specify as many of these components as needed in any order (e.g.
4188bgr). The components can repeat as well (e.g. rgbr).</p>
4189
cristy3ed852e2009-09-05 21:47:34 +00004190
4191<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004192 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004193<em class="arg">filename</em></h4>
4194</div>
4195
4196<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>
4197
4198<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
4199
4200<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004201 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004202</div>
4203
4204<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify the color to be used with the <a href="#frame">-frame</a> option.</td><td style='text-align:right;'></td></tr></table>
4205
4206<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4207
cristybac7a162010-06-15 19:57:29 +00004208<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4209style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004210
4211<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004212 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004213</div>
4214
4215<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>
4216
4217<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004218 <h4><a id="median"></a>-median <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004219</div>
4220
4221<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>
4222
4223<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004224 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004225</div>
4226
4227<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
4228
4229<p>Choose from:</p>
4230
4231<pre class="text">
cristybac7a162010-06-15 19:57:29 +00004232 AE absolute error count, number of different pixels (-fuzz effected)
cristya20e3f92010-12-13 01:52:32 +00004233 FUZZ mean color distance
cristybac7a162010-06-15 19:57:29 +00004234 MAE mean absolute error (normalized), average channel error distance
4235 MEPP mean error per pixel (normalized mean error, normalized peak error)
4236 MSE mean error squared, average of the channel error squared
cristya20e3f92010-12-13 01:52:32 +00004237 NCC normalized cross correlation
cristybac7a162010-06-15 19:57:29 +00004238 PAE peak absolute (normalize peak absolute)
4239 PSNR peak signal to noise ratio
4240 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004241</pre>
4242
cristy771f7a72010-11-27 21:42:59 +00004243<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4244with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4245only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004246size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004247'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004248for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004249
4250<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4251('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004252normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004253
cristybac7a162010-06-15 19:57:29 +00004254<p>To print a complete list of metrics, use the <a href="#list">-list
4255metrics</a> option.</p>
4256
cristy3ed852e2009-09-05 21:47:34 +00004257
cristyd2baf7d2010-03-06 04:26:44 +00004258<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004259 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004260</div>
4261
4262<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>
4263
cristy3ed852e2009-09-05 21:47:34 +00004264
4265<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004266 <h4><a id="mode"></a>-mode <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004267</div>
4268
4269<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>
4270
cristybac7a162010-06-15 19:57:29 +00004271<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4272Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004273
cristybac7a162010-06-15 19:57:29 +00004274<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4275for a list of <a href="#mode" >-mode</a> arguments available in your
4276ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004277
4278
4279<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004280 <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 +00004281</div>
4282
cristybac7a162010-06-15 19:57:29 +00004283<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
4284class="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 +00004285
cristyb36feb22010-03-26 16:54:37 +00004286<p>The arguments are given as a percentages of variation. A value of 100 means
4287no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004288
cristyb36feb22010-03-26 16:54:37 +00004289<p>The <em class="arg">brightness</em> is a multiplier of the overall
4290brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4291twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4292before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004293
cristyb36feb22010-03-26 16:54:37 +00004294<p>The <em class="arg">saturation</em> controls the amount of color in an
4295image. For example, 0 produce a grayscale image, while a large value such as
4296200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004297
cristyb36feb22010-03-26 16:54:37 +00004298<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4299within the image by the amount specified. For example, 50 results in
4300a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4301A value of either 0 or 200 results in a complete 180 degree rotation of the
4302image. Using a value of 300 is a 360 degree rotation resulting in no change to
4303the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004304
cristyb36feb22010-03-26 16:54:37 +00004305<p>For example, to increase the color brightness by 20% and decrease the color
4306saturation by 10% and leave the hue unchanged, use <a
4307href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004308
cristyb36feb22010-03-26 16:54:37 +00004309<p>Use <a href="#set">-set</a> attribute of '<kbd
4310class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4311modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4312<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004313
4314<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 +00004315
cristy3ed852e2009-09-05 21:47:34 +00004316<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004317 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004318</div>
4319
4320<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>
4321
4322
4323<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004324 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004325</div>
4326
4327<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>
4328
4329
4330<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004331 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004332</div>
4333
4334<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>
4335
4336<p>Both the image pixels and size are linearly interpolated to give the
4337appearance of a meta-morphosis from one image to the next, over all the images
4338in the current image list. The added images are the equivalent of a <a
4339href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4340argument determine how many images to interpolate between each image. </p>
4341
4342
4343<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004344 <h4><a id="morphology"></a>-morphology</h4>
4345 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004346</div>
4347
cristy2c839602010-04-03 02:32:08 +00004348<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 +00004349
cristydcca3fa2010-12-29 21:50:07 +00004350<p>Until I get around to writing a option summary for this, see <a
4351href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4352Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004353
4354
cristy488844c2010-01-22 14:02:05 +00004355<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004356 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004357</div>
4358
4359<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>
4360
4361
4362<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004363 <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 +00004364</div>
4365
4366<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>
4367
4368<p>Blur with the given radius, standard deviation (sigma), and angle. The
4369angle given is the angle toward which the image is blurred. That is the
4370direction people would consider the object is coming from. </p>
4371
4372<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004373definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004374
4375<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4376pixels which are outside the image proper are blurred into the final result.
4377</p>
4378
4379<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004380 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004381</div>
4382
4383<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>
4384<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004385 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004386</div>
4387
cristyb29bc032010-02-01 20:29:43 +00004388<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 +00004389
4390<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>
4391
4392<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004393 <h4><a id="noise"></a>-noise <em class="arg">radius</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004394 +noise <em class="arg">type</em></h4>
4395</div>
4396
4397<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>
4398
4399<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>
4400
4401<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>
4402
4403<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>
4404
4405<pre class="text">
4406Gaussian
4407Impulse
4408Laplacian
4409Multiplicative
4410Poisson
4411Random
4412Uniform
4413</pre>
4414
4415<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4416
cristy83543962009-10-16 19:04:28 +00004417<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4418the use of a controlling value to specify teh amount of noise that should be
4419added to an image. </p>
4420
cristy3ed852e2009-09-05 21:47:34 +00004421
4422<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004423 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004424</div>
4425
4426<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>
4427
cristyd934d102009-10-10 12:55:13 +00004428<p>The intensity values are stretched to cover the entire range of possible
4429values. While doing so, black-out at most <em>2%</em> of the pixels and
4430white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004431
cristyd934d102009-10-10 12:55:13 +00004432<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4433is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4434(Before this version, it was equivalent to <a href="#contrast-stretch"
4435>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004436
cristyd934d102009-10-10 12:55:13 +00004437<p>All the channels are normalized in concert by the came amount so as to
4438preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004439setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004440setting will normalize the RGB channels independently.</p>
4441
cristydcca3fa2010-12-29 21:50:07 +00004442<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004443Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004444that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004445
4446<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004447
4448
4449<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004450 <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 +00004451</div>
4452
cristyd934d102009-10-10 12:55:13 +00004453<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
4454class="arg">threshold map</em> specified, and a uniform color map with the
4455given 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 +00004456
4457<p>You can choose from these standard threshold maps:</p>
4458
4459<pre class="text">
cristya6d7cf72010-11-07 15:58:34 +00004460threshold 1x1 Threshold 1x1 (non-dither)
4461checks 2x1 Checkerboard 2x1 (dither)
4462o2x2 2x2 Ordered 2x2 (dispersed)
4463o3x3 3x3 Ordered 3x3 (dispersed)
4464o4x4 4x4 Ordered 4x4 (dispersed)
4465o8x8 8x8 Ordered 8x8 (dispersed)
4466h4x4a 4x1 Halftone 4x4 (angled)
4467h6x6a 6x1 Halftone 6x6 (angled)
4468h8x8a 8x1 Halftone 8x8 (angled)
4469h4x4o Halftone 4x4 (orthogonal)
4470h6x6o Halftone 6x6 (orthogonal)
4471h8x8o Halftone 8x8 (orthogonal)
4472h16x16o Halftone 16x16 (orthogonal)
4473c5x5b c5x5 Circles 5x5 (black)
4474c5x5w Circles 5x5 (white)
4475c6x6b c6x6 Circles 6x6 (black)
4476c6x6w Circles 6x6 (white)
4477c7x7b c7x7 Circles 7x7 (black)
4478c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004479</pre>
4480
cristyde368992010-11-05 14:32:14 +00004481<p> The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
cristyd934d102009-10-10 12:55:13 +00004482pattern. Or you can define your own <em class="arg" >threshold map</em> in a
cristyde368992010-11-05 14:32:14 +00004483personal or system <kbd>thresholds.xml</kbd> XML file. </p>
cristy3ed852e2009-09-05 21:47:34 +00004484
cristyd934d102009-10-10 12:55:13 +00004485<p>To print a complete list of threshold, use the <a href="#list" >-list
4486threshold</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004487
cristyd934d102009-10-10 12:55:13 +00004488<p>It is recommended that the <a href="#map" >+map</a> operator be used after
4489applying <a href="#ordered-dither" >-ordered-dither</a> to reduce the number of
cristy3ed852e2009-09-05 21:47:34 +00004490colors an animated image sequence, to less that 256 colors. This ensures that
4491a common or global color table is used when saving the result to a color
4492limited file format such as GIF. </p>
4493
cristyd934d102009-10-10 12:55:13 +00004494<p>Note that at this time the exact same threshold dithering map is used for
4495all color channels, no attempt is made to offset or rotate the map for
4496different channels is made, to create an offset printing effect. (possible
4497future expansion) </p>
cristy3ed852e2009-09-05 21:47:34 +00004498
4499
4500<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004501 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004502</div>
4503
4504<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>
4505
cristyc54f5d42009-11-27 21:36:31 +00004506<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004507described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4508>-fuzz</a> setting can be used to match and replace colors similar to the one
4509given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004510
cristyb36feb22010-03-26 16:54:37 +00004511<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4512the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004513
cristyb36feb22010-03-26 16:54:37 +00004514<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4515as <a href="#opaque" >-opaque</a> but replaces the matching color with
4516transparency rather than the current <a href="#fill">-fill</a> color setting.
4517To ensure that it can do this it also ensures that the image has an alpha
4518channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4519the new transparent colors, and does not require you to modify the <a
4520href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004521
cristy3ed852e2009-09-05 21:47:34 +00004522
4523<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004524 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004525</div>
4526
4527<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>
4528
4529<p>Choose from these orientations:</p>
4530
4531<pre class="text">
4532 bottom-left
4533 bottom-right
4534 left-bottom
4535 left-top
4536 right-bottom
4537 right-top
4538 top-left
4539 top-right
4540 undefined
4541</pre>
4542
cristyd934d102009-10-10 12:55:13 +00004543<p>To print a complete list of orientations, use the <a href="#list" >-list
4544orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004545
4546
4547<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004548 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004549 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4550 +page
4551 </h4>
4552</div>
4553
4554<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>
4555
4556<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>
4557
4558<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>
4559
4560<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>
4561<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4562<thead>
4563 <tr valign="top">
4564 <th align="center"><em class="arg">media</em></th>
4565 <th align="center"><em class="arg">width</em></th>
4566 <th align="center"><em class="arg">height</em></th>
4567 </tr>
4568</thead>
4569<tbody>
4570<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4571<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4572<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4573<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4574<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4575<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4576<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4577<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4578<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4579<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4580<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4581<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4582<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4583<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4584<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4585<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4586<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4587<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4588<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4589<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4590<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4591<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4592<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4593<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4594<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4595<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4596<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4597<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4598<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4599<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4600<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4601<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4602<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4603<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4604<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4605<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4606<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4607<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4608</tbody>
4609</table>
4610
4611
4612
4613
4614<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>
4615
4616<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>
4617
4618<p>The default page dimensions for a TEXT image is 612x792.</p>
4619
4620<p>This option is used in concert with <a href="#density">-density</a>.</p>
4621
4622<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4623
4624<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004625 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004626</div>
4627
4628<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>
4629
4630<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>
4631
4632<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004633 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004634
4635<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>
4636
4637<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004638 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004639</div>
4640
4641<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>
4642
4643<p>Pause for the specified number of seconds before repeating the animation.</p>
4644
4645<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004646 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004647</div>
4648
4649<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>
4650
4651<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4652
4653<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004654 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004655</div>
4656
4657<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>
4658
4659<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004660 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></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%'>pointsize of the PostScript, OPTION1, or TrueType font.</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="polaroid"></a>-polaroid <em class="arg">angle</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%'>simulate a Polaroid picture.</td><td style='text-align:right;'></td></tr></table>
4670
4671<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4672
4673<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004674 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004675</div>
4676
4677<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>
4678
4679<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004680 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004681</div>
4682
4683<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>
4684
4685<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004686 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004687</div>
4688
4689<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>
4690
4691<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>
4692
4693<pre class="text">
4694 Rotate
4695 Shear
4696 Roll
4697 Hue
4698 Saturation
4699 Brightness
4700 Gamma
4701 Spiff
4702 Dull
4703 Grayscale
4704 Quantize
4705 Despeckle
4706 ReduceNoise
4707 Add Noise
4708 Sharpen
4709 Blur
4710 Threshold
4711 EdgeDetect
4712 Spread
4713 Shade
4714 Raise
4715 Segment
4716 Solarize
4717 Swirl
4718 Implode
4719 Wave
4720 OilPaint
4721 CharcoalDrawing
4722 JPEG
4723</pre>
4724
4725<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4726
4727<p>The default preview is <kbd>JPEG</kbd>.</p>
4728
4729<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004730 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004731</div>
4732
4733<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>
4734
4735<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004736 <h4><a id="process"></a>-process <em class="arg">command</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%'>process the image with a custom image filter.</td><td style='text-align:right;'></td></tr></table>
4740
4741<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>
4742
4743<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004744 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004745 +profile <em class="arg">profile_name</em></h4>
4746</div>
4747
4748<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>
4749
4750<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>
4751
4752<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>
4753
4754<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>
4755
4756<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>
4757
4758<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4759
4760<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4761<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>
4762
4763<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>
4764<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4765CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4766</p>
4767
4768<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004769 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004770</div>
4771
4772<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>
4773
cristy851dbce2010-08-06 21:40:00 +00004774<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 +00004775
4776<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>
4777
cristy851dbce2010-08-06 21:40:00 +00004778<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 +00004779
cristy3c98a4f2010-08-13 20:09:41 +00004780<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 +00004781
4782<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4783
4784<pre class="text">
4785 0: none
4786 1: sub
4787 2: up
4788 3: average
4789 4: Paeth
4790</pre>
4791
4792<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>
4793
4794<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4795
4796<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>
4797
cristy3c98a4f2010-08-13 20:09:41 +00004798<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 +00004799
4800<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4801
cristy3ed852e2009-09-05 21:47:34 +00004802<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004803 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004804</div>
4805
cristy3c98a4f2010-08-13 20:09:41 +00004806<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 +00004807
cristy3c98a4f2010-08-13 20:09:41 +00004808<p>This setting defines the colorspace used to sort out and reduce the number
4809of colors needed by an image (for later dithering) by operators such as <a
4810href="#colors" >-colors</a>, Note that color reducion also happens
4811automatically when saving images to color-limited image file formats, such as
4812GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004813
4814
4815<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004816 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004817</div>
4818
4819<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>
4820
4821<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004822 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004823</div>
4824
4825<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>
4826
4827<p>Note that this is actually a rotational blur rather than a radial and as
4828such actually mis-named. </p>
4829
4830<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4831pixels which are outside the image proper are blurred into the final result.
4832</p>
4833
4834
4835<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004836 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004837</div>
4838
4839<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>
4840
4841<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>.
4842</p>
4843
4844<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4845
4846<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004847 <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 +00004848</div>
4849
4850<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>
4851
4852<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004853 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004854</div>
4855
4856<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the red chromaticity primary point.</td><td style='text-align:right;'></td></tr></table>
4857
4858<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004859 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00004860</div>
4861
4862<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Pay attention to warning messages.</td><td style='text-align:right;'></td></tr></table>
4863
4864<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004865 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004866</div>
4867
4868<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>
4869
4870<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4871the given colors are dithered over the image as necessary, otherwise the closest
4872color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4873
4874<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4875images in the current image sequence, all the images will have the same color
4876table. That means that when saved to a file format such as GIF, it will use
4877that color table as a single common or global color table, for all the images,
4878without requiring extra local color tables. </p>
4879
4880<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4881sequence to use a common color map over all the images. This equivalent to
4882appending all the images together (without extra background colors) and color
4883reducing those images using <a href="#colors">-colors</a> with a 256 color
4884limit, then <a href="#remap">-remap</a> those colors over the original list of
4885images. This ensures all the images follow a single color map. </p>
4886
4887<p>If the number of colors over all the images is less than 256, then <a
4888href="#remap">+remap</a> should not perform any color reduction or dithering, as
4889no color changes are needed. In that case, its only effect is to force the use
4890of a global color table. This recommended after using either <a
4891href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
4892reduce the number of colors in an animated image sequence. </p>
4893
4894<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004895 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004896</div>
4897
4898<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>
4899
4900<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>
4901
4902<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>
4903
4904<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004905 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00004906</div>
4907
4908<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>
4909
4910<p>The only command recognized is the name of an image file to load.</p>
4911
4912<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>
4913
4914<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004915 <h4><a id="render"></a>-render</h4>
cristy3ed852e2009-09-05 21:47:34 +00004916</div>
4917
4918<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>
4919
4920<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>
4921
4922<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004923<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004924</div>
4925
4926<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Adjust the canvas and offset information of the image.</td><td style='text-align:right;'></td></tr></table>
4927
4928<p>This option is like <a href="#page">-page</a> but acts as an image operator
4929rather than a setting. You can separately set the canvas size or the offset
4930of the image on that canvas by only providing those components. </p>
4931
4932<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>
4933
4934<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
4935offset to move the image relative to its previous position. This useful for
4936animation sequences. </p>
4937
4938<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
4939recalculate the canvas size so the image (at its current offset) will appear
4940completely on that canvas (unless it has a negative offset).</p>
4941
4942<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
4943canvas meta-data from the images. </p>
4944
4945<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
4946directly assign virtual canvas meta-data. </p>
4947
4948
4949<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004950 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004951</div>
4952
4953<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>
4954
4955<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>
4956
4957<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>
4958
4959<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004960 <h4><a id="resize"></a>-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004961</div>
4962
4963<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Resize an image.</td><td style='text-align:right;'></td></tr></table>
4964
4965<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>
4966
4967<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>
4968
cristy13538962010-02-26 17:53:04 +00004969<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>
4970
cristy4949d522010-03-12 18:41:34 +00004971<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 +00004972<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004973 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00004974</div>
4975
4976<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>
4977
4978<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004979 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00004980</div>
4981
4982<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>
4983
4984
4985<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004986 <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 +00004987</div>
4988
4989<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>
4990
4991<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>
4992
4993
4994<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004995 <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 +00004996</div>
4997
4998<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>
4999
5000<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>
5001
5002<p>Empty triangles in the corners, left over from rotating the image, are
5003filled with the <kbd>background</kbd> color. </p>
5004
5005<p>See also the <a href="#distort">-distort</a> operator and specifically the
5006'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5007
5008
5009<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005010 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005011</div>
5012
cristyd0bd44a2010-09-24 12:38:11 +00005013<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 +00005014
cristyd0bd44a2010-09-24 12:38:11 +00005015<p>Change the image size simply by directly sampling the pixels original
5016image. When magnifying, pixels are replicated in blocks. When minifying,
5017pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005018
cristyd0bd44a2010-09-24 12:38:11 +00005019<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5020a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5021neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5022avoids all the filter processing of the image. As such it completely ignores
5023the current <a href="#filter">-filter</a> setting. </p>
5024
5025<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5026will be added to the resulting image, though some colors may disappear. </p>
5027
5028<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
5029ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005030
5031
5032<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005033 <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 +00005034</div>
5035
5036<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>
5037
5038<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>
5039
5040<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005041 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005042</div>
5043
cristyd0bd44a2010-09-24 12:38:11 +00005044<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 +00005045
cristyd0bd44a2010-09-24 12:38:11 +00005046<p>Change the image size simply by replacing pixels by averaging pixels
5047together when minifying, or replacing pixels when magnifing. </p>
5048
5049<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5050a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5051faster, as it avoids all the filter processing of the image. As such it
5052completely ignores the current <a href="#filter">-filter</a> setting. </p>
5053
5054<p>If when shrinking (minifying) images the original image is some integer
5055multiple of the new image size, the number of pixels avergaed together to
5056produce the new pixel color is the same across the whole image. This is
5057a special case known as 'binning' and is often used as a method of reducing
5058noise in image such as those generated by digital cameras, especially in low
5059light conditions. </p>
5060
cristy3ed852e2009-09-05 21:47:34 +00005061
5062<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005063 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005064</div>
5065
5066<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>
5067
5068<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5069
5070<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005071 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005072</div>
5073
5074<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>
5075
5076<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>
5077
5078<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005079 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005080</div>
5081
5082<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>seed a new sequence of pseudo-random numbers</td><td style='text-align:right;'></td></tr></table>
5083
5084<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005085 <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 +00005086</div>
5087
5088<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>
5089
5090<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>
5091
5092<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>
5093
5094<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5095of the color clusters is returned.</p>
5096
5097
5098<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005099 <h4><a id="selective-blur"></a>-selective-blur <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005100</div>
5101
cristy2e2662a2010-10-09 14:29:37 +00005102<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005103 <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 +00005104</div>
5105
cristy3ed852e2009-09-05 21:47:34 +00005106<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>
5107
cristy2e2662a2010-10-09 14:29:37 +00005108<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>
5109
cristy3ed852e2009-09-05 21:47:34 +00005110<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005111 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005112</div>
5113
5114<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>
5115
5116<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005117 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005118</div>
5119
5120<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>
5121
5122<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5123
5124<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>
5125
cristyd0bda5e2010-09-21 16:22:45 +00005126
5127
cristy3ed852e2009-09-05 21:47:34 +00005128<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005129 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5130 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005131</div>
5132
cristyd0bd44a2010-09-24 12:38:11 +00005133<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 +00005134image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005135
cristyd0bd44a2010-09-24 12:38:11 +00005136<p>This will assign (or modify) specific settings attached to all the images
5137in the current image sequence. Using the <a href="#set">+set</a> form of the
5138option will either remove, or reset that setting to a default state, as
5139appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005140
cristyd0bd44a2010-09-24 12:38:11 +00005141<p>For example, it will modify specific well known image meta-data
5142'attributes' such as those normally overridden by: the options <a
5143href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5144href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5145assigned before the image is read in, by using a <em class="arg">key</em> of
5146the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005147
cristyd0bd44a2010-09-24 12:38:11 +00005148<p>If the given <em class="arg">key</em> does not match a specific known
5149'attribute ', such as shown above, the setting is stored as a a free form
cristyd0bda5e2010-09-21 16:22:45 +00005150'properity' string. Such settings are listed in <a href="#verbose"
5151>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5152</p>
5153
cristyd0bd44a2010-09-24 12:38:11 +00005154<p>This includes string 'properities' that are set by and assigned to images
5155using the options <a href="#comment" >-comment</a>, <a href="#label"
5156>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5157a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5158Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005159
cristyd0bd44a2010-09-24 12:38:11 +00005160<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>
5161<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5162Properties</a> in the defined value. For example:</p>
5163
5164<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>
5165<p>Other well known 'properities' that can be include:
5166'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5167'<kbd>signature</kbd>'. </p>
5168
5169<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5170the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5171see <a href="#repage">-page</a>). However it is designed to provide a finer
5172control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5173option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5174attribute. </p>
5175
5176<p>This option can also associate a colorspace or profile with your image.
5177For example,</p>
5178
5179<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 +00005180<p>Some 'properties' must be defined in a specific way to be used. For
5181example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5182modify the output filename of an image. For example</p>
5183
5184<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>
5185<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5186be saved as a global "Artifact" exactly as if it was set using the <a
cristyd0bd44a2010-09-24 12:38:11 +00005187href="#define" >-define</a> option. As such settings are globel in scope, they
5188can be used to pass 'attributes' and 'properities' of one specific image,
5189in a way that allows you to use them in a completely different image, even if
5190the original image has long since been modified or destroyed. For example: </p>
5191
5192<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>
5193<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5194a 'artifact' if the given <em class="arg">key</em> does not match an existing
5195'attribute' or 'properity'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005196
5197<p>You can set the attributes of the image registry by prefixing the value
5198with <kbd>registry:</kbd>.</p>
5199
5200
cristy3ed852e2009-09-05 21:47:34 +00005201
5202<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005203 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005204</div>
5205
5206<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>
5207
5208<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>
5209
5210<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005211 <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 +00005212</div>
5213
5214<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>
5215
5216<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005217 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005218id="shared-memory"></a>-shared-memory</h4>
5219</div>
5220
5221<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>
5222
5223<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>
5224
5225<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005226 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005227</div>
5228
5229<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>sharpen the image.</td><td style='text-align:right;'></td></tr></table>
5230
5231<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5232
5233<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005234 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005235</div>
5236
5237<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>
5238
5239<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>
5240
5241<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>
5242
5243<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005244 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005245</div>
5246
5247<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Shear the image along the x-axis and/or y-axis.</td><td style='text-align:right;'></td></tr></table>
5248
5249<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>
5250
5251<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>
5252
5253<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>
5254
5255<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>
5256
5257<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>
5258<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>
5259
5260<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5261<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005262 <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 +00005263</div>
5264
5265<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>
5266
5267<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>
5268
5269<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005270 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005271</div>
5272
5273<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>
5274
5275<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005276 <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 +00005277</div>
5278
5279<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>
5280
5281<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>
5282
5283<p>For Photo CD images, choose from these sizes:</p>
5284
5285<pre class="text">
5286 192x128
5287 384x256
5288 768x512
5289 1536x1024
5290 3072x2048
5291</pre>
5292
cristy3ed852e2009-09-05 21:47:34 +00005293<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005294 <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 +00005295</div>
5296
5297<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>
5298
5299<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>
5300
5301<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005302 <h4><a id="snaps"></a>-snaps <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005303</div>
5304
5305<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>
5306
5307<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5308
5309<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005310 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005311</div>
5312
5313<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>
5314
5315<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5316
5317<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5318
5319<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005320 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005321 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5322</div>
5323
5324<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>
5325
5326
5327<table class="doc">
5328 <tbody>
5329 <tr valign="top">
5330 <th align="left" style="width: 8%">Method</th>
5331 <th align="left">Description</th>
5332 </tr>
5333
5334 <tr valign="top">
5335 <td valign="top">voronoi</td>
5336 <td valign="top">Simply map each pixel to the to nearest color point
5337 given. The result are polygonal 'cells' of solid color. </td>
5338 </tr>
5339
5340 <tr valign="top">
5341 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005342 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005343 squared. Generating spots of color in a sea of the average of
5344 colors. </td>
5345 </tr>
5346
5347 <tr valign="top">
5348 <td valign="top">barycentric</td>
5349 <td valign="top">three point triangle of color given 3 points.
5350 Giving only 2 points will form a linear gradient between those points.
5351 Gradient is however not restricted to just the triangle or line. </td>
5352 </tr>
5353
5354 <tr valign="top">
5355 <td valign="top">bilinear</td>
5356 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5357 fall back to barycentric. </td>
5358 </tr>
5359
5360 </tbody>
5361</table>
5362
5363<p>The points are placed according to the images location on the virtual
5364canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5365offset), and do not actually have to exist on the given image, but may be
5366some point beyond the edge of the image. All points are floating point values.
5367</p>
5368
5369<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
5370modified, whcih means the matte/alpha transparency channel is not effected by
5371default. If enabled, the image also needs a the matte/alpha channel to be
5372enabled for this operator to effect an images transparency. This is typical
5373transparency handling for images. </p>
5374
5375<p>All the above methods when given a single point of color will replace all
5376the colors in the image with the color given, regardless of the point. This is
5377logical, and provides an alternative technique to recolor a image to some
5378default value. </p>
5379
5380
5381<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005382 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005383</div>
5384
5385<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>
5386
5387<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>
5388
5389<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005390 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005391</div>
5392
5393<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>
5394
5395<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>
5396
5397<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005398 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005399</div>
5400
5401<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>
5402
5403<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>
5404
5405<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005406 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005407</div>
5408
5409<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>
5410
5411<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>
5412
5413<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005414 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005415</div>
5416
5417<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>pixel storage type. Here are the valid types:</td><td style='text-align:right;'></td></tr></table>
5418
5419<pre class="text">
5420 char store pixels as unsigned characters
5421 double store pixels as doubles
5422 float store pixels as floats
5423 integer store pixels as integers
5424 long store pixels as longs
5425 quantum store pixels in the native depth of your ImageMagick distribution
5426 short store pixels as unsigned shorts
5427</pre>
5428
5429<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5430values range from 0 to the maximum value the storage type can support.</p>
5431
5432<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005433 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005434</div>
5435
5436<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>
5437
5438<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>
5439
5440<pre class="text">
5441 Any
5442 Condensed
5443 Expanded
5444 ExtraCondensed
5445 ExtraExpanded
5446 Normal
5447 SemiCondensed
5448 SemiExpanded
5449 UltraCondensed
5450 UltraExpanded
5451</pre>
5452
5453<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5454
5455<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>
5456
5457<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005458 <h4><a id="strip"></a>-strip</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%'>strip the image of any profiles or comments.</td><td style='text-align:right;'></td></tr></table>
5462
5463<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005464 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005465</div>
5466
5467<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>color to use when stroking a graphic primitive.</td><td style='text-align:right;'></td></tr></table>
5468
5469<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5470
5471<p>See <a href="#draw">-draw</a> for further details.</p>
5472
5473<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005474 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005475</div>
5476
5477<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>
5478
5479<p>See <a href="#draw">-draw</a> for further details.</p>
5480
5481<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005482 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005483</div>
5484
5485<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>
5486
cristy71a3f602010-09-15 12:38:16 +00005487<p>This setting suggests a font style that ImageMagick should try to apply to
5488the currently selected font family. Select <em class="arg">fontStyle</em> from
5489the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005490
5491<pre class="text">
5492 Any
5493 Italic
5494 Normal
5495 Oblique
5496</pre>
5497
5498<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>
5499
5500<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005501 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005502</div>
5503
cristyd4d64ed2010-08-22 22:19:33 +00005504<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>
5505
cristy71a3f602010-09-15 12:38:16 +00005506<p>This option is required to have compare search for the best match location
5507of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005508(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005509be the "match score" image.</p>
5510
cristyd0bd44a2010-09-24 12:38:11 +00005511<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005512position of the top-left corner of the given sub-image. that is its size will
5513be the size of the larger_image - sub_image + 1. The brightest location in
5514this image is the location s the locate on the best match that is also
5515reported. Note that this may or may nor be a perfect match, and the actual
5516brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005517possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005518
cristyd0bda5e2010-09-21 16:22:45 +00005519<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005520location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005521sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005522
cristyae6203d2010-08-09 01:12:14 +00005523
5524<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005525 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005526</div>
5527
5528<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>
5529
cristy71a3f602010-09-15 12:38:16 +00005530<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5531images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5532the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005533
5534<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005535 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005536</div>
5537
5538<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>
5539
5540<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5541
5542<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005543 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005544</div>
5545
5546<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>
5547
5548<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005549 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005550</div>
5551
cristy5063d812010-10-19 16:28:10 +00005552<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 +00005553
5554<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005555 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005556</div>
5557
5558<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>
5559
5560<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>
5561
5562<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>
5563
5564<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005565 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005566</div>
5567
5568<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>
5569
5570<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005571 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005572</div>
5573
5574<!-- {<em class="arg">green,blue,opacity</em>}
5575<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>
5576-->
5577
5578<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>
5579
5580<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>
5581
5582<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.
5583</p>
5584
5585<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>
5586
5587<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5588<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>
5589
5590
5591<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>
5592<p>Note that the values of the transparency channel is treated as 'matte'
5593values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5594
5595<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>.
5596</p>
5597
5598<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005599 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005600</div>
5601
5602<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>
5603
5604<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>
5605
5606<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>
5607
5608<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005609 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005610</div>
5611
5612<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>
5613
5614<div style="margin: auto;">
5615 <h4>-tile <em class="arg">geometry</em></h4>
5616</div>
5617
5618<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>
5619
5620<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>
5621
5622<div style="margin: auto;">
5623 <h4>-tile</h4>
5624</div>
5625
5626<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>
5627
5628<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005629 <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 +00005630</div>
5631
5632<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>
5633
5634<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>
5635
5636<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>
5637
5638<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005639 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005640</div>
5641
5642<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>
5643
5644<p>Tint the image with the fill color.</p>
5645
5646<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>
5647
5648<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005649 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005650</div>
5651
5652<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>
5653
5654<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>
5655
5656<p>For example,</p>
5657
5658<p class="crtsnip">
5659 -title "%m:%f %wx%h"
5660</p>
5661
5662<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>
5663
5664
5665<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005666 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005667</div>
5668
5669<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>
5670
5671<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5672
5673<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 +00005674
5675<p>This operator has been now been superseded by the <a
5676href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5677
5678
cristy3ed852e2009-09-05 21:47:34 +00005679<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005680 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005681</div>
5682
5683<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>
5684
5685<p>The <em class="arg">color</em> argument is defined using the format
5686described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5687>-fuzz</a> setting can be used to match and replace colors similar to the one
5688given. </p>
5689
cristyb36feb22010-03-26 16:54:37 +00005690<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5691that is make all non-matching colors transparent. </p>
5692
cristy3ed852e2009-09-05 21:47:34 +00005693<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005694href="#transparent" >-transparent</a> but replaces the matching color with the
5695current <a href="#fill">-fill</a> color setting, rather than transparent.
5696However the <a href="#transparent" >-transparent</a> operator also ensures
5697that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5698>-alpha</a> set</kbd>", and does not require you to modify the <a
5699href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005700
cristyb36feb22010-03-26 16:54:37 +00005701<p>Note that this does not define the color as being the 'transparency color'
5702used for color-mapped image formats, such as GIF. For that use <a
5703href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005704
5705
5706<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005707 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005708</div>
5709
5710<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>
5711
5712<p>Sometimes this is used for saving to image formats such as
5713GIF and PNG8 which uses this color to represent boolean transparency. This
5714does not make a color transparent, it only defines what color the transparent
5715color is in the color palette of the saved image. Use <a
5716href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5717
5718<p>This option allows you to have both an opaque visible color, as well as a
5719transparent color of the same color value without conflict. That is, you can
5720use the same color for both the transparent and opaque color areas within an
5721image. This, in turn, frees to you to select a transparent color that is
5722appropriate when an image is displayed by an application that does not handle a
5723transparent color index, while allowing ImageMagick to correctly handle images of this
5724type. </p>
5725
5726<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5727
5728<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005729 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005730</div>
5731
5732<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>
5733
5734<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5735</p>
5736
5737<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005738 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005739</div>
5740
5741<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>
5742
5743
5744<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005745 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005746</div>
5747
5748<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>
5749
5750<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>
5751
5752<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>
5753
5754<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>
5755
5756<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005757 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00005758</div>
5759
5760<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>
5761
5762<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>
5763
5764<p>The page or virtual canvas information of the image is preserved allowing
5765you to extract the result of the <a href="#trim">-trim</a> operation from the
5766image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5767information if it is unwanted.</p>
5768
5769<p>If the trimmed image 'disappears' an warning is produced, and a special
5770single pixel transparent 'missed' image is returned, in the same way as when a
5771<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5772
5773
5774<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005775 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005776</div>
5777
5778<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 +00005779 <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 +00005780
5781<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>
5782
5783<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5784<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>
5785
5786<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5787
5788<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005789 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005790</div>
5791
5792<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>
5793
5794<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5795
5796<p>See <a href="#draw">-draw</a> for further details.</p>
5797
5798
5799<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005800 <h4><a id="update"></a>-update <em class="arg">seconds</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%'>detect when image file is modified and redisplay.</td><td style='text-align:right;'></td></tr></table>
5804
5805<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>
5806
5807
5808<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005809 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00005810</div>
5811
5812<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>
5813
5814
5815<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005816 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005817</div>
5818
5819<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>
5820
5821<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>
5822
5823
5824<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005825 <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 +00005826</div>
5827
5828<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>
5829
5830<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>
5831
5832<p>The parameters are:</p>
5833
5834<pre class="text">
5835 radius: The radius of the Gaussian, in pixels, not counting the center
5836 pixel (default 0).
5837 sigma: The standard deviation of the Gaussian, in pixels (default 1.0).
5838 amount: The fraction of the difference between the original and the blur
5839 image that is added back into the original (default 1.0).
5840 threshold: The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5841 difference amount (default 0.05).
5842</pre>
5843
5844
5845<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005846 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005847</div>
5848
cristyd0bda5e2010-09-21 16:22:45 +00005849<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 +00005850
5851
5852<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005853 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00005854</div>
5855
5856<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>
5857
5858
5859<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005860 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005861</div>
5862
5863<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>
5864
5865
5866<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005867 <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 +00005868</div>
5869
5870<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>
5871
5872
5873<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005874 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005875</div>
5876
5877<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>
5878
5879<p>This option defines what color source should be used if and when a color
5880lookup completely 'misses' the source image. The color(s) that appear to
5881surround the source image. Generally this color is derived from the source
5882image, but could also be set to a specify background color. </p>
5883
5884<p>Choose from these methods:</p>
5885
5886<pre class="text">
5887 background: the area surrounding the image is the background color
5888 black: the area surrounding the image is black
5889 checker-tile: alternate squares with image and background color
5890 dither: non-random 32x32 dithered pattern
5891 edge: extend the edge pixel toward infinity
5892 gray: the area surrounding the image is gray
5893 horizontal-tile: horizontally tile the image, background color above/below
5894 horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
5895 mirror: mirror tile the image
5896 random: choose a random pixel from the image
5897 tile: tile the image (default)
5898 transparent: the area surrounding the image is transparent blackness
5899 vertical-tile: vertically tile the image, sides are background color
5900 vertical-tile-edge: vertically tile the image and replicate the side edge pixels
5901 white: the area surrounding the image is white
5902</pre>
5903
5904<p>The default value is "edge".</p>
5905
5906<p>This most important for distortion operators such as <a href="#distort"
5907>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
5908However it also effects operations that may access pixels just outside the
5909image proper, such as <a href="#convolve">-convolve</a>, <a
5910href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
5911
5912<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
5913
5914
5915<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005916 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005917</div>
5918
5919<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
5920
5921<p>Choose from these visual classes:</p>
5922
5923<pre class="text">
5924 StaticGray
5925 GrayScale
5926 StaticColor
5927 PseudoColor
5928 TrueColor
5929 DirectColor
5930 default
5931 visual id
5932</pre>
5933
5934<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>
5935
5936
5937<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005938 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00005939 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
5940</div>
5941
5942<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
5943saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5944
5945<p>Take a grayscale image (with alpha mask) and modify the destination image's
5946brightness according to watermark image's grayscale value and the <em
5947class="arg">brightness</em> percentage. The destinations color saturation
5948attribute is just direct modified by the <em class="arg">saturation</em>
5949percentage, which defaults to 100 percent (no color change). </p>
5950
5951
5952<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005953 <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 +00005954</div>
5955
5956<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>
5957
5958<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
5959
5960<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005961 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005962</div>
5963
5964<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>
5965
5966<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>
5967
5968<table class="doc">
5969 <col width="25%" />
5970 <col width="75%" />
5971 <thead>
5972 <tr>
5973 <th><em class="arg">fontWeight</em></th>
5974 <th>Description</th>
5975 </tr>
5976 </thead>
5977 <tbody>
5978 <tr><td>All </td> <td>No effect. </td></tr>
5979 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
5980 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
5981 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
5982 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
5983 </tbody>
5984 </table>
5985
5986<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
5987
5988<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>
5989
5990<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005991 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005992</div>
5993
5994<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>
5995
5996<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005997 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005998</div>
5999
cristy5cadd612009-09-21 19:33:41 +00006000<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>
6001
6002<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.
6003</p>
cristy3ed852e2009-09-05 21:47:34 +00006004
6005<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006006 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006007</div>
6008
6009<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>
6010
6011<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>
6012
6013<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>
6014
6015<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>
6016
6017<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006018 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006019</div>
6020
6021<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the window group.</td><td style='text-align:right;'></td></tr></table>
6022
6023<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006024 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006025</div>
6026
6027<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>
6028 <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>
6029
6030<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006031</div>
6032</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006033
6034</div>
6035
6036<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006037 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006038 <span id="linkbar-center">
6039 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006040 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006041 </span>
6042 <span id="linkbar-east">&nbsp;</span>
6043 </div>
6044 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +00006045 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006046 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6047 </div>
6048 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006049 <script type="text/javascript">
6050 var _gaq = _gaq || [];
6051 _gaq.push(['_setAccount', 'UA-17690367-1']);
6052 _gaq.push(['_trackPageview']);
6053
6054 (function() {
6055 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6056 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6057 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6058 })();
6059 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006060</body>
6061</html>