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