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