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