blob: 5a747be52c3560be0bfcc6a8afdc20175104358e [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>
cristy3c98a4f2010-08-13 20:09:41 +00009 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
11 <title>ImageMagick: Command-line Options</title/>
cristy3ed852e2009-09-05 21:47:34 +000012 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000015 <meta name="Application-name" content="ImageMagick"/>
16 <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."/>
17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000018 <meta name="Generator" content="PHP"/>
19 <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"/>
cristy3ed852e2009-09-05 21:47:34 +000020 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +000026 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000027 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +000028 <link rel="icon" href="../images/wand.png" sizes="32x32"/>
29 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
31 <style type="text/css" media="all">
32 @import url("../www/magick.css");
33 </style>
cristy3eaa0ef2010-03-06 20:35:26 +000034</head>
35
36<body id="www-imagemagick-org">
37<div class="titlebar">
38<a href="../index.html">
39 <img src="../images/script.png" alt="[ImageMagick]"
40 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
41<a href="http://www.networkredux.com">
42 <img src="../images/networkredux.png" alt="[sponsor]"
43 style="margin: 45px auto; border: 0px; float: left;" /></a>
44<a href="http://www.imagemagick.org/discourse-server/">
45 <img src="../images/logo.jpg" alt=""
46 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
47<a href="../index.html">
48 <img src="../images/sprite.jpg" alt=""
49 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
50</div>
51
cristyce69bb02010-07-27 19:49:46 +000052<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000053
cristy3ed852e2009-09-05 21:47:34 +000054<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000055 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000056</div>
cristy3eaa0ef2010-03-06 20:35:26 +000057<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000058<div class="menu">
cristybb503372010-05-27 20:51:26 +000059 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
60</div>
61<div class="sub">
62 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
63</div>
64<div class="sub">
65 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
66</div>
67<div class="sub">
68 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
69</div>
70<div class="sep"></div>
71<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000072 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</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: Processing" href="../www/command-line-processing.html">Processing</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: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000079</div>
80<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000081 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000082</div>
83<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000084 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000085</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000087 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000088</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000090 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000091</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
cristy3eaa0ef2010-03-06 20:35:26 +000098<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000099<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Install from Source" href="../www/install-source.html">Install from Source</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: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000106 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000107 </div>
108<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
cristybb503372010-05-27 20:51:26 +0000111<div class="menu">
112 <a title="Architecture" href="../www/architecture.html">Architecture</a>
113</div>
cristy3ed852e2009-09-05 21:47:34 +0000114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Site Map"href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000124</div>
125<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Site Map: Links"href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000127</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000128<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000129<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000131
132<div class="sponsbox">
133<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000134 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
135</div>
136<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000137 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy787d4352010-03-06 13:55:58 +0000138</div>
139<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000140 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000141</div>
142<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000143 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy1f9e1ed2009-11-18 04:09:38 +0000144</div>
145<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000146 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000147</div>
148<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000149 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyc49f7992009-09-22 22:48:40 +0000150</div>
cristy9c60d3f2010-08-09 02:29:30 +0000151<div class="sponsor">
cristybc9539a2010-08-16 18:06:20 +0000152 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristy9c60d3f2010-08-09 02:29:30 +0000153</div>
cristy3ed852e2009-09-05 21:47:34 +0000154</div>
155</div>
cristyce69bb02010-07-27 19:49:46 +0000156</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000157
cristyce69bb02010-07-27 19:49:46 +0000158<div class="eastbar">
159 <script type="text/javascript">
160 <!--
161 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000162 google_ad_slot = "0574824969";
163 google_ad_width = 160;
164 google_ad_height = 600;
165 //-->
166 </script>
167 <script type="text/javascript"
168 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
169 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000170</div>
171
172<div class="main">
173
cristy5cadd612009-09-21 19:33:41 +0000174<p class="navigation-index">
cristyae6203d2010-08-09 01:12:14 +0000175[ <a href="../www/command-line-options.html#adaptive-blur">&#x2011;adaptive&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adaptive-resize">&#x2011;adaptive&#x2011;resize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adaptive-sharpen">&#x2011;adaptive&#x2011;sharpen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adjoin">&#x2011;adjoin</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#affine">&#x2011;affine</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#alpha">&#x2011;alpha</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#annotate">&#x2011;annotate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#antialias">&#x2011;antialias</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#append">&#x2011;append</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#attenuate">&#x2011;attenuate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#authenticate">&#x2011;authenticate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-gamma">&#x2011;auto&#x2011;gamma</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-level">&#x2011;auto&#x2011;level</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-orient">&#x2011;auto&#x2011;orient</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#backdrop">&#x2011;backdrop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#background">&#x2011;background</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bench">&#x2011;bench</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bias">&#x2011;bias</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blackpoint-compensation">&#x2011;blackpoint&#x2011;compensation</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#black-threshold">&#x2011;black&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blend">&#x2011;blend</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blue-primary">&#x2011;blue&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blue-shift">&#x2011;blue&#x2011;shift</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blur">&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#border">&#x2011;border</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bordercolor">&#x2011;bordercolor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#borderwidth">&#x2011;borderwidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#brightness-contrast">&#x2011;brightness&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cache">&#x2011;cache</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#caption">&#x2011;caption</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cdl">&#x2011;cdl</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#channel">&#x2011;channel</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#charcoal">&#x2011;charcoal</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#chop">&#x2011;chop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clamp">&#x2011;clamp</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip">&#x2011;clip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip-mask">&#x2011;clip&#x2011;mask</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip-path">&#x2011;clip&#x2011;path</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clone">&#x2011;clone</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clut">&#x2011;clut</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#coalesce">&#x2011;coalesce</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colorize">&#x2011;colorize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colormap">&#x2011;colormap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#color-matrix">&#x2011;color&#x2011;matrix</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colors">&#x2011;colors</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colorspace">&#x2011;colorspace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#combine">&#x2011;combine</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#comment">&#x2011;comment</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#compose">&#x2011;compose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#composite">&#x2011;composite</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#compress">&#x2011;compress</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#contrast">&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#contrast-stretch">&#x2011;contrast&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#convolve">&#x2011;convolve</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#crop">&#x2011;crop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cycle">&#x2011;cycle</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#debug">&#x2011;debug</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#decipher">&#x2011;decipher</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#deconstruct">&#x2011;deconstruct</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#define">&#x2011;define</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#delay">&#x2011;delay</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#delete">&#x2011;delete</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#density">&#x2011;density</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#depth">&#x2011;depth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#descend">&#x2011;descend</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#deskew">&#x2011;deskew</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#despeckle">&#x2011;despeckle</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#direction">&#x2011;direction</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#displace">&#x2011;displace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#display">&#x2011;display</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dispose">&#x2011;dispose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dissimilarity-threshold">&#x2011;dissimilarity&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dissolve">&#x2011;dissolve</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#distort">&#x2011;distort</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dither">&#x2011;dither</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#draw">&#x2011;draw</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#edge">&#x2011;edge</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#emboss">&#x2011;emboss</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#encipher">&#x2011;encipher</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#encoding">&#x2011;encoding</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#endian">&#x2011;endian</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#enhance">&#x2011;enhance</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#equalize">&#x2011;equalize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#evaluate">&#x2011;evaluate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#evaluate-sequence">&#x2011;evaluate&#x2011;sequence</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#extent">&#x2011;extent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#extract">&#x2011;extract</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#family">&#x2011;family</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#features">&#x2011;features</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fft">&#x2011;fft</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fill">&#x2011;fill</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#filter">&#x2011;filter</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flatten">&#x2011;flatten</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flip">&#x2011;flip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#floodfill">&#x2011;floodfill</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flop">&#x2011;flop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#font">&#x2011;font</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#foreground">&#x2011;foreground</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#format">&#x2011;format</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#format_identify_">&#x2011;format[identify]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#frame">&#x2011;frame</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#frame_import_">&#x2011;frame[import]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#function">&#x2011;function</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fuzz">&#x2011;fuzz</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fx">&#x2011;fx</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gamma">&#x2011;gamma</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gaussian-blur">&#x2011;gaussian&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#geometry">&#x2011;geometry</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gravity">&#x2011;gravity</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#green-primary">&#x2011;green&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#hald-clut">&#x2011;hald&#x2011;clut</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#help">&#x2011;help</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#highlight-color">&#x2011;highlight&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#iconGeometry">&#x2011;iconGeometry</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#iconic">&#x2011;iconic</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#identify">&#x2011;identify</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ift">&#x2011;ift</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#immutable">&#x2011;immutable</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#implode">&#x2011;implode</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#insert">&#x2011;insert</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#intent">&#x2011;intent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interlace">&#x2011;interlace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interpolate">&#x2011;interpolate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interline-spacing">&#x2011;interline&#x2011;spacing</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interword-spacing">&#x2011;interword&#x2011;spacing</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#kerning">&#x2011;kerning</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#label">&#x2011;label</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#lat">&#x2011;lat</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#layers">&#x2011;layers</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#level">&#x2011;level</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#level-colors">&#x2011;level&#x2011;colors</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#limit">&#x2011;limit</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#linear-stretch">&#x2011;linear&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#linewidth">&#x2011;linewidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#liquid-rescale">&#x2011;liquid&#x2011;rescale</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#list">&#x2011;list</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#log">&#x2011;log</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#loop">&#x2011;loop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#lowlight-color">&#x2011;lowlight&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#magnify">&#x2011;magnify</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#map">&#x2011;map</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#map_stream_">&#x2011;map[stream]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mask">&#x2011;mask</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mattecolor">&#x2011;mattecolor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#median">&#x2011;median</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#metric">&#x2011;metric</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mode">&#x2011;mode</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#modulate">&#x2011;modulate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#monitor">&#x2011;monitor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#monochrome">&#x2011;monochrome</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#morph">&#x2011;morph</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#morphology">&#x2011;morphology</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mosaic">&#x2011;mosaic</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#motion-blur">&#x2011;motion&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#name">&#x2011;name</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#negate">&#x2011;negate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#noise">&#x2011;noise</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#normalize">&#x2011;normalize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#opaque">&#x2011;opaque</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ordered-dither">&#x2011;ordered&#x2011;dither</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#orient">&#x2011;orient</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#page">&#x2011;page</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#paint">&#x2011;paint</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#path">&#x2011;path</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pause_animate_">&#x2011;pause[animate]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pause_import_">&#x2011;pause[import]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pen">&#x2011;pen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ping">&#x2011;ping</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pointsize">&#x2011;pointsize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#polaroid">&#x2011;polaroid</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#posterize">&#x2011;posterize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#precision">&#x2011;precision</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#preview">&#x2011;preview</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#print">&#x2011;print</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#process">&#x2011;process</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#profile">&#x2011;profile</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quality">&#x2011;quality</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quantize">&#x2011;quantize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quiet">&#x2011;quiet</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#radial-blur">&#x2011;radial&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#raise">&#x2011;raise</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#random-threshold">&#x2011;random&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#red-primary">&#x2011;red&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#regard-warnings">&#x2011;regard&#x2011;warnings</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#region">&#x2011;region</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#remap">&#x2011;remap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#remote">&#x2011;remote</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#render">&#x2011;render</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#repage">&#x2011;repage</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#resample">&#x2011;resample</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#resize">&#x2011;resize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#respect-parentheses">&#x2011;respect&#x2011;parentheses</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#reverse">&#x2011;reverse</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#roll">&#x2011;roll</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#rotate">&#x2011;rotate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sample">&#x2011;sample</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sampling-factor">&#x2011;sampling&#x2011;factor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#scale">&#x2011;scale</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#scene">&#x2011;scene</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#screen">&#x2011;screen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#seed">&#x2011;seed</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#segment">&#x2011;segment</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#selective-blur">&#x2011;selective&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#separate">&#x2011;separate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sepia-tone">&#x2011;sepia&#x2011;tone</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#set">&#x2011;set</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shade">&#x2011;shade</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shadow">&#x2011;shadow</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shared-memory">&#x2011;shared&#x2011;memory</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sharpen">&#x2011;sharpen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shave">&#x2011;shave</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shear">&#x2011;shear</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sigmoidal-contrast">&#x2011;sigmoidal&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#silent">&#x2011;silent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#size">&#x2011;size</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sketch">&#x2011;sketch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#snaps">&#x2011;snaps</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#solarize">&#x2011;solarize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sparse-color">&#x2011;sparse&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#splice">&#x2011;splice</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#spread">&#x2011;spread</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stegano">&#x2011;stegano</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stereo">&#x2011;stereo</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stretch">&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#strip">&#x2011;strip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stroke">&#x2011;stroke</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#strokewidth">&#x2011;strokewidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#style">&#x2011;style</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#subimage-search">&#x2011;subimage&#x2011;search</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#swap">&#x2011;swap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#swirl">&#x2011;swirl</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#taint">&#x2011;taint</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#text-font">&#x2011;text&#x2011;font</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#texture">&#x2011;texture</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#threshold">&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#thumbnail">&#x2011;thumbnail</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#tile">&#x2011;tile</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#tile-offset">&#x2011;tile&#x2011;offset</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#tint">&#x2011;tint</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#title">&#x2011;title</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transform">&#x2011;transform</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transparent">&#x2011;transparent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transparent-color">&#x2011;transparent&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transpose">&#x2011;transpose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transverse">&#x2011;transverse</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#treedepth">&#x2011;treedepth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#trim">&#x2011;trim</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#type">&#x2011;type</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#undercolor">&#x2011;undercolor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#unique-colors">&#x2011;unique&#x2011;colors</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#units">&#x2011;units</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#unsharp">&#x2011;unsharp</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#update">&#x2011;update</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#verbose">&#x2011;verbose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#version">&#x2011;version</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#view">&#x2011;view</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#vignette">&#x2011;vignette</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#virtual-pixel">&#x2011;virtual&#x2011;pixel</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#visual">&#x2011;visual</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#watermark">&#x2011;watermark</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#wave">&#x2011;wave</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#weight">&#x2011;weight</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#white-point">&#x2011;white&#x2011;point</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#white-threshold">&#x2011;white&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#window">&#x2011;window</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#window-group">&#x2011;window&#x2011;group</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#write">&#x2011;write</a> ] </p>
cristy3ed852e2009-09-05 21:47:34 +0000176
cristyb36feb22010-03-26 16:54:37 +0000177<p>Below is list of command-line options recognized by the ImageMagick <a
178href="../www/command-line-tools.html">command-line
179tools</a>. If you want a description of a particular option, click on the
180option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000181otherwise noted, each option is recognized by the commands <a href="../www/convert.html">convert</a>, <a href="../www/mogrify.html">mogrify</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000182
183<div style="margin: auto;">
184 <h4><a name="adaptive-blur" id="adaptive-blur"></a>-adaptive-blur <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
185</div>
186
187<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 +0000188 "direction",
cristy3ed852e2009-09-05 21:47:34 +0000189<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>
190
191<div style="margin: auto;">
192 <h4><a name="adaptive-resize" id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
193</div>
194
195<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>
196
197<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>
198
199<div style="margin: auto;">
200 <h4><a name="adaptive-sharpen" id="adaptive-sharpen"></a>-adaptive-sharpen <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
201</div>
202
203<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>
204
205<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>
206
207<div style="margin: auto;">
208 <h4><a name="adjoin" id="adjoin"></a>-adjoin</h4>
209</div>
210
211<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>
212
213<p>This option is enabled by default. An attempt is made to save all
214images of an image sequence into the given output file.
215However, some formats, such as JPEG and PNG, do not support more than one
216image per file, and in that case ImageMagick is forced to write each image as a separate file. As
217such, if more than one image needs to be written, the filename given is
218modified by adding a <a href="#scene">-scene</a> number before the
219suffix, in order to make distinct names for each image. </p>
220
221<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written
222to separate files, whether or not the file format allows multiple images
223per file (for example, GIF, MIFF, and TIFF). </p>
224
225<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>
226
227<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: rose: -morph 15 my%02dmorph.jpg</span></p>
228<p>will create a sequence of 17 images named my00morph.jpg, my01morph.jpg, my02morph.jpg, ..., my16morph.jpg.
229</p>
230
231<p>In summary, ImageMagick tries to write all images to one file, but will use
232multiple files if either (1) the output image's file format does not allow multi-image files,
233(2) the <a href="#adjoin">+adjoin</a> option is given, or (3) a C-style integer format string is
234present in the output filename. </p>
235
236
237<div style="margin: auto;">
238 <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/>
239 -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>
240</div>
241
242<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>
243
244<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>
245
246<p>The matrix entries are entered as comma-separated numeric values <i>with no spaces</i>. </p>
247
248<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>
249
250<div class="eqn">
251<img alt="affine transformation" src="../images/affine.png"/>
252</div>
253
254<p>
255The 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>
256
257<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>
258
259<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>
260
261<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>
262
263<p class="crtsnip">
264 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
265</p>
266
267<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>
268
269<p class="crtsnip">
270 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
271</p>
272
273<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
274<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
275
276<p class="crtsnip">
277 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
278</p>
279
280<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>
281
282<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>
283
284<div style="margin: auto;">
285 <h4><a name="alpha" id="alpha"></a>-alpha <em class="arg">type</em></h4>
286</div>
287
288<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>
289
290<p>Used to set a flag on an image indicating whether or not to use existing alpha
291channel 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>
292
293
294<table class="doc">
295 <tbody>
296 <tr valign="top">
297 <th align="left" style="width: 8%">type</th>
298 <th align="left">Description</th>
299 </tr>
300
301 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000302 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000303 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000304 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
305 should be used instead of this, unless you specifically need to
306 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
307 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000308
309 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000310 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000311 <td valign="top">
312 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000313 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000314
315 <tr valign="top">
316 <td valign="top"><kbd>Set</kbd></td>
317 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000318 Activates the alpha/matte channel. If it was previously turned off
319 then it also resets the channel to opaque. If the image already had
320 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000321
322 <tr valign="top">
323 <td valign="top"><kbd>Opaque</kbd></td>
324 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000325 Enables the alpha/matte channel and forces it to be fully opaque.
326 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000327
328 <tr valign="top">
329 <td valign="top"><kbd>Transparent</kbd></td>
330 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000331 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000332 transparent. This effectively creates a fully transparent image the
333 same size as the original and with all its original RGB data still
334 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000335
336 <tr valign="top">
337 <td valign="top"><kbd>Extract</kbd></td>
338 <td valign="top">
339 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000340 '<kbd>Off</kbd>' the the image's transparency, so as to generate
341 a gray-scale mask of the image's shape. The alpha channel data is left
342 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
343 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000344
345 <tr valign="top">
346 <td valign="top"><kbd>Copy</kbd></td>
347 <td valign="top">
348 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000349 gray-scale intensity of the image, into the alpha channel, converting
350 a gray-scale mask into a transparent shaped mask ready to be colored
351 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000352
353 <tr valign="top">
354 <td valign="top"><kbd>Shape</kbd></td>
355 <td valign="top">
356 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000357 the current background color. That is the RGB color channels is
358 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000359 </td></tr>
360
361 <tr valign="top">
362 <td valign="top"><kbd>Background</kbd></td>
363 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000364 Set any fully-transparent pixel to the background color, while leaving
365 it fully-transparent. This can make some image file formats, such as
366 PNG, smaller as the RGB values of transparent pixels are more uniform,
367 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000368 </td></tr>
369 </tbody>
370</table>
371
372<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000373"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000374>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000375Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000376
377
378<div style="margin: auto;">
379 <h4><a name="annotate" id="annotate"></a>
380 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
381 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
382 -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>
383</div>
384
385<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>
386
387<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>
388
389
390<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>
391
392<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>
393
394<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>
395<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
396
397<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>
398
399<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>
400
401<div style="margin: auto;">
402 <h4><a name="antialias" id="antialias"></a>-antialias</h4>
403</div>
404
405<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
406drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
407
408<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
409drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
410antialiasing edge pixels. This will then reduce the number of colors added to
411an image to just the colors being directly drawn. That is, no mixed colors
412will be added when drawing such objects. </p>
413
414<div style="margin: auto;">
415 <h4><a name="append" id="append"></a>-append</h4>
416</div>
417
418<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>
419
420<p>This option creates a single longer image image, by joining all the current
421images in sequence top-to-bottom. Use <a href="#append">+append</a> to
422stack images left-to-right. </p>
423
424<p>If they are not of the same width, narrower images are padded with the
425current <a href="#background">-background</a> color setting, and their
426position relative to each other can be controled by the current <a
427href="#gravity">-gravity</a> setting. </p>
428
429
430<div style="margin: auto;">
431 <h4><a name="attenuate" id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
432</div>
433
434<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>
435
436
437<div style="margin: auto;">
438 <h4><a name="authenticate" id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
439</div>
440
441<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>
442
443<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>
444
445<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
446
cristyd934d102009-10-10 12:55:13 +0000447
448
cristy3ed852e2009-09-05 21:47:34 +0000449<div style="margin: auto;">
450 <h4><a name="auto-gamma" id="auto-gamma"></a>-auto-gamma</h4>
451</div>
452
453<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>
454
cristyd934d102009-10-10 12:55:13 +0000455<p>This calculates the mean values of an image, then applies a calculated <a
456href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
457image it will get a have a value of 50%. </p>
458
459<p>This means that any solid 'gray' image will become 50% gray. </p>
460
461<p>This works well for real-life images with little or no extreme dark and
462light areas, but tend to fail for images with large amounts of bright sky or
463dark shadows. It also does not work well for diagrmas or cartoon like images.
464</p>
465
466<p>It uses the <a href="#channel" >-channel</a> setting, (including the
467'<CODE>sync</CODE>' flag for channel syncronization), to determine which color
468values will be used and modified. As the default <a href="#channel"
469>-channel</a> setting is '<CODE>RGB,sync</CODE>', channels will be modified
470together by the same gamma value, preserving colors. </p>
471
472
473
cristy3ed852e2009-09-05 21:47:34 +0000474<div style="margin: auto;">
475 <h4><a name="auto-level" id="auto-level"></a>-auto-level</h4>
476</div>
477
478<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>
479
cristyd934d102009-10-10 12:55:13 +0000480<p>This is a 'perfect' image normalization operator. It finds the exact
481mimimum and maximum color values in the image and then applies a <a
482href="#level" >-level</a> operator to stretch the values to the full range of
483values. </p>
484
cristy83543962009-10-16 19:04:28 +0000485<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000486JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
487for the <a href="#level" >-level</a> operation. On the other hand it is the
488right operator to use for color stretching gradient images being used to
489generate Color lookup tables, distortion maps, or other 'mathematically'
490defined images. </p>
491
492<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
493href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
494>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
495problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000496>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000497
498<p>It uses the <a href="#channel" >-channel</a> setting, (including the
499special '<CODE>sync</CODE>' flag for channel syncronization), to determine
500which color values will be used and modified. As the default <a
cristy83543962009-10-16 19:04:28 +0000501href="#channel" >+channel</a> setting is '<CODE>RGB,sync</CODE>', the
502'<CODE>sync</CODE>' will ensure that the color channels will be modified
503together by the same gamma value, preserving colors, and ignoring
504transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000505
506
507
cristy3ed852e2009-09-05 21:47:34 +0000508<div style="margin: auto;">
509 <h4><a name="auto-orient" id="auto-orient"></a>-auto-orient</h4>
510</div>
511
512<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>
513
cristy83543962009-10-16 19:04:28 +0000514<p>This operator reads and resets the EXIF image profile setting 'Orientation'
515and then performs the appropriate 90 degree rotation on the image to orient
516the image, for correct viewing. </p>
517
518<p>This EXIF profile setting is usually set using a gravity sensor in digital
519camara, however photos taken directly downward or upward may not have an
520appropriate value. Also images that have been orientation 'corrected' without
521reseting this setting, may be 'corrected' again resulting in a incorrect
522result. If the he EXIF profile was previously stripped, the <a
523href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
524
525
cristy3ed852e2009-09-05 21:47:34 +0000526<div style="margin: auto;">
527 <h4><a name="average" id="average"></a>-average</h4>
528</div>
529
530<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>
531
532<p>An error results if the images are not identically sized.</p>
533
cristy3ed852e2009-09-05 21:47:34 +0000534
535<div style="margin: auto;">
536 <h4><a name="backdrop" id="backdrop"></a>-backdrop</h4>
537</div>
538
539<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>
540
541<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>
542
543<div style="margin: auto;">
544 <h4><a name="background" id="background"></a>-background <em class="arg">color</em></h4>
545</div>
546
547<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>
548
549<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>
550
551<div style="margin: auto;">
552 <h4><a name="bench" id="bench"></a>-bench <em class="arg">iterations</em></h4>
553</div>
554
555<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>
556
cristye6378132009-10-26 20:05:17 +0000557<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 +0000558
cristye6378132009-10-26 20:05:17 +0000559<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>
560<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 +0000561
562<div style="margin: auto;">
563 <h4><a name="bias" id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
564</div>
565
566<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>
567
568<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>
569
570<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>
571
572<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
573negative results without clipping to the color value range
574(0..QuantumRange).</p>
575
576<p>See the discussion on HDRI implementations of ImageMagick on the page
577<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.
578</p>
579
580<div style="margin: auto;">
581 <h4><a name="black-point-compensation" id="black-point-compensation"></a>-black-point-compensation</h4>
582</div>
583
584<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>
585
586<div style="margin: auto;">
cristy5cadd612009-09-21 19:33:41 +0000587 <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 +0000588</div>
589
cristy5cadd612009-09-21 19:33:41 +0000590<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>
591
592<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.
593</p>
cristy3ed852e2009-09-05 21:47:34 +0000594
595
596<div style="margin: auto;">
cristy83a272e2010-05-07 20:40:35 +0000597 <h4><a name="blend" id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000598</div>
599
cristy83a272e2010-05-07 20:40:35 +0000600<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 +0000601
602<p>Blend will average the images together ('plus') according to the
603percentages given and each pixels transparency. If only a single percentage
604value is given it sets the weight of the composite or 'source' image, while
605the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000606<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
607'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000608
609
610<div style="margin: auto;">
611 <h4><a name="blue-primary" id="blue-primary"></a>-blue-primary <em class="arg">x</em>,<em class="arg">y</em></h4>
612</div>
613
614<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>
615
616<div style="margin: auto;">
617 <h4><a name="blue-shift" id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
618</div>
619
620<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>
621
622<div style="margin: auto;">
623
624<div style="margin: auto;">
625 <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>
626</div>
627
628<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>
629
cristyb15553d2010-07-03 22:53:14 +0000630<p>Convolve the image with a Gaussian or normal distribution using the given
631<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000632
633<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
634</div>
635
cristyb15553d2010-07-03 22:53:14 +0000636<p>The <em class="arg" >Sigma</em> value is the important argument, and
637determines the actual amount of bluring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000638
cristyb15553d2010-07-03 22:53:14 +0000639<p>The <em class="arg" >Radius</em> is only used to determine the size of the
640array which will hold the calculated gaussian distribution. It should be an
641integer. If not given, or set to zero, IM will calculate the largest posible
642radius that will provide meaningful results for the Gaussian distribution.
643</p>
644
645<p>The larger the <em class="arg" >Radius</em> the radius the slower the
646operation is. However too small a <em class="arg" >Radius</em>, and sever
647aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
648should be at least twice the <em class="arg" >Sigma</em> value, though three
649times will produce a more accurite result. </p>
650
651<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
652by taking advantage of the separability properties of the distribution. Here
653we apply a single-dimensional Gaussian matrix in the horizontal direction,
654then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000655
656<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
657pixels which are outside the image proper are blurred into the final result.
658</p>
659
660
661<div style="margin: auto;">
662 <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>
663</div>
664
665<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>
666
667<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
668Average (EWA) of the source image, scaled according to the grayscale
669mapping. </p>
670
671<p>The ellipse is weighted with sigma set to the given <em class="arg"
672>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
673defaults to the <em class="arg" >Width</em> for a normal circular Guassian
674weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
675horizontal clock-wise. </p>
676
677<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
678pixels which are outside the image proper are blurred into the final result.
679</p>
680
681
682<div style="margin: auto;">
683 <h4><a name="border" id="border"></a>-border <em class="arg">geometry</em></h4>
684</div>
685
686<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>
687
cristybc9539a2010-08-16 18:06:20 +0000688<p>Set the width and height using the <em class="arg">size</em> portion of the
689<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
690ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000691
cristybc9539a2010-08-16 18:06:20 +0000692<p>Set the border color by preceding with the <a
693href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000694
cristybc9539a2010-08-16 18:06:20 +0000695<p>The <a href="#border">-border</a> operation is affected by the current <a
696href="#compose">-compose</a> setting and assumes that this is using the default
697'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
698size colors by the current <a href="#bordercolor">-bordercolor</a> before
699overlaying the original image in the center of this net image. This means that
700with the default compose method of '<kbd>Over</kbd>' any transparent parts may
701be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
702<p>See also the <a href="#frame">-frame</a> option, which has more
703functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000704
705<div style="margin: auto;">
706 <h4><a name="bordercolor" id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
707</div>
708
709<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>
710
711<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
712
713<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
714
715<div style="margin: auto;">
716 <h4><a name="borderwidth" id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
717</div>
718
719<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>
720
721<div style="margin: auto;">
cristy16ff93c2010-01-13 23:18:07 +0000722 <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>
723</div>
724
725<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>
726
727<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>
728
729<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>
730
731<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>
732
733<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>
734
735<p>Negative slopes, i.e. negating the image, are not possible with this function. All achievable slopes will be zero or positive.</p>
736
737<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>
738
739<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>
740
741<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +0000742 <h4><a name="cache" id="cache"></a>-cache <em class="arg">threshold</em></h4>
743</div>
744
745<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>
746
747<div style="margin: auto;">
748 <h4><a name="caption" id="caption"></a>-caption <em class="arg">string</em></h4>
749</div>
750
751<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>
752
753<div style="margin: auto;">
754 <h4><a name="cdl" id="cdl"></a>-cdl <em class="arg">filename</em></h4>
755</div>
756
757<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>
758
759<p>Here is an example color correction collection:</p>
760
761<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000762&lt;?xml version="1.0" encoding="UTF-8"?&gt;
763&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
764 &lt;ColorCorrection id="cc06668"&gt;
765 &lt;SOPNode&gt;
766 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
767 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
768 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
769 &lt;/SOPNode&gt;
770 &lt;SATNode&gt;
771 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
772 &lt;/SATNode&gt;
773 &lt;/ColorCorrection&gt;
774&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000775</pre>
776
777<div style="margin: auto;">
778 <h4><a name="channel" id="channel"></a>-channel <em class="arg">type</em></h4>
779</div>
780
781<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>
782
783<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>
784
cristy83a272e2010-05-07 20:40:35 +0000785<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000786abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
787'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
788'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000789
cristy83a272e2010-05-07 20:40:35 +0000790For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
791you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000792<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000793 -channel Red,Blue
794</p>
795<p>or you can use the short hand form</p>
796<p class="crtsnip">
797 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000798</p>
799
cristy83a272e2010-05-07 20:40:35 +0000800<p>All the channels that is present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000801special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
802but generally any operators that are generally 'grey-scale' image operators,
803will understand this setting. See individual operator documentation. </p>
804
805<br>
cristy83a272e2010-05-07 20:40:35 +0000806
807<p>On top of the normal channel selection a extra flag can be specified,
808'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000809operators that understand this flag should perform: cross-channel
810syncronization of the channels. If not specified, then most grey-scale
811operators will apply their image processing operations to each individual
812channel (as specified by the rest of the <a href="#channel">-channel</a>
813setting) completely independantally from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000814
815<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
816<a href="#auto-gamma">-auto-gamma</a> the color channels will be modified
817together in exactly the same way so that colors will remain in-sync. Without
818it being set, then each channel will be modified separatally and
cristybac7a162010-06-15 19:57:29 +0000819independantally, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000820
cristybac7a162010-06-15 19:57:29 +0000821<p>The <a href="#morphology">-morphology</a> '<kdb>Convolve</kdb>' method
822and the <a href="#compose">-compose</a> mathematical methods, also understands
823the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
824to the alpha channel (if present). That is to say it will modify the image
825processing with the understanding that fully-transparent colors should not
826contribute to the final result. </p>
827
828Basically, by default, operators work with color channels in syncronous, and
829treats transparency as special, unless the <a href="#channel">-channel</a>
830setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
831How each operator does this depends on that operators current implementation.
832Not all operators understands this flag at this time, but that is changing.
833</p>
cristy83a272e2010-05-07 20:40:35 +0000834
835<p>To print a complete list of channel types, use <a href="#list">-list
836channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000837
cristybac7a162010-06-15 19:57:29 +0000838<br>
cristyd934d102009-10-10 12:55:13 +0000839
840<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000841'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
842channels except the transparency channel, and that all the color channels are
843to be modified in exactly the same way, with a understanding of transprancy
844(depending on the operation being applied). The 'plus' form <a
845href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000846
847<p>Options that are affected by the <a href="#channel" >-channel</a> setting
848include the following.
849
850<a href="#auto-gamma">-auto-gamma</a>,
851<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000852<a href="#black-threshold">-black-threshold</a>,
853<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000854<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000855<a href="#clut">-clut</a>,
856<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000857<a href="#composite">-composite</a> (Mathematical compose methods only),
858<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000859<a href="#contrast-stretch">-contrast-stretch</a>,
860<a href="#evaluate">-evaluate</a>,
861<a href="#function">-function</a>,
862<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000863<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000864<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000865<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000866<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000867<a href="#negate">-negate</a>,
868<a href="#normalize">-normalize</a>,
869<a href="#ordered-dither">-ordered-dither</a>,
870<a href="#radial-blur">-radial-blur</a>,
871<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000872<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000873<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000874<a href="#white-threshold">-white-threshold</a>.
875</p>
876
cristyd934d102009-10-10 12:55:13 +0000877<p>Warning, some operators behave differentally when the <a href="#channel"
878>+channel</a> default setting is in effect, verses ANY user defined <a
879href="#channel" >-channel</a> setting (including the equivelent of the
cristy83a272e2010-05-07 20:40:35 +0000880default). These operators have yet to be made to understand the newer 'Sync'
881flag. </p>
882
cristybac7a162010-06-15 19:57:29 +0000883<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
884the image before thresholding, if no <a href="#channel" >-channel</a> setting
885has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +0000886
887<p>Also some operators such as <a href="#blur">-blur</a>, <a
888href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
889color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
890href="#channel" >-channel</a>. Generally this done to ensure that
891fully-transparent colors are treated as being fully-transparent, and thus any
892underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +0000893resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
894convolution equivelents however does have a understanding of the 'Sync' flag
895and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +0000896
cristybac7a162010-06-15 19:57:29 +0000897<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +0000898color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +0000899alpha channel present, and the <a href="#channel" >-channel</a> setting tells
900the operator to apply the operation using alpha channels. The <a
901href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +0000902
cristy3ed852e2009-09-05 21:47:34 +0000903
904<div style="margin: auto;">
cristyb4c03bb2009-09-27 13:55:46 +0000905 <h4><a name="clamp" id="clamp"></a>-clamp</h4>
906</div>
907
908<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>
909
910<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +0000911 <h4><a name="charcoal" id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
912</div>
913
914<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>
915
916<div style="margin: auto;">
917 <h4><a name="chop" id="chop"></a>-chop <em class="arg">geometry</em></h4>
918</div>
919
920<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>
921
922<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>
923
924<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>
925
926<div style="margin: auto;">
927 <h4><a name="clip" id="clip"></a>-clip</h4>
928</div>
929
930<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>
931
932<p>If a clipping path is present, it is applied to subsequent operations.</p>
933
934<p>For example, in the command</p>
935
936<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
937<p>only the pixels within the clipping path are negated.</p>
938
939<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
940
941<div style="margin: auto;">
942 <h4><a name="clip-mask" id="clip-mask"></a>-clip-mask</h4>
943</div>
944
945<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>
946
947<div style="margin: auto;">
948 <h4><a name="clip-path" id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
949</div>
950
951<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>
952
953<div style="margin: auto;">
954 <h4><a name="clone" id="clone"></a>-clone <em class="arg">index(s)</em></h4>
955</div>
956
957<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>
958
959<p>Specify the image by its index in the sequence. The first image is index
9600. Negative indexes are relative to the end of the sequence; for example, &minus;1
961represents the last image of the sequence. Specify a range of images with a
962dash (e.g. 0&minus;4). Separate multiple indexes with commas but no spaces (e.g. 0,2,5). Use <a
963href="#clone">+clone</a> make a copy of the last image in the image
964sequence.</p>
965
966<div style="margin: auto;">
967 <h4><a name="clut" id="clut"></a>-clut</h4>
968</div>
969
970<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
971corresponding channel in the second image as a <b>c</b>olor
972<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
973
974<p>The second (LUT) image is ordinarily a gradient image containing the
975histogram mapping of how each channel should be modified. Typically it is a
976either a single row or column image of replacement color values. If larger
977than a single row or column, values are taken from a diagonal line from
978top-left to bottom-right corners.</p>
979
980<p>The lookup is further controlled by the <a
981href="#interpolate">-interpolate</a> setting, which is especially handy for an
982LUT which is not the full length needed by the ImageMagick installed Quality
983(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
984'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
985gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
986lookup of color values. </p>
987
988<p>This operator is especially suited to replacing a grayscale image with a
989specific color gradient from the CLUT image. </p>
990
991<p>Only the channel values defined by the <a href="#channel">-channel</a>
992setting will have their values replaced. In particular, since the default <a
993href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
994transparency (alpha/matte channel) is not affected, unless the <a
995href="#channel">-channel</a> setting is modified. When the alpha channel is
996set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
997as the other channels, implying that alpha/matte values are replaced using the
998alpha/matte values of the original image. </p>
999
1000<p>If either the image being modified, or the lookup image, conatins no
1001transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1002href="#channel">-channel</a> setting includes alpha replacement, then it is
1003assumed that image represents a gray-scale graident which will be used for the
1004replacement alpha values. That is you can use a gray-scale CLUT image to
1005adjust a existing images alpha channel, or you can color a gray-scale image
1006using colors form CLUT containing the desired colors, including transparency.
1007</p>
1008
1009<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors according
1010the lookup of the full color RGB value from a 2D representation of a 3D color
1011cube. </p>
1012
1013
1014<div style="margin: auto;">
1015 <h4><a name="coalesce" id="coalesce"></a>-coalesce</h4>
1016</div>
1017
1018<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>
1019
1020<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>
1021
1022<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>
1023
1024
1025<div style="margin: auto;">
1026 <h4><a name="colorize" id="colorize"></a>-colorize <em class="arg">value</em></h4>
1027</div>
1028
1029<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>
1030
1031<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>
1032
1033<div style="margin: auto;">
1034 <h4><a name="colormap" id="colormap"></a>-colormap <em class="arg">type</em></h4>
1035</div>
1036
1037<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>
1038
1039<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1040
1041<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>
1042
1043<div style="margin: auto;">
1044 <h4><a name="colors" id="colors"></a>-colors <em class="arg">value</em></h4>
1045</div>
1046
1047<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>
1048
1049<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>
1050
1051<div style="margin: auto;">
cristy2c839602010-04-03 02:32:08 +00001052 <h4><a name="color-matrix" id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
1053</div>
1054
1055<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>
1056
1057<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>
1058
1059<p>As an example, to add contrast to an image with offsets, try this command:</p>
1060
1061<pre class="text">
1062convert kittens.jpg -color-matrix \
1063 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1064 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1065 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1066 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1067 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1068 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1069</pre>
1070<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00001071 <h4><a name="colorspace" id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
1072</div>
1073
1074<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>
1075
1076<p>Choices are:</p>
1077
1078<pre class="text">
1079 CMY
1080 CMYK
1081 Gray
1082 HSB
1083 HSL
1084 HWB
1085 Lab
1086 Log
1087 OHTA
1088 Rec601Luma
1089 Rec601YCbCr
1090 Rec709Luma
1091 Rec709YCbCr
1092 RGB
1093 sRGB
1094 Transparent
1095 XYZ
1096 YCbCr
1097 YCC
1098 YIQ
1099 YPbPr
1100 YUV
1101</pre>
1102
1103<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1104
1105<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>
1106
1107<table class="doc">
1108 <caption>Conversion Of RGB To Other Color Spaces</caption>
1109 <tr><th align="left" valign="middle">CMY</th></tr>
1110 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1111 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1112 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1113 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1114 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1115 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1116 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1117 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1118
1119 <tr><th align="left" valign="middle">Gray</th></tr>
1120 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1121
1122 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1123 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1124 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1125 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1126
1127 <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>
1128 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1129 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1130 <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>
1131
1132 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1133 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1134 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1135 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1136
1137 <tr><th align="left" valign="middle">LAB</th></tr>
1138 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1139 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1140 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1141
1142 <tr><th align="left" valign="middle">LOG</th></tr>
1143 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1144 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1145 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1146
1147 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1148 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1149 <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>
1150 <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>
1151
1152 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1153 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1154
1155 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1156 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1157 <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>
1158 <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>
1159
1160 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1161 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1162
1163 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1164 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1165 <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>
1166 <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>
1167
1168 <tr><th align="left" valign="middle">sRGB</th></tr>
1169 <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>
1170 <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>
1171 <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>
1172
1173 <tr><th align="left" valign="middle">XYZ</th></tr>
1174 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1175 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1176 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1177
1178 <tr><th align="left" valign="middle">YCC</th></tr>
1179 <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>
1180 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1181 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1182
1183 <tr><th align="left" valign="middle">YCbCr</th></tr>
1184 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1185 <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>
1186 <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>
1187
1188 <tr><th align="left" valign="middle">YIQ</th></tr>
1189 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1190 <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>
1191 <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>
1192
1193 <tr><th align="left" valign="middle">YPbPr</th></tr>
1194 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1195 <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>
1196 <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>
1197
1198 <tr><th align="left" valign="middle">YUV</th></tr>
1199 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1200 <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>
1201 <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>
1202</table>
1203
1204<div style="margin: auto;">
1205 <h4><a name="combine" id="combine"></a>-combine</h4>
1206</div>
1207
1208<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>
1209
1210<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>
1211
1212<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.
1213</p>
1214
cristy4949d522010-03-12 18:41:34 +00001215<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 +00001216<div style="margin: auto;">
1217 <h4><a name="comment" id="comment"></a>-comment <em class="arg">string</em></h4>
1218</div>
1219
1220<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>
1221
1222<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>
1223
cristybc9539a2010-08-16 18:06:20 +00001224<p>Use this option to assign a specific comment to the image, when writing to
1225an image format that supports comments. You can include the image filename,
1226type, width, height, or other image attribute by embedding special format
1227characters listed in the <a href="../www/escape.html">Format and Print Image
1228Properties</a>. The comment is not drawn on the image, but is embedded in the
1229image datastream via "Comment" tag or similar mechanism. </p>
cristy3ed852e2009-09-05 21:47:34 +00001230
1231<p>For example,</p>
1232
1233<p class="crtsnip">
1234 -comment "%m:%f %wx%h"
1235</p>
1236
cristybc9539a2010-08-16 18:06:20 +00001237<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> for an image
1238titled <kbd>bird.miff</kbd> and whose width is 512 and height is 480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001239
1240<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>
1241
1242<div style="margin: auto;">
1243 <h4><a name="compose" id="compose"></a>-compose <em class="arg">operator</em></h4>
1244</div>
1245
1246<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>
1247
cristybc9539a2010-08-16 18:06:20 +00001248<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1249a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001250
cristybc9539a2010-08-16 18:06:20 +00001251<p>This setting effects image processing operators that merge two (or more)
1252images together in some way. This includes the operators,
1253<a href="#composite">-composite</a>,
1254<a href="#layers">-layers</a> composite,
1255<a href="#flatten">-flatten</a>,
1256<a href="#mosaic">-mosaic</a>,
1257<a href="#layers">-layers</a> merge,
1258<a href="#border">-border</a>,
1259<a href="#frame">-frame</a>,
1260and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001261
cristybc9539a2010-08-16 18:06:20 +00001262<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1263command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001264
1265
1266<div style="margin: auto;">
1267 <h4><a name="composite" id="composite"></a>-composite</h4>
1268</div>
1269
cristybc9539a2010-08-16 18:06:20 +00001270<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Perform alpha composition on two images and an optional mask</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001271
1272<p>Take the first image 'destination' and overlay the second 'source' image
1273according to the current <a href="#compose">-compose</a> setting. The location
1274of the 'source' or 'overlay' image is controlled according to <a
1275href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1276settings. </p>
1277
1278<p>If a third image is given this is treated as a gray-scale 'mask' image
1279relative to the first 'destination' image. This mask will limit what parts of
1280the destination can be modified by the image composition. However for the
1281'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1282Y-displacement image instead. </p>
1283
1284<p>If a <a href="#compose">-compose</a> method requires extra numerical
1285arguments or flags these can be provided by setting the <a
1286href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
1287appropriatally for the compose method. </p>
1288
1289<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1290image outside the overlay area. You can disable this by setting the special <a
1291href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1292to '<kbd>false</kbd>'. </p>
1293
1294
1295<div style="margin: auto;">
1296 <h4><a name="compress" id="compress"></a>-compress <em class="arg">type</em></h4>
1297</div>
1298
1299<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>
1300
1301<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>
1302
1303<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1304
1305<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>
1306
1307<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>
1308
1309<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>
1310
1311<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>
1312
1313<div style="margin: auto;">
1314 <h4><a name="contrast" id="contrast"></a>-contrast</h4>
1315</div>
1316
1317<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>
1318
1319<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>
1320
1321<p>For a more pronounced effect you can repeat the option:</p>
1322
1323<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1324<div style="margin: auto;">
1325 <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>
1326</div>
1327
1328<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>
1329
cristyd934d102009-10-10 12:55:13 +00001330<p>While performing the stretch, black-out at most <em
1331class="arg" >black-point</em> pixels and white-out at most <em
1332class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1333<em class="arg" >black-point %</em> pixels and white-out at most <em
1334class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001335
cristyd934d102009-10-10 12:55:13 +00001336<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1337>-contrast-stretch</a> will black-out at most <em class="arg"
1338>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1339minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1340class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1341>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001342
cristyd934d102009-10-10 12:55:13 +00001343<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1344the image's min and max values are stretched to 0 and <em class="QR"
1345>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1346clipping at either end. This is not the same as <a href="#normalize"
1347>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 2%x1%</kbd> (or
1348prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001349
cristyd934d102009-10-10 12:55:13 +00001350<p>Internally operator works by creating a histogram bin, and then uses that
1351bin to modify the image. As such some colors may be merged together when they
1352originally fell into the same 'bin'. </p>
1353
1354<p>All the channels are normalized in concert by the came amount so as to
1355preserve color integrity, when the default <a href="#channel" >+channel</a>
1356setting is in use. Specifing any other <a href="#channel" >-channel</a>
1357setting will normalize the RGB channels independently.</p>
1358
1359<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1360normalization of mathematical images. </p>
1361
1362<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001363
1364
1365<div style="margin: auto;">
1366 <h4><a name="convolve" id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
1367</div>
1368
1369<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>
1370
cristy16ff93c2010-01-13 23:18:07 +00001371<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001372a comma-separated list of integers (with no spaces), ordered left-to right,
1373starting with the top row. Presently, only odd-dimensioned kernels are
1374supported, and therefore the number of entries in the specified <em
1375class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
13767<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001377
cristyd934d102009-10-10 12:55:13 +00001378<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
1379positive and negative results are relative to a user-specified bias value.
1380This is important for non-HDRI compilations of ImageMagick when dealing with
1381convolutions that contain negative as well as positive values. This is
1382especially the case with convolutions involving high pass filters or edge
1383detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001384</p>
1385
cristyd934d102009-10-10 12:55:13 +00001386<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
1387negative results without clipping to the color value range (0..QuantumRange).
1388See the discussion on HDRI implementations of ImageMagick on the page <a
1389href="/www/high-dynamic-range.html">High
1390Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1391href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1392<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1393entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001394
cristy3ed852e2009-09-05 21:47:34 +00001395
1396<div style="margin: auto;">
1397 <h4><a name="crop" id="crop"></a>-crop <em class="arg">geometry</em></h4>
1398</div>
1399
1400<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>
1401
1402<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>
1403
1404<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>
1405
1406<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>
1407
1408<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>
1409
1410<p>By adding a exclamation character flag to the geometry argument, the
1411cropped images virtual canvas page size and offset is set as if the
1412geometry argument was a viewport or window. This means the canvas page size
1413is set to exactly the same size you specified, the image offset set
1414relative top left corner of the region cropped. </p>
1415
1416<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1417special single pixel transparent 'missed' image is returned, and a 'crop
1418missed' warning given. </p>
1419
cristy739df912009-10-24 16:10:18 +00001420<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 +00001421
1422<div style="margin: auto;">
1423 <h4><a name="cycle" id="cycle"></a>-cycle <em class="arg">amount</em></h4>
1424</div>
1425
1426<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>
1427
1428<p><em class="arg">Amount</em> defines the number of positions each
1429colormap entry is shifted.</p>
1430
1431
1432<div style="margin: auto;">
1433 <h4><a name="debug" id="debug"></a>-debug <em class="arg">events</em></h4>
1434</div>
1435
1436<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>
1437
1438<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>
1439
1440
1441<p>For example, to log cache and blob events, use.</p>
1442
1443<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1444<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1445
1446<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1447
1448<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1449
1450<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1451
1452<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>
1453
1454
1455<div style="margin: auto;">
1456 <h4><a name="decipher" id="decipher"></a>-decipher <em class="arg">filename</em></h4>
1457</div>
1458
1459<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>
1460
1461<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1462
1463<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1464
1465
1466<div style="margin: auto;">
1467 <h4><a name="deconstruct" id="deconstruct"></a>-deconstruct</h4>
1468</div>
1469
1470<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>
1471
1472<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>
1473
1474<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>
1475
1476<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1477
1478
1479<div style="margin: auto;">
1480 <h4><a name="define" id="define"></a>-define <em class="arg">key</em>{<em class="arg">=value</em>}<em class="arg">...</em></h4>
1481</div>
1482
1483<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>
1484
1485<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>
1486
1487<p>The following definitions may be created:</p>
1488
1489<ul>
cristy045bd902010-01-30 18:56:24 +00001490<dt>dcm:display-range=reset</dt>
1491 <dd>Set the display range to the minimum and maximum pixel values for the DCM image format.</dd><br />
1492<dt>dot:layout-engine=<em class="arg">value</em></dt>
1493 <dd>Set the specify the layout engine for the DOT image format (e.g. <kbd>neato</kbd>).</dd><br />
1494<dt>jpeg:extent=<em class="arg">value</em></dt>
cristy7396d882010-01-27 02:37:56 +00001495 <dd>Restrict the maximum JPEG file size, for example <kbd>-define jpeg:extent=400kb</kbd>.</dd><br />
cristy045bd902010-01-30 18:56:24 +00001496<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristy48dd1af2009-10-02 01:21:56 +00001497 <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 +00001498<dt>jp2:rate=<em class="arg">value</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00001499 <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 />
1500<dt>mng:need-cacheoff</dt>
1501 <dd>turn playback caching off for streaming MNG.</dd><br />
cristy045bd902010-01-30 18:56:24 +00001502<dt>png:bit-depth=<em class="arg">value</em></dt>
1503<dt>png:color-type=<em class="arg">value</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00001504 <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 />
1505<dt>ps:imagemask</dt>
cristy045bd902010-01-30 18:56:24 +00001506 <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 />
1507<dt>quantum:format=<em class="arg">type</em></dt>
1508 <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 +00001509</ul>
1510
1511<p>For example, to create a postscript file that will render only the black pixels of a bilevel image, use:</p>
1512
1513<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bilevel.tif -define ps:imagemask eps3:stencil.ps</span></p>
1514<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>
1515
1516<p class="crtsnip">
1517-define registry:temporary-path=/data/tmp
1518</p>
1519
1520<div style="margin: auto;">
1521 <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>
1522</div>
1523
1524<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>
1525
1526<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>
1527
1528<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>
1529
1530
1531<div style="margin: auto;">
1532 <h4><a name="delete" id="delete"></a>-delete <em class="arg">index</em></h4>
1533</div>
1534
1535<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>
1536
1537<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>
1538
1539
1540<div style="margin: auto;">
1541 <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>
1542</div>
1543
1544<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>
1545
1546<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>
1547
1548<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>
1549
1550<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>
1551
1552<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>
1553
1554<div style="margin: auto;">
1555 <h4><a name="depth" id="depth"></a>-depth <em class="arg">value</em></h4>
1556</div>
1557
1558<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>
1559
1560<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>
1561
1562<div style="margin: auto;">
1563 <h4><a name="descend" id="descend"></a>-descend</h4>
1564</div>
1565
1566<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>
1567
1568<div style="margin: auto;">
1569 <h4><a name="deskew" id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
1570</div>
1571
1572<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>
1573
1574<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>
1575
1576<div style="margin: auto;">
1577 <h4><a name="despeckle" id="despeckle"></a>-despeckle</h4>
1578</div>
1579
1580<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>
1581
1582<div style="margin: auto;">
cristy2c839602010-04-03 02:32:08 +00001583 <h4><a name="direction" id="direction"></a>-direction <em class="arg">type</em></h4>
1584</div>
1585
1586<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>
1587
1588<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00001589 <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>
1590</div>
1591
1592<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>
1593
1594<p>With this option, the 'overlay' image, and optionally the 'mask' image,
1595will be used as a displacement map, which is used to displace the lookup of
1596what part of the 'background' image is seen at each point of the overlaid
1597area. Much like the displacement map is a 'lens' that redirects light shining
1598through it so as to present a distorted view the original 'background' image
1599behind it. </p>
1600
1601<p>Any perfect grey areas of the displacement map produce a zero
1602displacement of the image. Black areas produce the given maximum negative
1603displacement of the lookup point, while white produce a maximum positive
1604displacement of the lookup. </p>
1605
1606<p>Note that it is the lookup of the 'background' that is displaced, not a
1607displacement of the image itself. As such an area of the displacement map
1608containing 'white' will have the lookup point 'shifted' by a positive amount,
1609and thus generating a copy of the destination image to the right/downward from
1610the correct position. That is the image will look like it may have been
1611'shifted' in a negative left/upward direction. Understanding this is a very
1612important in understanding how displacement maps work. </p>
1613
1614<p>The given arguments define the maximum amount of displacement in pixels
1615that a particular map can produce. If the displacement scale is large enough
1616it is also posible to lookup parts of the 'background' image that lie well
1617outside the bounds of the displacement map itself. That is you could very
1618easilly copy a section of the original image from outside the overlay area
1619into the overlay area. </p>
1620
1621<p>The '%' flag makes the displacement scale relative to the size of the
1622overlay image (100% = half width/height of image). Using '!' switches
1623percentage arguments to refer to the destination image size instead.
1624these flags were added as of IM v6.5.3-5.</p>
1625
1626<p>Normally a single grayscale displacement map is provided, which with the
1627given scaling values will determine a single direction (vector) in which
1628displacements can occur (positivally or negativally). However, if you also
1629specify a third image which is normally used as a <em class="arg">mask</em>,
1630then the <em class="arg">composite image</em> will be used for horizontal X
1631displacement, while the <em class="arg">mask image</em> is used for vertical Y
1632displacement. This allows you to define completely different displacement
1633values for the X and Y directions, and allowing you to lookup any point within
1634the <em class="arg">scale</em> bounds. In other words each pixel can lookup
1635any other nearby pixel, producing complex 2 dimentional displacements, rather
1636than a simple 1 dimentional vector displacements. </p>
1637
1638<p>Alternativally rather than suppling two separate images, as of IM v6.4.4-0,
1639you can use the 'red' channel of the overlay image to specify the horizontal
1640or X displacement, and the 'green' channel for the vertical or Y displacement.
1641</p>
1642
1643<p>As of IM v6.5.3-5 any alpha channel in the overlay image will be used as a
1644mask the transparency of the destination image. However areas outside the
1645overlaid areas will not be effected. </p>
1646
1647
1648<div style="margin: auto;">
1649 <h4><a name="display" id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
1650</div>
1651
1652<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>
1653
1654<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1655
1656<div style="margin: auto;">
1657 <h4><a name="dispose" id="dispose"></a>-dispose <em class="arg">method</em></h4>
1658</div>
1659
1660<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>
1661
1662<p>The layer disposal method defines the way each the displayed image is to be
1663modified after the current 'frame' of an animation has finished being
1664displayed (after its 'delay' period), but before the next frame on an
1665animation is to be overlaid onto the display. </p>
1666
1667<p>Here are the valid methods:</p>
1668
1669<pre class="text">
1670Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
1671None 1 Do not dispose, just overlay next frame image.
1672Background 2 Clear the frame area with the background color.
1673Previous 3 Clear to the image prior to this frames overlay.
1674</pre>
1675
1676<p>You can also use the numbers given above, which is what the GIF format
1677uses internally to represent the above settings. </p>
1678
1679<p>To print a complete list of dispose methods, use <a href="#list">-list dipose</a>.</p>
1680
1681<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
1682resetting the layer disposal methods of images being read in. </p>
1683
1684<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
1685disposal method for images already in memory.</p>
1686
1687<div style="margin: auto;">
1688 <h4><a name="dissimilarity-threshold" id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
1689</div>
1690
1691<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>
1692
1693
1694<div style="margin: auto;">
1695 <h4><a name="dissolve" id="dissolve"></a>-dissolve <em class="arg">src_percent</em>[x<em class="arg">dst_percent</em>]</h4>
1696</div>
1697
1698<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>
1699
1700<p>The opacity of the composite image is multiplied by the given percent, then
1701it is composited 'over' the main image. If <em class="arg">src_percent</em>
1702is greater than 100, start dissolving the main image so it will become
1703transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
1704are given, each image are dissolved to the percentages given. </p>
1705
1706<p>Note that dissolve percentages do not add, two opaque images dissolved
1707'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
1708images, you would need to use dissolve values of '50,100'. </p>
1709
1710<div style="margin: auto;">
1711 <h4><a name="distort" id="distort"></a>-distort <em class="arg">method arguments</em></h4>
1712</div>
1713
1714<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>
1715
1716<p>The <em class="arg">arguments</em> is a single string containing a list
1717of floating point numbers separated by commas or spaces. The number of
1718and meaning of the floating point values depends on the distortion <em
1719class="arg">method</em> being used. </p>
1720
1721<p>Choose from these distortion types:</p>
1722
1723<table class="doc">
1724 <tr valign="top">
1725 <th align="left" style="width: 8%">Method</th>
1726 <th align="left">Description</th>
1727 </tr>
1728
1729 <tr valign="top">
1730 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
1731 <br/>or &nbsp; <kbd>SRT</kbd></td>
1732 <td valign="top">
1733 Distort image by first scaling and rotating about a given 'center',
1734 before translating that 'center' to the new location, in that order. It
1735 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
1736 distortion, but without shearing effects. It also provides a good way
1737 of rotating and displacing a smaller image for tiling onto a larger
1738 background (IE 2-dimensional animations). <br/>
1739
1740 The number of arguments determine the specific meaning of each
1741 argument for the scales, rotation, and translation operations. <br/>
1742
1743 <table style="margin-left:auto; margin-right:auto;">
1744 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
1745 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
1746 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
1747 <tr><td>3:</td><td><em>ScaleX,ScaleY &nbsp; Angle</em></td></tr>
1748 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
1749 <tr><td>5:</td>
1750 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
1751 <tr><td>6:</td>
1752 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
1753 <tr><td>7:</td>
1754 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
1755 &nbsp; NewX,NewY</em></td></tr>
1756 </table>
1757
1758 This is actually an alternative way of specifing a 2 dimensional linear
1759 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
1760
1761 <tr valign="top">
1762 <td valign="top"><kbd>Affine</kbd></td>
1763 <td valign="top">
1764 Distort the image linearly by moving a list of at least 3 or more sets
1765 of control points (as defined below). Idealy 3 sets or 12 floating
1766 point values are given allowing the image to be linearly scaled,
1767 rotated, sheared, and translated, according to those three points. See
1768 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
1769 distortions. <br/>
1770
1771 More than 3 sets given control point pairs (12 numbers) is least
1772 squares fitted to best match a lineary affine distortion. If only 2
1773 control point pairs (8 numbers) are given a two point image translation
1774 rotation and scaling is performed, without any posible shearing,
1775 flipping or changes in aspect ratio to the resulting image. If only one
1776 control point pair is provides the image is only translated, (which may
1777 be a floating point non-integer translation). <br/>
1778
1779 This distortion does not include any form of perspective distortion.
1780 </td>
1781
1782 </tr>
1783
1784 <tr valign="top">
1785 <td valign="top"><kbd>AffineProjection</kbd></td>
1786 <td valign="top">
1787 Linearly distort an image using the given Affine Matrix of 6
1788 pre-calculated coefficients forming a set of Affine Equations to map
1789 the source image to the destination image.
1790
1791 <div style="text-align: center"><em>
1792 s<sub>x</sub>, r<sub>x</sub>,
1793 r<sub>y</sub>, s<sub>y</sub>,
1794 t<sub>x</sub>, t<sub>y</sub>
1795 </em></div>
1796
1797 See <a href="#affine" >-affine</a> setting for more detail, and
1798 meanings of these coefficients. <br/>
1799
1800 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
1801 alternative methods of defining this distortion, with ImageMagick doing the
1802 calculations needed to generate the required coefficients. You can see
1803 the internally generated coefficients, by using a <a href="#verbose"
1804 >-verbose</a> setting. </td>
1805
1806 </tr>
1807
1808<!-- still under development, do not display - Anthony
1809 <tr valign="top">
1810 <td valign="top"><kbd>Bilinear</kbd></td>
1811 <td valign="top">
1812 Bilinear (reversed) Distortion, given a minimum of 4 sets of
1813 coordinate pairs, or 16 values (see below). Not that lines may not
1814 appear straight after distortion, though the distance between
1815 coordinates will remain consistant. </td>
1816 </tr>
1817-->
1818
1819 <tr valign="top">
1820 <td valign="top"><kbd>Perspective</kbd></td>
1821 <td valign="top">
1822 Perspective distort the images, using a list of 4 or more sets of
1823 control points (as defined below). More that 4 sets (16 numbers) of
1824 control points provide least squares fitting for more accurate
1825 distortions (for the purposes of image registration and panarama
1826 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
1827 linear distortion. <br/>
1828
1829 Perspective Distorted images ensures that straight lines remain
1830 straight, but the scale of the distorted image will vary. The horizon
1831 is anti-aliased, and the 'sky' color may be set using the
1832 <a href="#mattecolor" >-mattecolor</a> setting. </td>
1833 </tr>
1834
1835 <tr valign="top">
1836 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
1837 <td valign="top">
1838 Do a '<kbd>Perspective</kbd>' distortion basied on a set of 8
1839 pre-calculated coefficients. You can get these coefficients by looking
1840 at the <a href="#verbose" >-verbose</a> output of a
1841 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
1842 If the last two perspective scaling coefficients are zero, the
1843 remaining 6 represents a transposed 'Affine Matrix'. </td>
1844
1845 </tr>
1846
1847 <tr valign="top">
1848 <td valign="top"><kbd>Arc</kbd></td>
1849 <td valign="top">
1850 Arc the image (variation of polar mapping) over the angle given around
1851 a circle. <br/>
1852 <table width="90%" style = "margin-left: auto; margin-right: auto;">
1853 <tr valign="top"><td>Argument</td>
1854 <td>Meaning</td></tr>
1855 <tr valign="top"><td><em>arc_angle</em></td>
1856 <td>The angle over which to arc the image side-to-side</td></tr>
1857 <tr valign="top"><td><em>rotate_angle</em></td>
1858 <td>Angle to rotate resulting image from vertical center</td></tr>
1859 <tr valign="top"><td><em>top_radius</em></td>
1860 <td>Set top edge of source image at this radius</td></tr>
1861 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
1862 <td>Set bottom edge to this radius (radial scaling)</td></tr>
1863 </table>
1864
1865 The resulting image is always resized to best fit the resulting image,
1866 (as if using <a href="#distort" >+distort</a>) while attempting to
1867 preserve scale and aspect ratio of the original image as much as
1868 possible with the arguments given by the user. All four arguments will
1869 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
1870
1871 This a variation of a polar distortion designed to try to preserve the
1872 aspect ratio of the image rather than direct Cartesian to Polar
1873 conversion. </td>
1874 </tr>
1875
1876 <tr valign="top">
1877 <td valign="top"><kbd>Polar</kbd></td>
1878 <td valign="top">
1879 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
1880 the image. that is the height of the input image is mapped to the
1881 radius limits, while the width is wrapped around between the
1882 angle limits. <br/>
1883
1884 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
1885
1886 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
1887 center to the center of the image, and the angles going from -180 (top)
1888 to +180 (top). If <em>Rmax</em> is given the special value of
1889 '<code>0</code>', the the distance from the center to the nearest edge
1890 is used for the radius of the output image, which will ensure the whole
1891 image is visible (though scaled smaller). However a special value of
1892 '<code>-1</code>' will use the distance from the center to the furthest
1893 corner, This may 'clip' the corners from the input rectangular image,
1894 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
1895 the same arguments. <br/>
1896
1897 If the plus form of distort (<a href="#distort" >+distort</a>) is used
1898 output image center will default to <code>0,0</code> of the virtual
1899 canvas, and the image size adjusted to ensure the whole input image is
1900 made visible in the output image on the virtual canvas. </td>
1901
1902 </tr>
1903
1904 <tr valign="top">
1905 <td valign="top"><kbd>DePolar</kbd></td>
1906 <td valign="top">
1907 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
1908 but generates the reverse Polar to Cartesian distortion. <br/>
1909
1910 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
1911 the corners of the input image. However using the special
1912 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
1913 distance) will ensure the whole distorted image is preserved in the
1914 generated result, so that the same argument to '<kbd>Polar</kbd>' will
1915 reverse the distortion re-producing the original.
1916
1917 Note that as this distortion requires the area resampling of a circular
1918 arc, which can not be handled by the builtin EWA resampling function.
1919 As such the normal EWA filters are turned off. It is recomended some
1920 form of 'super-sampling' image processing technique be used to produce
1921 a high quality result. </td>
1922
1923 </tr>
1924
1925 <tr valign="top">
1926 <td valign="top"><kbd>Barrel</kbd></td>
1927 <td valign="top">
1928 Given the four coefficients (A,B,C,D) as defined by <a
1929 href="http://www.all-in-one.ee/~dersch/barrel/barrel.html" >Helmut
1930 Dersch</a>, perform a barrell or pincussion distortion appropriate to
1931 correct radial lens distortions. That is in photographs, make straight
1932 lines straight again. <br/>
1933
1934 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
1935 <em>X</em> , <em>Y</em> ] ] <br/>
1936 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
1937 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
1938 [ <em>X</em> , <em>Y</em> ] <br/>
1939 So that it forms the function <br/>
1940 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
1941 <em>C</em>*r + <em>D</em> )<br/>
1942
1943 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
1944 (defaulting to the center of the image). <br/>
1945 The second form is typically used to distort images, rather than
1946 correct lens distortions. <br/>
1947 </td>
1948
1949 </tr>
1950
1951 <tr valign="top">
1952 <td valign="top"><kbd>BarrelInverse</kbd></td>
1953 <td valign="top">
1954 This is very simular to '<kbd>Barrel</kbd>' with the same set of
1955 arguments, and argument handling. However it uses the inverse
1956 of the radial polynomial,
1957 so that it forms the function <br/>
1958 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
1959 <em>C</em>*r + <em>D</em> )
1960 </td>
1961 </tr>
1962
1963 <tr valign="top">
1964 <td valign="top"><kbd>Shepards</kbd></td>
1965 <td valign="top">
1966 Distort the given list control points (any number) using an Inverse
1967 Squared Distance Interpolation Method (<a
1968 href="http://www.ems-i.com/smshelp/Data_Module/Interpolation/Inverse_Distance_Weighted.htm"
1969 >Shepards Method</a>). The control points in effect do 'localized'
1970 distortions of the image around the given control point. For best
1971 results extra control points should be added to 'lock' the positions of
1972 the corners and other unchanging parts of the image. <br/>
1973
1974 The distortion has been likened to 'taffy pulling' using nails, pins or
1975 sticks. It basically uses the <a href="#sparse-color"
1976 >-sparse-color</a> method of the same name to generate separate X and Y
1977 displacement maps (see <a href="#displace" >-displace</a>) for source
1978 image color look-up. </td>
1979
1980 </tr>
1981
1982</table>
1983
1984<p>To print a complete list of distortion methods, use <a href="#list">-list distort</a>.</p>
1985
1986<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
1987'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
1988defining how these points in the given image should be distorted in the
1989destination image. Each set of four floating point values represent a source
1990image coordinate, followed immediately by the destination image coordinate.
1991This produces a list of values such as...</p>
1992<div style="text-align: center"><em>
1993 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
1994 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
1995 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
1996 ... &nbsp;
1997 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
1998</em></div>
1999<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2000destination image. </p>
2001
2002<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2003needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2004perspective distortion of the built-in "rose:" image. Note how spaces were
2005used to group the 4 sets of coordinate pairs, to make it easier to read and
2006understand.</p>
2007
2008<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2009 convert rose: -virtual-pixel black \ <br/>
2010 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \ <br/>
2011 rose_3d_rotated.gif</span></p>
2012<p>If more that the required number of coordinate pairs are given for a
2013distortion, the distortion method is 'least squares' fitted to
2014produce the best result for all the coordinate pairs given. If less than the
2015ideal number of points are given, the distort will generally fall back to a
2016simpler form of distortion that can handles the smaller number of coordinates
2017(usally a linear '<kbd>Affine</kbd>' distortion). </p>
2018
2019<p>By using more coodinates you can make use of image registration tool to
2020find matching coordinate pairs in overlaping images, so as to improve the 'fit'
2021of the distortion. Of course a bad coordinate pair can also make the 'fit'
2022worse. Caution is always advised. </p>
2023
2024<p>Colors are acquired from the source image according to the <a
2025href="#interpolate" >-interpolate</a> color lookup setting, when the image is
2026magnified. However if the viewed image is minified (image becomes smaller), a
2027special area resampling function (added ImageMagick v6.3.5-9), is used to
2028produce a higher quality image. For example you can use a
2029'<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all the
2030way to the horizon. </p>
2031
2032<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \ <br/>
2033 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \ <br/>
2034 checks_tiled.jpg</span></p>
2035<p>Note that a infinitely tiled perspective images involving the horizon can
2036be very slow to generate due to the use of the high quality 'area resampling'
2037function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2038using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2039(recommended if you plan to use super-sampling instead). </p>
2040
2041<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2042'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2043will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2044pixels. If you do not what these pixels to be visible, set the color to match
2045the rest of the ground. </p>
2046
2047<p>The output image size will by default be the same as the input image. This
2048means that if the part of the distorted image falls outside the viewed area of
2049the 'distorted space', those parts is clipped and lost. However if you
2050use the plus form of the operator (<a href="#distort" >+distort</a>) the
2051operator will attempt (if posible) to show the whole of the distorted image,
2052while retaining a correct 'virtual canvas' offset, for image layering. This
2053offset may need to be removed using <a href="#repage" >+repage</a>, to remove
2054if it is unwanted. </p>
2055
2056<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2057option:distort:viewport {geometry_string}</kbd>" setting which will specify
2058the size and the offset of the generated 'viewport' image of the distorted
2059image space.</p>
2060
2061<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2062{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2063that factor without changing the viewed contents of the distorted image. This
2064can be used either for 'super-sampling' the image for a higher quality result,
2065or for panning and zooming around the image (with appropriate viewport
2066changes, or post-distort cropping and resizing). </p>
2067
2068<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2069href="#distort" >-distort</a> to attempt to output the internal coefficients,
2070and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2071and debugging purposes. This many not be available for all distorts. </p>
2072
2073<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2074produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2075and/or <a href="#shear" >-shear</a> operation, with more control of due to the
2076above settings. It is algorithmically slower, though in ImageMagick it may be faster.
2077</p>
2078
2079
2080<div style="margin: auto;">
2081 <h4><a name="dither" id="dither"></a>-dither <em class="arg">method</em></h4>
2082</div>
2083
2084<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>
2085
2086<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>
2087
2088<p>Dithering is turned on by default, to turn it off use the plus form of the
2089setting, <a href="#dither">+dither</a>. This will also also render PostScript
2090without text or graphic aliasing. Disabling dithering often (but not always)
2091leads to faster process, a smaller number of colors, but more cartoon like
2092image coloring. Generally resulting in 'color banding' effects in areas with
2093color gradients. </p>
2094
2095<p>The color reduction operators <a href="#colors">-colors</a>, <a
2096href="#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>
2097
2098<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>
2099
2100
2101<div style="margin: auto;">
2102 <h4><a name="draw" id="draw"></a>-draw <em class="arg">string</em></h4>
2103</div>
2104
2105<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>
2106
2107<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>
2108
2109<p>The shape primitives:</p>
2110
2111<pre class="text">
2112 point x,y
2113 line x0,y0 x1,y1
2114 rectangle x0,y0 x1,y1
2115 roundRectangle x0,y0 x1,y1 wc,hc
2116 arc x0,y0 x1,y1 a0,a1
2117 ellipse x0,y0 rx,ry a0,a1
2118 circle x0,y0 x1,y1
2119 polyline x0,y0 ... xn,yn
2120 polygon x0,y0 ... xn,yn
2121 bezier x0,y0 ... xn,yn
2122 path path specification
2123 image operator x0,y0 w,h filename
2124</pre>
2125
2126<p>The text primitive:</p>
2127
2128<pre class="text">
2129 text x0,y0 string
2130</pre>
2131<p>The text gravity primitive:</p>
2132
2133<pre class="text">
2134 gravity NorthWest, North, NorthEast, West, Center,
2135 East, SouthWest, South, or SouthEast
2136</pre>
2137
2138<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>
2139
2140<p>The transformation primitives:</p>
2141
2142<pre class="text">
2143 rotate degrees
2144 translate dx,dy
2145 scale sx,sy
2146 skewX degrees
2147 skewY degrees
2148</pre>
2149
2150<p>The pixel operation primitives:</p>
2151
2152<pre class="text">
2153 color x0,y0 method
2154 matte x0,y0 method
2155</pre>
2156
2157<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>
2158
2159<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>
2160
2161<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2162
2163<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2164
2165<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>
2166
2167<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2168
2169<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>
2170
2171<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>
2172
2173<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>.
2174</p>
2175
2176<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2177
2178<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2179
2180<p class="crtsnip">
2181 -draw 'circle 100,100 150,150'
2182</p>
2183
2184<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
2185draw 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>
2186
2187<p class="crtsnip">
2188 -draw 'bezier 20,50 45,100 45,0 70,50'
2189</p>
2190<p class="crtsnip">
2191 -draw 'bezier 70,50 95,100 95,0 120,50'
2192</p>
2193
2194
2195<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>
2196
2197<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>
2198
2199<p class="crtsnip">
2200 -draw 'image SrcOver 100,100 225,225 image.jpg'
2201</p>
2202
cristybc9539a2010-08-16 18:06:20 +00002203<p>You can use 0,0 for the image size, which means to use the actual
2204dimensions found in the image header. Otherwise, it is scaled to the given
2205dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
2206a detailed discussion of alpha composition methods that are available. </p>
cristy3ed852e2009-09-05 21:47:34 +00002207
2208<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>
2209
2210<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2211
2212<p class="crtsnip">
2213 -draw 'text 100,100 "Works like magick!"'
2214</p>
2215
2216<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2217
2218<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>
2219
2220<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2221
2222<p>The <kbd>scale</kbd> primitive scales them.</p>
2223
2224<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>
2225
2226<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
2227matrix.</p>
2228
2229<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>
2230
2231<pre class="text">
2232 point
2233 replace
2234 floodfill
2235 filltoborder
2236 reset
2237</pre>
2238
2239<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>
2240
2241<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>
2242
2243<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>
2244
2245<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2246
2247<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2248
2249
2250<div style="margin: auto;">
2251 <h4><a name="edge" id="edge"></a>-edge <em class="arg">radius</em></h4>
2252</div>
2253
2254<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>
2255
2256<div style="margin: auto;">
2257 <h4><a name="emboss" id="emboss"></a>-emboss <em class="arg">radius</em></h4>
2258</div>
2259
2260<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>
2261
2262<div style="margin: auto;">
2263 <h4><a name="encipher" id="encipher"></a>-encipher <em class="arg">filename</em></h4>
2264</div>
2265
2266<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>
2267
2268<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2269
2270<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2271
2272<div style="margin: auto;">
2273 <h4><a name="encoding" id="encoding"></a>-encoding <em class="arg">type</em></h4>
2274</div>
2275
2276<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>
2277
2278<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>
2279
2280<div style="margin: auto;">
2281 <h4><a name="endian" id="endian"></a>-endian <em class="arg">type</em></h4>
2282</div>
2283
2284<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>
2285
2286<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2287
2288<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2289
2290
2291<div style="margin: auto;">
2292 <h4><a name="enhance" id="enhance"></a>-enhance</h4>
2293</div>
2294
2295<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>
2296
2297
2298<div style="margin: auto;">
2299 <h4><a name="equalize" id="equalize"></a>-equalize</h4>
2300</div>
2301
2302<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>
2303
2304<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>
2305
2306<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2307
2308<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>
2309
2310<div style="margin: auto;">
2311 <h4><a name="evaluate" id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
2312</div>
2313
2314<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>
2315
2316<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>
2317
2318<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>
2319
2320<table class="doc">
2321 <col width="25%" />
2322 <col width="75%" />
2323 <thead>
2324 <tr>
2325 <th><em class="arg">operator</em></th>
2326 <th>Summary (see further below for details)</th>
2327 </tr>
2328 </thead>
2329 <tbody>
2330
cristy3c98a4f2010-08-13 20:09:41 +00002331 <tr><td>Abs </td> <td>Add <em class="arg">value</em> to pixels and return absolute value. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002332 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2333 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2334 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2335 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2336 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
2337 <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>
2338 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2339 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002340 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002341 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2342 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2343 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2344 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2345 <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>
2346 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2347 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2348 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2349 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2350
2351 <tr><td>&nbsp;</td></tr>
2352
2353 <tr><td>Gaussian-noise</td></tr>
2354 <tr><td>Impulse-noise</td></tr>
2355 <tr><td>Laplacian-noise</td></tr>
2356 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2357 <tr><td>PoissonNoise</td></tr>
2358 <tr><td>Uniform-noise</td></tr>
2359
2360 <tr><td>&nbsp;</td></tr>
2361
2362 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2363 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2364 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2365 </tbody>
2366 </table>
2367
2368<p>The specified functions are applied only to each previously set <a
2369href="#channel" >-channel</a> in the image. If necessary, the results of the
2370calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2371class="QR">QuantumRange</em>]. The transparency channel of the image is
2372represented as a 'alpha' values (0 = fully transparent), so, for example, a
2373<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2374semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2375as a percentage of the <em class="QR">QuantumRange</em>.</p>
2376
2377<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2378<a href="#list">-list evaluate</a>.</p>
2379
2380<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2381<kbd>Multiply</kbd> methods can also be achieved using either the <a
2382href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2383appropriate argument, to linearly modify the overall range of color values.
2384Please note, however, that <a href="#level" >-level</a> treats transparency as
2385'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2386'alpha' values.</p>
2387
2388<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>
2389
2390<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>
2391
2392 <div style="text-align:center;">
2393 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2394 </div>
2395
2396<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2397normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2398href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2399to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2400with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2401with <kbd>Pow</kbd>.</p>
2402
2403<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2404converts the image values into a value according to a (co)sine wave function.
2405The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2406is biased 50% and normalized by 50% so as to fit in the respective color value
2407range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2408function (its frequency), and thus determines the number of 'waves' that will
2409be generated over the input color range. For example, if the <em
2410class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2411class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2412then the effective period is the <em>half</em> the <em
2413class="QR">QuantumRange</em>.
2414
2415 <div style="text-align:center;">
2416 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2417 </div>
2418
2419See also the <a href="#function" >-function</a> operator, which is a
2420multi-value version of evaluate. </P>
2421
cristy63fed272010-03-07 19:08:45 +00002422<div style="margin: auto;">
2423 <h4><a name="evaluate-sequence" id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
2424</div>
2425
2426<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 +00002427
2428<div style="margin: auto;">
2429 <h4><a name="extent" id="extent"></a>-extent <em class="arg">geometry</em></h4>
2430</div>
2431
2432<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>
2433
cristy3e2860c2010-01-24 01:36:30 +00002434<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 +00002435
2436<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>
2437
2438<div style="margin: auto;">
2439 <h4><a name="extract" id="extract"></a>-extract <em class="arg">geometry</em></h4>
2440</div>
2441
2442<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>
2443
2444<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2445
cristy4949d522010-03-12 18:41:34 +00002446<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 +00002447
cristy4949d522010-03-12 18:41:34 +00002448<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 +00002449<p>then the image will be <em>resized</em> to the specified dimensions instead,
2450equivalent to:</p>
2451
2452<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>
2453<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>
2454
2455<div style="margin: auto;">
2456 <h4><a name="family" id="family"></a>-family <em class="arg">fontFamily</em></h4>
2457</div>
2458
2459<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>
2460
2461<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).
2462</p>
2463
2464<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>.
2465</p>
2466
2467<div style="margin: auto;">
cristy7396d882010-01-27 02:37:56 +00002468 <h4><a name="features" id="features"></a>-features <em class="arg">distance</em></h4>
2469</div>
2470
2471<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>
2472
2473<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00002474 <h4><a name="fft" id="fft"></a>-fft</h4>
2475</div>
2476
2477<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>
2478
cristyb36feb22010-03-26 16:54:37 +00002479<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 +00002480
2481<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>
2482
2483<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>
2484
2485<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2486<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>
2487
2488<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2489<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>
2490
2491<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>
2492
2493<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>
2494
2495<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2496 -evaluate log 1000 fft_image_spectrum.png</span></p>
2497<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>
2498
2499<p>The <a href="http://www.fftw.org/" target="_blank">FFTW</a> delegate library is required to use <a href="#fft">-fft</a>.
2500
2501<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>
2502
2503<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>
2504
2505<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>
2506
2507<p>See the discussion on HDRI implementations of ImageMagick on the page
2508<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.
2509</p>
2510
2511
2512<div style="margin: auto;">
2513 <h4><a name="fill" id="fill"></a>-fill <em class="arg">color</em></h4>
2514</div>
2515
2516<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>
2517
2518<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>
2519
2520<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2521
2522<p>For example,</p>
2523
2524<p class="crtsnip">
2525 -fill blue
2526</p>
2527<p class="crtsnip">
2528 -fill "#ddddff"
2529</p>
2530<p class="crtsnip">
2531 -fill "rgb(255,255,255)"
2532</p>
2533
2534<p>See <a href="#draw">-draw</a> for further details.</p>
2535
2536<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2537
2538<div style="margin: auto;">
2539 <h4><a name="filter" id="filter"></a>-filter <em class="arg">type</em></h4>
2540</div>
2541
2542<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>
2543
2544<p>Use this option to affect the resizing operation of an image (see <a
2545href="#resize">-resize</a>). For example you can use a simple resize filter
2546such as:</p>
2547
2548<pre class="text">
2549 Point Hermite Cubic
2550 Box Gaussian Catrom
2551 Triangle Quadratic Mitchell
2552</pre>
2553
2554<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided, but are
2555by default <kbd>blackman</kbd>-windowed. However these filters define a
2556windowing filter for the Sinc or Bessel filter function, as appropriate for
2557the scaling operator used (usally Sinc for orthogonal <a href="#resize"
2558>-resize</a>). Windowed filters include: </p>
2559
2560<pre class="text">
2561 Lanczos Hamming Parzen
2562 Blackman Kaiser Welsh
2563 Hanning Bartlett Bohman
2564</pre>
2565
2566<p>Also one special self-windowing filter is also provided
2567<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2568on the current 'support' or 'lobes' expert settings (see below).</p>
2569
2570<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>
2571
2572<p>To print a complete list of resize filters, use the <a href="#list">-list filter</a> option.</p>
2573
2574<p>You can modify how the filter behaves as it scales your image through the
2575use of these expert settings:</p>
2576
2577<dl class="doc">
2578<dt>-set filter:blur <em>factor</em></dt>
2579<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
2580 blurry or &lt; 1.0 for sharp.</dd>
2581
2582<dt>-set filter:support <em>radius</em></dt>
2583<dd>Set the filter support radius.</dd>
2584
2585<dt>-set filter:lobes <em>count</em></dt>
2586<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
2587 alternative way of specifying the 'support' range of the filter.</dd>
2588
2589<dt>-set filter:b <em>b-spline_factor</em></dt>
2590<dt>-set filter:c <em>keys_alpha_factor</em></dt>
2591<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2592 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2593 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2594 are defined, the other is set so as to generate a 'Keys' type cubic
2595 filter.
2596
2597<dt>-set filter:filter <em>filter</em></dt>
2598<dd>Use this function directly as the scaling filter. This will allow
2599 you to directly use a 'windowing filter' such as <kbd>blackman</kbd>,
2600 rather than as its normal usage as a windowing function for 'Sinc' or
2601 'Bessel'. If defined, no windowing function is used, unless the following
2602 expert setting is also defined.</dd>
2603
2604<dt>-set filter:window <em>filter</em></dt>
2605<dd>The IIR (infinite impulse response) filters <kbd>bessel</kbd> and
2606 <kbd>sinc</kbd> are windowed (brought down to zero over the defined
2607 support range) with the given filter. This allows you to use a filter that
2608 is not normally used as a windowing function, such as <kbd>box</kbd>,
2609 (which effectivally turns off the windowing function). </dd>
2610
2611</dl>
2612
2613<p>For example, to get a 8 lobe Lanczos-Bessel filter:</p>
2614
2615<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
2616 -set filter:window=bessel -set filter:lobes=8 \ <br/>
2617 -resize 150% image.jpg</span></p>
2618<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
2619
2620<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
2621 -resize 150% image.jpg</span></p>
2622<p>Note that the use of expert options (except for 'blur' with simple resize
2623filters), are provided for image processing experts who have studied and
2624understood how resize filters work. Without this knowledge, and an
2625understanding of the defination of the actual filters involved, using expert
2626settings are more likely to be detremental to your image resizing.</p>
2627
2628
2629<div style="margin: auto;">
2630 <h4><a name="flatten" id="flatten"></a>-flatten</h4>
2631</div>
2632
2633<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>
2634
2635
2636<div style="margin: auto;">
2637 <h4><a name="flip" id="flip"></a>-flip</h4>
2638</div>
2639
2640<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>
2641
2642<p>reflect the scanlines in the vertical direction.</p>
2643
2644<div style="margin: auto;">
2645 <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>
2646</div>
2647
2648<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>
2649
2650<div style="margin: auto;">
2651 <h4><a name="flop" id="flop"></a>-flop</h4>
2652</div>
2653
2654<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>
2655
2656<p>reflect the scanlines in the horizontal direction.</p>
2657
2658
2659<div style="margin: auto;">
2660 <h4><a name="font" id="font"></a>-font <em class="arg">name</em></h4>
2661</div>
2662
2663<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>
2664
2665<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>
2666
2667<p>In addition to the fonts specified by the above pre-defined list, you can
2668also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
2669is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
2670<kbd>x:fixed</kbd> is X11 font.</p>
2671
2672<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>
2673
2674
2675<div style="margin: auto;">
2676 <h4><a name="foreground" id="foreground"></a>-foreground <em class="arg">color</em></h4>
2677</div>
2678
2679<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>
2680
2681<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
2682
2683<p>The default foreground color is black.</p>
2684
2685<div style="margin: auto;">
2686 <h4><a name="format" id="format"></a>-format <em class="arg">type</em></h4>
2687</div>
2688
2689<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>
2690
2691<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>
2692
2693<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>
2694
2695<div style="margin: auto;">
2696 <h4><a name="format_identify_" id="format_identify_"></a>-format <em class="arg">string</em></h4>
2697</div>
2698
2699<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>
2700
2701<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>
2702
2703<div style="margin: auto;">
2704 <h4><a name="frame" id="frame"></a>-frame <em class="arg">geometry</em></h4>
2705</div>
2706
2707<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>
2708
cristybc9539a2010-08-16 18:06:20 +00002709<p>The color of the border is specified with the <a href="#mattecolor"
2710>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00002711
cristybc9539a2010-08-16 18:06:20 +00002712<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
2713class="arg">geometry</em> argument indicates the amount of extra width and
2714height that is added to the dimensions of the image. If no offsets are given
2715in the <em class="arg">geometry</em> argument, then the border added is
2716a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
2717the width and height of the border is partitioned to form an outer bevel of
2718thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
2719<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
2720</p>
2721
2722<p>The <a href="#frame">-frame</a> option is affected by the current <a
2723href="#compose">-compose</a> setting and assumes that this is using the default
2724'<kbd>Over</kbd>' composition method. It generates a image of the appripriate
2725size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
2726draws the frame of four distinct colors close to the current <a
2727href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
2728center of this image. This means that with the default compose method of
2729'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
2730href="#bordercolor">-bordercolor</a> setting.</p>
2731
2732<p>The image composition is not
2733affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002734
2735
2736<div style="margin: auto;">
2737 <h4><a name="frame_import_" id="frame_import_"></a>-frame</h4>
2738</div>
2739
2740<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>
2741
2742<div style="margin: auto;">
2743 <h4><a name="function" id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
2744</div>
2745
2746<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>
2747
2748<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>
2749
2750<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>
2751
2752<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>
2753
2754<pre class="text">
2755 Polynomial
2756 Sinusoid
2757 Arcsin
2758 Arctan
2759</pre>
2760
2761<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
2762
2763<dl class="doc">
2764<dt><kbd>Polynomial</kbd></dt>
2765<dd>
2766<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>
2767
2768<div style="text-align: center">
2769 -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>
2770</div>
2771
2772<p>will invoke a polynomial function given by</p>
2773
2774<div style="text-align: center">
2775 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
2776 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
2777 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
2778</div>
2779
2780<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
2781
2782<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>
2783
2784<table class="doc">
2785 <col width="35%" />
2786 <col width="35%" />
2787 <col width="30%" />
2788 <tr>
2789 <td>-evaluate Set <em class="arg">value</em> </td>
2790 <td>-function Polynomial <em class="arg">value</em></td>
2791 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
2792 </tr>
2793 <tr>
2794 <td>-evaluate Add <em class="arg">value</em> </td>
2795 <td>-function Polynomial 1,<em class="arg">value</em></td>
2796 </tr>
2797 <tr>
2798 <td>-evaluate Subtract <em class="arg">value</em> </td>
2799 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
2800 </tr>
2801 <tr>
2802 <td>-evaluate Multiply <em class="arg">value</em> </td>
2803 <td>-function Polynomial <em class="arg">value</em>,0</td>
2804 </tr>
2805 <tr>
2806 <td>+level black% x white%</td>
2807 <td>-function Polynomial A,B</td>
2808 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
2809 </tr>
2810</table>
2811
2812<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>
2813</dd>
2814
2815<dt><kbd>Sinusoid</kbd></dt>
2816<dd>
2817<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>
2818
2819<div style="text-align: center">
2820 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
2821</div>
2822
2823<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>
2824
2825<div style="text-align: center">
2826<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>
2827</div>
2828
2829<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>
2830
2831<p class="crtsnip">
2832 -function Sinusoid 3,-90,.2,.7
2833</p>
2834
2835<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>
2836
2837<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>
2838
2839<table class="doc">
2840 <tr>
2841 <td>-evaluate Sin <em class="arg">freq</em> </td>
2842 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
2843 </tr>
2844 <tr>
2845 <td>-evaluate Cos <em class="arg">freq</em> </td>
2846 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
2847 </tr>
2848</table>
2849</dd>
2850
2851<dt><kbd>ArcSin</kbd></dt>
2852<dd>
2853<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
2854and can be used to generate cylindrical distortion and displacement maps.
2855The curve can be adjusted relative to both the input values and output range
2856of values.
2857
2858<div style="text-align: center">
2859 -function <kbd>ArcSin</kbd> <em class="arg">width</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
2860</div>
2861
2862<p>with all values given in terms of noramlize color values (0.0 for black,
28631.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
2864for bout input (<em class="arg">width</em>), and output (<em
2865class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
2866
2867<div style="text-align: center">
2868<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>
2869</div>
2870
2871</dd>
2872
2873<dt><kbd>ArcTan</kbd></dt>
2874<dd>
2875<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
2876limit values at infinities, though a center using the given slope value.
2877All these values can be adjusted via the arguments.
2878
2879<div style="text-align: center">
2880 -function <kbd>ArcTan</kbd> <em class="arg">slope</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
2881</div>
2882
2883<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
2884</p>
2885
2886<div style="text-align: center">
2887<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>
2888</div>
2889
2890</dd>
2891
2892</dl>
2893
2894
2895<div style="margin: auto;">
2896 <h4><a name="fuzz" id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
2897</div>
2898
2899<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>
2900
2901<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>
2902
2903<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>
2904
2905
2906<div style="margin: auto;">
2907 <h4><a name="fx" id="fx"></a>-fx <em class="arg">expression</em></h4>
2908</div>
2909
2910<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>
2911
2912<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>
2913
2914<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
2915
2916
2917<div style="margin: auto;">
2918 <h4><a name="gamma" id="gamma"></a>-gamma <em class="arg">value</em></h4>
2919</div>
2920
2921<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>
2922
2923<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>
2924
2925<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>
2926
2927<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>
2928
2929<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>
2930
2931<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
2932
2933<div style="margin: auto;">
2934 <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>
2935</div>
2936
2937<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>
2938
cristyb15553d2010-07-03 22:53:14 +00002939<p>Convolve the image with a Gaussian or normal distribution using the given
2940<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00002941
2942<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
2943</div>
2944
cristyb15553d2010-07-03 22:53:14 +00002945<p>The <em class="arg" >Sigma</em> value is the important argument, and
2946determines the actual amount of bluring that will take place. </p>
2947
2948<p>The <em class="arg" >Radius</em> is only used to determine the size of the
2949array which will hold the calculated gaussian distribution. It should be an
2950integer. If not given, or set to zero, IM will calculate the largest posible
2951radius that will provide meaningful results for the Gaussian distribution.
2952</p>
2953
2954<p>The larger the <em class="arg" >Radius</em> the radius the slower the
2955operation is. However too small a <em class="arg" >Radius</em>, and sever
2956aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
2957should be at least twice the <em class="arg" >Sigma</em> value, though three
2958times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00002959
2960<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
2961full 2-dimentional convolution is used to generate the weighted average of the
2962neighbouring pixels. </p>
2963
2964<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
2965pixels which are outside the image proper are blurred into the final result.
2966</p>
2967
2968
2969<div style="margin: auto;">
2970 <h4><a name="geometry" id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
2971</div>
2972
2973<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>
2974
2975<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>
2976
2977<div style="margin: auto;">
2978 <h4><a name="gravity" id="gravity"></a>-gravity <em class="arg">type</em></h4>
2979</div>
2980
2981<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>
2982
2983<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
2984<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
2985<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
2986list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
2987installation.</p>
2988
2989<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>
2990
2991<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>
2992
2993<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>
2994
cristy4949d522010-03-12 18:41:34 +00002995<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 +00002996<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>
2997
2998<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>
2999
3000
3001<div style="margin: auto;">
3002 <h4><a name="green-primary" id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
3003</div>
3004
3005<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>
3006
3007
3008<div style="margin: auto;">
3009 <h4><a name="hald-clut" id="hald-clut"></a>-hald-clut</h4>
3010</div>
3011
3012<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>
3013
3014<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3015dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3016can apply any color transformation to the Hald image and then use this option
3017to apply the transform to the image. </p>
3018
3019<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3020<p>This option provides a convenient method for you to use Gimp or Photoshop
3021to make color corrections to the Hald CLUT image and subsequently apply them
3022to multiple images using an ImageMagick script. </p>
3023
3024<p>Note that the representation is only of the normal RGB color space and that
3025the whole color value triplet is used for the interpolated lookup of the
3026represented Hald color cube image. Because of this the operation is not <a
3027href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3028images transparency or alpha/matte channel.</p>
3029
3030<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3031of the individual color channels, usally involving a simplier gray-scale
3032image. E.g: gray-scale to color replacement, or modification by a histogram
3033mapping. </p>
3034
3035
3036<div style="margin: auto;">
3037 <h4><a name="help" id="help"></a>-help</h4>
3038</div>
3039
3040<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>
3041
3042<div style="margin: auto;">
3043 <h4><a name="highlight-color" id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
3044</div>
3045
3046<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>
3047
3048<div style="margin: auto;">
3049 <h4><a name="iconGeometry" id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
3050</div>
3051
3052<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>
3053
3054<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>
3055
3056<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>
3057
3058<div style="margin: auto;">
3059 <h4><a name="iconic" id="iconic"></a>-iconic</h4>
3060</div>
3061
3062<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>
3063
3064<div style="margin: auto;">
3065 <h4><a name="identify" id="identify"></a>-identify</h4>
3066</div>
3067
3068<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>
3069
3070<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>
3071
3072<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>
3073
3074<p>If <a href="#verbose">-verbose</a> preceds this option, copious
3075amounts of image properties are displayed including image statistics, profiles,
3076image histogram, and others.</p>
3077
3078<div style="margin: auto;">
3079 <h4><a name="ift" id="ift"></a>-ift</h4>
3080</div>
3081
3082<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>
3083
cristyb36feb22010-03-26 16:54:37 +00003084<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 +00003085
3086<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>
3087
3088<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3089<p>or</p>
3090
3091<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>
3092
3093<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.
3094
3095<p>The <a href="http://www.fftw.org/" target="_blank">FFTW</a> delegate library is required to use <a href="#ift">-ift</a>.
3096
3097<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.
3098
3099<div style="margin: auto;">
3100 <h4><a name="immutable" id="immutable"></a>-immutable</h4>
3101</div>
3102
3103<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>
3104
3105<div style="margin: auto;">
3106 <h4><a name="implode" id="implode"></a>-implode <em class="arg">factor</em></h4>
3107</div>
3108
3109<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>
3110
3111<div style="margin: auto;">
3112 <h4><a name="insert" id="insert"></a>-insert <em class="arg">index</em></h4>
3113</div>
3114
3115<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>
3116
3117<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>
3118
3119<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>
3120
3121<div style="margin: auto;">
3122 <h4><a name="intent" id="intent"></a>-intent <em class="arg">type</em></h4>
3123</div>
3124
3125<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>
3126
3127<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>
3128
3129<p>The default intent is undefined.</p>
3130
3131<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3132
3133<div style="margin: auto;">
3134 <h4><a name="interlace" id="interlace"></a>-interlace <em class="arg">type</em></h4>
3135</div>
3136
3137<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>
3138
3139<p>Choose from:</p>
3140
3141<pre class="text">
3142 none
3143 line
3144 plane
3145 partition
3146 JPEG
3147 GIF
3148 PNG
3149</pre>
3150
3151<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>
3152
3153<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3154
3155<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3156
3157<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3158
3159<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3160image.G, and image.B).</p>
3161
3162<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>
3163image.</p>
3164
3165<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3166
3167<div style="margin: auto;">
3168 <h4><a name="interpolate" id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
3169</div>
3170
3171<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>
3172
3173<p>When looking up the color of a pixel using a non-interger floating point
3174value, you typically fall in between the pixel colors defined by the source
3175image. This setting determines how the color is determined from the colors of
3176the pixels surrounding that point. That is how to determine the color of a
3177point that falls between two, or even four different colored pixels. </p>
3178
3179<pre class="text">
3180 integer: The color of the top-left pixel (floor function)
3181 nearest-neighbor: The nearest pixel to the lookup point (rounded function)
3182 average: The average color of the surrounding four pixels
3183 bilinear A double linear interpolation of pixels (the default)
3184 mesh Divide area into two flat triangular interpolations
3185 bicubic Fitted bicubic-spines of surrounding 16 pixels
3186 spline Direct spline curves (colors are blurred)
3187 filter Use resize <a href="#filter">-filter</a> settings
3188</pre>
3189
3190<p>This most important for distortion operators such as <a href="#distort"
3191>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3192>-transform</a> and <a href="#fx" >-fx</a>. </p>
3193
3194<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3195
3196<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3197lookup for positions outside the boundaries of the image. </p>
3198
3199
3200<div style="margin: auto;">
cristyf3bb4782009-09-08 13:10:04 +00003201 <h4><a name="interline-spacing" id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
3202</div>
3203
3204<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>
3205
3206<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00003207 <h4><a name="interword-spacing" id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
3208</div>
3209
3210<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>
3211
3212<div style="margin: auto;">
3213 <h4><a name="kerning" id="kerning"></a>-kerning <em class="arg">value</em></h4>
3214</div>
3215
3216<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>
3217
3218<div style="margin: auto;">
3219 <h4><a name="label" id="label"></a>-label <em class="arg">name</em></h4>
3220</div>
3221
3222<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>
3223
3224<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>
3225
3226<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>
3227
cristybc9539a2010-08-16 18:06:20 +00003228<p>You can include the image filename, type, width, height, or other image
3229attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3230Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003231
3232<p>For example,</p>
3233
3234<p class="crtsnip">
3235 -label "%m:%f %wx%h" bird.miff
3236</p>
3237
3238<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>
3239
3240<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>
3241
3242<p>The label font can be specified with <a href="#font">-font</a>, and the
3243other font attribute settings.</p>
3244
3245<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>
3246
3247
3248<div style="margin: auto;">
3249 <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>
3250</div>
3251
3252<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>
3253
3254<p>Adaptively threshold each pixel based on the value of pixels in a
3255surrounding window. If the current pixel is lighter than this average plus
3256the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3257black. Small variations in pixel values such as found in scanned documents
3258can be ignored if offset is positive. A negative offset will make it more
3259sensitive to those small variations. </p>
3260
3261<p>This is commonly used to threshold images with an uneven background. It is
3262based on the assumption that average color of the small window is the
3263the local background color, from which to separate the forground color. </p>
3264
3265
3266<div style="margin: auto;">
3267 <h4><a name="layers" id="layers"></a>-layers <em class="arg">method</em></h4>
3268</div>
3269
3270<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>
3271
3272<p>Perform various image operation methods to a ordered sequence of images
3273which may represent either a set of overlaid 'image layers', a GIF disposal
3274animation, or a fully-'coalesced' animation sequence. </p>
3275
3276<table class="doc">
3277 <tbody>
3278 <tr valign="top">
3279 <th align="left" style="width: 8%">Method</th>
3280 <th align="left">Description</th>
3281 </tr>
3282
3283 <tr valign="top">
3284 <td valign="top">compare-any</td>
3285 <td valign="top">Crop the second and later frames to the smallest rectangle
3286 that contains all the differences between the two images. No GIF <a
3287 href="#dispose" >-dispose</a> methods are taken into account. </td>
3288 </tr>
3289
3290 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3291 >-deconstruct</a> operator, and does not preserve animations normal
3292 working, especially when animation used layer disposal methods such as
3293 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3294 </tr>
3295
3296 <tr valign="top">
3297 <td valign="top">compare-clear</td>
3298 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3299 opaque pixels which become transparent in the second frame. That is the
3300 smallest image needed to mask or erase pixels for the next frame. </td>
3301 </tr>
3302
3303 <tr valign="top">
3304 <td valign="top">compare-overlay</td>
3305 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3306 extra color to the next image, as a result of overlaying color pixels.
3307 That is the smallest single overlaid image to add or change colors. </td>
3308 </tr>
3309
3310 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3311 composition method '<kbd>change-mask</kbd>', to reduce the image to
3312 just the pixels that need to be overlaid. </td>
3313 </tr>
3314
3315 <tr valign="top">
3316 <td valign="top">coalesce</td>
3317 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3318 >-coalesce</a> operator. Apply the layer disposal methods set in the
3319 current image sequence to form a fully defined animation sequence, as
3320 it should be displayed. Effectively converting a GIF animation into a
3321 'film strip'-like animation. </td>
3322 </tr>
3323
3324 <tr valign="top">
3325 <td valign="top">composite</td>
3326 <td valign="top">Alpha Composition of two image lists, separated by a
3327 "<kbd>null:</kbd>" image, with the destination image list first, and
3328 the source images last. An image from each list are composited
3329 together until one list is finished. The separator image and source
3330 image lists are removed. </td>
3331 </tr>
3332
3333
cristybac7a162010-06-15 19:57:29 +00003334 <tr><td></td>
3335 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3336 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3337 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003338 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003339 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003340
cristybac7a162010-06-15 19:57:29 +00003341 <tr><td></td>
3342 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003343 applied to all the images in the other image list, regardless of which
3344 list it is. In this case it is the image meta-data of the list which
3345 preserved. </td>
3346 </tr>
3347
3348
3349 <tr valign="top">
3350 <td valign="top">dispose</td>
3351 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3352 the animation after the layer disposal method has been applied, before
3353 the next sub-frame image is overlaid. That is the 'dispose' image that
3354 results from the application of the GIF <a href="#dispose"
3355 >-dispose</a> method. This allows you to check what
3356 is going wrong with a particular animation you may be developing.
3357 </td>
3358 </tr>
3359
3360 <tr valign="top">
3361 <td valign="top">flatten</td>
3362 <td valign="top">Create a canvas the size of the first images virtual
3363 canvas using the current <a href="#background" >-background</a> color,
3364 and <a href="#compose" >-compose</a> each image in turn onto that
3365 canvas. Images falling outside that canvas is clipped. Final
3366 image will have a zero virtual canvas offset. </td>
3367 </tr>
3368
cristybac7a162010-06-15 19:57:29 +00003369 <tr><td></td>
3370 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003371 overlaying all the prepared image layers into a final image. </td>
3372 </tr>
3373
cristybac7a162010-06-15 19:57:29 +00003374 <tr><td></td>
3375 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003376 canvas with real pixels, or to underlay a opaque color to remove
3377 transparency from an image.</td>
3378 </tr>
3379
3380
3381 <tr valign="top">
3382 <td valign="top">merge</td>
3383 <td valign="top">As 'flatten' method but merging all the given image
3384 layers into a new layer image just large enough to hold all the image
3385 without clipping or extra space. The new images virtual offset will
3386 prevere the position of the new layer, even if this offset is
3387 negative. the virtual canvas size of the first image is preserved.
3388 </td>
3389 </tr>
3390
3391 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3392 as few image file formats handle them correctly. </td>
3393 </tr>
3394
3395 <tr valign="top">
3396 <td valign="top">mosaic</td>
3397 <td valign="top">As 'flatten' method but expanding the initial canvas size
3398 of the first image so as to hold all the image layers. However as a
3399 virtual canvas is 'locked' to the origin, by defination, image layers
3400 with a negative offsets will still be clipped by the top and left
3401 edges.</td>
3402 </tr>
3403
3404 <tr><td></td><td>This method is commonly used to layout individual image using various
3405 offset but without knowning the final canvas size. The resulting image
3406 will, like 'flatten' not have any virtual offset, so can be saved to
3407 any image file format. </td>
3408 </tr>
3409
3410
3411 <tr valign="top">
3412 <td valign="top">optimize</td>
3413 <td valign="top">Optimize a coalesced animation, into GIF animation using
3414 a number of general techniques. This currently a short cut to
3415 apply both the '<kbd>optimize-frame</kbd>', and
3416 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3417 include other optimization methods as they are developed. </td>
3418 </tr>
3419
3420 <tr valign="top">
3421 <td valign="top">optimize-frame</td>
3422 <td valign="top">Optimize a coalesced animation, into GIF animation by
3423 reducing the number of pixels per frame as much as possible by
3424 attempting to pick the best layer disposal method to use, while ensuring
3425 the result will continue to animate properly. </td>
3426 </tr>
3427
3428 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3429 then no reasonably fast GIF optimization algorithm can do this.
3430 However this does seem to do better than most other GIF frame
3431 optimizers seen. </td>
3432 </tr>
3433
3434 <tr valign="top">
3435 <td valign="top">optimize-plus</td>
3436 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3437 overall optimization by adding extra frames to the animation, without
3438 changing the final look or timing of the animation. The frames are
3439 added to attempt to separate the clearing of pixels from the
3440 overlaying of new additional pixels from one animation frame to the
3441 next. If this does not improve the optimization (for the next frame
3442 only), it will fall back to the results of the previous normal
3443 '<kbd>optimize-frame</kbd>' technique. </td>
3444 </tr>
3445
3446 <tr><td></td><td>There is the possibility that the change in the disposal style will
3447 result in a worsening in the optimization of later frames, though this
3448 is unlikely. In other words there no guarantee that it is better than
3449 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
3450 however you can get a vast improvment in the final animation size. </td>
3451 </tr>
3452
3453 <tr valign="top">
3454 <td valign="top">optimize-transparency</td>
3455 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3456 overlay images with transparency, if it does not change the resulting
3457 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3458 </td>
3459 </tr>
3460
3461 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3462 into a smaller file size due to larger areas of one (transparent)
3463 color rather than a pattern of multiple colors repeating the current
3464 disposed image of the last frame. </td>
3465 </tr>
3466
3467 <tr valign="top">
3468 <td valign="top">remove-dups</td>
3469 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3470 images, so as to simplify layer overlays of coalesced animations.
3471 </td>
3472 </tr>
3473
3474 <tr><td></td><td>Usually this a result of using a constant time delay across the
3475 whole animation, or after a larger animation was split into smaller
3476 sub-animations. The duplicate frames could also have been used as
3477 part of some frame optimization methods. </td>
3478 </tr>
3479
3480 <tr valign="top">
3481 <td valign="top">remove-zero</td>
3482 <td valign="top">Remove any image with a zero time delay, unless ALL the
3483 images have a zero time delay (and is not a proper timed animation, a
3484 warning is then issued). </td>
3485 </tr>
3486
3487 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3488 partial intermediary updates between the frames that are actually
3489 displayed to users. These frames are usally added for improved frame
3490 optimization in GIF animations. </td>
3491 </tr>
3492
3493 <tr valign="top">
3494 <td valign="top">trim-bounds</td>
3495 <td valign="top">Find the bounds of all the images in the current
3496 image sequence, then adjust the offsets so all images are contained on
3497 a minimal positive canvas. None of the image data is modified, only
3498 there virtual canvas size and offset. The all the image is given
3499 the same canvas size, and and will have a positive offset, but will
3500 remain in the same position relative to each other. As a result of the
3501 minimal canvas size at least one image will touch every edge of that
3502 canvas. The image data however may be transparent.
3503 </td>
3504 </tr>
3505
3506 </tbody>
3507</table>
3508
3509<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3510
3511<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3512>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3513>-mosaic</a> are only aliases for the above methods. Also see <a
3514href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3515href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3516>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3517
3518
3519<div style="margin: auto;">
3520 <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>
3521</div>
3522
3523<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>
3524
3525<p>Given one, two or three values delimited with commas: black-point,
3526white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3527white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3528point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3529contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3530both black and white points are percentages of the full color range. Gamma
3531will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3532omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3533
3534<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3535the given '<kbd>black_point</kbd>' value in the original image is set to
3536zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3537<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3538to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3539adjusted. </p>
3540
3541<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3542adding the special '!' flag anywhere in the argument list, will cause the
3543operator to do the reverse of the level adjustment. That is a zero, or
3544<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
3545adjusted to the given level values, allowing you to de-contrast, or compress
3546the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
3547
3548<p>Only the channels defined by the current <a href="#channel">-channel</a>
3549setting are adjusted (defaults to RGB color channels only), allowing you to
3550limit the effect of this operator. </p>
3551
3552<p>Please note that the transparency channel is treated as 'matte'
3553values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
3554
3555
3556<div style="margin: auto;">
3557 <h4><a name="level-colors" id="level-colors"></a>-level-colors {<em
3558 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
3559</div>
3560
3561<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>
3562
3563<p>This function is exactly like <a href="#level">-level</a>, except that the
3564value value for each color channel is determined by the
3565'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
3566described under the <a href="#fill">-fill</a> option). </p>
3567
3568<p>This effectivally means the colors provided to <kbd>-level-colors</kbd>
3569is mapped to become 'black' and 'white' respectivally, with all the other
3570colors linearly adjusted (or clipped) to match that change. Each channel is
3571adjusted separatally using the channel values of the colors specified. </p>
3572
3573<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
3574will map the image color 'black' and 'white' to the given colors
3575respectivally, resulting in a gradient (de-contrasting) tint of the image to
3576those colors. This can also be used to convert a plain gray-scale image into a
3577one using the gradient of colors specified. </p>
3578
3579<p>By supplying a single color with a comma separator either before or after
3580that color, will just replace the respective 'black' or 'white' point
3581respectivally. But if no comma separator is provided, the given color is
3582used for both the black and white color points, making the operator either
3583threshold the images around that color (- form) or set all colors to that
3584color (+ form). </p>
3585
3586
3587<div style="margin: auto;">
3588 <h4><a name="limit" id="limit"></a>-limit <em class="arg">type value</em></h4>
3589</div>
3590
3591<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>
3592
3593<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>
3594
cristy6b636652009-12-05 17:16:11 +00003595<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 +00003596
3597<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00003598 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00003599</p>
3600
3601<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
3602
cristy6b636652009-12-05 17:16:11 +00003603<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
3604------------------------------------------------------------------------------
3605 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited</pre>
cristy3ed852e2009-09-05 21:47:34 +00003606</span></p>
3607<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>
3608
3609<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>
3610
3611<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>
3612
3613<p class="crtsnip">
3614-limit area 10mb
3615</p>
3616
3617<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>
3618
3619<p class="crtsnip">
3620-limit area 10mb -limit disk 500mb
3621</p>
3622
3623<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
3624
3625<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>
3626
3627<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.
3628</p>
3629
3630<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.
3631</p>
3632
3633<div style="margin: auto;">
3634 <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>
3635</div>
3636
3637<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>
3638
cristyd934d102009-10-10 12:55:13 +00003639<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
3640and uses a 'histogram bin' to determine the range of color values that needs to
3641be stretched. However it then stretchs those colors using the <a
3642href="#level" >-level</a> operator.</p>
3643
3644<p>As such while the initial determination may have 'binning' round off
3645effects, the image colors are stretched mathematically, rather than using the
3646histogram bins. This makes the operator more accurate. </p>
3647
3648<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
3649'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
3650perfect stretch of the color range. </p>
3651
3652<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
3653normalization of mathematical images. </p>
3654
3655<p>This operator is under review for re-development. </p>
3656
3657
cristy3ed852e2009-09-05 21:47:34 +00003658<div style="margin: auto;">
3659 <h4><a name="linewidth" id="linewidth"></a>-linewidth</h4>
3660</div>
3661
3662<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>
3663
3664<div style="margin: auto;">
3665 <h4><a name="liquid-rescale" id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
3666</div>
3667
3668<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>
3669
3670<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>
3671
3672<div style="margin: auto;">
3673 <h4><a name="list" id="list"></a>-list <em class="arg">type</em></h4>
3674</div>
3675
3676<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>
3677
3678<pre class="text">
cristyc1aee832010-05-08 00:36:47 +00003679 Align
3680 Alpha
3681 Boolean
3682 Channel
3683 Class
3684 ClipPath
3685 Coder
3686 Color
3687 Colorspace
3688 Command
3689 Compose
3690 Compress
3691 Configure
3692 DataType
3693 Debug
3694 Decoration
3695 Delegate
3696 Direction
3697 Dispose
3698 Distort
3699 Dither
3700 Endian
3701 Evaluate
3702 FillRule
3703 Filter
3704 Font
3705 Format
3706 Function
3707 Gravity
3708 ImageList
3709 Intent
3710 Interlace
3711 Interpolate
3712 Kernel
cristy787d4352010-03-06 13:55:58 +00003713 Layers
3714 LineCap
3715 LineJoin
3716 List
3717 Locale
3718 LogEvent
3719 Log
3720 Magic
3721 Method
3722 Metric
3723 Mime
3724 Mode
3725 Morphology
3726 Module
3727 Noise
3728 Orientation
3729 Policy
3730 PolicyDomain
3731 PolicyRights
3732 Preview
3733 Primitive
3734 QuantumFormat
3735 Resource
3736 SparseColor
3737 Storage
3738 Stretch
3739 Style
3740 Threshold
3741 Type
3742 Units
3743 Validate
3744 VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00003745</pre>
3746
cristybac7a162010-06-15 19:57:29 +00003747<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
3748list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
3749available:</p>
cristy3ed852e2009-09-05 21:47:34 +00003750
3751<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
3752<div style="margin: auto;">
3753 <h4><a name="log" id="log"></a>-log <em class="arg">string</em></h4>
3754</div>
3755
3756<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>
3757
cristybac7a162010-06-15 19:57:29 +00003758<p>This option specifies the format for the log printed when the <a
3759href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00003760
cristybac7a162010-06-15 19:57:29 +00003761<p>You can display the following components by embedding special format
3762characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00003763
3764<pre class="text">
3765 %d domain
3766 %e event
3767 %f function
3768 %l line
3769 %m module
3770 %p process ID
3771 %r real CPU time
3772 %t wall clock time
3773 %u user CPU time
3774 %% percent sign
3775 \n newline
3776 \r carriage return
3777</pre>
3778
3779<p>For example:</p>
3780
3781<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>
3782<p>The default behavior is to print all of the components.</p>
3783
3784<div style="margin: auto;">
3785 <h4><a name="loop" id="loop"></a>-loop <em class="arg">iterations</em></h4>
3786</div>
3787
3788<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>
3789
cristybac7a162010-06-15 19:57:29 +00003790<p>Set iterations to zero to repeat the animation an infinite number of times,
3791otherwise the animation repeats itself up to <em class="arg">iterations</em>
3792times.</p>
cristy3ed852e2009-09-05 21:47:34 +00003793
3794<div style="margin: auto;">
3795 <h4><a name="lowlight-color" id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
3796</div>
3797
3798<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>
3799
3800<div style="margin: auto;">
3801 <h4><a name="magnify" id="magnify"></a>-magnify <em class="arg">factor</em></h4>
3802</div>
3803
3804<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>
3805
3806
3807<div style="margin: auto;">
3808 <h4><a name="map" id="map"></a>-map <em class="arg">type</em></h4>
3809</div>
3810
3811<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>
3812
3813<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
3814
3815<pre class="text">
3816 best
3817 default
3818 gray
3819 red
3820 green
3821 blue
3822</pre>
3823
cristybac7a162010-06-15 19:57:29 +00003824<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
3825Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
3826the type and <kbd>display</kbd> searches the list of colormap types in
3827<kbd>top-to-bottom</kbd> order until one is located. See <em
3828class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00003829
3830
3831<div style="margin: auto;">
3832 <h4><a name="map_stream_" id="map_stream_"></a>-map <em class="arg">components</em></h4>
3833</div>
3834
3835<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>
3836
3837<p>Here are the valid components of a map:</p>
3838
3839<pre class="text">
3840 r red pixel component
3841 g green pixel component
3842 b blue pixel component
3843 a alpha pixel component (0 is transparent)
3844 o opacity pixel component (0 is opaque)
3845 i grayscale intensity pixel component
3846 c cyan pixel component
3847 m magenta pixel component
3848 y yellow pixel component
3849 k black pixel component
3850 p pad component (always 0)
3851</pre>
3852
cristybac7a162010-06-15 19:57:29 +00003853<p>You can specify as many of these components as needed in any order (e.g.
3854bgr). The components can repeat as well (e.g. rgbr).</p>
3855
cristy3ed852e2009-09-05 21:47:34 +00003856
3857<div style="margin: auto;">
3858 <h4><a name="mask" id="mask"></a>-mask
3859<em class="arg">filename</em></h4>
3860</div>
3861
3862<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>
3863
3864<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
3865
3866<div style="margin: auto;">
3867 <h4><a name="mattecolor" id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
3868</div>
3869
3870<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>
3871
3872<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3873
cristybac7a162010-06-15 19:57:29 +00003874<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
3875style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00003876
3877<div style="margin: auto;">
cristyd2baf7d2010-03-06 04:26:44 +00003878 <h4><a name="maximum" id="maximum"></a>-maximum</h4>
3879</div>
3880
3881<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>
3882
3883<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00003884 <h4><a name="median" id="median"></a>-median <em class="arg">radius</em></h4>
3885</div>
3886
3887<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>
3888
3889<div style="margin: auto;">
3890 <h4><a name="metric" id="metric"></a>-metric <em class="arg">type</em></h4>
3891</div>
3892
3893<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>
3894
3895<p>Choose from:</p>
3896
3897<pre class="text">
cristybac7a162010-06-15 19:57:29 +00003898 AE absolute error count, number of different pixels (-fuzz effected)
3899 MAE mean absolute error (normalized), average channel error distance
3900 MEPP mean error per pixel (normalized mean error, normalized peak error)
3901 MSE mean error squared, average of the channel error squared
3902 PAE peak absolute (normalize peak absolute)
3903 PSNR peak signal to noise ratio
3904 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00003905</pre>
3906
3907<p>The '<kbd>AE</kbd>' or absolute count of pixels that are different, can be
3908controled using a <a href="#fuzz" >-fuzz</a> factor to ignore pixels which
3909only changed by a small amount. The '<kbd>PAE</kbd>' can be used to find the
3910size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristybac7a162010-06-15 19:57:29 +00003911'similar', while '<kbd>MAE</kbd>' can be used to find out the factor needed
3912for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00003913
3914<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
3915('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristybac7a162010-06-15 19:57:29 +00003916normalized) from a single comparision run. </p>
cristy3ed852e2009-09-05 21:47:34 +00003917
cristybac7a162010-06-15 19:57:29 +00003918<p>To print a complete list of metrics, use the <a href="#list">-list
3919metrics</a> option.</p>
3920
cristy3ed852e2009-09-05 21:47:34 +00003921
cristyd2baf7d2010-03-06 04:26:44 +00003922<div style="margin: auto;">
3923 <h4><a name="minimum" id="minimum"></a>-minimum</h4>
3924</div>
3925
3926<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>
3927
cristy3ed852e2009-09-05 21:47:34 +00003928
3929<div style="margin: auto;">
3930 <h4><a name="mode" id="mode"></a>-mode <em class="arg">value</em></h4>
3931</div>
3932
3933<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>
3934
cristybac7a162010-06-15 19:57:29 +00003935<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
3936Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00003937
cristybac7a162010-06-15 19:57:29 +00003938<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
3939for a list of <a href="#mode" >-mode</a> arguments available in your
3940ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00003941
3942
3943<div style="margin: auto;">
3944 <h4><a name="modulate" id="modulate"></a>-modulate <em class="arg">brightness</em>[,<em class="arg">saturation</em>,<em class="arg">hue</em>]</h4>
3945</div>
3946
cristybac7a162010-06-15 19:57:29 +00003947<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
3948class="arg">saturation</em>, and <em class="arg">hue</em> of an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00003949
cristyb36feb22010-03-26 16:54:37 +00003950<p>The arguments are given as a percentages of variation. A value of 100 means
3951no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00003952
cristyb36feb22010-03-26 16:54:37 +00003953<p>The <em class="arg">brightness</em> is a multiplier of the overall
3954brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
3955twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
3956before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00003957
cristyb36feb22010-03-26 16:54:37 +00003958<p>The <em class="arg">saturation</em> controls the amount of color in an
3959image. For example, 0 produce a grayscale image, while a large value such as
3960200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00003961
cristyb36feb22010-03-26 16:54:37 +00003962<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
3963within the image by the amount specified. For example, 50 results in
3964a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
3965A value of either 0 or 200 results in a complete 180 degree rotation of the
3966image. Using a value of 300 is a 360 degree rotation resulting in no change to
3967the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003968
cristyb36feb22010-03-26 16:54:37 +00003969<p>For example, to increase the color brightness by 20% and decrease the color
3970saturation by 10% and leave the hue unchanged, use <a
3971href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00003972
cristyb36feb22010-03-26 16:54:37 +00003973<p>Use <a href="#set">-set</a> attribute of '<kbd
3974class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
3975modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
3976<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00003977
3978<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 +00003979
cristy3ed852e2009-09-05 21:47:34 +00003980<div style="margin: auto;">
3981 <h4><a name="monitor" id="monitor"></a>-monitor</h4>
3982</div>
3983
3984<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>
3985
3986
3987<div style="margin: auto;">
3988 <h4><a name="monochrome" id="monochrome"></a>-monochrome</h4>
3989</div>
3990
3991<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>
3992
3993
3994<div style="margin: auto;">
3995 <h4><a name="morph" id="morph"></a>-morph <em class="arg">frames</em></h4>
3996</div>
3997
3998<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>
3999
4000<p>Both the image pixels and size are linearly interpolated to give the
4001appearance of a meta-morphosis from one image to the next, over all the images
4002in the current image list. The added images are the equivalent of a <a
4003href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4004argument determine how many images to interpolate between each image. </p>
4005
4006
4007<div style="margin: auto;">
cristy488844c2010-01-22 14:02:05 +00004008 <h4><a name="morphology" id="morphology"></a>-morphology</h4>
4009 <h4><a name="morphology" id="morphology"></a>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
4010</div>
4011
cristy2c839602010-04-03 02:32:08 +00004012<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 +00004013
cristy83a272e2010-05-07 20:40:35 +00004014Until I get around to writing a option summary for this, see <A
4015HREF="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4016Morphology</A>. </P>
4017
4018
cristy488844c2010-01-22 14:02:05 +00004019<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004020 <h4><a name="mosaic" id="mosaic"></a>-mosaic</h4>
4021</div>
4022
4023<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>
4024
4025
4026<div style="margin: auto;">
4027 <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>
4028</div>
4029
4030<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>
4031
4032<p>Blur with the given radius, standard deviation (sigma), and angle. The
4033angle given is the angle toward which the image is blurred. That is the
4034direction people would consider the object is coming from. </p>
4035
4036<p>Note that the blur is not uniform distribution, giving the motion a
4037definate sense of direction of movement. </p>
4038
4039<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4040pixels which are outside the image proper are blurred into the final result.
4041</p>
4042
4043<div style="margin: auto;">
4044 <h4><a name="name" id="name"></a>-name</h4>
4045</div>
4046
4047<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>
4048<div style="margin: auto;">
4049 <h4><a name="negate" id="negate"></a>-negate</h4>
4050</div>
4051
cristyb29bc032010-02-01 20:29:43 +00004052<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 +00004053
4054<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>
4055
4056<div style="margin: auto;">
4057 <h4><a name="noise" id="noise"></a>-noise <em class="arg">radius</em><br/>
4058 +noise <em class="arg">type</em></h4>
4059</div>
4060
4061<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>
4062
4063<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>
4064
4065<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>
4066
4067<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>
4068
4069<pre class="text">
4070Gaussian
4071Impulse
4072Laplacian
4073Multiplicative
4074Poisson
4075Random
4076Uniform
4077</pre>
4078
4079<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4080
cristy83543962009-10-16 19:04:28 +00004081<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4082the use of a controlling value to specify teh amount of noise that should be
4083added to an image. </p>
4084
cristy3ed852e2009-09-05 21:47:34 +00004085
4086<div style="margin: auto;">
4087 <h4><a name="normalize" id="normalize"></a>-normalize</h4>
4088</div>
4089
4090<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>
4091
cristyd934d102009-10-10 12:55:13 +00004092<p>The intensity values are stretched to cover the entire range of possible
4093values. While doing so, black-out at most <em>2%</em> of the pixels and
4094white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004095
cristyd934d102009-10-10 12:55:13 +00004096<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4097is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4098(Before this version, it was equivalent to <a href="#contrast-stretch"
4099>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004100
cristyd934d102009-10-10 12:55:13 +00004101<p>All the channels are normalized in concert by the came amount so as to
4102preserve color integrity, when the default <a href="#channel" >+channel</a>
4103setting is in use. Specifing any other <a href="#channel" >-channel</a>
4104setting will normalize the RGB channels independently.</p>
4105
4106<p>See <a href="#contrast-stretch" >-contrast-stretch</A> for more details.
4107Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004108that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004109
4110<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004111
4112
4113<div style="margin: auto;">
4114 <h4><a name="ordered-dither" id="ordered-dither"></a>-ordered-dither <em class="arg">threshold_map</em>{,<em class="arg">level</em>...}</h4>
4115</div>
4116
cristyd934d102009-10-10 12:55:13 +00004117<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
4118class="arg">threshold map</em> specified, and a uniform color map with the
4119given 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 +00004120
4121<p>You can choose from these standard threshold maps:</p>
4122
4123<pre class="text">
cristyd934d102009-10-10 12:55:13 +00004124 threshold
cristy3ed852e2009-09-05 21:47:34 +00004125 checks
4126 o2x2
4127 o3x3
4128 o4x4
4129 o8x8
4130 h4x4a
4131 h6x6a
4132 h8x8a
4133 h4x4o
4134 h6x6o
4135 h8x8o
4136 h16x16o
4137</pre>
4138
cristyd934d102009-10-10 12:55:13 +00004139<p>The '<kbd>o</kbd>' maps are ordered diffused pixel threshold maps, while the
4140'<kbd>h</kbd>' maps are halftone threshold maps which are either 'a' angled, or
4141'o' orthogonal. The '<kbd>checks</kbd>' produce a 3 level checkerbord dither
4142pattern. Or you can define your own <em class="arg" >threshold map</em> in a
4143personal or system "<kbd>thresholds.xml</kbd>" XML file. </p>
cristy3ed852e2009-09-05 21:47:34 +00004144
cristyd934d102009-10-10 12:55:13 +00004145<p>To print a complete list of threshold, use the <a href="#list" >-list
4146threshold</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004147
cristyd934d102009-10-10 12:55:13 +00004148<p>It is recommended that the <a href="#map" >+map</a> operator be used after
4149applying <a href="#ordered-dither" >-ordered-dither</a> to reduce the number of
cristy3ed852e2009-09-05 21:47:34 +00004150colors an animated image sequence, to less that 256 colors. This ensures that
4151a common or global color table is used when saving the result to a color
4152limited file format such as GIF. </p>
4153
cristyd934d102009-10-10 12:55:13 +00004154<p>Note that at this time the exact same threshold dithering map is used for
4155all color channels, no attempt is made to offset or rotate the map for
4156different channels is made, to create an offset printing effect. (possible
4157future expansion) </p>
cristy3ed852e2009-09-05 21:47:34 +00004158
4159
4160<div style="margin: auto;">
4161 <h4><a name="opaque" id="opaque"></a>-opaque <em class="arg">color</em></h4>
4162</div>
4163
4164<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>
4165
cristyc54f5d42009-11-27 21:36:31 +00004166<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004167described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4168>-fuzz</a> setting can be used to match and replace colors similar to the one
4169given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004170
cristyb36feb22010-03-26 16:54:37 +00004171<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4172the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004173
cristyb36feb22010-03-26 16:54:37 +00004174<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4175as <a href="#opaque" >-opaque</a> but replaces the matching color with
4176transparency rather than the current <a href="#fill">-fill</a> color setting.
4177To ensure that it can do this it also ensures that the image has an alpha
4178channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4179the new transparent colors, and does not require you to modify the <a
4180href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004181
cristy3ed852e2009-09-05 21:47:34 +00004182
4183<div style="margin: auto;">
4184 <h4><a name="orient" id="orient"></a>-orient <em class="arg">image orientation</em></h4>
4185</div>
4186
4187<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>
4188
4189<p>Choose from these orientations:</p>
4190
4191<pre class="text">
4192 bottom-left
4193 bottom-right
4194 left-bottom
4195 left-top
4196 right-bottom
4197 right-top
4198 top-left
4199 top-right
4200 undefined
4201</pre>
4202
cristyd934d102009-10-10 12:55:13 +00004203<p>To print a complete list of orientations, use the <a href="#list" >-list
4204orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004205
4206
4207<div style="margin: auto;">
4208 <h4><a name="page" id="page"></a>-page <em class="arg">geometry</em><br/>
4209 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4210 +page
4211 </h4>
4212</div>
4213
4214<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>
4215
4216<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>
4217
4218<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>
4219
4220<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>
4221<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4222<thead>
4223 <tr valign="top">
4224 <th align="center"><em class="arg">media</em></th>
4225 <th align="center"><em class="arg">width</em></th>
4226 <th align="center"><em class="arg">height</em></th>
4227 </tr>
4228</thead>
4229<tbody>
4230<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4231<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4232<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4233<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4234<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4235<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4236<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4237<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4238<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4239<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4240<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4241<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4242<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4243<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4244<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4245<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4246<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4247<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4248<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4249<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4250<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4251<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4252<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4253<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4254<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4255<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4256<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4257<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4258<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4259<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4260<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4261<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4262<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4263<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4264<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4265<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4266<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4267<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4268</tbody>
4269</table>
4270
4271
4272
4273
4274<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>
4275
4276<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>
4277
4278<p>The default page dimensions for a TEXT image is 612x792.</p>
4279
4280<p>This option is used in concert with <a href="#density">-density</a>.</p>
4281
4282<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4283
4284<div style="margin: auto;">
4285 <h4><a name="paint" id="paint"></a>-paint <em class="arg">radius</em></h4>
4286</div>
4287
4288<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>
4289
4290<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>
4291
4292<div style="margin: auto;">
4293 <h4><a name="path" id="path"></a>-path <em class="arg">path</em></h4></div>
4294
4295<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>
4296
4297<div style="margin: auto;">
4298 <h4><a name="pause_animate_" id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
4299</div>
4300
4301<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>
4302
4303<p>Pause for the specified number of seconds before repeating the animation.</p>
4304
4305<div style="margin: auto;">
4306 <h4><a name="pause_import_" id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
4307</div>
4308
4309<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>
4310
4311<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4312
4313<div style="margin: auto;">
4314 <h4><a name="ping" id="ping"></a>-ping</h4>
4315</div>
4316
4317<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>
4318
4319<div style="margin: auto;">
4320 <h4><a name="pointsize" id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
4321</div>
4322
4323<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>
4324
4325<div style="margin: auto;">
4326 <h4><a name="polaroid" id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
4327</div>
4328
4329<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>
4330
4331<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4332
4333<div style="margin: auto;">
4334 <h4><a name="posterize" id="posterize"></a>-posterize <em class="arg">levels</em></h4>
4335</div>
4336
4337<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>
4338
4339<div style="margin: auto;">
cristyd43a46b2010-01-21 02:13:41 +00004340 <h4><a name="precision" id="precision"></a>-precision <em class="arg">value</em></h4>
4341</div>
4342
4343<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>
4344
4345<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004346 <h4><a name="preview" id="preview"></a>-preview <em class="arg">type</em></h4>
4347</div>
4348
4349<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>
4350
4351<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>
4352
4353<pre class="text">
4354 Rotate
4355 Shear
4356 Roll
4357 Hue
4358 Saturation
4359 Brightness
4360 Gamma
4361 Spiff
4362 Dull
4363 Grayscale
4364 Quantize
4365 Despeckle
4366 ReduceNoise
4367 Add Noise
4368 Sharpen
4369 Blur
4370 Threshold
4371 EdgeDetect
4372 Spread
4373 Shade
4374 Raise
4375 Segment
4376 Solarize
4377 Swirl
4378 Implode
4379 Wave
4380 OilPaint
4381 CharcoalDrawing
4382 JPEG
4383</pre>
4384
4385<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4386
4387<p>The default preview is <kbd>JPEG</kbd>.</p>
4388
4389<div style="margin: auto;">
4390 <h4><a name="print" id="print"></a>-print <em class="arg">string</em></h4>
4391</div>
4392
4393<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>
4394
4395<div style="margin: auto;">
4396 <h4><a name="process" id="process"></a>-process <em class="arg">command</em></h4>
4397</div>
4398
4399<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>
4400
4401<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>
4402
4403<div style="margin: auto;">
4404 <h4><a name="profile" id="profile"></a>-profile <em class="arg">filename</em><br/>
4405 +profile <em class="arg">profile_name</em></h4>
4406</div>
4407
4408<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>
4409
4410<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>
4411
4412<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>
4413
4414<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>
4415
4416<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>
4417
4418<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4419
4420<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4421<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>
4422
4423<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>
4424<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4425CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4426</p>
4427
4428<div style="margin: auto;">
4429 <h4><a name="quality" id="quality"></a>-quality <em class="arg">value</em></h4>
4430</div>
4431
4432<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>
4433
cristy851dbce2010-08-06 21:40:00 +00004434<p>For the JPEG and MPEG image formats, quality is 1 (lowest image quality and highest compression) to 100 (best quality but least effective compression). The default is to use the estimate quality of your input image otherwise 92. Use the <a href="#sampling-factor">-sampling-factor</a> option to specify the factors for chroma downsampling.</p>
cristy3ed852e2009-09-05 21:47:34 +00004435
4436<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>
4437
cristy851dbce2010-08-06 21:40:00 +00004438<p>For the JPEG-2000 image format, quality is mapped using a non-linear equation to the compression ratio required by the Jasper library. This non-linear equation is intended to loosely approximate the quality provided by the JPEG v1 format. The default quality value 100, a request for non-lossy compression. A quality of 75 results in a request for 16:1 compression.</p>
cristy3ed852e2009-09-05 21:47:34 +00004439
cristy3c98a4f2010-08-13 20:09:41 +00004440<p>For the MNG and PNG image formats, the quality value sets the zlib compression level (quality / 10) and filter-type (quality % 10). For compression level 0, the Huffman-only strategy is used, which is fastest but not necessarily the worst compression. The default PNG compression is 75.</p>
cristy3ed852e2009-09-05 21:47:34 +00004441
4442<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4443
4444<pre class="text">
4445 0: none
4446 1: sub
4447 2: up
4448 3: average
4449 4: Paeth
4450</pre>
4451
4452<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>
4453
4454<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4455
4456<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>
4457
cristy3c98a4f2010-08-13 20:09:41 +00004458<p>The quality setting has no effect on the appearance of PNG and MNG images, since the compression is always lossless.</p>
cristy3ed852e2009-09-05 21:47:34 +00004459
4460<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4461
cristy3ed852e2009-09-05 21:47:34 +00004462<div style="margin: auto;">
4463 <h4><a name="quantize" id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
4464</div>
4465
cristy3c98a4f2010-08-13 20:09:41 +00004466<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>reduce colors using this colorspace.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00004467
cristy3c98a4f2010-08-13 20:09:41 +00004468<p>This setting defines the colorspace used to sort out and reduce the number
4469of colors needed by an image (for later dithering) by operators such as <a
4470href="#colors" >-colors</a>, Note that color reducion also happens
4471automatically when saving images to color-limited image file formats, such as
4472GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004473
4474
4475<div style="margin: auto;">
4476 <h4><a name="quiet" id="quiet"></a>-quiet</h4>
4477</div>
4478
4479<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>
4480
4481<div style="margin: auto;">
4482 <h4><a name="radial-blur" id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
4483</div>
4484
4485<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>
4486
4487<p>Note that this is actually a rotational blur rather than a radial and as
4488such actually mis-named. </p>
4489
4490<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4491pixels which are outside the image proper are blurred into the final result.
4492</p>
4493
4494
4495<div style="margin: auto;">
4496 <h4><a name="raise" id="raise"></a>-raise <em class="arg">thickness</em></h4>
4497</div>
4498
4499<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>
4500
4501<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>.
4502</p>
4503
4504<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4505
4506<div style="margin: auto;">
4507 <h4><a name="random-threshold" id="random-threshold"></a>-random-threshold <em class="arg">low</em>x<em class="arg">high</em></h4>
4508</div>
4509
4510<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>
4511
4512<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004513 <h4><a name="red-primary" id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
4514</div>
4515
4516<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>
4517
4518<div style="margin: auto;">
4519 <h4><a name="regard-warnings" id="regard-warnings"></a>-regard-warnings</h4>
4520</div>
4521
4522<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>
4523
4524<div style="margin: auto;">
4525 <h4><a name="remap" id="remap"></a>-remap <em class="arg">filename</em></h4>
4526</div>
4527
4528<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>
4529
4530<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4531the given colors are dithered over the image as necessary, otherwise the closest
4532color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4533
4534<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4535images in the current image sequence, all the images will have the same color
4536table. That means that when saved to a file format such as GIF, it will use
4537that color table as a single common or global color table, for all the images,
4538without requiring extra local color tables. </p>
4539
4540<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4541sequence to use a common color map over all the images. This equivalent to
4542appending all the images together (without extra background colors) and color
4543reducing those images using <a href="#colors">-colors</a> with a 256 color
4544limit, then <a href="#remap">-remap</a> those colors over the original list of
4545images. This ensures all the images follow a single color map. </p>
4546
4547<p>If the number of colors over all the images is less than 256, then <a
4548href="#remap">+remap</a> should not perform any color reduction or dithering, as
4549no color changes are needed. In that case, its only effect is to force the use
4550of a global color table. This recommended after using either <a
4551href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
4552reduce the number of colors in an animated image sequence. </p>
4553
4554<div style="margin: auto;">
4555 <h4><a name="region" id="region"></a>-region <em class="arg">geometry</em></h4>
4556</div>
4557
4558<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>
4559
4560<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>
4561
4562<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>
4563
4564<div style="margin: auto;">
4565 <h4><a name="remote" id="remote"></a>-remote</h4>
4566</div>
4567
4568<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>
4569
4570<p>The only command recognized is the name of an image file to load.</p>
4571
4572<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>
4573
4574<div style="margin: auto;">
4575 <h4><a name="render" id="render"></a>-render</h4>
4576</div>
4577
4578<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>
4579
4580<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>
4581
4582<div style="margin: auto;">
4583<h4><a name="repage" id="repage"></a>-repage <em class="arg">geometry</em></h4>
4584</div>
4585
4586<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>
4587
4588<p>This option is like <a href="#page">-page</a> but acts as an image operator
4589rather than a setting. You can separately set the canvas size or the offset
4590of the image on that canvas by only providing those components. </p>
4591
4592<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>
4593
4594<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
4595offset to move the image relative to its previous position. This useful for
4596animation sequences. </p>
4597
4598<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
4599recalculate the canvas size so the image (at its current offset) will appear
4600completely on that canvas (unless it has a negative offset).</p>
4601
4602<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
4603canvas meta-data from the images. </p>
4604
4605<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
4606directly assign virtual canvas meta-data. </p>
4607
4608
4609<div style="margin: auto;">
4610 <h4><a name="resample" id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
4611</div>
4612
4613<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>
4614
4615<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>
4616
4617<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>
4618
4619<div style="margin: auto;">
4620 <h4><a name="resize" id="resize"></a>-resize <em class="arg">geometry</em></h4>
4621</div>
4622
4623<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>
4624
4625<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>
4626
4627<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>
4628
cristy13538962010-02-26 17:53:04 +00004629<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>
4630
cristy4949d522010-03-12 18:41:34 +00004631<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 +00004632<div style="margin: auto;">
4633 <h4><a name="respect-parentheses" id="respect-parentheses"></a>-respect-parentheses</h4>
4634</div>
4635
4636<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>
4637
4638<div style="margin: auto;">
4639 <h4><a name="reverse" id="reverse"></a>-reverse</h4>
4640</div>
4641
4642<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>
4643
4644
4645<div style="margin: auto;">
4646 <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>
4647</div>
4648
4649<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>
4650
4651<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>
4652
4653
4654<div style="margin: auto;">
4655 <h4><a name="rotate" id="rotate"></a>-rotate <em class="arg">degrees</em>{<em class="arg">&lt;</em>}{<em class="arg">&gt;</em>}</h4>
4656</div>
4657
4658<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>
4659
4660<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>
4661
4662<p>Empty triangles in the corners, left over from rotating the image, are
4663filled with the <kbd>background</kbd> color. </p>
4664
4665<p>See also the <a href="#distort">-distort</a> operator and specifically the
4666'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
4667
4668
4669<div style="margin: auto;">
4670 <h4><a name="sample" id="sample"></a>-sample <em class="arg">geometry</em></h4>
4671</div>
4672
4673<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>
4674
4675<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>
4676
4677<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>
4678
4679
4680<div style="margin: auto;">
4681 <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>
4682</div>
4683
4684<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>
4685
4686<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>
4687
4688<div style="margin: auto;">
4689 <h4><a name="scale" id="scale"></a>-scale <em class="arg">geometry</em></h4>
4690</div>
4691
4692<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>
4693
4694<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>
4695
4696<div style="margin: auto;">
4697 <h4><a name="scene" id="scene"></a>-scene <em class="arg">value</em></h4>
4698</div>
4699
4700<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>
4701
4702<p>This option sets the scene number of an image or the first image in an image sequence.</p>
4703
4704<div style="margin: auto;">
4705 <h4><a name="screen" id="screen"></a>-screen</h4>
4706</div>
4707
4708<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>
4709
4710<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>
4711
4712<div style="margin: auto;">
4713 <h4><a name="seed" id="seed"></a>-seed</h4>
4714</div>
4715
4716<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>
4717
4718<div style="margin: auto;">
4719 <h4><a name="segment" id="segment"></a>-segment <em class="arg">cluster-threshold</em>x<em class="arg">smoothing-threshold</em></h4>
4720</div>
4721
4722<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>
4723
4724<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>
4725
4726<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>
4727
4728<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
4729of the color clusters is returned.</p>
4730
4731
4732<div style="margin: auto;">
4733 <h4><a name="selective-blur" id="selective-blur"></a>-selective-blur <em class="arg">geometry</em></h4>
4734</div>
4735
4736<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>
4737
4738<div style="margin: auto;">
4739 <h4><a name="separate" id="separate"></a>-separate</h4>
4740</div>
4741
4742<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>
4743
4744<div style="margin: auto;">
4745 <h4><a name="sepia-tone" id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
4746</div>
4747
4748<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>
4749
4750<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
4751
4752<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>
4753
4754<div style="margin: auto;">
4755 <h4><a name="set" id="set"></a>-set <em class="arg">attribute value</em></h4>
4756</div>
4757
4758<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>
4759
4760<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>
4761
cristy4949d522010-03-12 18:41:34 +00004762<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 +00004763<p>The <a href="#repage">-repage</a> operator will also set the
4764'<kbd>page</kbd>' attribute of images already in memory, but allows you to
4765separately set the virtual canvas's size and offset components, and also allows
4766relative offset changes, and automatic canvas size re-calculating. The above
4767<a href="#set">-set</a> option is purely a direct, unmodified assignment of the
4768virtual canvas (page) meta-data. </p>
4769
cristy0391e8d2010-04-10 01:36:10 +00004770<p>Use this option to associate a colorspace or profile with your image. For example,</p>
4771<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 +00004772<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>
4773
4774<div style="margin: auto;">
4775 <h4><a name="shade" id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
4776</div>
4777
4778<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>
4779
4780<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>
4781
4782<div style="margin: auto;">
4783 <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>
4784</div>
4785
4786<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>
4787
4788<div style="margin: auto;">
4789 <h4><a name="shared-memory"
4790id="shared-memory"></a>-shared-memory</h4>
4791</div>
4792
4793<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>
4794
4795<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>
4796
4797<div style="margin: auto;">
4798 <h4><a name="sharpen" id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
4799</div>
4800
4801<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>
4802
4803<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
4804
4805<div style="margin: auto;">
4806 <h4><a name="shave" id="shave"></a>-shave <em class="arg">geometry</em></h4>
4807</div>
4808
4809<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>
4810
4811<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>
4812
4813<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>
4814
4815<div style="margin: auto;">
4816 <h4><a name="shear" id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
4817</div>
4818
4819<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>
4820
4821<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>
4822
4823<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>
4824
4825<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>
4826
4827<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>
4828
4829<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>
4830<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>
4831
4832<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
4833<div style="margin: auto;">
4834 <h4><a name="sigmoidal" id="sigmoidal-contrast"></a>-sigmoidal-contrast <em class="arg">contrast</em>x<em class="arg">mid-point</em></h4>
4835</div>
4836
4837<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>
4838
4839<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>
4840
4841<div style="margin: auto;">
4842 <h4><a name="silent" id="silent"></a>-silent</h4>
4843</div>
4844
4845<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>
4846
4847<div style="margin: auto;">
4848 <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>
4849</div>
4850
4851<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>
4852
4853<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>
4854
4855<p>For Photo CD images, choose from these sizes:</p>
4856
4857<pre class="text">
4858 192x128
4859 384x256
4860 768x512
4861 1536x1024
4862 3072x2048
4863</pre>
4864
cristy3ed852e2009-09-05 21:47:34 +00004865<div style="margin: auto;">
4866 <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>
4867</div>
4868
4869<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>
4870
4871<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>
4872
4873<div style="margin: auto;">
4874 <h4><a name="snaps" id="snaps"></a>-snaps <em class="arg">value</em></h4>
4875</div>
4876
4877<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the number of screen snapshots.</td><td style='text-align:right;'>[<a href="../www/import.html">import</a>]</td></tr></table>
4878
4879<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
4880
4881<div style="margin: auto;">
4882 <h4><a name="solarize" id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
4883</div>
4884
4885<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>
4886
4887<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
4888
4889<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
4890
4891<div style="margin: auto;">
4892 <h4><a name="sparse-color" id="sparse-color"></a>-sparse-color <em
4893 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
4894</div>
4895
4896<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>
4897
4898
4899<table class="doc">
4900 <tbody>
4901 <tr valign="top">
4902 <th align="left" style="width: 8%">Method</th>
4903 <th align="left">Description</th>
4904 </tr>
4905
4906 <tr valign="top">
4907 <td valign="top">voronoi</td>
4908 <td valign="top">Simply map each pixel to the to nearest color point
4909 given. The result are polygonal 'cells' of solid color. </td>
4910 </tr>
4911
4912 <tr valign="top">
4913 <td valign="top">shepards</td>
4914 <td valign="top">Colors points basied on the ratio of inverse distance
4915 squared. Generating spots of color in a sea of the average of
4916 colors. </td>
4917 </tr>
4918
4919 <tr valign="top">
4920 <td valign="top">barycentric</td>
4921 <td valign="top">three point triangle of color given 3 points.
4922 Giving only 2 points will form a linear gradient between those points.
4923 Gradient is however not restricted to just the triangle or line. </td>
4924 </tr>
4925
4926 <tr valign="top">
4927 <td valign="top">bilinear</td>
4928 <td valign="top">Like barycentric but for 4 points. Less than 4 points
4929 fall back to barycentric. </td>
4930 </tr>
4931
4932 </tbody>
4933</table>
4934
4935<p>The points are placed according to the images location on the virtual
4936canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
4937offset), and do not actually have to exist on the given image, but may be
4938some point beyond the edge of the image. All points are floating point values.
4939</p>
4940
4941<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
4942modified, whcih means the matte/alpha transparency channel is not effected by
4943default. If enabled, the image also needs a the matte/alpha channel to be
4944enabled for this operator to effect an images transparency. This is typical
4945transparency handling for images. </p>
4946
4947<p>All the above methods when given a single point of color will replace all
4948the colors in the image with the color given, regardless of the point. This is
4949logical, and provides an alternative technique to recolor a image to some
4950default value. </p>
4951
4952
4953<div style="margin: auto;">
4954 <h4><a name="splice" id="splice"></a>-splice <em class="arg">geometry</em></h4>
4955</div>
4956
4957<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>
4958
4959<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>
4960
4961<div style="margin: auto;">
4962 <h4><a name="spread" id="spread"></a>-spread <em class="arg">amount</em></h4>
4963</div>
4964
4965<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>
4966
4967<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>
4968
4969<div style="margin: auto;">
4970 <h4><a name="stegano" id="stegano"></a>-stegano <em class="arg">offset</em></h4>
4971</div>
4972
4973<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>
4974
4975<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>
4976
4977<div style="margin: auto;">
4978 <h4><a name="stereo" id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
4979</div>
4980
4981<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>
4982
4983<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>
4984
4985<div style="margin: auto;">
4986 <h4><a name="storage-type" id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
4987</div>
4988
4989<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>
4990
4991<pre class="text">
4992 char store pixels as unsigned characters
4993 double store pixels as doubles
4994 float store pixels as floats
4995 integer store pixels as integers
4996 long store pixels as longs
4997 quantum store pixels in the native depth of your ImageMagick distribution
4998 short store pixels as unsigned shorts
4999</pre>
5000
5001<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5002values range from 0 to the maximum value the storage type can support.</p>
5003
5004<div style="margin: auto;">
5005 <h4><a name="stretch" id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
5006</div>
5007
5008<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>
5009
5010<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>
5011
5012<pre class="text">
5013 Any
5014 Condensed
5015 Expanded
5016 ExtraCondensed
5017 ExtraExpanded
5018 Normal
5019 SemiCondensed
5020 SemiExpanded
5021 UltraCondensed
5022 UltraExpanded
5023</pre>
5024
5025<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5026
5027<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>
5028
5029<div style="margin: auto;">
5030 <h4><a name="strip" id="strip"></a>-strip</h4>
5031</div>
5032
5033<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>
5034
5035<div style="margin: auto;">
5036 <h4><a name="stroke" id="stroke"></a>-stroke <em class="arg">color</em></h4>
5037</div>
5038
5039<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>
5040
5041<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5042
5043<p>See <a href="#draw">-draw</a> for further details.</p>
5044
5045<div style="margin: auto;">
5046 <h4><a name="strokewidth" id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
5047</div>
5048
5049<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>
5050
5051<p>See <a href="#draw">-draw</a> for further details.</p>
5052
5053<div style="margin: auto;">
5054 <h4><a name="style" id="style"></a>-style <em class="arg">fontStyle</em></h4>
5055</div>
5056
5057<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>
5058
5059<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>
5060
5061<pre class="text">
5062 Any
5063 Italic
5064 Normal
5065 Oblique
5066</pre>
5067
5068<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>
5069
5070<div style="margin: auto;">
cristyae6203d2010-08-09 01:12:14 +00005071 <h4><a name="subimage-search" id="subimage-search"></a>-subimage-search</h4>
5072</div>
5073
5074<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>search for subimage.</td><td style='text-align:right;'></td></tr></table>
5075
5076<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00005077 <h4><a name="swap" id="swap"></a>-swap <em class="arg">index,index</em></h4>
5078</div>
5079
5080<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>
5081
5082<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>
5083
5084<div style="margin: auto;">
5085 <h4><a name="swirl" id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
5086</div>
5087
5088<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>
5089
5090<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5091
5092<div style="margin: auto;">
5093 <h4><a name="taint" id="taint"></a>-taint</h4>
5094</div>
5095
5096<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>
5097
5098<div style="margin: auto;">
5099 <h4><a name="text-font" id="text-font"></a>-text-font <em class="arg">name</em></h4>
5100</div>
5101
5102<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>
5103
5104<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>
5105
5106<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>
5107
5108<div style="margin: auto;">
5109 <h4><a name="texture" id="texture"></a>-texture <em class="arg">filename</em></h4>
5110</div>
5111
5112<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>
5113
5114<div style="margin: auto;">
5115 <h4><a name="threshold" id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
5116</div>
5117
5118<!-- {<em class="arg">green,blue,opacity</em>}
5119<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>
5120-->
5121
5122<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>
5123
5124<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>
5125
5126<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.
5127</p>
5128
5129<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>
5130
5131<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5132<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>
5133
5134
5135<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>
5136<p>Note that the values of the transparency channel is treated as 'matte'
5137values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5138
5139<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>.
5140</p>
5141
5142<div style="margin: auto;">
5143 <h4><a name="thumbnail" id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
5144</div>
5145
5146<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>
5147
5148<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>
5149
5150<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>
5151
5152<div style="margin: auto;">
5153 <h4><a name="tile" id="tile"></a>-tile <em class="arg">filename</em></h4>
5154</div>
5155
5156<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>
5157
5158<div style="margin: auto;">
5159 <h4>-tile <em class="arg">geometry</em></h4>
5160</div>
5161
5162<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>
5163
5164<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>
5165
5166<div style="margin: auto;">
5167 <h4>-tile</h4>
5168</div>
5169
5170<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>
5171
5172<div style="margin: auto;">
5173 <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>
5174</div>
5175
5176<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>
5177
5178<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>
5179
5180<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>
5181
5182<div style="margin: auto;">
5183 <h4><a name="tint" id="tint"></a>-tint <em class="arg">value</em></h4>
5184</div>
5185
5186<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>
5187
5188<p>Tint the image with the fill color.</p>
5189
5190<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>
5191
5192<div style="margin: auto;">
5193 <h4><a name="title" id="title"></a>-title <em class="arg">string</em></h4>
5194</div>
5195
5196<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>
5197
5198<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>
5199
5200<p>For example,</p>
5201
5202<p class="crtsnip">
5203 -title "%m:%f %wx%h"
5204</p>
5205
5206<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>
5207
5208
5209<div style="margin: auto;">
5210 <h4><a name="transform" id="transform"></a>-transform</h4>
5211</div>
5212
5213<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>
5214
5215<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5216
5217<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 +00005218
5219<p>This operator has been now been superseded by the <a
5220href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5221
5222
cristy3ed852e2009-09-05 21:47:34 +00005223<div style="margin: auto;">
5224 <h4><a name="transparent" id="transparent"></a>-transparent <em class="arg">color</em></h4>
5225</div>
5226
5227<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>
5228
5229<p>The <em class="arg">color</em> argument is defined using the format
5230described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5231>-fuzz</a> setting can be used to match and replace colors similar to the one
5232given. </p>
5233
cristyb36feb22010-03-26 16:54:37 +00005234<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5235that is make all non-matching colors transparent. </p>
5236
cristy3ed852e2009-09-05 21:47:34 +00005237<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005238href="#transparent" >-transparent</a> but replaces the matching color with the
5239current <a href="#fill">-fill</a> color setting, rather than transparent.
5240However the <a href="#transparent" >-transparent</a> operator also ensures
5241that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5242>-alpha</a> set</kbd>", and does not require you to modify the <a
5243href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005244
cristyb36feb22010-03-26 16:54:37 +00005245<p>Note that this does not define the color as being the 'transparency color'
5246used for color-mapped image formats, such as GIF. For that use <a
5247href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005248
5249
5250<div style="margin: auto;">
5251 <h4><a name="transparent-color" id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
5252</div>
5253
5254<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>
5255
5256<p>Sometimes this is used for saving to image formats such as
5257GIF and PNG8 which uses this color to represent boolean transparency. This
5258does not make a color transparent, it only defines what color the transparent
5259color is in the color palette of the saved image. Use <a
5260href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5261
5262<p>This option allows you to have both an opaque visible color, as well as a
5263transparent color of the same color value without conflict. That is, you can
5264use the same color for both the transparent and opaque color areas within an
5265image. This, in turn, frees to you to select a transparent color that is
5266appropriate when an image is displayed by an application that does not handle a
5267transparent color index, while allowing ImageMagick to correctly handle images of this
5268type. </p>
5269
5270<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5271
5272<div style="margin: auto;">
5273 <h4><a name="transpose" id="transpose"></a>-transpose</h4>
5274</div>
5275
5276<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>
5277
5278<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5279</p>
5280
5281<div style="margin: auto;">
5282 <h4><a name="transverse" id="transverse"></a>-transverse</h4>
5283</div>
5284
5285<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>
5286
5287
5288<div style="margin: auto;">
5289 <h4><a name="treedepth" id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
5290</div>
5291
5292<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>
5293
5294<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>
5295
5296<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>
5297
5298<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>
5299
5300<div style="margin: auto;">
5301 <h4><a name="trim" id="trim"></a>-trim</h4>
5302</div>
5303
5304<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>
5305
5306<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>
5307
5308<p>The page or virtual canvas information of the image is preserved allowing
5309you to extract the result of the <a href="#trim">-trim</a> operation from the
5310image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5311information if it is unwanted.</p>
5312
5313<p>If the trimmed image 'disappears' an warning is produced, and a special
5314single pixel transparent 'missed' image is returned, in the same way as when a
5315<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5316
5317
5318<div style="margin: auto;">
5319 <h4><a name="type" id="type"></a>-type <em class="arg">type</em></h4>
5320</div>
5321
5322<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>
5323 <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>
5324
5325<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>
5326
5327<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5328<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>
5329
5330<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5331
5332<div style="margin: auto;">
5333 <h4><a name="undercolor" id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
5334</div>
5335
5336<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>
5337
5338<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5339
5340<p>See <a href="#draw">-draw</a> for further details.</p>
5341
5342
5343<div style="margin: auto;">
5344 <h4><a name="update" id="update"></a>-update <em class="arg">seconds</em></h4>
5345</div>
5346
5347<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>
5348
5349<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>
5350
5351
5352<div style="margin: auto;">
5353 <h4><a name="unique-colors" id="unique-colors"></a>-unique-colors</h4>
5354</div>
5355
5356<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>
5357
5358
5359<div style="margin: auto;">
5360 <h4><a name="units" id="units"></a>-units <em class="arg">type</em></h4>
5361</div>
5362
5363<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>
5364
5365<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>
5366
5367
5368<div style="margin: auto;">
5369 <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>
5370</div>
5371
5372<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>
5373
5374<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>
5375
5376<p>The parameters are:</p>
5377
5378<pre class="text">
5379 radius: The radius of the Gaussian, in pixels, not counting the center
5380 pixel (default 0).
5381 sigma: The standard deviation of the Gaussian, in pixels (default 1.0).
5382 amount: The fraction of the difference between the original and the blur
5383 image that is added back into the original (default 1.0).
5384 threshold: The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5385 difference amount (default 0.05).
5386</pre>
5387
5388
5389<div style="margin: auto;">
5390 <h4><a name="verbose" id="verbose"></a>-verbose</h4>
5391</div>
5392
5393<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>
5394
5395
5396<div style="margin: auto;">
5397 <h4><a name="version" id="version"></a>-version</h4>
5398</div>
5399
5400<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>
5401
5402
5403<div style="margin: auto;">
5404 <h4><a name="view" id="view"></a>-view <em class="arg">string</em></h4>
5405</div>
5406
5407<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>
5408
5409
5410<div style="margin: auto;">
5411 <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>
5412</div>
5413
5414<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>
5415
5416
5417<div style="margin: auto;">
5418 <h4><a name="virtual-pixel" id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
5419</div>
5420
5421<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>
5422
5423<p>This option defines what color source should be used if and when a color
5424lookup completely 'misses' the source image. The color(s) that appear to
5425surround the source image. Generally this color is derived from the source
5426image, but could also be set to a specify background color. </p>
5427
5428<p>Choose from these methods:</p>
5429
5430<pre class="text">
5431 background: the area surrounding the image is the background color
5432 black: the area surrounding the image is black
5433 checker-tile: alternate squares with image and background color
5434 dither: non-random 32x32 dithered pattern
5435 edge: extend the edge pixel toward infinity
5436 gray: the area surrounding the image is gray
5437 horizontal-tile: horizontally tile the image, background color above/below
5438 horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
5439 mirror: mirror tile the image
5440 random: choose a random pixel from the image
5441 tile: tile the image (default)
5442 transparent: the area surrounding the image is transparent blackness
5443 vertical-tile: vertically tile the image, sides are background color
5444 vertical-tile-edge: vertically tile the image and replicate the side edge pixels
5445 white: the area surrounding the image is white
5446</pre>
5447
5448<p>The default value is "edge".</p>
5449
5450<p>This most important for distortion operators such as <a href="#distort"
5451>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
5452However it also effects operations that may access pixels just outside the
5453image proper, such as <a href="#convolve">-convolve</a>, <a
5454href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
5455
5456<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
5457
5458
5459<div style="margin: auto;">
5460 <h4><a name="visual" id="visual"></a>-visual <em class="arg">type</em></h4>
5461</div>
5462
5463<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>
5464
5465<p>Choose from these visual classes:</p>
5466
5467<pre class="text">
5468 StaticGray
5469 GrayScale
5470 StaticColor
5471 PseudoColor
5472 TrueColor
5473 DirectColor
5474 default
5475 visual id
5476</pre>
5477
5478<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>
5479
5480
5481<div style="margin: auto;">
5482 <h4><a name="watermark" id="watermark"></a>-watermark <em
5483 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
5484</div>
5485
5486<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
5487saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5488
5489<p>Take a grayscale image (with alpha mask) and modify the destination image's
5490brightness according to watermark image's grayscale value and the <em
5491class="arg">brightness</em> percentage. The destinations color saturation
5492attribute is just direct modified by the <em class="arg">saturation</em>
5493percentage, which defaults to 100 percent (no color change). </p>
5494
5495
5496<div style="margin: auto;">
5497 <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>
5498</div>
5499
5500<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>
5501
5502<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
5503
5504<div style="margin: auto;">
5505 <h4><a name="weight" id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
5506</div>
5507
5508<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>
5509
5510<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>
5511
5512<table class="doc">
5513 <col width="25%" />
5514 <col width="75%" />
5515 <thead>
5516 <tr>
5517 <th><em class="arg">fontWeight</em></th>
5518 <th>Description</th>
5519 </tr>
5520 </thead>
5521 <tbody>
5522 <tr><td>All </td> <td>No effect. </td></tr>
5523 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
5524 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
5525 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
5526 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
5527 </tbody>
5528 </table>
5529
5530<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
5531
5532<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>
5533
5534<div style="margin: auto;">
5535 <h4><a name="white-point" id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
5536</div>
5537
5538<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>
5539
5540<div style="margin: auto;">
cristy5cadd612009-09-21 19:33:41 +00005541 <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 +00005542</div>
5543
cristy5cadd612009-09-21 19:33:41 +00005544<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>
5545
5546<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.
5547</p>
cristy3ed852e2009-09-05 21:47:34 +00005548
5549<div style="margin: auto;">
5550 <h4><a name="window" id="window"></a>-window <em class="arg">id</em></h4>
5551</div>
5552
5553<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>
5554
5555<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>
5556
5557<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>
5558
5559<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>
5560
5561<div style="margin: auto;">
5562 <h4><a name="window-group" id="window-group"></a>-window-group</h4>
5563</div>
5564
5565<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>
5566
5567<div style="margin: auto;">
5568 <h4><a name="write" id="write"></a>-write <em class="arg">filename</em></h4>
5569</div>
5570
5571<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>
5572 <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>
5573
5574<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
5575
cristy3eaa0ef2010-03-06 20:35:26 +00005576
5577</div>
5578
5579<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00005580 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00005581 <span id="linkbar-center">
5582 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00005583 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00005584 </span>
5585 <span id="linkbar-east">&nbsp;</span>
5586 </div>
5587 <div class="footer">
5588 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
5589 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
5590 </div>
5591 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00005592 <script type="text/javascript">
5593 var _gaq = _gaq || [];
5594 _gaq.push(['_setAccount', 'UA-17690367-1']);
5595 _gaq.push(['_trackPageview']);
5596
5597 (function() {
5598 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
5599 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
5600 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
5601 })();
5602 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00005603</body>
5604</html>