blob: dbac96bf557f24de8be4afe3b735f02fe7793f13 [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"/>
31 <style type="text/css" media="all">
32 @import url("../www/magick.css");
33 </style>
cristydcca3fa2010-12-29 21:50:07 +000034 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000035 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
36 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
37 <script type="text/javascript">
38 $(document).ready(function() {
39 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
40 'transitionIn' : 'elastic',
41 'transitionOut' : 'elastic',
42 'overlayShow' : false,
43 'opacity' : true
44 });
45 });
46 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000047</head>
48
49<body id="www-imagemagick-org">
50<div class="titlebar">
51<a href="../index.html">
52 <img src="../images/script.png" alt="[ImageMagick]"
53 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
54<a href="http://www.networkredux.com">
55 <img src="../images/networkredux.png" alt="[sponsor]"
56 style="margin: 45px auto; border: 0px; float: left;" /></a>
57<a href="http://www.imagemagick.org/discourse-server/">
58 <img src="../images/logo.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60<a href="../index.html">
61 <img src="../images/sprite.jpg" alt=""
62 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
63</div>
64
cristyce69bb02010-07-27 19:49:46 +000065<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000066
cristy3ed852e2009-09-05 21:47:34 +000067<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000069</div>
cristy3eaa0ef2010-03-06 20:35:26 +000070<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000071<div class="menu">
cristybb503372010-05-27 20:51:26 +000072 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
79</div>
80<div class="sub">
81 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
82</div>
83<div class="sep"></div>
84<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000085 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000086</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000088 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000089</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000091 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000092</div>
93<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000094 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000106 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
108<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000109 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000111<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000112<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000113 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000120 </div>
121<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000122 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000123</div>
cristybb503372010-05-27 20:51:26 +0000124<div class="menu">
125 <a title="Architecture" href="../www/architecture.html">Architecture</a>
126</div>
cristy3ed852e2009-09-05 21:47:34 +0000127<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000128 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000129</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000130<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000131<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000132 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000133</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000134<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000135<div class="menu">
cristydcca3fa2010-12-29 21:50:07 +0000136 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
138<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000139 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000140</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000141<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000142<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000143 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000144
145<div class="sponsbox">
cristyec6b4752011-01-08 03:16:23 +0000146<div class="sponsor">
147 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.html">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000148</div>
149<div class="sponsor">
150 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000151</div>
152<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000153 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
154</div>
155<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000156 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
157</div>
cristyec6b4752011-01-08 03:16:23 +0000158<div class="sponsor">
159 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011050100025 gabi.schulze-->
160</div>
cristy3ed852e2009-09-05 21:47:34 +0000161</div>
162</div>
cristyce69bb02010-07-27 19:49:46 +0000163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000164
cristyce69bb02010-07-27 19:49:46 +0000165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000177</div>
178
179<div class="main">
180
cristydcca3fa2010-12-29 21:50:07 +0000181<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000182<p class="navigation-index">
cristy5063d812010-10-19 16:28:10 +0000183[ <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 +0000184
cristydcca3fa2010-12-29 21:50:07 +0000185<div class="doc-section">
186
cristyb36feb22010-03-26 16:54:37 +0000187<p>Below is list of command-line options recognized by the ImageMagick <a
188href="../www/command-line-tools.html">command-line
189tools</a>. If you want a description of a particular option, click on the
190option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000191otherwise 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 +0000192
193<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000194 <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 +0000195</div>
196
197<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 +0000198<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>
199
200<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000201 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000202</div>
203
204<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>
205
206<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>
207
208<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000209 <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 +0000210</div>
211
212<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>
213
214<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>
215
216<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000217 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000218</div>
219
220<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>
221
222<p>This option is enabled by default. An attempt is made to save all
223images of an image sequence into the given output file.
224However, some formats, such as JPEG and PNG, do not support more than one
225image per file, and in that case ImageMagick is forced to write each image as a separate file. As
226such, if more than one image needs to be written, the filename given is
227modified by adding a <a href="#scene">-scene</a> number before the
228suffix, in order to make distinct names for each image. </p>
229
230<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written
231to separate files, whether or not the file format allows multiple images
232per file (for example, GIF, MIFF, and TIFF). </p>
233
234<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>
235
236<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: rose: -morph 15 my%02dmorph.jpg</span></p>
237<p>will create a sequence of 17 images named my00morph.jpg, my01morph.jpg, my02morph.jpg, ..., my16morph.jpg.
238</p>
239
240<p>In summary, ImageMagick tries to write all images to one file, but will use
cristydcca3fa2010-12-29 21:50:07 +0000241multiple files if either<br />
242 (1) the output image's file format does not allow multi-image files,<br />
243 (2) the <a href="#adjoin">+adjoin</a> option is given, or<br />
244 (3) a printf() integer format string (eg: "%d") is present in the output filename. </p>
cristy3ed852e2009-09-05 21:47:34 +0000245
246
247<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000248 <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 +0000249 -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>
250</div>
251
252<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>
253
254<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>
255
256<p>The matrix entries are entered as comma-separated numeric values <i>with no spaces</i>. </p>
257
258<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>
259
260<div class="eqn">
261<img alt="affine transformation" src="../images/affine.png"/>
262</div>
263
264<p>
265The 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>
266
267<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>
268
269<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>
270
271<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>
272
273<p class="crtsnip">
274 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
275</p>
276
277<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>
278
279<p class="crtsnip">
280 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
281</p>
282
283<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
284<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
285
286<p class="crtsnip">
287 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
288</p>
289
290<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>
291
292<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>
293
294<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000295 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000296</div>
297
298<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>
299
300<p>Used to set a flag on an image indicating whether or not to use existing alpha
301channel 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>
302
303
304<table class="doc">
305 <tbody>
306 <tr valign="top">
307 <th align="left" style="width: 8%">type</th>
308 <th align="left">Description</th>
309 </tr>
310
311 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000312 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000313 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000314 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
315 should be used instead of this, unless you specifically need to
316 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
317 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000318
319 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000320 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000321 <td valign="top">
322 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000323 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000324
325 <tr valign="top">
326 <td valign="top"><kbd>Set</kbd></td>
327 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000328 Activates the alpha/matte channel. If it was previously turned off
329 then it also resets the channel to opaque. If the image already had
330 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000331
332 <tr valign="top">
333 <td valign="top"><kbd>Opaque</kbd></td>
334 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000335 Enables the alpha/matte channel and forces it to be fully opaque.
336 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000337
338 <tr valign="top">
339 <td valign="top"><kbd>Transparent</kbd></td>
340 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000341 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000342 transparent. This effectively creates a fully transparent image the
343 same size as the original and with all its original RGB data still
344 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000345
346 <tr valign="top">
347 <td valign="top"><kbd>Extract</kbd></td>
348 <td valign="top">
349 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000350 '<kbd>Off</kbd>' the the image's transparency, so as to generate
351 a gray-scale mask of the image's shape. The alpha channel data is left
352 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
353 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000354
355 <tr valign="top">
356 <td valign="top"><kbd>Copy</kbd></td>
357 <td valign="top">
358 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000359 gray-scale intensity of the image, into the alpha channel, converting
360 a gray-scale mask into a transparent shaped mask ready to be colored
361 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000362
363 <tr valign="top">
364 <td valign="top"><kbd>Shape</kbd></td>
365 <td valign="top">
366 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000367 the current background color. That is the RGB color channels is
368 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000369 </td></tr>
370
371 <tr valign="top">
372 <td valign="top"><kbd>Background</kbd></td>
373 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000374 Set any fully-transparent pixel to the background color, while leaving
375 it fully-transparent. This can make some image file formats, such as
376 PNG, smaller as the RGB values of transparent pixels are more uniform,
377 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000378 </td></tr>
379 </tbody>
380</table>
381
382<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000383"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000384>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000385Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000386
387
388<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000389 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000390 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
391 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
392 -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>
393</div>
394
395<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>
396
397<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>
398
399
400<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>
401
402<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>
403
404<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>
405<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
406
407<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>
408
409<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>
410
411<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000412 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000413</div>
414
415<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
416drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
417
418<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
419drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
420antialiasing edge pixels. This will then reduce the number of colors added to
421an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000422are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000423
424<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000425 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000426</div>
427
428<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>
429
430<p>This option creates a single longer image image, by joining all the current
431images in sequence top-to-bottom. Use <a href="#append">+append</a> to
432stack images left-to-right. </p>
433
434<p>If they are not of the same width, narrower images are padded with the
435current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000436position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000437href="#gravity">-gravity</a> setting. </p>
438
439
440<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000441 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000442</div>
443
444<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>
445
446
447<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000448 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000449</div>
450
451<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>
452
453<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>
454
455<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
456
cristyd934d102009-10-10 12:55:13 +0000457
458
cristy3ed852e2009-09-05 21:47:34 +0000459<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000460 <h4><a id="auto-gamma"></a>-auto-gamma</h4>
cristy3ed852e2009-09-05 21:47:34 +0000461</div>
462
463<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>
464
cristyd934d102009-10-10 12:55:13 +0000465<p>This calculates the mean values of an image, then applies a calculated <a
466href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
467image it will get a have a value of 50%. </p>
468
cristyd0bd44a2010-09-24 12:38:11 +0000469<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000470
471<p>This works well for real-life images with little or no extreme dark and
472light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000473dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000474</p>
475
476<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000477'<em>sync</em>' flag for channel syncronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000478values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000479>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000480together by the same gamma value, preserving colors. </p>
481
482
483
cristy3ed852e2009-09-05 21:47:34 +0000484<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000485 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000486</div>
487
488<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>
489
cristyd934d102009-10-10 12:55:13 +0000490<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000491minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000492href="#level" >-level</a> operator to stretch the values to the full range of
493values. </p>
494
cristy83543962009-10-16 19:04:28 +0000495<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000496JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
497for the <a href="#level" >-level</a> operation. On the other hand it is the
498right operator to use for color stretching gradient images being used to
499generate Color lookup tables, distortion maps, or other 'mathematically'
500defined images. </p>
501
502<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
503href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
504>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
505problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000506>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000507
508<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000509special '<em>sync</em>' flag for channel syncronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000510which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000511href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
512'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000513together by the same gamma value, preserving colors, and ignoring
514transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000515
516
cristy3ed852e2009-09-05 21:47:34 +0000517<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000518 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000519</div>
520
521<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>
522
cristy83543962009-10-16 19:04:28 +0000523<p>This operator reads and resets the EXIF image profile setting 'Orientation'
524and then performs the appropriate 90 degree rotation on the image to orient
525the image, for correct viewing. </p>
526
527<p>This EXIF profile setting is usually set using a gravity sensor in digital
528camara, however photos taken directly downward or upward may not have an
529appropriate value. Also images that have been orientation 'corrected' without
530reseting this setting, may be 'corrected' again resulting in a incorrect
531result. If the he EXIF profile was previously stripped, the <a
532href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
533
534
cristy3ed852e2009-09-05 21:47:34 +0000535<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000536 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000537</div>
538
539<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>
540
541<p>An error results if the images are not identically sized.</p>
542
cristy3ed852e2009-09-05 21:47:34 +0000543
544<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000545 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000546</div>
547
548<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>
549
550<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>
551
552<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000553 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000554</div>
555
556<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>
557
558<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>
559
560<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000561 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000562</div>
563
564<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>
565
cristye6378132009-10-26 20:05:17 +0000566<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 +0000567
cristye6378132009-10-26 20:05:17 +0000568<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>
569<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 +0000570
571<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000572 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000573</div>
574
575<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>
576
577<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>
578
579<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>
580
581<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
582negative results without clipping to the color value range
583(0..QuantumRange).</p>
584
585<p>See the discussion on HDRI implementations of ImageMagick on the page
586<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.
587</p>
588
589<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000590 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000591</div>
592
593<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>
594
595<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000596 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000597</div>
598
cristy5cadd612009-09-21 19:33:41 +0000599<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>
600
601<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.
602</p>
cristy3ed852e2009-09-05 21:47:34 +0000603
604
605<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000606 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000607</div>
608
cristy83a272e2010-05-07 20:40:35 +0000609<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 +0000610
611<p>Blend will average the images together ('plus') according to the
612percentages given and each pixels transparency. If only a single percentage
613value is given it sets the weight of the composite or 'source' image, while
614the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000615<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
616'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000617
618
619<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000620 <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 +0000621</div>
622
623<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>
624
625<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000626 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000627</div>
628
629<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</td><td style='text-align:right;'></td></tr></table>
630
631<div style="margin: auto;">
632
633<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000634 <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 +0000635</div>
636
637<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>
638
cristyb15553d2010-07-03 22:53:14 +0000639<p>Convolve the image with a Gaussian or normal distribution using the given
640<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000641
642<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
643</div>
644
cristyb15553d2010-07-03 22:53:14 +0000645<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000646determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000647
cristyb15553d2010-07-03 22:53:14 +0000648<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000649array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000650integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000651radius that will provide meaningful results for the Gaussian distribution.
652</p>
653
654<p>The larger the <em class="arg" >Radius</em> the radius the slower the
655operation is. However too small a <em class="arg" >Radius</em>, and sever
656aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
657should be at least twice the <em class="arg" >Sigma</em> value, though three
658times will produce a more accurite result. </p>
659
660<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
661by taking advantage of the separability properties of the distribution. Here
662we apply a single-dimensional Gaussian matrix in the horizontal direction,
663then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000664
665<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
666pixels which are outside the image proper are blurred into the final result.
667</p>
668
669
670<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000671 <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 +0000672</div>
673
674<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>
675
676<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
677Average (EWA) of the source image, scaled according to the grayscale
678mapping. </p>
679
680<p>The ellipse is weighted with sigma set to the given <em class="arg"
681>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
682defaults to the <em class="arg" >Width</em> for a normal circular Guassian
683weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
684horizontal clock-wise. </p>
685
686<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
687pixels which are outside the image proper are blurred into the final result.
688</p>
689
690
691<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000692 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000693</div>
694
695<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>
696
cristybc9539a2010-08-16 18:06:20 +0000697<p>Set the width and height using the <em class="arg">size</em> portion of the
698<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
699ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000700
cristybc9539a2010-08-16 18:06:20 +0000701<p>Set the border color by preceding with the <a
702href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000703
cristybc9539a2010-08-16 18:06:20 +0000704<p>The <a href="#border">-border</a> operation is affected by the current <a
705href="#compose">-compose</a> setting and assumes that this is using the default
706'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
707size colors by the current <a href="#bordercolor">-bordercolor</a> before
708overlaying the original image in the center of this net image. This means that
709with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000710be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000711<p>See also the <a href="#frame">-frame</a> option, which has more
712functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000713
714<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000715 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000716</div>
717
718<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>
719
720<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
721
722<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
723
724<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000725 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000726</div>
727
728<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>
729
730<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000731 <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 +0000732</div>
733
734<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>
735
cristyefb2bdb2010-11-20 19:35:22 +0000736<p>Brightness and Contrast values apply changes to the input image. They are
737not absolute settings. A brightness or contrast value of zero means no change.
738The range of values is -100 to +100 on each. Positive values increase the
739brightness or contrast and negative values decrease the brightness or contrast.
740To control only contrast, set the brightness=0. To control only brightness,
741set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000742
cristyefb2bdb2010-11-20 19:35:22 +0000743<p>You may also use <a href="#fill">-channel</a> to control which channels to
744apply the brightness and/or contrast change. The default is to apply the same
745transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000746
cristyefb2bdb2010-11-20 19:35:22 +0000747<p>Brightness and Contrast arguments are converted to offset and slope of a
748linear transform and applied
749using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000750
cristyefb2bdb2010-11-20 19:35:22 +0000751<p>The slope varies from 0 at contrast=-100 to almost vertical at
752contrast=+100. For brightness=0 and contrast=-100, the result are totally
753midgray. For brightness=0 and contrast=+100, the result will approach but
754not quite reach a threshold at midgray; that is the linear transformation
755is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000756
cristyefb2bdb2010-11-20 19:35:22 +0000757<p>Negative slopes, i.e. negating the image, are not possible with this
758function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000759
cristyefb2bdb2010-11-20 19:35:22 +0000760<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
761at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
762totally white. Similarly, when contrast=0 and brightness=-100, the result is
763totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000764
cristyefb2bdb2010-11-20 19:35:22 +0000765<p>As the range of values for the arguments are -100 to +100, adding the '%'
766symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000767
768<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000769 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000770</div>
771
772<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>
773
774<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000775 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000776</div>
777
778<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Assign a caption to an image.</td><td style='text-align:right;'></td></tr></table>
779
cristy71a3f602010-09-15 12:38:16 +0000780<p>This option sets the caption meta-data of an image read in after this
781option has been given. To modify a caption of images already in memory use
782"<kbd><a href="#set">-set</a> caption</kbd>". </p>
783
784<p>The caption can contain special format characters listed in the <a
785href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000786Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000787is finally assigned to the individual images. </p>
788
789<p>If the first character of <em class="arg">string</em> is <em
790class="arg">@</em>, the image caption is read from a file titled by the
791remaining characters in the string. Comments read in from a file are literal;
792no embedded formatting characters are recognized.</p>
793
794<p>Caption meta-data ais not visible on the image itself. To do that use the
795<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
796instead.</p>
797
798<p>For example,</p>
799
800<p class="crtsnip">
801 -caption "%m:%f %wx%h" bird.miff
802</p>
803
804<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
805that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
806480.</p>
807
808
cristy3ed852e2009-09-05 21:47:34 +0000809<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000810 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000811</div>
812
813<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>
814
815<p>Here is an example color correction collection:</p>
816
817<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000818&lt;?xml version="1.0" encoding="UTF-8"?&gt;
819&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
820 &lt;ColorCorrection id="cc06668"&gt;
821 &lt;SOPNode&gt;
822 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
823 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
824 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
825 &lt;/SOPNode&gt;
826 &lt;SATNode&gt;
827 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
828 &lt;/SATNode&gt;
829 &lt;/ColorCorrection&gt;
830&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000831</pre>
832
833<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000834 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000835</div>
836
837<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Specify those image color channels to which subsequent operators are limited.</td><td style='text-align:right;'></td></tr></table>
838
cristyefb2bdb2010-11-20 19:35:22 +0000839<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
840<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
841<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
842<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000843
cristy83a272e2010-05-07 20:40:35 +0000844<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000845abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
846'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
847'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000848
cristy83a272e2010-05-07 20:40:35 +0000849For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
850you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000851<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000852 -channel Red,Blue
853</p>
854<p>or you can use the short hand form</p>
855<p class="crtsnip">
856 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000857</p>
858
cristy83a272e2010-05-07 20:40:35 +0000859<p>All the channels that is present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000860special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
861but generally any operators that are generally 'grey-scale' image operators,
862will understand this setting. See individual operator documentation. </p>
863
cristydcca3fa2010-12-29 21:50:07 +0000864<br />
cristy83a272e2010-05-07 20:40:35 +0000865
866<p>On top of the normal channel selection a extra flag can be specified,
867'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000868operators that understand this flag should perform: cross-channel
869syncronization of the channels. If not specified, then most grey-scale
870operators will apply their image processing operations to each individual
871channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000872setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000873
874<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000875<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000876together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000877it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000878independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000879
cristydcca3fa2010-12-29 21:50:07 +0000880<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000881and the <a href="#compose">-compose</a> mathematical methods, also understands
882the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
883to the alpha channel (if present). That is to say it will modify the image
884processing with the understanding that fully-transparent colors should not
885contribute to the final result. </p>
886
cristydcca3fa2010-12-29 21:50:07 +0000887<p>Basically, by default, operators work with color channels in syncronous, and
cristybac7a162010-06-15 19:57:29 +0000888treats transparency as special, unless the <a href="#channel">-channel</a>
889setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
890How each operator does this depends on that operators current implementation.
891Not all operators understands this flag at this time, but that is changing.
892</p>
cristy83a272e2010-05-07 20:40:35 +0000893
894<p>To print a complete list of channel types, use <a href="#list">-list
895channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000896
cristydcca3fa2010-12-29 21:50:07 +0000897<br />
cristyd934d102009-10-10 12:55:13 +0000898
899<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000900'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
901channels except the transparency channel, and that all the color channels are
902to be modified in exactly the same way, with a understanding of transprancy
903(depending on the operation being applied). The 'plus' form <a
904href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000905
906<p>Options that are affected by the <a href="#channel" >-channel</a> setting
907include the following.
908
909<a href="#auto-gamma">-auto-gamma</a>,
910<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000911<a href="#black-threshold">-black-threshold</a>,
912<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000913<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000914<a href="#clut">-clut</a>,
915<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000916<a href="#composite">-composite</a> (Mathematical compose methods only),
917<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000918<a href="#contrast-stretch">-contrast-stretch</a>,
919<a href="#evaluate">-evaluate</a>,
920<a href="#function">-function</a>,
921<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000922<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000923<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000924<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000925<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000926<a href="#negate">-negate</a>,
927<a href="#normalize">-normalize</a>,
928<a href="#ordered-dither">-ordered-dither</a>,
929<a href="#radial-blur">-radial-blur</a>,
930<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000931<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000932<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000933<a href="#white-threshold">-white-threshold</a>.
934</p>
935
cristyd0bda5e2010-09-21 16:22:45 +0000936<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +0000937>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +0000938href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +0000939default). These operators have yet to be made to understand the newer 'Sync'
940flag. </p>
941
cristybac7a162010-06-15 19:57:29 +0000942<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
943the image before thresholding, if no <a href="#channel" >-channel</a> setting
944has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +0000945
946<p>Also some operators such as <a href="#blur">-blur</a>, <a
947href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
948color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
949href="#channel" >-channel</a>. Generally this done to ensure that
950fully-transparent colors are treated as being fully-transparent, and thus any
951underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +0000952resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +0000953convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +0000954and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +0000955
cristybac7a162010-06-15 19:57:29 +0000956<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +0000957color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +0000958alpha channel present, and the <a href="#channel" >-channel</a> setting tells
959the operator to apply the operation using alpha channels. The <a
960href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +0000961
cristy3ed852e2009-09-05 21:47:34 +0000962
963<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000964 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +0000965</div>
966
967<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>
968
969<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000970 <h4><a id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000971</div>
972
973<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>
974
975<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000976 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000977</div>
978
979<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>
980
cristyefb2bdb2010-11-20 19:35:22 +0000981<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>
982and <em class="arg">height</em> given in the of the <em class="arg">size</em>
983portion of the <em class="arg">geometry</em> argument give the number of
984columns and rows to remove. The <em class="arg">offset</em> portion of
985the <em class="arg">geometry</em> argument is influenced by
986a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +0000987
cristyefb2bdb2010-11-20 19:35:22 +0000988<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
989and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +0000990
cristydcca3fa2010-12-29 21:50:07 +0000991<p>While it can remove internal rows and columns of pixels, it is more typically
992used with as <a href="#gravity">-gravity</a> setting and a '<kbd>+0+0</kbd>' offset
993so as to remove a single edge from an image. Compare this to <a href="#shave"
994>-shave</a> whcih removes equal numbers of pixels from oppisite sides of the image.
995</p>
996
997<p>Using <a href="#chop">-chop</a> will effectivally undo the results of a
998<a href="#splice">-splice</a> that was given the same <em class="arg">geometry</em>
999and <a href="#gravity">-gravity</a> settings. </p>
1000
1001
cristy3ed852e2009-09-05 21:47:34 +00001002<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001003 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001004</div>
1005
1006<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>
1007
1008<p>If a clipping path is present, it is applied to subsequent operations.</p>
1009
1010<p>For example, in the command</p>
1011
1012<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
1013<p>only the pixels within the clipping path are negated.</p>
1014
1015<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1016
1017<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001018 <h4><a id="clip-mask"></a>-clip-mask</h4>
cristy3ed852e2009-09-05 21:47:34 +00001019</div>
1020
1021<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>
1022
1023<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001024 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001025</div>
1026
1027<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>
1028
1029<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001030 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001031</div>
1032
1033<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>
1034
cristydcca3fa2010-12-29 21:50:07 +00001035<p>Inside parenthesis (where the operator is normally used) it will make a
1036clone of the images from the last 'pushed' image sequence, and adds them to
1037the end of the current image sequence. Outside parenthesis
1038(not recommended) it clones the images from the current image sequence. </p>
1039
cristy3ed852e2009-09-05 21:47:34 +00001040<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000010410. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001042example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001043represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001044dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1045spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
1046effectivally clone all the images. </p>
1047
1048<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
1049in the image sequence, and is thus equivelent to using a argument of
1050'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001051
1052<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001053 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001054</div>
1055
1056<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Replace the channel values in the first image using each
1057corresponding channel in the second image as a <b>c</b>olor
1058<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1059
1060<p>The second (LUT) image is ordinarily a gradient image containing the
1061histogram mapping of how each channel should be modified. Typically it is a
1062either a single row or column image of replacement color values. If larger
1063than a single row or column, values are taken from a diagonal line from
1064top-left to bottom-right corners.</p>
1065
1066<p>The lookup is further controlled by the <a
1067href="#interpolate">-interpolate</a> setting, which is especially handy for an
1068LUT which is not the full length needed by the ImageMagick installed Quality
1069(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1070'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1071gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1072lookup of color values. </p>
1073
1074<p>This operator is especially suited to replacing a grayscale image with a
1075specific color gradient from the CLUT image. </p>
1076
1077<p>Only the channel values defined by the <a href="#channel">-channel</a>
1078setting will have their values replaced. In particular, since the default <a
1079href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1080transparency (alpha/matte channel) is not affected, unless the <a
1081href="#channel">-channel</a> setting is modified. When the alpha channel is
1082set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1083as the other channels, implying that alpha/matte values are replaced using the
1084alpha/matte values of the original image. </p>
1085
cristyd0bda5e2010-09-21 16:22:45 +00001086<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001087transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1088href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001089assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001090replacement alpha values. That is you can use a gray-scale CLUT image to
1091adjust a existing images alpha channel, or you can color a gray-scale image
1092using colors form CLUT containing the desired colors, including transparency.
1093</p>
1094
cristyefb2bdb2010-11-20 19:35:22 +00001095<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1096according to the lookup of the full color RGB value from a 2D representation
1097of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001098
1099
1100<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001101 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001102</div>
1103
1104<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>
1105
cristyefb2bdb2010-11-20 19:35:22 +00001106<p>Overlay each image in an image sequence according to
1107its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1108an animation at each point in the animation sequence. All images should be
1109the same size, and are assigned appropriate GIF disposal settings for the
1110animation to continue working as expected as a GIF animation. Such frames
1111are more easily viewed and processed than the highly optimized GIF overlay
1112images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001113
cristyefb2bdb2010-11-20 19:35:22 +00001114<p>The animation can be re-optimized after processing using
1115the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1116there is no guarantee that the restored GIF animation optimization is
1117better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001118
1119
1120<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001121 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001122</div>
1123
1124<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>
1125
cristyefb2bdb2010-11-20 19:35:22 +00001126<p>Specify the amount of colorization as a percentage. Separate colorization
1127values can be applied to the red, green, and blue channels of the image with
1128a comma-delimited list of colorization
1129values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001130
1131<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001132 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001133</div>
1134
1135<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>
1136
1137<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1138
cristyefb2bdb2010-11-20 19:35:22 +00001139<p>This option only applies when the default X server visual
1140is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1141to <a href="#visual">-visual</a> for more details. By default,
1142a shared colormap is allocated. The image shares colors with
1143other X clients. Some image colors could be approximated,
1144therefore your image may look very different than intended.
1145If <kbd>private</kbd> is chosen, the image colors appear exactly
1146as they are defined. However, other clients may go <em>technicolor</em>
1147when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001148
1149<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001150 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001151</div>
1152
1153<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>
1154
cristyefb2bdb2010-11-20 19:35:22 +00001155<p>The actual number of colors in the image may be less than your request,
1156but never more. Note that this a color reduction option. Images with fewer
1157unique colors than specified by <em class="arg">value</em> will have any
1158duplicate or unused colors removed. The ordering of an existing color
1159palette may be altered. When converting an image from color to grayscale,
1160it is more efficient to convert the image to the gray colorspace before
1161reducing the number of colors. Refer to
1162the <a href="../www/quantize.html">
1163color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001164
1165<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001166 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001167</div>
1168
1169<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>
1170
cristyefb2bdb2010-11-20 19:35:22 +00001171<p>This option permits saturation changes, hue rotation, luminance to alpha,
1172and various other effects. Although variable-sized transformation matrices
1173can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1174for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1175Adobe Flash except offsets are in column 6 rather than 5 (in support of
1176CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001177
1178<p>As an example, to add contrast to an image with offsets, try this command:</p>
1179
1180<pre class="text">
1181convert kittens.jpg -color-matrix \
1182 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1183 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1184 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1185 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1186 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1187 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1188</pre>
1189<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001190 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001191</div>
1192
1193<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the image colorspace.</td><td style='text-align:right;'></td></tr></table>
1194
1195<p>Choices are:</p>
1196
1197<pre class="text">
1198 CMY
1199 CMYK
1200 Gray
1201 HSB
1202 HSL
1203 HWB
1204 Lab
1205 Log
1206 OHTA
1207 Rec601Luma
1208 Rec601YCbCr
1209 Rec709Luma
1210 Rec709YCbCr
1211 RGB
1212 sRGB
1213 Transparent
1214 XYZ
1215 YCbCr
1216 YCC
1217 YIQ
1218 YPbPr
1219 YUV
1220</pre>
1221
1222<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1223
1224<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>
1225
1226<table class="doc">
1227 <caption>Conversion Of RGB To Other Color Spaces</caption>
1228 <tr><th align="left" valign="middle">CMY</th></tr>
1229 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1230 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1231 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1232 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1233 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1234 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1235 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1236 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1237
1238 <tr><th align="left" valign="middle">Gray</th></tr>
1239 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1240
1241 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1242 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1243 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1244 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1245
1246 <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>
1247 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1248 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1249 <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>
1250
1251 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1252 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1253 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1254 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1255
1256 <tr><th align="left" valign="middle">LAB</th></tr>
1257 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1258 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1259 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1260
1261 <tr><th align="left" valign="middle">LOG</th></tr>
1262 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1263 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1264 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1265
1266 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1267 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1268 <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>
1269 <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>
1270
1271 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1272 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1273
1274 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1275 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1276 <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>
1277 <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>
1278
1279 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1280 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1281
1282 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1283 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1284 <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>
1285 <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>
1286
1287 <tr><th align="left" valign="middle">sRGB</th></tr>
1288 <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>
1289 <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>
1290 <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>
1291
1292 <tr><th align="left" valign="middle">XYZ</th></tr>
1293 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1294 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1295 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1296
1297 <tr><th align="left" valign="middle">YCC</th></tr>
1298 <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>
1299 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1300 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1301
1302 <tr><th align="left" valign="middle">YCbCr</th></tr>
1303 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1304 <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>
1305 <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>
1306
1307 <tr><th align="left" valign="middle">YIQ</th></tr>
1308 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1309 <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>
1310 <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>
1311
1312 <tr><th align="left" valign="middle">YPbPr</th></tr>
1313 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1314 <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>
1315 <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>
1316
1317 <tr><th align="left" valign="middle">YUV</th></tr>
1318 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1319 <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>
1320 <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>
1321</table>
1322
1323<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001324 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001325</div>
1326
1327<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>
1328
1329<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>
1330
1331<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.
1332</p>
1333
cristy4949d522010-03-12 18:41:34 +00001334<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 +00001335<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001336 <h4><a id="comment"></a>-comment <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001337</div>
1338
1339<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>
1340
cristyd0bda5e2010-09-21 16:22:45 +00001341<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001342option has been given. To modify a comment of images already in memory use
1343"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001344
cristy71a3f602010-09-15 12:38:16 +00001345<p>The comment can contain special format characters listed in the <a
1346href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001347Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001348is finally assigned to the individual images. </p>
1349
1350<p>If the first character of <em class="arg">string</em> is <em
1351class="arg">@</em>, the image comment is read from a file titled by the
1352remaining characters in the string. Comments read in from a file are literal;
1353no embedded formatting characters are recognized.</p>
1354
1355<p>Comment meta-data are not visible on the image itself. To do that use the
1356<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1357instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001358
1359<p>For example,</p>
1360
1361<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001362 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001363</p>
1364
cristy71a3f602010-09-15 12:38:16 +00001365<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1366that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1367480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001368
1369<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001370 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001371</div>
1372
1373<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>
1374
cristybc9539a2010-08-16 18:06:20 +00001375<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1376a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001377
cristybc9539a2010-08-16 18:06:20 +00001378<p>This setting effects image processing operators that merge two (or more)
1379images together in some way. This includes the operators,
1380<a href="#composite">-composite</a>,
1381<a href="#layers">-layers</a> composite,
1382<a href="#flatten">-flatten</a>,
1383<a href="#mosaic">-mosaic</a>,
1384<a href="#layers">-layers</a> merge,
1385<a href="#border">-border</a>,
1386<a href="#frame">-frame</a>,
1387and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001388
cristybc9539a2010-08-16 18:06:20 +00001389<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1390command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001391
1392
1393<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001394 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001395</div>
1396
cristybc9539a2010-08-16 18:06:20 +00001397<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 +00001398
1399<p>Take the first image 'destination' and overlay the second 'source' image
1400according to the current <a href="#compose">-compose</a> setting. The location
1401of the 'source' or 'overlay' image is controlled according to <a
1402href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1403settings. </p>
1404
1405<p>If a third image is given this is treated as a gray-scale 'mask' image
1406relative to the first 'destination' image. This mask will limit what parts of
1407the destination can be modified by the image composition. However for the
1408'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1409Y-displacement image instead. </p>
1410
1411<p>If a <a href="#compose">-compose</a> method requires extra numerical
1412arguments or flags these can be provided by setting the <a
1413href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001414appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001415
1416<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1417image outside the overlay area. You can disable this by setting the special <a
1418href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1419to '<kbd>false</kbd>'. </p>
1420
1421
1422<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001423 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001424</div>
1425
1426<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Use pixel compression specified by <em class="arg">type</em> when writing the image.</td><td style='text-align:right;'></td></tr></table>
1427
1428<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>
1429
1430<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1431
1432<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>
1433
1434<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>
1435
1436<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>
1437
1438<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>
1439
1440<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001441 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001442</div>
1443
1444<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>
1445
1446<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>
1447
1448<p>For a more pronounced effect you can repeat the option:</p>
1449
1450<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1451<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001452 <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 +00001453</div>
1454
1455<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>
1456
cristyd934d102009-10-10 12:55:13 +00001457<p>While performing the stretch, black-out at most <em
1458class="arg" >black-point</em> pixels and white-out at most <em
1459class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1460<em class="arg" >black-point %</em> pixels and white-out at most <em
1461class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001462
cristyd934d102009-10-10 12:55:13 +00001463<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1464>-contrast-stretch</a> will black-out at most <em class="arg"
1465>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1466minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1467class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1468>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001469
cristyd934d102009-10-10 12:55:13 +00001470<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1471the image's min and max values are stretched to 0 and <em class="QR"
1472>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1473clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001474>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001475prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001476
cristyd934d102009-10-10 12:55:13 +00001477<p>Internally operator works by creating a histogram bin, and then uses that
1478bin to modify the image. As such some colors may be merged together when they
1479originally fell into the same 'bin'. </p>
1480
1481<p>All the channels are normalized in concert by the came amount so as to
1482preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001483setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001484setting will normalize the RGB channels independently.</p>
1485
1486<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1487normalization of mathematical images. </p>
1488
1489<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001490
1491
1492<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001493 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001494</div>
1495
1496<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>
1497
cristy16ff93c2010-01-13 23:18:07 +00001498<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001499a comma-separated list of integers (with no spaces), ordered left-to right,
1500starting with the top row. Presently, only odd-dimensioned kernels are
1501supported, and therefore the number of entries in the specified <em
1502class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15037<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001504
cristyd934d102009-10-10 12:55:13 +00001505<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
1506positive and negative results are relative to a user-specified bias value.
1507This is important for non-HDRI compilations of ImageMagick when dealing with
1508convolutions that contain negative as well as positive values. This is
1509especially the case with convolutions involving high pass filters or edge
1510detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001511</p>
1512
cristyd934d102009-10-10 12:55:13 +00001513<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
1514negative results without clipping to the color value range (0..QuantumRange).
1515See the discussion on HDRI implementations of ImageMagick on the page <a
1516href="/www/high-dynamic-range.html">High
1517Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1518href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1519<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1520entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001521
cristy3ed852e2009-09-05 21:47:34 +00001522
1523<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001524 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001525</div>
1526
1527<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>
1528
1529<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>
1530
1531<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>
1532
1533<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>
1534
1535<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>
1536
1537<p>By adding a exclamation character flag to the geometry argument, the
1538cropped images virtual canvas page size and offset is set as if the
1539geometry argument was a viewport or window. This means the canvas page size
1540is set to exactly the same size you specified, the image offset set
1541relative top left corner of the region cropped. </p>
1542
1543<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1544special single pixel transparent 'missed' image is returned, and a 'crop
1545missed' warning given. </p>
1546
cristy739df912009-10-24 16:10:18 +00001547<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 +00001548
1549<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001550 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001551</div>
1552
1553<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>
1554
1555<p><em class="arg">Amount</em> defines the number of positions each
1556colormap entry is shifted.</p>
1557
1558
1559<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001560 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001561</div>
1562
1563<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>
1564
1565<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>
1566
1567
1568<p>For example, to log cache and blob events, use.</p>
1569
1570<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1571<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1572
1573<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1574
1575<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1576
1577<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1578
1579<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>
1580
1581
1582<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001583 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001584</div>
1585
1586<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>
1587
1588<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1589
1590<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1591
1592
1593<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001594 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001595</div>
1596
1597<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>
1598
1599<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>
1600
1601<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>
1602
1603<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1604
1605
1606<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001607 <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 +00001608</div>
1609
cristyd0bd44a2010-09-24 12:38:11 +00001610<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 +00001611coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001612
cristyd0bda5e2010-09-21 16:22:45 +00001613<p>This option creates one or more definitions for coders and decoders to use
1614while reading and writing image data. Definitions are generally used to
1615control image file format coder modules, and image processing operations,
1616beyond what is provided by normal means. Defined settings are listed in <a
1617href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1618as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001619
cristyd0bda5e2010-09-21 16:22:45 +00001620<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1621definition of a flag is created with that name. This used to control on/off
1622options. Use <a href="#define">+define key</a> to remove definitions
1623previously created. Use <a href="#define">+define "*"</a> to remove all
1624existing definitions.</p>
1625
cristyd0bd44a2010-09-24 12:38:11 +00001626<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001627href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001628>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 +00001629Properties</a> in the defined value. </p>
1630
cristyefb2bdb2010-11-20 19:35:22 +00001631<p>The <em>option</em> and <em>key</em> are case-independent (they are
1632converted to lowercase for use within the decoders) while the <em>value</em>
1633is case-dependent.</p>
1634
cristyd0bda5e2010-09-21 16:22:45 +00001635<p>Such settings are global in scope, and effect all images and operations. </p>
1636
1637<p>The following definitions are just some of the artifacts that are
1638available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001639
cristydcca3fa2010-12-29 21:50:07 +00001640<dl>
cristy045bd902010-01-30 18:56:24 +00001641<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001642<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001643 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001644
cristy045bd902010-01-30 18:56:24 +00001645<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001646<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001647 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001648
cristy045bd902010-01-30 18:56:24 +00001649<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001650<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001651 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001652
cristy045bd902010-01-30 18:56:24 +00001653<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001654<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1655 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001656 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001657
cristy045bd902010-01-30 18:56:24 +00001658<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001659<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1660 compression factor is the reciprocal of the compression ratio. The valid
1661 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1662 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001663 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001664
cristy3ed852e2009-09-05 21:47:34 +00001665<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001666 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001667
cristy045bd902010-01-30 18:56:24 +00001668<dt>png:bit-depth=<em class="arg">value</em></dt>
1669<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001670<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1671 encoder to use a different bit-depth and color-type than it would have
1672 normally selected, but only if this does not cause any loss of image
1673 quality. Any attempt to reduce image quality is treated as an error and no
1674 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1675 can use these "defines" to cause it to be written as an 8-bit grayscale,
1676 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1677 you cannot force it to be written as a grayscale or indexed PNG. If you
1678 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1679 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1680 reduce the image quality prior to using the PNG encoder. Note that in
1681 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001682 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001683 8-bit depth.</dd>
1684
1685<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1686<dt>png:include-chunk=<em class="arg">value</em></dt>
1687<dd>ancillary chunks to be excluded from or included in PNG output.
1688
1689 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1690 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1691 or the word <em class="arg">all</em> or
1692 the word <em class="arg">none</em>. There must be no spaces in the
1693 list. Although PNG chunk-names are case-dependent, you can use
1694 all lowercase names if you prefer.</p>
1695
1696 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1697 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1698 only be written if gamma is not 1/2.2, since most decoders assume
1699 sRGB and gamma=1/2.2 when no colorspace information is included in
1700 the PNG file. Because the list is processed from left to right, you
1701 can achieve this with a single define:</p>
1702
1703<pre class="text">
1704 -define png:include-chunk=none,gAMA
1705</pre>
1706
1707 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
1708 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any of
1709 these entries appearing in the list will be ignored.</p>
1710
1711 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1712 image has transparency, the PNG colortype is forced to be 4 or 6
1713 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1714 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1715 on the PNG colortype of the output image.</p>
1716
1717 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1718 following for PNG output:</p>
1719
1720<pre class="text">
1721 -define png:include-chunk=none,gama
1722</pre>
1723
1724 <p>The default behavior is to include all known PNG ancillary chunks
1725 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk.</p>
1726 </dd>
cristyd0bda5e2010-09-21 16:22:45 +00001727
cristy3ed852e2009-09-05 21:47:34 +00001728<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001729<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1730 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001731 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001732
cristy045bd902010-01-30 18:56:24 +00001733<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001734<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1735 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1736 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001737 included, the result is a single precision floating point format.
1738 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001739 double precision floating point format.</dd>
1740
cristydcca3fa2010-12-29 21:50:07 +00001741</dl>
cristy3ed852e2009-09-05 21:47:34 +00001742
cristyd0bda5e2010-09-21 16:22:45 +00001743<p>For example, to create a postscript file that will render only the black
1744pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001745
1746<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 +00001747<p>Set attributes of the image registry by prefixing the value with
1748<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1749use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001750
1751<p class="crtsnip">
1752-define registry:temporary-path=/data/tmp
1753</p>
1754
cristyd0bda5e2010-09-21 16:22:45 +00001755
1756
cristy3ed852e2009-09-05 21:47:34 +00001757<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001758 <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 +00001759</div>
1760
1761<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>
1762
1763<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>
1764
1765<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>
1766
1767
1768<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001769 <h4><a id="delete"></a>-delete <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001770</div>
1771
1772<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>
1773
1774<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>
1775
1776
1777<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001778 <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 +00001779</div>
1780
1781<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>
1782
1783<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>
1784
1785<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>
1786
1787<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>
1788
1789<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>
1790
1791<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001792 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001793</div>
1794
1795<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>
1796
1797<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>
1798
1799<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001800 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00001801</div>
1802
1803<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>
1804
1805<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001806 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001807</div>
1808
1809<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>
1810
1811<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>
1812
1813<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001814 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00001815</div>
1816
1817<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>
1818
1819<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001820 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001821</div>
1822
1823<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>
1824
1825<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001826 <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 +00001827</div>
1828
1829<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>
1830
1831<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001832is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001833what part of the 'background' image is seen at each point of the overlaid
1834area. Much like the displacement map is a 'lens' that redirects light shining
1835through it so as to present a distorted view the original 'background' image
1836behind it. </p>
1837
1838<p>Any perfect grey areas of the displacement map produce a zero
1839displacement of the image. Black areas produce the given maximum negative
1840displacement of the lookup point, while white produce a maximum positive
1841displacement of the lookup. </p>
1842
1843<p>Note that it is the lookup of the 'background' that is displaced, not a
1844displacement of the image itself. As such an area of the displacement map
1845containing 'white' will have the lookup point 'shifted' by a positive amount,
1846and thus generating a copy of the destination image to the right/downward from
1847the correct position. That is the image will look like it may have been
1848'shifted' in a negative left/upward direction. Understanding this is a very
1849important in understanding how displacement maps work. </p>
1850
1851<p>The given arguments define the maximum amount of displacement in pixels
1852that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001853it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001854outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001855easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001856into the overlay area. </p>
1857
1858<p>The '%' flag makes the displacement scale relative to the size of the
1859overlay image (100% = half width/height of image). Using '!' switches
1860percentage arguments to refer to the destination image size instead.
1861these flags were added as of IM v6.5.3-5.</p>
1862
1863<p>Normally a single grayscale displacement map is provided, which with the
1864given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001865displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001866specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001867the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001868displacement, while the <em class="arg">mask image</em> is used for vertical Y
1869displacement. This allows you to define completely different displacement
1870values for the X and Y directions, and allowing you to lookup any point within
1871the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001872any other nearby pixel, producing complex 2 dimensional displacements, rather
1873than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001874
cristyd0bda5e2010-09-21 16:22:45 +00001875<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001876you can use the 'red' channel of the overlay image to specify the horizontal
1877or X displacement, and the 'green' channel for the vertical or Y displacement.
1878</p>
1879
cristyd0bd44a2010-09-24 12:38:11 +00001880<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 +00001881mask the transparency of the destination image. However areas outside the
1882overlaid areas will not be effected. </p>
1883
1884
1885<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001886 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001887</div>
1888
1889<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>
1890
1891<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1892
1893<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001894 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001895</div>
1896
1897<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>
1898
1899<p>The layer disposal method defines the way each the displayed image is to be
1900modified after the current 'frame' of an animation has finished being
1901displayed (after its 'delay' period), but before the next frame on an
1902animation is to be overlaid onto the display. </p>
1903
1904<p>Here are the valid methods:</p>
1905
1906<pre class="text">
1907Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
1908None 1 Do not dispose, just overlay next frame image.
1909Background 2 Clear the frame area with the background color.
1910Previous 3 Clear to the image prior to this frames overlay.
1911</pre>
1912
1913<p>You can also use the numbers given above, which is what the GIF format
1914uses internally to represent the above settings. </p>
1915
cristyd0bda5e2010-09-21 16:22:45 +00001916<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00001917
1918<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
1919resetting the layer disposal methods of images being read in. </p>
1920
1921<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
1922disposal method for images already in memory.</p>
1923
1924<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001925 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001926</div>
1927
1928<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>
1929
1930
1931<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001932 <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 +00001933</div>
1934
1935<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>
1936
1937<p>The opacity of the composite image is multiplied by the given percent, then
1938it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00001939is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00001940transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
1941are given, each image are dissolved to the percentages given. </p>
1942
1943<p>Note that dissolve percentages do not add, two opaque images dissolved
1944'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
1945images, you would need to use dissolve values of '50,100'. </p>
1946
1947<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001948 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001949</div>
1950
1951<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>
1952
1953<p>The <em class="arg">arguments</em> is a single string containing a list
1954of floating point numbers separated by commas or spaces. The number of
1955and meaning of the floating point values depends on the distortion <em
1956class="arg">method</em> being used. </p>
1957
1958<p>Choose from these distortion types:</p>
1959
1960<table class="doc">
1961 <tr valign="top">
1962 <th align="left" style="width: 8%">Method</th>
1963 <th align="left">Description</th>
1964 </tr>
1965
1966 <tr valign="top">
1967 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
1968 <br/>or &nbsp; <kbd>SRT</kbd></td>
1969 <td valign="top">
1970 Distort image by first scaling and rotating about a given 'center',
1971 before translating that 'center' to the new location, in that order. It
1972 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
1973 distortion, but without shearing effects. It also provides a good way
1974 of rotating and displacing a smaller image for tiling onto a larger
1975 background (IE 2-dimensional animations). <br/>
1976
1977 The number of arguments determine the specific meaning of each
1978 argument for the scales, rotation, and translation operations. <br/>
1979
1980 <table style="margin-left:auto; margin-right:auto;">
1981 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
1982 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
1983 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00001984 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00001985 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
1986 <tr><td>5:</td>
1987 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
1988 <tr><td>6:</td>
1989 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
1990 <tr><td>7:</td>
1991 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
1992 &nbsp; NewX,NewY</em></td></tr>
1993 </table>
1994
cristyd0bda5e2010-09-21 16:22:45 +00001995 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00001996 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
1997
1998 <tr valign="top">
1999 <td valign="top"><kbd>Affine</kbd></td>
2000 <td valign="top">
2001 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002002 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002003 point values are given allowing the image to be linearly scaled,
2004 rotated, sheared, and translated, according to those three points. See
2005 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2006 distortions. <br/>
2007
2008 More than 3 sets given control point pairs (12 numbers) is least
2009 squares fitted to best match a lineary affine distortion. If only 2
2010 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002011 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002012 flipping or changes in aspect ratio to the resulting image. If only one
2013 control point pair is provides the image is only translated, (which may
2014 be a floating point non-integer translation). <br/>
2015
2016 This distortion does not include any form of perspective distortion.
2017 </td>
2018
2019 </tr>
2020
2021 <tr valign="top">
2022 <td valign="top"><kbd>AffineProjection</kbd></td>
2023 <td valign="top">
2024 Linearly distort an image using the given Affine Matrix of 6
2025 pre-calculated coefficients forming a set of Affine Equations to map
2026 the source image to the destination image.
2027
2028 <div style="text-align: center"><em>
2029 s<sub>x</sub>, r<sub>x</sub>,
2030 r<sub>y</sub>, s<sub>y</sub>,
2031 t<sub>x</sub>, t<sub>y</sub>
2032 </em></div>
2033
2034 See <a href="#affine" >-affine</a> setting for more detail, and
2035 meanings of these coefficients. <br/>
2036
2037 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002038 alternative methods of defining this distortion, with ImageMagick doing
2039 the calculations needed to generate the required coefficients. You can
2040 see the internally generated coefficients, by using a <a
2041 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002042
2043 </tr>
2044
cristy3ed852e2009-09-05 21:47:34 +00002045 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002046 <td valign="top"><kbd>BilinearForward</kbd><br/>
2047 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002048 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002049 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2050 16 values (see below). Not that lines may not appear straight after
2051 distortion, though the distance between coordinates will remain
2052 consistent. <br/>
2053
2054 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2055 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2056 quadrilateral to a rectangle, while preserving the straigth line edges
2057 in each case. <br/>
2058
2059 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2060 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2061 color setting. Also if the quadraterial becomes 'flipped' the image
2062 may dissappear. <br/>
2063
2064 There are future plans to produce a true Bilinear distortion that will
2065 attempt to map any quadrilateral to any other quadrilateral, while
2066 preserving edges (and edge distance ratios).
2067
2068 </td>
cristy3ed852e2009-09-05 21:47:34 +00002069 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002070
2071 <tr valign="top">
2072 <td valign="top"><kbd>Perspective</kbd></td>
2073 <td valign="top">
2074 Perspective distort the images, using a list of 4 or more sets of
2075 control points (as defined below). More that 4 sets (16 numbers) of
2076 control points provide least squares fitting for more accurate
2077 distortions (for the purposes of image registration and panarama
2078 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2079 linear distortion. <br/>
2080
2081 Perspective Distorted images ensures that straight lines remain
2082 straight, but the scale of the distorted image will vary. The horizon
2083 is anti-aliased, and the 'sky' color may be set using the
2084 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2085 </tr>
2086
2087 <tr valign="top">
2088 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2089 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002090 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002091 pre-calculated coefficients. You can get these coefficients by looking
2092 at the <a href="#verbose" >-verbose</a> output of a
2093 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2094 If the last two perspective scaling coefficients are zero, the
2095 remaining 6 represents a transposed 'Affine Matrix'. </td>
2096
2097 </tr>
2098
2099 <tr valign="top">
2100 <td valign="top"><kbd>Arc</kbd></td>
2101 <td valign="top">
2102 Arc the image (variation of polar mapping) over the angle given around
2103 a circle. <br/>
2104 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2105 <tr valign="top"><td>Argument</td>
2106 <td>Meaning</td></tr>
2107 <tr valign="top"><td><em>arc_angle</em></td>
2108 <td>The angle over which to arc the image side-to-side</td></tr>
2109 <tr valign="top"><td><em>rotate_angle</em></td>
2110 <td>Angle to rotate resulting image from vertical center</td></tr>
2111 <tr valign="top"><td><em>top_radius</em></td>
2112 <td>Set top edge of source image at this radius</td></tr>
2113 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2114 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2115 </table>
2116
2117 The resulting image is always resized to best fit the resulting image,
2118 (as if using <a href="#distort" >+distort</a>) while attempting to
2119 preserve scale and aspect ratio of the original image as much as
2120 possible with the arguments given by the user. All four arguments will
2121 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2122
2123 This a variation of a polar distortion designed to try to preserve the
2124 aspect ratio of the image rather than direct Cartesian to Polar
2125 conversion. </td>
2126 </tr>
2127
2128 <tr valign="top">
2129 <td valign="top"><kbd>Polar</kbd></td>
2130 <td valign="top">
2131 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2132 the image. that is the height of the input image is mapped to the
2133 radius limits, while the width is wrapped around between the
2134 angle limits. <br/>
2135
2136 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2137
2138 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2139 center to the center of the image, and the angles going from -180 (top)
2140 to +180 (top). If <em>Rmax</em> is given the special value of
2141 '<code>0</code>', the the distance from the center to the nearest edge
2142 is used for the radius of the output image, which will ensure the whole
2143 image is visible (though scaled smaller). However a special value of
2144 '<code>-1</code>' will use the distance from the center to the furthest
2145 corner, This may 'clip' the corners from the input rectangular image,
2146 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2147 the same arguments. <br/>
2148
2149 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2150 output image center will default to <code>0,0</code> of the virtual
2151 canvas, and the image size adjusted to ensure the whole input image is
2152 made visible in the output image on the virtual canvas. </td>
2153
2154 </tr>
2155
2156 <tr valign="top">
2157 <td valign="top"><kbd>DePolar</kbd></td>
2158 <td valign="top">
2159 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2160 but generates the reverse Polar to Cartesian distortion. <br/>
2161
2162 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2163 the corners of the input image. However using the special
2164 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2165 distance) will ensure the whole distorted image is preserved in the
2166 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2167 reverse the distortion re-producing the original.
2168
2169 Note that as this distortion requires the area resampling of a circular
2170 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002171 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002172 form of 'super-sampling' image processing technique be used to produce
2173 a high quality result. </td>
2174
2175 </tr>
2176
2177 <tr valign="top">
2178 <td valign="top"><kbd>Barrel</kbd></td>
2179 <td valign="top">
2180 Given the four coefficients (A,B,C,D) as defined by <a
2181 href="http://www.all-in-one.ee/~dersch/barrel/barrel.html" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002182 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002183 correct radial lens distortions. That is in photographs, make straight
2184 lines straight again. <br/>
2185
2186 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2187 <em>X</em> , <em>Y</em> ] ] <br/>
2188 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2189 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2190 [ <em>X</em> , <em>Y</em> ] <br/>
2191 So that it forms the function <br/>
2192 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2193 <em>C</em>*r + <em>D</em> )<br/>
2194
2195 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2196 (defaulting to the center of the image). <br/>
2197 The second form is typically used to distort images, rather than
2198 correct lens distortions. <br/>
2199 </td>
2200
2201 </tr>
2202
2203 <tr valign="top">
2204 <td valign="top"><kbd>BarrelInverse</kbd></td>
2205 <td valign="top">
2206 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2207 arguments, and argument handling. However it uses the inverse
2208 of the radial polynomial,
2209 so that it forms the function <br/>
2210 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002211 <em>C</em>*r + <em>D</em> )<br/>
2212 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2213 distortion, just a different barrel-like radial distortion method.
2214
cristy3ed852e2009-09-05 21:47:34 +00002215 </td>
2216 </tr>
2217
2218 <tr valign="top">
2219 <td valign="top"><kbd>Shepards</kbd></td>
2220 <td valign="top">
2221 Distort the given list control points (any number) using an Inverse
2222 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002223 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2224 Method</a>). The control points in effect do 'localized' displacement
2225 of the image around the given control point (preserving the look and
2226 the rotation of the area near the control points. For best results
2227 extra control points should be added to 'lock' the positions of the
2228 corners, edges and other unchanging parts of the image, to prevent
2229 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002230
cristyd0bd44a2010-09-24 12:38:11 +00002231 The distortion has been likened to 'taffy pulling' using nails, or
2232 pins' stuck in a block of 'jelly' which is then moved to the new
2233 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002234
cristyd0bd44a2010-09-24 12:38:11 +00002235 Internally it is equivelent to generating a displacement map (see <a
2236 href="#displace" >-displace</a>) for source image color look-up using
2237 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2238
2239 </td>
cristy3ed852e2009-09-05 21:47:34 +00002240 </tr>
2241
2242</table>
2243
cristyd0bd44a2010-09-24 12:38:11 +00002244<p>To print a complete list of distortion methods, use <a href="#list">-list
2245distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002246
2247<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2248'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2249defining how these points in the given image should be distorted in the
2250destination image. Each set of four floating point values represent a source
2251image coordinate, followed immediately by the destination image coordinate.
2252This produces a list of values such as...</p>
2253<div style="text-align: center"><em>
2254 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2255 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2256 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2257 ... &nbsp;
2258 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2259</em></div>
2260<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2261destination image. </p>
2262
2263<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2264needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2265perspective distortion of the built-in "rose:" image. Note how spaces were
2266used to group the 4 sets of coordinate pairs, to make it easier to read and
2267understand.</p>
2268
2269<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002270convert rose: -virtual-pixel black \<br/>
2271 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2272 rose_3d_rotated.gif</span></p>
2273<p>If more that the required number of coordinate pairs are given for
2274a distortion, the distortion method is 'least squares' fitted to produce the
2275best result for all the coordinate pairs given. If less than the ideal number
2276of points are given, the distort will generally fall back to a simpler form of
2277distortion that can handles the smaller number of coordinates (usally a linear
2278'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002279
cristyd0bda5e2010-09-21 16:22:45 +00002280<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002281find matching coordinate pairs in overlapping images, so as to improve the
2282'fit' of the distortion. Of course a bad coordinate pair can also make the
2283'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002284
2285<p>Colors are acquired from the source image according to the <a
2286href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002287magnified. However if the viewed image is minified (image becomes smaller),
2288a special area resampling function (added ImageMagick v6.3.5-9), is used to
2289produce a higher quality image. For example you can use
2290a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2291the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002292
cristyd0bd44a2010-09-24 12:38:11 +00002293<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2294convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2295 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2296 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002297<p>Note that a infinitely tiled perspective images involving the horizon can
2298be very slow to generate due to the use of the high quality 'area resampling'
2299function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2300using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2301(recommended if you plan to use super-sampling instead). </p>
2302
2303<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2304'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2305will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2306pixels. If you do not what these pixels to be visible, set the color to match
2307the rest of the ground. </p>
2308
2309<p>The output image size will by default be the same as the input image. This
2310means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002311the 'distorted space', those parts is clipped and lost. However if you use
2312the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2313will attempt (if possible) to show the whole of the distorted image, while
2314retaining a correct 'virtual canvas' offset, for image layering. This offset
2315may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2316is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002317
2318<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2319option:distort:viewport {geometry_string}</kbd>" setting which will specify
2320the size and the offset of the generated 'viewport' image of the distorted
2321image space.</p>
2322
2323<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2324{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2325that factor without changing the viewed contents of the distorted image. This
2326can be used either for 'super-sampling' the image for a higher quality result,
2327or for panning and zooming around the image (with appropriate viewport
2328changes, or post-distort cropping and resizing). </p>
2329
2330<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2331href="#distort" >-distort</a> to attempt to output the internal coefficients,
2332and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2333and debugging purposes. This many not be available for all distorts. </p>
2334
2335<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2336produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2337and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002338above settings. It is algorithmically slower however, though that may not be
2339the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002340
2341
2342<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002343 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002344</div>
2345
2346<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>
2347
cristyd0bda5e2010-09-21 16:22:45 +00002348<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 +00002349
2350<p>Dithering is turned on by default, to turn it off use the plus form of the
2351setting, <a href="#dither">+dither</a>. This will also also render PostScript
2352without text or graphic aliasing. Disabling dithering often (but not always)
2353leads to faster process, a smaller number of colors, but more cartoon like
2354image coloring. Generally resulting in 'color banding' effects in areas with
2355color gradients. </p>
2356
2357<p>The color reduction operators <a href="#colors">-colors</a>, <a
2358href="#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>
2359
2360<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>
2361
2362
2363<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002364 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002365</div>
2366
2367<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>
2368
2369<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>
2370
2371<p>The shape primitives:</p>
2372
2373<pre class="text">
2374 point x,y
2375 line x0,y0 x1,y1
2376 rectangle x0,y0 x1,y1
2377 roundRectangle x0,y0 x1,y1 wc,hc
2378 arc x0,y0 x1,y1 a0,a1
2379 ellipse x0,y0 rx,ry a0,a1
2380 circle x0,y0 x1,y1
2381 polyline x0,y0 ... xn,yn
2382 polygon x0,y0 ... xn,yn
2383 bezier x0,y0 ... xn,yn
2384 path path specification
2385 image operator x0,y0 w,h filename
2386</pre>
2387
2388<p>The text primitive:</p>
2389
2390<pre class="text">
2391 text x0,y0 string
2392</pre>
2393<p>The text gravity primitive:</p>
2394
2395<pre class="text">
2396 gravity NorthWest, North, NorthEast, West, Center,
2397 East, SouthWest, South, or SouthEast
2398</pre>
2399
2400<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>
2401
2402<p>The transformation primitives:</p>
2403
2404<pre class="text">
2405 rotate degrees
2406 translate dx,dy
2407 scale sx,sy
2408 skewX degrees
2409 skewY degrees
2410</pre>
2411
2412<p>The pixel operation primitives:</p>
2413
2414<pre class="text">
2415 color x0,y0 method
2416 matte x0,y0 method
2417</pre>
2418
2419<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>
2420
2421<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>
2422
2423<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2424
2425<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2426
2427<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>
2428
2429<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2430
2431<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>
2432
2433<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>
2434
2435<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>.
2436</p>
2437
2438<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2439
2440<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2441
2442<p class="crtsnip">
2443 -draw 'circle 100,100 150,150'
2444</p>
2445
2446<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
2447draw 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>
2448
2449<p class="crtsnip">
2450 -draw 'bezier 20,50 45,100 45,0 70,50'
2451</p>
2452<p class="crtsnip">
2453 -draw 'bezier 70,50 95,100 95,0 120,50'
2454</p>
2455
2456
2457<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>
2458
2459<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>
2460
2461<p class="crtsnip">
2462 -draw 'image SrcOver 100,100 225,225 image.jpg'
2463</p>
2464
cristybc9539a2010-08-16 18:06:20 +00002465<p>You can use 0,0 for the image size, which means to use the actual
2466dimensions found in the image header. Otherwise, it is scaled to the given
2467dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
2468a detailed discussion of alpha composition methods that are available. </p>
cristy3ed852e2009-09-05 21:47:34 +00002469
2470<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>
2471
2472<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2473
2474<p class="crtsnip">
2475 -draw 'text 100,100 "Works like magick!"'
2476</p>
2477
2478<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2479
2480<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>
2481
2482<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2483
2484<p>The <kbd>scale</kbd> primitive scales them.</p>
2485
2486<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>
2487
2488<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
2489matrix.</p>
2490
2491<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>
2492
2493<pre class="text">
2494 point
2495 replace
2496 floodfill
2497 filltoborder
2498 reset
2499</pre>
2500
2501<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>
2502
2503<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>
2504
2505<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>
2506
2507<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2508
2509<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2510
2511
2512<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002513 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002514</div>
2515
2516<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>
2517
2518<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002519 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002520</div>
2521
2522<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>
2523
2524<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002525 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002526</div>
2527
2528<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>
2529
2530<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2531
2532<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2533
cristyd0bda5e2010-09-21 16:22:45 +00002534
2535
cristy3ed852e2009-09-05 21:47:34 +00002536<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002537 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002538</div>
2539
2540<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>
2541
2542<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>
2543
2544<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002545 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002546</div>
2547
2548<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>
2549
2550<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2551
2552<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2553
2554
2555<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002556 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002557</div>
2558
2559<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>
2560
2561
2562<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002563 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002564</div>
2565
2566<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>perform histogram equalization on the image channel-by-channel.</td><td style='text-align:right;'></td></tr></table>
2567
2568<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>
2569
2570<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2571
2572<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>
2573
2574<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002575 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002576</div>
2577
2578<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>
2579
2580<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>
2581
2582<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>
2583
2584<table class="doc">
2585 <col width="25%" />
2586 <col width="75%" />
2587 <thead>
2588 <tr>
2589 <th><em class="arg">operator</em></th>
2590 <th>Summary (see further below for details)</th>
2591 </tr>
2592 </thead>
2593 <tbody>
2594
cristy3c98a4f2010-08-13 20:09:41 +00002595 <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 +00002596 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2597 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2598 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2599 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2600 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002601 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2602 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002603 <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>
2604 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2605 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002606 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002607 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002608 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2609 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2610 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2611 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2612 <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>
2613 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2614 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2615 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2616 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2617
2618 <tr><td>&nbsp;</td></tr>
2619
2620 <tr><td>Gaussian-noise</td></tr>
2621 <tr><td>Impulse-noise</td></tr>
2622 <tr><td>Laplacian-noise</td></tr>
2623 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2624 <tr><td>PoissonNoise</td></tr>
2625 <tr><td>Uniform-noise</td></tr>
2626
2627 <tr><td>&nbsp;</td></tr>
2628
2629 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2630 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2631 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2632 </tbody>
2633 </table>
2634
2635<p>The specified functions are applied only to each previously set <a
2636href="#channel" >-channel</a> in the image. If necessary, the results of the
2637calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2638class="QR">QuantumRange</em>]. The transparency channel of the image is
2639represented as a 'alpha' values (0 = fully transparent), so, for example, a
2640<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2641semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2642as a percentage of the <em class="QR">QuantumRange</em>.</p>
2643
2644<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2645<a href="#list">-list evaluate</a>.</p>
2646
2647<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2648<kbd>Multiply</kbd> methods can also be achieved using either the <a
2649href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2650appropriate argument, to linearly modify the overall range of color values.
2651Please note, however, that <a href="#level" >-level</a> treats transparency as
2652'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2653'alpha' values.</p>
2654
2655<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>
2656
cristyce66ab12010-10-21 23:36:32 +00002657<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>
2658
2659 <div style="text-align:center;">
2660 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2661 </div>
2662
2663<p> If the input image is squared, for example, using <a
2664href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2665
cristy3ed852e2009-09-05 21:47:34 +00002666<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>
2667
2668 <div style="text-align:center;">
2669 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2670 </div>
2671
2672<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2673normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2674href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2675to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2676with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2677with <kbd>Pow</kbd>.</p>
2678
2679<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2680converts the image values into a value according to a (co)sine wave function.
2681The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2682is biased 50% and normalized by 50% so as to fit in the respective color value
2683range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2684function (its frequency), and thus determines the number of 'waves' that will
2685be generated over the input color range. For example, if the <em
2686class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2687class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2688then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002689class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002690
2691 <div style="text-align:center;">
2692 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2693 </div>
2694
cristydcca3fa2010-12-29 21:50:07 +00002695<p>See also the <a href="#function" >-function</a> operator, which is a
2696multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002697
cristy63fed272010-03-07 19:08:45 +00002698<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002699 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002700</div>
2701
2702<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 +00002703
2704<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002705 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002706</div>
2707
2708<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>
2709
cristy3e2860c2010-01-24 01:36:30 +00002710<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 +00002711<p>This command reduces or expands a JPEG image to fit on an 800x600
2712display. If the aspect ratio of the input image isn't exactly 4:3, then the
2713image is centered on an 800x600 black canvas: </p>
2714
2715<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>
2716
cristy3ed852e2009-09-05 21:47:34 +00002717
2718<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>
2719
2720<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002721 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002722</div>
2723
2724<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>
2725
2726<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2727
cristy4949d522010-03-12 18:41:34 +00002728<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 +00002729
cristy4949d522010-03-12 18:41:34 +00002730<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 +00002731<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002732equivalent to:</p>
2733
2734<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>
2735<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>
2736
2737<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002738 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002739</div>
2740
2741<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>
2742
2743<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).
2744</p>
2745
2746<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>.
2747</p>
2748
2749<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002750 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002751</div>
2752
2753<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>
2754
2755<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002756 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002757</div>
2758
2759<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>
2760
cristydcca3fa2010-12-29 21:50:07 +00002761<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 +00002762
cristydcca3fa2010-12-29 21:50:07 +00002763<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 +00002764
2765<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>
2766
2767<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2768<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>
2769
2770<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2771<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>
2772
cristyd0bd44a2010-09-24 12:38:11 +00002773<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 +00002774
2775<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>
2776
2777<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2778 -evaluate log 1000 fft_image_spectrum.png</span></p>
2779<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>
2780
cristydcca3fa2010-12-29 21:50:07 +00002781<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 +00002782
2783<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>
2784
2785<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>
2786
cristydcca3fa2010-12-29 21:50:07 +00002787<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 +00002788
2789<p>See the discussion on HDRI implementations of ImageMagick on the page
2790<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.
2791</p>
2792
2793
2794<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002795 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002796</div>
2797
2798<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>color to use when filling a graphic primitive.</td><td style='text-align:right;'></td></tr></table>
2799
2800<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>
2801
2802<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2803
2804<p>For example,</p>
2805
2806<p class="crtsnip">
2807 -fill blue
2808</p>
2809<p class="crtsnip">
2810 -fill "#ddddff"
2811</p>
2812<p class="crtsnip">
2813 -fill "rgb(255,255,255)"
2814</p>
2815
2816<p>See <a href="#draw">-draw</a> for further details.</p>
2817
2818<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2819
2820<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002821 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002822</div>
2823
cristyd0bda5e2010-09-21 16:22:45 +00002824<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
2825distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002826
cristyd0bda5e2010-09-21 16:22:45 +00002827<p>Use this option to affect the resizing operation of an image during
2828operations such as <a href="#resize">-resize</a> and <a href="#distort"
2829>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002830
2831<pre class="text">
2832 Point Hermite Cubic
2833 Box Gaussian Catrom
2834 Triangle Quadratic Mitchell
2835</pre>
2836
cristyd0bda5e2010-09-21 16:22:45 +00002837<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002838as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2839generally useless on their own as they are infinite filters that are being
2840clipped to the filters support size. Their direct use is not recommended
2841except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002842
cristydcca3fa2010-12-29 21:50:07 +00002843<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002844function that the <a href="#filter" >-filter</a> setting defines. That is
2845using these functions will define a 'Windowed' filter, appropriate to the
2846operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002847
2848<pre class="text">
2849 Lanczos Hamming Parzen
2850 Blackman Kaiser Welsh
2851 Hanning Bartlett Bohman
2852</pre>
2853
2854<p>Also one special self-windowing filter is also provided
2855<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2856on the current 'support' or 'lobes' expert settings (see below).</p>
2857
cristyd0bda5e2010-09-21 16:22:45 +00002858<p>If you do not select a filter with this option, the filter defaults to
2859<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2860if the image is enlarged. Otherwise the filter default to
2861<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002862
cristyd0bda5e2010-09-21 16:22:45 +00002863<p>To print a complete list of resize filters, use the <a href="#list">-list
2864filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002865
2866<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002867use of these expert settings (see also <a href="#define" >-define</a> and <a
2868href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002869
2870<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002871<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002872<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002873 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2874 Gaussian-like filters simple filters, or you may not get the expected
2875 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002876
cristyd0bda5e2010-09-21 16:22:45 +00002877<dt>-define filter:support=<em>radius</em></dt>
2878<dd>Set the filter support radius. Defines how large the filter should be and
2879 thus directly defines how slow the filtered resampling process is. All
2880 filters have a default 'prefered' support size. Some filters like
2881 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2882 this value. With simple filters this value either does nothing (but slow
2883 the resampling), or will clip the filter function in a detrimental way.
2884 </dd>
cristy3ed852e2009-09-05 21:47:34 +00002885
cristyd0bda5e2010-09-21 16:22:45 +00002886<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002887<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00002888 alternative way of specifying the 'support' range of the filter, that is
2889 designed to be more suited to windowed filters, especially when used for
2890 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002891
cristyd0bda5e2010-09-21 16:22:45 +00002892<dt>-define filter:b=<em>b-spline_factor</em></dt>
2893<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002894<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2895 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2896 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2897 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00002898 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00002899 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002900
cristyd0bda5e2010-09-21 16:22:45 +00002901<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002902<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00002903 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00002904 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00002905 'Bessel' functions. If defined, no windowing function is used, unless the
2906 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002907
cristyd0bda5e2010-09-21 16:22:45 +00002908<dt>-define filter:window=<em>filter_function</em></dt>
2909<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
2910 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
2911 support range) with the given filter. This allows you to specify a filter
2912 function that is not normally used as a windowing function, such as
2913 <kbd>Box</kbd>, (which effectively turns off the windowing function),
2914 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
2915 </dd>
2916
2917<dt>-define filter:verbose=<em>1</em></dt>
2918<dd>This causes IM to print information on the final internal filter
2919 selection to standard output. This includes a commented header on the
2920 filter settings being used, and data allowing the filter weights to be
2921 easily graphed. </dd>
2922
2923<dd>Note however that some filters are internally defined in terms of other
2924 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
2925 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
2926 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
2927 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002928
2929</dl>
2930
cristyd0bda5e2010-09-21 16:22:45 +00002931<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00002932
2933<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
2934 -set filter:window=bessel -set filter:lobes=8 \ <br/>
2935 -resize 150% image.jpg</span></p>
2936<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
2937
2938<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
2939 -resize 150% image.jpg</span></p>
2940<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00002941filters, and 'verbose' for viewing the internal filter selection), are
2942provided for image processing experts who have studied and understood how
2943resize filters work. Without this knowledge, and an understanding of the
2944definition of the actual filters involved, using expert settings are more
2945likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00002946
2947
2948<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002949 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00002950</div>
2951
2952<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>
2953
2954
2955<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002956 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00002957</div>
2958
2959<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>create a <em>mirror image</em>.</td><td style='text-align:right;'></td></tr></table>
2960
2961<p>reflect the scanlines in the vertical direction.</p>
2962
2963<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002964 <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 +00002965</div>
2966
2967<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>
2968
2969<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002970 <h4><a id="flop"></a>-flop</h4>
cristy3ed852e2009-09-05 21:47:34 +00002971</div>
2972
2973<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>
2974
2975<p>reflect the scanlines in the horizontal direction.</p>
2976
2977
2978<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002979 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002980</div>
2981
2982<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>
2983
2984<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>
2985
2986<p>In addition to the fonts specified by the above pre-defined list, you can
2987also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
2988is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
2989<kbd>x:fixed</kbd> is X11 font.</p>
2990
2991<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>
2992
2993
2994<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002995 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002996</div>
2997
2998<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>
2999
3000<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3001
3002<p>The default foreground color is black.</p>
3003
3004<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003005 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003006</div>
3007
3008<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>
3009
3010<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>
3011
3012<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>
3013
3014<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003015 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003016</div>
3017
3018<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>
3019
3020<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>
3021
3022<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003023 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003024</div>
3025
3026<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Surround the image with a border or beveled frame.</td><td style='text-align:right;'></td></tr></table>
3027
cristybc9539a2010-08-16 18:06:20 +00003028<p>The color of the border is specified with the <a href="#mattecolor"
3029>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003030
cristybc9539a2010-08-16 18:06:20 +00003031<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
3032class="arg">geometry</em> argument indicates the amount of extra width and
3033height that is added to the dimensions of the image. If no offsets are given
3034in the <em class="arg">geometry</em> argument, then the border added is
3035a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3036the width and height of the border is partitioned to form an outer bevel of
3037thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3038<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3039</p>
3040
3041<p>The <a href="#frame">-frame</a> option is affected by the current <a
3042href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003043'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003044size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3045draws the frame of four distinct colors close to the current <a
3046href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3047center of this image. This means that with the default compose method of
3048'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3049href="#bordercolor">-bordercolor</a> setting.</p>
3050
3051<p>The image composition is not
3052affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003053
3054
3055<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003056 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003057</div>
3058
3059<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>
3060
3061<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003062 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003063</div>
3064
3065<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>
3066
3067<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>
3068
3069<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>
3070
3071<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>
3072
3073<pre class="text">
3074 Polynomial
3075 Sinusoid
3076 Arcsin
3077 Arctan
3078</pre>
3079
3080<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3081
3082<dl class="doc">
3083<dt><kbd>Polynomial</kbd></dt>
3084<dd>
3085<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>
3086
3087<div style="text-align: center">
3088 -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>
3089</div>
3090
3091<p>will invoke a polynomial function given by</p>
3092
3093<div style="text-align: center">
3094 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3095 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3096 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3097</div>
3098
3099<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3100
3101<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>
3102
3103<table class="doc">
3104 <col width="35%" />
3105 <col width="35%" />
3106 <col width="30%" />
3107 <tr>
3108 <td>-evaluate Set <em class="arg">value</em> </td>
3109 <td>-function Polynomial <em class="arg">value</em></td>
3110 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3111 </tr>
3112 <tr>
3113 <td>-evaluate Add <em class="arg">value</em> </td>
3114 <td>-function Polynomial 1,<em class="arg">value</em></td>
3115 </tr>
3116 <tr>
3117 <td>-evaluate Subtract <em class="arg">value</em> </td>
3118 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3119 </tr>
3120 <tr>
3121 <td>-evaluate Multiply <em class="arg">value</em> </td>
3122 <td>-function Polynomial <em class="arg">value</em>,0</td>
3123 </tr>
3124 <tr>
3125 <td>+level black% x white%</td>
3126 <td>-function Polynomial A,B</td>
3127 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3128 </tr>
3129</table>
3130
3131<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>
3132</dd>
3133
3134<dt><kbd>Sinusoid</kbd></dt>
3135<dd>
3136<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>
3137
3138<div style="text-align: center">
3139 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3140</div>
3141
3142<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>
3143
3144<div style="text-align: center">
3145<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>
3146</div>
3147
3148<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>
3149
3150<p class="crtsnip">
3151 -function Sinusoid 3,-90,.2,.7
3152</p>
3153
3154<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>
3155
3156<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>
3157
3158<table class="doc">
3159 <tr>
3160 <td>-evaluate Sin <em class="arg">freq</em> </td>
3161 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3162 </tr>
3163 <tr>
3164 <td>-evaluate Cos <em class="arg">freq</em> </td>
3165 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3166 </tr>
3167</table>
3168</dd>
3169
3170<dt><kbd>ArcSin</kbd></dt>
3171<dd>
3172<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3173and can be used to generate cylindrical distortion and displacement maps.
3174The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003175of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003176
cristydcca3fa2010-12-29 21:50:07 +00003177<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003178 -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 +00003179</p>
cristy3ed852e2009-09-05 21:47:34 +00003180
3181<p>with all values given in terms of noramlize color values (0.0 for black,
31821.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3183for bout input (<em class="arg">width</em>), and output (<em
3184class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3185
cristydcca3fa2010-12-29 21:50:07 +00003186<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003187<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 +00003188</p>
cristy3ed852e2009-09-05 21:47:34 +00003189
3190</dd>
3191
3192<dt><kbd>ArcTan</kbd></dt>
3193<dd>
3194<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3195limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003196All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003197
cristydcca3fa2010-12-29 21:50:07 +00003198<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003199 -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 +00003200</p>
cristy3ed852e2009-09-05 21:47:34 +00003201
3202<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3203</p>
3204
cristydcca3fa2010-12-29 21:50:07 +00003205<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003206<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 +00003207</p>
cristy3ed852e2009-09-05 21:47:34 +00003208
3209</dd>
3210
3211</dl>
3212
3213
3214<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003215 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003216</div>
3217
3218<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>
3219
3220<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>
3221
3222<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>
3223
3224
3225<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003226 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003227</div>
3228
3229<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>
3230
3231<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>
3232
3233<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3234
3235
3236<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003237 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003238</div>
3239
3240<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>
3241
3242<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>
3243
3244<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>
3245
3246<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>
3247
3248<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>
3249
3250<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3251
3252<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003253 <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 +00003254</div>
3255
3256<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>
3257
cristyb15553d2010-07-03 22:53:14 +00003258<p>Convolve the image with a Gaussian or normal distribution using the given
3259<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003260
3261<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3262</div>
3263
cristyb15553d2010-07-03 22:53:14 +00003264<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003265determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003266
3267<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003268array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003269integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003270radius that will provide meaningful results for the Gaussian distribution.
3271</p>
3272
3273<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3274operation is. However too small a <em class="arg" >Radius</em>, and sever
3275aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3276should be at least twice the <em class="arg" >Sigma</em> value, though three
3277times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003278
3279<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003280full 2-dimensional convolution is used to generate the weighted average of the
3281neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003282
3283<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3284pixels which are outside the image proper are blurred into the final result.
3285</p>
3286
3287
3288<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003289 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003290</div>
3291
3292<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the preferred size and location of the image.</td><td style='text-align:right;'></td></tr></table>
3293
3294<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>
3295
3296<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003297 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003298</div>
3299
3300<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>
3301
3302<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3303<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3304<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3305list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3306installation.</p>
3307
3308<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>
3309
3310<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>
3311
3312<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>
3313
cristy4949d522010-03-12 18:41:34 +00003314<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 +00003315<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>
3316
3317<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>
3318
3319
3320<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003321 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003322</div>
3323
3324<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>
3325
3326
3327<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003328 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003329</div>
3330
3331<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>apply a Hald color lookup table to the image.</td><td style='text-align:right;'></td></tr></table>
3332
3333<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3334dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3335can apply any color transformation to the Hald image and then use this option
3336to apply the transform to the image. </p>
3337
3338<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3339<p>This option provides a convenient method for you to use Gimp or Photoshop
3340to make color corrections to the Hald CLUT image and subsequently apply them
3341to multiple images using an ImageMagick script. </p>
3342
3343<p>Note that the representation is only of the normal RGB color space and that
3344the whole color value triplet is used for the interpolated lookup of the
3345represented Hald color cube image. Because of this the operation is not <a
3346href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3347images transparency or alpha/matte channel.</p>
3348
3349<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3350of the individual color channels, usally involving a simplier gray-scale
3351image. E.g: gray-scale to color replacement, or modification by a histogram
3352mapping. </p>
3353
3354
3355<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003356 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003357</div>
3358
3359<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>
3360
3361<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003362 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003363</div>
3364
3365<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>
3366
3367<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003368 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003369</div>
3370
3371<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>
3372
3373<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>
3374
3375<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>
3376
3377<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003378 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003379</div>
3380
3381<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>
3382
3383<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003384 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003385</div>
3386
3387<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>
3388
3389<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>
3390
3391<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>
3392
cristyd0bda5e2010-09-21 16:22:45 +00003393<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003394amounts of image properties are displayed including image statistics, profiles,
3395image histogram, and others.</p>
3396
3397<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003398 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003399</div>
3400
3401<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>
3402
cristydcca3fa2010-12-29 21:50:07 +00003403<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 +00003404
3405<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>
3406
3407<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3408<p>or</p>
3409
3410<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>
3411
cristydcca3fa2010-12-29 21:50:07 +00003412<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 +00003413
cristydcca3fa2010-12-29 21:50:07 +00003414<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 +00003415
cristydcca3fa2010-12-29 21:50:07 +00003416<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 +00003417
3418<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003419 <h4><a id="immutable"></a>-immutable</h4>
cristy3ed852e2009-09-05 21:47:34 +00003420</div>
3421
3422<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>
3423
3424<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003425 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003426</div>
3427
3428<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>implode image pixels about the center.</td><td style='text-align:right;'></td></tr></table>
3429
3430<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003431 <h4><a id="insert"></a>-insert <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003432</div>
3433
3434<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>insert the last image into the image sequence.</td><td style='text-align:right;'></td></tr></table>
3435
3436<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>
3437
3438<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>
3439
3440<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003441 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003442</div>
3443
3444<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>use this type of rendering intent when managing the image color.</td><td style='text-align:right;'></td></tr></table>
3445
3446<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>
3447
3448<p>The default intent is undefined.</p>
3449
3450<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3451
3452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003453 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003454</div>
3455
3456<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the type of interlacing scheme.</td><td style='text-align:right;'></td></tr></table>
3457
3458<p>Choose from:</p>
3459
3460<pre class="text">
3461 none
3462 line
3463 plane
3464 partition
3465 JPEG
3466 GIF
3467 PNG
3468</pre>
3469
3470<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>
3471
3472<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3473
3474<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3475
3476<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3477
3478<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3479image.G, and image.B).</p>
3480
3481<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>
3482image.</p>
3483
3484<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3485
3486<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003487 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003488</div>
3489
3490<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>
3491
cristyd0bda5e2010-09-21 16:22:45 +00003492<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003493value, you typically fall in between the pixel colors defined by the source
3494image. This setting determines how the color is determined from the colors of
3495the pixels surrounding that point. That is how to determine the color of a
3496point that falls between two, or even four different colored pixels. </p>
3497
3498<pre class="text">
3499 integer: The color of the top-left pixel (floor function)
3500 nearest-neighbor: The nearest pixel to the lookup point (rounded function)
3501 average: The average color of the surrounding four pixels
3502 bilinear A double linear interpolation of pixels (the default)
3503 mesh Divide area into two flat triangular interpolations
3504 bicubic Fitted bicubic-spines of surrounding 16 pixels
3505 spline Direct spline curves (colors are blurred)
3506 filter Use resize <a href="#filter">-filter</a> settings
3507</pre>
3508
3509<p>This most important for distortion operators such as <a href="#distort"
3510>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3511>-transform</a> and <a href="#fx" >-fx</a>. </p>
3512
3513<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3514
3515<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3516lookup for positions outside the boundaries of the image. </p>
3517
3518
3519<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003520 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003521</div>
3522
3523<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>
3524
3525<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003526 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003527</div>
3528
3529<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>
3530
3531<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003532 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003533</div>
3534
3535<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>the space between two letters.</td><td style='text-align:right;'></td></tr></table>
3536
3537<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003538 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003539</div>
3540
3541<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>assign a label to an image.</td><td style='text-align:right;'></td></tr></table>
3542
cristy71a3f602010-09-15 12:38:16 +00003543<p>Use this option to assign a specific label to the image, as it is read in
3544or created. You can use the <a href="#set" >-set</a> operation to re-assign
3545a the labels of images already read in. Image formats such as TIFF, PNG,
3546MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003547
cristy71a3f602010-09-15 12:38:16 +00003548<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3549assigned to an image is used as a header string to print above the postscript
3550image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003551
cristybc9539a2010-08-16 18:06:20 +00003552<p>You can include the image filename, type, width, height, or other image
3553attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3554Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003555
3556<p>For example,</p>
3557
3558<p class="crtsnip">
3559 -label "%m:%f %wx%h" bird.miff
3560</p>
3561
cristy71a3f602010-09-15 12:38:16 +00003562<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3563"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3564is read in. If a <a href="#label">+label</a> option was used instead, any
3565existing label present in the image would be used. You can remove all labels
3566from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003567
cristy71a3f602010-09-15 12:38:16 +00003568<p>A label is not drawn on the image, but is embedded in the image datastream
3569via <em>Label</em> tag or similar mechanism. If you want the label to be
3570visible on the image itself, use the <a href="#draw">-draw</a> option, or
3571during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003572
cristy71a3f602010-09-15 12:38:16 +00003573<p>If the first character of <em class="arg">string</em> is <em
3574class="arg">@</em>, the image label is read from a file titled by the
3575remaining characters in the string. Labels in a file are literal, no embedded
3576formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003577
3578
3579<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003580 <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 +00003581</div>
3582
3583<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>
3584
3585<p>Adaptively threshold each pixel based on the value of pixels in a
3586surrounding window. If the current pixel is lighter than this average plus
3587the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3588black. Small variations in pixel values such as found in scanned documents
3589can be ignored if offset is positive. A negative offset will make it more
3590sensitive to those small variations. </p>
3591
3592<p>This is commonly used to threshold images with an uneven background. It is
3593based on the assumption that average color of the small window is the
3594the local background color, from which to separate the forground color. </p>
3595
3596
3597<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003598 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003599</div>
3600
3601<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>
3602
3603<p>Perform various image operation methods to a ordered sequence of images
3604which may represent either a set of overlaid 'image layers', a GIF disposal
3605animation, or a fully-'coalesced' animation sequence. </p>
3606
3607<table class="doc">
3608 <tbody>
3609 <tr valign="top">
3610 <th align="left" style="width: 8%">Method</th>
3611 <th align="left">Description</th>
3612 </tr>
3613
3614 <tr valign="top">
3615 <td valign="top">compare-any</td>
3616 <td valign="top">Crop the second and later frames to the smallest rectangle
3617 that contains all the differences between the two images. No GIF <a
3618 href="#dispose" >-dispose</a> methods are taken into account. </td>
3619 </tr>
3620
3621 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3622 >-deconstruct</a> operator, and does not preserve animations normal
3623 working, especially when animation used layer disposal methods such as
3624 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3625 </tr>
3626
3627 <tr valign="top">
3628 <td valign="top">compare-clear</td>
3629 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3630 opaque pixels which become transparent in the second frame. That is the
3631 smallest image needed to mask or erase pixels for the next frame. </td>
3632 </tr>
3633
3634 <tr valign="top">
3635 <td valign="top">compare-overlay</td>
3636 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3637 extra color to the next image, as a result of overlaying color pixels.
3638 That is the smallest single overlaid image to add or change colors. </td>
3639 </tr>
3640
3641 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3642 composition method '<kbd>change-mask</kbd>', to reduce the image to
3643 just the pixels that need to be overlaid. </td>
3644 </tr>
3645
3646 <tr valign="top">
3647 <td valign="top">coalesce</td>
3648 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3649 >-coalesce</a> operator. Apply the layer disposal methods set in the
3650 current image sequence to form a fully defined animation sequence, as
3651 it should be displayed. Effectively converting a GIF animation into a
3652 'film strip'-like animation. </td>
3653 </tr>
3654
3655 <tr valign="top">
3656 <td valign="top">composite</td>
3657 <td valign="top">Alpha Composition of two image lists, separated by a
3658 "<kbd>null:</kbd>" image, with the destination image list first, and
3659 the source images last. An image from each list are composited
3660 together until one list is finished. The separator image and source
3661 image lists are removed. </td>
3662 </tr>
3663
3664
cristybac7a162010-06-15 19:57:29 +00003665 <tr><td></td>
3666 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3667 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3668 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003669 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003670 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003671
cristybac7a162010-06-15 19:57:29 +00003672 <tr><td></td>
3673 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003674 applied to all the images in the other image list, regardless of which
3675 list it is. In this case it is the image meta-data of the list which
3676 preserved. </td>
3677 </tr>
3678
3679
3680 <tr valign="top">
3681 <td valign="top">dispose</td>
3682 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3683 the animation after the layer disposal method has been applied, before
3684 the next sub-frame image is overlaid. That is the 'dispose' image that
3685 results from the application of the GIF <a href="#dispose"
3686 >-dispose</a> method. This allows you to check what
3687 is going wrong with a particular animation you may be developing.
3688 </td>
3689 </tr>
3690
3691 <tr valign="top">
3692 <td valign="top">flatten</td>
3693 <td valign="top">Create a canvas the size of the first images virtual
3694 canvas using the current <a href="#background" >-background</a> color,
3695 and <a href="#compose" >-compose</a> each image in turn onto that
3696 canvas. Images falling outside that canvas is clipped. Final
3697 image will have a zero virtual canvas offset. </td>
3698 </tr>
3699
cristybac7a162010-06-15 19:57:29 +00003700 <tr><td></td>
3701 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003702 overlaying all the prepared image layers into a final image. </td>
3703 </tr>
3704
cristybac7a162010-06-15 19:57:29 +00003705 <tr><td></td>
3706 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003707 canvas with real pixels, or to underlay a opaque color to remove
3708 transparency from an image.</td>
3709 </tr>
3710
3711
3712 <tr valign="top">
3713 <td valign="top">merge</td>
3714 <td valign="top">As 'flatten' method but merging all the given image
3715 layers into a new layer image just large enough to hold all the image
3716 without clipping or extra space. The new images virtual offset will
3717 prevere the position of the new layer, even if this offset is
3718 negative. the virtual canvas size of the first image is preserved.
3719 </td>
3720 </tr>
3721
3722 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3723 as few image file formats handle them correctly. </td>
3724 </tr>
3725
3726 <tr valign="top">
3727 <td valign="top">mosaic</td>
3728 <td valign="top">As 'flatten' method but expanding the initial canvas size
3729 of the first image so as to hold all the image layers. However as a
cristyd0bda5e2010-09-21 16:22:45 +00003730 virtual canvas is 'locked' to the origin, by definition, image layers
cristy3ed852e2009-09-05 21:47:34 +00003731 with a negative offsets will still be clipped by the top and left
3732 edges.</td>
3733 </tr>
3734
3735 <tr><td></td><td>This method is commonly used to layout individual image using various
cristyd0bda5e2010-09-21 16:22:45 +00003736 offset but without knowing the final canvas size. The resulting image
cristy3ed852e2009-09-05 21:47:34 +00003737 will, like 'flatten' not have any virtual offset, so can be saved to
3738 any image file format. </td>
3739 </tr>
3740
3741
3742 <tr valign="top">
3743 <td valign="top">optimize</td>
3744 <td valign="top">Optimize a coalesced animation, into GIF animation using
3745 a number of general techniques. This currently a short cut to
3746 apply both the '<kbd>optimize-frame</kbd>', and
3747 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3748 include other optimization methods as they are developed. </td>
3749 </tr>
3750
3751 <tr valign="top">
3752 <td valign="top">optimize-frame</td>
3753 <td valign="top">Optimize a coalesced animation, into GIF animation by
3754 reducing the number of pixels per frame as much as possible by
3755 attempting to pick the best layer disposal method to use, while ensuring
3756 the result will continue to animate properly. </td>
3757 </tr>
3758
3759 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3760 then no reasonably fast GIF optimization algorithm can do this.
3761 However this does seem to do better than most other GIF frame
3762 optimizers seen. </td>
3763 </tr>
3764
3765 <tr valign="top">
3766 <td valign="top">optimize-plus</td>
3767 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3768 overall optimization by adding extra frames to the animation, without
3769 changing the final look or timing of the animation. The frames are
3770 added to attempt to separate the clearing of pixels from the
3771 overlaying of new additional pixels from one animation frame to the
3772 next. If this does not improve the optimization (for the next frame
3773 only), it will fall back to the results of the previous normal
3774 '<kbd>optimize-frame</kbd>' technique. </td>
3775 </tr>
3776
3777 <tr><td></td><td>There is the possibility that the change in the disposal style will
3778 result in a worsening in the optimization of later frames, though this
3779 is unlikely. In other words there no guarantee that it is better than
3780 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
cristyd0bda5e2010-09-21 16:22:45 +00003781 however you can get a vast improvement in the final animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003782 </tr>
3783
3784 <tr valign="top">
3785 <td valign="top">optimize-transparency</td>
3786 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3787 overlay images with transparency, if it does not change the resulting
3788 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3789 </td>
3790 </tr>
3791
3792 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3793 into a smaller file size due to larger areas of one (transparent)
3794 color rather than a pattern of multiple colors repeating the current
3795 disposed image of the last frame. </td>
3796 </tr>
3797
3798 <tr valign="top">
3799 <td valign="top">remove-dups</td>
3800 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3801 images, so as to simplify layer overlays of coalesced animations.
3802 </td>
3803 </tr>
3804
3805 <tr><td></td><td>Usually this a result of using a constant time delay across the
3806 whole animation, or after a larger animation was split into smaller
3807 sub-animations. The duplicate frames could also have been used as
3808 part of some frame optimization methods. </td>
3809 </tr>
3810
3811 <tr valign="top">
3812 <td valign="top">remove-zero</td>
3813 <td valign="top">Remove any image with a zero time delay, unless ALL the
3814 images have a zero time delay (and is not a proper timed animation, a
3815 warning is then issued). </td>
3816 </tr>
3817
3818 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3819 partial intermediary updates between the frames that are actually
3820 displayed to users. These frames are usally added for improved frame
3821 optimization in GIF animations. </td>
3822 </tr>
3823
3824 <tr valign="top">
3825 <td valign="top">trim-bounds</td>
3826 <td valign="top">Find the bounds of all the images in the current
3827 image sequence, then adjust the offsets so all images are contained on
3828 a minimal positive canvas. None of the image data is modified, only
3829 there virtual canvas size and offset. The all the image is given
3830 the same canvas size, and and will have a positive offset, but will
3831 remain in the same position relative to each other. As a result of the
3832 minimal canvas size at least one image will touch every edge of that
3833 canvas. The image data however may be transparent.
3834 </td>
3835 </tr>
3836
3837 </tbody>
3838</table>
3839
3840<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3841
3842<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3843>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3844>-mosaic</a> are only aliases for the above methods. Also see <a
3845href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3846href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3847>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3848
3849
3850<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003851 <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 +00003852</div>
3853
3854<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>
3855
3856<p>Given one, two or three values delimited with commas: black-point,
3857white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3858white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3859point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3860contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3861both black and white points are percentages of the full color range. Gamma
3862will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3863omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3864
3865<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3866the given '<kbd>black_point</kbd>' value in the original image is set to
3867zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3868<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3869to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3870adjusted. </p>
3871
3872<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3873adding the special '!' flag anywhere in the argument list, will cause the
3874operator to do the reverse of the level adjustment. That is a zero, or
3875<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
3876adjusted to the given level values, allowing you to de-contrast, or compress
3877the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
3878
3879<p>Only the channels defined by the current <a href="#channel">-channel</a>
3880setting are adjusted (defaults to RGB color channels only), allowing you to
3881limit the effect of this operator. </p>
3882
3883<p>Please note that the transparency channel is treated as 'matte'
3884values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
3885
3886
3887<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003888 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00003889 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
3890</div>
3891
cristyd0bda5e2010-09-21 16:22:45 +00003892<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 +00003893
3894<p>This function is exactly like <a href="#level">-level</a>, except that the
3895value value for each color channel is determined by the
3896'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
3897described under the <a href="#fill">-fill</a> option). </p>
3898
cristyd0bda5e2010-09-21 16:22:45 +00003899<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
3900is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00003901colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00003902adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00003903
3904<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
3905will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00003906respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00003907those colors. This can also be used to convert a plain gray-scale image into a
3908one using the gradient of colors specified. </p>
3909
3910<p>By supplying a single color with a comma separator either before or after
3911that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00003912respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00003913used for both the black and white color points, making the operator either
3914threshold the images around that color (- form) or set all colors to that
3915color (+ form). </p>
3916
3917
3918<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003919 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003920</div>
3921
3922<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>
3923
3924<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>
3925
cristy6b636652009-12-05 17:16:11 +00003926<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 +00003927
3928<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00003929 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00003930</p>
3931
3932<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
3933
cristydcca3fa2010-12-29 21:50:07 +00003934<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list resource</span><span class='crtout'></span></p><pre class="text">
3935File Area Memory Map Disk Thread Time
cristy6b636652009-12-05 17:16:11 +00003936------------------------------------------------------------------------------
cristydcca3fa2010-12-29 21:50:07 +00003937 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
3938</pre>
3939
cristy3ed852e2009-09-05 21:47:34 +00003940<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>
3941
3942<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>
3943
3944<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>
3945
3946<p class="crtsnip">
3947-limit area 10mb
3948</p>
3949
cristyd0bda5e2010-09-21 16:22:45 +00003950<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 +00003951
3952<p class="crtsnip">
3953-limit area 10mb -limit disk 500mb
3954</p>
3955
3956<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
3957
3958<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>
3959
3960<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.
3961</p>
3962
3963<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.
3964</p>
3965
3966<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003967 <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 +00003968</div>
3969
3970<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>
3971
cristyd934d102009-10-10 12:55:13 +00003972<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
3973and uses a 'histogram bin' to determine the range of color values that needs to
3974be stretched. However it then stretchs those colors using the <a
3975href="#level" >-level</a> operator.</p>
3976
3977<p>As such while the initial determination may have 'binning' round off
3978effects, the image colors are stretched mathematically, rather than using the
3979histogram bins. This makes the operator more accurate. </p>
3980
3981<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
3982'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
3983perfect stretch of the color range. </p>
3984
3985<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
3986normalization of mathematical images. </p>
3987
3988<p>This operator is under review for re-development. </p>
3989
3990
cristy3ed852e2009-09-05 21:47:34 +00003991<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003992 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00003993</div>
3994
3995<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>
3996
3997<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003998 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003999</div>
4000
4001<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>
4002
4003<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>
4004
4005<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004006 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004007</div>
4008
4009<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>
4010
4011<pre class="text">
cristyc1aee832010-05-08 00:36:47 +00004012 Align
4013 Alpha
4014 Boolean
4015 Channel
4016 Class
4017 ClipPath
4018 Coder
4019 Color
4020 Colorspace
4021 Command
4022 Compose
4023 Compress
4024 Configure
4025 DataType
4026 Debug
4027 Decoration
4028 Delegate
4029 Direction
4030 Dispose
4031 Distort
4032 Dither
4033 Endian
4034 Evaluate
4035 FillRule
4036 Filter
4037 Font
4038 Format
4039 Function
4040 Gravity
4041 ImageList
4042 Intent
4043 Interlace
4044 Interpolate
4045 Kernel
cristy787d4352010-03-06 13:55:58 +00004046 Layers
4047 LineCap
4048 LineJoin
4049 List
4050 Locale
4051 LogEvent
4052 Log
4053 Magic
4054 Method
4055 Metric
4056 Mime
4057 Mode
4058 Morphology
4059 Module
4060 Noise
4061 Orientation
4062 Policy
4063 PolicyDomain
4064 PolicyRights
4065 Preview
4066 Primitive
4067 QuantumFormat
4068 Resource
4069 SparseColor
4070 Storage
4071 Stretch
4072 Style
4073 Threshold
4074 Type
4075 Units
4076 Validate
4077 VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004078</pre>
4079
cristybac7a162010-06-15 19:57:29 +00004080<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4081list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4082available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004083
4084<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4085<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004086 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004087</div>
4088
4089<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>
4090
cristybac7a162010-06-15 19:57:29 +00004091<p>This option specifies the format for the log printed when the <a
4092href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004093
cristybac7a162010-06-15 19:57:29 +00004094<p>You can display the following components by embedding special format
4095characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004096
4097<pre class="text">
4098 %d domain
4099 %e event
4100 %f function
4101 %l line
4102 %m module
4103 %p process ID
4104 %r real CPU time
4105 %t wall clock time
4106 %u user CPU time
4107 %% percent sign
4108 \n newline
4109 \r carriage return
4110</pre>
4111
4112<p>For example:</p>
4113
4114<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>
4115<p>The default behavior is to print all of the components.</p>
4116
4117<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004118 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004119</div>
4120
4121<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>
4122
cristybac7a162010-06-15 19:57:29 +00004123<p>Set iterations to zero to repeat the animation an infinite number of times,
4124otherwise the animation repeats itself up to <em class="arg">iterations</em>
4125times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004126
4127<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004128 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004129</div>
4130
4131<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>
4132
4133<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004134 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004135</div>
4136
4137<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>
4138
4139
4140<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004141 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004142</div>
4143
4144<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
4145
4146<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4147
4148<pre class="text">
4149 best
4150 default
4151 gray
4152 red
4153 green
4154 blue
4155</pre>
4156
cristybac7a162010-06-15 19:57:29 +00004157<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4158Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4159the type and <kbd>display</kbd> searches the list of colormap types in
4160<kbd>top-to-bottom</kbd> order until one is located. See <em
4161class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004162
4163
4164<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004165 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004166</div>
4167
4168<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>
4169
4170<p>Here are the valid components of a map:</p>
4171
4172<pre class="text">
4173 r red pixel component
4174 g green pixel component
4175 b blue pixel component
4176 a alpha pixel component (0 is transparent)
4177 o opacity pixel component (0 is opaque)
4178 i grayscale intensity pixel component
4179 c cyan pixel component
4180 m magenta pixel component
4181 y yellow pixel component
4182 k black pixel component
4183 p pad component (always 0)
4184</pre>
4185
cristybac7a162010-06-15 19:57:29 +00004186<p>You can specify as many of these components as needed in any order (e.g.
4187bgr). The components can repeat as well (e.g. rgbr).</p>
4188
cristy3ed852e2009-09-05 21:47:34 +00004189
4190<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004191 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004192<em class="arg">filename</em></h4>
4193</div>
4194
4195<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>
4196
4197<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
4198
4199<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004200 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004201</div>
4202
4203<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>
4204
4205<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4206
cristybac7a162010-06-15 19:57:29 +00004207<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4208style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004209
4210<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004211 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004212</div>
4213
4214<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>
4215
4216<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004217 <h4><a id="median"></a>-median <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004218</div>
4219
4220<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>apply a median filter to the image.</td><td style='text-align:right;'></td></tr></table>
4221
4222<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004223 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004224</div>
4225
4226<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>
4227
4228<p>Choose from:</p>
4229
4230<pre class="text">
cristybac7a162010-06-15 19:57:29 +00004231 AE absolute error count, number of different pixels (-fuzz effected)
cristya20e3f92010-12-13 01:52:32 +00004232 FUZZ mean color distance
cristybac7a162010-06-15 19:57:29 +00004233 MAE mean absolute error (normalized), average channel error distance
4234 MEPP mean error per pixel (normalized mean error, normalized peak error)
4235 MSE mean error squared, average of the channel error squared
cristya20e3f92010-12-13 01:52:32 +00004236 NCC normalized cross correlation
cristybac7a162010-06-15 19:57:29 +00004237 PAE peak absolute (normalize peak absolute)
4238 PSNR peak signal to noise ratio
4239 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004240</pre>
4241
cristy771f7a72010-11-27 21:42:59 +00004242<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4243with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4244only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004245size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004246'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004247for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004248
4249<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4250('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004251normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004252
cristybac7a162010-06-15 19:57:29 +00004253<p>To print a complete list of metrics, use the <a href="#list">-list
4254metrics</a> option.</p>
4255
cristy3ed852e2009-09-05 21:47:34 +00004256
cristyd2baf7d2010-03-06 04:26:44 +00004257<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004258 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004259</div>
4260
4261<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>
4262
cristy3ed852e2009-09-05 21:47:34 +00004263
4264<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004265 <h4><a id="mode"></a>-mode <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004266</div>
4267
4268<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>
4269
cristybac7a162010-06-15 19:57:29 +00004270<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4271Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004272
cristybac7a162010-06-15 19:57:29 +00004273<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4274for a list of <a href="#mode" >-mode</a> arguments available in your
4275ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004276
4277
4278<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004279 <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 +00004280</div>
4281
cristybac7a162010-06-15 19:57:29 +00004282<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
4283class="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 +00004284
cristyb36feb22010-03-26 16:54:37 +00004285<p>The arguments are given as a percentages of variation. A value of 100 means
4286no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004287
cristyb36feb22010-03-26 16:54:37 +00004288<p>The <em class="arg">brightness</em> is a multiplier of the overall
4289brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4290twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4291before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004292
cristyb36feb22010-03-26 16:54:37 +00004293<p>The <em class="arg">saturation</em> controls the amount of color in an
4294image. For example, 0 produce a grayscale image, while a large value such as
4295200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004296
cristyb36feb22010-03-26 16:54:37 +00004297<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4298within the image by the amount specified. For example, 50 results in
4299a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4300A value of either 0 or 200 results in a complete 180 degree rotation of the
4301image. Using a value of 300 is a 360 degree rotation resulting in no change to
4302the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004303
cristyb36feb22010-03-26 16:54:37 +00004304<p>For example, to increase the color brightness by 20% and decrease the color
4305saturation by 10% and leave the hue unchanged, use <a
4306href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004307
cristyb36feb22010-03-26 16:54:37 +00004308<p>Use <a href="#set">-set</a> attribute of '<kbd
4309class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4310modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4311<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004312
4313<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 +00004314
cristy3ed852e2009-09-05 21:47:34 +00004315<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004316 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004317</div>
4318
4319<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>
4320
4321
4322<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004323 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004324</div>
4325
4326<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>transform the image to black and white.</td><td style='text-align:right;'></td></tr></table>
4327
4328
4329<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004330 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004331</div>
4332
4333<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>morphs an image sequence.</td><td style='text-align:right;'></td></tr></table>
4334
4335<p>Both the image pixels and size are linearly interpolated to give the
4336appearance of a meta-morphosis from one image to the next, over all the images
4337in the current image list. The added images are the equivalent of a <a
4338href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4339argument determine how many images to interpolate between each image. </p>
4340
4341
4342<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004343 <h4><a id="morphology"></a>-morphology</h4>
4344 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004345</div>
4346
cristy2c839602010-04-03 02:32:08 +00004347<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 +00004348
cristydcca3fa2010-12-29 21:50:07 +00004349<p>Until I get around to writing a option summary for this, see <a
4350href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4351Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004352
4353
cristy488844c2010-01-22 14:02:05 +00004354<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004355 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004356</div>
4357
4358<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>
4359
4360
4361<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004362 <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 +00004363</div>
4364
4365<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>
4366
4367<p>Blur with the given radius, standard deviation (sigma), and angle. The
4368angle given is the angle toward which the image is blurred. That is the
4369direction people would consider the object is coming from. </p>
4370
4371<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004372definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004373
4374<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4375pixels which are outside the image proper are blurred into the final result.
4376</p>
4377
4378<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004379 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004380</div>
4381
4382<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>
4383<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004384 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004385</div>
4386
cristyb29bc032010-02-01 20:29:43 +00004387<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 +00004388
4389<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>
4390
4391<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004392 <h4><a id="noise"></a>-noise <em class="arg">radius</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004393 +noise <em class="arg">type</em></h4>
4394</div>
4395
4396<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>
4397
4398<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>
4399
4400<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>
4401
4402<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>
4403
4404<pre class="text">
4405Gaussian
4406Impulse
4407Laplacian
4408Multiplicative
4409Poisson
4410Random
4411Uniform
4412</pre>
4413
4414<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4415
cristy83543962009-10-16 19:04:28 +00004416<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4417the use of a controlling value to specify teh amount of noise that should be
4418added to an image. </p>
4419
cristy3ed852e2009-09-05 21:47:34 +00004420
4421<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004422 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004423</div>
4424
4425<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>
4426
cristyd934d102009-10-10 12:55:13 +00004427<p>The intensity values are stretched to cover the entire range of possible
4428values. While doing so, black-out at most <em>2%</em> of the pixels and
4429white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004430
cristyd934d102009-10-10 12:55:13 +00004431<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4432is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4433(Before this version, it was equivalent to <a href="#contrast-stretch"
4434>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004435
cristyd934d102009-10-10 12:55:13 +00004436<p>All the channels are normalized in concert by the came amount so as to
4437preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004438setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004439setting will normalize the RGB channels independently.</p>
4440
cristydcca3fa2010-12-29 21:50:07 +00004441<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004442Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004443that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004444
4445<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004446
4447
4448<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004449 <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 +00004450</div>
4451
cristyd934d102009-10-10 12:55:13 +00004452<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
4453class="arg">threshold map</em> specified, and a uniform color map with the
4454given 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 +00004455
4456<p>You can choose from these standard threshold maps:</p>
4457
4458<pre class="text">
cristya6d7cf72010-11-07 15:58:34 +00004459threshold 1x1 Threshold 1x1 (non-dither)
4460checks 2x1 Checkerboard 2x1 (dither)
4461o2x2 2x2 Ordered 2x2 (dispersed)
4462o3x3 3x3 Ordered 3x3 (dispersed)
4463o4x4 4x4 Ordered 4x4 (dispersed)
4464o8x8 8x8 Ordered 8x8 (dispersed)
4465h4x4a 4x1 Halftone 4x4 (angled)
4466h6x6a 6x1 Halftone 6x6 (angled)
4467h8x8a 8x1 Halftone 8x8 (angled)
4468h4x4o Halftone 4x4 (orthogonal)
4469h6x6o Halftone 6x6 (orthogonal)
4470h8x8o Halftone 8x8 (orthogonal)
4471h16x16o Halftone 16x16 (orthogonal)
4472c5x5b c5x5 Circles 5x5 (black)
4473c5x5w Circles 5x5 (white)
4474c6x6b c6x6 Circles 6x6 (black)
4475c6x6w Circles 6x6 (white)
4476c7x7b c7x7 Circles 7x7 (black)
4477c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004478</pre>
4479
cristyde368992010-11-05 14:32:14 +00004480<p> The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
cristyd934d102009-10-10 12:55:13 +00004481pattern. Or you can define your own <em class="arg" >threshold map</em> in a
cristyde368992010-11-05 14:32:14 +00004482personal or system <kbd>thresholds.xml</kbd> XML file. </p>
cristy3ed852e2009-09-05 21:47:34 +00004483
cristyd934d102009-10-10 12:55:13 +00004484<p>To print a complete list of threshold, use the <a href="#list" >-list
4485threshold</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004486
cristyd934d102009-10-10 12:55:13 +00004487<p>It is recommended that the <a href="#map" >+map</a> operator be used after
4488applying <a href="#ordered-dither" >-ordered-dither</a> to reduce the number of
cristy3ed852e2009-09-05 21:47:34 +00004489colors an animated image sequence, to less that 256 colors. This ensures that
4490a common or global color table is used when saving the result to a color
4491limited file format such as GIF. </p>
4492
cristyd934d102009-10-10 12:55:13 +00004493<p>Note that at this time the exact same threshold dithering map is used for
4494all color channels, no attempt is made to offset or rotate the map for
4495different channels is made, to create an offset printing effect. (possible
4496future expansion) </p>
cristy3ed852e2009-09-05 21:47:34 +00004497
4498
4499<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004500 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004501</div>
4502
4503<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>
4504
cristyc54f5d42009-11-27 21:36:31 +00004505<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004506described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4507>-fuzz</a> setting can be used to match and replace colors similar to the one
4508given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004509
cristyb36feb22010-03-26 16:54:37 +00004510<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4511the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004512
cristyb36feb22010-03-26 16:54:37 +00004513<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4514as <a href="#opaque" >-opaque</a> but replaces the matching color with
4515transparency rather than the current <a href="#fill">-fill</a> color setting.
4516To ensure that it can do this it also ensures that the image has an alpha
4517channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4518the new transparent colors, and does not require you to modify the <a
4519href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004520
cristy3ed852e2009-09-05 21:47:34 +00004521
4522<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004523 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004524</div>
4525
4526<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>
4527
4528<p>Choose from these orientations:</p>
4529
4530<pre class="text">
4531 bottom-left
4532 bottom-right
4533 left-bottom
4534 left-top
4535 right-bottom
4536 right-top
4537 top-left
4538 top-right
4539 undefined
4540</pre>
4541
cristyd934d102009-10-10 12:55:13 +00004542<p>To print a complete list of orientations, use the <a href="#list" >-list
4543orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004544
4545
4546<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004547 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004548 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4549 +page
4550 </h4>
4551</div>
4552
4553<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>
4554
4555<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>
4556
4557<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>
4558
4559<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>
4560<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4561<thead>
4562 <tr valign="top">
4563 <th align="center"><em class="arg">media</em></th>
4564 <th align="center"><em class="arg">width</em></th>
4565 <th align="center"><em class="arg">height</em></th>
4566 </tr>
4567</thead>
4568<tbody>
4569<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4570<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4571<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4572<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4573<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4574<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4575<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4576<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4577<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4578<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4579<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4580<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4581<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4582<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4583<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4584<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4585<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4586<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4587<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4588<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4589<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4590<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4591<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4592<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4593<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4594<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4595<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4596<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4597<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4598<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4599<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4600<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4601<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4602<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4603<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4604<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4605<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4606<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4607</tbody>
4608</table>
4609
4610
4611
4612
4613<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>
4614
4615<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>
4616
4617<p>The default page dimensions for a TEXT image is 612x792.</p>
4618
4619<p>This option is used in concert with <a href="#density">-density</a>.</p>
4620
4621<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4622
4623<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004624 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004625</div>
4626
4627<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>
4628
4629<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>
4630
4631<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004632 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004633
4634<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>
4635
4636<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004637 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004638</div>
4639
4640<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>
4641
4642<p>Pause for the specified number of seconds before repeating the animation.</p>
4643
4644<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004645 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004646</div>
4647
4648<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>
4649
4650<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4651
4652<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004653 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004654</div>
4655
4656<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>
4657
4658<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004659 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004660</div>
4661
4662<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>
4663
4664<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004665 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004666</div>
4667
4668<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>
4669
4670<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4671
4672<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004673 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004674</div>
4675
4676<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>
4677
4678<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004679 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004680</div>
4681
4682<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>
4683
4684<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004685 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004686</div>
4687
4688<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>image preview type.</td><td style='text-align:right;'></td></tr></table>
4689
4690<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>
4691
4692<pre class="text">
4693 Rotate
4694 Shear
4695 Roll
4696 Hue
4697 Saturation
4698 Brightness
4699 Gamma
4700 Spiff
4701 Dull
4702 Grayscale
4703 Quantize
4704 Despeckle
4705 ReduceNoise
4706 Add Noise
4707 Sharpen
4708 Blur
4709 Threshold
4710 EdgeDetect
4711 Spread
4712 Shade
4713 Raise
4714 Segment
4715 Solarize
4716 Swirl
4717 Implode
4718 Wave
4719 OilPaint
4720 CharcoalDrawing
4721 JPEG
4722</pre>
4723
4724<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4725
4726<p>The default preview is <kbd>JPEG</kbd>.</p>
4727
4728<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004729 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004730</div>
4731
4732<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>
4733
4734<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004735 <h4><a id="process"></a>-process <em class="arg">command</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004736</div>
4737
4738<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>
4739
4740<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>
4741
4742<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004743 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004744 +profile <em class="arg">profile_name</em></h4>
4745</div>
4746
4747<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>
4748
4749<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>
4750
4751<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>
4752
4753<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>
4754
4755<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>
4756
4757<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4758
4759<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4760<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>
4761
4762<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>
4763<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4764CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4765</p>
4766
4767<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004768 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004769</div>
4770
4771<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>
4772
cristy851dbce2010-08-06 21:40:00 +00004773<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 +00004774
4775<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>
4776
cristy851dbce2010-08-06 21:40:00 +00004777<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 +00004778
cristy3c98a4f2010-08-13 20:09:41 +00004779<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 +00004780
4781<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4782
4783<pre class="text">
4784 0: none
4785 1: sub
4786 2: up
4787 3: average
4788 4: Paeth
4789</pre>
4790
4791<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>
4792
4793<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4794
4795<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>
4796
cristy3c98a4f2010-08-13 20:09:41 +00004797<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 +00004798
4799<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4800
cristy3ed852e2009-09-05 21:47:34 +00004801<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004802 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004803</div>
4804
cristy3c98a4f2010-08-13 20:09:41 +00004805<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 +00004806
cristy3c98a4f2010-08-13 20:09:41 +00004807<p>This setting defines the colorspace used to sort out and reduce the number
4808of colors needed by an image (for later dithering) by operators such as <a
4809href="#colors" >-colors</a>, Note that color reducion also happens
4810automatically when saving images to color-limited image file formats, such as
4811GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004812
4813
4814<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004815 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004816</div>
4817
4818<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>
4819
4820<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004821 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004822</div>
4823
4824<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>
4825
4826<p>Note that this is actually a rotational blur rather than a radial and as
4827such actually mis-named. </p>
4828
4829<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4830pixels which are outside the image proper are blurred into the final result.
4831</p>
4832
4833
4834<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004835 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004836</div>
4837
4838<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Lighten or darken image edges.</td><td style='text-align:right;'></td></tr></table>
4839
4840<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>.
4841</p>
4842
4843<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4844
4845<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004846 <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 +00004847</div>
4848
4849<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>
4850
4851<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004852 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004853</div>
4854
4855<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>
4856
4857<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004858 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00004859</div>
4860
4861<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>
4862
4863<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004864 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004865</div>
4866
4867<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>
4868
4869<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4870the given colors are dithered over the image as necessary, otherwise the closest
4871color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4872
4873<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4874images in the current image sequence, all the images will have the same color
4875table. That means that when saved to a file format such as GIF, it will use
4876that color table as a single common or global color table, for all the images,
4877without requiring extra local color tables. </p>
4878
4879<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4880sequence to use a common color map over all the images. This equivalent to
4881appending all the images together (without extra background colors) and color
4882reducing those images using <a href="#colors">-colors</a> with a 256 color
4883limit, then <a href="#remap">-remap</a> those colors over the original list of
4884images. This ensures all the images follow a single color map. </p>
4885
4886<p>If the number of colors over all the images is less than 256, then <a
4887href="#remap">+remap</a> should not perform any color reduction or dithering, as
4888no color changes are needed. In that case, its only effect is to force the use
4889of a global color table. This recommended after using either <a
4890href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
4891reduce the number of colors in an animated image sequence. </p>
4892
4893<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004894 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004895</div>
4896
4897<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>
4898
4899<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>
4900
4901<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>
4902
4903<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004904 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00004905</div>
4906
4907<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>
4908
4909<p>The only command recognized is the name of an image file to load.</p>
4910
4911<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>
4912
4913<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004914 <h4><a id="render"></a>-render</h4>
cristy3ed852e2009-09-05 21:47:34 +00004915</div>
4916
4917<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>
4918
4919<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>
4920
4921<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004922<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004923</div>
4924
4925<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>
4926
4927<p>This option is like <a href="#page">-page</a> but acts as an image operator
4928rather than a setting. You can separately set the canvas size or the offset
4929of the image on that canvas by only providing those components. </p>
4930
4931<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>
4932
4933<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
4934offset to move the image relative to its previous position. This useful for
4935animation sequences. </p>
4936
4937<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
4938recalculate the canvas size so the image (at its current offset) will appear
4939completely on that canvas (unless it has a negative offset).</p>
4940
4941<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
4942canvas meta-data from the images. </p>
4943
4944<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
4945directly assign virtual canvas meta-data. </p>
4946
4947
4948<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004949 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004950</div>
4951
4952<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>
4953
4954<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>
4955
4956<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>
4957
4958<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004959 <h4><a id="resize"></a>-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004960</div>
4961
4962<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>
4963
4964<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>
4965
4966<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>
4967
cristy13538962010-02-26 17:53:04 +00004968<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>
4969
cristy4949d522010-03-12 18:41:34 +00004970<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 +00004971<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004972 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00004973</div>
4974
4975<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>settings remain in effect until parenthesis boundary.</td><td style='text-align:right;'></td></tr></table>
4976
4977<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004978 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00004979</div>
4980
4981<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Reverse the order of images in the current image list.</td><td style='text-align:right;'></td></tr></table>
4982
4983
4984<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004985 <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 +00004986</div>
4987
4988<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>
4989
4990<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>
4991
4992
4993<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004994 <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 +00004995</div>
4996
4997<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>
4998
4999<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>
5000
5001<p>Empty triangles in the corners, left over from rotating the image, are
5002filled with the <kbd>background</kbd> color. </p>
5003
5004<p>See also the <a href="#distort">-distort</a> operator and specifically the
5005'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5006
5007
5008<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005009 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005010</div>
5011
cristyd0bd44a2010-09-24 12:38:11 +00005012<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 +00005013
cristyd0bd44a2010-09-24 12:38:11 +00005014<p>Change the image size simply by directly sampling the pixels original
5015image. When magnifying, pixels are replicated in blocks. When minifying,
5016pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005017
cristyd0bd44a2010-09-24 12:38:11 +00005018<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5019a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5020neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5021avoids all the filter processing of the image. As such it completely ignores
5022the current <a href="#filter">-filter</a> setting. </p>
5023
5024<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5025will be added to the resulting image, though some colors may disappear. </p>
5026
5027<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
5028ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005029
5030
5031<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005032 <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 +00005033</div>
5034
5035<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>
5036
5037<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>
5038
5039<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005040 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005041</div>
5042
cristyd0bd44a2010-09-24 12:38:11 +00005043<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 +00005044
cristyd0bd44a2010-09-24 12:38:11 +00005045<p>Change the image size simply by replacing pixels by averaging pixels
5046together when minifying, or replacing pixels when magnifing. </p>
5047
5048<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5049a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5050faster, as it avoids all the filter processing of the image. As such it
5051completely ignores the current <a href="#filter">-filter</a> setting. </p>
5052
5053<p>If when shrinking (minifying) images the original image is some integer
5054multiple of the new image size, the number of pixels avergaed together to
5055produce the new pixel color is the same across the whole image. This is
5056a special case known as 'binning' and is often used as a method of reducing
5057noise in image such as those generated by digital cameras, especially in low
5058light conditions. </p>
5059
cristy3ed852e2009-09-05 21:47:34 +00005060
5061<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005062 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005063</div>
5064
5065<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>
5066
5067<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5068
5069<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005070 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005071</div>
5072
5073<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the screen to capture.</td><td style='text-align:right;'></td></tr></table>
5074
5075<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>
5076
5077<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005078 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005079</div>
5080
5081<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>
5082
5083<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005084 <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 +00005085</div>
5086
5087<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>
5088
5089<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>
5090
5091<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>
5092
5093<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5094of the color clusters is returned.</p>
5095
5096
5097<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005098 <h4><a id="selective-blur"></a>-selective-blur <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005099</div>
5100
cristy2e2662a2010-10-09 14:29:37 +00005101<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005102 <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 +00005103</div>
5104
cristy3ed852e2009-09-05 21:47:34 +00005105<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>
5106
cristy2e2662a2010-10-09 14:29:37 +00005107<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>
5108
cristy3ed852e2009-09-05 21:47:34 +00005109<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005110 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005111</div>
5112
5113<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
5114
5115<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005116 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005117</div>
5118
5119<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate a sepia-toned photo.</td><td style='text-align:right;'></td></tr></table>
5120
5121<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5122
5123<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>
5124
cristyd0bda5e2010-09-21 16:22:45 +00005125
5126
cristy3ed852e2009-09-05 21:47:34 +00005127<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005128 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5129 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005130</div>
5131
cristyd0bd44a2010-09-24 12:38:11 +00005132<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>sets image attributes and properties for images in the current
cristyd0bda5e2010-09-21 16:22:45 +00005133image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005134
cristyd0bd44a2010-09-24 12:38:11 +00005135<p>This will assign (or modify) specific settings attached to all the images
5136in the current image sequence. Using the <a href="#set">+set</a> form of the
5137option will either remove, or reset that setting to a default state, as
5138appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005139
cristyd0bd44a2010-09-24 12:38:11 +00005140<p>For example, it will modify specific well known image meta-data
5141'attributes' such as those normally overridden by: the options <a
5142href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5143href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5144assigned before the image is read in, by using a <em class="arg">key</em> of
5145the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005146
cristyd0bd44a2010-09-24 12:38:11 +00005147<p>If the given <em class="arg">key</em> does not match a specific known
5148'attribute ', such as shown above, the setting is stored as a a free form
cristyd0bda5e2010-09-21 16:22:45 +00005149'properity' string. Such settings are listed in <a href="#verbose"
5150>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5151</p>
5152
cristyd0bd44a2010-09-24 12:38:11 +00005153<p>This includes string 'properities' that are set by and assigned to images
5154using the options <a href="#comment" >-comment</a>, <a href="#label"
5155>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5156a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5157Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005158
cristyd0bd44a2010-09-24 12:38:11 +00005159<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>
5160<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5161Properties</a> in the defined value. For example:</p>
5162
5163<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>
5164<p>Other well known 'properities' that can be include:
5165'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5166'<kbd>signature</kbd>'. </p>
5167
5168<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5169the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5170see <a href="#repage">-page</a>). However it is designed to provide a finer
5171control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5172option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5173attribute. </p>
5174
5175<p>This option can also associate a colorspace or profile with your image.
5176For example,</p>
5177
5178<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 +00005179<p>Some 'properties' must be defined in a specific way to be used. For
5180example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5181modify the output filename of an image. For example</p>
5182
5183<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>
5184<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5185be saved as a global "Artifact" exactly as if it was set using the <a
cristyd0bd44a2010-09-24 12:38:11 +00005186href="#define" >-define</a> option. As such settings are globel in scope, they
5187can be used to pass 'attributes' and 'properities' of one specific image,
5188in a way that allows you to use them in a completely different image, even if
5189the original image has long since been modified or destroyed. For example: </p>
5190
5191<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>
5192<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5193a 'artifact' if the given <em class="arg">key</em> does not match an existing
5194'attribute' or 'properity'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005195
5196<p>You can set the attributes of the image registry by prefixing the value
5197with <kbd>registry:</kbd>.</p>
5198
5199
cristy3ed852e2009-09-05 21:47:34 +00005200
5201<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005202 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005203</div>
5204
5205<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>
5206
5207<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>
5208
5209<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005210 <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 +00005211</div>
5212
5213<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>
5214
5215<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005216 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005217id="shared-memory"></a>-shared-memory</h4>
5218</div>
5219
5220<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>
5221
5222<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>
5223
5224<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005225 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005226</div>
5227
5228<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>
5229
5230<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5231
5232<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005233 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005234</div>
5235
5236<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>
5237
5238<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>
5239
5240<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>
5241
5242<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005243 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005244</div>
5245
5246<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>
5247
5248<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>
5249
5250<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>
5251
5252<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>
5253
5254<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>
5255
5256<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>
5257<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>
5258
5259<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5260<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005261 <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 +00005262</div>
5263
5264<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>
5265
5266<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>
5267
5268<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005269 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005270</div>
5271
5272<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>operate silently.</td><td style='text-align:right;'></td></tr></table>
5273
5274<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005275 <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 +00005276</div>
5277
5278<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>
5279
5280<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>
5281
5282<p>For Photo CD images, choose from these sizes:</p>
5283
5284<pre class="text">
5285 192x128
5286 384x256
5287 768x512
5288 1536x1024
5289 3072x2048
5290</pre>
5291
cristy3ed852e2009-09-05 21:47:34 +00005292<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005293 <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 +00005294</div>
5295
5296<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>
5297
5298<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>
5299
5300<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005301 <h4><a id="snaps"></a>-snaps <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005302</div>
5303
5304<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the number of screen snapshots.</td><td style='text-align:right;'>[<a href="../www/import.html">import</a>]</td></tr></table>
5305
5306<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5307
5308<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005309 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005310</div>
5311
5312<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>negate all pixels above the threshold level.</td><td style='text-align:right;'></td></tr></table>
5313
5314<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5315
5316<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5317
5318<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005319 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005320 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5321</div>
5322
5323<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>
5324
5325
5326<table class="doc">
5327 <tbody>
5328 <tr valign="top">
5329 <th align="left" style="width: 8%">Method</th>
5330 <th align="left">Description</th>
5331 </tr>
5332
5333 <tr valign="top">
5334 <td valign="top">voronoi</td>
5335 <td valign="top">Simply map each pixel to the to nearest color point
5336 given. The result are polygonal 'cells' of solid color. </td>
5337 </tr>
5338
5339 <tr valign="top">
5340 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005341 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005342 squared. Generating spots of color in a sea of the average of
5343 colors. </td>
5344 </tr>
5345
5346 <tr valign="top">
5347 <td valign="top">barycentric</td>
5348 <td valign="top">three point triangle of color given 3 points.
5349 Giving only 2 points will form a linear gradient between those points.
5350 Gradient is however not restricted to just the triangle or line. </td>
5351 </tr>
5352
5353 <tr valign="top">
5354 <td valign="top">bilinear</td>
5355 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5356 fall back to barycentric. </td>
5357 </tr>
5358
5359 </tbody>
5360</table>
5361
5362<p>The points are placed according to the images location on the virtual
5363canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5364offset), and do not actually have to exist on the given image, but may be
5365some point beyond the edge of the image. All points are floating point values.
5366</p>
5367
5368<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
5369modified, whcih means the matte/alpha transparency channel is not effected by
5370default. If enabled, the image also needs a the matte/alpha channel to be
5371enabled for this operator to effect an images transparency. This is typical
5372transparency handling for images. </p>
5373
5374<p>All the above methods when given a single point of color will replace all
5375the colors in the image with the color given, regardless of the point. This is
5376logical, and provides an alternative technique to recolor a image to some
5377default value. </p>
5378
5379
5380<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005381 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005382</div>
5383
5384<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Splice the current background color into the image.</td><td style='text-align:right;'></td></tr></table>
5385
5386<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>
5387
5388<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005389 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005390</div>
5391
5392<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>
5393
5394<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>
5395
5396<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005397 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005398</div>
5399
5400<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>
5401
5402<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>
5403
5404<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005405 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005406</div>
5407
5408<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>
5409
5410<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>
5411
5412<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005413 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005414</div>
5415
5416<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>
5417
5418<pre class="text">
5419 char store pixels as unsigned characters
5420 double store pixels as doubles
5421 float store pixels as floats
5422 integer store pixels as integers
5423 long store pixels as longs
5424 quantum store pixels in the native depth of your ImageMagick distribution
5425 short store pixels as unsigned shorts
5426</pre>
5427
5428<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5429values range from 0 to the maximum value the storage type can support.</p>
5430
5431<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005432 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005433</div>
5434
5435<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>
5436
5437<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>
5438
5439<pre class="text">
5440 Any
5441 Condensed
5442 Expanded
5443 ExtraCondensed
5444 ExtraExpanded
5445 Normal
5446 SemiCondensed
5447 SemiExpanded
5448 UltraCondensed
5449 UltraExpanded
5450</pre>
5451
5452<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5453
5454<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>
5455
5456<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005457 <h4><a id="strip"></a>-strip</h4>
cristy3ed852e2009-09-05 21:47:34 +00005458</div>
5459
5460<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>
5461
5462<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005463 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005464</div>
5465
5466<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>
5467
5468<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5469
5470<p>See <a href="#draw">-draw</a> for further details.</p>
5471
5472<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005473 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005474</div>
5475
5476<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>
5477
5478<p>See <a href="#draw">-draw</a> for further details.</p>
5479
5480<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005481 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005482</div>
5483
5484<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>
5485
cristy71a3f602010-09-15 12:38:16 +00005486<p>This setting suggests a font style that ImageMagick should try to apply to
5487the currently selected font family. Select <em class="arg">fontStyle</em> from
5488the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005489
5490<pre class="text">
5491 Any
5492 Italic
5493 Normal
5494 Oblique
5495</pre>
5496
5497<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>
5498
5499<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005500 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005501</div>
5502
cristyd4d64ed2010-08-22 22:19:33 +00005503<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>
5504
cristy71a3f602010-09-15 12:38:16 +00005505<p>This option is required to have compare search for the best match location
5506of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005507(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005508be the "match score" image.</p>
5509
cristyd0bd44a2010-09-24 12:38:11 +00005510<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005511position of the top-left corner of the given sub-image. that is its size will
5512be the size of the larger_image - sub_image + 1. The brightest location in
5513this image is the location s the locate on the best match that is also
5514reported. Note that this may or may nor be a perfect match, and the actual
5515brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005516possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005517
cristyd0bda5e2010-09-21 16:22:45 +00005518<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005519location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005520sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005521
cristyae6203d2010-08-09 01:12:14 +00005522
5523<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005524 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005525</div>
5526
5527<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>
5528
cristy71a3f602010-09-15 12:38:16 +00005529<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5530images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5531the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005532
5533<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005534 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005535</div>
5536
5537<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>
5538
5539<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5540
5541<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005542 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005543</div>
5544
5545<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>
5546
5547<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005548 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005549</div>
5550
cristy5063d812010-10-19 16:28:10 +00005551<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 +00005552
5553<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005554 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005555</div>
5556
5557<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>
5558
5559<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>
5560
5561<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>
5562
5563<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005564 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005565</div>
5566
5567<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>
5568
5569<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005570 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005571</div>
5572
5573<!-- {<em class="arg">green,blue,opacity</em>}
5574<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>
5575-->
5576
5577<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>
5578
5579<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>
5580
5581<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.
5582</p>
5583
5584<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>
5585
5586<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5587<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>
5588
5589
5590<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>
5591<p>Note that the values of the transparency channel is treated as 'matte'
5592values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5593
5594<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>.
5595</p>
5596
5597<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005598 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005599</div>
5600
5601<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>
5602
5603<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>
5604
5605<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>
5606
5607<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005608 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005609</div>
5610
5611<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>
5612
5613<div style="margin: auto;">
5614 <h4>-tile <em class="arg">geometry</em></h4>
5615</div>
5616
5617<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>
5618
5619<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>
5620
5621<div style="margin: auto;">
5622 <h4>-tile</h4>
5623</div>
5624
5625<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>
5626
5627<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005628 <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 +00005629</div>
5630
5631<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>
5632
5633<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>
5634
5635<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>
5636
5637<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005638 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005639</div>
5640
5641<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>
5642
5643<p>Tint the image with the fill color.</p>
5644
5645<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>
5646
5647<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005648 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005649</div>
5650
5651<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>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>
5652
5653<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>
5654
5655<p>For example,</p>
5656
5657<p class="crtsnip">
5658 -title "%m:%f %wx%h"
5659</p>
5660
5661<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>
5662
5663
5664<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005665 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005666</div>
5667
5668<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>transform the image.</td><td style='text-align:right;'></td></tr></table>
5669
5670<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5671
5672<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 +00005673
5674<p>This operator has been now been superseded by the <a
5675href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5676
5677
cristy3ed852e2009-09-05 21:47:34 +00005678<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005679 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005680</div>
5681
5682<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>
5683
5684<p>The <em class="arg">color</em> argument is defined using the format
5685described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5686>-fuzz</a> setting can be used to match and replace colors similar to the one
5687given. </p>
5688
cristyb36feb22010-03-26 16:54:37 +00005689<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5690that is make all non-matching colors transparent. </p>
5691
cristy3ed852e2009-09-05 21:47:34 +00005692<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005693href="#transparent" >-transparent</a> but replaces the matching color with the
5694current <a href="#fill">-fill</a> color setting, rather than transparent.
5695However the <a href="#transparent" >-transparent</a> operator also ensures
5696that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5697>-alpha</a> set</kbd>", and does not require you to modify the <a
5698href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005699
cristyb36feb22010-03-26 16:54:37 +00005700<p>Note that this does not define the color as being the 'transparency color'
5701used for color-mapped image formats, such as GIF. For that use <a
5702href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005703
5704
5705<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005706 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005707</div>
5708
5709<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>
5710
5711<p>Sometimes this is used for saving to image formats such as
5712GIF and PNG8 which uses this color to represent boolean transparency. This
5713does not make a color transparent, it only defines what color the transparent
5714color is in the color palette of the saved image. Use <a
5715href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5716
5717<p>This option allows you to have both an opaque visible color, as well as a
5718transparent color of the same color value without conflict. That is, you can
5719use the same color for both the transparent and opaque color areas within an
5720image. This, in turn, frees to you to select a transparent color that is
5721appropriate when an image is displayed by an application that does not handle a
5722transparent color index, while allowing ImageMagick to correctly handle images of this
5723type. </p>
5724
5725<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5726
5727<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005728 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005729</div>
5730
5731<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Mirror the image along the top-left to bottom-right diagonal.</td><td style='text-align:right;'></td></tr></table>
5732
5733<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5734</p>
5735
5736<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005737 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005738</div>
5739
5740<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>
5741
5742
5743<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005744 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005745</div>
5746
5747<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>
5748
5749<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>
5750
5751<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>
5752
5753<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>
5754
5755<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005756 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00005757</div>
5758
5759<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>
5760
5761<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>
5762
5763<p>The page or virtual canvas information of the image is preserved allowing
5764you to extract the result of the <a href="#trim">-trim</a> operation from the
5765image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5766information if it is unwanted.</p>
5767
5768<p>If the trimmed image 'disappears' an warning is produced, and a special
5769single pixel transparent 'missed' image is returned, in the same way as when a
5770<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5771
5772
5773<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005774 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005775</div>
5776
5777<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 +00005778 <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 +00005779
5780<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>
5781
5782<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5783<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>
5784
5785<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5786
5787<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005788 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005789</div>
5790
5791<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>
5792
5793<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5794
5795<p>See <a href="#draw">-draw</a> for further details.</p>
5796
5797
5798<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005799 <h4><a id="update"></a>-update <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005800</div>
5801
5802<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>
5803
5804<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>
5805
5806
5807<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005808 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00005809</div>
5810
5811<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>
5812
5813
5814<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005815 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005816</div>
5817
5818<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>
5819
5820<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>
5821
5822
5823<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005824 <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 +00005825</div>
5826
5827<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>
5828
5829<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>
5830
5831<p>The parameters are:</p>
5832
5833<pre class="text">
5834 radius: The radius of the Gaussian, in pixels, not counting the center
5835 pixel (default 0).
5836 sigma: The standard deviation of the Gaussian, in pixels (default 1.0).
5837 amount: The fraction of the difference between the original and the blur
5838 image that is added back into the original (default 1.0).
5839 threshold: The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5840 difference amount (default 0.05).
5841</pre>
5842
5843
5844<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005845 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005846</div>
5847
cristyd0bda5e2010-09-21 16:22:45 +00005848<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 +00005849
5850
5851<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005852 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00005853</div>
5854
5855<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>
5856
5857
5858<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005859 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005860</div>
5861
5862<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>
5863
5864
5865<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005866 <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 +00005867</div>
5868
5869<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>
5870
5871
5872<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005873 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005874</div>
5875
5876<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>
5877
5878<p>This option defines what color source should be used if and when a color
5879lookup completely 'misses' the source image. The color(s) that appear to
5880surround the source image. Generally this color is derived from the source
5881image, but could also be set to a specify background color. </p>
5882
5883<p>Choose from these methods:</p>
5884
5885<pre class="text">
5886 background: the area surrounding the image is the background color
5887 black: the area surrounding the image is black
5888 checker-tile: alternate squares with image and background color
5889 dither: non-random 32x32 dithered pattern
5890 edge: extend the edge pixel toward infinity
5891 gray: the area surrounding the image is gray
5892 horizontal-tile: horizontally tile the image, background color above/below
5893 horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
5894 mirror: mirror tile the image
5895 random: choose a random pixel from the image
5896 tile: tile the image (default)
5897 transparent: the area surrounding the image is transparent blackness
5898 vertical-tile: vertically tile the image, sides are background color
5899 vertical-tile-edge: vertically tile the image and replicate the side edge pixels
5900 white: the area surrounding the image is white
5901</pre>
5902
5903<p>The default value is "edge".</p>
5904
5905<p>This most important for distortion operators such as <a href="#distort"
5906>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
5907However it also effects operations that may access pixels just outside the
5908image proper, such as <a href="#convolve">-convolve</a>, <a
5909href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
5910
5911<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
5912
5913
5914<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005915 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005916</div>
5917
5918<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>
5919
5920<p>Choose from these visual classes:</p>
5921
5922<pre class="text">
5923 StaticGray
5924 GrayScale
5925 StaticColor
5926 PseudoColor
5927 TrueColor
5928 DirectColor
5929 default
5930 visual id
5931</pre>
5932
5933<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>
5934
5935
5936<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005937 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00005938 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
5939</div>
5940
5941<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
5942saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5943
5944<p>Take a grayscale image (with alpha mask) and modify the destination image's
5945brightness according to watermark image's grayscale value and the <em
5946class="arg">brightness</em> percentage. The destinations color saturation
5947attribute is just direct modified by the <em class="arg">saturation</em>
5948percentage, which defaults to 100 percent (no color change). </p>
5949
5950
5951<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005952 <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 +00005953</div>
5954
5955<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>
5956
5957<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
5958
5959<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005960 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005961</div>
5962
5963<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set a font weight for text.</td><td style='text-align:right;'></td></tr></table>
5964
5965<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>
5966
5967<table class="doc">
5968 <col width="25%" />
5969 <col width="75%" />
5970 <thead>
5971 <tr>
5972 <th><em class="arg">fontWeight</em></th>
5973 <th>Description</th>
5974 </tr>
5975 </thead>
5976 <tbody>
5977 <tr><td>All </td> <td>No effect. </td></tr>
5978 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
5979 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
5980 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
5981 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
5982 </tbody>
5983 </table>
5984
5985<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
5986
5987<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>
5988
5989<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005990 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005991</div>
5992
5993<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>
5994
5995<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005996 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005997</div>
5998
cristy5cadd612009-09-21 19:33:41 +00005999<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>
6000
6001<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.
6002</p>
cristy3ed852e2009-09-05 21:47:34 +00006003
6004<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006005 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006006</div>
6007
6008<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>
6009
6010<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>
6011
6012<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>
6013
6014<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>
6015
6016<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006017 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006018</div>
6019
6020<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>specify the window group.</td><td style='text-align:right;'></td></tr></table>
6021
6022<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006023 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006024</div>
6025
6026<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>write an image sequence.</td><td style='text-align:right;'></td></tr></table>
6027 <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>
6028
6029<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006030</div>
6031</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006032
6033</div>
6034
6035<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006036 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006037 <span id="linkbar-center">
6038 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006039 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006040 </span>
6041 <span id="linkbar-east">&nbsp;</span>
6042 </div>
6043 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +00006044 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006045 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6046 </div>
6047 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006048 <script type="text/javascript">
6049 var _gaq = _gaq || [];
6050 _gaq.push(['_setAccount', 'UA-17690367-1']);
6051 _gaq.push(['_trackPageview']);
6052
6053 (function() {
6054 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6055 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6056 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6057 })();
6058 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006059</body>
6060</html>