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