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