blob: 74226209bedf3587d1fbf0707e48190d14ba7b5c [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001
2
3
4
5<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
6 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +00007<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00008<head>
cristy3de29cc2010-04-15 02:34:44 +00009 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +000010 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
11 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +000012 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +000013 @import url("../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +000014 </style>
cristy3ed852e2009-09-05 21:47:34 +000015 <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/>
16 <title>ImageMagick: Command-line Options</title>
17 <meta http-equiv="Content-Language" content="en-US"/>
18 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
19 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
20 <meta name="Generator" content="PHP"/>
21 <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"/>
22 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
23 <meta name="Rating" content="GENERAL"/>
24 <meta name="Robots" content="INDEX, FOLLOW"/>
25 <meta name="Generator" content="ImageMagick Studio LLC"/>
26 <meta name="Author" content="ImageMagick Studio LLC"/>
27 <meta name="Revisit-after" content="2 DAYS"/>
28 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +000029 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000030 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +000031</head>
32
33<body id="www-imagemagick-org">
34<div class="titlebar">
35<a href="../index.html">
36 <img src="../images/script.png" alt="[ImageMagick]"
37 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
38<a href="http://www.networkredux.com">
39 <img src="../images/networkredux.png" alt="[sponsor]"
40 style="margin: 45px auto; border: 0px; float: left;" /></a>
41<a href="http://www.imagemagick.org/discourse-server/">
42 <img src="../images/logo.jpg" alt=""
43 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
44<a href="../index.html">
45 <img src="../images/sprite.jpg" alt=""
46 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
47</div>
48
cristyce69bb02010-07-27 19:49:46 +000049<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000050
cristy3ed852e2009-09-05 21:47:34 +000051<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000052 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000053</div>
cristy3eaa0ef2010-03-06 20:35:26 +000054<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000055<div class="menu">
cristybb503372010-05-27 20:51:26 +000056 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
57</div>
58<div class="sub">
59 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
60</div>
61<div class="sub">
62 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
63</div>
64<div class="sub">
65 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
66</div>
67<div class="sep"></div>
68<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000069 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000070</div>
71<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000072 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000073</div>
74<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000075 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000076</div>
77<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000078 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000079</div>
80<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000081 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000082</div>
83<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000084 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000085</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000087 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000088</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000090 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000091</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
cristy3eaa0ef2010-03-06 20:35:26 +000095<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000096<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000104 </div>
105<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000106 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
cristybb503372010-05-27 20:51:26 +0000108<div class="menu">
109 <a title="Architecture" href="../www/architecture.html">Architecture</a>
110</div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000118<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000119<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000120 <a title="Site Map"href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000121</div>
122<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Site Map: Links"href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000124</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000125<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000128
129<div class="sponsbox">
130<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000131 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
132</div>
133<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000134 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy787d4352010-03-06 13:55:58 +0000135</div>
136<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000137 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000138</div>
139<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000140 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy1f9e1ed2009-11-18 04:09:38 +0000141</div>
142<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000143 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000144</div>
145<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000146 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyc49f7992009-09-22 22:48:40 +0000147</div>
cristy96e13132010-06-07 14:55:44 +0000148<div class="sponsor">
cristyce69bb02010-07-27 19:49:46 +0000149 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristy96e13132010-06-07 14:55:44 +0000150</div>
cristy3ed852e2009-09-05 21:47:34 +0000151</div>
152</div>
cristyce69bb02010-07-27 19:49:46 +0000153</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000154
cristyce69bb02010-07-27 19:49:46 +0000155<div class="eastbar">
156 <script type="text/javascript">
157 <!--
158 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000159 google_ad_slot = "0574824969";
160 google_ad_width = 160;
161 google_ad_height = 600;
162 //-->
163 </script>
164 <script type="text/javascript"
165 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
166 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000167</div>
168
169<div class="main">
170
cristy5cadd612009-09-21 19:33:41 +0000171<p class="navigation-index">
cristy2c839602010-04-03 02:32:08 +0000172[ <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#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#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 +0000173
cristyb36feb22010-03-26 16:54:37 +0000174<p>Below is list of command-line options recognized by the ImageMagick <a
175href="../www/command-line-tools.html">command-line
176tools</a>. If you want a description of a particular option, click on the
177option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000178otherwise 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 +0000179
180<div style="margin: auto;">
181 <h4><a name="adaptive-blur" id="adaptive-blur"></a>-adaptive-blur <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
182</div>
183
184<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>
cristy2c839602010-04-03 02:32:08 +0000185 "direction",
cristy3ed852e2009-09-05 21:47:34 +0000186<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>
187
188<div style="margin: auto;">
189 <h4><a name="adaptive-resize" id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
190</div>
191
192<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>
193
194<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>
195
196<div style="margin: auto;">
197 <h4><a name="adaptive-sharpen" id="adaptive-sharpen"></a>-adaptive-sharpen <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
198</div>
199
200<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>
201
202<p>A Gaussian operator of the given radius and standard deviation (<em class="arg">sigma</em>) is used. If <em class="arg">sigma</em> is not given it defaults to 1.</p>
203
204<div style="margin: auto;">
205 <h4><a name="adjoin" id="adjoin"></a>-adjoin</h4>
206</div>
207
208<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>
209
210<p>This option is enabled by default. An attempt is made to save all
211images of an image sequence into the given output file.
212However, some formats, such as JPEG and PNG, do not support more than one
213image per file, and in that case ImageMagick is forced to write each image as a separate file. As
214such, if more than one image needs to be written, the filename given is
215modified by adding a <a href="#scene">-scene</a> number before the
216suffix, in order to make distinct names for each image. </p>
217
218<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written
219to separate files, whether or not the file format allows multiple images
220per file (for example, GIF, MIFF, and TIFF). </p>
221
222<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>
223
224<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: rose: -morph 15 my%02dmorph.jpg</span></p>
225<p>will create a sequence of 17 images named my00morph.jpg, my01morph.jpg, my02morph.jpg, ..., my16morph.jpg.
226</p>
227
228<p>In summary, ImageMagick tries to write all images to one file, but will use
229multiple files if either (1) the output image's file format does not allow multi-image files,
230(2) the <a href="#adjoin">+adjoin</a> option is given, or (3) a C-style integer format string is
231present in the output filename. </p>
232
233
234<div style="margin: auto;">
235 <h4><a name="affine" 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/>
236 -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>
237</div>
238
239<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>
240
241<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>
242
243<p>The matrix entries are entered as comma-separated numeric values <i>with no spaces</i>. </p>
244
245<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>
246
247<div class="eqn">
248<img alt="affine transformation" src="../images/affine.png"/>
249</div>
250
251<p>
252The 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>
253
254<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>
255
256<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>
257
258<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>
259
260<p class="crtsnip">
261 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
262</p>
263
264<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>
265
266<p class="crtsnip">
267 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
268</p>
269
270<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
271<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
272
273<p class="crtsnip">
274 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
275</p>
276
277<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>
278
279<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>
280
281<div style="margin: auto;">
282 <h4><a name="alpha" id="alpha"></a>-alpha <em class="arg">type</em></h4>
283</div>
284
285<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>
286
287<p>Used to set a flag on an image indicating whether or not to use existing alpha
288channel 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>
289
290
291<table class="doc">
292 <tbody>
293 <tr valign="top">
294 <th align="left" style="width: 8%">type</th>
295 <th align="left">Description</th>
296 </tr>
297
298 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000299 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000300 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000301 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
302 should be used instead of this, unless you specifically need to
303 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
304 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000305
306 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000307 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000308 <td valign="top">
309 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000310 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000311
312 <tr valign="top">
313 <td valign="top"><kbd>Set</kbd></td>
314 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000315 Activates the alpha/matte channel. If it was previously turned off
316 then it also resets the channel to opaque. If the image already had
317 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000318
319 <tr valign="top">
320 <td valign="top"><kbd>Opaque</kbd></td>
321 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000322 Enables the alpha/matte channel and forces it to be fully opaque.
323 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000324
325 <tr valign="top">
326 <td valign="top"><kbd>Transparent</kbd></td>
327 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000328 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000329 transparent. This effectively creates a fully transparent image the
330 same size as the original and with all its original RGB data still
331 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000332
333 <tr valign="top">
334 <td valign="top"><kbd>Extract</kbd></td>
335 <td valign="top">
336 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000337 '<kbd>Off</kbd>' the the image's transparency, so as to generate
338 a gray-scale mask of the image's shape. The alpha channel data is left
339 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
340 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000341
342 <tr valign="top">
343 <td valign="top"><kbd>Copy</kbd></td>
344 <td valign="top">
345 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000346 gray-scale intensity of the image, into the alpha channel, converting
347 a gray-scale mask into a transparent shaped mask ready to be colored
348 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000349
350 <tr valign="top">
351 <td valign="top"><kbd>Shape</kbd></td>
352 <td valign="top">
353 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000354 the current background color. That is the RGB color channels is
355 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000356 </td></tr>
357
358 <tr valign="top">
359 <td valign="top"><kbd>Background</kbd></td>
360 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000361 Set any fully-transparent pixel to the background color, while leaving
362 it fully-transparent. This can make some image file formats, such as
363 PNG, smaller as the RGB values of transparent pixels are more uniform,
364 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000365 </td></tr>
366 </tbody>
367</table>
368
369<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000370"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000371>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000372Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000373
374
375<div style="margin: auto;">
376 <h4><a name="annotate" id="annotate"></a>
377 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
378 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
379 -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>
380</div>
381
382<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>
383
384<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>
385
386
387<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>
388
389<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>
390
391<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>
392<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
393
394<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>
395
396<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>
397
398<div style="margin: auto;">
399 <h4><a name="antialias" id="antialias"></a>-antialias</h4>
400</div>
401
402<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
403drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
404
405<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
406drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
407antialiasing edge pixels. This will then reduce the number of colors added to
408an image to just the colors being directly drawn. That is, no mixed colors
409will be added when drawing such objects. </p>
410
411<div style="margin: auto;">
412 <h4><a name="append" id="append"></a>-append</h4>
413</div>
414
415<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>
416
417<p>This option creates a single longer image image, by joining all the current
418images in sequence top-to-bottom. Use <a href="#append">+append</a> to
419stack images left-to-right. </p>
420
421<p>If they are not of the same width, narrower images are padded with the
422current <a href="#background">-background</a> color setting, and their
423position relative to each other can be controled by the current <a
424href="#gravity">-gravity</a> setting. </p>
425
426
427<div style="margin: auto;">
428 <h4><a name="attenuate" id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
429</div>
430
431<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>
432
433
434<div style="margin: auto;">
435 <h4><a name="authenticate" id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
436</div>
437
438<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>
439
440<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>
441
442<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
443
cristyd934d102009-10-10 12:55:13 +0000444
445
cristy3ed852e2009-09-05 21:47:34 +0000446<div style="margin: auto;">
447 <h4><a name="auto-gamma" id="auto-gamma"></a>-auto-gamma</h4>
448</div>
449
450<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>
451
cristyd934d102009-10-10 12:55:13 +0000452<p>This calculates the mean values of an image, then applies a calculated <a
453href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
454image it will get a have a value of 50%. </p>
455
456<p>This means that any solid 'gray' image will become 50% gray. </p>
457
458<p>This works well for real-life images with little or no extreme dark and
459light areas, but tend to fail for images with large amounts of bright sky or
460dark shadows. It also does not work well for diagrmas or cartoon like images.
461</p>
462
463<p>It uses the <a href="#channel" >-channel</a> setting, (including the
464'<CODE>sync</CODE>' flag for channel syncronization), to determine which color
465values will be used and modified. As the default <a href="#channel"
466>-channel</a> setting is '<CODE>RGB,sync</CODE>', channels will be modified
467together by the same gamma value, preserving colors. </p>
468
469
470
cristy3ed852e2009-09-05 21:47:34 +0000471<div style="margin: auto;">
472 <h4><a name="auto-level" id="auto-level"></a>-auto-level</h4>
473</div>
474
475<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>
476
cristyd934d102009-10-10 12:55:13 +0000477<p>This is a 'perfect' image normalization operator. It finds the exact
478mimimum and maximum color values in the image and then applies a <a
479href="#level" >-level</a> operator to stretch the values to the full range of
480values. </p>
481
cristy83543962009-10-16 19:04:28 +0000482<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000483JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
484for the <a href="#level" >-level</a> operation. On the other hand it is the
485right operator to use for color stretching gradient images being used to
486generate Color lookup tables, distortion maps, or other 'mathematically'
487defined images. </p>
488
489<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
490href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
491>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
492problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000493>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000494
495<p>It uses the <a href="#channel" >-channel</a> setting, (including the
496special '<CODE>sync</CODE>' flag for channel syncronization), to determine
497which color values will be used and modified. As the default <a
cristy83543962009-10-16 19:04:28 +0000498href="#channel" >+channel</a> setting is '<CODE>RGB,sync</CODE>', the
499'<CODE>sync</CODE>' will ensure that the color channels will be modified
500together by the same gamma value, preserving colors, and ignoring
501transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000502
503
504
cristy3ed852e2009-09-05 21:47:34 +0000505<div style="margin: auto;">
506 <h4><a name="auto-orient" id="auto-orient"></a>-auto-orient</h4>
507</div>
508
509<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>
510
cristy83543962009-10-16 19:04:28 +0000511<p>This operator reads and resets the EXIF image profile setting 'Orientation'
512and then performs the appropriate 90 degree rotation on the image to orient
513the image, for correct viewing. </p>
514
515<p>This EXIF profile setting is usually set using a gravity sensor in digital
516camara, however photos taken directly downward or upward may not have an
517appropriate value. Also images that have been orientation 'corrected' without
518reseting this setting, may be 'corrected' again resulting in a incorrect
519result. If the he EXIF profile was previously stripped, the <a
520href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
521
522
cristy3ed852e2009-09-05 21:47:34 +0000523<div style="margin: auto;">
524 <h4><a name="average" id="average"></a>-average</h4>
525</div>
526
527<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>
528
529<p>An error results if the images are not identically sized.</p>
530
cristy3ed852e2009-09-05 21:47:34 +0000531
532<div style="margin: auto;">
533 <h4><a name="backdrop" id="backdrop"></a>-backdrop</h4>
534</div>
535
536<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>
537
538<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>
539
540<div style="margin: auto;">
541 <h4><a name="background" id="background"></a>-background <em class="arg">color</em></h4>
542</div>
543
544<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>
545
546<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>
547
548<div style="margin: auto;">
549 <h4><a name="bench" id="bench"></a>-bench <em class="arg">iterations</em></h4>
550</div>
551
552<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>
553
cristye6378132009-10-26 20:05:17 +0000554<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 +0000555
cristye6378132009-10-26 20:05:17 +0000556<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>
557<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 +0000558
559<div style="margin: auto;">
560 <h4><a name="bias" id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
561</div>
562
563<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>
564
565<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>
566
567<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>
568
569<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
570negative results without clipping to the color value range
571(0..QuantumRange).</p>
572
573<p>See the discussion on HDRI implementations of ImageMagick on the page
574<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.
575</p>
576
577<div style="margin: auto;">
578 <h4><a name="black-point-compensation" id="black-point-compensation"></a>-black-point-compensation</h4>
579</div>
580
581<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>
582
583<div style="margin: auto;">
cristy5cadd612009-09-21 19:33:41 +0000584 <h4><a name="black-threshold" id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000585</div>
586
cristy5cadd612009-09-21 19:33:41 +0000587<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>
588
589<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.
590</p>
cristy3ed852e2009-09-05 21:47:34 +0000591
592
593<div style="margin: auto;">
cristy83a272e2010-05-07 20:40:35 +0000594 <h4><a name="blend" id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000595</div>
596
cristy83a272e2010-05-07 20:40:35 +0000597<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 +0000598
599<p>Blend will average the images together ('plus') according to the
600percentages given and each pixels transparency. If only a single percentage
601value is given it sets the weight of the composite or 'source' image, while
602the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000603<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
604'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000605
606
607<div style="margin: auto;">
608 <h4><a name="blue-primary" id="blue-primary"></a>-blue-primary <em class="arg">x</em>,<em class="arg">y</em></h4>
609</div>
610
611<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>
612
613<div style="margin: auto;">
614 <h4><a name="blue-shift" id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
615</div>
616
617<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>
618
619<div style="margin: auto;">
620
621<div style="margin: auto;">
622 <h4><a name="blur" id="blur"></a>-blur <em class="arg">radius</em><br />-blur <em class="arg">radius</em>x<em class="arg">sigma</em></h4>
623</div>
624
625<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>
626
cristyb15553d2010-07-03 22:53:14 +0000627<p>Convolve the image with a Gaussian or normal distribution using the given
628<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000629
630<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
631</div>
632
cristyb15553d2010-07-03 22:53:14 +0000633<p>The <em class="arg" >Sigma</em> value is the important argument, and
634determines the actual amount of bluring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000635
cristyb15553d2010-07-03 22:53:14 +0000636<p>The <em class="arg" >Radius</em> is only used to determine the size of the
637array which will hold the calculated gaussian distribution. It should be an
638integer. If not given, or set to zero, IM will calculate the largest posible
639radius that will provide meaningful results for the Gaussian distribution.
640</p>
641
642<p>The larger the <em class="arg" >Radius</em> the radius the slower the
643operation is. However too small a <em class="arg" >Radius</em>, and sever
644aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
645should be at least twice the <em class="arg" >Sigma</em> value, though three
646times will produce a more accurite result. </p>
647
648<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
649by taking advantage of the separability properties of the distribution. Here
650we apply a single-dimensional Gaussian matrix in the horizontal direction,
651then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000652
653<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
654pixels which are outside the image proper are blurred into the final result.
655</p>
656
657
658<div style="margin: auto;">
659 <h4><a name="blur-composite" id="blur"></a>-blur <em class="arg">Width</em>[x<em class="arg">Height</em>[+<em class="arg">Angle</em>]]</h4>
660</div>
661
662<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>
663
664<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
665Average (EWA) of the source image, scaled according to the grayscale
666mapping. </p>
667
668<p>The ellipse is weighted with sigma set to the given <em class="arg"
669>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
670defaults to the <em class="arg" >Width</em> for a normal circular Guassian
671weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
672horizontal clock-wise. </p>
673
674<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
675pixels which are outside the image proper are blurred into the final result.
676</p>
677
678
679<div style="margin: auto;">
680 <h4><a name="border" id="border"></a>-border <em class="arg">geometry</em></h4>
681</div>
682
683<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>
684
685<p>Set the width and height using the <em class="arg">size</em> portion of the <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 ignored. </p>
686
687<p>Set the border color by preceding with the <a href="#bordercolor">-bordercolor</a> setting.</p>
688
689<p>See also the <a href="#frame">-frame</a> option, which has more functionality.</p>
690
691<div style="margin: auto;">
692 <h4><a name="bordercolor" id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
693</div>
694
695<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>
696
697<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
698
699<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
700
701<div style="margin: auto;">
702 <h4><a name="borderwidth" id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
703</div>
704
705<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>
706
707<div style="margin: auto;">
cristy16ff93c2010-01-13 23:18:07 +0000708 <h4><a name="brightness-contrast" 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>
709</div>
710
711<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>
712
713<p>Brightness and Contrast values apply changes to the input image. They are not absolute settings. A brightness or contrast value of zero means no change. The range of values is -100 to +100 on each. Positive values increase the brightness or contrast and negative values decrease the brightness or contrast. To control only contrast, set the brightness=0. To control only brightness, set contrast=0 or just leave it off.</p>
714
715<p>You may also use <a href="#fill">-channel</a> to control which channels to apply the brightness and/or contrast change. The default is to apply the same transformation to all channels.</p>
716
717<p>Brightness and Contrast arguments are converted to offset and slope of a linear transform and applied using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
718
719<p>The slope varies from 0 at contrast=-100 to almost vertical at contrast=+100. For brightness=0 and contrast=-100, the result will be totally midgray. For brightness=0 and contrast=+100, the result will approach but not quite reach a threshold at midgray; that is the linear transformation will be a a very steep vertical line at mid gray.</p>
720
721<p>Negative slopes, i.e. negating the image, are not possible with this function. All achievable slopes will be zero or positive.</p>
722
723<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5 at brightness=+100. Thus, when contrast=0 and brightness=100, the result will be totally white. Similarly, when contrast=0 and brightness=-100, the result will be totally black.</p>
724
725<p>As the range of values for the arguments are -100 to +100, adding the '%' symbol will be no different than leaving it off.</p>
726
727<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +0000728 <h4><a name="cache" id="cache"></a>-cache <em class="arg">threshold</em></h4>
729</div>
730
731<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>
732
733<div style="margin: auto;">
734 <h4><a name="caption" id="caption"></a>-caption <em class="arg">string</em></h4>
735</div>
736
737<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>
738
739<div style="margin: auto;">
740 <h4><a name="cdl" id="cdl"></a>-cdl <em class="arg">filename</em></h4>
741</div>
742
743<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>
744
745<p>Here is an example color correction collection:</p>
746
747<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000748&lt;?xml version="1.0" encoding="UTF-8"?&gt;
749&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
750 &lt;ColorCorrection id="cc06668"&gt;
751 &lt;SOPNode&gt;
752 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
753 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
754 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
755 &lt;/SOPNode&gt;
756 &lt;SATNode&gt;
757 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
758 &lt;/SATNode&gt;
759 &lt;/ColorCorrection&gt;
760&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000761</pre>
762
763<div style="margin: auto;">
764 <h4><a name="channel" id="channel"></a>-channel <em class="arg">type</em></h4>
765</div>
766
767<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>
768
769<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>, <kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>, <kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>, <kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
770
cristy83a272e2010-05-07 20:40:35 +0000771<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000772abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
773'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
774'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000775
cristy83a272e2010-05-07 20:40:35 +0000776For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
777you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000778<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000779 -channel Red,Blue
780</p>
781<p>or you can use the short hand form</p>
782<p class="crtsnip">
783 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000784</p>
785
cristy83a272e2010-05-07 20:40:35 +0000786<p>All the channels that is present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000787special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
788but generally any operators that are generally 'grey-scale' image operators,
789will understand this setting. See individual operator documentation. </p>
790
791<br>
cristy83a272e2010-05-07 20:40:35 +0000792
793<p>On top of the normal channel selection a extra flag can be specified,
794'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000795operators that understand this flag should perform: cross-channel
796syncronization of the channels. If not specified, then most grey-scale
797operators will apply their image processing operations to each individual
798channel (as specified by the rest of the <a href="#channel">-channel</a>
799setting) completely independantally from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000800
801<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
802<a href="#auto-gamma">-auto-gamma</a> the color channels will be modified
803together in exactly the same way so that colors will remain in-sync. Without
804it being set, then each channel will be modified separatally and
cristybac7a162010-06-15 19:57:29 +0000805independantally, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000806
cristybac7a162010-06-15 19:57:29 +0000807<p>The <a href="#morphology">-morphology</a> '<kdb>Convolve</kdb>' method
808and the <a href="#compose">-compose</a> mathematical methods, also understands
809the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
810to the alpha channel (if present). That is to say it will modify the image
811processing with the understanding that fully-transparent colors should not
812contribute to the final result. </p>
813
814Basically, by default, operators work with color channels in syncronous, and
815treats transparency as special, unless the <a href="#channel">-channel</a>
816setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
817How each operator does this depends on that operators current implementation.
818Not all operators understands this flag at this time, but that is changing.
819</p>
cristy83a272e2010-05-07 20:40:35 +0000820
821<p>To print a complete list of channel types, use <a href="#list">-list
822channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000823
cristybac7a162010-06-15 19:57:29 +0000824<br>
cristyd934d102009-10-10 12:55:13 +0000825
826<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000827'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
828channels except the transparency channel, and that all the color channels are
829to be modified in exactly the same way, with a understanding of transprancy
830(depending on the operation being applied). The 'plus' form <a
831href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000832
833<p>Options that are affected by the <a href="#channel" >-channel</a> setting
834include the following.
835
836<a href="#auto-gamma">-auto-gamma</a>,
837<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000838<a href="#black-threshold">-black-threshold</a>,
839<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000840<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000841<a href="#clut">-clut</a>,
842<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000843<a href="#composite">-composite</a> (Mathematical compose methods only),
844<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000845<a href="#contrast-stretch">-contrast-stretch</a>,
846<a href="#evaluate">-evaluate</a>,
847<a href="#function">-function</a>,
848<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000849<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000850<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000851<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000852<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000853<a href="#negate">-negate</a>,
854<a href="#normalize">-normalize</a>,
855<a href="#ordered-dither">-ordered-dither</a>,
856<a href="#radial-blur">-radial-blur</a>,
857<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000858<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000859<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000860<a href="#white-threshold">-white-threshold</a>.
861</p>
862
cristyd934d102009-10-10 12:55:13 +0000863<p>Warning, some operators behave differentally when the <a href="#channel"
864>+channel</a> default setting is in effect, verses ANY user defined <a
865href="#channel" >-channel</a> setting (including the equivelent of the
cristy83a272e2010-05-07 20:40:35 +0000866default). These operators have yet to be made to understand the newer 'Sync'
867flag. </p>
868
cristybac7a162010-06-15 19:57:29 +0000869<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
870the image before thresholding, if no <a href="#channel" >-channel</a> setting
871has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +0000872
873<p>Also some operators such as <a href="#blur">-blur</a>, <a
874href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
875color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
876href="#channel" >-channel</a>. Generally this done to ensure that
877fully-transparent colors are treated as being fully-transparent, and thus any
878underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +0000879resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
880convolution equivelents however does have a understanding of the 'Sync' flag
881and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +0000882
cristybac7a162010-06-15 19:57:29 +0000883<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +0000884color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +0000885alpha channel present, and the <a href="#channel" >-channel</a> setting tells
886the operator to apply the operation using alpha channels. The <a
887href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +0000888
cristy3ed852e2009-09-05 21:47:34 +0000889
890<div style="margin: auto;">
cristyb4c03bb2009-09-27 13:55:46 +0000891 <h4><a name="clamp" id="clamp"></a>-clamp</h4>
892</div>
893
894<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>
895
896<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +0000897 <h4><a name="charcoal" id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
898</div>
899
900<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>
901
902<div style="margin: auto;">
903 <h4><a name="chop" id="chop"></a>-chop <em class="arg">geometry</em></h4>
904</div>
905
906<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>
907
908<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> and <em class="arg">height</em> given in the of the <em class="arg">size</em> portion of the <em class="arg">geometry</em> argument give the number of columns and rows to remove. The <em class="arg">offset</em> portion of the <em class="arg">geometry</em> argument is influenced by a <a href="#gravity">-gravity</a> setting, if present.</p>
909
910<p>The <a href="#chop">-chop</a> option removes entire rows and columns, and moves the remaining corner blocks leftward and upward to close the gaps.</p>
911
912<div style="margin: auto;">
913 <h4><a name="clip" id="clip"></a>-clip</h4>
914</div>
915
916<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>
917
918<p>If a clipping path is present, it is applied to subsequent operations.</p>
919
920<p>For example, in the command</p>
921
922<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
923<p>only the pixels within the clipping path are negated.</p>
924
925<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
926
927<div style="margin: auto;">
928 <h4><a name="clip-mask" id="clip-mask"></a>-clip-mask</h4>
929</div>
930
931<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>
932
933<div style="margin: auto;">
934 <h4><a name="clip-path" id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
935</div>
936
937<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>
938
939<div style="margin: auto;">
940 <h4><a name="clone" id="clone"></a>-clone <em class="arg">index(s)</em></h4>
941</div>
942
943<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>
944
945<p>Specify the image by its index in the sequence. The first image is index
9460. Negative indexes are relative to the end of the sequence; for example, &minus;1
947represents the last image of the sequence. Specify a range of images with a
948dash (e.g. 0&minus;4). Separate multiple indexes with commas but no spaces (e.g. 0,2,5). Use <a
949href="#clone">+clone</a> make a copy of the last image in the image
950sequence.</p>
951
952<div style="margin: auto;">
953 <h4><a name="clut" id="clut"></a>-clut</h4>
954</div>
955
956<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
957corresponding channel in the second image as a <b>c</b>olor
958<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
959
960<p>The second (LUT) image is ordinarily a gradient image containing the
961histogram mapping of how each channel should be modified. Typically it is a
962either a single row or column image of replacement color values. If larger
963than a single row or column, values are taken from a diagonal line from
964top-left to bottom-right corners.</p>
965
966<p>The lookup is further controlled by the <a
967href="#interpolate">-interpolate</a> setting, which is especially handy for an
968LUT which is not the full length needed by the ImageMagick installed Quality
969(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
970'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
971gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
972lookup of color values. </p>
973
974<p>This operator is especially suited to replacing a grayscale image with a
975specific color gradient from the CLUT image. </p>
976
977<p>Only the channel values defined by the <a href="#channel">-channel</a>
978setting will have their values replaced. In particular, since the default <a
979href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
980transparency (alpha/matte channel) is not affected, unless the <a
981href="#channel">-channel</a> setting is modified. When the alpha channel is
982set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
983as the other channels, implying that alpha/matte values are replaced using the
984alpha/matte values of the original image. </p>
985
986<p>If either the image being modified, or the lookup image, conatins no
987transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
988href="#channel">-channel</a> setting includes alpha replacement, then it is
989assumed that image represents a gray-scale graident which will be used for the
990replacement alpha values. That is you can use a gray-scale CLUT image to
991adjust a existing images alpha channel, or you can color a gray-scale image
992using colors form CLUT containing the desired colors, including transparency.
993</p>
994
995<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors according
996the lookup of the full color RGB value from a 2D representation of a 3D color
997cube. </p>
998
999
1000<div style="margin: auto;">
1001 <h4><a name="coalesce" id="coalesce"></a>-coalesce</h4>
1002</div>
1003
1004<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>
1005
1006<p>Overlay each image in an image sequence according to its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of an animation at each point in the animation sequence. All images should be the same size, and are assigned appropriate GIF disposal settings for the animation to continue working as expected as a GIF animation. Such frames are more easilly viewed and processed than the highly optimized GIF overlay images. </p>
1007
1008<p>The animation can be re-optimized after processing using the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', though there is no guarantee that the restored GIF animation optimization is better than the original. </p>
1009
1010
1011<div style="margin: auto;">
1012 <h4><a name="colorize" id="colorize"></a>-colorize <em class="arg">value</em></h4>
1013</div>
1014
1015<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>
1016
1017<p>Specify the amount of colorization as a percentage. Separate colorization values can be applied to the red, green, and blue channels of the image with a comma-delimited list of colorization values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
1018
1019<div style="margin: auto;">
1020 <h4><a name="colormap" id="colormap"></a>-colormap <em class="arg">type</em></h4>
1021</div>
1022
1023<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>
1024
1025<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1026
1027<p>This option only applies when the default X server visual is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer to <a href="#visual">-visual</a> for more details. By default, a shared colormap is allocated. The image shares colors with other X clients. Some image colors could be approximated, therefore your image may look very different than intended. If <kbd>private</kbd> is chosen, the image colors appear exactly as they are defined. However, other clients may go <em>technicolor</em> when the image colormap is installed.</p>
1028
1029<div style="margin: auto;">
1030 <h4><a name="colors" id="colors"></a>-colors <em class="arg">value</em></h4>
1031</div>
1032
1033<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>
1034
1035<p>The actual number of colors in the image may be less than your request, but never more. Note that this a color reduction option. Images with fewer unique colors than specified by <em class="arg">value</em> will have any duplicate or unused colors removed. The ordering of an existing color palette may be altered. When converting an image from color to grayscale, it is more efficient to convert the image to the gray colorspace before reducing the number of colors. Refer to the <a href="../www/quantize.html">color reduction algorithm</a> for more details.</p>
1036
1037<div style="margin: auto;">
cristy2c839602010-04-03 02:32:08 +00001038 <h4><a name="color-matrix" id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
1039</div>
1040
1041<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>
1042
1043<p>This option permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
1044
1045<p>As an example, to add contrast to an image with offsets, try this command:</p>
1046
1047<pre class="text">
1048convert kittens.jpg -color-matrix \
1049 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1050 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1051 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1052 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1053 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1054 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1055</pre>
1056<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00001057 <h4><a name="colorspace" id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
1058</div>
1059
1060<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>
1061
1062<p>Choices are:</p>
1063
1064<pre class="text">
1065 CMY
1066 CMYK
1067 Gray
1068 HSB
1069 HSL
1070 HWB
1071 Lab
1072 Log
1073 OHTA
1074 Rec601Luma
1075 Rec601YCbCr
1076 Rec709Luma
1077 Rec709YCbCr
1078 RGB
1079 sRGB
1080 Transparent
1081 XYZ
1082 YCbCr
1083 YCC
1084 YIQ
1085 YPbPr
1086 YUV
1087</pre>
1088
1089<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1090
1091<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>
1092
1093<table class="doc">
1094 <caption>Conversion Of RGB To Other Color Spaces</caption>
1095 <tr><th align="left" valign="middle">CMY</th></tr>
1096 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1097 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1098 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1099 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1100 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1101 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1102 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1103 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1104
1105 <tr><th align="left" valign="middle">Gray</th></tr>
1106 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1107
1108 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1109 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1110 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1111 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1112
1113 <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>
1114 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1115 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1116 <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>
1117
1118 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1119 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1120 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1121 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1122
1123 <tr><th align="left" valign="middle">LAB</th></tr>
1124 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1125 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1126 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1127
1128 <tr><th align="left" valign="middle">LOG</th></tr>
1129 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1130 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1131 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1132
1133 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1134 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1135 <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>
1136 <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>
1137
1138 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1139 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1140
1141 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1142 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1143 <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>
1144 <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>
1145
1146 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1147 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1148
1149 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1150 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1151 <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>
1152 <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>
1153
1154 <tr><th align="left" valign="middle">sRGB</th></tr>
1155 <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>
1156 <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>
1157 <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>
1158
1159 <tr><th align="left" valign="middle">XYZ</th></tr>
1160 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1161 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1162 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1163
1164 <tr><th align="left" valign="middle">YCC</th></tr>
1165 <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>
1166 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1167 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1168
1169 <tr><th align="left" valign="middle">YCbCr</th></tr>
1170 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1171 <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>
1172 <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>
1173
1174 <tr><th align="left" valign="middle">YIQ</th></tr>
1175 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1176 <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>
1177 <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>
1178
1179 <tr><th align="left" valign="middle">YPbPr</th></tr>
1180 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1181 <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>
1182 <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>
1183
1184 <tr><th align="left" valign="middle">YUV</th></tr>
1185 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1186 <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>
1187 <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>
1188</table>
1189
1190<div style="margin: auto;">
1191 <h4><a name="combine" id="combine"></a>-combine</h4>
1192</div>
1193
1194<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>
1195
1196<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>
1197
1198<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.
1199</p>
1200
cristy4949d522010-03-12 18:41:34 +00001201<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 +00001202<div style="margin: auto;">
1203 <h4><a name="comment" id="comment"></a>-comment <em class="arg">string</em></h4>
1204</div>
1205
1206<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>
1207
1208<p>This option places comments in a non-pixel portion of the image file. For a comment to be visibly written on the image itself, use the <a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options.</p>
1209
1210<p>Use this option to assign a specific comment to the image, when writing to an image format that supports comments. You can include the image filename, type, width, height, or other image attribute by embedding special format characters listed under the <a href="#format">-format</a> option. The comment is not drawn on the image, but is embedded in the image datastream via "Comment" tag or similar mechanism. </p>
1211
1212<p>For example,</p>
1213
1214<p class="crtsnip">
1215 -comment "%m:%f %wx%h"
1216</p>
1217
1218<p>produces an image comment 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>
1219
1220<p>If the first character of <em class="arg">string</em> is <em class="arg">@</em>, the image comment is read from a file titled by the remaining characters in the string. Comments in a file are literal; no embedded formatting characters are recognized.</p>
1221
1222<div style="margin: auto;">
1223 <h4><a name="compose" id="compose"></a>-compose <em class="arg">operator</em></h4>
1224</div>
1225
1226<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>
1227
1228<p>The description of composition uses abstract terminology in order to allow
1229the description to be more precise, while avoiding constant values which are
1230specific to a particular build configuration. Each image pixel is represented
1231by red, green, and blue levels (which are equal for a gray pixel). The
1232build-dependent value <em class="QR">QuantumRange</em> is the maximum integral
1233value which may be stored, per pixel, in the red, green, or blue channels of
1234the image. Each image pixel may also optionally (if the image matte channel is
1235enabled) have an associated level of opacity, ranging from <em>opaque</em> to
1236<em>transparent</em>, which may be used to determine the influence of the pixel
1237color when compositing the pixel with another image pixel. If the image matte
1238channel is disabled, then all pixels in the image are treated as opaque. The
1239color of an opaque pixel is fully visible while the color of a transparent
1240pixel color is entirely absent (pixel color is ignored).</p>
1241
1242<p>By definition, raster images have a rectangular shape. All image rows are of
1243equal length, as are all image columns. By treating the alpha channel as a
1244visual "mask" the rectangular image may be given a "shape" by treating the
1245alpha channel as a cookie-cutter for the image. This is done by setting the
1246pixels within the shape to be opaque, with pixels outside the shape set as
1247transparent. Pixels on the boundary of the shape may be between opaque and
1248transparent in order to provide antialiasing (visually smooth edges). The
1249description of the composition operators use this concept of image "shape" in
1250order to make the description of the operators easier to understand. While it
1251is convenient to describe the operators in terms of "shapes" they are by no
1252means limited to mask-style operations since they are based on continuous
1253floating-point mathematics rather than simple boolean operations.</p>
1254
1255<p>The following alpha blending (Duff-Porter) compose methods are available:</p>
1256
1257<table class="doc">
1258 <tbody>
1259 <tr valign="top">
1260 <th align="left" style="width: 8%">Method</th>
1261 <th align="left">Description</th>
1262 </tr>
1263
1264 <tr valign="top">
1265 <td valign="top">clear</td>
1266 <td valign="top">Both the color and the alpha of the destination are
1267 cleared. Neither the source nor the destination are used (except for
1268 destinations size and other meta-data which is always preserved.</td>
1269 </tr>
1270
1271 <tr valign="top">
1272 <td valign="top">src</td>
1273 <td valign="top">The source is copied to the destination. The destination
1274 is not used as input, though it is cleared.</td>
1275 </tr>
1276
1277 <tr valign="top">
1278 <td valign="top">dst</td>
1279 <td valign="top">The destination is left untouched. The source image is
1280 completely ignored.</td>
1281 </tr>
1282
1283 <tr valign="top">
1284 <td valign="top">src-over</td>
1285 <td valign="top">The source is composited over the destination. this is
1286 the default alpha blending compose method, when neither the compose
1287 setting is set, nor is set in the image meta-data.</td>
1288 </tr>
1289
1290 <tr valign="top">
1291 <td valign="top">dst-over</td>
1292 <td valign="top">The destination is composited over the source and the
1293 result replaces the destination.</td>
1294 </tr>
1295
1296 <tr valign="top">
1297 <td valign="top">src-in</td>
1298 <td valign="top">The part of the source lying inside of the destination
1299 replaces the destination.</td>
1300 </tr>
1301
1302 <tr valign="top">
1303 <td valign="top">dst-in</td>
1304 <td valign="top">The part of the destination lying inside of the source
1305 replaces the destination. Areas not overlaid are cleared.</td>
1306 </tr>
1307
1308 <tr valign="top">
1309 <td valign="top">src-out</td>
1310 <td valign="top">The part of the source lying outside of the destination
1311 replaces the destination.</td>
1312 </tr>
1313
1314 <tr valign="top">
1315 <td valign="top">dst-out</td>
1316 <td valign="top">The part of the destination lying outside of the source
1317 replaces the destination.</td>
1318 </tr>
1319
1320 <tr valign="top">
1321 <td valign="top">src-atop</td>
1322 <td valign="top">The part of the source lying inside of the destination is
1323 composited onto the destination.</td>
1324 </tr>
1325
1326 <tr valign="top">
1327 <td valign="top">dst-atop</td>
1328 <td valign="top">The part of the destination lying inside of the source is
1329 composited over the source and replaces the destination. Areas not
1330 overlaid are cleared. </td>
1331 </tr>
1332
1333 <tr valign="top">
1334 <td valign="top">xor</td>
1335 <td valign="top">The part of the source that lies outside of the
1336 destination is combined with the part of the destination that lies
1337 outside of the source. Source or Destination, but not both. </td>
1338 </tr>
1339
1340 </tbody>
1341</table>
1342
1343<p>Any of the 'Src-*' methods can also be specified without the 'Src-' part.
1344For example the defaul compose method can be specified as just 'Over'.</p>
1345
1346
1347<p>The following mathemathical composition methods are also available. </p>
1348
cristy3ed852e2009-09-05 21:47:34 +00001349<table class="doc">
1350 <tbody>
1351 <tr valign="top">
1352 <th align="left" style="width: 8%">Method</th>
1353 <th align="left">Description</th>
1354 </tr>
1355
1356 <tr valign="top">
1357 <td valign="top">multiply</td>
cristy83a272e2010-05-07 20:40:35 +00001358 <td valign="top">The source is multiplied by the destination and replaces
1359 the destination. The resultant color is always at least as dark as
1360 either of the two constituent colors. Multiplying any color with black
1361 produces black. Multiplying any color with white leaves the original
1362 color unchanged.</td>
cristy3ed852e2009-09-05 21:47:34 +00001363 </tr>
1364
1365 <tr valign="top">
1366 <td valign="top">screen</td>
cristy83a272e2010-05-07 20:40:35 +00001367 <td valign="top">The source and destination are complemented and then
1368 multiplied and then replace the destination. The resultant color is
1369 always at least as light as either of the two constituent colors.
1370 Screening any color with white produces white. Screening any color
1371 with black leaves the original color unchanged.</td>
cristy3ed852e2009-09-05 21:47:34 +00001372 </tr>
1373
1374 <tr valign="top">
1375 <td valign="top">plus</td>
1376 <td valign="top">The source is added to the destination and replaces the
1377 destination. This operator is useful for averaging or a controled
1378 merger of two images, rather than a direct overlay.</td>
1379 </tr>
1380
1381 <tr valign="top">
1382 <td valign="top">add</td>
1383 <td valign="top">As per 'plus' but transparency data is treated as matte
1384 values. As such any transparent areas in either image remain
1385 transparent. </td>
1386 </tr>
1387
1388 <tr valign="top">
1389 <td valign="top">minus</td>
1390 <td valign="top">Subtract the colors in the source image from the
1391 destination image. When transparency is involved, opaque areas is
1392 subtracted from any destination opaque areas. </td>
1393 </tr>
1394
1395 <tr valign="top">
1396 <td valign="top">subtract</td>
1397 <td valign="top">Subtract the colors in the source image from the
1398 destination image. When transparency is involved transparent areas are
1399 subtracted, so only the opaque areas in the source remain opaque in
1400 the destination image. </td>
1401 </tr>
1402
1403 <tr valign="top">
1404 <td valign="top">difference</td>
1405 <td valign="top">Subtracts the darker of the two constituent colors from
1406 the lighter. Painting with white inverts the destination color.
1407 Painting with black produces no change.</td>
1408 </tr>
1409
1410 <tr valign="top">
1411 <td valign="top">exclusion</td>
1412 <td valign="top">Produces an effect similar to that of 'difference', but
1413 appears as lower contrast. Painting with white inverts the
1414 destination color. Painting with black produces no change.</td>
1415 </tr>
1416
1417 <tr valign="top">
1418 <td valign="top">darken</td>
1419 <td valign="top">Selects the darker of the destination and source colors.
1420 The destination is replaced with the source when the source is darker,
1421 otherwise it is left unchanged.</td>
1422 </tr>
1423
1424 <tr valign="top">
1425 <td valign="top">lighten</td>
1426 <td valign="top">Selects the lighter of the destination and source colors.
1427 The destination is replaced with the source when the source is
1428 lighter, otherwise it is left unchanged. </td>
1429 </tr>
1430
cristy83a272e2010-05-07 20:40:35 +00001431 </tbody>
1432</table>
1433
1434<p>Typically these use the default 'Over' alpha blending when transparencies
1435are also involved, except for 'Plus' which uses a 'plus' alpha blending.
1436This means the alpha channel is used to not only specify that all
1437non-transparent parts of the input image is visible, but also applied color
1438channel 'weighting' of the values. This also applied to the lighting
1439composition methods below. </p>
1440
1441<p>As of IM v6.6.1-6, if the special '<kbd>Sync</kbd>' flag is not specified
1442(enabled by default) with the <a href="#channel" >-channel</a> setting, then
1443the above mathematical compositions will nolonger syncronise its actiosn with
1444the alpha channel. Instead the math composition will be applied on an
1445individual channel basis as defined by the <a href="#channel" >-channel</a>.
1446this includes the alpha channel. </p>
1447
1448<p>This special usage allows you to perform mathematics between images. </p>
1449
1450
1451<p>The following lighting composition methods are also available. </p>
1452
1453<table class="doc">
1454 <tbody>
1455 <tr valign="top">
1456 <th align="left" style="width: 8%">Method</th>
1457 <th align="left">Description</th>
1458 </tr>
1459
cristy3ed852e2009-09-05 21:47:34 +00001460 <tr valign="top">
1461 <td valign="top">linear-dodge</td>
1462 <td valign="top">This is equivelent to 'Plus' in that the color channels
1463 are simply added, however it does not 'Plus' the alpha channel, but
1464 uses the normal 'Over' alpha blending, which transparencies are
1465 involved. Produces a sort of additive multiply-like result. Added
1466 ImageMagick version 6.5.4-3. </td>
1467 </tr>
1468
1469 <tr valign="top">
1470 <td valign="top">linear-burn</td>
1471 <td valign="top">As 'Linear-Dodge', but also subtract one from the result.
1472 Sort of a additive 'Screen' of the images. Added ImageMagick version
1473 6.5.4-3. </td>
1474 </tr>
1475
1476 <tr valign="top">
1477 <td valign="top">color-dodge</td>
1478 <td valign="top">Brightens the destination color to reflect the source
1479 color. Painting with black produces no change.</td>
1480 </tr>
1481
1482 <tr valign="top">
1483 <td valign="top">color-burn</td>
1484 <td valign="top">Darkens the destination color to reflect the source
1485 color. Painting with white produces no change. Fixed in ImageMagick
1486 version 6.5.4-3. </td>
1487 </tr>
1488
1489 <tr valign="top">
1490 <td valign="top">overlay</td>
1491 <td valign="top">Multiplies or screens the colors, dependent on the
1492 destination color. Source colors overlay the destination whilst
1493 preserving its highlights and shadows. The destination color is not
1494 replaced, but is mixed with the source color to reflect the lightness
1495 or darkness of the destination.</td>
1496 </tr>
1497
1498 <tr valign="top">
1499 <td valign="top">hard-light</td>
1500 <td valign="top">Multiplies or screens the colors, dependent on the source
1501 color value. If the source color is lighter than 0.5, the destination
1502 is lightened as if it were screened. If the source color is darker
1503 than 0.5, the destination is darkened, as if it were multiplied. The
1504 degree of lightening or darkening is proportional to the difference
1505 between the source color and 0.5. If it is equal to 0.5 the
1506 destination is unchanged. Painting with pure black or white produces
1507 black or white.</td>
1508 </tr>
1509
1510
1511 <tr valign="top">
1512 <td valign="top">linear-light</td>
1513 <td valign="top">Like 'Hard-Light' but using linear-dodge and linear-burn
1514 instead. Increases contrast slightly with an impact on the
1515 foreground's tonal values.</td>
1516 </tr>
1517
1518 <tr valign="top">
1519 <td valign="top">soft-light</td>
1520 <td valign="top">Darkens or lightens the colors, dependent on the source
1521 color value. If the source color is lighter than 0.5, the destination
1522 is lightened. If the source color is darker than 0.5, the destination
1523 is darkened, as if it were burned in. The degree of darkening or
1524 lightening is proportional to the difference between the source color
1525 and 0.5. If it is equal to 0.5, the destination is unchanged. Painting
1526 with pure black or white produces a distinctly darker or lighter area,
1527 but does not result in pure black or white. Fixed in ImageMagick
1528 version 6.5.4-3. </td>
1529 </tr>
1530
1531 <tr valign="top">
1532 <td valign="top">pegtop-light</td>
1533 <td valign="top">Almost equivelent to 'Soft-Light', but using a
1534 continuious mathematical formula rather than two conditionally
1535 selected formulae. Added ImageMagick version 6.5.4-3. </td>
1536 </tr>
1537
1538 <tr valign="top">
1539 <td valign="top">vivid-light</td>
1540 <td valign="top">A modified 'Linear-Light' designed to preserve very stong
1541 primary and secondary colors in the image. Added ImageMagick version
1542 6.5.4-3. </td>
1543 </tr>
1544
1545 <tr valign="top">
1546 <td valign="top">pin-light</td>
1547 <td valign="top">Similar to 'Hard-Light', but using sharp linear shadings,
1548 to similate the effects of a strong 'pinhole' light source. Added
1549 ImageMagick version 6.5.4-3. </td>
1550 </tr>
1551
1552 </tbody>
1553</table>
1554
1555
cristy83a272e2010-05-07 20:40:35 +00001556
cristy3ed852e2009-09-05 21:47:34 +00001557<p>Also included are these special purpose compose methods:</p>
1558
1559<table class="doc">
1560 <tbody>
1561 <tr valign="top">
1562 <th align="left" style="width: 8%">Method</th>
1563 <th align="left">Description</th>
1564 </tr>
1565
1566 <tr valign="top">
1567 <td valign="top">copy-*</td>
1568 <td valign="top">Copy the specified channel (Red, Green, Blue, Cyan,
1569 Magenta, Yellow, Black, or Opacity) in the source image to the
1570 same channel in the destination image. If the channel specified
1571 does not exist in the source image, (which can only happen for methods,
1572 '<kbd>copy-opacity</kbd>' or '<kbd>copy-black</kbd>') then it is
1573 assumed that the source image is a special grayscale channel image
1574 of the values to be copied. </td>
1575 </tr>
1576
1577 <tr valign="top">
1578 <td valign="top">change-mask</td>
1579 <td valign="top">Replace any destination pixel that is the similar to the source images pixel (as defined by the current <a href="#fuzz">-fuzz</a> factor), with transparency. </td>
1580 </tr>
1581 </tbody>
1582</table>
1583
1584<p>On top of these composed methods are a few special ones that not only require
1585the two images that are being merged or overlaid, but have some extra numerical
1586arguments, which are tabled below. </p>
1587
1588<p>In the "<code>composite</code>" command these composition methods are
1589selected using special options with the arguments needed. They are usually,
1590but not always, the same name as the composte 'method' they use, and replaces
1591the normal use of the <a href="#compose" >-compose</a> setting in the
1592"<code>composite</code>" command. For example... </p>
1593
1594<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>composite ... -blend 50x50 ...</span></p>
1595<p>As of IM v6.5.3-4 the "<code>convert</code>" command can now also supply
1596these extra arguments to its <a href="#composite" >-composite</a> operator,
1597using the special <a href="#set">-set</a> attribute of '<kbd class="arg">option:compose:args</kbd>'. This means you can now make use of
1598these special argumented <a href="#compose" >-compose</a> methods, those the
1599argument and the method both need to be set separatally. For example... </p>
1600
1601<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert ... -compose blend -set option:compose:args 50x50 -composite ...</span></p>
1602<p>The following is a table of these special 'argumented' compose methods,
1603with a brief summary of what they do. For more details see the equivalent
1604"composite" command option name. </p>
1605
1606<table class="doc">
1607 <tbody>
1608 <tr valign="top">
1609 <th align="left" style="width: 8%">Method</th>
1610 <th align="left">Description</th>
1611 </tr>
1612
1613 <tr valign="top">
1614 <td valign="top">dissolve</td>
1615 <td valign="top">Arguments:
1616 <em class="arg">src_percent</em>[x<em class="arg">dst_percent</em>]
1617 <br>Equivalent to "<code>composite</code>" <a href="#dissolve">-dissolve</a>
1618 <br>Dissolve the 'source' image by the percentage given before overlaying
1619 'over' the 'destination' image. If <em class="arg">src_percent</em> is
1620 greater than 100, it starts dissolving the main image so it will
1621 become transparent at a value of '<kbd class="arg">200</kbd>'. If
1622 both percentages are given, each image are dissolved to the
1623 percentages given.
1624 </td>
1625 </tr>
1626
1627 <tr valign="top">
1628 <td valign="top">blend</td>
1629 <td valign="top">Arguments:
1630 <em class="arg">src_percent</em>[x<em class="arg">dst_percent</em>]
1631 <br>Equivalent to "<code>composite</code>" <a href="#blend">-blend</a>
1632 <br>Average the images together ('plus') according to the percentages
1633 given and each pixels transparency. If only a single percentage value
1634 is given it sets the weight of the composite or 'source' image, while
1635 the background image is weighted by the exact opposite amount. That is
1636 a <kbd>-blend 30</kbd> merges 30% of the 'source' image with 70% of
1637 the 'destination' image. Thus it is equivalent to <kbd>-blend
1638 30x70</kbd>.
1639 </td>
1640 </tr>
1641
1642 <tr valign="top">
1643 <td valign="top">mathematics</td>
1644 <td valign="top">Arguments: <em class="arg">A, B, C, D</em>
1645 <br>Not available in "<code>composite</code>" at this time.
1646 <br>Merge the source and destination images according to the formula
1647 <br>&nbsp; &nbsp; &nbsp;<code>A*Sc*Dc + B*Sc + C*Dc + D</code>
1648 <br>Can be used to generate a custom composition method that would
1649 otherwise need to be implemented using the slow <a href="#fx">-fx</a>
1650 DIY image operator. Added to ImageMagick version 6.5.4-3.
cristy83a272e2010-05-07 20:40:35 +00001651 <br>As of IM v6.6.1-6 this method will do per-channel math compositions
1652 if the 'Sync' flag is removed from <a href="#channel" >-channel</a>,
1653 just like all the other mathematical compostion methods above.
cristy3ed852e2009-09-05 21:47:34 +00001654 </td>
1655 </tr>
1656
1657 <tr valign="top">
1658 <td valign="top">modulate</td>
1659 <td valign="top">Arguments:
1660 <em class="arg">brightness</em>[x<em class="arg">saturation</em>]
1661 <br>Equivalent to "<code>composite</code>" <a href="#watermark">-watermark</a>
1662 <br>Take a grayscale image (with alpha mask) and modify the destination
1663 image's brightness according to watermark image's grayscale value and
1664 the <em class="arg">brightness</em> percentage. The destinations
1665 color saturation attribute is just direct modified by the <em
1666 class="arg">saturation</em> percentage, which defaults to 100 percent
1667 (no color change).
1668
1669 </td>
1670 </tr>
1671
1672 <tr valign="top">
1673 <td valign="top">displace</td>
1674 <td valign="top">Arguments:
1675 <em class="arg">X-scale</em>[x<em class="arg">Y-scale</em>][!][%]
1676 <br>Equivalent to "<code>composite</code>" <a href="#displace">-displace</a>
1677 <br>With this option, the 'overlay' image, and optionally the 'mask'
1678 image, is used as a relative displacement map, which is used to
1679 displace the lookup of what part of the destination image is seen at
1680 each point of the overlaid area. Much like the displacement map is a
1681 'lens' that distorts the original 'background' image behind it.
1682 <br><br>
1683 The X-scale is modilated by the 'red' channel of the overlay image
1684 while the Y-scale is modulated by the green channel, (the mask image
1685 if given is rolled into green channel of the overlay image. This
1686 separation allows you to modulate the X and Y lookup displacement
1687 separatally allowing you to di 2 dimentional displacements, rather
1688 than 1 dimentional verctored displacements (using grayscale image).
1689 <br><br>
1690 If the overlay image contains transparency this is used as a mask
1691 of the resulting image to remove 'invalid' pixels.
1692 <br><br>
1693 The '%' flag makes the displacement scale relative to the size of the
1694 overlay image (100% = half width/height of image). Using '!' switches
1695 percentage arguments to refer to the destination image size instead.
1696 <br><br>
1697 Special flags were added Added to ImageMagick version 6.5.3-5.
1698 </td>
1699 </tr>
1700
1701 <tr valign="top">
1702 <td valign="top">distort</td>
1703 <td valign="top">Arguments:
1704 <em class="arg">X-scale</em>[x<em class="arg">Y-scale</em
1705 >[+<em class="arg">X-center</em>+<em class="arg">Y-center</em>]][!][%]
1706 <br>Not available in "<code>composite</code>" at this time.
1707 <br>Exactly as per 'Displace' (above), but using absolute coordinates,
1708 relative to the center of the overlay (or that given). Basically
1709 allows you to generate absolute distortion maps where 'black' will
1710 look up the left/top edge, and 'white' looks up the bottom/right
1711 edge of the destination image, according to the scale given.
1712 <br><br>
1713 The '!' flag not only switches percentage scaling, to use the
1714 destination image, but also the image the center offset of the lookup.
1715 This means the overlay can lookup a completely different region of the
1716 destination image.
1717 <br><br>
1718 Added to ImageMagick version 6.5.3-5.
1719 </td>
1720 </tr>
1721
1722 <tr valign="top">
1723 <td valign="top">blur</td>
1724 <td valign="top">Arguments:
1725 <em class="arg">Width</em>[x<em class="arg">Height</em
1726 >[+<em class="arg">Angle</em>]]
1727 <br>Equivalent to "<code>composite</code>"
1728 <a href="#blur-composite">-blur</a>
1729 <br>A Variable Blur Mapping Composition method, where each pixel in the
1730 overlaid region is replaced with an Elliptical Weighted Average (EWA),
1731 with an ellipse (typically a circle) of the given sigma size, scaled
1732 according to overlay (source image) grayscale mapping.
1733 <br><br>
1734 As per 'Displace' and 'Distort', the red channel will modulate the
1735 width of the ellipse, while the green channel will modulate the height
1736 of the ellipse. However at this time the ellipse angle is not
1737 modulated though this may be a future posibility (perhaps with a
1738 special flag to enable use of blur channel for this purpose).
1739 <br><br>
1740 Added to ImageMagick version 6.5.4-0.
1741 </td>
1742 </tr>
1743
1744 </tbody>
1745</table>
1746
cristy83a272e2010-05-07 20:40:35 +00001747<p>To print a complete list of all the available compose operators, use <a
1748href="#list">-list compose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00001749
1750
1751<div style="margin: auto;">
1752 <h4><a name="composite" id="composite"></a>-composite</h4>
1753</div>
1754
1755<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Perform alpha composition on the current image sequence.</td><td style='text-align:right;'></td></tr></table>
1756
1757<p>Take the first image 'destination' and overlay the second 'source' image
1758according to the current <a href="#compose">-compose</a> setting. The location
1759of the 'source' or 'overlay' image is controlled according to <a
1760href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1761settings. </p>
1762
1763<p>If a third image is given this is treated as a gray-scale 'mask' image
1764relative to the first 'destination' image. This mask will limit what parts of
1765the destination can be modified by the image composition. However for the
1766'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1767Y-displacement image instead. </p>
1768
1769<p>If a <a href="#compose">-compose</a> method requires extra numerical
1770arguments or flags these can be provided by setting the <a
1771href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
1772appropriatally for the compose method. </p>
1773
1774<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1775image outside the overlay area. You can disable this by setting the special <a
1776href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1777to '<kbd>false</kbd>'. </p>
1778
1779
1780<div style="margin: auto;">
1781 <h4><a name="compress" id="compress"></a>-compress <em class="arg">type</em></h4>
1782</div>
1783
1784<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>
1785
1786<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>
1787
1788<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1789
1790<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>
1791
1792<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>
1793
1794<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>
1795
1796<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>
1797
1798<div style="margin: auto;">
1799 <h4><a name="contrast" id="contrast"></a>-contrast</h4>
1800</div>
1801
1802<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>
1803
1804<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>
1805
1806<p>For a more pronounced effect you can repeat the option:</p>
1807
1808<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1809<div style="margin: auto;">
1810 <h4><a name="contrast-stretch" 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>
1811</div>
1812
1813<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>
1814
cristyd934d102009-10-10 12:55:13 +00001815<p>While performing the stretch, black-out at most <em
1816class="arg" >black-point</em> pixels and white-out at most <em
1817class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1818<em class="arg" >black-point %</em> pixels and white-out at most <em
1819class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001820
cristyd934d102009-10-10 12:55:13 +00001821<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1822>-contrast-stretch</a> will black-out at most <em class="arg"
1823>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1824minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1825class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1826>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001827
cristyd934d102009-10-10 12:55:13 +00001828<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1829the image's min and max values are stretched to 0 and <em class="QR"
1830>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1831clipping at either end. This is not the same as <a href="#normalize"
1832>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 2%x1%</kbd> (or
1833prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001834
cristyd934d102009-10-10 12:55:13 +00001835<p>Internally operator works by creating a histogram bin, and then uses that
1836bin to modify the image. As such some colors may be merged together when they
1837originally fell into the same 'bin'. </p>
1838
1839<p>All the channels are normalized in concert by the came amount so as to
1840preserve color integrity, when the default <a href="#channel" >+channel</a>
1841setting is in use. Specifing any other <a href="#channel" >-channel</a>
1842setting will normalize the RGB channels independently.</p>
1843
1844<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1845normalization of mathematical images. </p>
1846
1847<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001848
1849
1850<div style="margin: auto;">
1851 <h4><a name="convolve" id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
1852</div>
1853
1854<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>
1855
cristy16ff93c2010-01-13 23:18:07 +00001856<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001857a comma-separated list of integers (with no spaces), ordered left-to right,
1858starting with the top row. Presently, only odd-dimensioned kernels are
1859supported, and therefore the number of entries in the specified <em
1860class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
18617<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001862
cristyd934d102009-10-10 12:55:13 +00001863<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
1864positive and negative results are relative to a user-specified bias value.
1865This is important for non-HDRI compilations of ImageMagick when dealing with
1866convolutions that contain negative as well as positive values. This is
1867especially the case with convolutions involving high pass filters or edge
1868detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001869</p>
1870
cristyd934d102009-10-10 12:55:13 +00001871<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
1872negative results without clipping to the color value range (0..QuantumRange).
1873See the discussion on HDRI implementations of ImageMagick on the page <a
1874href="/www/high-dynamic-range.html">High
1875Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1876href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1877<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1878entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001879
cristy3ed852e2009-09-05 21:47:34 +00001880
1881<div style="margin: auto;">
1882 <h4><a name="crop" id="crop"></a>-crop <em class="arg">geometry</em></h4>
1883</div>
1884
1885<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>
1886
1887<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>
1888
1889<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>
1890
1891<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>
1892
1893<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>
1894
1895<p>By adding a exclamation character flag to the geometry argument, the
1896cropped images virtual canvas page size and offset is set as if the
1897geometry argument was a viewport or window. This means the canvas page size
1898is set to exactly the same size you specified, the image offset set
1899relative top left corner of the region cropped. </p>
1900
1901<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1902special single pixel transparent 'missed' image is returned, and a 'crop
1903missed' warning given. </p>
1904
cristy739df912009-10-24 16:10:18 +00001905<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 +00001906
1907<div style="margin: auto;">
1908 <h4><a name="cycle" id="cycle"></a>-cycle <em class="arg">amount</em></h4>
1909</div>
1910
1911<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>
1912
1913<p><em class="arg">Amount</em> defines the number of positions each
1914colormap entry is shifted.</p>
1915
1916
1917<div style="margin: auto;">
1918 <h4><a name="debug" id="debug"></a>-debug <em class="arg">events</em></h4>
1919</div>
1920
1921<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>
1922
1923<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>
1924
1925
1926<p>For example, to log cache and blob events, use.</p>
1927
1928<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1929<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1930
1931<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1932
1933<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1934
1935<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1936
1937<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>
1938
1939
1940<div style="margin: auto;">
1941 <h4><a name="decipher" id="decipher"></a>-decipher <em class="arg">filename</em></h4>
1942</div>
1943
1944<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>
1945
1946<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1947
1948<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1949
1950
1951<div style="margin: auto;">
1952 <h4><a name="deconstruct" id="deconstruct"></a>-deconstruct</h4>
1953</div>
1954
1955<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>
1956
1957<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>
1958
1959<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>
1960
1961<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1962
1963
1964<div style="margin: auto;">
1965 <h4><a name="define" id="define"></a>-define <em class="arg">key</em>{<em class="arg">=value</em>}<em class="arg">...</em></h4>
1966</div>
1967
1968<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>add coder/decoder specific options.</td><td style='text-align:right;'></td></tr></table>
1969
1970<p>This option creates one or more definitions for coders and decoders to use while reading and writing image data. Definitions may be passed to coders and decoders to control options that are specific to certain image formats. If <em class="arg">value</em> is missing for a definition, an empty-valued definition of a flag is created with that name. This used to control on/off options. Use <a href="#define">+define key</a> to remove definitions previously created. Use <a href="#define">+define "*"</a> to remove all existing definitions.</p>
1971
1972<p>The following definitions may be created:</p>
1973
1974<ul>
cristy045bd902010-01-30 18:56:24 +00001975<dt>dcm:display-range=reset</dt>
1976 <dd>Set the display range to the minimum and maximum pixel values for the DCM image format.</dd><br />
1977<dt>dot:layout-engine=<em class="arg">value</em></dt>
1978 <dd>Set the specify the layout engine for the DOT image format (e.g. <kbd>neato</kbd>).</dd><br />
1979<dt>jpeg:extent=<em class="arg">value</em></dt>
cristy7396d882010-01-27 02:37:56 +00001980 <dd>Restrict the maximum JPEG file size, for example <kbd>-define jpeg:extent=400kb</kbd>.</dd><br />
cristy045bd902010-01-30 18:56:24 +00001981<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristy48dd1af2009-10-02 01:21:56 +00001982 <dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128. It is most useful for increasing performance and reducing the memory requirements when reducing the size of a large JPEG image.</dd><br />
cristy045bd902010-01-30 18:56:24 +00001983<dt>jp2:rate=<em class="arg">value</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00001984 <dd>Specify the compression factor to use while writing JPEG-2000 files. The compression factor is the reciprocal of the compression ratio. The valid range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined, this value overrides the -quality setting. A quality setting of 75 results in a rate value of 0.06641.</dd><br />
1985<dt>mng:need-cacheoff</dt>
1986 <dd>turn playback caching off for streaming MNG.</dd><br />
cristy045bd902010-01-30 18:56:24 +00001987<dt>png:bit-depth=<em class="arg">value</em></dt>
1988<dt>png:color-type=<em class="arg">value</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00001989 <dd>desired bit-depth and color-type for PNG output. You can force the PNG encoder to use a different bit-depth and color-type than it would have normally selected, but only if this does not cause any loss of image quality. Any attempt to reduce image quality is treated as an error and no PNG file is written. E.g., if you have a 1-bit black-and-white image, you can use these "defines" to cause it to be written as an 8-bit grayscale, indexed, or even a 64-bit RGBA. But if you have a 16-million color image, you cannot force it to be written as a grayscale or indexed PNG. If you wish to do this, you must use the appropriate <a href="#depth">-depth</a>, <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to reduce the image quality prior to using the PNG encoder. Note that in indexed PNG files, "bit-depth" refers to the number of bits per index, which can range from 1 to 8. In such files, the color samples always have 8-bit depth.</dd><br />
1990<dt>ps:imagemask</dt>
cristy045bd902010-01-30 18:56:24 +00001991 <dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create Postscript files that render bilevel images with the Postscript imagemask operator instead of the image operator.</dd><br />
1992<dt>quantum:format=<em class="arg">type</em></dt>
1993 <dd>Set the type to <kbd>floating-point</kbd> to specify a single precision floating-point format for raw files (e.g. GRAY:).</dd>
cristy3ed852e2009-09-05 21:47:34 +00001994</ul>
1995
1996<p>For example, to create a postscript file that will render only the black pixels of a bilevel image, use:</p>
1997
1998<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bilevel.tif -define ps:imagemask eps3:stencil.ps</span></p>
1999<p>Set attributes of the image registry by prefixing the value with <kbd>registry:</kbd>. For example, to set a temporary path to put work files, use:</p>
2000
2001<p class="crtsnip">
2002-define registry:temporary-path=/data/tmp
2003</p>
2004
2005<div style="margin: auto;">
2006 <h4><a name="delay" 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>
2007</div>
2008
2009<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>
2010
2011<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>
2012
2013<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>
2014
2015
2016<div style="margin: auto;">
2017 <h4><a name="delete" id="delete"></a>-delete <em class="arg">index</em></h4>
2018</div>
2019
2020<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>
2021
2022<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>
2023
2024
2025<div style="margin: auto;">
2026 <h4><a name="density" id="density"></a>-density <em class="arg">width</em><br />-density <em class="arg">width</em>x<em class="arg">height</em></h4>
2027</div>
2028
2029<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>
2030
2031<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>
2032
2033<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>
2034
2035<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>
2036
2037<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>
2038
2039<div style="margin: auto;">
2040 <h4><a name="depth" id="depth"></a>-depth <em class="arg">value</em></h4>
2041</div>
2042
2043<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>
2044
2045<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>
2046
2047<div style="margin: auto;">
2048 <h4><a name="descend" id="descend"></a>-descend</h4>
2049</div>
2050
2051<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>
2052
2053<div style="margin: auto;">
2054 <h4><a name="deskew" id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
2055</div>
2056
2057<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>
2058
2059<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>
2060
2061<div style="margin: auto;">
2062 <h4><a name="despeckle" id="despeckle"></a>-despeckle</h4>
2063</div>
2064
2065<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>
2066
2067<div style="margin: auto;">
cristy2c839602010-04-03 02:32:08 +00002068 <h4><a name="direction" id="direction"></a>-direction <em class="arg">type</em></h4>
2069</div>
2070
2071<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>
2072
2073<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00002074 <h4><a name="displace" 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>
2075</div>
2076
2077<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>
2078
2079<p>With this option, the 'overlay' image, and optionally the 'mask' image,
2080will be used as a displacement map, which is used to displace the lookup of
2081what part of the 'background' image is seen at each point of the overlaid
2082area. Much like the displacement map is a 'lens' that redirects light shining
2083through it so as to present a distorted view the original 'background' image
2084behind it. </p>
2085
2086<p>Any perfect grey areas of the displacement map produce a zero
2087displacement of the image. Black areas produce the given maximum negative
2088displacement of the lookup point, while white produce a maximum positive
2089displacement of the lookup. </p>
2090
2091<p>Note that it is the lookup of the 'background' that is displaced, not a
2092displacement of the image itself. As such an area of the displacement map
2093containing 'white' will have the lookup point 'shifted' by a positive amount,
2094and thus generating a copy of the destination image to the right/downward from
2095the correct position. That is the image will look like it may have been
2096'shifted' in a negative left/upward direction. Understanding this is a very
2097important in understanding how displacement maps work. </p>
2098
2099<p>The given arguments define the maximum amount of displacement in pixels
2100that a particular map can produce. If the displacement scale is large enough
2101it is also posible to lookup parts of the 'background' image that lie well
2102outside the bounds of the displacement map itself. That is you could very
2103easilly copy a section of the original image from outside the overlay area
2104into the overlay area. </p>
2105
2106<p>The '%' flag makes the displacement scale relative to the size of the
2107overlay image (100% = half width/height of image). Using '!' switches
2108percentage arguments to refer to the destination image size instead.
2109these flags were added as of IM v6.5.3-5.</p>
2110
2111<p>Normally a single grayscale displacement map is provided, which with the
2112given scaling values will determine a single direction (vector) in which
2113displacements can occur (positivally or negativally). However, if you also
2114specify a third image which is normally used as a <em class="arg">mask</em>,
2115then the <em class="arg">composite image</em> will be used for horizontal X
2116displacement, while the <em class="arg">mask image</em> is used for vertical Y
2117displacement. This allows you to define completely different displacement
2118values for the X and Y directions, and allowing you to lookup any point within
2119the <em class="arg">scale</em> bounds. In other words each pixel can lookup
2120any other nearby pixel, producing complex 2 dimentional displacements, rather
2121than a simple 1 dimentional vector displacements. </p>
2122
2123<p>Alternativally rather than suppling two separate images, as of IM v6.4.4-0,
2124you can use the 'red' channel of the overlay image to specify the horizontal
2125or X displacement, and the 'green' channel for the vertical or Y displacement.
2126</p>
2127
2128<p>As of IM v6.5.3-5 any alpha channel in the overlay image will be used as a
2129mask the transparency of the destination image. However areas outside the
2130overlaid areas will not be effected. </p>
2131
2132
2133<div style="margin: auto;">
2134 <h4><a name="display" id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
2135</div>
2136
2137<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>
2138
2139<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
2140
2141<div style="margin: auto;">
2142 <h4><a name="dispose" id="dispose"></a>-dispose <em class="arg">method</em></h4>
2143</div>
2144
2145<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>
2146
2147<p>The layer disposal method defines the way each the displayed image is to be
2148modified after the current 'frame' of an animation has finished being
2149displayed (after its 'delay' period), but before the next frame on an
2150animation is to be overlaid onto the display. </p>
2151
2152<p>Here are the valid methods:</p>
2153
2154<pre class="text">
2155Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
2156None 1 Do not dispose, just overlay next frame image.
2157Background 2 Clear the frame area with the background color.
2158Previous 3 Clear to the image prior to this frames overlay.
2159</pre>
2160
2161<p>You can also use the numbers given above, which is what the GIF format
2162uses internally to represent the above settings. </p>
2163
2164<p>To print a complete list of dispose methods, use <a href="#list">-list dipose</a>.</p>
2165
2166<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
2167resetting the layer disposal methods of images being read in. </p>
2168
2169<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
2170disposal method for images already in memory.</p>
2171
2172<div style="margin: auto;">
2173 <h4><a name="dissimilarity-threshold" id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
2174</div>
2175
2176<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>
2177
2178
2179<div style="margin: auto;">
2180 <h4><a name="dissolve" id="dissolve"></a>-dissolve <em class="arg">src_percent</em>[x<em class="arg">dst_percent</em>]</h4>
2181</div>
2182
2183<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>
2184
2185<p>The opacity of the composite image is multiplied by the given percent, then
2186it is composited 'over' the main image. If <em class="arg">src_percent</em>
2187is greater than 100, start dissolving the main image so it will become
2188transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
2189are given, each image are dissolved to the percentages given. </p>
2190
2191<p>Note that dissolve percentages do not add, two opaque images dissolved
2192'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2193images, you would need to use dissolve values of '50,100'. </p>
2194
2195<div style="margin: auto;">
2196 <h4><a name="distort" id="distort"></a>-distort <em class="arg">method arguments</em></h4>
2197</div>
2198
2199<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>
2200
2201<p>The <em class="arg">arguments</em> is a single string containing a list
2202of floating point numbers separated by commas or spaces. The number of
2203and meaning of the floating point values depends on the distortion <em
2204class="arg">method</em> being used. </p>
2205
2206<p>Choose from these distortion types:</p>
2207
2208<table class="doc">
2209 <tr valign="top">
2210 <th align="left" style="width: 8%">Method</th>
2211 <th align="left">Description</th>
2212 </tr>
2213
2214 <tr valign="top">
2215 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
2216 <br/>or &nbsp; <kbd>SRT</kbd></td>
2217 <td valign="top">
2218 Distort image by first scaling and rotating about a given 'center',
2219 before translating that 'center' to the new location, in that order. It
2220 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
2221 distortion, but without shearing effects. It also provides a good way
2222 of rotating and displacing a smaller image for tiling onto a larger
2223 background (IE 2-dimensional animations). <br/>
2224
2225 The number of arguments determine the specific meaning of each
2226 argument for the scales, rotation, and translation operations. <br/>
2227
2228 <table style="margin-left:auto; margin-right:auto;">
2229 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
2230 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
2231 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
2232 <tr><td>3:</td><td><em>ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2233 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
2234 <tr><td>5:</td>
2235 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2236 <tr><td>6:</td>
2237 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
2238 <tr><td>7:</td>
2239 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
2240 &nbsp; NewX,NewY</em></td></tr>
2241 </table>
2242
2243 This is actually an alternative way of specifing a 2 dimensional linear
2244 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2245
2246 <tr valign="top">
2247 <td valign="top"><kbd>Affine</kbd></td>
2248 <td valign="top">
2249 Distort the image linearly by moving a list of at least 3 or more sets
2250 of control points (as defined below). Idealy 3 sets or 12 floating
2251 point values are given allowing the image to be linearly scaled,
2252 rotated, sheared, and translated, according to those three points. See
2253 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2254 distortions. <br/>
2255
2256 More than 3 sets given control point pairs (12 numbers) is least
2257 squares fitted to best match a lineary affine distortion. If only 2
2258 control point pairs (8 numbers) are given a two point image translation
2259 rotation and scaling is performed, without any posible shearing,
2260 flipping or changes in aspect ratio to the resulting image. If only one
2261 control point pair is provides the image is only translated, (which may
2262 be a floating point non-integer translation). <br/>
2263
2264 This distortion does not include any form of perspective distortion.
2265 </td>
2266
2267 </tr>
2268
2269 <tr valign="top">
2270 <td valign="top"><kbd>AffineProjection</kbd></td>
2271 <td valign="top">
2272 Linearly distort an image using the given Affine Matrix of 6
2273 pre-calculated coefficients forming a set of Affine Equations to map
2274 the source image to the destination image.
2275
2276 <div style="text-align: center"><em>
2277 s<sub>x</sub>, r<sub>x</sub>,
2278 r<sub>y</sub>, s<sub>y</sub>,
2279 t<sub>x</sub>, t<sub>y</sub>
2280 </em></div>
2281
2282 See <a href="#affine" >-affine</a> setting for more detail, and
2283 meanings of these coefficients. <br/>
2284
2285 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
2286 alternative methods of defining this distortion, with ImageMagick doing the
2287 calculations needed to generate the required coefficients. You can see
2288 the internally generated coefficients, by using a <a href="#verbose"
2289 >-verbose</a> setting. </td>
2290
2291 </tr>
2292
2293<!-- still under development, do not display - Anthony
2294 <tr valign="top">
2295 <td valign="top"><kbd>Bilinear</kbd></td>
2296 <td valign="top">
2297 Bilinear (reversed) Distortion, given a minimum of 4 sets of
2298 coordinate pairs, or 16 values (see below). Not that lines may not
2299 appear straight after distortion, though the distance between
2300 coordinates will remain consistant. </td>
2301 </tr>
2302-->
2303
2304 <tr valign="top">
2305 <td valign="top"><kbd>Perspective</kbd></td>
2306 <td valign="top">
2307 Perspective distort the images, using a list of 4 or more sets of
2308 control points (as defined below). More that 4 sets (16 numbers) of
2309 control points provide least squares fitting for more accurate
2310 distortions (for the purposes of image registration and panarama
2311 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2312 linear distortion. <br/>
2313
2314 Perspective Distorted images ensures that straight lines remain
2315 straight, but the scale of the distorted image will vary. The horizon
2316 is anti-aliased, and the 'sky' color may be set using the
2317 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2318 </tr>
2319
2320 <tr valign="top">
2321 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2322 <td valign="top">
2323 Do a '<kbd>Perspective</kbd>' distortion basied on a set of 8
2324 pre-calculated coefficients. You can get these coefficients by looking
2325 at the <a href="#verbose" >-verbose</a> output of a
2326 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2327 If the last two perspective scaling coefficients are zero, the
2328 remaining 6 represents a transposed 'Affine Matrix'. </td>
2329
2330 </tr>
2331
2332 <tr valign="top">
2333 <td valign="top"><kbd>Arc</kbd></td>
2334 <td valign="top">
2335 Arc the image (variation of polar mapping) over the angle given around
2336 a circle. <br/>
2337 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2338 <tr valign="top"><td>Argument</td>
2339 <td>Meaning</td></tr>
2340 <tr valign="top"><td><em>arc_angle</em></td>
2341 <td>The angle over which to arc the image side-to-side</td></tr>
2342 <tr valign="top"><td><em>rotate_angle</em></td>
2343 <td>Angle to rotate resulting image from vertical center</td></tr>
2344 <tr valign="top"><td><em>top_radius</em></td>
2345 <td>Set top edge of source image at this radius</td></tr>
2346 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2347 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2348 </table>
2349
2350 The resulting image is always resized to best fit the resulting image,
2351 (as if using <a href="#distort" >+distort</a>) while attempting to
2352 preserve scale and aspect ratio of the original image as much as
2353 possible with the arguments given by the user. All four arguments will
2354 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2355
2356 This a variation of a polar distortion designed to try to preserve the
2357 aspect ratio of the image rather than direct Cartesian to Polar
2358 conversion. </td>
2359 </tr>
2360
2361 <tr valign="top">
2362 <td valign="top"><kbd>Polar</kbd></td>
2363 <td valign="top">
2364 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2365 the image. that is the height of the input image is mapped to the
2366 radius limits, while the width is wrapped around between the
2367 angle limits. <br/>
2368
2369 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2370
2371 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2372 center to the center of the image, and the angles going from -180 (top)
2373 to +180 (top). If <em>Rmax</em> is given the special value of
2374 '<code>0</code>', the the distance from the center to the nearest edge
2375 is used for the radius of the output image, which will ensure the whole
2376 image is visible (though scaled smaller). However a special value of
2377 '<code>-1</code>' will use the distance from the center to the furthest
2378 corner, This may 'clip' the corners from the input rectangular image,
2379 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2380 the same arguments. <br/>
2381
2382 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2383 output image center will default to <code>0,0</code> of the virtual
2384 canvas, and the image size adjusted to ensure the whole input image is
2385 made visible in the output image on the virtual canvas. </td>
2386
2387 </tr>
2388
2389 <tr valign="top">
2390 <td valign="top"><kbd>DePolar</kbd></td>
2391 <td valign="top">
2392 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2393 but generates the reverse Polar to Cartesian distortion. <br/>
2394
2395 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2396 the corners of the input image. However using the special
2397 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2398 distance) will ensure the whole distorted image is preserved in the
2399 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2400 reverse the distortion re-producing the original.
2401
2402 Note that as this distortion requires the area resampling of a circular
2403 arc, which can not be handled by the builtin EWA resampling function.
2404 As such the normal EWA filters are turned off. It is recomended some
2405 form of 'super-sampling' image processing technique be used to produce
2406 a high quality result. </td>
2407
2408 </tr>
2409
2410 <tr valign="top">
2411 <td valign="top"><kbd>Barrel</kbd></td>
2412 <td valign="top">
2413 Given the four coefficients (A,B,C,D) as defined by <a
2414 href="http://www.all-in-one.ee/~dersch/barrel/barrel.html" >Helmut
2415 Dersch</a>, perform a barrell or pincussion distortion appropriate to
2416 correct radial lens distortions. That is in photographs, make straight
2417 lines straight again. <br/>
2418
2419 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2420 <em>X</em> , <em>Y</em> ] ] <br/>
2421 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2422 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2423 [ <em>X</em> , <em>Y</em> ] <br/>
2424 So that it forms the function <br/>
2425 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2426 <em>C</em>*r + <em>D</em> )<br/>
2427
2428 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2429 (defaulting to the center of the image). <br/>
2430 The second form is typically used to distort images, rather than
2431 correct lens distortions. <br/>
2432 </td>
2433
2434 </tr>
2435
2436 <tr valign="top">
2437 <td valign="top"><kbd>BarrelInverse</kbd></td>
2438 <td valign="top">
2439 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2440 arguments, and argument handling. However it uses the inverse
2441 of the radial polynomial,
2442 so that it forms the function <br/>
2443 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2444 <em>C</em>*r + <em>D</em> )
2445 </td>
2446 </tr>
2447
2448 <tr valign="top">
2449 <td valign="top"><kbd>Shepards</kbd></td>
2450 <td valign="top">
2451 Distort the given list control points (any number) using an Inverse
2452 Squared Distance Interpolation Method (<a
2453 href="http://www.ems-i.com/smshelp/Data_Module/Interpolation/Inverse_Distance_Weighted.htm"
2454 >Shepards Method</a>). The control points in effect do 'localized'
2455 distortions of the image around the given control point. For best
2456 results extra control points should be added to 'lock' the positions of
2457 the corners and other unchanging parts of the image. <br/>
2458
2459 The distortion has been likened to 'taffy pulling' using nails, pins or
2460 sticks. It basically uses the <a href="#sparse-color"
2461 >-sparse-color</a> method of the same name to generate separate X and Y
2462 displacement maps (see <a href="#displace" >-displace</a>) for source
2463 image color look-up. </td>
2464
2465 </tr>
2466
2467</table>
2468
2469<p>To print a complete list of distortion methods, use <a href="#list">-list distort</a>.</p>
2470
2471<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2472'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2473defining how these points in the given image should be distorted in the
2474destination image. Each set of four floating point values represent a source
2475image coordinate, followed immediately by the destination image coordinate.
2476This produces a list of values such as...</p>
2477<div style="text-align: center"><em>
2478 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2479 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2480 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2481 ... &nbsp;
2482 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2483</em></div>
2484<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2485destination image. </p>
2486
2487<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2488needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2489perspective distortion of the built-in "rose:" image. Note how spaces were
2490used to group the 4 sets of coordinate pairs, to make it easier to read and
2491understand.</p>
2492
2493<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2494 convert rose: -virtual-pixel black \ <br/>
2495 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \ <br/>
2496 rose_3d_rotated.gif</span></p>
2497<p>If more that the required number of coordinate pairs are given for a
2498distortion, the distortion method is 'least squares' fitted to
2499produce the best result for all the coordinate pairs given. If less than the
2500ideal number of points are given, the distort will generally fall back to a
2501simpler form of distortion that can handles the smaller number of coordinates
2502(usally a linear '<kbd>Affine</kbd>' distortion). </p>
2503
2504<p>By using more coodinates you can make use of image registration tool to
2505find matching coordinate pairs in overlaping images, so as to improve the 'fit'
2506of the distortion. Of course a bad coordinate pair can also make the 'fit'
2507worse. Caution is always advised. </p>
2508
2509<p>Colors are acquired from the source image according to the <a
2510href="#interpolate" >-interpolate</a> color lookup setting, when the image is
2511magnified. However if the viewed image is minified (image becomes smaller), a
2512special area resampling function (added ImageMagick v6.3.5-9), is used to
2513produce a higher quality image. For example you can use a
2514'<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all the
2515way to the horizon. </p>
2516
2517<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \ <br/>
2518 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \ <br/>
2519 checks_tiled.jpg</span></p>
2520<p>Note that a infinitely tiled perspective images involving the horizon can
2521be very slow to generate due to the use of the high quality 'area resampling'
2522function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2523using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2524(recommended if you plan to use super-sampling instead). </p>
2525
2526<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2527'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2528will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2529pixels. If you do not what these pixels to be visible, set the color to match
2530the rest of the ground. </p>
2531
2532<p>The output image size will by default be the same as the input image. This
2533means that if the part of the distorted image falls outside the viewed area of
2534the 'distorted space', those parts is clipped and lost. However if you
2535use the plus form of the operator (<a href="#distort" >+distort</a>) the
2536operator will attempt (if posible) to show the whole of the distorted image,
2537while retaining a correct 'virtual canvas' offset, for image layering. This
2538offset may need to be removed using <a href="#repage" >+repage</a>, to remove
2539if it is unwanted. </p>
2540
2541<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2542option:distort:viewport {geometry_string}</kbd>" setting which will specify
2543the size and the offset of the generated 'viewport' image of the distorted
2544image space.</p>
2545
2546<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2547{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2548that factor without changing the viewed contents of the distorted image. This
2549can be used either for 'super-sampling' the image for a higher quality result,
2550or for panning and zooming around the image (with appropriate viewport
2551changes, or post-distort cropping and resizing). </p>
2552
2553<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2554href="#distort" >-distort</a> to attempt to output the internal coefficients,
2555and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2556and debugging purposes. This many not be available for all distorts. </p>
2557
2558<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2559produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2560and/or <a href="#shear" >-shear</a> operation, with more control of due to the
2561above settings. It is algorithmically slower, though in ImageMagick it may be faster.
2562</p>
2563
2564
2565<div style="margin: auto;">
2566 <h4><a name="dither" id="dither"></a>-dither <em class="arg">method</em></h4>
2567</div>
2568
2569<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>
2570
2571<p>Dithering places two or more colors in neighbouring 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>
2572
2573<p>Dithering is turned on by default, to turn it off use the plus form of the
2574setting, <a href="#dither">+dither</a>. This will also also render PostScript
2575without text or graphic aliasing. Disabling dithering often (but not always)
2576leads to faster process, a smaller number of colors, but more cartoon like
2577image coloring. Generally resulting in 'color banding' effects in areas with
2578color gradients. </p>
2579
2580<p>The color reduction operators <a href="#colors">-colors</a>, <a
2581href="#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>
2582
2583<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>
2584
2585
2586<div style="margin: auto;">
2587 <h4><a name="draw" id="draw"></a>-draw <em class="arg">string</em></h4>
2588</div>
2589
2590<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>
2591
2592<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>
2593
2594<p>The shape primitives:</p>
2595
2596<pre class="text">
2597 point x,y
2598 line x0,y0 x1,y1
2599 rectangle x0,y0 x1,y1
2600 roundRectangle x0,y0 x1,y1 wc,hc
2601 arc x0,y0 x1,y1 a0,a1
2602 ellipse x0,y0 rx,ry a0,a1
2603 circle x0,y0 x1,y1
2604 polyline x0,y0 ... xn,yn
2605 polygon x0,y0 ... xn,yn
2606 bezier x0,y0 ... xn,yn
2607 path path specification
2608 image operator x0,y0 w,h filename
2609</pre>
2610
2611<p>The text primitive:</p>
2612
2613<pre class="text">
2614 text x0,y0 string
2615</pre>
2616<p>The text gravity primitive:</p>
2617
2618<pre class="text">
2619 gravity NorthWest, North, NorthEast, West, Center,
2620 East, SouthWest, South, or SouthEast
2621</pre>
2622
2623<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>
2624
2625<p>The transformation primitives:</p>
2626
2627<pre class="text">
2628 rotate degrees
2629 translate dx,dy
2630 scale sx,sy
2631 skewX degrees
2632 skewY degrees
2633</pre>
2634
2635<p>The pixel operation primitives:</p>
2636
2637<pre class="text">
2638 color x0,y0 method
2639 matte x0,y0 method
2640</pre>
2641
2642<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>
2643
2644<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>
2645
2646<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2647
2648<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2649
2650<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>
2651
2652<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2653
2654<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>
2655
2656<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>
2657
2658<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>.
2659</p>
2660
2661<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2662
2663<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2664
2665<p class="crtsnip">
2666 -draw 'circle 100,100 150,150'
2667</p>
2668
2669<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
2670draw 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>
2671
2672<p class="crtsnip">
2673 -draw 'bezier 20,50 45,100 45,0 70,50'
2674</p>
2675<p class="crtsnip">
2676 -draw 'bezier 70,50 95,100 95,0 120,50'
2677</p>
2678
2679
2680<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>
2681
2682<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>
2683
2684<p class="crtsnip">
2685 -draw 'image SrcOver 100,100 225,225 image.jpg'
2686</p>
2687
2688<p>You can use 0,0 for the image size, which means to use the actual dimensions found in the image header. Otherwise, it is scaled to the given dimensions. See <a href="#compose">-compose</a> for a description of the composite operators.</p>
2689
2690<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>
2691
2692<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2693
2694<p class="crtsnip">
2695 -draw 'text 100,100 "Works like magick!"'
2696</p>
2697
2698<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2699
2700<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>
2701
2702<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2703
2704<p>The <kbd>scale</kbd> primitive scales them.</p>
2705
2706<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>
2707
2708<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
2709matrix.</p>
2710
2711<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>
2712
2713<pre class="text">
2714 point
2715 replace
2716 floodfill
2717 filltoborder
2718 reset
2719</pre>
2720
2721<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>
2722
2723<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>
2724
2725<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>
2726
2727<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2728
2729<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2730
2731
2732<div style="margin: auto;">
2733 <h4><a name="edge" id="edge"></a>-edge <em class="arg">radius</em></h4>
2734</div>
2735
2736<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>
2737
2738<div style="margin: auto;">
2739 <h4><a name="emboss" id="emboss"></a>-emboss <em class="arg">radius</em></h4>
2740</div>
2741
2742<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>
2743
2744<div style="margin: auto;">
2745 <h4><a name="encipher" id="encipher"></a>-encipher <em class="arg">filename</em></h4>
2746</div>
2747
2748<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>
2749
2750<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2751
2752<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2753
2754<div style="margin: auto;">
2755 <h4><a name="encoding" id="encoding"></a>-encoding <em class="arg">type</em></h4>
2756</div>
2757
2758<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>
2759
2760<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>
2761
2762<div style="margin: auto;">
2763 <h4><a name="endian" id="endian"></a>-endian <em class="arg">type</em></h4>
2764</div>
2765
2766<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>
2767
2768<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2769
2770<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2771
2772
2773<div style="margin: auto;">
2774 <h4><a name="enhance" id="enhance"></a>-enhance</h4>
2775</div>
2776
2777<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>
2778
2779
2780<div style="margin: auto;">
2781 <h4><a name="equalize" id="equalize"></a>-equalize</h4>
2782</div>
2783
2784<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>
2785
2786<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>
2787
2788<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2789
2790<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>
2791
2792<div style="margin: auto;">
2793 <h4><a name="evaluate" id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
2794</div>
2795
2796<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>
2797
2798<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>
2799
2800<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>
2801
2802<table class="doc">
2803 <col width="25%" />
2804 <col width="75%" />
2805 <thead>
2806 <tr>
2807 <th><em class="arg">operator</em></th>
2808 <th>Summary (see further below for details)</th>
2809 </tr>
2810 </thead>
2811 <tbody>
2812
2813 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2814 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2815 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2816 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2817 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
2818 <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>
2819 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2820 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002821 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002822 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2823 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2824 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2825 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2826 <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>
2827 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2828 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2829 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2830 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2831
2832 <tr><td>&nbsp;</td></tr>
2833
2834 <tr><td>Gaussian-noise</td></tr>
2835 <tr><td>Impulse-noise</td></tr>
2836 <tr><td>Laplacian-noise</td></tr>
2837 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2838 <tr><td>PoissonNoise</td></tr>
2839 <tr><td>Uniform-noise</td></tr>
2840
2841 <tr><td>&nbsp;</td></tr>
2842
2843 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2844 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2845 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2846 </tbody>
2847 </table>
2848
2849<p>The specified functions are applied only to each previously set <a
2850href="#channel" >-channel</a> in the image. If necessary, the results of the
2851calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2852class="QR">QuantumRange</em>]. The transparency channel of the image is
2853represented as a 'alpha' values (0 = fully transparent), so, for example, a
2854<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2855semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2856as a percentage of the <em class="QR">QuantumRange</em>.</p>
2857
2858<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2859<a href="#list">-list evaluate</a>.</p>
2860
2861<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2862<kbd>Multiply</kbd> methods can also be achieved using either the <a
2863href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2864appropriate argument, to linearly modify the overall range of color values.
2865Please note, however, that <a href="#level" >-level</a> treats transparency as
2866'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2867'alpha' values.</p>
2868
2869<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>
2870
2871<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>
2872
2873 <div style="text-align:center;">
2874 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2875 </div>
2876
2877<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2878normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2879href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2880to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2881with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2882with <kbd>Pow</kbd>.</p>
2883
2884<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2885converts the image values into a value according to a (co)sine wave function.
2886The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2887is biased 50% and normalized by 50% so as to fit in the respective color value
2888range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2889function (its frequency), and thus determines the number of 'waves' that will
2890be generated over the input color range. For example, if the <em
2891class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2892class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2893then the effective period is the <em>half</em> the <em
2894class="QR">QuantumRange</em>.
2895
2896 <div style="text-align:center;">
2897 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2898 </div>
2899
2900See also the <a href="#function" >-function</a> operator, which is a
2901multi-value version of evaluate. </P>
2902
cristy63fed272010-03-07 19:08:45 +00002903<div style="margin: auto;">
2904 <h4><a name="evaluate-sequence" id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
2905</div>
2906
2907<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 +00002908
2909<div style="margin: auto;">
2910 <h4><a name="extent" id="extent"></a>-extent <em class="arg">geometry</em></h4>
2911</div>
2912
2913<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>
2914
cristy3e2860c2010-01-24 01:36:30 +00002915<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>
cristy3ed852e2009-09-05 21:47:34 +00002916
2917<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>
2918
2919<div style="margin: auto;">
2920 <h4><a name="extract" id="extract"></a>-extract <em class="arg">geometry</em></h4>
2921</div>
2922
2923<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>
2924
2925<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2926
cristy4949d522010-03-12 18:41:34 +00002927<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 +00002928
cristy4949d522010-03-12 18:41:34 +00002929<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>
cristy3ed852e2009-09-05 21:47:34 +00002930<p>then the image will be <em>resized</em> to the specified dimensions instead,
2931equivalent to:</p>
2932
2933<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>
2934<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>
2935
2936<div style="margin: auto;">
2937 <h4><a name="family" id="family"></a>-family <em class="arg">fontFamily</em></h4>
2938</div>
2939
2940<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>
2941
2942<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).
2943</p>
2944
2945<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>.
2946</p>
2947
2948<div style="margin: auto;">
cristy7396d882010-01-27 02:37:56 +00002949 <h4><a name="features" id="features"></a>-features <em class="arg">distance</em></h4>
2950</div>
2951
2952<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>
2953
2954<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00002955 <h4><a name="fft" id="fft"></a>-fft</h4>
2956</div>
2957
2958<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>
2959
cristyb36feb22010-03-26 16:54:37 +00002960<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" target="_blank">Fourier Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT" target="_blank">Discrete Fourier Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT" target="_blank">Fast Fourier Transform</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002961
2962<p>A single image name is provided as output for this option. However, the output result will have two components. It will be 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" target="_blank">Complex Numbers</a>.<p>
2963
2964<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>
2965
2966<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2967<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>
2968
2969<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2970<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>
2971
2972<p>The input image can be any size, but if not square and even-dimensioned, it will be 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 will be square at this size. The kind of padding relies on the <a href="#virtual-pixel">-virtual-pixel</a> setting.</p>
2973
2974<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>
2975
2976<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2977 -evaluate log 1000 fft_image_spectrum.png</span></p>
2978<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>
2979
2980<p>The <a href="http://www.fftw.org/" target="_blank">FFTW</a> delegate library is required to use <a href="#fft">-fft</a>.
2981
2982<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>
2983
2984<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>
2985
2986<p>The real and imaginary component images resulting from <a href="#fft">+fft</a> also will be square, even dimensioned images due to the same padding that was discussed above for the magnitude and phase component images.</a>
2987
2988<p>See the discussion on HDRI implementations of ImageMagick on the page
2989<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.
2990</p>
2991
2992
2993<div style="margin: auto;">
2994 <h4><a name="fill" id="fill"></a>-fill <em class="arg">color</em></h4>
2995</div>
2996
2997<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>
2998
2999<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>
3000
3001<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
3002
3003<p>For example,</p>
3004
3005<p class="crtsnip">
3006 -fill blue
3007</p>
3008<p class="crtsnip">
3009 -fill "#ddddff"
3010</p>
3011<p class="crtsnip">
3012 -fill "rgb(255,255,255)"
3013</p>
3014
3015<p>See <a href="#draw">-draw</a> for further details.</p>
3016
3017<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
3018
3019<div style="margin: auto;">
3020 <h4><a name="filter" id="filter"></a>-filter <em class="arg">type</em></h4>
3021</div>
3022
3023<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 an image.</td><td style='text-align:right;'></td></tr></table>
3024
3025<p>Use this option to affect the resizing operation of an image (see <a
3026href="#resize">-resize</a>). For example you can use a simple resize filter
3027such as:</p>
3028
3029<pre class="text">
3030 Point Hermite Cubic
3031 Box Gaussian Catrom
3032 Triangle Quadratic Mitchell
3033</pre>
3034
3035<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided, but are
3036by default <kbd>blackman</kbd>-windowed. However these filters define a
3037windowing filter for the Sinc or Bessel filter function, as appropriate for
3038the scaling operator used (usally Sinc for orthogonal <a href="#resize"
3039>-resize</a>). Windowed filters include: </p>
3040
3041<pre class="text">
3042 Lanczos Hamming Parzen
3043 Blackman Kaiser Welsh
3044 Hanning Bartlett Bohman
3045</pre>
3046
3047<p>Also one special self-windowing filter is also provided
3048<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
3049on the current 'support' or 'lobes' expert settings (see below).</p>
3050
3051<p>If you do not select a filter with this option, the filter defaults to <kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or if the image is enlarged. Otherwise the filter default to <kbd>Lanczos</kbd>.</p>
3052
3053<p>To print a complete list of resize filters, use the <a href="#list">-list filter</a> option.</p>
3054
3055<p>You can modify how the filter behaves as it scales your image through the
3056use of these expert settings:</p>
3057
3058<dl class="doc">
3059<dt>-set filter:blur <em>factor</em></dt>
3060<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
3061 blurry or &lt; 1.0 for sharp.</dd>
3062
3063<dt>-set filter:support <em>radius</em></dt>
3064<dd>Set the filter support radius.</dd>
3065
3066<dt>-set filter:lobes <em>count</em></dt>
3067<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
3068 alternative way of specifying the 'support' range of the filter.</dd>
3069
3070<dt>-set filter:b <em>b-spline_factor</em></dt>
3071<dt>-set filter:c <em>keys_alpha_factor</em></dt>
3072<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
3073 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
3074 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
3075 are defined, the other is set so as to generate a 'Keys' type cubic
3076 filter.
3077
3078<dt>-set filter:filter <em>filter</em></dt>
3079<dd>Use this function directly as the scaling filter. This will allow
3080 you to directly use a 'windowing filter' such as <kbd>blackman</kbd>,
3081 rather than as its normal usage as a windowing function for 'Sinc' or
3082 'Bessel'. If defined, no windowing function is used, unless the following
3083 expert setting is also defined.</dd>
3084
3085<dt>-set filter:window <em>filter</em></dt>
3086<dd>The IIR (infinite impulse response) filters <kbd>bessel</kbd> and
3087 <kbd>sinc</kbd> are windowed (brought down to zero over the defined
3088 support range) with the given filter. This allows you to use a filter that
3089 is not normally used as a windowing function, such as <kbd>box</kbd>,
3090 (which effectivally turns off the windowing function). </dd>
3091
3092</dl>
3093
3094<p>For example, to get a 8 lobe Lanczos-Bessel filter:</p>
3095
3096<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
3097 -set filter:window=bessel -set filter:lobes=8 \ <br/>
3098 -resize 150% image.jpg</span></p>
3099<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
3100
3101<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
3102 -resize 150% image.jpg</span></p>
3103<p>Note that the use of expert options (except for 'blur' with simple resize
3104filters), are provided for image processing experts who have studied and
3105understood how resize filters work. Without this knowledge, and an
3106understanding of the defination of the actual filters involved, using expert
3107settings are more likely to be detremental to your image resizing.</p>
3108
3109
3110<div style="margin: auto;">
3111 <h4><a name="flatten" id="flatten"></a>-flatten</h4>
3112</div>
3113
3114<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>
3115
3116
3117<div style="margin: auto;">
3118 <h4><a name="flip" id="flip"></a>-flip</h4>
3119</div>
3120
3121<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>
3122
3123<p>reflect the scanlines in the vertical direction.</p>
3124
3125<div style="margin: auto;">
3126 <h4><a name="floodfill" 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>
3127</div>
3128
3129<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>
3130
3131<div style="margin: auto;">
3132 <h4><a name="flop" id="flop"></a>-flop</h4>
3133</div>
3134
3135<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>
3136
3137<p>reflect the scanlines in the horizontal direction.</p>
3138
3139
3140<div style="margin: auto;">
3141 <h4><a name="font" id="font"></a>-font <em class="arg">name</em></h4>
3142</div>
3143
3144<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>
3145
3146<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>
3147
3148<p>In addition to the fonts specified by the above pre-defined list, you can
3149also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
3150is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
3151<kbd>x:fixed</kbd> is X11 font.</p>
3152
3153<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>
3154
3155
3156<div style="margin: auto;">
3157 <h4><a name="foreground" id="foreground"></a>-foreground <em class="arg">color</em></h4>
3158</div>
3159
3160<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>
3161
3162<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3163
3164<p>The default foreground color is black.</p>
3165
3166<div style="margin: auto;">
3167 <h4><a name="format" id="format"></a>-format <em class="arg">type</em></h4>
3168</div>
3169
3170<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>
3171
3172<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>
3173
3174<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>
3175
3176<div style="margin: auto;">
3177 <h4><a name="format_identify_" id="format_identify_"></a>-format <em class="arg">string</em></h4>
3178</div>
3179
3180<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>
3181
3182<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>
3183
3184<div style="margin: auto;">
3185 <h4><a name="frame" id="frame"></a>-frame <em class="arg">geometry</em></h4>
3186</div>
3187
3188<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>
3189
3190<p>The color of the border is specified with the <a href="#mattecolor">-mattecolor</a> command line option. </p>
3191
3192<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 class="arg">geometry</em> argument indicates the amount of extra width and height that is added to the dimensions of the image. If no offsets are given in the <em class="arg">geometry</em> argument, then the border added is a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that the width and height of the border is partitioned to form an outer bevel of thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness <em>y</em>&nbsp;pixels. (Negative offsets make no sense here.) The <a href="#frame">-frame</a> option is not affected by the <a href="#gravity">-gravity</a> option.</p>
3193
3194
3195<div style="margin: auto;">
3196 <h4><a name="frame_import_" id="frame_import_"></a>-frame</h4>
3197</div>
3198
3199<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>
3200
3201<div style="margin: auto;">
3202 <h4><a name="function" id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
3203</div>
3204
3205<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>
3206
3207<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>
3208
3209<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>
3210
3211<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>
3212
3213<pre class="text">
3214 Polynomial
3215 Sinusoid
3216 Arcsin
3217 Arctan
3218</pre>
3219
3220<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3221
3222<dl class="doc">
3223<dt><kbd>Polynomial</kbd></dt>
3224<dd>
3225<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>
3226
3227<div style="text-align: center">
3228 -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>
3229</div>
3230
3231<p>will invoke a polynomial function given by</p>
3232
3233<div style="text-align: center">
3234 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3235 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3236 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3237</div>
3238
3239<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3240
3241<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>
3242
3243<table class="doc">
3244 <col width="35%" />
3245 <col width="35%" />
3246 <col width="30%" />
3247 <tr>
3248 <td>-evaluate Set <em class="arg">value</em> </td>
3249 <td>-function Polynomial <em class="arg">value</em></td>
3250 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3251 </tr>
3252 <tr>
3253 <td>-evaluate Add <em class="arg">value</em> </td>
3254 <td>-function Polynomial 1,<em class="arg">value</em></td>
3255 </tr>
3256 <tr>
3257 <td>-evaluate Subtract <em class="arg">value</em> </td>
3258 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3259 </tr>
3260 <tr>
3261 <td>-evaluate Multiply <em class="arg">value</em> </td>
3262 <td>-function Polynomial <em class="arg">value</em>,0</td>
3263 </tr>
3264 <tr>
3265 <td>+level black% x white%</td>
3266 <td>-function Polynomial A,B</td>
3267 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3268 </tr>
3269</table>
3270
3271<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>
3272</dd>
3273
3274<dt><kbd>Sinusoid</kbd></dt>
3275<dd>
3276<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>
3277
3278<div style="text-align: center">
3279 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3280</div>
3281
3282<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>
3283
3284<div style="text-align: center">
3285<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>
3286</div>
3287
3288<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>
3289
3290<p class="crtsnip">
3291 -function Sinusoid 3,-90,.2,.7
3292</p>
3293
3294<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>
3295
3296<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>
3297
3298<table class="doc">
3299 <tr>
3300 <td>-evaluate Sin <em class="arg">freq</em> </td>
3301 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3302 </tr>
3303 <tr>
3304 <td>-evaluate Cos <em class="arg">freq</em> </td>
3305 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3306 </tr>
3307</table>
3308</dd>
3309
3310<dt><kbd>ArcSin</kbd></dt>
3311<dd>
3312<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3313and can be used to generate cylindrical distortion and displacement maps.
3314The curve can be adjusted relative to both the input values and output range
3315of values.
3316
3317<div style="text-align: center">
3318 -function <kbd>ArcSin</kbd> <em class="arg">width</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
3319</div>
3320
3321<p>with all values given in terms of noramlize color values (0.0 for black,
33221.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3323for bout input (<em class="arg">width</em>), and output (<em
3324class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3325
3326<div style="text-align: center">
3327<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>
3328</div>
3329
3330</dd>
3331
3332<dt><kbd>ArcTan</kbd></dt>
3333<dd>
3334<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3335limit values at infinities, though a center using the given slope value.
3336All these values can be adjusted via the arguments.
3337
3338<div style="text-align: center">
3339 -function <kbd>ArcTan</kbd> <em class="arg">slope</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
3340</div>
3341
3342<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3343</p>
3344
3345<div style="text-align: center">
3346<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>
3347</div>
3348
3349</dd>
3350
3351</dl>
3352
3353
3354<div style="margin: auto;">
3355 <h4><a name="fuzz" id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
3356</div>
3357
3358<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>
3359
3360<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>
3361
3362<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>
3363
3364
3365<div style="margin: auto;">
3366 <h4><a name="fx" id="fx"></a>-fx <em class="arg">expression</em></h4>
3367</div>
3368
3369<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>
3370
3371<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>
3372
3373<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3374
3375
3376<div style="margin: auto;">
3377 <h4><a name="gamma" id="gamma"></a>-gamma <em class="arg">value</em></h4>
3378</div>
3379
3380<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>
3381
3382<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>
3383
3384<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>
3385
3386<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>
3387
3388<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>
3389
3390<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3391
3392<div style="margin: auto;">
3393 <h4><a name="gaussian-blur" 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>
3394</div>
3395
3396<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>
3397
cristyb15553d2010-07-03 22:53:14 +00003398<p>Convolve the image with a Gaussian or normal distribution using the given
3399<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003400
3401<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3402</div>
3403
cristyb15553d2010-07-03 22:53:14 +00003404<p>The <em class="arg" >Sigma</em> value is the important argument, and
3405determines the actual amount of bluring that will take place. </p>
3406
3407<p>The <em class="arg" >Radius</em> is only used to determine the size of the
3408array which will hold the calculated gaussian distribution. It should be an
3409integer. If not given, or set to zero, IM will calculate the largest posible
3410radius that will provide meaningful results for the Gaussian distribution.
3411</p>
3412
3413<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3414operation is. However too small a <em class="arg" >Radius</em>, and sever
3415aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3416should be at least twice the <em class="arg" >Sigma</em> value, though three
3417times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003418
3419<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
3420full 2-dimentional convolution is used to generate the weighted average of the
3421neighbouring pixels. </p>
3422
3423<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3424pixels which are outside the image proper are blurred into the final result.
3425</p>
3426
3427
3428<div style="margin: auto;">
3429 <h4><a name="geometry" id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
3430</div>
3431
3432<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>
3433
3434<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>
3435
3436<div style="margin: auto;">
3437 <h4><a name="gravity" id="gravity"></a>-gravity <em class="arg">type</em></h4>
3438</div>
3439
3440<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>
3441
3442<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3443<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3444<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3445list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3446installation.</p>
3447
3448<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>
3449
3450<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>
3451
3452<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>
3453
cristy4949d522010-03-12 18:41:34 +00003454<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 +00003455<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>
3456
3457<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>
3458
3459
3460<div style="margin: auto;">
3461 <h4><a name="green-primary" id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
3462</div>
3463
3464<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>
3465
3466
3467<div style="margin: auto;">
3468 <h4><a name="hald-clut" id="hald-clut"></a>-hald-clut</h4>
3469</div>
3470
3471<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>
3472
3473<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3474dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3475can apply any color transformation to the Hald image and then use this option
3476to apply the transform to the image. </p>
3477
3478<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3479<p>This option provides a convenient method for you to use Gimp or Photoshop
3480to make color corrections to the Hald CLUT image and subsequently apply them
3481to multiple images using an ImageMagick script. </p>
3482
3483<p>Note that the representation is only of the normal RGB color space and that
3484the whole color value triplet is used for the interpolated lookup of the
3485represented Hald color cube image. Because of this the operation is not <a
3486href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3487images transparency or alpha/matte channel.</p>
3488
3489<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3490of the individual color channels, usally involving a simplier gray-scale
3491image. E.g: gray-scale to color replacement, or modification by a histogram
3492mapping. </p>
3493
3494
3495<div style="margin: auto;">
3496 <h4><a name="help" id="help"></a>-help</h4>
3497</div>
3498
3499<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>
3500
3501<div style="margin: auto;">
3502 <h4><a name="highlight-color" id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
3503</div>
3504
3505<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>
3506
3507<div style="margin: auto;">
3508 <h4><a name="iconGeometry" id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
3509</div>
3510
3511<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>
3512
3513<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>
3514
3515<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>
3516
3517<div style="margin: auto;">
3518 <h4><a name="iconic" id="iconic"></a>-iconic</h4>
3519</div>
3520
3521<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>
3522
3523<div style="margin: auto;">
3524 <h4><a name="identify" id="identify"></a>-identify</h4>
3525</div>
3526
3527<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>
3528
3529<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>
3530
3531<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>
3532
3533<p>If <a href="#verbose">-verbose</a> preceds this option, copious
3534amounts of image properties are displayed including image statistics, profiles,
3535image histogram, and others.</p>
3536
3537<div style="margin: auto;">
3538 <h4><a name="ift" id="ift"></a>-ift</h4>
3539</div>
3540
3541<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>
3542
cristyb36feb22010-03-26 16:54:37 +00003543<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" target="_blank">Fourier Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT" target="_blank">Discrete Fourier Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT" target="_blank">Fast Fourier Transform</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00003544
3545<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>
3546
3547<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3548<p>or</p>
3549
3550<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>
3551
3552<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 will be at the right and/or bottom sides of the image.
3553
3554<p>The <a href="http://www.fftw.org/" target="_blank">FFTW</a> delegate library is required to use <a href="#ift">-ift</a>.
3555
3556<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.
3557
3558<div style="margin: auto;">
3559 <h4><a name="immutable" id="immutable"></a>-immutable</h4>
3560</div>
3561
3562<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>
3563
3564<div style="margin: auto;">
3565 <h4><a name="implode" id="implode"></a>-implode <em class="arg">factor</em></h4>
3566</div>
3567
3568<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>
3569
3570<div style="margin: auto;">
3571 <h4><a name="insert" id="insert"></a>-insert <em class="arg">index</em></h4>
3572</div>
3573
3574<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>
3575
3576<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>
3577
3578<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>
3579
3580<div style="margin: auto;">
3581 <h4><a name="intent" id="intent"></a>-intent <em class="arg">type</em></h4>
3582</div>
3583
3584<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>
3585
3586<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>
3587
3588<p>The default intent is undefined.</p>
3589
3590<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3591
3592<div style="margin: auto;">
3593 <h4><a name="interlace" id="interlace"></a>-interlace <em class="arg">type</em></h4>
3594</div>
3595
3596<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>
3597
3598<p>Choose from:</p>
3599
3600<pre class="text">
3601 none
3602 line
3603 plane
3604 partition
3605 JPEG
3606 GIF
3607 PNG
3608</pre>
3609
3610<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>
3611
3612<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3613
3614<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3615
3616<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3617
3618<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3619image.G, and image.B).</p>
3620
3621<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>
3622image.</p>
3623
3624<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3625
3626<div style="margin: auto;">
3627 <h4><a name="interpolate" id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
3628</div>
3629
3630<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>
3631
3632<p>When looking up the color of a pixel using a non-interger floating point
3633value, you typically fall in between the pixel colors defined by the source
3634image. This setting determines how the color is determined from the colors of
3635the pixels surrounding that point. That is how to determine the color of a
3636point that falls between two, or even four different colored pixels. </p>
3637
3638<pre class="text">
3639 integer: The color of the top-left pixel (floor function)
3640 nearest-neighbor: The nearest pixel to the lookup point (rounded function)
3641 average: The average color of the surrounding four pixels
3642 bilinear A double linear interpolation of pixels (the default)
3643 mesh Divide area into two flat triangular interpolations
3644 bicubic Fitted bicubic-spines of surrounding 16 pixels
3645 spline Direct spline curves (colors are blurred)
3646 filter Use resize <a href="#filter">-filter</a> settings
3647</pre>
3648
3649<p>This most important for distortion operators such as <a href="#distort"
3650>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3651>-transform</a> and <a href="#fx" >-fx</a>. </p>
3652
3653<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3654
3655<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3656lookup for positions outside the boundaries of the image. </p>
3657
3658
3659<div style="margin: auto;">
cristyf3bb4782009-09-08 13:10:04 +00003660 <h4><a name="interline-spacing" id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
3661</div>
3662
3663<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>
3664
3665<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00003666 <h4><a name="interword-spacing" id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
3667</div>
3668
3669<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>
3670
3671<div style="margin: auto;">
3672 <h4><a name="kerning" id="kerning"></a>-kerning <em class="arg">value</em></h4>
3673</div>
3674
3675<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>
3676
3677<div style="margin: auto;">
3678 <h4><a name="label" id="label"></a>-label <em class="arg">name</em></h4>
3679</div>
3680
3681<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>
3682
3683<p>Use this option to assign a specific label to the image, as it is read in or created. You can use the <a href="#set" >-set</a> operation to re-assign a the labels of images already read in. Image formats such as TIFF, PNG, MIFF, supports saving the label information with the image.</p>
3684
3685<p>When saving an image to a <em class="arg">PostScript</em> file, any label assigned to an image is used as a header string to print above the postscript image. </p>
3686
3687<p>You can include the image filename, type, width, height, or other image attribute by embedding special format character. See <a href="#format">-format</a> for details of the percent escape codes.</p>
3688
3689<p>For example,</p>
3690
3691<p class="crtsnip">
3692 -label "%m:%f %wx%h" bird.miff
3693</p>
3694
3695<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the "<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it is read in. If a <a href="#label">+label</a> option was used instead, any existing label present in the image would be used. You can remove all labels from an image by assigning the empty string. </p>
3696
3697<p>A label is not drawn on the image, but is embedded in the image datastream via <em>Label</em> tag or similar mechanism. If you want the label to be visible on the image itself, use the <a href="#draw">-draw</a> option, or during the final processing in the creation of a image montage.</p>
3698
3699<p>The label font can be specified with <a href="#font">-font</a>, and the
3700other font attribute settings.</p>
3701
3702<p>If the first character of <em class="arg">string</em> is <em class="arg">@</em>, the image label is read from a file titled by the remaining characters in the string. Labels in a file are literal, no embedded formatting characters are recognized.</p>
3703
3704
3705<div style="margin: auto;">
3706 <h4><a name="lat" 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>
3707</div>
3708
3709<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>
3710
3711<p>Adaptively threshold each pixel based on the value of pixels in a
3712surrounding window. If the current pixel is lighter than this average plus
3713the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3714black. Small variations in pixel values such as found in scanned documents
3715can be ignored if offset is positive. A negative offset will make it more
3716sensitive to those small variations. </p>
3717
3718<p>This is commonly used to threshold images with an uneven background. It is
3719based on the assumption that average color of the small window is the
3720the local background color, from which to separate the forground color. </p>
3721
3722
3723<div style="margin: auto;">
3724 <h4><a name="layers" id="layers"></a>-layers <em class="arg">method</em></h4>
3725</div>
3726
3727<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>
3728
3729<p>Perform various image operation methods to a ordered sequence of images
3730which may represent either a set of overlaid 'image layers', a GIF disposal
3731animation, or a fully-'coalesced' animation sequence. </p>
3732
3733<table class="doc">
3734 <tbody>
3735 <tr valign="top">
3736 <th align="left" style="width: 8%">Method</th>
3737 <th align="left">Description</th>
3738 </tr>
3739
3740 <tr valign="top">
3741 <td valign="top">compare-any</td>
3742 <td valign="top">Crop the second and later frames to the smallest rectangle
3743 that contains all the differences between the two images. No GIF <a
3744 href="#dispose" >-dispose</a> methods are taken into account. </td>
3745 </tr>
3746
3747 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3748 >-deconstruct</a> operator, and does not preserve animations normal
3749 working, especially when animation used layer disposal methods such as
3750 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3751 </tr>
3752
3753 <tr valign="top">
3754 <td valign="top">compare-clear</td>
3755 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3756 opaque pixels which become transparent in the second frame. That is the
3757 smallest image needed to mask or erase pixels for the next frame. </td>
3758 </tr>
3759
3760 <tr valign="top">
3761 <td valign="top">compare-overlay</td>
3762 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3763 extra color to the next image, as a result of overlaying color pixels.
3764 That is the smallest single overlaid image to add or change colors. </td>
3765 </tr>
3766
3767 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3768 composition method '<kbd>change-mask</kbd>', to reduce the image to
3769 just the pixels that need to be overlaid. </td>
3770 </tr>
3771
3772 <tr valign="top">
3773 <td valign="top">coalesce</td>
3774 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3775 >-coalesce</a> operator. Apply the layer disposal methods set in the
3776 current image sequence to form a fully defined animation sequence, as
3777 it should be displayed. Effectively converting a GIF animation into a
3778 'film strip'-like animation. </td>
3779 </tr>
3780
3781 <tr valign="top">
3782 <td valign="top">composite</td>
3783 <td valign="top">Alpha Composition of two image lists, separated by a
3784 "<kbd>null:</kbd>" image, with the destination image list first, and
3785 the source images last. An image from each list are composited
3786 together until one list is finished. The separator image and source
3787 image lists are removed. </td>
3788 </tr>
3789
3790
cristybac7a162010-06-15 19:57:29 +00003791 <tr><td></td>
3792 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3793 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3794 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003795 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003796 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003797
cristybac7a162010-06-15 19:57:29 +00003798 <tr><td></td>
3799 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003800 applied to all the images in the other image list, regardless of which
3801 list it is. In this case it is the image meta-data of the list which
3802 preserved. </td>
3803 </tr>
3804
3805
3806 <tr valign="top">
3807 <td valign="top">dispose</td>
3808 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3809 the animation after the layer disposal method has been applied, before
3810 the next sub-frame image is overlaid. That is the 'dispose' image that
3811 results from the application of the GIF <a href="#dispose"
3812 >-dispose</a> method. This allows you to check what
3813 is going wrong with a particular animation you may be developing.
3814 </td>
3815 </tr>
3816
3817 <tr valign="top">
3818 <td valign="top">flatten</td>
3819 <td valign="top">Create a canvas the size of the first images virtual
3820 canvas using the current <a href="#background" >-background</a> color,
3821 and <a href="#compose" >-compose</a> each image in turn onto that
3822 canvas. Images falling outside that canvas is clipped. Final
3823 image will have a zero virtual canvas offset. </td>
3824 </tr>
3825
cristybac7a162010-06-15 19:57:29 +00003826 <tr><td></td>
3827 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003828 overlaying all the prepared image layers into a final image. </td>
3829 </tr>
3830
cristybac7a162010-06-15 19:57:29 +00003831 <tr><td></td>
3832 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003833 canvas with real pixels, or to underlay a opaque color to remove
3834 transparency from an image.</td>
3835 </tr>
3836
3837
3838 <tr valign="top">
3839 <td valign="top">merge</td>
3840 <td valign="top">As 'flatten' method but merging all the given image
3841 layers into a new layer image just large enough to hold all the image
3842 without clipping or extra space. The new images virtual offset will
3843 prevere the position of the new layer, even if this offset is
3844 negative. the virtual canvas size of the first image is preserved.
3845 </td>
3846 </tr>
3847
3848 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3849 as few image file formats handle them correctly. </td>
3850 </tr>
3851
3852 <tr valign="top">
3853 <td valign="top">mosaic</td>
3854 <td valign="top">As 'flatten' method but expanding the initial canvas size
3855 of the first image so as to hold all the image layers. However as a
3856 virtual canvas is 'locked' to the origin, by defination, image layers
3857 with a negative offsets will still be clipped by the top and left
3858 edges.</td>
3859 </tr>
3860
3861 <tr><td></td><td>This method is commonly used to layout individual image using various
3862 offset but without knowning the final canvas size. The resulting image
3863 will, like 'flatten' not have any virtual offset, so can be saved to
3864 any image file format. </td>
3865 </tr>
3866
3867
3868 <tr valign="top">
3869 <td valign="top">optimize</td>
3870 <td valign="top">Optimize a coalesced animation, into GIF animation using
3871 a number of general techniques. This currently a short cut to
3872 apply both the '<kbd>optimize-frame</kbd>', and
3873 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3874 include other optimization methods as they are developed. </td>
3875 </tr>
3876
3877 <tr valign="top">
3878 <td valign="top">optimize-frame</td>
3879 <td valign="top">Optimize a coalesced animation, into GIF animation by
3880 reducing the number of pixels per frame as much as possible by
3881 attempting to pick the best layer disposal method to use, while ensuring
3882 the result will continue to animate properly. </td>
3883 </tr>
3884
3885 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3886 then no reasonably fast GIF optimization algorithm can do this.
3887 However this does seem to do better than most other GIF frame
3888 optimizers seen. </td>
3889 </tr>
3890
3891 <tr valign="top">
3892 <td valign="top">optimize-plus</td>
3893 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3894 overall optimization by adding extra frames to the animation, without
3895 changing the final look or timing of the animation. The frames are
3896 added to attempt to separate the clearing of pixels from the
3897 overlaying of new additional pixels from one animation frame to the
3898 next. If this does not improve the optimization (for the next frame
3899 only), it will fall back to the results of the previous normal
3900 '<kbd>optimize-frame</kbd>' technique. </td>
3901 </tr>
3902
3903 <tr><td></td><td>There is the possibility that the change in the disposal style will
3904 result in a worsening in the optimization of later frames, though this
3905 is unlikely. In other words there no guarantee that it is better than
3906 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
3907 however you can get a vast improvment in the final animation size. </td>
3908 </tr>
3909
3910 <tr valign="top">
3911 <td valign="top">optimize-transparency</td>
3912 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3913 overlay images with transparency, if it does not change the resulting
3914 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3915 </td>
3916 </tr>
3917
3918 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3919 into a smaller file size due to larger areas of one (transparent)
3920 color rather than a pattern of multiple colors repeating the current
3921 disposed image of the last frame. </td>
3922 </tr>
3923
3924 <tr valign="top">
3925 <td valign="top">remove-dups</td>
3926 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3927 images, so as to simplify layer overlays of coalesced animations.
3928 </td>
3929 </tr>
3930
3931 <tr><td></td><td>Usually this a result of using a constant time delay across the
3932 whole animation, or after a larger animation was split into smaller
3933 sub-animations. The duplicate frames could also have been used as
3934 part of some frame optimization methods. </td>
3935 </tr>
3936
3937 <tr valign="top">
3938 <td valign="top">remove-zero</td>
3939 <td valign="top">Remove any image with a zero time delay, unless ALL the
3940 images have a zero time delay (and is not a proper timed animation, a
3941 warning is then issued). </td>
3942 </tr>
3943
3944 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3945 partial intermediary updates between the frames that are actually
3946 displayed to users. These frames are usally added for improved frame
3947 optimization in GIF animations. </td>
3948 </tr>
3949
3950 <tr valign="top">
3951 <td valign="top">trim-bounds</td>
3952 <td valign="top">Find the bounds of all the images in the current
3953 image sequence, then adjust the offsets so all images are contained on
3954 a minimal positive canvas. None of the image data is modified, only
3955 there virtual canvas size and offset. The all the image is given
3956 the same canvas size, and and will have a positive offset, but will
3957 remain in the same position relative to each other. As a result of the
3958 minimal canvas size at least one image will touch every edge of that
3959 canvas. The image data however may be transparent.
3960 </td>
3961 </tr>
3962
3963 </tbody>
3964</table>
3965
3966<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3967
3968<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3969>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3970>-mosaic</a> are only aliases for the above methods. Also see <a
3971href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3972href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3973>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3974
3975
3976<div style="margin: auto;">
3977 <h4><a name="level" 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>
3978</div>
3979
3980<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>
3981
3982<p>Given one, two or three values delimited with commas: black-point,
3983white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3984white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3985point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3986contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3987both black and white points are percentages of the full color range. Gamma
3988will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3989omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3990
3991<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3992the given '<kbd>black_point</kbd>' value in the original image is set to
3993zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3994<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3995to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3996adjusted. </p>
3997
3998<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3999adding the special '!' flag anywhere in the argument list, will cause the
4000operator to do the reverse of the level adjustment. That is a zero, or
4001<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
4002adjusted to the given level values, allowing you to de-contrast, or compress
4003the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
4004
4005<p>Only the channels defined by the current <a href="#channel">-channel</a>
4006setting are adjusted (defaults to RGB color channels only), allowing you to
4007limit the effect of this operator. </p>
4008
4009<p>Please note that the transparency channel is treated as 'matte'
4010values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
4011
4012
4013<div style="margin: auto;">
4014 <h4><a name="level-colors" id="level-colors"></a>-level-colors {<em
4015 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
4016</div>
4017
4018<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 seperated colors.</td><td style='text-align:right;'></td></tr></table>
4019
4020<p>This function is exactly like <a href="#level">-level</a>, except that the
4021value value for each color channel is determined by the
4022'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
4023described under the <a href="#fill">-fill</a> option). </p>
4024
4025<p>This effectivally means the colors provided to <kbd>-level-colors</kbd>
4026is mapped to become 'black' and 'white' respectivally, with all the other
4027colors linearly adjusted (or clipped) to match that change. Each channel is
4028adjusted separatally using the channel values of the colors specified. </p>
4029
4030<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
4031will map the image color 'black' and 'white' to the given colors
4032respectivally, resulting in a gradient (de-contrasting) tint of the image to
4033those colors. This can also be used to convert a plain gray-scale image into a
4034one using the gradient of colors specified. </p>
4035
4036<p>By supplying a single color with a comma separator either before or after
4037that color, will just replace the respective 'black' or 'white' point
4038respectivally. But if no comma separator is provided, the given color is
4039used for both the black and white color points, making the operator either
4040threshold the images around that color (- form) or set all colors to that
4041color (+ form). </p>
4042
4043
4044<div style="margin: auto;">
4045 <h4><a name="limit" id="limit"></a>-limit <em class="arg">type value</em></h4>
4046</div>
4047
4048<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>
4049
4050<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>
4051
cristy6b636652009-12-05 17:16:11 +00004052<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 +00004053
4054<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00004055 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00004056</p>
4057
4058<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
4059
cristy6b636652009-12-05 17:16:11 +00004060<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list resource</span><span class='crtout'><pre>File Area Memory Map Disk Thread Time
4061------------------------------------------------------------------------------
4062 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited</pre>
cristy3ed852e2009-09-05 21:47:34 +00004063</span></p>
4064<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>
4065
4066<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>
4067
4068<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>
4069
4070<p class="crtsnip">
4071-limit area 10mb
4072</p>
4073
4074<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 inadvertedly upload a huge image to process, you should set a disk limit as well:</p>
4075
4076<p class="crtsnip">
4077-limit area 10mb -limit disk 500mb
4078</p>
4079
4080<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
4081
4082<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>
4083
4084<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.
4085</p>
4086
4087<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.
4088</p>
4089
4090<div style="margin: auto;">
4091 <h4><a name="linear-stretch" 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>
4092</div>
4093
4094<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>
4095
cristyd934d102009-10-10 12:55:13 +00004096<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
4097and uses a 'histogram bin' to determine the range of color values that needs to
4098be stretched. However it then stretchs those colors using the <a
4099href="#level" >-level</a> operator.</p>
4100
4101<p>As such while the initial determination may have 'binning' round off
4102effects, the image colors are stretched mathematically, rather than using the
4103histogram bins. This makes the operator more accurate. </p>
4104
4105<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
4106'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
4107perfect stretch of the color range. </p>
4108
4109<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
4110normalization of mathematical images. </p>
4111
4112<p>This operator is under review for re-development. </p>
4113
4114
cristy3ed852e2009-09-05 21:47:34 +00004115<div style="margin: auto;">
4116 <h4><a name="linewidth" id="linewidth"></a>-linewidth</h4>
4117</div>
4118
4119<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>
4120
4121<div style="margin: auto;">
4122 <h4><a name="liquid-rescale" id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
4123</div>
4124
4125<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>
4126
4127<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>
4128
4129<div style="margin: auto;">
4130 <h4><a name="list" id="list"></a>-list <em class="arg">type</em></h4>
4131</div>
4132
4133<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>
4134
4135<pre class="text">
cristyc1aee832010-05-08 00:36:47 +00004136 Align
4137 Alpha
4138 Boolean
4139 Channel
4140 Class
4141 ClipPath
4142 Coder
4143 Color
4144 Colorspace
4145 Command
4146 Compose
4147 Compress
4148 Configure
4149 DataType
4150 Debug
4151 Decoration
4152 Delegate
4153 Direction
4154 Dispose
4155 Distort
4156 Dither
4157 Endian
4158 Evaluate
4159 FillRule
4160 Filter
4161 Font
4162 Format
4163 Function
4164 Gravity
4165 ImageList
4166 Intent
4167 Interlace
4168 Interpolate
4169 Kernel
cristy787d4352010-03-06 13:55:58 +00004170 Layers
4171 LineCap
4172 LineJoin
4173 List
4174 Locale
4175 LogEvent
4176 Log
4177 Magic
4178 Method
4179 Metric
4180 Mime
4181 Mode
4182 Morphology
4183 Module
4184 Noise
4185 Orientation
4186 Policy
4187 PolicyDomain
4188 PolicyRights
4189 Preview
4190 Primitive
4191 QuantumFormat
4192 Resource
4193 SparseColor
4194 Storage
4195 Stretch
4196 Style
4197 Threshold
4198 Type
4199 Units
4200 Validate
4201 VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004202</pre>
4203
cristybac7a162010-06-15 19:57:29 +00004204<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4205list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4206available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004207
4208<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4209<div style="margin: auto;">
4210 <h4><a name="log" id="log"></a>-log <em class="arg">string</em></h4>
4211</div>
4212
4213<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>
4214
cristybac7a162010-06-15 19:57:29 +00004215<p>This option specifies the format for the log printed when the <a
4216href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004217
cristybac7a162010-06-15 19:57:29 +00004218<p>You can display the following components by embedding special format
4219characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004220
4221<pre class="text">
4222 %d domain
4223 %e event
4224 %f function
4225 %l line
4226 %m module
4227 %p process ID
4228 %r real CPU time
4229 %t wall clock time
4230 %u user CPU time
4231 %% percent sign
4232 \n newline
4233 \r carriage return
4234</pre>
4235
4236<p>For example:</p>
4237
4238<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>
4239<p>The default behavior is to print all of the components.</p>
4240
4241<div style="margin: auto;">
4242 <h4><a name="loop" id="loop"></a>-loop <em class="arg">iterations</em></h4>
4243</div>
4244
4245<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>
4246
cristybac7a162010-06-15 19:57:29 +00004247<p>Set iterations to zero to repeat the animation an infinite number of times,
4248otherwise the animation repeats itself up to <em class="arg">iterations</em>
4249times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004250
4251<div style="margin: auto;">
4252 <h4><a name="lowlight-color" id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
4253</div>
4254
4255<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>
4256
4257<div style="margin: auto;">
4258 <h4><a name="magnify" id="magnify"></a>-magnify <em class="arg">factor</em></h4>
4259</div>
4260
4261<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>
4262
4263
4264<div style="margin: auto;">
4265 <h4><a name="map" id="map"></a>-map <em class="arg">type</em></h4>
4266</div>
4267
4268<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>
4269
4270<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4271
4272<pre class="text">
4273 best
4274 default
4275 gray
4276 red
4277 green
4278 blue
4279</pre>
4280
cristybac7a162010-06-15 19:57:29 +00004281<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4282Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4283the type and <kbd>display</kbd> searches the list of colormap types in
4284<kbd>top-to-bottom</kbd> order until one is located. See <em
4285class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004286
4287
4288<div style="margin: auto;">
4289 <h4><a name="map_stream_" id="map_stream_"></a>-map <em class="arg">components</em></h4>
4290</div>
4291
4292<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>
4293
4294<p>Here are the valid components of a map:</p>
4295
4296<pre class="text">
4297 r red pixel component
4298 g green pixel component
4299 b blue pixel component
4300 a alpha pixel component (0 is transparent)
4301 o opacity pixel component (0 is opaque)
4302 i grayscale intensity pixel component
4303 c cyan pixel component
4304 m magenta pixel component
4305 y yellow pixel component
4306 k black pixel component
4307 p pad component (always 0)
4308</pre>
4309
cristybac7a162010-06-15 19:57:29 +00004310<p>You can specify as many of these components as needed in any order (e.g.
4311bgr). The components can repeat as well (e.g. rgbr).</p>
4312
cristy3ed852e2009-09-05 21:47:34 +00004313
4314<div style="margin: auto;">
4315 <h4><a name="mask" id="mask"></a>-mask
4316<em class="arg">filename</em></h4>
4317</div>
4318
4319<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>
4320
4321<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
4322
4323<div style="margin: auto;">
4324 <h4><a name="mattecolor" id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
4325</div>
4326
4327<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>
4328
4329<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4330
cristybac7a162010-06-15 19:57:29 +00004331<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4332style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004333
4334<div style="margin: auto;">
cristyd2baf7d2010-03-06 04:26:44 +00004335 <h4><a name="maximum" id="maximum"></a>-maximum</h4>
4336</div>
4337
4338<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>
4339
4340<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004341 <h4><a name="median" id="median"></a>-median <em class="arg">radius</em></h4>
4342</div>
4343
4344<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>
4345
4346<div style="margin: auto;">
4347 <h4><a name="metric" id="metric"></a>-metric <em class="arg">type</em></h4>
4348</div>
4349
4350<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>
4351
4352<p>Choose from:</p>
4353
4354<pre class="text">
cristybac7a162010-06-15 19:57:29 +00004355 AE absolute error count, number of different pixels (-fuzz effected)
4356 MAE mean absolute error (normalized), average channel error distance
4357 MEPP mean error per pixel (normalized mean error, normalized peak error)
4358 MSE mean error squared, average of the channel error squared
4359 PAE peak absolute (normalize peak absolute)
4360 PSNR peak signal to noise ratio
4361 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004362</pre>
4363
4364<p>The '<kbd>AE</kbd>' or absolute count of pixels that are different, can be
4365controled using a <a href="#fuzz" >-fuzz</a> factor to ignore pixels which
4366only changed by a small amount. The '<kbd>PAE</kbd>' can be used to find the
4367size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristybac7a162010-06-15 19:57:29 +00004368'similar', while '<kbd>MAE</kbd>' can be used to find out the factor needed
4369for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004370
4371<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4372('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristybac7a162010-06-15 19:57:29 +00004373normalized) from a single comparision run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004374
cristybac7a162010-06-15 19:57:29 +00004375<p>To print a complete list of metrics, use the <a href="#list">-list
4376metrics</a> option.</p>
4377
cristy3ed852e2009-09-05 21:47:34 +00004378
cristyd2baf7d2010-03-06 04:26:44 +00004379<div style="margin: auto;">
4380 <h4><a name="minimum" id="minimum"></a>-minimum</h4>
4381</div>
4382
4383<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>
4384
cristy3ed852e2009-09-05 21:47:34 +00004385
4386<div style="margin: auto;">
4387 <h4><a name="mode" id="mode"></a>-mode <em class="arg">value</em></h4>
4388</div>
4389
4390<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>
4391
cristybac7a162010-06-15 19:57:29 +00004392<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4393Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004394
cristybac7a162010-06-15 19:57:29 +00004395<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4396for a list of <a href="#mode" >-mode</a> arguments available in your
4397ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004398
4399
4400<div style="margin: auto;">
4401 <h4><a name="modulate" id="modulate"></a>-modulate <em class="arg">brightness</em>[,<em class="arg">saturation</em>,<em class="arg">hue</em>]</h4>
4402</div>
4403
cristybac7a162010-06-15 19:57:29 +00004404<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
4405class="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 +00004406
cristyb36feb22010-03-26 16:54:37 +00004407<p>The arguments are given as a percentages of variation. A value of 100 means
4408no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004409
cristyb36feb22010-03-26 16:54:37 +00004410<p>The <em class="arg">brightness</em> is a multiplier of the overall
4411brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4412twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4413before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004414
cristyb36feb22010-03-26 16:54:37 +00004415<p>The <em class="arg">saturation</em> controls the amount of color in an
4416image. For example, 0 produce a grayscale image, while a large value such as
4417200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004418
cristyb36feb22010-03-26 16:54:37 +00004419<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4420within the image by the amount specified. For example, 50 results in
4421a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4422A value of either 0 or 200 results in a complete 180 degree rotation of the
4423image. Using a value of 300 is a 360 degree rotation resulting in no change to
4424the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004425
cristyb36feb22010-03-26 16:54:37 +00004426<p>For example, to increase the color brightness by 20% and decrease the color
4427saturation by 10% and leave the hue unchanged, use <a
4428href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004429
cristyb36feb22010-03-26 16:54:37 +00004430<p>Use <a href="#set">-set</a> attribute of '<kbd
4431class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4432modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4433<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004434
4435<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 +00004436
cristy3ed852e2009-09-05 21:47:34 +00004437<div style="margin: auto;">
4438 <h4><a name="monitor" id="monitor"></a>-monitor</h4>
4439</div>
4440
4441<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>
4442
4443
4444<div style="margin: auto;">
4445 <h4><a name="monochrome" id="monochrome"></a>-monochrome</h4>
4446</div>
4447
4448<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>
4449
4450
4451<div style="margin: auto;">
4452 <h4><a name="morph" id="morph"></a>-morph <em class="arg">frames</em></h4>
4453</div>
4454
4455<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>
4456
4457<p>Both the image pixels and size are linearly interpolated to give the
4458appearance of a meta-morphosis from one image to the next, over all the images
4459in the current image list. The added images are the equivalent of a <a
4460href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4461argument determine how many images to interpolate between each image. </p>
4462
4463
4464<div style="margin: auto;">
cristy488844c2010-01-22 14:02:05 +00004465 <h4><a name="morphology" id="morphology"></a>-morphology</h4>
4466 <h4><a name="morphology" id="morphology"></a>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
4467</div>
4468
cristy2c839602010-04-03 02:32:08 +00004469<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 +00004470
cristy83a272e2010-05-07 20:40:35 +00004471Until I get around to writing a option summary for this, see <A
4472HREF="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4473Morphology</A>. </P>
4474
4475
cristy488844c2010-01-22 14:02:05 +00004476<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004477 <h4><a name="mosaic" id="mosaic"></a>-mosaic</h4>
4478</div>
4479
4480<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>
4481
4482
4483<div style="margin: auto;">
4484 <h4><a name="motion-blur" 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>
4485</div>
4486
4487<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>
4488
4489<p>Blur with the given radius, standard deviation (sigma), and angle. The
4490angle given is the angle toward which the image is blurred. That is the
4491direction people would consider the object is coming from. </p>
4492
4493<p>Note that the blur is not uniform distribution, giving the motion a
4494definate sense of direction of movement. </p>
4495
4496<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4497pixels which are outside the image proper are blurred into the final result.
4498</p>
4499
4500<div style="margin: auto;">
4501 <h4><a name="name" id="name"></a>-name</h4>
4502</div>
4503
4504<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>
4505<div style="margin: auto;">
4506 <h4><a name="negate" id="negate"></a>-negate</h4>
4507</div>
4508
cristyb29bc032010-02-01 20:29:43 +00004509<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 +00004510
4511<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>
4512
4513<div style="margin: auto;">
4514 <h4><a name="noise" id="noise"></a>-noise <em class="arg">radius</em><br/>
4515 +noise <em class="arg">type</em></h4>
4516</div>
4517
4518<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>
4519
4520<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>
4521
4522<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>
4523
4524<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>
4525
4526<pre class="text">
4527Gaussian
4528Impulse
4529Laplacian
4530Multiplicative
4531Poisson
4532Random
4533Uniform
4534</pre>
4535
4536<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4537
cristy83543962009-10-16 19:04:28 +00004538<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4539the use of a controlling value to specify teh amount of noise that should be
4540added to an image. </p>
4541
cristy3ed852e2009-09-05 21:47:34 +00004542
4543<div style="margin: auto;">
4544 <h4><a name="normalize" id="normalize"></a>-normalize</h4>
4545</div>
4546
4547<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>
4548
cristyd934d102009-10-10 12:55:13 +00004549<p>The intensity values are stretched to cover the entire range of possible
4550values. While doing so, black-out at most <em>2%</em> of the pixels and
4551white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004552
cristyd934d102009-10-10 12:55:13 +00004553<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4554is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4555(Before this version, it was equivalent to <a href="#contrast-stretch"
4556>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004557
cristyd934d102009-10-10 12:55:13 +00004558<p>All the channels are normalized in concert by the came amount so as to
4559preserve color integrity, when the default <a href="#channel" >+channel</a>
4560setting is in use. Specifing any other <a href="#channel" >-channel</a>
4561setting will normalize the RGB channels independently.</p>
4562
4563<p>See <a href="#contrast-stretch" >-contrast-stretch</A> for more details.
4564Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004565that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004566
4567<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004568
4569
4570<div style="margin: auto;">
4571 <h4><a name="ordered-dither" id="ordered-dither"></a>-ordered-dither <em class="arg">threshold_map</em>{,<em class="arg">level</em>...}</h4>
4572</div>
4573
cristyd934d102009-10-10 12:55:13 +00004574<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
4575class="arg">threshold map</em> specified, and a uniform color map with the
4576given 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 +00004577
4578<p>You can choose from these standard threshold maps:</p>
4579
4580<pre class="text">
cristyd934d102009-10-10 12:55:13 +00004581 threshold
cristy3ed852e2009-09-05 21:47:34 +00004582 checks
4583 o2x2
4584 o3x3
4585 o4x4
4586 o8x8
4587 h4x4a
4588 h6x6a
4589 h8x8a
4590 h4x4o
4591 h6x6o
4592 h8x8o
4593 h16x16o
4594</pre>
4595
cristyd934d102009-10-10 12:55:13 +00004596<p>The '<kbd>o</kbd>' maps are ordered diffused pixel threshold maps, while the
4597'<kbd>h</kbd>' maps are halftone threshold maps which are either 'a' angled, or
4598'o' orthogonal. The '<kbd>checks</kbd>' produce a 3 level checkerbord dither
4599pattern. Or you can define your own <em class="arg" >threshold map</em> in a
4600personal or system "<kbd>thresholds.xml</kbd>" XML file. </p>
cristy3ed852e2009-09-05 21:47:34 +00004601
cristyd934d102009-10-10 12:55:13 +00004602<p>To print a complete list of threshold, use the <a href="#list" >-list
4603threshold</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004604
cristyd934d102009-10-10 12:55:13 +00004605<p>It is recommended that the <a href="#map" >+map</a> operator be used after
4606applying <a href="#ordered-dither" >-ordered-dither</a> to reduce the number of
cristy3ed852e2009-09-05 21:47:34 +00004607colors an animated image sequence, to less that 256 colors. This ensures that
4608a common or global color table is used when saving the result to a color
4609limited file format such as GIF. </p>
4610
cristyd934d102009-10-10 12:55:13 +00004611<p>Note that at this time the exact same threshold dithering map is used for
4612all color channels, no attempt is made to offset or rotate the map for
4613different channels is made, to create an offset printing effect. (possible
4614future expansion) </p>
cristy3ed852e2009-09-05 21:47:34 +00004615
4616
4617<div style="margin: auto;">
4618 <h4><a name="opaque" id="opaque"></a>-opaque <em class="arg">color</em></h4>
4619</div>
4620
4621<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>
4622
cristyc54f5d42009-11-27 21:36:31 +00004623<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004624described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4625>-fuzz</a> setting can be used to match and replace colors similar to the one
4626given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004627
cristyb36feb22010-03-26 16:54:37 +00004628<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4629the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004630
cristyb36feb22010-03-26 16:54:37 +00004631<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4632as <a href="#opaque" >-opaque</a> but replaces the matching color with
4633transparency rather than the current <a href="#fill">-fill</a> color setting.
4634To ensure that it can do this it also ensures that the image has an alpha
4635channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4636the new transparent colors, and does not require you to modify the <a
4637href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004638
cristy3ed852e2009-09-05 21:47:34 +00004639
4640<div style="margin: auto;">
4641 <h4><a name="orient" id="orient"></a>-orient <em class="arg">image orientation</em></h4>
4642</div>
4643
4644<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>
4645
4646<p>Choose from these orientations:</p>
4647
4648<pre class="text">
4649 bottom-left
4650 bottom-right
4651 left-bottom
4652 left-top
4653 right-bottom
4654 right-top
4655 top-left
4656 top-right
4657 undefined
4658</pre>
4659
cristyd934d102009-10-10 12:55:13 +00004660<p>To print a complete list of orientations, use the <a href="#list" >-list
4661orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004662
4663
4664<div style="margin: auto;">
4665 <h4><a name="page" id="page"></a>-page <em class="arg">geometry</em><br/>
4666 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4667 +page
4668 </h4>
4669</div>
4670
4671<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>
4672
4673<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>
4674
4675<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>
4676
4677<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>
4678<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4679<thead>
4680 <tr valign="top">
4681 <th align="center"><em class="arg">media</em></th>
4682 <th align="center"><em class="arg">width</em></th>
4683 <th align="center"><em class="arg">height</em></th>
4684 </tr>
4685</thead>
4686<tbody>
4687<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4688<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4689<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4690<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4691<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4692<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4693<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4694<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4695<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4696<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4697<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4698<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4699<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4700<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4701<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4702<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4703<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4704<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4705<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4706<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4707<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4708<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4709<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4710<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4711<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4712<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4713<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4714<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4715<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4716<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4717<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4718<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4719<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4720<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4721<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4722<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4723<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4724<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4725</tbody>
4726</table>
4727
4728
4729
4730
4731<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>
4732
4733<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>
4734
4735<p>The default page dimensions for a TEXT image is 612x792.</p>
4736
4737<p>This option is used in concert with <a href="#density">-density</a>.</p>
4738
4739<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4740
4741<div style="margin: auto;">
4742 <h4><a name="paint" id="paint"></a>-paint <em class="arg">radius</em></h4>
4743</div>
4744
4745<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>
4746
4747<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>
4748
4749<div style="margin: auto;">
4750 <h4><a name="path" id="path"></a>-path <em class="arg">path</em></h4></div>
4751
4752<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>
4753
4754<div style="margin: auto;">
4755 <h4><a name="pause_animate_" id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
4756</div>
4757
4758<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>
4759
4760<p>Pause for the specified number of seconds before repeating the animation.</p>
4761
4762<div style="margin: auto;">
4763 <h4><a name="pause_import_" id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
4764</div>
4765
4766<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>
4767
4768<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4769
4770<div style="margin: auto;">
4771 <h4><a name="ping" id="ping"></a>-ping</h4>
4772</div>
4773
4774<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>
4775
4776<div style="margin: auto;">
4777 <h4><a name="pointsize" id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
4778</div>
4779
4780<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>
4781
4782<div style="margin: auto;">
4783 <h4><a name="polaroid" id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
4784</div>
4785
4786<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>
4787
4788<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4789
4790<div style="margin: auto;">
4791 <h4><a name="posterize" id="posterize"></a>-posterize <em class="arg">levels</em></h4>
4792</div>
4793
4794<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>
4795
4796<div style="margin: auto;">
cristyd43a46b2010-01-21 02:13:41 +00004797 <h4><a name="precision" id="precision"></a>-precision <em class="arg">value</em></h4>
4798</div>
4799
4800<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>
4801
4802<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004803 <h4><a name="preview" id="preview"></a>-preview <em class="arg">type</em></h4>
4804</div>
4805
4806<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>
4807
4808<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>
4809
4810<pre class="text">
4811 Rotate
4812 Shear
4813 Roll
4814 Hue
4815 Saturation
4816 Brightness
4817 Gamma
4818 Spiff
4819 Dull
4820 Grayscale
4821 Quantize
4822 Despeckle
4823 ReduceNoise
4824 Add Noise
4825 Sharpen
4826 Blur
4827 Threshold
4828 EdgeDetect
4829 Spread
4830 Shade
4831 Raise
4832 Segment
4833 Solarize
4834 Swirl
4835 Implode
4836 Wave
4837 OilPaint
4838 CharcoalDrawing
4839 JPEG
4840</pre>
4841
4842<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4843
4844<p>The default preview is <kbd>JPEG</kbd>.</p>
4845
4846<div style="margin: auto;">
4847 <h4><a name="print" id="print"></a>-print <em class="arg">string</em></h4>
4848</div>
4849
4850<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>
4851
4852<div style="margin: auto;">
4853 <h4><a name="process" id="process"></a>-process <em class="arg">command</em></h4>
4854</div>
4855
4856<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>
4857
4858<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>
4859
4860<div style="margin: auto;">
4861 <h4><a name="profile" id="profile"></a>-profile <em class="arg">filename</em><br/>
4862 +profile <em class="arg">profile_name</em></h4>
4863</div>
4864
4865<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>
4866
4867<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>
4868
4869<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>
4870
4871<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>
4872
4873<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>
4874
4875<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4876
4877<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4878<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>
4879
4880<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>
4881<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4882CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4883</p>
4884
4885<div style="margin: auto;">
4886 <h4><a name="quality" id="quality"></a>-quality <em class="arg">value</em></h4>
4887</div>
4888
4889<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>
4890
cristy851dbce2010-08-06 21:40:00 +00004891<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 +00004892
4893<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>
4894
cristy851dbce2010-08-06 21:40:00 +00004895<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 +00004896
cristy851dbce2010-08-06 21:40:00 +00004897<p>For the MNG and PNG image formats, the quality value sets the zlib compression level (quality / 10) and filter-type (quality % 10). Compression levels range from 0 (fastest compression) to 100 (best but slowest). For compression level 0, the Huffman-only strategy is used, which is fastest but not necessarily the worst compression. The default is PNG is 75.</p>
cristy3ed852e2009-09-05 21:47:34 +00004898
4899<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4900
4901<pre class="text">
4902 0: none
4903 1: sub
4904 2: up
4905 3: average
4906 4: Paeth
4907</pre>
4908
4909<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>
4910
4911<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4912
4913<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>
4914
cristy851dbce2010-08-06 21:40:00 +00004915<p>The default is quality is 92, which means nearly the best compression with adaptive filtering. 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 +00004916
4917<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4918
4919<p>When writing a JNG image with transparency, two quality values are required, one for the main image and one for the grayscale image that conveys the alpha channel. These are written as a single integer equal to the main image quality plus 1000 times the opacity quality. For example, if you want to use quality 85 for the main image and quality 90 to compress the opacity data, use <a href="#quality">-quality 90085</a>.</p>
4920
4921<div style="margin: auto;">
4922 <h4><a name="quantize" id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
4923</div>
4924
4925<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>reduce colors in this colorspace.</td><td style='text-align:right;'></td></tr></table>
4926
4927<p>To print a complete list of colorspaces, use the <a href="#list">-list colorspace</a> option.</p>
4928
4929
4930<div style="margin: auto;">
4931 <h4><a name="quiet" id="quiet"></a>-quiet</h4>
4932</div>
4933
4934<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>
4935
4936<div style="margin: auto;">
4937 <h4><a name="radial-blur" id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
4938</div>
4939
4940<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>
4941
4942<p>Note that this is actually a rotational blur rather than a radial and as
4943such actually mis-named. </p>
4944
4945<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4946pixels which are outside the image proper are blurred into the final result.
4947</p>
4948
4949
4950<div style="margin: auto;">
4951 <h4><a name="raise" id="raise"></a>-raise <em class="arg">thickness</em></h4>
4952</div>
4953
4954<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>
4955
4956<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>.
4957</p>
4958
4959<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4960
4961<div style="margin: auto;">
4962 <h4><a name="random-threshold" id="random-threshold"></a>-random-threshold <em class="arg">low</em>x<em class="arg">high</em></h4>
4963</div>
4964
4965<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>
4966
4967<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004968 <h4><a name="red-primary" id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
4969</div>
4970
4971<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>
4972
4973<div style="margin: auto;">
4974 <h4><a name="regard-warnings" id="regard-warnings"></a>-regard-warnings</h4>
4975</div>
4976
4977<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>
4978
4979<div style="margin: auto;">
4980 <h4><a name="remap" id="remap"></a>-remap <em class="arg">filename</em></h4>
4981</div>
4982
4983<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>
4984
4985<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4986the given colors are dithered over the image as necessary, otherwise the closest
4987color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4988
4989<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4990images in the current image sequence, all the images will have the same color
4991table. That means that when saved to a file format such as GIF, it will use
4992that color table as a single common or global color table, for all the images,
4993without requiring extra local color tables. </p>
4994
4995<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4996sequence to use a common color map over all the images. This equivalent to
4997appending all the images together (without extra background colors) and color
4998reducing those images using <a href="#colors">-colors</a> with a 256 color
4999limit, then <a href="#remap">-remap</a> those colors over the original list of
5000images. This ensures all the images follow a single color map. </p>
5001
5002<p>If the number of colors over all the images is less than 256, then <a
5003href="#remap">+remap</a> should not perform any color reduction or dithering, as
5004no color changes are needed. In that case, its only effect is to force the use
5005of a global color table. This recommended after using either <a
5006href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
5007reduce the number of colors in an animated image sequence. </p>
5008
5009<div style="margin: auto;">
5010 <h4><a name="region" id="region"></a>-region <em class="arg">geometry</em></h4>
5011</div>
5012
5013<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>
5014
5015<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>
5016
5017<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>
5018
5019<div style="margin: auto;">
5020 <h4><a name="remote" id="remote"></a>-remote</h4>
5021</div>
5022
5023<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>
5024
5025<p>The only command recognized is the name of an image file to load.</p>
5026
5027<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>
5028
5029<div style="margin: auto;">
5030 <h4><a name="render" id="render"></a>-render</h4>
5031</div>
5032
5033<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>
5034
5035<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>
5036
5037<div style="margin: auto;">
5038<h4><a name="repage" id="repage"></a>-repage <em class="arg">geometry</em></h4>
5039</div>
5040
5041<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>
5042
5043<p>This option is like <a href="#page">-page</a> but acts as an image operator
5044rather than a setting. You can separately set the canvas size or the offset
5045of the image on that canvas by only providing those components. </p>
5046
5047<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>
5048
5049<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
5050offset to move the image relative to its previous position. This useful for
5051animation sequences. </p>
5052
5053<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
5054recalculate the canvas size so the image (at its current offset) will appear
5055completely on that canvas (unless it has a negative offset).</p>
5056
5057<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
5058canvas meta-data from the images. </p>
5059
5060<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
5061directly assign virtual canvas meta-data. </p>
5062
5063
5064<div style="margin: auto;">
5065 <h4><a name="resample" id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
5066</div>
5067
5068<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>
5069
5070<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>
5071
5072<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>
5073
5074<div style="margin: auto;">
5075 <h4><a name="resize" id="resize"></a>-resize <em class="arg">geometry</em></h4>
5076</div>
5077
5078<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>
5079
5080<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>
5081
5082<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>
5083
cristy13538962010-02-26 17:53:04 +00005084<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>
5085
cristy4949d522010-03-12 18:41:34 +00005086<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 +00005087<div style="margin: auto;">
5088 <h4><a name="respect-parentheses" id="respect-parentheses"></a>-respect-parentheses</h4>
5089</div>
5090
5091<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>
5092
5093<div style="margin: auto;">
5094 <h4><a name="reverse" id="reverse"></a>-reverse</h4>
5095</div>
5096
5097<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>
5098
5099
5100<div style="margin: auto;">
5101 <h4><a name="roll" id="roll"></a>-roll {<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em></h4>
5102</div>
5103
5104<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>
5105
5106<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>
5107
5108
5109<div style="margin: auto;">
5110 <h4><a name="rotate" id="rotate"></a>-rotate <em class="arg">degrees</em>{<em class="arg">&lt;</em>}{<em class="arg">&gt;</em>}</h4>
5111</div>
5112
5113<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>
5114
5115<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>
5116
5117<p>Empty triangles in the corners, left over from rotating the image, are
5118filled with the <kbd>background</kbd> color. </p>
5119
5120<p>See also the <a href="#distort">-distort</a> operator and specifically the
5121'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5122
5123
5124<div style="margin: auto;">
5125 <h4><a name="sample" id="sample"></a>-sample <em class="arg">geometry</em></h4>
5126</div>
5127
5128<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>scale image using pixel sampling.</td><td style='text-align:right;'></td></tr></table>
5129
5130<p><a href="#sample">-sample</a> ignores the current <a href="#resize">-resize</a> <a href="#filter">-filter</a> setting. The results are equivalent to using <a href="#resize">-resize</a> with a <a href="#filter">-filter</a> setting of <kbd>point</kbd>, though <a href="#sample">-sample</a> is a lot faster. </p>
5131
5132<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>
5133
5134
5135<div style="margin: auto;">
5136 <h4><a name="sampling-factor" id="sampling-factor"></a>-sampling-factor <em class="arg">horizontal-factor</em>x<em class="arg">vertical-factor</em></h4>
5137</div>
5138
5139<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>
5140
5141<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>
5142
5143<div style="margin: auto;">
5144 <h4><a name="scale" id="scale"></a>-scale <em class="arg">geometry</em></h4>
5145</div>
5146
5147<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>scale the image.</td><td style='text-align:right;'></td></tr></table>
5148
5149<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="#scale">-scale</a> option uses a simpler, faster algorithm than <a href="#resize">-resize</a>, and it ignores the <a href="#filter">-filter</a> setting if one is present. Offsets, if present in the <em class="arg">geometry</em> string, are ignored, and the <a href="#gravity">-gravity</a> option has no effect.</p>
5150
5151<div style="margin: auto;">
5152 <h4><a name="scene" id="scene"></a>-scene <em class="arg">value</em></h4>
5153</div>
5154
5155<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>
5156
5157<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5158
5159<div style="margin: auto;">
5160 <h4><a name="screen" id="screen"></a>-screen</h4>
5161</div>
5162
5163<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>
5164
5165<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>
5166
5167<div style="margin: auto;">
5168 <h4><a name="seed" id="seed"></a>-seed</h4>
5169</div>
5170
5171<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>
5172
5173<div style="margin: auto;">
5174 <h4><a name="segment" id="segment"></a>-segment <em class="arg">cluster-threshold</em>x<em class="arg">smoothing-threshold</em></h4>
5175</div>
5176
5177<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>
5178
5179<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>
5180
5181<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>
5182
5183<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5184of the color clusters is returned.</p>
5185
5186
5187<div style="margin: auto;">
5188 <h4><a name="selective-blur" id="selective-blur"></a>-selective-blur <em class="arg">geometry</em></h4>
5189</div>
5190
5191<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>
5192
5193<div style="margin: auto;">
5194 <h4><a name="separate" id="separate"></a>-separate</h4>
5195</div>
5196
5197<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>
5198
5199<div style="margin: auto;">
5200 <h4><a name="sepia-tone" id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
5201</div>
5202
5203<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>
5204
5205<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5206
5207<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>
5208
5209<div style="margin: auto;">
5210 <h4><a name="set" id="set"></a>-set <em class="arg">attribute value</em></h4>
5211</div>
5212
5213<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set an image attribute for all images in the current image sequence, after they have been created or read in. </td><td style='text-align:right;'></td></tr></table>
5214
5215<p>Attributes of interest include <a href="#comment">-comment</a>, <a href="#delay">-delay</a>, <a href="#dispose">-dispose</a>, and <a href="#page">-page</a>. For example:</p>
5216
cristy4949d522010-03-12 18:41:34 +00005217<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' \ <br/> rose.png</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -format %c rose.png</span><span class='crtout'>Rose is a rose is a rose is a rose</span></p>
cristy3ed852e2009-09-05 21:47:34 +00005218<p>The <a href="#repage">-repage</a> operator will also set the
5219'<kbd>page</kbd>' attribute of images already in memory, but allows you to
5220separately set the virtual canvas's size and offset components, and also allows
5221relative offset changes, and automatic canvas size re-calculating. The above
5222<a href="#set">-set</a> option is purely a direct, unmodified assignment of the
5223virtual canvas (page) meta-data. </p>
5224
cristy0391e8d2010-04-10 01:36:10 +00005225<p>Use this option to associate a colorspace or profile with your image. For example,</p>
5226<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>
cristy3ed852e2009-09-05 21:47:34 +00005227<p>Set image options by prefixing the value with <kbd>option:</kbd>. Set attributes of the image registry by prefixing the value with <kbd>registry:</kbd>.</p>
5228
5229<div style="margin: auto;">
5230 <h4><a name="shade" id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
5231</div>
5232
5233<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>
5234
5235<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>
5236
5237<div style="margin: auto;">
5238 <h4><a name="shadow" 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>
5239</div>
5240
5241<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>
5242
5243<div style="margin: auto;">
5244 <h4><a name="shared-memory"
5245id="shared-memory"></a>-shared-memory</h4>
5246</div>
5247
5248<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>
5249
5250<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>
5251
5252<div style="margin: auto;">
5253 <h4><a name="sharpen" id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
5254</div>
5255
5256<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>
5257
5258<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5259
5260<div style="margin: auto;">
5261 <h4><a name="shave" id="shave"></a>-shave <em class="arg">geometry</em></h4>
5262</div>
5263
5264<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>
5265
5266<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>
5267
5268<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>
5269
5270<div style="margin: auto;">
5271 <h4><a name="shear" id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
5272</div>
5273
5274<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>
5275
5276<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>
5277
5278<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>
5279
5280<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>
5281
5282<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>
5283
5284<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>
5285<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>
5286
5287<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5288<div style="margin: auto;">
5289 <h4><a name="sigmoidal" id="sigmoidal-contrast"></a>-sigmoidal-contrast <em class="arg">contrast</em>x<em class="arg">mid-point</em></h4>
5290</div>
5291
5292<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>
5293
5294<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>
5295
5296<div style="margin: auto;">
5297 <h4><a name="silent" id="silent"></a>-silent</h4>
5298</div>
5299
5300<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>
5301
5302<div style="margin: auto;">
5303 <h4><a name="size" id="size"></a>-size <em class="arg">width</em>[x<em class="arg">height</em>][<em class="arg">+offset</em>]</h4>
5304</div>
5305
5306<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>
5307
5308<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>
5309
5310<p>For Photo CD images, choose from these sizes:</p>
5311
5312<pre class="text">
5313 192x128
5314 384x256
5315 768x512
5316 1536x1024
5317 3072x2048
5318</pre>
5319
cristy3ed852e2009-09-05 21:47:34 +00005320<div style="margin: auto;">
5321 <h4><a name="sketch" 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>
5322</div>
5323
5324<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>
5325
5326<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>
5327
5328<div style="margin: auto;">
5329 <h4><a name="snaps" id="snaps"></a>-snaps <em class="arg">value</em></h4>
5330</div>
5331
5332<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>
5333
5334<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5335
5336<div style="margin: auto;">
5337 <h4><a name="solarize" id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
5338</div>
5339
5340<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>
5341
5342<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5343
5344<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5345
5346<div style="margin: auto;">
5347 <h4><a name="sparse-color" id="sparse-color"></a>-sparse-color <em
5348 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5349</div>
5350
5351<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>
5352
5353
5354<table class="doc">
5355 <tbody>
5356 <tr valign="top">
5357 <th align="left" style="width: 8%">Method</th>
5358 <th align="left">Description</th>
5359 </tr>
5360
5361 <tr valign="top">
5362 <td valign="top">voronoi</td>
5363 <td valign="top">Simply map each pixel to the to nearest color point
5364 given. The result are polygonal 'cells' of solid color. </td>
5365 </tr>
5366
5367 <tr valign="top">
5368 <td valign="top">shepards</td>
5369 <td valign="top">Colors points basied on the ratio of inverse distance
5370 squared. Generating spots of color in a sea of the average of
5371 colors. </td>
5372 </tr>
5373
5374 <tr valign="top">
5375 <td valign="top">barycentric</td>
5376 <td valign="top">three point triangle of color given 3 points.
5377 Giving only 2 points will form a linear gradient between those points.
5378 Gradient is however not restricted to just the triangle or line. </td>
5379 </tr>
5380
5381 <tr valign="top">
5382 <td valign="top">bilinear</td>
5383 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5384 fall back to barycentric. </td>
5385 </tr>
5386
5387 </tbody>
5388</table>
5389
5390<p>The points are placed according to the images location on the virtual
5391canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5392offset), and do not actually have to exist on the given image, but may be
5393some point beyond the edge of the image. All points are floating point values.
5394</p>
5395
5396<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
5397modified, whcih means the matte/alpha transparency channel is not effected by
5398default. If enabled, the image also needs a the matte/alpha channel to be
5399enabled for this operator to effect an images transparency. This is typical
5400transparency handling for images. </p>
5401
5402<p>All the above methods when given a single point of color will replace all
5403the colors in the image with the color given, regardless of the point. This is
5404logical, and provides an alternative technique to recolor a image to some
5405default value. </p>
5406
5407
5408<div style="margin: auto;">
5409 <h4><a name="splice" id="splice"></a>-splice <em class="arg">geometry</em></h4>
5410</div>
5411
5412<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>
5413
5414<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>
5415
5416<div style="margin: auto;">
5417 <h4><a name="spread" id="spread"></a>-spread <em class="arg">amount</em></h4>
5418</div>
5419
5420<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>
5421
5422<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>
5423
5424<div style="margin: auto;">
5425 <h4><a name="stegano" id="stegano"></a>-stegano <em class="arg">offset</em></h4>
5426</div>
5427
5428<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>
5429
5430<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>
5431
5432<div style="margin: auto;">
5433 <h4><a name="stereo" id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
5434</div>
5435
5436<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>
5437
5438<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>
5439
5440<div style="margin: auto;">
5441 <h4><a name="storage-type" id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
5442</div>
5443
5444<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>
5445
5446<pre class="text">
5447 char store pixels as unsigned characters
5448 double store pixels as doubles
5449 float store pixels as floats
5450 integer store pixels as integers
5451 long store pixels as longs
5452 quantum store pixels in the native depth of your ImageMagick distribution
5453 short store pixels as unsigned shorts
5454</pre>
5455
5456<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5457values range from 0 to the maximum value the storage type can support.</p>
5458
5459<div style="margin: auto;">
5460 <h4><a name="stretch" id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
5461</div>
5462
5463<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>
5464
5465<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>
5466
5467<pre class="text">
5468 Any
5469 Condensed
5470 Expanded
5471 ExtraCondensed
5472 ExtraExpanded
5473 Normal
5474 SemiCondensed
5475 SemiExpanded
5476 UltraCondensed
5477 UltraExpanded
5478</pre>
5479
5480<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5481
5482<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>
5483
5484<div style="margin: auto;">
5485 <h4><a name="strip" id="strip"></a>-strip</h4>
5486</div>
5487
5488<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>
5489
5490<div style="margin: auto;">
5491 <h4><a name="stroke" id="stroke"></a>-stroke <em class="arg">color</em></h4>
5492</div>
5493
5494<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>
5495
5496<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5497
5498<p>See <a href="#draw">-draw</a> for further details.</p>
5499
5500<div style="margin: auto;">
5501 <h4><a name="strokewidth" id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
5502</div>
5503
5504<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>
5505
5506<p>See <a href="#draw">-draw</a> for further details.</p>
5507
5508<div style="margin: auto;">
5509 <h4><a name="style" id="style"></a>-style <em class="arg">fontStyle</em></h4>
5510</div>
5511
5512<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>
5513
5514<p>This setting suggests a font style that ImageMagick should try to apply to the currently selected font family. Select <em class="arg">fontStyle</em> from the following.</p>
5515
5516<pre class="text">
5517 Any
5518 Italic
5519 Normal
5520 Oblique
5521</pre>
5522
5523<p>For other settings that affect fonts, see the options <a href="#font">-font</a>, <a href="#family">-family</a>, <a href="#stretch">-stretch</a>, and <a href="#weight">-weight</a>. </p>
5524
5525<div style="margin: auto;">
5526 <h4><a name="swap" id="swap"></a>-swap <em class="arg">index,index</em></h4>
5527</div>
5528
5529<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>
5530
5531<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third images in the current image sequence. Use <a href="#swap">+swap</a> to switch the last two images in the sequence.</p>
5532
5533<div style="margin: auto;">
5534 <h4><a name="swirl" id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
5535</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;">
5542 <h4><a name="taint" id="taint"></a>-taint</h4>
5543</div>
5544
5545<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Mark the image as modified even if it isn't.</td><td style='text-align:right;'></td></tr></table>
5546
5547<div style="margin: auto;">
5548 <h4><a name="text-font" id="text-font"></a>-text-font <em class="arg">name</em></h4>
5549</div>
5550
5551<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>
5552
5553<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>
5554
5555<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>
5556
5557<div style="margin: auto;">
5558 <h4><a name="texture" id="texture"></a>-texture <em class="arg">filename</em></h4>
5559</div>
5560
5561<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>
5562
5563<div style="margin: auto;">
5564 <h4><a name="threshold" id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
5565</div>
5566
5567<!-- {<em class="arg">green,blue,opacity</em>}
5568<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>
5569-->
5570
5571<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>
5572
5573<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>
5574
5575<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.
5576</p>
5577
5578<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>
5579
5580<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5581<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>
5582
5583
5584<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>
5585<p>Note that the values of the transparency channel is treated as 'matte'
5586values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5587
5588<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>.
5589</p>
5590
5591<div style="margin: auto;">
5592 <h4><a name="thumbnail" id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
5593</div>
5594
5595<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>
5596
5597<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>
5598
5599<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>
5600
5601<div style="margin: auto;">
5602 <h4><a name="tile" id="tile"></a>-tile <em class="arg">filename</em></h4>
5603</div>
5604
5605<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>
5606
5607<div style="margin: auto;">
5608 <h4>-tile <em class="arg">geometry</em></h4>
5609</div>
5610
5611<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>
5612
5613<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>
5614
5615<div style="margin: auto;">
5616 <h4>-tile</h4>
5617</div>
5618
5619<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>
5620
5621<div style="margin: auto;">
5622 <h4><a name="tile-offset" 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>
5623</div>
5624
5625<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>
5626
5627<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>
5628
5629<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>
5630
5631<div style="margin: auto;">
5632 <h4><a name="tint" id="tint"></a>-tint <em class="arg">value</em></h4>
5633</div>
5634
5635<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>
5636
5637<p>Tint the image with the fill color.</p>
5638
5639<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>
5640
5641<div style="margin: auto;">
5642 <h4><a name="title" id="title"></a>-title <em class="arg">string</em></h4>
5643</div>
5644
5645<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>
5646
5647<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>
5648
5649<p>For example,</p>
5650
5651<p class="crtsnip">
5652 -title "%m:%f %wx%h"
5653</p>
5654
5655<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>
5656
5657
5658<div style="margin: auto;">
5659 <h4><a name="transform" id="transform"></a>-transform</h4>
5660</div>
5661
5662<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>
5663
5664<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5665
5666<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 +00005667
5668<p>This operator has been now been superseded by the <a
5669href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5670
5671
cristy3ed852e2009-09-05 21:47:34 +00005672<div style="margin: auto;">
5673 <h4><a name="transparent" id="transparent"></a>-transparent <em class="arg">color</em></h4>
5674</div>
5675
5676<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>
5677
5678<p>The <em class="arg">color</em> argument is defined using the format
5679described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5680>-fuzz</a> setting can be used to match and replace colors similar to the one
5681given. </p>
5682
cristyb36feb22010-03-26 16:54:37 +00005683<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5684that is make all non-matching colors transparent. </p>
5685
cristy3ed852e2009-09-05 21:47:34 +00005686<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005687href="#transparent" >-transparent</a> but replaces the matching color with the
5688current <a href="#fill">-fill</a> color setting, rather than transparent.
5689However the <a href="#transparent" >-transparent</a> operator also ensures
5690that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5691>-alpha</a> set</kbd>", and does not require you to modify the <a
5692href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005693
cristyb36feb22010-03-26 16:54:37 +00005694<p>Note that this does not define the color as being the 'transparency color'
5695used for color-mapped image formats, such as GIF. For that use <a
5696href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005697
5698
5699<div style="margin: auto;">
5700 <h4><a name="transparent-color" id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
5701</div>
5702
5703<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>
5704
5705<p>Sometimes this is used for saving to image formats such as
5706GIF and PNG8 which uses this color to represent boolean transparency. This
5707does not make a color transparent, it only defines what color the transparent
5708color is in the color palette of the saved image. Use <a
5709href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5710
5711<p>This option allows you to have both an opaque visible color, as well as a
5712transparent color of the same color value without conflict. That is, you can
5713use the same color for both the transparent and opaque color areas within an
5714image. This, in turn, frees to you to select a transparent color that is
5715appropriate when an image is displayed by an application that does not handle a
5716transparent color index, while allowing ImageMagick to correctly handle images of this
5717type. </p>
5718
5719<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5720
5721<div style="margin: auto;">
5722 <h4><a name="transpose" id="transpose"></a>-transpose</h4>
5723</div>
5724
5725<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>
5726
5727<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5728</p>
5729
5730<div style="margin: auto;">
5731 <h4><a name="transverse" id="transverse"></a>-transverse</h4>
5732</div>
5733
5734<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>
5735
5736
5737<div style="margin: auto;">
5738 <h4><a name="treedepth" id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
5739</div>
5740
5741<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>
5742
5743<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>
5744
5745<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>
5746
5747<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>
5748
5749<div style="margin: auto;">
5750 <h4><a name="trim" id="trim"></a>-trim</h4>
5751</div>
5752
5753<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>
5754
5755<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>
5756
5757<p>The page or virtual canvas information of the image is preserved allowing
5758you to extract the result of the <a href="#trim">-trim</a> operation from the
5759image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5760information if it is unwanted.</p>
5761
5762<p>If the trimmed image 'disappears' an warning is produced, and a special
5763single pixel transparent 'missed' image is returned, in the same way as when a
5764<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5765
5766
5767<div style="margin: auto;">
5768 <h4><a name="type" id="type"></a>-type <em class="arg">type</em></h4>
5769</div>
5770
5771<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>
5772 <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>, <kbd>ColorSeparationMatte</kbd>, or <kbd>Optimize</kbd>.</p>
5773
5774<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>
5775
5776<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5777<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>
5778
5779<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5780
5781<div style="margin: auto;">
5782 <h4><a name="undercolor" id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
5783</div>
5784
5785<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>
5786
5787<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5788
5789<p>See <a href="#draw">-draw</a> for further details.</p>
5790
5791
5792<div style="margin: auto;">
5793 <h4><a name="update" id="update"></a>-update <em class="arg">seconds</em></h4>
5794</div>
5795
5796<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>
5797
5798<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>
5799
5800
5801<div style="margin: auto;">
5802 <h4><a name="unique-colors" id="unique-colors"></a>-unique-colors</h4>
5803</div>
5804
5805<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>
5806
5807
5808<div style="margin: auto;">
5809 <h4><a name="units" id="units"></a>-units <em class="arg">type</em></h4>
5810</div>
5811
5812<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>
5813
5814<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>
5815
5816
5817<div style="margin: auto;">
5818 <h4><a name="unsharp" 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>
5819</div>
5820
5821<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>
5822
5823<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>
5824
5825<p>The parameters are:</p>
5826
5827<pre class="text">
5828 radius: The radius of the Gaussian, in pixels, not counting the center
5829 pixel (default 0).
5830 sigma: The standard deviation of the Gaussian, in pixels (default 1.0).
5831 amount: The fraction of the difference between the original and the blur
5832 image that is added back into the original (default 1.0).
5833 threshold: The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5834 difference amount (default 0.05).
5835</pre>
5836
5837
5838<div style="margin: auto;">
5839 <h4><a name="verbose" id="verbose"></a>-verbose</h4>
5840</div>
5841
5842<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 preceds the <a href="#identify">-identify</a> option or <kbd>info:</kbd>.</td><td style='text-align:right;'></td></tr></table>
5843
5844
5845<div style="margin: auto;">
5846 <h4><a name="version" id="version"></a>-version</h4>
5847</div>
5848
5849<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>
5850
5851
5852<div style="margin: auto;">
5853 <h4><a name="view" id="view"></a>-view <em class="arg">string</em></h4>
5854</div>
5855
5856<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>
5857
5858
5859<div style="margin: auto;">
5860 <h4><a name="vignette" 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>
5861</div>
5862
5863<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>
5864
5865
5866<div style="margin: auto;">
5867 <h4><a name="virtual-pixel" id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
5868</div>
5869
5870<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>
5871
5872<p>This option defines what color source should be used if and when a color
5873lookup completely 'misses' the source image. The color(s) that appear to
5874surround the source image. Generally this color is derived from the source
5875image, but could also be set to a specify background color. </p>
5876
5877<p>Choose from these methods:</p>
5878
5879<pre class="text">
5880 background: the area surrounding the image is the background color
5881 black: the area surrounding the image is black
5882 checker-tile: alternate squares with image and background color
5883 dither: non-random 32x32 dithered pattern
5884 edge: extend the edge pixel toward infinity
5885 gray: the area surrounding the image is gray
5886 horizontal-tile: horizontally tile the image, background color above/below
5887 horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
5888 mirror: mirror tile the image
5889 random: choose a random pixel from the image
5890 tile: tile the image (default)
5891 transparent: the area surrounding the image is transparent blackness
5892 vertical-tile: vertically tile the image, sides are background color
5893 vertical-tile-edge: vertically tile the image and replicate the side edge pixels
5894 white: the area surrounding the image is white
5895</pre>
5896
5897<p>The default value is "edge".</p>
5898
5899<p>This most important for distortion operators such as <a href="#distort"
5900>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
5901However it also effects operations that may access pixels just outside the
5902image proper, such as <a href="#convolve">-convolve</a>, <a
5903href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
5904
5905<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
5906
5907
5908<div style="margin: auto;">
5909 <h4><a name="visual" id="visual"></a>-visual <em class="arg">type</em></h4>
5910</div>
5911
5912<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>
5913
5914<p>Choose from these visual classes:</p>
5915
5916<pre class="text">
5917 StaticGray
5918 GrayScale
5919 StaticColor
5920 PseudoColor
5921 TrueColor
5922 DirectColor
5923 default
5924 visual id
5925</pre>
5926
5927<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>
5928
5929
5930<div style="margin: auto;">
5931 <h4><a name="watermark" id="watermark"></a>-watermark <em
5932 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
5933</div>
5934
5935<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
5936saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5937
5938<p>Take a grayscale image (with alpha mask) and modify the destination image's
5939brightness according to watermark image's grayscale value and the <em
5940class="arg">brightness</em> percentage. The destinations color saturation
5941attribute is just direct modified by the <em class="arg">saturation</em>
5942percentage, which defaults to 100 percent (no color change). </p>
5943
5944
5945<div style="margin: auto;">
5946 <h4><a name="wave" id="wave"></a>-wave <em class="arg">amplitude</em><br />-wave <em class="arg">amplitude</em>x<em class="arg">wavelength</em></h4>
5947</div>
5948
5949<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>
5950
5951<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
5952
5953<div style="margin: auto;">
5954 <h4><a name="weight" id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
5955</div>
5956
5957<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>
5958
5959<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>
5960
5961<table class="doc">
5962 <col width="25%" />
5963 <col width="75%" />
5964 <thead>
5965 <tr>
5966 <th><em class="arg">fontWeight</em></th>
5967 <th>Description</th>
5968 </tr>
5969 </thead>
5970 <tbody>
5971 <tr><td>All </td> <td>No effect. </td></tr>
5972 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
5973 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
5974 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
5975 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
5976 </tbody>
5977 </table>
5978
5979<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
5980
5981<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>
5982
5983<div style="margin: auto;">
5984 <h4><a name="white-point" id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
5985</div>
5986
5987<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>
5988
5989<div style="margin: auto;">
cristy5cadd612009-09-21 19:33:41 +00005990 <h4><a name="white-threshold" id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005991</div>
5992
cristy5cadd612009-09-21 19:33:41 +00005993<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>
5994
5995<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.
5996</p>
cristy3ed852e2009-09-05 21:47:34 +00005997
5998<div style="margin: auto;">
5999 <h4><a name="window" id="window"></a>-window <em class="arg">id</em></h4>
6000</div>
6001
6002<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>
6003
6004<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>
6005
6006<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>
6007
6008<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>
6009
6010<div style="margin: auto;">
6011 <h4><a name="window-group" id="window-group"></a>-window-group</h4>
6012</div>
6013
6014<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>
6015
6016<div style="margin: auto;">
6017 <h4><a name="write" id="write"></a>-write <em class="arg">filename</em></h4>
6018</div>
6019
6020<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>
6021 <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>
6022
6023<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
6024
cristy3eaa0ef2010-03-06 20:35:26 +00006025
6026</div>
6027
6028<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006029 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006030 <span id="linkbar-center">
6031 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006032 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006033 </span>
6034 <span id="linkbar-east">&nbsp;</span>
6035 </div>
6036 <div class="footer">
6037 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
6038 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6039 </div>
6040 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006041 <script type="text/javascript">
6042 var _gaq = _gaq || [];
6043 _gaq.push(['_setAccount', 'UA-17690367-1']);
6044 _gaq.push(['_trackPageview']);
6045
6046 (function() {
6047 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6048 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6049 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6050 })();
6051 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006052</body>
6053</html>