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