blob: 23099f0376046d415d208fd6e32cae6a663069ad [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">
cristyd0bda5e2010-09-21 16:22:45 +0000134 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristy73fd1cd2010-09-12 19:14:25 +0000135</div>
136<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000137 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
138</div>
139<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000140 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
141</div>
142<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000143 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy787d4352010-03-06 13:55:58 +0000144</div>
145<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000146 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000147</div>
148<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000149 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000150</div>
151<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000152 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyc49f7992009-09-22 22:48:40 +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
cristyd0bda5e2010-09-21 16:22:45 +0000426position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000427href="#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
cristyd0bda5e2010-09-21 16:22:45 +0000463dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000464</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
cristyd0bda5e2010-09-21 16:22:45 +0000481minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000482href="#level" >-level</a> operator to stretch the values to the full range of
483values. </p>
484
cristy83543962009-10-16 19:04:28 +0000485<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000486JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
487for the <a href="#level" >-level</a> operation. On the other hand it is the
488right operator to use for color stretching gradient images being used to
489generate Color lookup tables, distortion maps, or other 'mathematically'
490defined images. </p>
491
492<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
493href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
494>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
495problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000496>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000497
498<p>It uses the <a href="#channel" >-channel</a> setting, (including the
499special '<CODE>sync</CODE>' flag for channel syncronization), to determine
500which color values will be used and modified. As the default <a
cristy83543962009-10-16 19:04:28 +0000501href="#channel" >+channel</a> setting is '<CODE>RGB,sync</CODE>', the
502'<CODE>sync</CODE>' will ensure that the color channels will be modified
503together by the same gamma value, preserving colors, and ignoring
504transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000505
506
cristy3ed852e2009-09-05 21:47:34 +0000507<div style="margin: auto;">
508 <h4><a name="auto-orient" id="auto-orient"></a>-auto-orient</h4>
509</div>
510
511<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Automagically orient (rotate) an image created by a digital camera.</td><td style='text-align:right;'></td></tr></table>
512
cristy83543962009-10-16 19:04:28 +0000513<p>This operator reads and resets the EXIF image profile setting 'Orientation'
514and then performs the appropriate 90 degree rotation on the image to orient
515the image, for correct viewing. </p>
516
517<p>This EXIF profile setting is usually set using a gravity sensor in digital
518camara, however photos taken directly downward or upward may not have an
519appropriate value. Also images that have been orientation 'corrected' without
520reseting this setting, may be 'corrected' again resulting in a incorrect
521result. If the he EXIF profile was previously stripped, the <a
522href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
523
524
cristy3ed852e2009-09-05 21:47:34 +0000525<div style="margin: auto;">
526 <h4><a name="average" id="average"></a>-average</h4>
527</div>
528
529<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Average a set of images.</td><td style='text-align:right;'></td></tr></table>
530
531<p>An error results if the images are not identically sized.</p>
532
cristy3ed852e2009-09-05 21:47:34 +0000533
534<div style="margin: auto;">
535 <h4><a name="backdrop" id="backdrop"></a>-backdrop</h4>
536</div>
537
538<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Display the image centered on a backdrop.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>]</td></tr></table>
539
540<p>This backdrop covers the entire workstation screen and is useful for hiding other X window activity while viewing the image. The color of the backdrop is specified as the background color. The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
541
542<div style="margin: auto;">
543 <h4><a name="background" id="background"></a>-background <em class="arg">color</em></h4>
544</div>
545
546<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the background color.</td><td style='text-align:right;'></td></tr></table>
547
548<p>The color is specified using the format described under the <a href="#fill">-fill</a> option. The default background color (if none is specified or found in the image) is white.</p>
549
550<div style="margin: auto;">
551 <h4><a name="bench" id="bench"></a>-bench <em class="arg">iterations</em></h4>
552</div>
553
554<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Measure performance.</td><td style='text-align:right;'></td></tr></table>
555
cristye6378132009-10-26 20:05:17 +0000556<p>Repeat the entire command for the given number of <em class="arg">iterations</em> and report the user-time and elapsed time. For instance, consider the following command and its output. Modify the benchmark with the -duration to run the benchmark for a fixed number of seconds and -concurrent to run the benchmark in parallel (requires the OpenMP feature).</p>
cristy3ed852e2009-09-05 21:47:34 +0000557
cristye6378132009-10-26 20:05:17 +0000558<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -resize 1000% -bench 5 logo.png</span><span class='crtout'>Performance: 5i 0.875657ips 6.880u 0:05.710</span></p>
559<p>In this example, 5 iterations were completed at 0.875657 iterations per second, using 6.88 seconds of the user's allotted time, for a total elapsed time of 5.71 seconds.</p>
cristy3ed852e2009-09-05 21:47:34 +0000560
561<div style="margin: auto;">
562 <h4><a name="bias" id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
563</div>
564
565<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Add bias when convolving an image.</td><td style='text-align:right;'></td></tr></table>
566
567<p>This option shifts the output of <a href="../www/command-line-options.html#convolve">&#x2011;convolve</a> so that positive and negative results are relative to the specified bias value. </p>
568
569<p>This is important for non-HDRI compilations of ImageMagick when dealing with convolutions that contain negative as well as positive values. This is especially the case with convolutions involving high pass filters or edge detection. Without an output bias, the negative values are clipped at zero.</p>
570
571<p>When using an ImageMagick with the HDRI compile-time setting, <a href="../www/command-line-options.html#bias">&#x2011;bias</a> is not needed, as ImageMagick is able to store/handle any
572negative results without clipping to the color value range
573(0..QuantumRange).</p>
574
575<p>See the discussion on HDRI implementations of ImageMagick on the page
576<a href="/www/high-dynamic-range.html">High Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this <a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a> entry.
577</p>
578
579<div style="margin: auto;">
580 <h4><a name="black-point-compensation" id="black-point-compensation"></a>-black-point-compensation</h4>
581</div>
582
583<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Use black point compensation.</td><td style='text-align:right;'></td></tr></table>
584
585<div style="margin: auto;">
cristy5cadd612009-09-21 19:33:41 +0000586 <h4><a name="black-threshold" id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000587</div>
588
cristy5cadd612009-09-21 19:33:41 +0000589<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Force to black all pixels below the threshold while leaving all pixels at or above the threshold unchanged.</td><td style='text-align:right;'></td></tr></table>
590
591<p> The threshold value can be given as a percentage or as an absolute integer value within [0,&nbsp;<em class="QR">QuantumRange</em>] corresponding to the desired <a href="../www/command-line-options.html#channel">&#x2011;channel</a> value. See <a href="../www/command-line-options.html#threshold">&#x2011;threshold</a> for more details on thresholds and resulting values.
592</p>
cristy3ed852e2009-09-05 21:47:34 +0000593
594
595<div style="margin: auto;">
cristy83a272e2010-05-07 20:40:35 +0000596 <h4><a name="blend" id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000597</div>
598
cristy83a272e2010-05-07 20:40:35 +0000599<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>blend an image into another by the given absolute value or percent.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +0000600
601<p>Blend will average the images together ('plus') according to the
602percentages given and each pixels transparency. If only a single percentage
603value is given it sets the weight of the composite or 'source' image, while
604the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000605<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
606'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000607
608
609<div style="margin: auto;">
610 <h4><a name="blue-primary" id="blue-primary"></a>-blue-primary <em class="arg">x</em>,<em class="arg">y</em></h4>
611</div>
612
613<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the blue chromaticity primary point.</td><td style='text-align:right;'></td></tr></table>
614
615<div style="margin: auto;">
616 <h4><a name="blue-shift" id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
617</div>
618
619<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</td><td style='text-align:right;'></td></tr></table>
620
621<div style="margin: auto;">
622
623<div style="margin: auto;">
624 <h4><a name="blur" id="blur"></a>-blur <em class="arg">radius</em><br />-blur <em class="arg">radius</em>x<em class="arg">sigma</em></h4>
625</div>
626
627<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Reduce image noise and reduce detail levels.</td><td style='text-align:right;'></td></tr></table>
628
cristyb15553d2010-07-03 22:53:14 +0000629<p>Convolve the image with a Gaussian or normal distribution using the given
630<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000631
632<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
633</div>
634
cristyb15553d2010-07-03 22:53:14 +0000635<p>The <em class="arg" >Sigma</em> value is the important argument, and
636determines the actual amount of bluring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000637
cristyb15553d2010-07-03 22:53:14 +0000638<p>The <em class="arg" >Radius</em> is only used to determine the size of the
639array which will hold the calculated gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000640integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000641radius that will provide meaningful results for the Gaussian distribution.
642</p>
643
644<p>The larger the <em class="arg" >Radius</em> the radius the slower the
645operation is. However too small a <em class="arg" >Radius</em>, and sever
646aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
647should be at least twice the <em class="arg" >Sigma</em> value, though three
648times will produce a more accurite result. </p>
649
650<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
651by taking advantage of the separability properties of the distribution. Here
652we apply a single-dimensional Gaussian matrix in the horizontal direction,
653then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000654
655<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
656pixels which are outside the image proper are blurred into the final result.
657</p>
658
659
660<div style="margin: auto;">
661 <h4><a name="blur-composite" id="blur"></a>-blur <em class="arg">Width</em>[x<em class="arg">Height</em>[+<em class="arg">Angle</em>]]</h4>
662</div>
663
664<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Variably blur and image according to the overlay mapping.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
665
666<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
667Average (EWA) of the source image, scaled according to the grayscale
668mapping. </p>
669
670<p>The ellipse is weighted with sigma set to the given <em class="arg"
671>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
672defaults to the <em class="arg" >Width</em> for a normal circular Guassian
673weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
674horizontal clock-wise. </p>
675
676<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
677pixels which are outside the image proper are blurred into the final result.
678</p>
679
680
681<div style="margin: auto;">
682 <h4><a name="border" id="border"></a>-border <em class="arg">geometry</em></h4>
683</div>
684
685<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Surround the image with a border of color. </td><td style='text-align:right;'></td></tr></table>
686
cristybc9539a2010-08-16 18:06:20 +0000687<p>Set the width and height using the <em class="arg">size</em> portion of the
688<em class="arg">gravity</em> argument. See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Offsets are
689ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000690
cristybc9539a2010-08-16 18:06:20 +0000691<p>Set the border color by preceding with the <a
692href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000693
cristybc9539a2010-08-16 18:06:20 +0000694<p>The <a href="#border">-border</a> operation is affected by the current <a
695href="#compose">-compose</a> setting and assumes that this is using the default
696'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
697size colors by the current <a href="#bordercolor">-bordercolor</a> before
698overlaying the original image in the center of this net image. This means that
699with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000700be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000701<p>See also the <a href="#frame">-frame</a> option, which has more
702functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000703
704<div style="margin: auto;">
705 <h4><a name="bordercolor" id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
706</div>
707
708<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the border color.</td><td style='text-align:right;'></td></tr></table>
709
710<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
711
712<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
713
714<div style="margin: auto;">
715 <h4><a name="borderwidth" id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
716</div>
717
718<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the border width.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>]</td></tr></table>
719
720<div style="margin: auto;">
cristy16ff93c2010-01-13 23:18:07 +0000721 <h4><a name="brightness-contrast" id="brightness-contrast"></a>-brightness-contrast <em class="arg">brightness</em><br />-brightness-contrast <em class="arg">brightness</em>{x<em class="arg">contrast</em>}{<em class="arg">%</em>}}</h4>
722</div>
723
724<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Adjust the brightness and/or contrast of the image.</td><td style='text-align:right;'></td></tr></table>
725
726<p>Brightness and Contrast values apply changes to the input image. They are not absolute settings. A brightness or contrast value of zero means no change. The range of values is -100 to +100 on each. Positive values increase the brightness or contrast and negative values decrease the brightness or contrast. To control only contrast, set the brightness=0. To control only brightness, set contrast=0 or just leave it off.</p>
727
728<p>You may also use <a href="#fill">-channel</a> to control which channels to apply the brightness and/or contrast change. The default is to apply the same transformation to all channels.</p>
729
730<p>Brightness and Contrast arguments are converted to offset and slope of a linear transform and applied using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
731
732<p>The slope varies from 0 at contrast=-100 to almost vertical at contrast=+100. For brightness=0 and contrast=-100, the result will be totally midgray. For brightness=0 and contrast=+100, the result will approach but not quite reach a threshold at midgray; that is the linear transformation will be a a very steep vertical line at mid gray.</p>
733
734<p>Negative slopes, i.e. negating the image, are not possible with this function. All achievable slopes will be zero or positive.</p>
735
736<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5 at brightness=+100. Thus, when contrast=0 and brightness=100, the result will be totally white. Similarly, when contrast=0 and brightness=-100, the result will be totally black.</p>
737
738<p>As the range of values for the arguments are -100 to +100, adding the '%' symbol will be no different than leaving it off.</p>
739
740<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +0000741 <h4><a name="cache" id="cache"></a>-cache <em class="arg">threshold</em></h4>
742</div>
743
744<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>(This option has been replaced by the <a href='#limit'>-limit</a> option.)</td><td style='text-align:right;'></td></tr></table>
745
746<div style="margin: auto;">
747 <h4><a name="caption" id="caption"></a>-caption <em class="arg">string</em></h4>
748</div>
749
750<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Assign a caption to an image.</td><td style='text-align:right;'></td></tr></table>
751
cristy71a3f602010-09-15 12:38:16 +0000752<p>This option sets the caption meta-data of an image read in after this
753option has been given. To modify a caption of images already in memory use
754"<kbd><a href="#set">-set</a> caption</kbd>". </p>
755
756<p>The caption can contain special format characters listed in the <a
757href="../www/escape.html">Format and
758Print Image Properties</a>. These attributes will be expanded when the caption
759is finally assigned to the individual images. </p>
760
761<p>If the first character of <em class="arg">string</em> is <em
762class="arg">@</em>, the image caption is read from a file titled by the
763remaining characters in the string. Comments read in from a file are literal;
764no embedded formatting characters are recognized.</p>
765
766<p>Caption meta-data ais not visible on the image itself. To do that use the
767<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
768instead.</p>
769
770<p>For example,</p>
771
772<p class="crtsnip">
773 -caption "%m:%f %wx%h" bird.miff
774</p>
775
776<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
777that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
778480.</p>
779
780
cristy3ed852e2009-09-05 21:47:34 +0000781<div style="margin: auto;">
782 <h4><a name="cdl" id="cdl"></a>-cdl <em class="arg">filename</em></h4>
783</div>
784
785<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>
786
787<p>Here is an example color correction collection:</p>
788
789<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000790&lt;?xml version="1.0" encoding="UTF-8"?&gt;
791&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
792 &lt;ColorCorrection id="cc06668"&gt;
793 &lt;SOPNode&gt;
794 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
795 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
796 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
797 &lt;/SOPNode&gt;
798 &lt;SATNode&gt;
799 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
800 &lt;/SATNode&gt;
801 &lt;/ColorCorrection&gt;
802&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000803</pre>
804
805<div style="margin: auto;">
806 <h4><a name="channel" id="channel"></a>-channel <em class="arg">type</em></h4>
807</div>
808
809<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>
810
811<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>
812
cristy83a272e2010-05-07 20:40:35 +0000813<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000814abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
815'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
816'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000817
cristy83a272e2010-05-07 20:40:35 +0000818For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
819you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000820<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000821 -channel Red,Blue
822</p>
823<p>or you can use the short hand form</p>
824<p class="crtsnip">
825 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000826</p>
827
cristy83a272e2010-05-07 20:40:35 +0000828<p>All the channels that is present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000829special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
830but generally any operators that are generally 'grey-scale' image operators,
831will understand this setting. See individual operator documentation. </p>
832
833<br>
cristy83a272e2010-05-07 20:40:35 +0000834
835<p>On top of the normal channel selection a extra flag can be specified,
836'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000837operators that understand this flag should perform: cross-channel
838syncronization of the channels. If not specified, then most grey-scale
839operators will apply their image processing operations to each individual
840channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000841setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000842
843<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
844<a href="#auto-gamma">-auto-gamma</a> the color channels will be modified
845together in exactly the same way so that colors will remain in-sync. Without
cristyd0bda5e2010-09-21 16:22:45 +0000846it being set, then each channel will be modified separately and
847independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000848
cristybac7a162010-06-15 19:57:29 +0000849<p>The <a href="#morphology">-morphology</a> '<kdb>Convolve</kdb>' method
850and the <a href="#compose">-compose</a> mathematical methods, also understands
851the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
852to the alpha channel (if present). That is to say it will modify the image
853processing with the understanding that fully-transparent colors should not
854contribute to the final result. </p>
855
856Basically, by default, operators work with color channels in syncronous, and
857treats transparency as special, unless the <a href="#channel">-channel</a>
858setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
859How each operator does this depends on that operators current implementation.
860Not all operators understands this flag at this time, but that is changing.
861</p>
cristy83a272e2010-05-07 20:40:35 +0000862
863<p>To print a complete list of channel types, use <a href="#list">-list
864channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000865
cristybac7a162010-06-15 19:57:29 +0000866<br>
cristyd934d102009-10-10 12:55:13 +0000867
868<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000869'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
870channels except the transparency channel, and that all the color channels are
871to be modified in exactly the same way, with a understanding of transprancy
872(depending on the operation being applied). The 'plus' form <a
873href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000874
875<p>Options that are affected by the <a href="#channel" >-channel</a> setting
876include the following.
877
878<a href="#auto-gamma">-auto-gamma</a>,
879<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000880<a href="#black-threshold">-black-threshold</a>,
881<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000882<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000883<a href="#clut">-clut</a>,
884<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000885<a href="#composite">-composite</a> (Mathematical compose methods only),
886<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000887<a href="#contrast-stretch">-contrast-stretch</a>,
888<a href="#evaluate">-evaluate</a>,
889<a href="#function">-function</a>,
890<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000891<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000892<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000893<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000894<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000895<a href="#negate">-negate</a>,
896<a href="#normalize">-normalize</a>,
897<a href="#ordered-dither">-ordered-dither</a>,
898<a href="#radial-blur">-radial-blur</a>,
899<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000900<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000901<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000902<a href="#white-threshold">-white-threshold</a>.
903</p>
904
cristyd0bda5e2010-09-21 16:22:45 +0000905<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +0000906>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +0000907href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +0000908default). These operators have yet to be made to understand the newer 'Sync'
909flag. </p>
910
cristybac7a162010-06-15 19:57:29 +0000911<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
912the image before thresholding, if no <a href="#channel" >-channel</a> setting
913has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +0000914
915<p>Also some operators such as <a href="#blur">-blur</a>, <a
916href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
917color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
918href="#channel" >-channel</a>. Generally this done to ensure that
919fully-transparent colors are treated as being fully-transparent, and thus any
920underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +0000921resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +0000922convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +0000923and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +0000924
cristybac7a162010-06-15 19:57:29 +0000925<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +0000926color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +0000927alpha channel present, and the <a href="#channel" >-channel</a> setting tells
928the operator to apply the operation using alpha channels. The <a
929href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +0000930
cristy3ed852e2009-09-05 21:47:34 +0000931
932<div style="margin: auto;">
cristyb4c03bb2009-09-27 13:55:46 +0000933 <h4><a name="clamp" id="clamp"></a>-clamp</h4>
934</div>
935
936<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>
937
938<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +0000939 <h4><a name="charcoal" id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
940</div>
941
942<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>
943
944<div style="margin: auto;">
945 <h4><a name="chop" id="chop"></a>-chop <em class="arg">geometry</em></h4>
946</div>
947
948<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>
949
950<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>
951
952<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>
953
954<div style="margin: auto;">
955 <h4><a name="clip" id="clip"></a>-clip</h4>
956</div>
957
958<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>
959
960<p>If a clipping path is present, it is applied to subsequent operations.</p>
961
962<p>For example, in the command</p>
963
964<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
965<p>only the pixels within the clipping path are negated.</p>
966
967<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
968
969<div style="margin: auto;">
970 <h4><a name="clip-mask" id="clip-mask"></a>-clip-mask</h4>
971</div>
972
973<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>
974
975<div style="margin: auto;">
976 <h4><a name="clip-path" id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
977</div>
978
979<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>
980
981<div style="margin: auto;">
982 <h4><a name="clone" id="clone"></a>-clone <em class="arg">index(s)</em></h4>
983</div>
984
985<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>
986
987<p>Specify the image by its index in the sequence. The first image is index
9880. Negative indexes are relative to the end of the sequence; for example, &minus;1
989represents the last image of the sequence. Specify a range of images with a
990dash (e.g. 0&minus;4). Separate multiple indexes with commas but no spaces (e.g. 0,2,5). Use <a
991href="#clone">+clone</a> make a copy of the last image in the image
992sequence.</p>
993
994<div style="margin: auto;">
995 <h4><a name="clut" id="clut"></a>-clut</h4>
996</div>
997
998<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
999corresponding channel in the second image as a <b>c</b>olor
1000<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1001
1002<p>The second (LUT) image is ordinarily a gradient image containing the
1003histogram mapping of how each channel should be modified. Typically it is a
1004either a single row or column image of replacement color values. If larger
1005than a single row or column, values are taken from a diagonal line from
1006top-left to bottom-right corners.</p>
1007
1008<p>The lookup is further controlled by the <a
1009href="#interpolate">-interpolate</a> setting, which is especially handy for an
1010LUT which is not the full length needed by the ImageMagick installed Quality
1011(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1012'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1013gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1014lookup of color values. </p>
1015
1016<p>This operator is especially suited to replacing a grayscale image with a
1017specific color gradient from the CLUT image. </p>
1018
1019<p>Only the channel values defined by the <a href="#channel">-channel</a>
1020setting will have their values replaced. In particular, since the default <a
1021href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1022transparency (alpha/matte channel) is not affected, unless the <a
1023href="#channel">-channel</a> setting is modified. When the alpha channel is
1024set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1025as the other channels, implying that alpha/matte values are replaced using the
1026alpha/matte values of the original image. </p>
1027
cristyd0bda5e2010-09-21 16:22:45 +00001028<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001029transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1030href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bda5e2010-09-21 16:22:45 +00001031assumed that image represents a gray-scale gradient which will be used for the
cristy3ed852e2009-09-05 21:47:34 +00001032replacement alpha values. That is you can use a gray-scale CLUT image to
1033adjust a existing images alpha channel, or you can color a gray-scale image
1034using colors form CLUT containing the desired colors, including transparency.
1035</p>
1036
1037<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors according
1038the lookup of the full color RGB value from a 2D representation of a 3D color
1039cube. </p>
1040
1041
1042<div style="margin: auto;">
1043 <h4><a name="coalesce" id="coalesce"></a>-coalesce</h4>
1044</div>
1045
1046<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>
1047
cristyd0bda5e2010-09-21 16:22:45 +00001048<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 easily viewed and processed than the highly optimized GIF overlay images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001049
1050<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>
1051
1052
1053<div style="margin: auto;">
1054 <h4><a name="colorize" id="colorize"></a>-colorize <em class="arg">value</em></h4>
1055</div>
1056
1057<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>
1058
1059<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>
1060
1061<div style="margin: auto;">
1062 <h4><a name="colormap" id="colormap"></a>-colormap <em class="arg">type</em></h4>
1063</div>
1064
1065<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>
1066
1067<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1068
1069<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>
1070
1071<div style="margin: auto;">
1072 <h4><a name="colors" id="colors"></a>-colors <em class="arg">value</em></h4>
1073</div>
1074
1075<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>
1076
1077<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>
1078
1079<div style="margin: auto;">
cristy2c839602010-04-03 02:32:08 +00001080 <h4><a name="color-matrix" id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
1081</div>
1082
1083<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>
1084
1085<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>
1086
1087<p>As an example, to add contrast to an image with offsets, try this command:</p>
1088
1089<pre class="text">
1090convert kittens.jpg -color-matrix \
1091 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1092 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1093 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1094 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1095 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1096 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1097</pre>
1098<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00001099 <h4><a name="colorspace" id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
1100</div>
1101
1102<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>
1103
1104<p>Choices are:</p>
1105
1106<pre class="text">
1107 CMY
1108 CMYK
1109 Gray
1110 HSB
1111 HSL
1112 HWB
1113 Lab
1114 Log
1115 OHTA
1116 Rec601Luma
1117 Rec601YCbCr
1118 Rec709Luma
1119 Rec709YCbCr
1120 RGB
1121 sRGB
1122 Transparent
1123 XYZ
1124 YCbCr
1125 YCC
1126 YIQ
1127 YPbPr
1128 YUV
1129</pre>
1130
1131<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1132
1133<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>
1134
1135<table class="doc">
1136 <caption>Conversion Of RGB To Other Color Spaces</caption>
1137 <tr><th align="left" valign="middle">CMY</th></tr>
1138 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1139 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1140 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1141 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1142 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1143 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1144 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1145 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1146
1147 <tr><th align="left" valign="middle">Gray</th></tr>
1148 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1149
1150 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1151 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1152 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1153 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1154
1155 <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>
1156 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1157 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1158 <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>
1159
1160 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1161 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1162 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1163 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1164
1165 <tr><th align="left" valign="middle">LAB</th></tr>
1166 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1167 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1168 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1169
1170 <tr><th align="left" valign="middle">LOG</th></tr>
1171 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1172 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1173 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1174
1175 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1176 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1177 <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>
1178 <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>
1179
1180 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1181 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1182
1183 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1184 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1185 <tr><td align="left" valign="middle">Cb=(&minus;0.168736*R-0.331264*G+0.500000*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1186 <tr><td align="left" valign="middle">Cr=(0.500000*R&minus;0.418688*G&minus;0.081312*B)*(<em class="QR">QuantumRange</em>+1)/2</td></tr>
1187
1188 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1189 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1190
1191 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1192 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1193 <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>
1194 <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>
1195
1196 <tr><th align="left" valign="middle">sRGB</th></tr>
1197 <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>
1198 <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>
1199 <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>
1200
1201 <tr><th align="left" valign="middle">XYZ</th></tr>
1202 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1203 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1204 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1205
1206 <tr><th align="left" valign="middle">YCC</th></tr>
1207 <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>
1208 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1209 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1210
1211 <tr><th align="left" valign="middle">YCbCr</th></tr>
1212 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1213 <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>
1214 <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>
1215
1216 <tr><th align="left" valign="middle">YIQ</th></tr>
1217 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1218 <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>
1219 <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>
1220
1221 <tr><th align="left" valign="middle">YPbPr</th></tr>
1222 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1223 <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>
1224 <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>
1225
1226 <tr><th align="left" valign="middle">YUV</th></tr>
1227 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1228 <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>
1229 <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>
1230</table>
1231
1232<div style="margin: auto;">
1233 <h4><a name="combine" id="combine"></a>-combine</h4>
1234</div>
1235
1236<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>
1237
1238<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>
1239
1240<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.
1241</p>
1242
cristy4949d522010-03-12 18:41:34 +00001243<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 +00001244<div style="margin: auto;">
1245 <h4><a name="comment" id="comment"></a>-comment <em class="arg">string</em></h4>
1246</div>
1247
1248<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>
1249
cristyd0bda5e2010-09-21 16:22:45 +00001250<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001251option has been given. To modify a comment of images already in memory use
1252"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001253
cristy71a3f602010-09-15 12:38:16 +00001254<p>The comment can contain special format characters listed in the <a
1255href="../www/escape.html">Format and
1256Print Image Properties</a>. These attributes will be expanded when the comment
1257is finally assigned to the individual images. </p>
1258
1259<p>If the first character of <em class="arg">string</em> is <em
1260class="arg">@</em>, the image comment is read from a file titled by the
1261remaining characters in the string. Comments read in from a file are literal;
1262no embedded formatting characters are recognized.</p>
1263
1264<p>Comment meta-data are not visible on the image itself. To do that use the
1265<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1266instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001267
1268<p>For example,</p>
1269
1270<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001271 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001272</p>
1273
cristy71a3f602010-09-15 12:38:16 +00001274<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1275that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1276480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001277
1278<div style="margin: auto;">
1279 <h4><a name="compose" id="compose"></a>-compose <em class="arg">operator</em></h4>
1280</div>
1281
1282<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>
1283
cristybc9539a2010-08-16 18:06:20 +00001284<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1285a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001286
cristybc9539a2010-08-16 18:06:20 +00001287<p>This setting effects image processing operators that merge two (or more)
1288images together in some way. This includes the operators,
1289<a href="#composite">-composite</a>,
1290<a href="#layers">-layers</a> composite,
1291<a href="#flatten">-flatten</a>,
1292<a href="#mosaic">-mosaic</a>,
1293<a href="#layers">-layers</a> merge,
1294<a href="#border">-border</a>,
1295<a href="#frame">-frame</a>,
1296and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001297
cristybc9539a2010-08-16 18:06:20 +00001298<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1299command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001300
1301
1302<div style="margin: auto;">
1303 <h4><a name="composite" id="composite"></a>-composite</h4>
1304</div>
1305
cristybc9539a2010-08-16 18:06:20 +00001306<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Perform alpha composition on two images and an optional mask</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001307
1308<p>Take the first image 'destination' and overlay the second 'source' image
1309according to the current <a href="#compose">-compose</a> setting. The location
1310of the 'source' or 'overlay' image is controlled according to <a
1311href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1312settings. </p>
1313
1314<p>If a third image is given this is treated as a gray-scale 'mask' image
1315relative to the first 'destination' image. This mask will limit what parts of
1316the destination can be modified by the image composition. However for the
1317'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1318Y-displacement image instead. </p>
1319
1320<p>If a <a href="#compose">-compose</a> method requires extra numerical
1321arguments or flags these can be provided by setting the <a
1322href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001323appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001324
1325<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1326image outside the overlay area. You can disable this by setting the special <a
1327href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1328to '<kbd>false</kbd>'. </p>
1329
1330
1331<div style="margin: auto;">
1332 <h4><a name="compress" id="compress"></a>-compress <em class="arg">type</em></h4>
1333</div>
1334
1335<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>
1336
1337<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>
1338
1339<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1340
1341<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>
1342
1343<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>
1344
1345<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>
1346
1347<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>
1348
1349<div style="margin: auto;">
1350 <h4><a name="contrast" id="contrast"></a>-contrast</h4>
1351</div>
1352
1353<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>
1354
1355<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>
1356
1357<p>For a more pronounced effect you can repeat the option:</p>
1358
1359<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1360<div style="margin: auto;">
1361 <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>
1362</div>
1363
1364<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>
1365
cristyd934d102009-10-10 12:55:13 +00001366<p>While performing the stretch, black-out at most <em
1367class="arg" >black-point</em> pixels and white-out at most <em
1368class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1369<em class="arg" >black-point %</em> pixels and white-out at most <em
1370class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001371
cristyd934d102009-10-10 12:55:13 +00001372<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1373>-contrast-stretch</a> will black-out at most <em class="arg"
1374>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1375minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1376class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1377>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001378
cristyd934d102009-10-10 12:55:13 +00001379<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1380the image's min and max values are stretched to 0 and <em class="QR"
1381>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1382clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001383>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001384prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001385
cristyd934d102009-10-10 12:55:13 +00001386<p>Internally operator works by creating a histogram bin, and then uses that
1387bin to modify the image. As such some colors may be merged together when they
1388originally fell into the same 'bin'. </p>
1389
1390<p>All the channels are normalized in concert by the came amount so as to
1391preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001392setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001393setting will normalize the RGB channels independently.</p>
1394
1395<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1396normalization of mathematical images. </p>
1397
1398<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001399
1400
1401<div style="margin: auto;">
1402 <h4><a name="convolve" id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
1403</div>
1404
1405<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>
1406
cristy16ff93c2010-01-13 23:18:07 +00001407<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001408a comma-separated list of integers (with no spaces), ordered left-to right,
1409starting with the top row. Presently, only odd-dimensioned kernels are
1410supported, and therefore the number of entries in the specified <em
1411class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
14127<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001413
cristyd934d102009-10-10 12:55:13 +00001414<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
1415positive and negative results are relative to a user-specified bias value.
1416This is important for non-HDRI compilations of ImageMagick when dealing with
1417convolutions that contain negative as well as positive values. This is
1418especially the case with convolutions involving high pass filters or edge
1419detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001420</p>
1421
cristyd934d102009-10-10 12:55:13 +00001422<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
1423negative results without clipping to the color value range (0..QuantumRange).
1424See the discussion on HDRI implementations of ImageMagick on the page <a
1425href="/www/high-dynamic-range.html">High
1426Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1427href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1428<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1429entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001430
cristy3ed852e2009-09-05 21:47:34 +00001431
1432<div style="margin: auto;">
1433 <h4><a name="crop" id="crop"></a>-crop <em class="arg">geometry</em></h4>
1434</div>
1435
1436<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>
1437
1438<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>
1439
1440<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>
1441
1442<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>
1443
1444<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>
1445
1446<p>By adding a exclamation character flag to the geometry argument, the
1447cropped images virtual canvas page size and offset is set as if the
1448geometry argument was a viewport or window. This means the canvas page size
1449is set to exactly the same size you specified, the image offset set
1450relative top left corner of the region cropped. </p>
1451
1452<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1453special single pixel transparent 'missed' image is returned, and a 'crop
1454missed' warning given. </p>
1455
cristy739df912009-10-24 16:10:18 +00001456<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 +00001457
1458<div style="margin: auto;">
1459 <h4><a name="cycle" id="cycle"></a>-cycle <em class="arg">amount</em></h4>
1460</div>
1461
1462<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>
1463
1464<p><em class="arg">Amount</em> defines the number of positions each
1465colormap entry is shifted.</p>
1466
1467
1468<div style="margin: auto;">
1469 <h4><a name="debug" id="debug"></a>-debug <em class="arg">events</em></h4>
1470</div>
1471
1472<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>
1473
1474<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>
1475
1476
1477<p>For example, to log cache and blob events, use.</p>
1478
1479<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1480<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1481
1482<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1483
1484<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1485
1486<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1487
1488<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>
1489
1490
1491<div style="margin: auto;">
1492 <h4><a name="decipher" id="decipher"></a>-decipher <em class="arg">filename</em></h4>
1493</div>
1494
1495<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>
1496
1497<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1498
1499<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1500
1501
1502<div style="margin: auto;">
1503 <h4><a name="deconstruct" id="deconstruct"></a>-deconstruct</h4>
1504</div>
1505
1506<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>
1507
1508<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>
1509
1510<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>
1511
1512<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1513
1514
1515<div style="margin: auto;">
1516 <h4><a name="define" id="define"></a>-define <em class="arg">key</em>{<em class="arg">=value</em>}<em class="arg">...</em></h4>
1517</div>
1518
cristyd0bda5e2010-09-21 16:22:45 +00001519<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>add specific global settings generally used to control
1520coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001521
cristyd0bda5e2010-09-21 16:22:45 +00001522<p>This option creates one or more definitions for coders and decoders to use
1523while reading and writing image data. Definitions are generally used to
1524control image file format coder modules, and image processing operations,
1525beyond what is provided by normal means. Defined settings are listed in <a
1526href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1527as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001528
cristyd0bda5e2010-09-21 16:22:45 +00001529<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1530definition of a flag is created with that name. This used to control on/off
1531options. Use <a href="#define">+define key</a> to remove definitions
1532previously created. Use <a href="#define">+define "*"</a> to remove all
1533existing definitions.</p>
1534
1535<p>The same "Artifact" settings can also be defined using the <a
1536href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
1537>value</em></a> option, which also allows the use of <a href="../www/escape.html" >Format and Print Image
1538Properties</a> in the defined value. </p>
1539
1540<p>Such settings are global in scope, and effect all images and operations. </p>
1541
1542<p>The following definitions are just some of the artifacts that are
1543available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001544
1545<ul>
cristyd0bda5e2010-09-21 16:22:45 +00001546
cristy045bd902010-01-30 18:56:24 +00001547<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001548<dd>Set the display range to the minimum and maximum pixel values for the
1549 DCM image format.</dd><br />
1550
cristy045bd902010-01-30 18:56:24 +00001551<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001552<dd>Set the specify the layout engine for the DOT image format (e.g.
1553 <kbd>neato</kbd>).</dd><br />
1554
cristy045bd902010-01-30 18:56:24 +00001555<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001556<dd>Restrict the maximum JPEG file size, for example <kbd>-define
1557 jpeg:extent=400kb</kbd>.</dd><br />
1558
cristy045bd902010-01-30 18:56:24 +00001559<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001560<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1561 It is most useful for increasing performance and reducing the memory
1562 requirements when reducing the size of a large JPEG image.</dd><br />
1563
cristy045bd902010-01-30 18:56:24 +00001564<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001565<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1566 compression factor is the reciprocal of the compression ratio. The valid
1567 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1568 this value overrides the -quality setting. A quality setting of 75
1569 results in a rate value of 0.06641.</dd><br />
1570
cristy3ed852e2009-09-05 21:47:34 +00001571<dt>mng:need-cacheoff</dt>
1572 <dd>turn playback caching off for streaming MNG.</dd><br />
cristyd0bda5e2010-09-21 16:22:45 +00001573
cristy045bd902010-01-30 18:56:24 +00001574<dt>png:bit-depth=<em class="arg">value</em></dt>
1575<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001576<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1577 encoder to use a different bit-depth and color-type than it would have
1578 normally selected, but only if this does not cause any loss of image
1579 quality. Any attempt to reduce image quality is treated as an error and no
1580 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1581 can use these "defines" to cause it to be written as an 8-bit grayscale,
1582 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1583 you cannot force it to be written as a grayscale or indexed PNG. If you
1584 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1585 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1586 reduce the image quality prior to using the PNG encoder. Note that in
1587 indexed PNG files, "bit-depth" refers to the number of bits per index,
1588 which can range from 1 to 8. In such files, the color samples always have
1589 8-bit depth.</dd><br />
1590
cristy3ed852e2009-09-05 21:47:34 +00001591<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001592<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1593 Postscript files that render bilevel images with the Postscript imagemask
1594 operator instead of the image operator.</dd><br />
1595
cristy045bd902010-01-30 18:56:24 +00001596<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001597<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1598 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1599 to preserve negative values. If <a href="#depth">-depth</a> 16 is
1600 included, then the result will be single precision floating point format.
1601 If <a href="#depth">-depth</a> 32 is included, then the result will be
1602 double precision floating point format.</dd>
1603
cristy3ed852e2009-09-05 21:47:34 +00001604</ul>
1605
cristyd0bda5e2010-09-21 16:22:45 +00001606<p>For example, to create a postscript file that will render only the black
1607pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001608
1609<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bilevel.tif -define ps:imagemask eps3:stencil.ps</span></p>
cristyd0bda5e2010-09-21 16:22:45 +00001610<p>Set attributes of the image registry by prefixing the value with
1611<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1612use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001613
1614<p class="crtsnip">
1615-define registry:temporary-path=/data/tmp
1616</p>
1617
cristyd0bda5e2010-09-21 16:22:45 +00001618
1619
cristy3ed852e2009-09-05 21:47:34 +00001620<div style="margin: auto;">
1621 <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>
1622</div>
1623
1624<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>
1625
1626<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>
1627
1628<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>
1629
1630
1631<div style="margin: auto;">
1632 <h4><a name="delete" id="delete"></a>-delete <em class="arg">index</em></h4>
1633</div>
1634
1635<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>
1636
1637<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>
1638
1639
1640<div style="margin: auto;">
1641 <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>
1642</div>
1643
1644<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>
1645
1646<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>
1647
1648<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>
1649
1650<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>
1651
1652<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>
1653
1654<div style="margin: auto;">
1655 <h4><a name="depth" id="depth"></a>-depth <em class="arg">value</em></h4>
1656</div>
1657
1658<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>
1659
1660<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>
1661
1662<div style="margin: auto;">
1663 <h4><a name="descend" id="descend"></a>-descend</h4>
1664</div>
1665
1666<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>
1667
1668<div style="margin: auto;">
1669 <h4><a name="deskew" id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
1670</div>
1671
1672<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>
1673
1674<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>
1675
1676<div style="margin: auto;">
1677 <h4><a name="despeckle" id="despeckle"></a>-despeckle</h4>
1678</div>
1679
1680<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>
1681
1682<div style="margin: auto;">
cristy2c839602010-04-03 02:32:08 +00001683 <h4><a name="direction" id="direction"></a>-direction <em class="arg">type</em></h4>
1684</div>
1685
1686<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>
1687
1688<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00001689 <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>
1690</div>
1691
1692<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>
1693
1694<p>With this option, the 'overlay' image, and optionally the 'mask' image,
1695will be used as a displacement map, which is used to displace the lookup of
1696what part of the 'background' image is seen at each point of the overlaid
1697area. Much like the displacement map is a 'lens' that redirects light shining
1698through it so as to present a distorted view the original 'background' image
1699behind it. </p>
1700
1701<p>Any perfect grey areas of the displacement map produce a zero
1702displacement of the image. Black areas produce the given maximum negative
1703displacement of the lookup point, while white produce a maximum positive
1704displacement of the lookup. </p>
1705
1706<p>Note that it is the lookup of the 'background' that is displaced, not a
1707displacement of the image itself. As such an area of the displacement map
1708containing 'white' will have the lookup point 'shifted' by a positive amount,
1709and thus generating a copy of the destination image to the right/downward from
1710the correct position. That is the image will look like it may have been
1711'shifted' in a negative left/upward direction. Understanding this is a very
1712important in understanding how displacement maps work. </p>
1713
1714<p>The given arguments define the maximum amount of displacement in pixels
1715that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001716it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001717outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001718easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001719into the overlay area. </p>
1720
1721<p>The '%' flag makes the displacement scale relative to the size of the
1722overlay image (100% = half width/height of image). Using '!' switches
1723percentage arguments to refer to the destination image size instead.
1724these flags were added as of IM v6.5.3-5.</p>
1725
1726<p>Normally a single grayscale displacement map is provided, which with the
1727given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001728displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001729specify a third image which is normally used as a <em class="arg">mask</em>,
1730then the <em class="arg">composite image</em> will be used for horizontal X
1731displacement, while the <em class="arg">mask image</em> is used for vertical Y
1732displacement. This allows you to define completely different displacement
1733values for the X and Y directions, and allowing you to lookup any point within
1734the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001735any other nearby pixel, producing complex 2 dimensional displacements, rather
1736than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001737
cristyd0bda5e2010-09-21 16:22:45 +00001738<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001739you can use the 'red' channel of the overlay image to specify the horizontal
1740or X displacement, and the 'green' channel for the vertical or Y displacement.
1741</p>
1742
1743<p>As of IM v6.5.3-5 any alpha channel in the overlay image will be used as a
1744mask the transparency of the destination image. However areas outside the
1745overlaid areas will not be effected. </p>
1746
1747
1748<div style="margin: auto;">
1749 <h4><a name="display" id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
1750</div>
1751
1752<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>
1753
1754<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1755
1756<div style="margin: auto;">
1757 <h4><a name="dispose" id="dispose"></a>-dispose <em class="arg">method</em></h4>
1758</div>
1759
1760<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>
1761
1762<p>The layer disposal method defines the way each the displayed image is to be
1763modified after the current 'frame' of an animation has finished being
1764displayed (after its 'delay' period), but before the next frame on an
1765animation is to be overlaid onto the display. </p>
1766
1767<p>Here are the valid methods:</p>
1768
1769<pre class="text">
1770Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
1771None 1 Do not dispose, just overlay next frame image.
1772Background 2 Clear the frame area with the background color.
1773Previous 3 Clear to the image prior to this frames overlay.
1774</pre>
1775
1776<p>You can also use the numbers given above, which is what the GIF format
1777uses internally to represent the above settings. </p>
1778
cristyd0bda5e2010-09-21 16:22:45 +00001779<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00001780
1781<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
1782resetting the layer disposal methods of images being read in. </p>
1783
1784<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
1785disposal method for images already in memory.</p>
1786
1787<div style="margin: auto;">
1788 <h4><a name="dissimilarity-threshold" id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
1789</div>
1790
1791<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>
1792
1793
1794<div style="margin: auto;">
1795 <h4><a name="dissolve" id="dissolve"></a>-dissolve <em class="arg">src_percent</em>[x<em class="arg">dst_percent</em>]</h4>
1796</div>
1797
1798<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>
1799
1800<p>The opacity of the composite image is multiplied by the given percent, then
1801it is composited 'over' the main image. If <em class="arg">src_percent</em>
1802is greater than 100, start dissolving the main image so it will become
1803transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
1804are given, each image are dissolved to the percentages given. </p>
1805
1806<p>Note that dissolve percentages do not add, two opaque images dissolved
1807'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
1808images, you would need to use dissolve values of '50,100'. </p>
1809
1810<div style="margin: auto;">
1811 <h4><a name="distort" id="distort"></a>-distort <em class="arg">method arguments</em></h4>
1812</div>
1813
1814<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>
1815
1816<p>The <em class="arg">arguments</em> is a single string containing a list
1817of floating point numbers separated by commas or spaces. The number of
1818and meaning of the floating point values depends on the distortion <em
1819class="arg">method</em> being used. </p>
1820
1821<p>Choose from these distortion types:</p>
1822
1823<table class="doc">
1824 <tr valign="top">
1825 <th align="left" style="width: 8%">Method</th>
1826 <th align="left">Description</th>
1827 </tr>
1828
1829 <tr valign="top">
1830 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
1831 <br/>or &nbsp; <kbd>SRT</kbd></td>
1832 <td valign="top">
1833 Distort image by first scaling and rotating about a given 'center',
1834 before translating that 'center' to the new location, in that order. It
1835 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
1836 distortion, but without shearing effects. It also provides a good way
1837 of rotating and displacing a smaller image for tiling onto a larger
1838 background (IE 2-dimensional animations). <br/>
1839
1840 The number of arguments determine the specific meaning of each
1841 argument for the scales, rotation, and translation operations. <br/>
1842
1843 <table style="margin-left:auto; margin-right:auto;">
1844 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
1845 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
1846 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
1847 <tr><td>3:</td><td><em>ScaleX,ScaleY &nbsp; Angle</em></td></tr>
1848 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
1849 <tr><td>5:</td>
1850 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
1851 <tr><td>6:</td>
1852 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
1853 <tr><td>7:</td>
1854 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
1855 &nbsp; NewX,NewY</em></td></tr>
1856 </table>
1857
cristyd0bda5e2010-09-21 16:22:45 +00001858 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00001859 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
1860
1861 <tr valign="top">
1862 <td valign="top"><kbd>Affine</kbd></td>
1863 <td valign="top">
1864 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00001865 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00001866 point values are given allowing the image to be linearly scaled,
1867 rotated, sheared, and translated, according to those three points. See
1868 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
1869 distortions. <br/>
1870
1871 More than 3 sets given control point pairs (12 numbers) is least
1872 squares fitted to best match a lineary affine distortion. If only 2
1873 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00001874 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00001875 flipping or changes in aspect ratio to the resulting image. If only one
1876 control point pair is provides the image is only translated, (which may
1877 be a floating point non-integer translation). <br/>
1878
1879 This distortion does not include any form of perspective distortion.
1880 </td>
1881
1882 </tr>
1883
1884 <tr valign="top">
1885 <td valign="top"><kbd>AffineProjection</kbd></td>
1886 <td valign="top">
1887 Linearly distort an image using the given Affine Matrix of 6
1888 pre-calculated coefficients forming a set of Affine Equations to map
1889 the source image to the destination image.
1890
1891 <div style="text-align: center"><em>
1892 s<sub>x</sub>, r<sub>x</sub>,
1893 r<sub>y</sub>, s<sub>y</sub>,
1894 t<sub>x</sub>, t<sub>y</sub>
1895 </em></div>
1896
1897 See <a href="#affine" >-affine</a> setting for more detail, and
1898 meanings of these coefficients. <br/>
1899
1900 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
1901 alternative methods of defining this distortion, with ImageMagick doing the
1902 calculations needed to generate the required coefficients. You can see
1903 the internally generated coefficients, by using a <a href="#verbose"
1904 >-verbose</a> setting. </td>
1905
1906 </tr>
1907
1908<!-- still under development, do not display - Anthony
1909 <tr valign="top">
1910 <td valign="top"><kbd>Bilinear</kbd></td>
1911 <td valign="top">
1912 Bilinear (reversed) Distortion, given a minimum of 4 sets of
1913 coordinate pairs, or 16 values (see below). Not that lines may not
1914 appear straight after distortion, though the distance between
cristyd0bda5e2010-09-21 16:22:45 +00001915 coordinates will remain consistent. </td>
cristy3ed852e2009-09-05 21:47:34 +00001916 </tr>
1917-->
1918
1919 <tr valign="top">
1920 <td valign="top"><kbd>Perspective</kbd></td>
1921 <td valign="top">
1922 Perspective distort the images, using a list of 4 or more sets of
1923 control points (as defined below). More that 4 sets (16 numbers) of
1924 control points provide least squares fitting for more accurate
1925 distortions (for the purposes of image registration and panarama
1926 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
1927 linear distortion. <br/>
1928
1929 Perspective Distorted images ensures that straight lines remain
1930 straight, but the scale of the distorted image will vary. The horizon
1931 is anti-aliased, and the 'sky' color may be set using the
1932 <a href="#mattecolor" >-mattecolor</a> setting. </td>
1933 </tr>
1934
1935 <tr valign="top">
1936 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
1937 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00001938 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00001939 pre-calculated coefficients. You can get these coefficients by looking
1940 at the <a href="#verbose" >-verbose</a> output of a
1941 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
1942 If the last two perspective scaling coefficients are zero, the
1943 remaining 6 represents a transposed 'Affine Matrix'. </td>
1944
1945 </tr>
1946
1947 <tr valign="top">
1948 <td valign="top"><kbd>Arc</kbd></td>
1949 <td valign="top">
1950 Arc the image (variation of polar mapping) over the angle given around
1951 a circle. <br/>
1952 <table width="90%" style = "margin-left: auto; margin-right: auto;">
1953 <tr valign="top"><td>Argument</td>
1954 <td>Meaning</td></tr>
1955 <tr valign="top"><td><em>arc_angle</em></td>
1956 <td>The angle over which to arc the image side-to-side</td></tr>
1957 <tr valign="top"><td><em>rotate_angle</em></td>
1958 <td>Angle to rotate resulting image from vertical center</td></tr>
1959 <tr valign="top"><td><em>top_radius</em></td>
1960 <td>Set top edge of source image at this radius</td></tr>
1961 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
1962 <td>Set bottom edge to this radius (radial scaling)</td></tr>
1963 </table>
1964
1965 The resulting image is always resized to best fit the resulting image,
1966 (as if using <a href="#distort" >+distort</a>) while attempting to
1967 preserve scale and aspect ratio of the original image as much as
1968 possible with the arguments given by the user. All four arguments will
1969 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
1970
1971 This a variation of a polar distortion designed to try to preserve the
1972 aspect ratio of the image rather than direct Cartesian to Polar
1973 conversion. </td>
1974 </tr>
1975
1976 <tr valign="top">
1977 <td valign="top"><kbd>Polar</kbd></td>
1978 <td valign="top">
1979 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
1980 the image. that is the height of the input image is mapped to the
1981 radius limits, while the width is wrapped around between the
1982 angle limits. <br/>
1983
1984 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
1985
1986 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
1987 center to the center of the image, and the angles going from -180 (top)
1988 to +180 (top). If <em>Rmax</em> is given the special value of
1989 '<code>0</code>', the the distance from the center to the nearest edge
1990 is used for the radius of the output image, which will ensure the whole
1991 image is visible (though scaled smaller). However a special value of
1992 '<code>-1</code>' will use the distance from the center to the furthest
1993 corner, This may 'clip' the corners from the input rectangular image,
1994 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
1995 the same arguments. <br/>
1996
1997 If the plus form of distort (<a href="#distort" >+distort</a>) is used
1998 output image center will default to <code>0,0</code> of the virtual
1999 canvas, and the image size adjusted to ensure the whole input image is
2000 made visible in the output image on the virtual canvas. </td>
2001
2002 </tr>
2003
2004 <tr valign="top">
2005 <td valign="top"><kbd>DePolar</kbd></td>
2006 <td valign="top">
2007 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2008 but generates the reverse Polar to Cartesian distortion. <br/>
2009
2010 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2011 the corners of the input image. However using the special
2012 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2013 distance) will ensure the whole distorted image is preserved in the
2014 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2015 reverse the distortion re-producing the original.
2016
2017 Note that as this distortion requires the area resampling of a circular
2018 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002019 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002020 form of 'super-sampling' image processing technique be used to produce
2021 a high quality result. </td>
2022
2023 </tr>
2024
2025 <tr valign="top">
2026 <td valign="top"><kbd>Barrel</kbd></td>
2027 <td valign="top">
2028 Given the four coefficients (A,B,C,D) as defined by <a
2029 href="http://www.all-in-one.ee/~dersch/barrel/barrel.html" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002030 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002031 correct radial lens distortions. That is in photographs, make straight
2032 lines straight again. <br/>
2033
2034 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2035 <em>X</em> , <em>Y</em> ] ] <br/>
2036 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2037 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2038 [ <em>X</em> , <em>Y</em> ] <br/>
2039 So that it forms the function <br/>
2040 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2041 <em>C</em>*r + <em>D</em> )<br/>
2042
2043 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2044 (defaulting to the center of the image). <br/>
2045 The second form is typically used to distort images, rather than
2046 correct lens distortions. <br/>
2047 </td>
2048
2049 </tr>
2050
2051 <tr valign="top">
2052 <td valign="top"><kbd>BarrelInverse</kbd></td>
2053 <td valign="top">
2054 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2055 arguments, and argument handling. However it uses the inverse
2056 of the radial polynomial,
2057 so that it forms the function <br/>
2058 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2059 <em>C</em>*r + <em>D</em> )
2060 </td>
2061 </tr>
2062
2063 <tr valign="top">
2064 <td valign="top"><kbd>Shepards</kbd></td>
2065 <td valign="top">
2066 Distort the given list control points (any number) using an Inverse
2067 Squared Distance Interpolation Method (<a
2068 href="http://www.ems-i.com/smshelp/Data_Module/Interpolation/Inverse_Distance_Weighted.htm"
2069 >Shepards Method</a>). The control points in effect do 'localized'
2070 distortions of the image around the given control point. For best
2071 results extra control points should be added to 'lock' the positions of
2072 the corners and other unchanging parts of the image. <br/>
2073
2074 The distortion has been likened to 'taffy pulling' using nails, pins or
2075 sticks. It basically uses the <a href="#sparse-color"
2076 >-sparse-color</a> method of the same name to generate separate X and Y
2077 displacement maps (see <a href="#displace" >-displace</a>) for source
2078 image color look-up. </td>
2079
2080 </tr>
2081
2082</table>
2083
2084<p>To print a complete list of distortion methods, use <a href="#list">-list distort</a>.</p>
2085
2086<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2087'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2088defining how these points in the given image should be distorted in the
2089destination image. Each set of four floating point values represent a source
2090image coordinate, followed immediately by the destination image coordinate.
2091This produces a list of values such as...</p>
2092<div style="text-align: center"><em>
2093 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2094 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2095 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2096 ... &nbsp;
2097 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2098</em></div>
2099<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2100destination image. </p>
2101
2102<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2103needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2104perspective distortion of the built-in "rose:" image. Note how spaces were
2105used to group the 4 sets of coordinate pairs, to make it easier to read and
2106understand.</p>
2107
2108<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2109 convert rose: -virtual-pixel black \ <br/>
2110 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \ <br/>
2111 rose_3d_rotated.gif</span></p>
2112<p>If more that the required number of coordinate pairs are given for a
2113distortion, the distortion method is 'least squares' fitted to
2114produce the best result for all the coordinate pairs given. If less than the
2115ideal number of points are given, the distort will generally fall back to a
2116simpler form of distortion that can handles the smaller number of coordinates
2117(usally a linear '<kbd>Affine</kbd>' distortion). </p>
2118
cristyd0bda5e2010-09-21 16:22:45 +00002119<p>By using more coordinates you can make use of image registration tool to
2120find matching coordinate pairs in overlapping images, so as to improve the 'fit'
cristy3ed852e2009-09-05 21:47:34 +00002121of the distortion. Of course a bad coordinate pair can also make the 'fit'
2122worse. Caution is always advised. </p>
2123
2124<p>Colors are acquired from the source image according to the <a
2125href="#interpolate" >-interpolate</a> color lookup setting, when the image is
2126magnified. However if the viewed image is minified (image becomes smaller), a
2127special area resampling function (added ImageMagick v6.3.5-9), is used to
2128produce a higher quality image. For example you can use a
2129'<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all the
2130way to the horizon. </p>
2131
2132<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \ <br/>
2133 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \ <br/>
2134 checks_tiled.jpg</span></p>
2135<p>Note that a infinitely tiled perspective images involving the horizon can
2136be very slow to generate due to the use of the high quality 'area resampling'
2137function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2138using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2139(recommended if you plan to use super-sampling instead). </p>
2140
2141<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2142'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2143will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2144pixels. If you do not what these pixels to be visible, set the color to match
2145the rest of the ground. </p>
2146
2147<p>The output image size will by default be the same as the input image. This
2148means that if the part of the distorted image falls outside the viewed area of
2149the 'distorted space', those parts is clipped and lost. However if you
2150use the plus form of the operator (<a href="#distort" >+distort</a>) the
cristyd0bda5e2010-09-21 16:22:45 +00002151operator will attempt (if possible) to show the whole of the distorted image,
cristy3ed852e2009-09-05 21:47:34 +00002152while retaining a correct 'virtual canvas' offset, for image layering. This
2153offset may need to be removed using <a href="#repage" >+repage</a>, to remove
2154if it is unwanted. </p>
2155
2156<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2157option:distort:viewport {geometry_string}</kbd>" setting which will specify
2158the size and the offset of the generated 'viewport' image of the distorted
2159image space.</p>
2160
2161<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2162{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2163that factor without changing the viewed contents of the distorted image. This
2164can be used either for 'super-sampling' the image for a higher quality result,
2165or for panning and zooming around the image (with appropriate viewport
2166changes, or post-distort cropping and resizing). </p>
2167
2168<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2169href="#distort" >-distort</a> to attempt to output the internal coefficients,
2170and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2171and debugging purposes. This many not be available for all distorts. </p>
2172
2173<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2174produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2175and/or <a href="#shear" >-shear</a> operation, with more control of due to the
2176above settings. It is algorithmically slower, though in ImageMagick it may be faster.
2177</p>
2178
2179
2180<div style="margin: auto;">
2181 <h4><a name="dither" id="dither"></a>-dither <em class="arg">method</em></h4>
2182</div>
2183
2184<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>
2185
cristyd0bda5e2010-09-21 16:22:45 +00002186<p>Dithering places two or more colors in neighboring 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>
cristy3ed852e2009-09-05 21:47:34 +00002187
2188<p>Dithering is turned on by default, to turn it off use the plus form of the
2189setting, <a href="#dither">+dither</a>. This will also also render PostScript
2190without text or graphic aliasing. Disabling dithering often (but not always)
2191leads to faster process, a smaller number of colors, but more cartoon like
2192image coloring. Generally resulting in 'color banding' effects in areas with
2193color gradients. </p>
2194
2195<p>The color reduction operators <a href="#colors">-colors</a>, <a
2196href="#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>
2197
2198<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>
2199
2200
2201<div style="margin: auto;">
2202 <h4><a name="draw" id="draw"></a>-draw <em class="arg">string</em></h4>
2203</div>
2204
2205<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>
2206
2207<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>
2208
2209<p>The shape primitives:</p>
2210
2211<pre class="text">
2212 point x,y
2213 line x0,y0 x1,y1
2214 rectangle x0,y0 x1,y1
2215 roundRectangle x0,y0 x1,y1 wc,hc
2216 arc x0,y0 x1,y1 a0,a1
2217 ellipse x0,y0 rx,ry a0,a1
2218 circle x0,y0 x1,y1
2219 polyline x0,y0 ... xn,yn
2220 polygon x0,y0 ... xn,yn
2221 bezier x0,y0 ... xn,yn
2222 path path specification
2223 image operator x0,y0 w,h filename
2224</pre>
2225
2226<p>The text primitive:</p>
2227
2228<pre class="text">
2229 text x0,y0 string
2230</pre>
2231<p>The text gravity primitive:</p>
2232
2233<pre class="text">
2234 gravity NorthWest, North, NorthEast, West, Center,
2235 East, SouthWest, South, or SouthEast
2236</pre>
2237
2238<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>
2239
2240<p>The transformation primitives:</p>
2241
2242<pre class="text">
2243 rotate degrees
2244 translate dx,dy
2245 scale sx,sy
2246 skewX degrees
2247 skewY degrees
2248</pre>
2249
2250<p>The pixel operation primitives:</p>
2251
2252<pre class="text">
2253 color x0,y0 method
2254 matte x0,y0 method
2255</pre>
2256
2257<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>
2258
2259<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>
2260
2261<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2262
2263<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2264
2265<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>
2266
2267<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2268
2269<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>
2270
2271<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>
2272
2273<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>.
2274</p>
2275
2276<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2277
2278<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2279
2280<p class="crtsnip">
2281 -draw 'circle 100,100 150,150'
2282</p>
2283
2284<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
2285draw 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>
2286
2287<p class="crtsnip">
2288 -draw 'bezier 20,50 45,100 45,0 70,50'
2289</p>
2290<p class="crtsnip">
2291 -draw 'bezier 70,50 95,100 95,0 120,50'
2292</p>
2293
2294
2295<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>
2296
2297<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>
2298
2299<p class="crtsnip">
2300 -draw 'image SrcOver 100,100 225,225 image.jpg'
2301</p>
2302
cristybc9539a2010-08-16 18:06:20 +00002303<p>You can use 0,0 for the image size, which means to use the actual
2304dimensions found in the image header. Otherwise, it is scaled to the given
2305dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
2306a detailed discussion of alpha composition methods that are available. </p>
cristy3ed852e2009-09-05 21:47:34 +00002307
2308<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>
2309
2310<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2311
2312<p class="crtsnip">
2313 -draw 'text 100,100 "Works like magick!"'
2314</p>
2315
2316<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2317
2318<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>
2319
2320<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2321
2322<p>The <kbd>scale</kbd> primitive scales them.</p>
2323
2324<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>
2325
2326<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
2327matrix.</p>
2328
2329<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>
2330
2331<pre class="text">
2332 point
2333 replace
2334 floodfill
2335 filltoborder
2336 reset
2337</pre>
2338
2339<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>
2340
2341<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>
2342
2343<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>
2344
2345<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2346
2347<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2348
2349
2350<div style="margin: auto;">
2351 <h4><a name="edge" id="edge"></a>-edge <em class="arg">radius</em></h4>
2352</div>
2353
2354<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>
2355
2356<div style="margin: auto;">
2357 <h4><a name="emboss" id="emboss"></a>-emboss <em class="arg">radius</em></h4>
2358</div>
2359
2360<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>
2361
2362<div style="margin: auto;">
2363 <h4><a name="encipher" id="encipher"></a>-encipher <em class="arg">filename</em></h4>
2364</div>
2365
2366<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>
2367
2368<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2369
2370<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2371
cristyd0bda5e2010-09-21 16:22:45 +00002372
2373
cristy3ed852e2009-09-05 21:47:34 +00002374<div style="margin: auto;">
2375 <h4><a name="encoding" id="encoding"></a>-encoding <em class="arg">type</em></h4>
2376</div>
2377
2378<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>
2379
2380<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>
2381
2382<div style="margin: auto;">
2383 <h4><a name="endian" id="endian"></a>-endian <em class="arg">type</em></h4>
2384</div>
2385
2386<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>
2387
2388<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2389
2390<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2391
2392
2393<div style="margin: auto;">
2394 <h4><a name="enhance" id="enhance"></a>-enhance</h4>
2395</div>
2396
2397<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>
2398
2399
2400<div style="margin: auto;">
2401 <h4><a name="equalize" id="equalize"></a>-equalize</h4>
2402</div>
2403
2404<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>
2405
2406<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>
2407
2408<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2409
2410<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>
2411
2412<div style="margin: auto;">
2413 <h4><a name="evaluate" id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
2414</div>
2415
2416<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>
2417
2418<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>
2419
2420<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>
2421
2422<table class="doc">
2423 <col width="25%" />
2424 <col width="75%" />
2425 <thead>
2426 <tr>
2427 <th><em class="arg">operator</em></th>
2428 <th>Summary (see further below for details)</th>
2429 </tr>
2430 </thead>
2431 <tbody>
2432
cristy3c98a4f2010-08-13 20:09:41 +00002433 <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 +00002434 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2435 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2436 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2437 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2438 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
2439 <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>
2440 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2441 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002442 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002443 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2444 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2445 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2446 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2447 <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>
2448 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2449 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2450 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2451 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2452
2453 <tr><td>&nbsp;</td></tr>
2454
2455 <tr><td>Gaussian-noise</td></tr>
2456 <tr><td>Impulse-noise</td></tr>
2457 <tr><td>Laplacian-noise</td></tr>
2458 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2459 <tr><td>PoissonNoise</td></tr>
2460 <tr><td>Uniform-noise</td></tr>
2461
2462 <tr><td>&nbsp;</td></tr>
2463
2464 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2465 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2466 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2467 </tbody>
2468 </table>
2469
2470<p>The specified functions are applied only to each previously set <a
2471href="#channel" >-channel</a> in the image. If necessary, the results of the
2472calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2473class="QR">QuantumRange</em>]. The transparency channel of the image is
2474represented as a 'alpha' values (0 = fully transparent), so, for example, a
2475<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2476semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2477as a percentage of the <em class="QR">QuantumRange</em>.</p>
2478
2479<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2480<a href="#list">-list evaluate</a>.</p>
2481
2482<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2483<kbd>Multiply</kbd> methods can also be achieved using either the <a
2484href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2485appropriate argument, to linearly modify the overall range of color values.
2486Please note, however, that <a href="#level" >-level</a> treats transparency as
2487'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2488'alpha' values.</p>
2489
2490<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>
2491
2492<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>
2493
2494 <div style="text-align:center;">
2495 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2496 </div>
2497
2498<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2499normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2500href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2501to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2502with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2503with <kbd>Pow</kbd>.</p>
2504
2505<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2506converts the image values into a value according to a (co)sine wave function.
2507The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2508is biased 50% and normalized by 50% so as to fit in the respective color value
2509range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2510function (its frequency), and thus determines the number of 'waves' that will
2511be generated over the input color range. For example, if the <em
2512class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2513class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2514then the effective period is the <em>half</em> the <em
2515class="QR">QuantumRange</em>.
2516
2517 <div style="text-align:center;">
2518 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2519 </div>
2520
2521See also the <a href="#function" >-function</a> operator, which is a
2522multi-value version of evaluate. </P>
2523
cristy63fed272010-03-07 19:08:45 +00002524<div style="margin: auto;">
2525 <h4><a name="evaluate-sequence" id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
2526</div>
2527
2528<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 +00002529
2530<div style="margin: auto;">
2531 <h4><a name="extent" id="extent"></a>-extent <em class="arg">geometry</em></h4>
2532</div>
2533
2534<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>
2535
cristy3e2860c2010-01-24 01:36:30 +00002536<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 +00002537
2538<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>
2539
2540<div style="margin: auto;">
2541 <h4><a name="extract" id="extract"></a>-extract <em class="arg">geometry</em></h4>
2542</div>
2543
2544<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>
2545
2546<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2547
cristy4949d522010-03-12 18:41:34 +00002548<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 +00002549
cristy4949d522010-03-12 18:41:34 +00002550<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 +00002551<p>then the image will be <em>resized</em> to the specified dimensions instead,
2552equivalent to:</p>
2553
2554<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>
2555<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>
2556
2557<div style="margin: auto;">
2558 <h4><a name="family" id="family"></a>-family <em class="arg">fontFamily</em></h4>
2559</div>
2560
2561<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>
2562
2563<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).
2564</p>
2565
2566<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>.
2567</p>
2568
2569<div style="margin: auto;">
cristy7396d882010-01-27 02:37:56 +00002570 <h4><a name="features" id="features"></a>-features <em class="arg">distance</em></h4>
2571</div>
2572
2573<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>
2574
2575<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00002576 <h4><a name="fft" id="fft"></a>-fft</h4>
2577</div>
2578
2579<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>
2580
cristyb36feb22010-03-26 16:54:37 +00002581<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 +00002582
2583<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>
2584
2585<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>
2586
2587<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2588<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>
2589
2590<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2591<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>
2592
2593<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>
2594
2595<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>
2596
2597<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2598 -evaluate log 1000 fft_image_spectrum.png</span></p>
2599<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>
2600
2601<p>The <a href="http://www.fftw.org/" target="_blank">FFTW</a> delegate library is required to use <a href="#fft">-fft</a>.
2602
2603<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>
2604
2605<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>
2606
2607<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>
2608
2609<p>See the discussion on HDRI implementations of ImageMagick on the page
2610<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.
2611</p>
2612
2613
2614<div style="margin: auto;">
2615 <h4><a name="fill" id="fill"></a>-fill <em class="arg">color</em></h4>
2616</div>
2617
2618<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>
2619
2620<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>
2621
2622<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2623
2624<p>For example,</p>
2625
2626<p class="crtsnip">
2627 -fill blue
2628</p>
2629<p class="crtsnip">
2630 -fill "#ddddff"
2631</p>
2632<p class="crtsnip">
2633 -fill "rgb(255,255,255)"
2634</p>
2635
2636<p>See <a href="#draw">-draw</a> for further details.</p>
2637
2638<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2639
2640<div style="margin: auto;">
2641 <h4><a name="filter" id="filter"></a>-filter <em class="arg">type</em></h4>
2642</div>
2643
cristyd0bda5e2010-09-21 16:22:45 +00002644<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 or
2645distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002646
cristyd0bda5e2010-09-21 16:22:45 +00002647<p>Use this option to affect the resizing operation of an image during
2648operations such as <a href="#resize">-resize</a> and <a href="#distort"
2649>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002650
2651<pre class="text">
2652 Point Hermite Cubic
2653 Box Gaussian Catrom
2654 Triangle Quadratic Mitchell
2655</pre>
2656
cristyd0bda5e2010-09-21 16:22:45 +00002657<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
2658as a faster <kbd>SincFast</kbd> equivalent ploynomil form).
2659However these filters are generally useless on their own as they are infinite
2660filters that have been clipped to the filters support size. Their direct use
2661is not recommended except via expert settings (see below). </p>
2662
2663Instead these special filter functions are typically windowed by a windowing
2664function that the <a href="#filter" >-filter</a> setting defines. That is
2665using these functions will define a 'Windowed' filter, appropriate to the
2666operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002667
2668<pre class="text">
2669 Lanczos Hamming Parzen
2670 Blackman Kaiser Welsh
2671 Hanning Bartlett Bohman
2672</pre>
2673
2674<p>Also one special self-windowing filter is also provided
2675<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2676on the current 'support' or 'lobes' expert settings (see below).</p>
2677
cristyd0bda5e2010-09-21 16:22:45 +00002678<p>If you do not select a filter with this option, the filter defaults to
2679<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2680if the image is enlarged. Otherwise the filter default to
2681<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002682
cristyd0bda5e2010-09-21 16:22:45 +00002683<p>To print a complete list of resize filters, use the <a href="#list">-list
2684filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002685
2686<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002687use of these expert settings (see also <a href="#define" >-define</a> and <a
2688href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002689
2690<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002691<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002692<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002693 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2694 Gaussian-like filters simple filters, or you may not get the expected
2695 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002696
cristyd0bda5e2010-09-21 16:22:45 +00002697<dt>-define filter:support=<em>radius</em></dt>
2698<dd>Set the filter support radius. Defines how large the filter should be and
2699 thus directly defines how slow the filtered resampling process is. All
2700 filters have a default 'prefered' support size. Some filters like
2701 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2702 this value. With simple filters this value either does nothing (but slow
2703 the resampling), or will clip the filter function in a detrimental way.
2704 </dd>
cristy3ed852e2009-09-05 21:47:34 +00002705
cristyd0bda5e2010-09-21 16:22:45 +00002706<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002707<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00002708 alternative way of specifying the 'support' range of the filter, that is
2709 designed to be more suited to windowed filters, especially when used for
2710 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002711
cristyd0bda5e2010-09-21 16:22:45 +00002712<dt>-define filter:b=<em>b-spline_factor</em></dt>
2713<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002714<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2715 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2716 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2717 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00002718 filter. Values meaning was defined by a research paper by
2719 Mitchell-Netravali.
cristy3ed852e2009-09-05 21:47:34 +00002720
cristyd0bda5e2010-09-21 16:22:45 +00002721<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002722<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00002723 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00002724 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00002725 'Bessel' functions. If defined, no windowing function is used, unless the
2726 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002727
cristyd0bda5e2010-09-21 16:22:45 +00002728<dt>-define filter:window=<em>filter_function</em></dt>
2729<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
2730 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
2731 support range) with the given filter. This allows you to specify a filter
2732 function that is not normally used as a windowing function, such as
2733 <kbd>Box</kbd>, (which effectively turns off the windowing function),
2734 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
2735 </dd>
2736
2737<dt>-define filter:verbose=<em>1</em></dt>
2738<dd>This causes IM to print information on the final internal filter
2739 selection to standard output. This includes a commented header on the
2740 filter settings being used, and data allowing the filter weights to be
2741 easily graphed. </dd>
2742
2743<dd>Note however that some filters are internally defined in terms of other
2744 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
2745 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
2746 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
2747 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002748
2749</dl>
2750
cristyd0bda5e2010-09-21 16:22:45 +00002751<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00002752
2753<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
2754 -set filter:window=bessel -set filter:lobes=8 \ <br/>
2755 -resize 150% image.jpg</span></p>
2756<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
2757
2758<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
2759 -resize 150% image.jpg</span></p>
2760<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00002761filters, and 'verbose' for viewing the internal filter selection), are
2762provided for image processing experts who have studied and understood how
2763resize filters work. Without this knowledge, and an understanding of the
2764definition of the actual filters involved, using expert settings are more
2765likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00002766
2767
2768<div style="margin: auto;">
2769 <h4><a name="flatten" id="flatten"></a>-flatten</h4>
2770</div>
2771
2772<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>
2773
2774
2775<div style="margin: auto;">
2776 <h4><a name="flip" id="flip"></a>-flip</h4>
2777</div>
2778
2779<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>
2780
2781<p>reflect the scanlines in the vertical direction.</p>
2782
2783<div style="margin: auto;">
2784 <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>
2785</div>
2786
2787<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>
2788
2789<div style="margin: auto;">
2790 <h4><a name="flop" id="flop"></a>-flop</h4>
2791</div>
2792
2793<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>
2794
2795<p>reflect the scanlines in the horizontal direction.</p>
2796
2797
2798<div style="margin: auto;">
2799 <h4><a name="font" id="font"></a>-font <em class="arg">name</em></h4>
2800</div>
2801
2802<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>
2803
2804<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>
2805
2806<p>In addition to the fonts specified by the above pre-defined list, you can
2807also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
2808is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
2809<kbd>x:fixed</kbd> is X11 font.</p>
2810
2811<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>
2812
2813
2814<div style="margin: auto;">
2815 <h4><a name="foreground" id="foreground"></a>-foreground <em class="arg">color</em></h4>
2816</div>
2817
2818<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>
2819
2820<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
2821
2822<p>The default foreground color is black.</p>
2823
2824<div style="margin: auto;">
2825 <h4><a name="format" id="format"></a>-format <em class="arg">type</em></h4>
2826</div>
2827
2828<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>
2829
2830<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>
2831
2832<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>
2833
2834<div style="margin: auto;">
2835 <h4><a name="format_identify_" id="format_identify_"></a>-format <em class="arg">string</em></h4>
2836</div>
2837
2838<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>
2839
2840<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>
2841
2842<div style="margin: auto;">
2843 <h4><a name="frame" id="frame"></a>-frame <em class="arg">geometry</em></h4>
2844</div>
2845
2846<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>
2847
cristybc9539a2010-08-16 18:06:20 +00002848<p>The color of the border is specified with the <a href="#mattecolor"
2849>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00002850
cristybc9539a2010-08-16 18:06:20 +00002851<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
2852class="arg">geometry</em> argument indicates the amount of extra width and
2853height that is added to the dimensions of the image. If no offsets are given
2854in the <em class="arg">geometry</em> argument, then the border added is
2855a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
2856the width and height of the border is partitioned to form an outer bevel of
2857thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
2858<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
2859</p>
2860
2861<p>The <a href="#frame">-frame</a> option is affected by the current <a
2862href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00002863'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00002864size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
2865draws the frame of four distinct colors close to the current <a
2866href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
2867center of this image. This means that with the default compose method of
2868'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
2869href="#bordercolor">-bordercolor</a> setting.</p>
2870
2871<p>The image composition is not
2872affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002873
2874
2875<div style="margin: auto;">
2876 <h4><a name="frame_import_" id="frame_import_"></a>-frame</h4>
2877</div>
2878
2879<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>
2880
2881<div style="margin: auto;">
2882 <h4><a name="function" id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
2883</div>
2884
2885<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>
2886
2887<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>
2888
2889<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>
2890
2891<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>
2892
2893<pre class="text">
2894 Polynomial
2895 Sinusoid
2896 Arcsin
2897 Arctan
2898</pre>
2899
2900<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
2901
2902<dl class="doc">
2903<dt><kbd>Polynomial</kbd></dt>
2904<dd>
2905<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>
2906
2907<div style="text-align: center">
2908 -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>
2909</div>
2910
2911<p>will invoke a polynomial function given by</p>
2912
2913<div style="text-align: center">
2914 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
2915 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
2916 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
2917</div>
2918
2919<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
2920
2921<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>
2922
2923<table class="doc">
2924 <col width="35%" />
2925 <col width="35%" />
2926 <col width="30%" />
2927 <tr>
2928 <td>-evaluate Set <em class="arg">value</em> </td>
2929 <td>-function Polynomial <em class="arg">value</em></td>
2930 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
2931 </tr>
2932 <tr>
2933 <td>-evaluate Add <em class="arg">value</em> </td>
2934 <td>-function Polynomial 1,<em class="arg">value</em></td>
2935 </tr>
2936 <tr>
2937 <td>-evaluate Subtract <em class="arg">value</em> </td>
2938 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
2939 </tr>
2940 <tr>
2941 <td>-evaluate Multiply <em class="arg">value</em> </td>
2942 <td>-function Polynomial <em class="arg">value</em>,0</td>
2943 </tr>
2944 <tr>
2945 <td>+level black% x white%</td>
2946 <td>-function Polynomial A,B</td>
2947 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
2948 </tr>
2949</table>
2950
2951<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>
2952</dd>
2953
2954<dt><kbd>Sinusoid</kbd></dt>
2955<dd>
2956<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>
2957
2958<div style="text-align: center">
2959 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
2960</div>
2961
2962<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>
2963
2964<div style="text-align: center">
2965<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>
2966</div>
2967
2968<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>
2969
2970<p class="crtsnip">
2971 -function Sinusoid 3,-90,.2,.7
2972</p>
2973
2974<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>
2975
2976<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>
2977
2978<table class="doc">
2979 <tr>
2980 <td>-evaluate Sin <em class="arg">freq</em> </td>
2981 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
2982 </tr>
2983 <tr>
2984 <td>-evaluate Cos <em class="arg">freq</em> </td>
2985 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
2986 </tr>
2987</table>
2988</dd>
2989
2990<dt><kbd>ArcSin</kbd></dt>
2991<dd>
2992<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
2993and can be used to generate cylindrical distortion and displacement maps.
2994The curve can be adjusted relative to both the input values and output range
2995of values.
2996
2997<div style="text-align: center">
2998 -function <kbd>ArcSin</kbd> <em class="arg">width</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
2999</div>
3000
3001<p>with all values given in terms of noramlize color values (0.0 for black,
30021.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3003for bout input (<em class="arg">width</em>), and output (<em
3004class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3005
3006<div style="text-align: center">
3007<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>
3008</div>
3009
3010</dd>
3011
3012<dt><kbd>ArcTan</kbd></dt>
3013<dd>
3014<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3015limit values at infinities, though a center using the given slope value.
3016All these values can be adjusted via the arguments.
3017
3018<div style="text-align: center">
3019 -function <kbd>ArcTan</kbd> <em class="arg">slope</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
3020</div>
3021
3022<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3023</p>
3024
3025<div style="text-align: center">
3026<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>
3027</div>
3028
3029</dd>
3030
3031</dl>
3032
3033
3034<div style="margin: auto;">
3035 <h4><a name="fuzz" id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
3036</div>
3037
3038<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>
3039
3040<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>
3041
3042<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>
3043
3044
3045<div style="margin: auto;">
3046 <h4><a name="fx" id="fx"></a>-fx <em class="arg">expression</em></h4>
3047</div>
3048
3049<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>
3050
3051<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>
3052
3053<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3054
3055
3056<div style="margin: auto;">
3057 <h4><a name="gamma" id="gamma"></a>-gamma <em class="arg">value</em></h4>
3058</div>
3059
3060<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>
3061
3062<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>
3063
3064<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>
3065
3066<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>
3067
3068<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>
3069
3070<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3071
3072<div style="margin: auto;">
3073 <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>
3074</div>
3075
3076<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>
3077
cristyb15553d2010-07-03 22:53:14 +00003078<p>Convolve the image with a Gaussian or normal distribution using the given
3079<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003080
3081<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3082</div>
3083
cristyb15553d2010-07-03 22:53:14 +00003084<p>The <em class="arg" >Sigma</em> value is the important argument, and
3085determines the actual amount of bluring that will take place. </p>
3086
3087<p>The <em class="arg" >Radius</em> is only used to determine the size of the
3088array which will hold the calculated gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003089integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003090radius that will provide meaningful results for the Gaussian distribution.
3091</p>
3092
3093<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3094operation is. However too small a <em class="arg" >Radius</em>, and sever
3095aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3096should be at least twice the <em class="arg" >Sigma</em> value, though three
3097times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003098
3099<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003100full 2-dimensional convolution is used to generate the weighted average of the
3101neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003102
3103<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3104pixels which are outside the image proper are blurred into the final result.
3105</p>
3106
3107
3108<div style="margin: auto;">
3109 <h4><a name="geometry" id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
3110</div>
3111
3112<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>
3113
3114<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>
3115
3116<div style="margin: auto;">
3117 <h4><a name="gravity" id="gravity"></a>-gravity <em class="arg">type</em></h4>
3118</div>
3119
3120<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>
3121
3122<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3123<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3124<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3125list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3126installation.</p>
3127
3128<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>
3129
3130<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>
3131
3132<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>
3133
cristy4949d522010-03-12 18:41:34 +00003134<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 +00003135<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>
3136
3137<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>
3138
3139
3140<div style="margin: auto;">
3141 <h4><a name="green-primary" id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
3142</div>
3143
3144<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>
3145
3146
3147<div style="margin: auto;">
3148 <h4><a name="hald-clut" id="hald-clut"></a>-hald-clut</h4>
3149</div>
3150
3151<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>
3152
3153<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3154dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3155can apply any color transformation to the Hald image and then use this option
3156to apply the transform to the image. </p>
3157
3158<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3159<p>This option provides a convenient method for you to use Gimp or Photoshop
3160to make color corrections to the Hald CLUT image and subsequently apply them
3161to multiple images using an ImageMagick script. </p>
3162
3163<p>Note that the representation is only of the normal RGB color space and that
3164the whole color value triplet is used for the interpolated lookup of the
3165represented Hald color cube image. Because of this the operation is not <a
3166href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3167images transparency or alpha/matte channel.</p>
3168
3169<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3170of the individual color channels, usally involving a simplier gray-scale
3171image. E.g: gray-scale to color replacement, or modification by a histogram
3172mapping. </p>
3173
3174
3175<div style="margin: auto;">
3176 <h4><a name="help" id="help"></a>-help</h4>
3177</div>
3178
3179<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>
3180
3181<div style="margin: auto;">
3182 <h4><a name="highlight-color" id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
3183</div>
3184
3185<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>
3186
3187<div style="margin: auto;">
3188 <h4><a name="iconGeometry" id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
3189</div>
3190
3191<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>
3192
3193<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>
3194
3195<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>
3196
3197<div style="margin: auto;">
3198 <h4><a name="iconic" id="iconic"></a>-iconic</h4>
3199</div>
3200
3201<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>
3202
3203<div style="margin: auto;">
3204 <h4><a name="identify" id="identify"></a>-identify</h4>
3205</div>
3206
3207<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>
3208
3209<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>
3210
3211<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>
3212
cristyd0bda5e2010-09-21 16:22:45 +00003213<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003214amounts of image properties are displayed including image statistics, profiles,
3215image histogram, and others.</p>
3216
3217<div style="margin: auto;">
3218 <h4><a name="ift" id="ift"></a>-ift</h4>
3219</div>
3220
3221<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>
3222
cristyb36feb22010-03-26 16:54:37 +00003223<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 +00003224
3225<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>
3226
3227<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3228<p>or</p>
3229
3230<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>
3231
3232<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.
3233
3234<p>The <a href="http://www.fftw.org/" target="_blank">FFTW</a> delegate library is required to use <a href="#ift">-ift</a>.
3235
3236<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.
3237
3238<div style="margin: auto;">
3239 <h4><a name="immutable" id="immutable"></a>-immutable</h4>
3240</div>
3241
3242<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>
3243
3244<div style="margin: auto;">
3245 <h4><a name="implode" id="implode"></a>-implode <em class="arg">factor</em></h4>
3246</div>
3247
3248<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>
3249
3250<div style="margin: auto;">
3251 <h4><a name="insert" id="insert"></a>-insert <em class="arg">index</em></h4>
3252</div>
3253
3254<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>
3255
3256<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>
3257
3258<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>
3259
3260<div style="margin: auto;">
3261 <h4><a name="intent" id="intent"></a>-intent <em class="arg">type</em></h4>
3262</div>
3263
3264<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>
3265
3266<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>
3267
3268<p>The default intent is undefined.</p>
3269
3270<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3271
3272<div style="margin: auto;">
3273 <h4><a name="interlace" id="interlace"></a>-interlace <em class="arg">type</em></h4>
3274</div>
3275
3276<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>
3277
3278<p>Choose from:</p>
3279
3280<pre class="text">
3281 none
3282 line
3283 plane
3284 partition
3285 JPEG
3286 GIF
3287 PNG
3288</pre>
3289
3290<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>
3291
3292<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3293
3294<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3295
3296<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3297
3298<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3299image.G, and image.B).</p>
3300
3301<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>
3302image.</p>
3303
3304<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3305
3306<div style="margin: auto;">
3307 <h4><a name="interpolate" id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
3308</div>
3309
3310<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>
3311
cristyd0bda5e2010-09-21 16:22:45 +00003312<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003313value, you typically fall in between the pixel colors defined by the source
3314image. This setting determines how the color is determined from the colors of
3315the pixels surrounding that point. That is how to determine the color of a
3316point that falls between two, or even four different colored pixels. </p>
3317
3318<pre class="text">
3319 integer: The color of the top-left pixel (floor function)
3320 nearest-neighbor: The nearest pixel to the lookup point (rounded function)
3321 average: The average color of the surrounding four pixels
3322 bilinear A double linear interpolation of pixels (the default)
3323 mesh Divide area into two flat triangular interpolations
3324 bicubic Fitted bicubic-spines of surrounding 16 pixels
3325 spline Direct spline curves (colors are blurred)
3326 filter Use resize <a href="#filter">-filter</a> settings
3327</pre>
3328
3329<p>This most important for distortion operators such as <a href="#distort"
3330>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3331>-transform</a> and <a href="#fx" >-fx</a>. </p>
3332
3333<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3334
3335<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3336lookup for positions outside the boundaries of the image. </p>
3337
3338
3339<div style="margin: auto;">
cristyf3bb4782009-09-08 13:10:04 +00003340 <h4><a name="interline-spacing" id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
3341</div>
3342
3343<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>
3344
3345<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00003346 <h4><a name="interword-spacing" id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
3347</div>
3348
3349<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>
3350
3351<div style="margin: auto;">
3352 <h4><a name="kerning" id="kerning"></a>-kerning <em class="arg">value</em></h4>
3353</div>
3354
3355<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>
3356
3357<div style="margin: auto;">
3358 <h4><a name="label" id="label"></a>-label <em class="arg">name</em></h4>
3359</div>
3360
3361<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>
3362
cristy71a3f602010-09-15 12:38:16 +00003363<p>Use this option to assign a specific label to the image, as it is read in
3364or created. You can use the <a href="#set" >-set</a> operation to re-assign
3365a the labels of images already read in. Image formats such as TIFF, PNG,
3366MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003367
cristy71a3f602010-09-15 12:38:16 +00003368<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3369assigned to an image is used as a header string to print above the postscript
3370image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003371
cristybc9539a2010-08-16 18:06:20 +00003372<p>You can include the image filename, type, width, height, or other image
3373attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3374Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003375
3376<p>For example,</p>
3377
3378<p class="crtsnip">
3379 -label "%m:%f %wx%h" bird.miff
3380</p>
3381
cristy71a3f602010-09-15 12:38:16 +00003382<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3383"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3384is read in. If a <a href="#label">+label</a> option was used instead, any
3385existing label present in the image would be used. You can remove all labels
3386from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003387
cristy71a3f602010-09-15 12:38:16 +00003388<p>A label is not drawn on the image, but is embedded in the image datastream
3389via <em>Label</em> tag or similar mechanism. If you want the label to be
3390visible on the image itself, use the <a href="#draw">-draw</a> option, or
3391during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003392
cristy71a3f602010-09-15 12:38:16 +00003393<p>If the first character of <em class="arg">string</em> is <em
3394class="arg">@</em>, the image label is read from a file titled by the
3395remaining characters in the string. Labels in a file are literal, no embedded
3396formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003397
3398
3399<div style="margin: auto;">
3400 <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>
3401</div>
3402
3403<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>
3404
3405<p>Adaptively threshold each pixel based on the value of pixels in a
3406surrounding window. If the current pixel is lighter than this average plus
3407the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3408black. Small variations in pixel values such as found in scanned documents
3409can be ignored if offset is positive. A negative offset will make it more
3410sensitive to those small variations. </p>
3411
3412<p>This is commonly used to threshold images with an uneven background. It is
3413based on the assumption that average color of the small window is the
3414the local background color, from which to separate the forground color. </p>
3415
3416
3417<div style="margin: auto;">
3418 <h4><a name="layers" id="layers"></a>-layers <em class="arg">method</em></h4>
3419</div>
3420
3421<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>
3422
3423<p>Perform various image operation methods to a ordered sequence of images
3424which may represent either a set of overlaid 'image layers', a GIF disposal
3425animation, or a fully-'coalesced' animation sequence. </p>
3426
3427<table class="doc">
3428 <tbody>
3429 <tr valign="top">
3430 <th align="left" style="width: 8%">Method</th>
3431 <th align="left">Description</th>
3432 </tr>
3433
3434 <tr valign="top">
3435 <td valign="top">compare-any</td>
3436 <td valign="top">Crop the second and later frames to the smallest rectangle
3437 that contains all the differences between the two images. No GIF <a
3438 href="#dispose" >-dispose</a> methods are taken into account. </td>
3439 </tr>
3440
3441 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3442 >-deconstruct</a> operator, and does not preserve animations normal
3443 working, especially when animation used layer disposal methods such as
3444 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3445 </tr>
3446
3447 <tr valign="top">
3448 <td valign="top">compare-clear</td>
3449 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3450 opaque pixels which become transparent in the second frame. That is the
3451 smallest image needed to mask or erase pixels for the next frame. </td>
3452 </tr>
3453
3454 <tr valign="top">
3455 <td valign="top">compare-overlay</td>
3456 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3457 extra color to the next image, as a result of overlaying color pixels.
3458 That is the smallest single overlaid image to add or change colors. </td>
3459 </tr>
3460
3461 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3462 composition method '<kbd>change-mask</kbd>', to reduce the image to
3463 just the pixels that need to be overlaid. </td>
3464 </tr>
3465
3466 <tr valign="top">
3467 <td valign="top">coalesce</td>
3468 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3469 >-coalesce</a> operator. Apply the layer disposal methods set in the
3470 current image sequence to form a fully defined animation sequence, as
3471 it should be displayed. Effectively converting a GIF animation into a
3472 'film strip'-like animation. </td>
3473 </tr>
3474
3475 <tr valign="top">
3476 <td valign="top">composite</td>
3477 <td valign="top">Alpha Composition of two image lists, separated by a
3478 "<kbd>null:</kbd>" image, with the destination image list first, and
3479 the source images last. An image from each list are composited
3480 together until one list is finished. The separator image and source
3481 image lists are removed. </td>
3482 </tr>
3483
3484
cristybac7a162010-06-15 19:57:29 +00003485 <tr><td></td>
3486 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3487 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3488 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003489 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003490 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003491
cristybac7a162010-06-15 19:57:29 +00003492 <tr><td></td>
3493 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003494 applied to all the images in the other image list, regardless of which
3495 list it is. In this case it is the image meta-data of the list which
3496 preserved. </td>
3497 </tr>
3498
3499
3500 <tr valign="top">
3501 <td valign="top">dispose</td>
3502 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3503 the animation after the layer disposal method has been applied, before
3504 the next sub-frame image is overlaid. That is the 'dispose' image that
3505 results from the application of the GIF <a href="#dispose"
3506 >-dispose</a> method. This allows you to check what
3507 is going wrong with a particular animation you may be developing.
3508 </td>
3509 </tr>
3510
3511 <tr valign="top">
3512 <td valign="top">flatten</td>
3513 <td valign="top">Create a canvas the size of the first images virtual
3514 canvas using the current <a href="#background" >-background</a> color,
3515 and <a href="#compose" >-compose</a> each image in turn onto that
3516 canvas. Images falling outside that canvas is clipped. Final
3517 image will have a zero virtual canvas offset. </td>
3518 </tr>
3519
cristybac7a162010-06-15 19:57:29 +00003520 <tr><td></td>
3521 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003522 overlaying all the prepared image layers into a final image. </td>
3523 </tr>
3524
cristybac7a162010-06-15 19:57:29 +00003525 <tr><td></td>
3526 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003527 canvas with real pixels, or to underlay a opaque color to remove
3528 transparency from an image.</td>
3529 </tr>
3530
3531
3532 <tr valign="top">
3533 <td valign="top">merge</td>
3534 <td valign="top">As 'flatten' method but merging all the given image
3535 layers into a new layer image just large enough to hold all the image
3536 without clipping or extra space. The new images virtual offset will
3537 prevere the position of the new layer, even if this offset is
3538 negative. the virtual canvas size of the first image is preserved.
3539 </td>
3540 </tr>
3541
3542 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3543 as few image file formats handle them correctly. </td>
3544 </tr>
3545
3546 <tr valign="top">
3547 <td valign="top">mosaic</td>
3548 <td valign="top">As 'flatten' method but expanding the initial canvas size
3549 of the first image so as to hold all the image layers. However as a
cristyd0bda5e2010-09-21 16:22:45 +00003550 virtual canvas is 'locked' to the origin, by definition, image layers
cristy3ed852e2009-09-05 21:47:34 +00003551 with a negative offsets will still be clipped by the top and left
3552 edges.</td>
3553 </tr>
3554
3555 <tr><td></td><td>This method is commonly used to layout individual image using various
cristyd0bda5e2010-09-21 16:22:45 +00003556 offset but without knowing the final canvas size. The resulting image
cristy3ed852e2009-09-05 21:47:34 +00003557 will, like 'flatten' not have any virtual offset, so can be saved to
3558 any image file format. </td>
3559 </tr>
3560
3561
3562 <tr valign="top">
3563 <td valign="top">optimize</td>
3564 <td valign="top">Optimize a coalesced animation, into GIF animation using
3565 a number of general techniques. This currently a short cut to
3566 apply both the '<kbd>optimize-frame</kbd>', and
3567 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3568 include other optimization methods as they are developed. </td>
3569 </tr>
3570
3571 <tr valign="top">
3572 <td valign="top">optimize-frame</td>
3573 <td valign="top">Optimize a coalesced animation, into GIF animation by
3574 reducing the number of pixels per frame as much as possible by
3575 attempting to pick the best layer disposal method to use, while ensuring
3576 the result will continue to animate properly. </td>
3577 </tr>
3578
3579 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3580 then no reasonably fast GIF optimization algorithm can do this.
3581 However this does seem to do better than most other GIF frame
3582 optimizers seen. </td>
3583 </tr>
3584
3585 <tr valign="top">
3586 <td valign="top">optimize-plus</td>
3587 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3588 overall optimization by adding extra frames to the animation, without
3589 changing the final look or timing of the animation. The frames are
3590 added to attempt to separate the clearing of pixels from the
3591 overlaying of new additional pixels from one animation frame to the
3592 next. If this does not improve the optimization (for the next frame
3593 only), it will fall back to the results of the previous normal
3594 '<kbd>optimize-frame</kbd>' technique. </td>
3595 </tr>
3596
3597 <tr><td></td><td>There is the possibility that the change in the disposal style will
3598 result in a worsening in the optimization of later frames, though this
3599 is unlikely. In other words there no guarantee that it is better than
3600 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
cristyd0bda5e2010-09-21 16:22:45 +00003601 however you can get a vast improvement in the final animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003602 </tr>
3603
3604 <tr valign="top">
3605 <td valign="top">optimize-transparency</td>
3606 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3607 overlay images with transparency, if it does not change the resulting
3608 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3609 </td>
3610 </tr>
3611
3612 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3613 into a smaller file size due to larger areas of one (transparent)
3614 color rather than a pattern of multiple colors repeating the current
3615 disposed image of the last frame. </td>
3616 </tr>
3617
3618 <tr valign="top">
3619 <td valign="top">remove-dups</td>
3620 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3621 images, so as to simplify layer overlays of coalesced animations.
3622 </td>
3623 </tr>
3624
3625 <tr><td></td><td>Usually this a result of using a constant time delay across the
3626 whole animation, or after a larger animation was split into smaller
3627 sub-animations. The duplicate frames could also have been used as
3628 part of some frame optimization methods. </td>
3629 </tr>
3630
3631 <tr valign="top">
3632 <td valign="top">remove-zero</td>
3633 <td valign="top">Remove any image with a zero time delay, unless ALL the
3634 images have a zero time delay (and is not a proper timed animation, a
3635 warning is then issued). </td>
3636 </tr>
3637
3638 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3639 partial intermediary updates between the frames that are actually
3640 displayed to users. These frames are usally added for improved frame
3641 optimization in GIF animations. </td>
3642 </tr>
3643
3644 <tr valign="top">
3645 <td valign="top">trim-bounds</td>
3646 <td valign="top">Find the bounds of all the images in the current
3647 image sequence, then adjust the offsets so all images are contained on
3648 a minimal positive canvas. None of the image data is modified, only
3649 there virtual canvas size and offset. The all the image is given
3650 the same canvas size, and and will have a positive offset, but will
3651 remain in the same position relative to each other. As a result of the
3652 minimal canvas size at least one image will touch every edge of that
3653 canvas. The image data however may be transparent.
3654 </td>
3655 </tr>
3656
3657 </tbody>
3658</table>
3659
3660<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3661
3662<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3663>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3664>-mosaic</a> are only aliases for the above methods. Also see <a
3665href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3666href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3667>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3668
3669
3670<div style="margin: auto;">
3671 <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>
3672</div>
3673
3674<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>
3675
3676<p>Given one, two or three values delimited with commas: black-point,
3677white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3678white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3679point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3680contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3681both black and white points are percentages of the full color range. Gamma
3682will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3683omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3684
3685<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3686the given '<kbd>black_point</kbd>' value in the original image is set to
3687zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3688<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3689to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3690adjusted. </p>
3691
3692<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3693adding the special '!' flag anywhere in the argument list, will cause the
3694operator to do the reverse of the level adjustment. That is a zero, or
3695<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
3696adjusted to the given level values, allowing you to de-contrast, or compress
3697the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
3698
3699<p>Only the channels defined by the current <a href="#channel">-channel</a>
3700setting are adjusted (defaults to RGB color channels only), allowing you to
3701limit the effect of this operator. </p>
3702
3703<p>Please note that the transparency channel is treated as 'matte'
3704values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
3705
3706
3707<div style="margin: auto;">
3708 <h4><a name="level-colors" id="level-colors"></a>-level-colors {<em
3709 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
3710</div>
3711
cristyd0bda5e2010-09-21 16:22:45 +00003712<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 separated colors.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00003713
3714<p>This function is exactly like <a href="#level">-level</a>, except that the
3715value value for each color channel is determined by the
3716'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
3717described under the <a href="#fill">-fill</a> option). </p>
3718
cristyd0bda5e2010-09-21 16:22:45 +00003719<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
3720is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00003721colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00003722adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00003723
3724<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
3725will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00003726respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00003727those colors. This can also be used to convert a plain gray-scale image into a
3728one using the gradient of colors specified. </p>
3729
3730<p>By supplying a single color with a comma separator either before or after
3731that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00003732respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00003733used for both the black and white color points, making the operator either
3734threshold the images around that color (- form) or set all colors to that
3735color (+ form). </p>
3736
3737
3738<div style="margin: auto;">
3739 <h4><a name="limit" id="limit"></a>-limit <em class="arg">type value</em></h4>
3740</div>
3741
3742<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>
3743
3744<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>
3745
cristy6b636652009-12-05 17:16:11 +00003746<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 +00003747
3748<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00003749 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00003750</p>
3751
3752<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
3753
cristy6b636652009-12-05 17:16:11 +00003754<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
3755------------------------------------------------------------------------------
3756 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited</pre>
cristy3ed852e2009-09-05 21:47:34 +00003757</span></p>
3758<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>
3759
3760<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>
3761
3762<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>
3763
3764<p class="crtsnip">
3765-limit area 10mb
3766</p>
3767
cristyd0bda5e2010-09-21 16:22:45 +00003768<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 inadvertently upload a huge image to process, you should set a disk limit as well:</p>
cristy3ed852e2009-09-05 21:47:34 +00003769
3770<p class="crtsnip">
3771-limit area 10mb -limit disk 500mb
3772</p>
3773
3774<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
3775
3776<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>
3777
3778<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.
3779</p>
3780
3781<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.
3782</p>
3783
3784<div style="margin: auto;">
3785 <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>
3786</div>
3787
3788<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>
3789
cristyd934d102009-10-10 12:55:13 +00003790<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
3791and uses a 'histogram bin' to determine the range of color values that needs to
3792be stretched. However it then stretchs those colors using the <a
3793href="#level" >-level</a> operator.</p>
3794
3795<p>As such while the initial determination may have 'binning' round off
3796effects, the image colors are stretched mathematically, rather than using the
3797histogram bins. This makes the operator more accurate. </p>
3798
3799<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
3800'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
3801perfect stretch of the color range. </p>
3802
3803<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
3804normalization of mathematical images. </p>
3805
3806<p>This operator is under review for re-development. </p>
3807
3808
cristy3ed852e2009-09-05 21:47:34 +00003809<div style="margin: auto;">
3810 <h4><a name="linewidth" id="linewidth"></a>-linewidth</h4>
3811</div>
3812
3813<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>
3814
3815<div style="margin: auto;">
3816 <h4><a name="liquid-rescale" id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
3817</div>
3818
3819<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>
3820
3821<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>
3822
3823<div style="margin: auto;">
3824 <h4><a name="list" id="list"></a>-list <em class="arg">type</em></h4>
3825</div>
3826
3827<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>
3828
3829<pre class="text">
cristyc1aee832010-05-08 00:36:47 +00003830 Align
3831 Alpha
3832 Boolean
3833 Channel
3834 Class
3835 ClipPath
3836 Coder
3837 Color
3838 Colorspace
3839 Command
3840 Compose
3841 Compress
3842 Configure
3843 DataType
3844 Debug
3845 Decoration
3846 Delegate
3847 Direction
3848 Dispose
3849 Distort
3850 Dither
3851 Endian
3852 Evaluate
3853 FillRule
3854 Filter
3855 Font
3856 Format
3857 Function
3858 Gravity
3859 ImageList
3860 Intent
3861 Interlace
3862 Interpolate
3863 Kernel
cristy787d4352010-03-06 13:55:58 +00003864 Layers
3865 LineCap
3866 LineJoin
3867 List
3868 Locale
3869 LogEvent
3870 Log
3871 Magic
3872 Method
3873 Metric
3874 Mime
3875 Mode
3876 Morphology
3877 Module
3878 Noise
3879 Orientation
3880 Policy
3881 PolicyDomain
3882 PolicyRights
3883 Preview
3884 Primitive
3885 QuantumFormat
3886 Resource
3887 SparseColor
3888 Storage
3889 Stretch
3890 Style
3891 Threshold
3892 Type
3893 Units
3894 Validate
3895 VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00003896</pre>
3897
cristybac7a162010-06-15 19:57:29 +00003898<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
3899list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
3900available:</p>
cristy3ed852e2009-09-05 21:47:34 +00003901
3902<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
3903<div style="margin: auto;">
3904 <h4><a name="log" id="log"></a>-log <em class="arg">string</em></h4>
3905</div>
3906
3907<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>
3908
cristybac7a162010-06-15 19:57:29 +00003909<p>This option specifies the format for the log printed when the <a
3910href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00003911
cristybac7a162010-06-15 19:57:29 +00003912<p>You can display the following components by embedding special format
3913characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00003914
3915<pre class="text">
3916 %d domain
3917 %e event
3918 %f function
3919 %l line
3920 %m module
3921 %p process ID
3922 %r real CPU time
3923 %t wall clock time
3924 %u user CPU time
3925 %% percent sign
3926 \n newline
3927 \r carriage return
3928</pre>
3929
3930<p>For example:</p>
3931
3932<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>
3933<p>The default behavior is to print all of the components.</p>
3934
3935<div style="margin: auto;">
3936 <h4><a name="loop" id="loop"></a>-loop <em class="arg">iterations</em></h4>
3937</div>
3938
3939<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>
3940
cristybac7a162010-06-15 19:57:29 +00003941<p>Set iterations to zero to repeat the animation an infinite number of times,
3942otherwise the animation repeats itself up to <em class="arg">iterations</em>
3943times.</p>
cristy3ed852e2009-09-05 21:47:34 +00003944
3945<div style="margin: auto;">
3946 <h4><a name="lowlight-color" id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
3947</div>
3948
3949<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>
3950
3951<div style="margin: auto;">
3952 <h4><a name="magnify" id="magnify"></a>-magnify <em class="arg">factor</em></h4>
3953</div>
3954
3955<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>
3956
3957
3958<div style="margin: auto;">
3959 <h4><a name="map" id="map"></a>-map <em class="arg">type</em></h4>
3960</div>
3961
3962<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>
3963
3964<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
3965
3966<pre class="text">
3967 best
3968 default
3969 gray
3970 red
3971 green
3972 blue
3973</pre>
3974
cristybac7a162010-06-15 19:57:29 +00003975<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
3976Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
3977the type and <kbd>display</kbd> searches the list of colormap types in
3978<kbd>top-to-bottom</kbd> order until one is located. See <em
3979class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00003980
3981
3982<div style="margin: auto;">
3983 <h4><a name="map_stream_" id="map_stream_"></a>-map <em class="arg">components</em></h4>
3984</div>
3985
3986<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>
3987
3988<p>Here are the valid components of a map:</p>
3989
3990<pre class="text">
3991 r red pixel component
3992 g green pixel component
3993 b blue pixel component
3994 a alpha pixel component (0 is transparent)
3995 o opacity pixel component (0 is opaque)
3996 i grayscale intensity pixel component
3997 c cyan pixel component
3998 m magenta pixel component
3999 y yellow pixel component
4000 k black pixel component
4001 p pad component (always 0)
4002</pre>
4003
cristybac7a162010-06-15 19:57:29 +00004004<p>You can specify as many of these components as needed in any order (e.g.
4005bgr). The components can repeat as well (e.g. rgbr).</p>
4006
cristy3ed852e2009-09-05 21:47:34 +00004007
4008<div style="margin: auto;">
4009 <h4><a name="mask" id="mask"></a>-mask
4010<em class="arg">filename</em></h4>
4011</div>
4012
4013<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>
4014
4015<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
4016
4017<div style="margin: auto;">
4018 <h4><a name="mattecolor" id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
4019</div>
4020
4021<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>
4022
4023<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4024
cristybac7a162010-06-15 19:57:29 +00004025<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4026style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004027
4028<div style="margin: auto;">
cristyd2baf7d2010-03-06 04:26:44 +00004029 <h4><a name="maximum" id="maximum"></a>-maximum</h4>
4030</div>
4031
4032<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>
4033
4034<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004035 <h4><a name="median" id="median"></a>-median <em class="arg">radius</em></h4>
4036</div>
4037
4038<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>
4039
4040<div style="margin: auto;">
4041 <h4><a name="metric" id="metric"></a>-metric <em class="arg">type</em></h4>
4042</div>
4043
4044<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>
4045
4046<p>Choose from:</p>
4047
4048<pre class="text">
cristybac7a162010-06-15 19:57:29 +00004049 AE absolute error count, number of different pixels (-fuzz effected)
4050 MAE mean absolute error (normalized), average channel error distance
4051 MEPP mean error per pixel (normalized mean error, normalized peak error)
4052 MSE mean error squared, average of the channel error squared
4053 PAE peak absolute (normalize peak absolute)
4054 PSNR peak signal to noise ratio
4055 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004056</pre>
4057
4058<p>The '<kbd>AE</kbd>' or absolute count of pixels that are different, can be
cristyd0bda5e2010-09-21 16:22:45 +00004059controlled using a <a href="#fuzz" >-fuzz</a> factor to ignore pixels which
cristy3ed852e2009-09-05 21:47:34 +00004060only changed by a small amount. The '<kbd>PAE</kbd>' can be used to find the
4061size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristybac7a162010-06-15 19:57:29 +00004062'similar', while '<kbd>MAE</kbd>' can be used to find out the factor needed
4063for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004064
4065<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4066('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004067normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004068
cristybac7a162010-06-15 19:57:29 +00004069<p>To print a complete list of metrics, use the <a href="#list">-list
4070metrics</a> option.</p>
4071
cristy3ed852e2009-09-05 21:47:34 +00004072
cristyd2baf7d2010-03-06 04:26:44 +00004073<div style="margin: auto;">
4074 <h4><a name="minimum" id="minimum"></a>-minimum</h4>
4075</div>
4076
4077<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>
4078
cristy3ed852e2009-09-05 21:47:34 +00004079
4080<div style="margin: auto;">
4081 <h4><a name="mode" id="mode"></a>-mode <em class="arg">value</em></h4>
4082</div>
4083
4084<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>
4085
cristybac7a162010-06-15 19:57:29 +00004086<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4087Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004088
cristybac7a162010-06-15 19:57:29 +00004089<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4090for a list of <a href="#mode" >-mode</a> arguments available in your
4091ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004092
4093
4094<div style="margin: auto;">
4095 <h4><a name="modulate" id="modulate"></a>-modulate <em class="arg">brightness</em>[,<em class="arg">saturation</em>,<em class="arg">hue</em>]</h4>
4096</div>
4097
cristybac7a162010-06-15 19:57:29 +00004098<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
4099class="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 +00004100
cristyb36feb22010-03-26 16:54:37 +00004101<p>The arguments are given as a percentages of variation. A value of 100 means
4102no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004103
cristyb36feb22010-03-26 16:54:37 +00004104<p>The <em class="arg">brightness</em> is a multiplier of the overall
4105brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4106twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4107before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004108
cristyb36feb22010-03-26 16:54:37 +00004109<p>The <em class="arg">saturation</em> controls the amount of color in an
4110image. For example, 0 produce a grayscale image, while a large value such as
4111200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004112
cristyb36feb22010-03-26 16:54:37 +00004113<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4114within the image by the amount specified. For example, 50 results in
4115a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4116A value of either 0 or 200 results in a complete 180 degree rotation of the
4117image. Using a value of 300 is a 360 degree rotation resulting in no change to
4118the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004119
cristyb36feb22010-03-26 16:54:37 +00004120<p>For example, to increase the color brightness by 20% and decrease the color
4121saturation by 10% and leave the hue unchanged, use <a
4122href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004123
cristyb36feb22010-03-26 16:54:37 +00004124<p>Use <a href="#set">-set</a> attribute of '<kbd
4125class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4126modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4127<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004128
4129<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 +00004130
cristy3ed852e2009-09-05 21:47:34 +00004131<div style="margin: auto;">
4132 <h4><a name="monitor" id="monitor"></a>-monitor</h4>
4133</div>
4134
4135<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>
4136
4137
4138<div style="margin: auto;">
4139 <h4><a name="monochrome" id="monochrome"></a>-monochrome</h4>
4140</div>
4141
4142<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>
4143
4144
4145<div style="margin: auto;">
4146 <h4><a name="morph" id="morph"></a>-morph <em class="arg">frames</em></h4>
4147</div>
4148
4149<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>
4150
4151<p>Both the image pixels and size are linearly interpolated to give the
4152appearance of a meta-morphosis from one image to the next, over all the images
4153in the current image list. The added images are the equivalent of a <a
4154href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4155argument determine how many images to interpolate between each image. </p>
4156
4157
4158<div style="margin: auto;">
cristy488844c2010-01-22 14:02:05 +00004159 <h4><a name="morphology" id="morphology"></a>-morphology</h4>
4160 <h4><a name="morphology" id="morphology"></a>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
4161</div>
4162
cristy2c839602010-04-03 02:32:08 +00004163<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 +00004164
cristy83a272e2010-05-07 20:40:35 +00004165Until I get around to writing a option summary for this, see <A
4166HREF="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4167Morphology</A>. </P>
4168
4169
cristy488844c2010-01-22 14:02:05 +00004170<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004171 <h4><a name="mosaic" id="mosaic"></a>-mosaic</h4>
4172</div>
4173
4174<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>
4175
4176
4177<div style="margin: auto;">
4178 <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>
4179</div>
4180
4181<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>
4182
4183<p>Blur with the given radius, standard deviation (sigma), and angle. The
4184angle given is the angle toward which the image is blurred. That is the
4185direction people would consider the object is coming from. </p>
4186
4187<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004188definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004189
4190<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4191pixels which are outside the image proper are blurred into the final result.
4192</p>
4193
4194<div style="margin: auto;">
4195 <h4><a name="name" id="name"></a>-name</h4>
4196</div>
4197
4198<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>
4199<div style="margin: auto;">
4200 <h4><a name="negate" id="negate"></a>-negate</h4>
4201</div>
4202
cristyb29bc032010-02-01 20:29:43 +00004203<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 +00004204
4205<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>
4206
4207<div style="margin: auto;">
4208 <h4><a name="noise" id="noise"></a>-noise <em class="arg">radius</em><br/>
4209 +noise <em class="arg">type</em></h4>
4210</div>
4211
4212<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>
4213
4214<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>
4215
4216<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>
4217
4218<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>
4219
4220<pre class="text">
4221Gaussian
4222Impulse
4223Laplacian
4224Multiplicative
4225Poisson
4226Random
4227Uniform
4228</pre>
4229
4230<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4231
cristy83543962009-10-16 19:04:28 +00004232<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4233the use of a controlling value to specify teh amount of noise that should be
4234added to an image. </p>
4235
cristy3ed852e2009-09-05 21:47:34 +00004236
4237<div style="margin: auto;">
4238 <h4><a name="normalize" id="normalize"></a>-normalize</h4>
4239</div>
4240
4241<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>
4242
cristyd934d102009-10-10 12:55:13 +00004243<p>The intensity values are stretched to cover the entire range of possible
4244values. While doing so, black-out at most <em>2%</em> of the pixels and
4245white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004246
cristyd934d102009-10-10 12:55:13 +00004247<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4248is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4249(Before this version, it was equivalent to <a href="#contrast-stretch"
4250>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004251
cristyd934d102009-10-10 12:55:13 +00004252<p>All the channels are normalized in concert by the came amount so as to
4253preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004254setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004255setting will normalize the RGB channels independently.</p>
4256
4257<p>See <a href="#contrast-stretch" >-contrast-stretch</A> for more details.
4258Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004259that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004260
4261<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004262
4263
4264<div style="margin: auto;">
4265 <h4><a name="ordered-dither" id="ordered-dither"></a>-ordered-dither <em class="arg">threshold_map</em>{,<em class="arg">level</em>...}</h4>
4266</div>
4267
cristyd934d102009-10-10 12:55:13 +00004268<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
4269class="arg">threshold map</em> specified, and a uniform color map with the
4270given 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 +00004271
4272<p>You can choose from these standard threshold maps:</p>
4273
4274<pre class="text">
cristyd934d102009-10-10 12:55:13 +00004275 threshold
cristy3ed852e2009-09-05 21:47:34 +00004276 checks
4277 o2x2
4278 o3x3
4279 o4x4
4280 o8x8
4281 h4x4a
4282 h6x6a
4283 h8x8a
4284 h4x4o
4285 h6x6o
4286 h8x8o
4287 h16x16o
4288</pre>
4289
cristyd934d102009-10-10 12:55:13 +00004290<p>The '<kbd>o</kbd>' maps are ordered diffused pixel threshold maps, while the
4291'<kbd>h</kbd>' maps are halftone threshold maps which are either 'a' angled, or
4292'o' orthogonal. The '<kbd>checks</kbd>' produce a 3 level checkerbord dither
4293pattern. Or you can define your own <em class="arg" >threshold map</em> in a
4294personal or system "<kbd>thresholds.xml</kbd>" XML file. </p>
cristy3ed852e2009-09-05 21:47:34 +00004295
cristyd934d102009-10-10 12:55:13 +00004296<p>To print a complete list of threshold, use the <a href="#list" >-list
4297threshold</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004298
cristyd934d102009-10-10 12:55:13 +00004299<p>It is recommended that the <a href="#map" >+map</a> operator be used after
4300applying <a href="#ordered-dither" >-ordered-dither</a> to reduce the number of
cristy3ed852e2009-09-05 21:47:34 +00004301colors an animated image sequence, to less that 256 colors. This ensures that
4302a common or global color table is used when saving the result to a color
4303limited file format such as GIF. </p>
4304
cristyd934d102009-10-10 12:55:13 +00004305<p>Note that at this time the exact same threshold dithering map is used for
4306all color channels, no attempt is made to offset or rotate the map for
4307different channels is made, to create an offset printing effect. (possible
4308future expansion) </p>
cristy3ed852e2009-09-05 21:47:34 +00004309
4310
4311<div style="margin: auto;">
4312 <h4><a name="opaque" id="opaque"></a>-opaque <em class="arg">color</em></h4>
4313</div>
4314
4315<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>
4316
cristyc54f5d42009-11-27 21:36:31 +00004317<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004318described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4319>-fuzz</a> setting can be used to match and replace colors similar to the one
4320given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004321
cristyb36feb22010-03-26 16:54:37 +00004322<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4323the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004324
cristyb36feb22010-03-26 16:54:37 +00004325<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4326as <a href="#opaque" >-opaque</a> but replaces the matching color with
4327transparency rather than the current <a href="#fill">-fill</a> color setting.
4328To ensure that it can do this it also ensures that the image has an alpha
4329channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4330the new transparent colors, and does not require you to modify the <a
4331href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004332
cristy3ed852e2009-09-05 21:47:34 +00004333
4334<div style="margin: auto;">
4335 <h4><a name="orient" id="orient"></a>-orient <em class="arg">image orientation</em></h4>
4336</div>
4337
4338<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>
4339
4340<p>Choose from these orientations:</p>
4341
4342<pre class="text">
4343 bottom-left
4344 bottom-right
4345 left-bottom
4346 left-top
4347 right-bottom
4348 right-top
4349 top-left
4350 top-right
4351 undefined
4352</pre>
4353
cristyd934d102009-10-10 12:55:13 +00004354<p>To print a complete list of orientations, use the <a href="#list" >-list
4355orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004356
4357
4358<div style="margin: auto;">
4359 <h4><a name="page" id="page"></a>-page <em class="arg">geometry</em><br/>
4360 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4361 +page
4362 </h4>
4363</div>
4364
4365<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>
4366
4367<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>
4368
4369<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>
4370
4371<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>
4372<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4373<thead>
4374 <tr valign="top">
4375 <th align="center"><em class="arg">media</em></th>
4376 <th align="center"><em class="arg">width</em></th>
4377 <th align="center"><em class="arg">height</em></th>
4378 </tr>
4379</thead>
4380<tbody>
4381<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4382<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4383<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4384<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4385<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4386<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4387<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4388<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4389<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4390<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4391<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4392<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4393<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4394<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4395<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4396<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4397<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4398<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4399<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4400<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4401<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4402<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4403<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4404<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4405<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4406<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4407<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4408<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4409<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4410<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4411<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4412<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4413<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4414<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4415<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4416<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4417<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4418<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4419</tbody>
4420</table>
4421
4422
4423
4424
4425<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>
4426
4427<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>
4428
4429<p>The default page dimensions for a TEXT image is 612x792.</p>
4430
4431<p>This option is used in concert with <a href="#density">-density</a>.</p>
4432
4433<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4434
4435<div style="margin: auto;">
4436 <h4><a name="paint" id="paint"></a>-paint <em class="arg">radius</em></h4>
4437</div>
4438
4439<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>
4440
4441<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>
4442
4443<div style="margin: auto;">
4444 <h4><a name="path" id="path"></a>-path <em class="arg">path</em></h4></div>
4445
4446<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>
4447
4448<div style="margin: auto;">
4449 <h4><a name="pause_animate_" id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
4450</div>
4451
4452<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>
4453
4454<p>Pause for the specified number of seconds before repeating the animation.</p>
4455
4456<div style="margin: auto;">
4457 <h4><a name="pause_import_" id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
4458</div>
4459
4460<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>
4461
4462<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4463
4464<div style="margin: auto;">
4465 <h4><a name="ping" id="ping"></a>-ping</h4>
4466</div>
4467
4468<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>
4469
4470<div style="margin: auto;">
4471 <h4><a name="pointsize" id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
4472</div>
4473
4474<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>
4475
4476<div style="margin: auto;">
4477 <h4><a name="polaroid" id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
4478</div>
4479
4480<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>
4481
4482<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4483
4484<div style="margin: auto;">
4485 <h4><a name="posterize" id="posterize"></a>-posterize <em class="arg">levels</em></h4>
4486</div>
4487
4488<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>
4489
4490<div style="margin: auto;">
cristyd43a46b2010-01-21 02:13:41 +00004491 <h4><a name="precision" id="precision"></a>-precision <em class="arg">value</em></h4>
4492</div>
4493
4494<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>
4495
4496<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004497 <h4><a name="preview" id="preview"></a>-preview <em class="arg">type</em></h4>
4498</div>
4499
4500<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>
4501
4502<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>
4503
4504<pre class="text">
4505 Rotate
4506 Shear
4507 Roll
4508 Hue
4509 Saturation
4510 Brightness
4511 Gamma
4512 Spiff
4513 Dull
4514 Grayscale
4515 Quantize
4516 Despeckle
4517 ReduceNoise
4518 Add Noise
4519 Sharpen
4520 Blur
4521 Threshold
4522 EdgeDetect
4523 Spread
4524 Shade
4525 Raise
4526 Segment
4527 Solarize
4528 Swirl
4529 Implode
4530 Wave
4531 OilPaint
4532 CharcoalDrawing
4533 JPEG
4534</pre>
4535
4536<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4537
4538<p>The default preview is <kbd>JPEG</kbd>.</p>
4539
4540<div style="margin: auto;">
4541 <h4><a name="print" id="print"></a>-print <em class="arg">string</em></h4>
4542</div>
4543
4544<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>
4545
4546<div style="margin: auto;">
4547 <h4><a name="process" id="process"></a>-process <em class="arg">command</em></h4>
4548</div>
4549
4550<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>
4551
4552<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>
4553
4554<div style="margin: auto;">
4555 <h4><a name="profile" id="profile"></a>-profile <em class="arg">filename</em><br/>
4556 +profile <em class="arg">profile_name</em></h4>
4557</div>
4558
4559<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>
4560
4561<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>
4562
4563<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>
4564
4565<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>
4566
4567<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>
4568
4569<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4570
4571<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4572<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>
4573
4574<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>
4575<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4576CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4577</p>
4578
4579<div style="margin: auto;">
4580 <h4><a name="quality" id="quality"></a>-quality <em class="arg">value</em></h4>
4581</div>
4582
4583<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>
4584
cristy851dbce2010-08-06 21:40:00 +00004585<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 +00004586
4587<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>
4588
cristy851dbce2010-08-06 21:40:00 +00004589<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 +00004590
cristy3c98a4f2010-08-13 20:09:41 +00004591<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 +00004592
4593<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4594
4595<pre class="text">
4596 0: none
4597 1: sub
4598 2: up
4599 3: average
4600 4: Paeth
4601</pre>
4602
4603<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>
4604
4605<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4606
4607<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>
4608
cristy3c98a4f2010-08-13 20:09:41 +00004609<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 +00004610
4611<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4612
cristy3ed852e2009-09-05 21:47:34 +00004613<div style="margin: auto;">
4614 <h4><a name="quantize" id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
4615</div>
4616
cristy3c98a4f2010-08-13 20:09:41 +00004617<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 +00004618
cristy3c98a4f2010-08-13 20:09:41 +00004619<p>This setting defines the colorspace used to sort out and reduce the number
4620of colors needed by an image (for later dithering) by operators such as <a
4621href="#colors" >-colors</a>, Note that color reducion also happens
4622automatically when saving images to color-limited image file formats, such as
4623GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004624
4625
4626<div style="margin: auto;">
4627 <h4><a name="quiet" id="quiet"></a>-quiet</h4>
4628</div>
4629
4630<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>
4631
4632<div style="margin: auto;">
4633 <h4><a name="radial-blur" id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
4634</div>
4635
4636<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>
4637
4638<p>Note that this is actually a rotational blur rather than a radial and as
4639such actually mis-named. </p>
4640
4641<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4642pixels which are outside the image proper are blurred into the final result.
4643</p>
4644
4645
4646<div style="margin: auto;">
4647 <h4><a name="raise" id="raise"></a>-raise <em class="arg">thickness</em></h4>
4648</div>
4649
4650<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>
4651
4652<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>.
4653</p>
4654
4655<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4656
4657<div style="margin: auto;">
4658 <h4><a name="random-threshold" id="random-threshold"></a>-random-threshold <em class="arg">low</em>x<em class="arg">high</em></h4>
4659</div>
4660
4661<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>
4662
4663<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004664 <h4><a name="red-primary" id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
4665</div>
4666
4667<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>
4668
4669<div style="margin: auto;">
4670 <h4><a name="regard-warnings" id="regard-warnings"></a>-regard-warnings</h4>
4671</div>
4672
4673<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>
4674
4675<div style="margin: auto;">
4676 <h4><a name="remap" id="remap"></a>-remap <em class="arg">filename</em></h4>
4677</div>
4678
4679<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>
4680
4681<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4682the given colors are dithered over the image as necessary, otherwise the closest
4683color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4684
4685<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4686images in the current image sequence, all the images will have the same color
4687table. That means that when saved to a file format such as GIF, it will use
4688that color table as a single common or global color table, for all the images,
4689without requiring extra local color tables. </p>
4690
4691<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4692sequence to use a common color map over all the images. This equivalent to
4693appending all the images together (without extra background colors) and color
4694reducing those images using <a href="#colors">-colors</a> with a 256 color
4695limit, then <a href="#remap">-remap</a> those colors over the original list of
4696images. This ensures all the images follow a single color map. </p>
4697
4698<p>If the number of colors over all the images is less than 256, then <a
4699href="#remap">+remap</a> should not perform any color reduction or dithering, as
4700no color changes are needed. In that case, its only effect is to force the use
4701of a global color table. This recommended after using either <a
4702href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
4703reduce the number of colors in an animated image sequence. </p>
4704
4705<div style="margin: auto;">
4706 <h4><a name="region" id="region"></a>-region <em class="arg">geometry</em></h4>
4707</div>
4708
4709<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>
4710
4711<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>
4712
4713<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>
4714
4715<div style="margin: auto;">
4716 <h4><a name="remote" id="remote"></a>-remote</h4>
4717</div>
4718
4719<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>
4720
4721<p>The only command recognized is the name of an image file to load.</p>
4722
4723<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>
4724
4725<div style="margin: auto;">
4726 <h4><a name="render" id="render"></a>-render</h4>
4727</div>
4728
4729<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>
4730
4731<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>
4732
4733<div style="margin: auto;">
4734<h4><a name="repage" id="repage"></a>-repage <em class="arg">geometry</em></h4>
4735</div>
4736
4737<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>
4738
4739<p>This option is like <a href="#page">-page</a> but acts as an image operator
4740rather than a setting. You can separately set the canvas size or the offset
4741of the image on that canvas by only providing those components. </p>
4742
4743<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>
4744
4745<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
4746offset to move the image relative to its previous position. This useful for
4747animation sequences. </p>
4748
4749<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
4750recalculate the canvas size so the image (at its current offset) will appear
4751completely on that canvas (unless it has a negative offset).</p>
4752
4753<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
4754canvas meta-data from the images. </p>
4755
4756<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
4757directly assign virtual canvas meta-data. </p>
4758
4759
4760<div style="margin: auto;">
4761 <h4><a name="resample" id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
4762</div>
4763
4764<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>
4765
4766<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>
4767
4768<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>
4769
4770<div style="margin: auto;">
4771 <h4><a name="resize" id="resize"></a>-resize <em class="arg">geometry</em></h4>
4772</div>
4773
4774<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>
4775
4776<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>
4777
4778<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>
4779
cristy13538962010-02-26 17:53:04 +00004780<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>
4781
cristy4949d522010-03-12 18:41:34 +00004782<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 +00004783<div style="margin: auto;">
4784 <h4><a name="respect-parentheses" id="respect-parentheses"></a>-respect-parentheses</h4>
4785</div>
4786
4787<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>
4788
4789<div style="margin: auto;">
4790 <h4><a name="reverse" id="reverse"></a>-reverse</h4>
4791</div>
4792
4793<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>
4794
4795
4796<div style="margin: auto;">
4797 <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>
4798</div>
4799
4800<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>
4801
4802<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>
4803
4804
4805<div style="margin: auto;">
4806 <h4><a name="rotate" id="rotate"></a>-rotate <em class="arg">degrees</em>{<em class="arg">&lt;</em>}{<em class="arg">&gt;</em>}</h4>
4807</div>
4808
4809<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>
4810
4811<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>
4812
4813<p>Empty triangles in the corners, left over from rotating the image, are
4814filled with the <kbd>background</kbd> color. </p>
4815
4816<p>See also the <a href="#distort">-distort</a> operator and specifically the
4817'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
4818
4819
4820<div style="margin: auto;">
4821 <h4><a name="sample" id="sample"></a>-sample <em class="arg">geometry</em></h4>
4822</div>
4823
4824<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>
4825
4826<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>
4827
4828<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>
4829
4830
4831<div style="margin: auto;">
4832 <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>
4833</div>
4834
4835<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>
4836
4837<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>
4838
4839<div style="margin: auto;">
4840 <h4><a name="scale" id="scale"></a>-scale <em class="arg">geometry</em></h4>
4841</div>
4842
4843<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>
4844
4845<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>
4846
4847<div style="margin: auto;">
4848 <h4><a name="scene" id="scene"></a>-scene <em class="arg">value</em></h4>
4849</div>
4850
4851<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set scene number.</td><td style='text-align:right;'></td></tr></table>
4852
4853<p>This option sets the scene number of an image or the first image in an image sequence.</p>
4854
4855<div style="margin: auto;">
4856 <h4><a name="screen" id="screen"></a>-screen</h4>
4857</div>
4858
4859<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>
4860
4861<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>
4862
4863<div style="margin: auto;">
4864 <h4><a name="seed" id="seed"></a>-seed</h4>
4865</div>
4866
4867<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>
4868
4869<div style="margin: auto;">
4870 <h4><a name="segment" id="segment"></a>-segment <em class="arg">cluster-threshold</em>x<em class="arg">smoothing-threshold</em></h4>
4871</div>
4872
4873<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>
4874
4875<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>
4876
4877<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>
4878
4879<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
4880of the color clusters is returned.</p>
4881
4882
4883<div style="margin: auto;">
4884 <h4><a name="selective-blur" id="selective-blur"></a>-selective-blur <em class="arg">geometry</em></h4>
4885</div>
4886
4887<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>
4888
4889<div style="margin: auto;">
4890 <h4><a name="separate" id="separate"></a>-separate</h4>
4891</div>
4892
4893<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>
4894
4895<div style="margin: auto;">
4896 <h4><a name="sepia-tone" id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
4897</div>
4898
4899<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>
4900
4901<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
4902
4903<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>
4904
cristyd0bda5e2010-09-21 16:22:45 +00004905
4906
cristy3ed852e2009-09-05 21:47:34 +00004907<div style="margin: auto;">
4908 <h4><a name="set" id="set"></a>-set <em class="arg">attribute value</em></h4>
4909</div>
4910
cristyd0bda5e2010-09-21 16:22:45 +00004911<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set an image attributes and properties to images the current
4912image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00004913
cristyd0bda5e2010-09-21 16:22:45 +00004914This will assign specific option and settings to all the images in the current
4915image sequence. That is it will let you modify settings that have already bee
4916read in. In particular those attributes that are assigned to images as they
4917are read in. Specifically setting such as: <a href="#comment">-comment</a>,
4918<a href="#delay">-delay</a>, <a href="#dispose">-dispose</a>, and <a
4919href="#page">-page</a>. For example:</p>
cristy3ed852e2009-09-05 21:47:34 +00004920
cristy4949d522010-03-12 18:41:34 +00004921<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 +00004922<p>The <a href="#repage">-repage</a> operator will also set the
4923'<kbd>page</kbd>' attribute of images already in memory, but allows you to
cristyd0bda5e2010-09-21 16:22:45 +00004924separately set the virtual canvas's size and offset components, and also
4925allows relative offset changes, and automatic canvas size re-calculating. The
4926<a href="#set">-set</a> option however can only provide a direct, unmodified
4927assignment of '<kbd>page</kbd>' attribute. </p>
cristy3ed852e2009-09-05 21:47:34 +00004928
cristyd0bda5e2010-09-21 16:22:45 +00004929<p>Use this option to associate a colorspace or profile with your image. For
4930example,</p> <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.psd -set profile ISOcoated_v2_eci.icc
4931image-icc.psd</span></p>
4932<p>If the given setting being set is not a known 'attribute' such as shown
4933above, the setting will be stored with the individual images as a free form
4934'properity' string. Such settings are listed in <a href="#verbose"
4935>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
4936</p>
4937
4938<p>The set value can also make use of of <a href="../www/escape.html" >Format and Print Image
4939Properties</a> in the defined value. Which can itself also include
4940'properties' previously set by this option. For example</p>
4941
4942<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -set origsize '%wx%h' -resize 50% \<br/>
4943 -format 'Old size = %[origsize] New size = %wx%h' info:</span><span class='crtout'>Old size = 70x46 New size = 35x23</span></p>
4944<p>Some 'properties' must be defined in a specific way to be used. For
4945example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
4946modify the output filename of an image. For example</p>
4947
4948<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -set filename:mysize '%wx%h' 'rose_%[filename:mysize].png'</span></p>
4949<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
4950be saved as a global "Artifact" exactly as if it was set using the <a
4951href="#define" >-define</a> option.</p>
4952
4953<p>You can set the attributes of the image registry by prefixing the value
4954with <kbd>registry:</kbd>.</p>
4955
4956
cristy3ed852e2009-09-05 21:47:34 +00004957
4958<div style="margin: auto;">
4959 <h4><a name="shade" id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
4960</div>
4961
4962<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>
4963
4964<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>
4965
4966<div style="margin: auto;">
4967 <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>
4968</div>
4969
4970<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>
4971
4972<div style="margin: auto;">
4973 <h4><a name="shared-memory"
4974id="shared-memory"></a>-shared-memory</h4>
4975</div>
4976
4977<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>
4978
4979<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>
4980
4981<div style="margin: auto;">
4982 <h4><a name="sharpen" id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
4983</div>
4984
4985<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>
4986
4987<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
4988
4989<div style="margin: auto;">
4990 <h4><a name="shave" id="shave"></a>-shave <em class="arg">geometry</em></h4>
4991</div>
4992
4993<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>
4994
4995<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>
4996
4997<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>
4998
4999<div style="margin: auto;">
5000 <h4><a name="shear" id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
5001</div>
5002
5003<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>
5004
5005<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>
5006
5007<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>
5008
5009<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>
5010
5011<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>
5012
5013<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>
5014<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>
5015
5016<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5017<div style="margin: auto;">
5018 <h4><a name="sigmoidal" id="sigmoidal-contrast"></a>-sigmoidal-contrast <em class="arg">contrast</em>x<em class="arg">mid-point</em></h4>
5019</div>
5020
5021<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>
5022
5023<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>
5024
5025<div style="margin: auto;">
5026 <h4><a name="silent" id="silent"></a>-silent</h4>
5027</div>
5028
5029<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>
5030
5031<div style="margin: auto;">
5032 <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>
5033</div>
5034
5035<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>
5036
5037<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>
5038
5039<p>For Photo CD images, choose from these sizes:</p>
5040
5041<pre class="text">
5042 192x128
5043 384x256
5044 768x512
5045 1536x1024
5046 3072x2048
5047</pre>
5048
cristy3ed852e2009-09-05 21:47:34 +00005049<div style="margin: auto;">
5050 <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>
5051</div>
5052
5053<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>
5054
5055<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>
5056
5057<div style="margin: auto;">
5058 <h4><a name="snaps" id="snaps"></a>-snaps <em class="arg">value</em></h4>
5059</div>
5060
5061<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>
5062
5063<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5064
5065<div style="margin: auto;">
5066 <h4><a name="solarize" id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
5067</div>
5068
5069<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>
5070
5071<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5072
5073<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5074
5075<div style="margin: auto;">
5076 <h4><a name="sparse-color" id="sparse-color"></a>-sparse-color <em
5077 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5078</div>
5079
5080<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>
5081
5082
5083<table class="doc">
5084 <tbody>
5085 <tr valign="top">
5086 <th align="left" style="width: 8%">Method</th>
5087 <th align="left">Description</th>
5088 </tr>
5089
5090 <tr valign="top">
5091 <td valign="top">voronoi</td>
5092 <td valign="top">Simply map each pixel to the to nearest color point
5093 given. The result are polygonal 'cells' of solid color. </td>
5094 </tr>
5095
5096 <tr valign="top">
5097 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005098 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005099 squared. Generating spots of color in a sea of the average of
5100 colors. </td>
5101 </tr>
5102
5103 <tr valign="top">
5104 <td valign="top">barycentric</td>
5105 <td valign="top">three point triangle of color given 3 points.
5106 Giving only 2 points will form a linear gradient between those points.
5107 Gradient is however not restricted to just the triangle or line. </td>
5108 </tr>
5109
5110 <tr valign="top">
5111 <td valign="top">bilinear</td>
5112 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5113 fall back to barycentric. </td>
5114 </tr>
5115
5116 </tbody>
5117</table>
5118
5119<p>The points are placed according to the images location on the virtual
5120canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5121offset), and do not actually have to exist on the given image, but may be
5122some point beyond the edge of the image. All points are floating point values.
5123</p>
5124
5125<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
5126modified, whcih means the matte/alpha transparency channel is not effected by
5127default. If enabled, the image also needs a the matte/alpha channel to be
5128enabled for this operator to effect an images transparency. This is typical
5129transparency handling for images. </p>
5130
5131<p>All the above methods when given a single point of color will replace all
5132the colors in the image with the color given, regardless of the point. This is
5133logical, and provides an alternative technique to recolor a image to some
5134default value. </p>
5135
5136
5137<div style="margin: auto;">
5138 <h4><a name="splice" id="splice"></a>-splice <em class="arg">geometry</em></h4>
5139</div>
5140
5141<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>
5142
5143<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>
5144
5145<div style="margin: auto;">
5146 <h4><a name="spread" id="spread"></a>-spread <em class="arg">amount</em></h4>
5147</div>
5148
5149<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>
5150
5151<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>
5152
5153<div style="margin: auto;">
5154 <h4><a name="stegano" id="stegano"></a>-stegano <em class="arg">offset</em></h4>
5155</div>
5156
5157<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>
5158
5159<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>
5160
5161<div style="margin: auto;">
5162 <h4><a name="stereo" id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
5163</div>
5164
5165<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>
5166
5167<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>
5168
5169<div style="margin: auto;">
5170 <h4><a name="storage-type" id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
5171</div>
5172
5173<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>
5174
5175<pre class="text">
5176 char store pixels as unsigned characters
5177 double store pixels as doubles
5178 float store pixels as floats
5179 integer store pixels as integers
5180 long store pixels as longs
5181 quantum store pixels in the native depth of your ImageMagick distribution
5182 short store pixels as unsigned shorts
5183</pre>
5184
5185<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5186values range from 0 to the maximum value the storage type can support.</p>
5187
5188<div style="margin: auto;">
5189 <h4><a name="stretch" id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
5190</div>
5191
5192<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>
5193
5194<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>
5195
5196<pre class="text">
5197 Any
5198 Condensed
5199 Expanded
5200 ExtraCondensed
5201 ExtraExpanded
5202 Normal
5203 SemiCondensed
5204 SemiExpanded
5205 UltraCondensed
5206 UltraExpanded
5207</pre>
5208
5209<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5210
5211<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>
5212
5213<div style="margin: auto;">
5214 <h4><a name="strip" id="strip"></a>-strip</h4>
5215</div>
5216
5217<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>
5218
5219<div style="margin: auto;">
5220 <h4><a name="stroke" id="stroke"></a>-stroke <em class="arg">color</em></h4>
5221</div>
5222
5223<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>
5224
5225<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5226
5227<p>See <a href="#draw">-draw</a> for further details.</p>
5228
5229<div style="margin: auto;">
5230 <h4><a name="strokewidth" id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
5231</div>
5232
5233<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>
5234
5235<p>See <a href="#draw">-draw</a> for further details.</p>
5236
5237<div style="margin: auto;">
5238 <h4><a name="style" id="style"></a>-style <em class="arg">fontStyle</em></h4>
5239</div>
5240
5241<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>
5242
cristy71a3f602010-09-15 12:38:16 +00005243<p>This setting suggests a font style that ImageMagick should try to apply to
5244the currently selected font family. Select <em class="arg">fontStyle</em> from
5245the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005246
5247<pre class="text">
5248 Any
5249 Italic
5250 Normal
5251 Oblique
5252</pre>
5253
5254<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>
5255
5256<div style="margin: auto;">
cristyae6203d2010-08-09 01:12:14 +00005257 <h4><a name="subimage-search" id="subimage-search"></a>-subimage-search</h4>
5258</div>
5259
cristyd4d64ed2010-08-22 22:19:33 +00005260<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>search for subimage.</td><td style='text-align:right;'>[<a href="../www/compare.html">compare</a>]</td></tr></table>
5261
cristy71a3f602010-09-15 12:38:16 +00005262<p>This option is required to have compare search for the best match location
5263of a small image within a larger image. This search will produce two images
5264(or two frames). The first will be the "difference" image and the second will
5265be the "match score" image.</p>
5266
cristyd0bda5e2010-09-21 16:22:45 +00005267<p>The "match-score" image will be smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005268position of the top-left corner of the given sub-image. that is its size will
5269be the size of the larger_image - sub_image + 1. The brightest location in
5270this image is the location s the locate on the best match that is also
5271reported. Note that this may or may nor be a perfect match, and the actual
5272brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005273possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005274
cristyd0bda5e2010-09-21 16:22:45 +00005275<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005276location in the larger image, as such it can be very slow. The smaller the
5277sub-image the faster this search will be. </p>
5278
cristyae6203d2010-08-09 01:12:14 +00005279
5280<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00005281 <h4><a name="swap" id="swap"></a>-swap <em class="arg">index,index</em></h4>
5282</div>
5283
5284<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>
5285
cristy71a3f602010-09-15 12:38:16 +00005286<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5287images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5288the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005289
5290<div style="margin: auto;">
5291 <h4><a name="swirl" id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
5292</div>
5293
5294<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>
5295
5296<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5297
5298<div style="margin: auto;">
5299 <h4><a name="taint" id="taint"></a>-taint</h4>
5300</div>
5301
5302<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>
5303
5304<div style="margin: auto;">
5305 <h4><a name="text-font" id="text-font"></a>-text-font <em class="arg">name</em></h4>
5306</div>
5307
5308<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>
5309
5310<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>
5311
5312<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>
5313
5314<div style="margin: auto;">
5315 <h4><a name="texture" id="texture"></a>-texture <em class="arg">filename</em></h4>
5316</div>
5317
5318<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>
5319
5320<div style="margin: auto;">
5321 <h4><a name="threshold" id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
5322</div>
5323
5324<!-- {<em class="arg">green,blue,opacity</em>}
5325<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>
5326-->
5327
5328<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>
5329
5330<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>
5331
5332<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.
5333</p>
5334
5335<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>
5336
5337<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5338<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>
5339
5340
5341<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>
5342<p>Note that the values of the transparency channel is treated as 'matte'
5343values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5344
5345<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>.
5346</p>
5347
5348<div style="margin: auto;">
5349 <h4><a name="thumbnail" id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
5350</div>
5351
5352<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>
5353
5354<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>
5355
5356<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>
5357
5358<div style="margin: auto;">
5359 <h4><a name="tile" id="tile"></a>-tile <em class="arg">filename</em></h4>
5360</div>
5361
5362<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>
5363
5364<div style="margin: auto;">
5365 <h4>-tile <em class="arg">geometry</em></h4>
5366</div>
5367
5368<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>
5369
5370<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>
5371
5372<div style="margin: auto;">
5373 <h4>-tile</h4>
5374</div>
5375
5376<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>
5377
5378<div style="margin: auto;">
5379 <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>
5380</div>
5381
5382<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>
5383
5384<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>
5385
5386<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>
5387
5388<div style="margin: auto;">
5389 <h4><a name="tint" id="tint"></a>-tint <em class="arg">value</em></h4>
5390</div>
5391
5392<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>
5393
5394<p>Tint the image with the fill color.</p>
5395
5396<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>
5397
5398<div style="margin: auto;">
5399 <h4><a name="title" id="title"></a>-title <em class="arg">string</em></h4>
5400</div>
5401
5402<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>
5403
5404<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>
5405
5406<p>For example,</p>
5407
5408<p class="crtsnip">
5409 -title "%m:%f %wx%h"
5410</p>
5411
5412<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>
5413
5414
5415<div style="margin: auto;">
5416 <h4><a name="transform" id="transform"></a>-transform</h4>
5417</div>
5418
5419<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>
5420
5421<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5422
5423<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 +00005424
5425<p>This operator has been now been superseded by the <a
5426href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5427
5428
cristy3ed852e2009-09-05 21:47:34 +00005429<div style="margin: auto;">
5430 <h4><a name="transparent" id="transparent"></a>-transparent <em class="arg">color</em></h4>
5431</div>
5432
5433<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>
5434
5435<p>The <em class="arg">color</em> argument is defined using the format
5436described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5437>-fuzz</a> setting can be used to match and replace colors similar to the one
5438given. </p>
5439
cristyb36feb22010-03-26 16:54:37 +00005440<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5441that is make all non-matching colors transparent. </p>
5442
cristy3ed852e2009-09-05 21:47:34 +00005443<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005444href="#transparent" >-transparent</a> but replaces the matching color with the
5445current <a href="#fill">-fill</a> color setting, rather than transparent.
5446However the <a href="#transparent" >-transparent</a> operator also ensures
5447that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5448>-alpha</a> set</kbd>", and does not require you to modify the <a
5449href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005450
cristyb36feb22010-03-26 16:54:37 +00005451<p>Note that this does not define the color as being the 'transparency color'
5452used for color-mapped image formats, such as GIF. For that use <a
5453href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005454
5455
5456<div style="margin: auto;">
5457 <h4><a name="transparent-color" id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
5458</div>
5459
5460<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>
5461
5462<p>Sometimes this is used for saving to image formats such as
5463GIF and PNG8 which uses this color to represent boolean transparency. This
5464does not make a color transparent, it only defines what color the transparent
5465color is in the color palette of the saved image. Use <a
5466href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5467
5468<p>This option allows you to have both an opaque visible color, as well as a
5469transparent color of the same color value without conflict. That is, you can
5470use the same color for both the transparent and opaque color areas within an
5471image. This, in turn, frees to you to select a transparent color that is
5472appropriate when an image is displayed by an application that does not handle a
5473transparent color index, while allowing ImageMagick to correctly handle images of this
5474type. </p>
5475
5476<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5477
5478<div style="margin: auto;">
5479 <h4><a name="transpose" id="transpose"></a>-transpose</h4>
5480</div>
5481
5482<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>
5483
5484<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5485</p>
5486
5487<div style="margin: auto;">
5488 <h4><a name="transverse" id="transverse"></a>-transverse</h4>
5489</div>
5490
5491<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>
5492
5493
5494<div style="margin: auto;">
5495 <h4><a name="treedepth" id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
5496</div>
5497
5498<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>
5499
5500<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>
5501
5502<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>
5503
5504<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>
5505
5506<div style="margin: auto;">
5507 <h4><a name="trim" id="trim"></a>-trim</h4>
5508</div>
5509
5510<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>
5511
5512<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>
5513
5514<p>The page or virtual canvas information of the image is preserved allowing
5515you to extract the result of the <a href="#trim">-trim</a> operation from the
5516image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5517information if it is unwanted.</p>
5518
5519<p>If the trimmed image 'disappears' an warning is produced, and a special
5520single pixel transparent 'missed' image is returned, in the same way as when a
5521<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5522
5523
5524<div style="margin: auto;">
5525 <h4><a name="type" id="type"></a>-type <em class="arg">type</em></h4>
5526</div>
5527
5528<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>
5529 <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>
5530
5531<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>
5532
5533<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5534<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>
5535
5536<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5537
5538<div style="margin: auto;">
5539 <h4><a name="undercolor" id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
5540</div>
5541
5542<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>
5543
5544<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5545
5546<p>See <a href="#draw">-draw</a> for further details.</p>
5547
5548
5549<div style="margin: auto;">
5550 <h4><a name="update" id="update"></a>-update <em class="arg">seconds</em></h4>
5551</div>
5552
5553<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>
5554
5555<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>
5556
5557
5558<div style="margin: auto;">
5559 <h4><a name="unique-colors" id="unique-colors"></a>-unique-colors</h4>
5560</div>
5561
5562<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>
5563
5564
5565<div style="margin: auto;">
5566 <h4><a name="units" id="units"></a>-units <em class="arg">type</em></h4>
5567</div>
5568
5569<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>
5570
5571<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>
5572
5573
5574<div style="margin: auto;">
5575 <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>
5576</div>
5577
5578<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>
5579
5580<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>
5581
5582<p>The parameters are:</p>
5583
5584<pre class="text">
5585 radius: The radius of the Gaussian, in pixels, not counting the center
5586 pixel (default 0).
5587 sigma: The standard deviation of the Gaussian, in pixels (default 1.0).
5588 amount: The fraction of the difference between the original and the blur
5589 image that is added back into the original (default 1.0).
5590 threshold: The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5591 difference amount (default 0.05).
5592</pre>
5593
5594
5595<div style="margin: auto;">
5596 <h4><a name="verbose" id="verbose"></a>-verbose</h4>
5597</div>
5598
cristyd0bda5e2010-09-21 16:22:45 +00005599<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 precedes the <a href="#identify">-identify</a> option or <kbd>info:</kbd>.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005600
5601
5602<div style="margin: auto;">
5603 <h4><a name="version" id="version"></a>-version</h4>
5604</div>
5605
5606<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>
5607
5608
5609<div style="margin: auto;">
5610 <h4><a name="view" id="view"></a>-view <em class="arg">string</em></h4>
5611</div>
5612
5613<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>
5614
5615
5616<div style="margin: auto;">
5617 <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>
5618</div>
5619
5620<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>
5621
5622
5623<div style="margin: auto;">
5624 <h4><a name="virtual-pixel" id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
5625</div>
5626
5627<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>
5628
5629<p>This option defines what color source should be used if and when a color
5630lookup completely 'misses' the source image. The color(s) that appear to
5631surround the source image. Generally this color is derived from the source
5632image, but could also be set to a specify background color. </p>
5633
5634<p>Choose from these methods:</p>
5635
5636<pre class="text">
5637 background: the area surrounding the image is the background color
5638 black: the area surrounding the image is black
5639 checker-tile: alternate squares with image and background color
5640 dither: non-random 32x32 dithered pattern
5641 edge: extend the edge pixel toward infinity
5642 gray: the area surrounding the image is gray
5643 horizontal-tile: horizontally tile the image, background color above/below
5644 horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
5645 mirror: mirror tile the image
5646 random: choose a random pixel from the image
5647 tile: tile the image (default)
5648 transparent: the area surrounding the image is transparent blackness
5649 vertical-tile: vertically tile the image, sides are background color
5650 vertical-tile-edge: vertically tile the image and replicate the side edge pixels
5651 white: the area surrounding the image is white
5652</pre>
5653
5654<p>The default value is "edge".</p>
5655
5656<p>This most important for distortion operators such as <a href="#distort"
5657>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
5658However it also effects operations that may access pixels just outside the
5659image proper, such as <a href="#convolve">-convolve</a>, <a
5660href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
5661
5662<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
5663
5664
5665<div style="margin: auto;">
5666 <h4><a name="visual" id="visual"></a>-visual <em class="arg">type</em></h4>
5667</div>
5668
5669<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>
5670
5671<p>Choose from these visual classes:</p>
5672
5673<pre class="text">
5674 StaticGray
5675 GrayScale
5676 StaticColor
5677 PseudoColor
5678 TrueColor
5679 DirectColor
5680 default
5681 visual id
5682</pre>
5683
5684<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>
5685
5686
5687<div style="margin: auto;">
5688 <h4><a name="watermark" id="watermark"></a>-watermark <em
5689 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
5690</div>
5691
5692<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
5693saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5694
5695<p>Take a grayscale image (with alpha mask) and modify the destination image's
5696brightness according to watermark image's grayscale value and the <em
5697class="arg">brightness</em> percentage. The destinations color saturation
5698attribute is just direct modified by the <em class="arg">saturation</em>
5699percentage, which defaults to 100 percent (no color change). </p>
5700
5701
5702<div style="margin: auto;">
5703 <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>
5704</div>
5705
5706<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>
5707
5708<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
5709
5710<div style="margin: auto;">
5711 <h4><a name="weight" id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
5712</div>
5713
5714<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>
5715
5716<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>
5717
5718<table class="doc">
5719 <col width="25%" />
5720 <col width="75%" />
5721 <thead>
5722 <tr>
5723 <th><em class="arg">fontWeight</em></th>
5724 <th>Description</th>
5725 </tr>
5726 </thead>
5727 <tbody>
5728 <tr><td>All </td> <td>No effect. </td></tr>
5729 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
5730 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
5731 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
5732 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
5733 </tbody>
5734 </table>
5735
5736<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
5737
5738<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>
5739
5740<div style="margin: auto;">
5741 <h4><a name="white-point" id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
5742</div>
5743
5744<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>
5745
5746<div style="margin: auto;">
cristy5cadd612009-09-21 19:33:41 +00005747 <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 +00005748</div>
5749
cristy5cadd612009-09-21 19:33:41 +00005750<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>
5751
5752<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.
5753</p>
cristy3ed852e2009-09-05 21:47:34 +00005754
5755<div style="margin: auto;">
5756 <h4><a name="window" id="window"></a>-window <em class="arg">id</em></h4>
5757</div>
5758
5759<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>
5760
5761<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>
5762
5763<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>
5764
5765<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>
5766
5767<div style="margin: auto;">
5768 <h4><a name="window-group" id="window-group"></a>-window-group</h4>
5769</div>
5770
5771<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>
5772
5773<div style="margin: auto;">
5774 <h4><a name="write" id="write"></a>-write <em class="arg">filename</em></h4>
5775</div>
5776
5777<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>
5778 <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>
5779
5780<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
5781
cristy3eaa0ef2010-03-06 20:35:26 +00005782
5783</div>
5784
5785<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00005786 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00005787 <span id="linkbar-center">
5788 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00005789 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00005790 </span>
5791 <span id="linkbar-east">&nbsp;</span>
5792 </div>
5793 <div class="footer">
5794 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
5795 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
5796 </div>
5797 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00005798 <script type="text/javascript">
5799 var _gaq = _gaq || [];
5800 _gaq.push(['_setAccount', 'UA-17690367-1']);
5801 _gaq.push(['_trackPageview']);
5802
5803 (function() {
5804 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
5805 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
5806 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
5807 })();
5808 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00005809</body>
5810</html>