blob: c2b8ecc844f9668ac9c474a1eafdbe773a348eca [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001
2
3
4
cristydcca3fa2010-12-29 21:50:07 +00005<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
6 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml" xml: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="/>
cristydcca3fa2010-12-29 21:50:07 +000011 <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"/>
cristyaf8d6652011-02-04 21:57:45 +000016 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000017 <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"/>
cristy7e41fe82010-12-04 23:12:08 +000026 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000027 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000028 <link rel="icon" href="../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000029 <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"/>
cristy7a40ba82011-01-08 20:31:18 +000031 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000032 <style type="text/css" media="all">
33 @import url("../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +000035 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000036 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000048</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
52<a href="../index.html">
53 <img src="../images/script.png" alt="[ImageMagick]"
54 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
55<a href="http://www.networkredux.com">
56 <img src="../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000057 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000058<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000059 <img src="../images/logo.jpg"
60 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000061 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000062<a href="../index.html">
cristyaf8d6652011-02-04 21:57:45 +000063 <img src="../images/sprite.jpg"
64 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000065 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
66</div>
67
cristyce69bb02010-07-27 19:49:46 +000068<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000069
cristy3ed852e2009-09-05 21:47:34 +000070<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
cristy3eaa0ef2010-03-06 20:35:26 +000073<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000074<div class="menu">
cristybb503372010-05-27 20:51:26 +000075 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
79</div>
80<div class="sub">
81 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
82</div>
83<div class="sub">
84 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
85</div>
86<div class="sep"></div>
87<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000088 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000089</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000091 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000092</div>
93<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000094 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000106 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
108<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
111<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000112 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000122 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000123 </div>
124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000125 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000126</div>
cristybb503372010-05-27 20:51:26 +0000127<div class="menu">
128 <a title="Architecture" href="../www/architecture.html">Architecture</a>
129</div>
cristy3ed852e2009-09-05 21:47:34 +0000130<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000131 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000134<div class="menu">
cristy52923442011-01-15 22:54:31 +0000135 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000136</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000137<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000138<div class="menu">
cristydcca3fa2010-12-29 21:50:07 +0000139 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000140</div>
141<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000142 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000145<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000146 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000147
148<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000149<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000150 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
151</div>
152<div class="sponsor">
153 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
154</div>
155<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000156 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
157</div>
cristyec6b4752011-01-08 03:16:23 +0000158<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000159 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000160</div>
161<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000162 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
163</div>
164<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000165 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
166</div>
cristyec6b4752011-01-08 03:16:23 +0000167<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000168 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
169</div>
170<div class="sponsor">
cristy70b59b62011-02-07 19:09:57 +0000171 <a title="Sponsor: Custom T-Shirts" href="http://www.ooshirts.com">Custom T-Shirts</a><!-- 2011050100030 ooshirts.com-->
cristyec6b4752011-01-08 03:16:23 +0000172</div>
cristy3ed852e2009-09-05 21:47:34 +0000173</div>
174</div>
cristyce69bb02010-07-27 19:49:46 +0000175</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000176
cristyce69bb02010-07-27 19:49:46 +0000177<div class="eastbar">
178 <script type="text/javascript">
179 <!--
180 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000181 google_ad_slot = "0574824969";
182 google_ad_width = 160;
183 google_ad_height = 600;
184 //-->
185 </script>
186 <script type="text/javascript"
187 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
188 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000189</div>
190
191<div class="main">
192
cristydcca3fa2010-12-29 21:50:07 +0000193<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000194<p class="navigation-index">
cristy2d67ddd2011-02-13 15:38:23 +0000195[ <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#smush">&#x2011;smush</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#synchronize">&#x2011;synchronize</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 +0000196
cristydcca3fa2010-12-29 21:50:07 +0000197<div class="doc-section">
198
cristyb36feb22010-03-26 16:54:37 +0000199<p>Below is list of command-line options recognized by the ImageMagick <a
200href="../www/command-line-tools.html">command-line
201tools</a>. If you want a description of a particular option, click on the
202option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000203otherwise 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 +0000204
205<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000206 <h4><a id="adaptive-blur"></a>-adaptive-blur <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000207</div>
208
209<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>
cristy3ed852e2009-09-05 21:47:34 +0000210<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>
211
212<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000213 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000214</div>
215
216<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>
217
218<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>
219
220<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000221 <h4><a id="adaptive-sharpen"></a>-adaptive-sharpen <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000222</div>
223
224<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>
225
226<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>
227
228<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000229 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000230</div>
231
232<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>
233
234<p>This option is enabled by default. An attempt is made to save all
235images of an image sequence into the given output file.
236However, some formats, such as JPEG and PNG, do not support more than one
237image per file, and in that case ImageMagick is forced to write each image as a separate file. As
238such, if more than one image needs to be written, the filename given is
239modified by adding a <a href="#scene">-scene</a> number before the
240suffix, in order to make distinct names for each image. </p>
241
242<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written
243to separate files, whether or not the file format allows multiple images
244per file (for example, GIF, MIFF, and TIFF). </p>
245
246<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>
247
248<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: rose: -morph 15 my%02dmorph.jpg</span></p>
249<p>will create a sequence of 17 images named my00morph.jpg, my01morph.jpg, my02morph.jpg, ..., my16morph.jpg.
250</p>
251
252<p>In summary, ImageMagick tries to write all images to one file, but will use
cristydcca3fa2010-12-29 21:50:07 +0000253multiple files if either<br />
254 (1) the output image's file format does not allow multi-image files,<br />
255 (2) the <a href="#adjoin">+adjoin</a> option is given, or<br />
256 (3) a printf() integer format string (eg: "%d") is present in the output filename. </p>
cristy3ed852e2009-09-05 21:47:34 +0000257
258
259<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000260 <h4><a 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/>
cristy3ed852e2009-09-05 21:47:34 +0000261 -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>
262</div>
263
264<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>
265
266<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>
267
268<p>The matrix entries are entered as comma-separated numeric values <i>with no spaces</i>. </p>
269
270<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>
271
272<div class="eqn">
273<img alt="affine transformation" src="../images/affine.png"/>
274</div>
275
276<p>
277The 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>
278
279<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>
280
281<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>
282
283<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>
284
285<p class="crtsnip">
286 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
287</p>
288
289<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>
290
291<p class="crtsnip">
292 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
293</p>
294
295<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
296<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
297
298<p class="crtsnip">
299 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
300</p>
301
302<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>
303
304<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>
305
306<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000307 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000308</div>
309
310<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>
311
312<p>Used to set a flag on an image indicating whether or not to use existing alpha
313channel 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>
314
315
316<table class="doc">
317 <tbody>
318 <tr valign="top">
319 <th align="left" style="width: 8%">type</th>
320 <th align="left">Description</th>
321 </tr>
322
323 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000324 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000325 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000326 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
327 should be used instead of this, unless you specifically need to
328 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
329 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000330
331 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000332 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000333 <td valign="top">
334 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000335 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000336
337 <tr valign="top">
338 <td valign="top"><kbd>Set</kbd></td>
339 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000340 Activates the alpha/matte channel. If it was previously turned off
341 then it also resets the channel to opaque. If the image already had
342 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000343
344 <tr valign="top">
345 <td valign="top"><kbd>Opaque</kbd></td>
346 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000347 Enables the alpha/matte channel and forces it to be fully opaque.
348 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000349
350 <tr valign="top">
351 <td valign="top"><kbd>Transparent</kbd></td>
352 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000353 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000354 transparent. This effectively creates a fully transparent image the
355 same size as the original and with all its original RGB data still
356 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000357
358 <tr valign="top">
359 <td valign="top"><kbd>Extract</kbd></td>
360 <td valign="top">
361 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000362 '<kbd>Off</kbd>' the the image's transparency, so as to generate
363 a gray-scale mask of the image's shape. The alpha channel data is left
364 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
365 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000366
367 <tr valign="top">
368 <td valign="top"><kbd>Copy</kbd></td>
369 <td valign="top">
370 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000371 gray-scale intensity of the image, into the alpha channel, converting
372 a gray-scale mask into a transparent shaped mask ready to be colored
373 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000374
375 <tr valign="top">
376 <td valign="top"><kbd>Shape</kbd></td>
377 <td valign="top">
378 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000379 the current background color. That is the RGB color channels is
380 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000381 </td></tr>
382
383 <tr valign="top">
384 <td valign="top"><kbd>Background</kbd></td>
385 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000386 Set any fully-transparent pixel to the background color, while leaving
387 it fully-transparent. This can make some image file formats, such as
388 PNG, smaller as the RGB values of transparent pixels are more uniform,
389 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000390 </td></tr>
391 </tbody>
392</table>
393
394<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000395"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000396>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000397Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000398
399
400<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000401 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000402 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
403 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
404 -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>
405</div>
406
407<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>
408
409<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>
410
411
412<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>
413
414<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>
415
416<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>
417<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
418
419<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>
420
421<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>
422
423<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000424 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000425</div>
426
427<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
428drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
429
430<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
431drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
432antialiasing edge pixels. This will then reduce the number of colors added to
433an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000434are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000435
436<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000437 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000438</div>
439
440<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>
441
442<p>This option creates a single longer image image, by joining all the current
443images in sequence top-to-bottom. Use <a href="#append">+append</a> to
444stack images left-to-right. </p>
445
446<p>If they are not of the same width, narrower images are padded with the
447current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000448position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000449href="#gravity">-gravity</a> setting. </p>
450
451
452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000453 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000454</div>
455
456<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>
457
458
459<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000460 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000461</div>
462
463<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>
464
465<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>
466
467<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
468
cristyd934d102009-10-10 12:55:13 +0000469
470
cristy3ed852e2009-09-05 21:47:34 +0000471<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000472 <h4><a id="auto-gamma"></a>-auto-gamma</h4>
cristy3ed852e2009-09-05 21:47:34 +0000473</div>
474
475<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>
476
cristyd934d102009-10-10 12:55:13 +0000477<p>This calculates the mean values of an image, then applies a calculated <a
478href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
479image it will get a have a value of 50%. </p>
480
cristyd0bd44a2010-09-24 12:38:11 +0000481<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000482
483<p>This works well for real-life images with little or no extreme dark and
484light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000485dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000486</p>
487
488<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000489'<em>sync</em>' flag for channel syncronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000490values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000491>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000492together by the same gamma value, preserving colors. </p>
493
494
495
cristy3ed852e2009-09-05 21:47:34 +0000496<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000497 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000498</div>
499
500<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>
501
cristyd934d102009-10-10 12:55:13 +0000502<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000503minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000504href="#level" >-level</a> operator to stretch the values to the full range of
505values. </p>
506
cristy83543962009-10-16 19:04:28 +0000507<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000508JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
509for the <a href="#level" >-level</a> operation. On the other hand it is the
510right operator to use for color stretching gradient images being used to
511generate Color lookup tables, distortion maps, or other 'mathematically'
512defined images. </p>
513
514<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
515href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
516>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
517problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000518>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000519
520<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000521special '<em>sync</em>' flag for channel syncronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000522which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000523href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
524'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000525together by the same gamma value, preserving colors, and ignoring
526transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000527
528
cristy3ed852e2009-09-05 21:47:34 +0000529<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000530 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000531</div>
532
533<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>
534
cristy83543962009-10-16 19:04:28 +0000535<p>This operator reads and resets the EXIF image profile setting 'Orientation'
536and then performs the appropriate 90 degree rotation on the image to orient
537the image, for correct viewing. </p>
538
539<p>This EXIF profile setting is usually set using a gravity sensor in digital
540camara, however photos taken directly downward or upward may not have an
541appropriate value. Also images that have been orientation 'corrected' without
542reseting this setting, may be 'corrected' again resulting in a incorrect
543result. If the he EXIF profile was previously stripped, the <a
544href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
545
546
cristy3ed852e2009-09-05 21:47:34 +0000547<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000548 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000549</div>
550
551<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>
552
553<p>An error results if the images are not identically sized.</p>
554
cristy3ed852e2009-09-05 21:47:34 +0000555
556<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000557 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000558</div>
559
560<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>
561
562<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>
563
564<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000565 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000566</div>
567
568<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>
569
570<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>
571
572<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000573 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000574</div>
575
576<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>
577
cristye6378132009-10-26 20:05:17 +0000578<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 +0000579
cristye6378132009-10-26 20:05:17 +0000580<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>
581<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 +0000582
583<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000584 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000585</div>
586
587<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>
588
589<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>
590
591<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>
592
593<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
594negative results without clipping to the color value range
595(0..QuantumRange).</p>
596
597<p>See the discussion on HDRI implementations of ImageMagick on the page
598<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.
599</p>
600
601<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000602 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000603</div>
604
605<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>
606
607<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000608 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000609</div>
610
cristy5cadd612009-09-21 19:33:41 +0000611<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>
612
613<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.
614</p>
cristy3ed852e2009-09-05 21:47:34 +0000615
616
617<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000618 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000619</div>
620
cristy83a272e2010-05-07 20:40:35 +0000621<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 +0000622
623<p>Blend will average the images together ('plus') according to the
624percentages given and each pixels transparency. If only a single percentage
625value is given it sets the weight of the composite or 'source' image, while
626the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000627<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
628'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000629
630
631<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000632 <h4><a id="blue-primary"></a>-blue-primary <em class="arg">x</em>,<em class="arg">y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000633</div>
634
635<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>
636
637<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000638 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000639</div>
640
641<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>
642
643<div style="margin: auto;">
644
645<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000646 <h4><a id="blur"></a>-blur <em class="arg">radius</em><br />-blur <em class="arg">radius</em>x<em class="arg">sigma</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000647</div>
648
649<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>
650
cristyb15553d2010-07-03 22:53:14 +0000651<p>Convolve the image with a Gaussian or normal distribution using the given
652<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000653
654<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
655</div>
656
cristyb15553d2010-07-03 22:53:14 +0000657<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000658determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000659
cristyb15553d2010-07-03 22:53:14 +0000660<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000661array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000662integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000663radius that will provide meaningful results for the Gaussian distribution.
664</p>
665
666<p>The larger the <em class="arg" >Radius</em> the radius the slower the
667operation is. However too small a <em class="arg" >Radius</em>, and sever
668aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
669should be at least twice the <em class="arg" >Sigma</em> value, though three
670times will produce a more accurite result. </p>
671
672<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
673by taking advantage of the separability properties of the distribution. Here
674we apply a single-dimensional Gaussian matrix in the horizontal direction,
675then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000676
677<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
678pixels which are outside the image proper are blurred into the final result.
679</p>
680
681
682<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000683 <h4>-blur <em class="arg">Width</em>[x<em class="arg">Height</em>[+<em class="arg">Angle</em>]]</h4>
cristy3ed852e2009-09-05 21:47:34 +0000684</div>
685
686<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>
687
688<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
689Average (EWA) of the source image, scaled according to the grayscale
690mapping. </p>
691
692<p>The ellipse is weighted with sigma set to the given <em class="arg"
693>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
694defaults to the <em class="arg" >Width</em> for a normal circular Guassian
695weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
696horizontal clock-wise. </p>
697
698<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
699pixels which are outside the image proper are blurred into the final result.
700</p>
701
702
703<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000704 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000705</div>
706
707<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>
708
cristybc9539a2010-08-16 18:06:20 +0000709<p>Set the width and height using the <em class="arg">size</em> portion of the
710<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
711ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000712
cristybc9539a2010-08-16 18:06:20 +0000713<p>Set the border color by preceding with the <a
714href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000715
cristybc9539a2010-08-16 18:06:20 +0000716<p>The <a href="#border">-border</a> operation is affected by the current <a
717href="#compose">-compose</a> setting and assumes that this is using the default
718'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
719size colors by the current <a href="#bordercolor">-bordercolor</a> before
720overlaying the original image in the center of this net image. This means that
721with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000722be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000723<p>See also the <a href="#frame">-frame</a> option, which has more
724functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000725
726<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000727 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000728</div>
729
730<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>
731
732<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
733
734<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
735
736<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000737 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000738</div>
739
740<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>
741
742<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000743 <h4><a 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>
cristy16ff93c2010-01-13 23:18:07 +0000744</div>
745
746<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>
747
cristyefb2bdb2010-11-20 19:35:22 +0000748<p>Brightness and Contrast values apply changes to the input image. They are
749not absolute settings. A brightness or contrast value of zero means no change.
750The range of values is -100 to +100 on each. Positive values increase the
751brightness or contrast and negative values decrease the brightness or contrast.
752To control only contrast, set the brightness=0. To control only brightness,
753set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000754
cristyefb2bdb2010-11-20 19:35:22 +0000755<p>You may also use <a href="#fill">-channel</a> to control which channels to
756apply the brightness and/or contrast change. The default is to apply the same
757transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000758
cristyefb2bdb2010-11-20 19:35:22 +0000759<p>Brightness and Contrast arguments are converted to offset and slope of a
760linear transform and applied
761using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000762
cristyefb2bdb2010-11-20 19:35:22 +0000763<p>The slope varies from 0 at contrast=-100 to almost vertical at
764contrast=+100. For brightness=0 and contrast=-100, the result are totally
765midgray. For brightness=0 and contrast=+100, the result will approach but
766not quite reach a threshold at midgray; that is the linear transformation
767is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000768
cristyefb2bdb2010-11-20 19:35:22 +0000769<p>Negative slopes, i.e. negating the image, are not possible with this
770function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000771
cristyefb2bdb2010-11-20 19:35:22 +0000772<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
773at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
774totally white. Similarly, when contrast=0 and brightness=-100, the result is
775totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000776
cristyefb2bdb2010-11-20 19:35:22 +0000777<p>As the range of values for the arguments are -100 to +100, adding the '%'
778symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000779
780<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000781 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000782</div>
783
784<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>
785
786<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000787 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000788</div>
789
790<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>
791
cristy71a3f602010-09-15 12:38:16 +0000792<p>This option sets the caption meta-data of an image read in after this
793option has been given. To modify a caption of images already in memory use
794"<kbd><a href="#set">-set</a> caption</kbd>". </p>
795
796<p>The caption can contain special format characters listed in the <a
797href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000798Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000799is finally assigned to the individual images. </p>
800
801<p>If the first character of <em class="arg">string</em> is <em
802class="arg">@</em>, the image caption is read from a file titled by the
803remaining characters in the string. Comments read in from a file are literal;
804no embedded formatting characters are recognized.</p>
805
806<p>Caption meta-data ais not visible on the image itself. To do that use the
807<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
808instead.</p>
809
810<p>For example,</p>
811
812<p class="crtsnip">
813 -caption "%m:%f %wx%h" bird.miff
814</p>
815
816<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
817that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
818480.</p>
819
820
cristy3ed852e2009-09-05 21:47:34 +0000821<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000822 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000823</div>
824
825<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>
826
827<p>Here is an example color correction collection:</p>
828
829<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000830&lt;?xml version="1.0" encoding="UTF-8"?&gt;
831&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
832 &lt;ColorCorrection id="cc06668"&gt;
833 &lt;SOPNode&gt;
834 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
835 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
836 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
837 &lt;/SOPNode&gt;
838 &lt;SATNode&gt;
839 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
840 &lt;/SATNode&gt;
841 &lt;/ColorCorrection&gt;
842&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000843</pre>
844
845<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000846 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000847</div>
848
849<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>
850
cristyefb2bdb2010-11-20 19:35:22 +0000851<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
852<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
853<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
854<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000855
cristy83a272e2010-05-07 20:40:35 +0000856<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000857abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
858'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
859'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000860
cristy83a272e2010-05-07 20:40:35 +0000861For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
862you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000863<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000864 -channel Red,Blue
865</p>
866<p>or you can use the short hand form</p>
867<p class="crtsnip">
868 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000869</p>
870
cristy83a272e2010-05-07 20:40:35 +0000871<p>All the channels that is present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000872special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
873but generally any operators that are generally 'grey-scale' image operators,
874will understand this setting. See individual operator documentation. </p>
875
cristydcca3fa2010-12-29 21:50:07 +0000876<br />
cristy83a272e2010-05-07 20:40:35 +0000877
878<p>On top of the normal channel selection a extra flag can be specified,
879'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000880operators that understand this flag should perform: cross-channel
881syncronization of the channels. If not specified, then most grey-scale
882operators will apply their image processing operations to each individual
883channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000884setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000885
886<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000887<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000888together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000889it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000890independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000891
cristydcca3fa2010-12-29 21:50:07 +0000892<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000893and the <a href="#compose">-compose</a> mathematical methods, also understands
894the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
895to the alpha channel (if present). That is to say it will modify the image
896processing with the understanding that fully-transparent colors should not
897contribute to the final result. </p>
898
cristydcca3fa2010-12-29 21:50:07 +0000899<p>Basically, by default, operators work with color channels in syncronous, and
cristybac7a162010-06-15 19:57:29 +0000900treats transparency as special, unless the <a href="#channel">-channel</a>
901setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
902How each operator does this depends on that operators current implementation.
903Not all operators understands this flag at this time, but that is changing.
904</p>
cristy83a272e2010-05-07 20:40:35 +0000905
906<p>To print a complete list of channel types, use <a href="#list">-list
907channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000908
cristydcca3fa2010-12-29 21:50:07 +0000909<br />
cristyd934d102009-10-10 12:55:13 +0000910
911<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000912'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
913channels except the transparency channel, and that all the color channels are
914to be modified in exactly the same way, with a understanding of transprancy
915(depending on the operation being applied). The 'plus' form <a
916href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000917
918<p>Options that are affected by the <a href="#channel" >-channel</a> setting
919include the following.
920
921<a href="#auto-gamma">-auto-gamma</a>,
922<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000923<a href="#black-threshold">-black-threshold</a>,
924<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000925<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000926<a href="#clut">-clut</a>,
927<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000928<a href="#composite">-composite</a> (Mathematical compose methods only),
929<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000930<a href="#contrast-stretch">-contrast-stretch</a>,
931<a href="#evaluate">-evaluate</a>,
932<a href="#function">-function</a>,
933<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000934<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000935<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000936<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000937<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000938<a href="#negate">-negate</a>,
939<a href="#normalize">-normalize</a>,
940<a href="#ordered-dither">-ordered-dither</a>,
941<a href="#radial-blur">-radial-blur</a>,
942<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000943<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000944<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000945<a href="#white-threshold">-white-threshold</a>.
946</p>
947
cristyd0bda5e2010-09-21 16:22:45 +0000948<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +0000949>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +0000950href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +0000951default). These operators have yet to be made to understand the newer 'Sync'
952flag. </p>
953
cristybac7a162010-06-15 19:57:29 +0000954<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
955the image before thresholding, if no <a href="#channel" >-channel</a> setting
956has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +0000957
958<p>Also some operators such as <a href="#blur">-blur</a>, <a
959href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
960color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
961href="#channel" >-channel</a>. Generally this done to ensure that
962fully-transparent colors are treated as being fully-transparent, and thus any
963underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +0000964resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +0000965convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +0000966and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +0000967
cristybac7a162010-06-15 19:57:29 +0000968<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +0000969color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +0000970alpha channel present, and the <a href="#channel" >-channel</a> setting tells
971the operator to apply the operation using alpha channels. The <a
972href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +0000973
cristy3ed852e2009-09-05 21:47:34 +0000974
975<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000976 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +0000977</div>
978
979<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>
980
981<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000982 <h4><a id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000983</div>
984
985<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>
986
987<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000988 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000989</div>
990
991<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>
992
cristyefb2bdb2010-11-20 19:35:22 +0000993<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>
994and <em class="arg">height</em> given in the of the <em class="arg">size</em>
995portion of the <em class="arg">geometry</em> argument give the number of
996columns and rows to remove. The <em class="arg">offset</em> portion of
997the <em class="arg">geometry</em> argument is influenced by
998a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +0000999
cristyefb2bdb2010-11-20 19:35:22 +00001000<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
1001and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00001002
cristydcca3fa2010-12-29 21:50:07 +00001003<p>While it can remove internal rows and columns of pixels, it is more typically
1004used with as <a href="#gravity">-gravity</a> setting and a '<kbd>+0+0</kbd>' offset
1005so as to remove a single edge from an image. Compare this to <a href="#shave"
1006>-shave</a> whcih removes equal numbers of pixels from oppisite sides of the image.
1007</p>
1008
1009<p>Using <a href="#chop">-chop</a> will effectivally undo the results of a
1010<a href="#splice">-splice</a> that was given the same <em class="arg">geometry</em>
1011and <a href="#gravity">-gravity</a> settings. </p>
1012
1013
cristy3ed852e2009-09-05 21:47:34 +00001014<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001015 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001016</div>
1017
1018<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>
1019
1020<p>If a clipping path is present, it is applied to subsequent operations.</p>
1021
1022<p>For example, in the command</p>
1023
1024<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
1025<p>only the pixels within the clipping path are negated.</p>
1026
1027<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1028
1029<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001030 <h4><a id="clip-mask"></a>-clip-mask</h4>
cristy3ed852e2009-09-05 21:47:34 +00001031</div>
1032
1033<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>
1034
1035<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001036 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001037</div>
1038
1039<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>
1040
1041<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001042 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001043</div>
1044
1045<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>
1046
cristydcca3fa2010-12-29 21:50:07 +00001047<p>Inside parenthesis (where the operator is normally used) it will make a
1048clone of the images from the last 'pushed' image sequence, and adds them to
1049the end of the current image sequence. Outside parenthesis
1050(not recommended) it clones the images from the current image sequence. </p>
1051
cristy3ed852e2009-09-05 21:47:34 +00001052<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000010530. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001054example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001055represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001056dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1057spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
1058effectivally clone all the images. </p>
1059
1060<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
1061in the image sequence, and is thus equivelent to using a argument of
1062'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001063
1064<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001065 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001066</div>
1067
1068<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
1069corresponding channel in the second image as a <b>c</b>olor
1070<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1071
1072<p>The second (LUT) image is ordinarily a gradient image containing the
1073histogram mapping of how each channel should be modified. Typically it is a
1074either a single row or column image of replacement color values. If larger
1075than a single row or column, values are taken from a diagonal line from
1076top-left to bottom-right corners.</p>
1077
1078<p>The lookup is further controlled by the <a
1079href="#interpolate">-interpolate</a> setting, which is especially handy for an
1080LUT which is not the full length needed by the ImageMagick installed Quality
1081(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1082'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1083gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1084lookup of color values. </p>
1085
1086<p>This operator is especially suited to replacing a grayscale image with a
1087specific color gradient from the CLUT image. </p>
1088
1089<p>Only the channel values defined by the <a href="#channel">-channel</a>
1090setting will have their values replaced. In particular, since the default <a
1091href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1092transparency (alpha/matte channel) is not affected, unless the <a
1093href="#channel">-channel</a> setting is modified. When the alpha channel is
1094set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1095as the other channels, implying that alpha/matte values are replaced using the
1096alpha/matte values of the original image. </p>
1097
cristyd0bda5e2010-09-21 16:22:45 +00001098<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001099transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1100href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001101assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001102replacement alpha values. That is you can use a gray-scale CLUT image to
1103adjust a existing images alpha channel, or you can color a gray-scale image
1104using colors form CLUT containing the desired colors, including transparency.
1105</p>
1106
cristyefb2bdb2010-11-20 19:35:22 +00001107<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1108according to the lookup of the full color RGB value from a 2D representation
1109of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001110
1111
1112<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001113 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001114</div>
1115
1116<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>
1117
cristyefb2bdb2010-11-20 19:35:22 +00001118<p>Overlay each image in an image sequence according to
1119its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1120an animation at each point in the animation sequence. All images should be
1121the same size, and are assigned appropriate GIF disposal settings for the
1122animation to continue working as expected as a GIF animation. Such frames
1123are more easily viewed and processed than the highly optimized GIF overlay
1124images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001125
cristyefb2bdb2010-11-20 19:35:22 +00001126<p>The animation can be re-optimized after processing using
1127the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1128there is no guarantee that the restored GIF animation optimization is
1129better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001130
1131
1132<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001133 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001134</div>
1135
1136<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>
1137
cristyefb2bdb2010-11-20 19:35:22 +00001138<p>Specify the amount of colorization as a percentage. Separate colorization
1139values can be applied to the red, green, and blue channels of the image with
1140a comma-delimited list of colorization
1141values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001142
1143<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001144 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001145</div>
1146
1147<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>
1148
1149<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1150
cristyefb2bdb2010-11-20 19:35:22 +00001151<p>This option only applies when the default X server visual
1152is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1153to <a href="#visual">-visual</a> for more details. By default,
1154a shared colormap is allocated. The image shares colors with
1155other X clients. Some image colors could be approximated,
1156therefore your image may look very different than intended.
1157If <kbd>private</kbd> is chosen, the image colors appear exactly
1158as they are defined. However, other clients may go <em>technicolor</em>
1159when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001160
1161<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001162 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001163</div>
1164
1165<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>
1166
cristyefb2bdb2010-11-20 19:35:22 +00001167<p>The actual number of colors in the image may be less than your request,
1168but never more. Note that this a color reduction option. Images with fewer
1169unique colors than specified by <em class="arg">value</em> will have any
1170duplicate or unused colors removed. The ordering of an existing color
1171palette may be altered. When converting an image from color to grayscale,
1172it is more efficient to convert the image to the gray colorspace before
1173reducing the number of colors. Refer to
1174the <a href="../www/quantize.html">
1175color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001176
1177<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001178 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001179</div>
1180
1181<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>
1182
cristyefb2bdb2010-11-20 19:35:22 +00001183<p>This option permits saturation changes, hue rotation, luminance to alpha,
1184and various other effects. Although variable-sized transformation matrices
1185can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1186for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1187Adobe Flash except offsets are in column 6 rather than 5 (in support of
1188CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001189
1190<p>As an example, to add contrast to an image with offsets, try this command:</p>
1191
1192<pre class="text">
1193convert kittens.jpg -color-matrix \
1194 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1195 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1196 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1197 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1198 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1199 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1200</pre>
1201<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001202 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001203</div>
1204
1205<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>
1206
1207<p>Choices are:</p>
1208
1209<pre class="text">
1210 CMY
1211 CMYK
1212 Gray
1213 HSB
1214 HSL
1215 HWB
1216 Lab
1217 Log
1218 OHTA
1219 Rec601Luma
1220 Rec601YCbCr
1221 Rec709Luma
1222 Rec709YCbCr
1223 RGB
1224 sRGB
1225 Transparent
1226 XYZ
1227 YCbCr
1228 YCC
1229 YIQ
1230 YPbPr
1231 YUV
1232</pre>
1233
1234<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1235
1236<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>
1237
1238<table class="doc">
1239 <caption>Conversion Of RGB To Other Color Spaces</caption>
1240 <tr><th align="left" valign="middle">CMY</th></tr>
1241 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1242 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1243 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1244 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1245 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1246 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1247 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1248 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1249
1250 <tr><th align="left" valign="middle">Gray</th></tr>
1251 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1252
1253 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1254 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1255 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1256 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1257
1258 <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>
1259 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1260 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1261 <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>
1262
1263 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1264 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1265 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1266 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1267
1268 <tr><th align="left" valign="middle">LAB</th></tr>
1269 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1270 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1271 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1272
1273 <tr><th align="left" valign="middle">LOG</th></tr>
1274 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1275 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1276 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1277
1278 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1279 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1280 <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>
1281 <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>
1282
1283 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1284 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1285
1286 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1287 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1288 <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>
1289 <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>
1290
1291 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1292 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1293
1294 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1295 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1296 <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>
1297 <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>
1298
1299 <tr><th align="left" valign="middle">sRGB</th></tr>
1300 <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>
1301 <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>
1302 <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>
1303
1304 <tr><th align="left" valign="middle">XYZ</th></tr>
1305 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1306 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1307 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1308
1309 <tr><th align="left" valign="middle">YCC</th></tr>
1310 <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>
1311 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1312 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1313
1314 <tr><th align="left" valign="middle">YCbCr</th></tr>
1315 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1316 <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>
1317 <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>
1318
1319 <tr><th align="left" valign="middle">YIQ</th></tr>
1320 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1321 <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>
1322 <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>
1323
1324 <tr><th align="left" valign="middle">YPbPr</th></tr>
1325 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1326 <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>
1327 <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>
1328
1329 <tr><th align="left" valign="middle">YUV</th></tr>
1330 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1331 <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>
1332 <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>
1333</table>
1334
1335<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001336 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001337</div>
1338
1339<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>
1340
1341<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>
1342
1343<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.
1344</p>
1345
cristy4949d522010-03-12 18:41:34 +00001346<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 +00001347<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001348 <h4><a id="comment"></a>-comment <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001349</div>
1350
1351<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>
1352
cristyd0bda5e2010-09-21 16:22:45 +00001353<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001354option has been given. To modify a comment of images already in memory use
1355"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001356
cristy71a3f602010-09-15 12:38:16 +00001357<p>The comment can contain special format characters listed in the <a
1358href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001359Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001360is finally assigned to the individual images. </p>
1361
1362<p>If the first character of <em class="arg">string</em> is <em
1363class="arg">@</em>, the image comment is read from a file titled by the
1364remaining characters in the string. Comments read in from a file are literal;
1365no embedded formatting characters are recognized.</p>
1366
1367<p>Comment meta-data are not visible on the image itself. To do that use the
1368<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1369instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001370
1371<p>For example,</p>
1372
1373<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001374 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001375</p>
1376
cristy71a3f602010-09-15 12:38:16 +00001377<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1378that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1379480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001380
1381<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001382 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001383</div>
1384
1385<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>
1386
cristybc9539a2010-08-16 18:06:20 +00001387<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1388a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001389
cristybc9539a2010-08-16 18:06:20 +00001390<p>This setting effects image processing operators that merge two (or more)
1391images together in some way. This includes the operators,
1392<a href="#composite">-composite</a>,
1393<a href="#layers">-layers</a> composite,
1394<a href="#flatten">-flatten</a>,
1395<a href="#mosaic">-mosaic</a>,
1396<a href="#layers">-layers</a> merge,
1397<a href="#border">-border</a>,
1398<a href="#frame">-frame</a>,
1399and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001400
cristybc9539a2010-08-16 18:06:20 +00001401<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1402command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001403
1404
1405<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001406 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001407</div>
1408
cristybc9539a2010-08-16 18:06:20 +00001409<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 +00001410
1411<p>Take the first image 'destination' and overlay the second 'source' image
1412according to the current <a href="#compose">-compose</a> setting. The location
1413of the 'source' or 'overlay' image is controlled according to <a
1414href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1415settings. </p>
1416
1417<p>If a third image is given this is treated as a gray-scale 'mask' image
1418relative to the first 'destination' image. This mask will limit what parts of
1419the destination can be modified by the image composition. However for the
1420'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1421Y-displacement image instead. </p>
1422
1423<p>If a <a href="#compose">-compose</a> method requires extra numerical
1424arguments or flags these can be provided by setting the <a
1425href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001426appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001427
1428<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1429image outside the overlay area. You can disable this by setting the special <a
1430href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1431to '<kbd>false</kbd>'. </p>
1432
1433
1434<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001435 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001436</div>
1437
1438<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>
1439
1440<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>
1441
1442<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1443
1444<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>
1445
1446<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>
1447
1448<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>
1449
1450<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>
1451
1452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001453 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001454</div>
1455
1456<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>
1457
1458<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>
1459
1460<p>For a more pronounced effect you can repeat the option:</p>
1461
1462<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1463<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001464 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00001465</div>
1466
1467<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>
1468
cristyd934d102009-10-10 12:55:13 +00001469<p>While performing the stretch, black-out at most <em
1470class="arg" >black-point</em> pixels and white-out at most <em
1471class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1472<em class="arg" >black-point %</em> pixels and white-out at most <em
1473class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001474
cristyd934d102009-10-10 12:55:13 +00001475<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1476>-contrast-stretch</a> will black-out at most <em class="arg"
1477>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1478minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1479class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1480>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001481
cristyd934d102009-10-10 12:55:13 +00001482<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1483the image's min and max values are stretched to 0 and <em class="QR"
1484>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1485clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001486>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001487prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001488
cristyd934d102009-10-10 12:55:13 +00001489<p>Internally operator works by creating a histogram bin, and then uses that
1490bin to modify the image. As such some colors may be merged together when they
1491originally fell into the same 'bin'. </p>
1492
1493<p>All the channels are normalized in concert by the came amount so as to
1494preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001495setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001496setting will normalize the RGB channels independently.</p>
1497
1498<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1499normalization of mathematical images. </p>
1500
1501<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001502
1503
1504<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001505 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001506</div>
1507
1508<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>
1509
cristy16ff93c2010-01-13 23:18:07 +00001510<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001511a comma-separated list of integers (with no spaces), ordered left-to right,
1512starting with the top row. Presently, only odd-dimensioned kernels are
1513supported, and therefore the number of entries in the specified <em
1514class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15157<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001516
cristyd934d102009-10-10 12:55:13 +00001517<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
1518positive and negative results are relative to a user-specified bias value.
1519This is important for non-HDRI compilations of ImageMagick when dealing with
1520convolutions that contain negative as well as positive values. This is
1521especially the case with convolutions involving high pass filters or edge
1522detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001523</p>
1524
cristyd934d102009-10-10 12:55:13 +00001525<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
1526negative results without clipping to the color value range (0..QuantumRange).
1527See the discussion on HDRI implementations of ImageMagick on the page <a
1528href="/www/high-dynamic-range.html">High
1529Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1530href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1531<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1532entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001533
cristy3ed852e2009-09-05 21:47:34 +00001534
1535<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001536 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001537</div>
1538
1539<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>
1540
1541<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>
1542
1543<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>
1544
1545<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>
1546
1547<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>
1548
1549<p>By adding a exclamation character flag to the geometry argument, the
1550cropped images virtual canvas page size and offset is set as if the
1551geometry argument was a viewport or window. This means the canvas page size
1552is set to exactly the same size you specified, the image offset set
1553relative top left corner of the region cropped. </p>
1554
1555<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1556special single pixel transparent 'missed' image is returned, and a 'crop
1557missed' warning given. </p>
1558
cristy739df912009-10-24 16:10:18 +00001559<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 +00001560
1561<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001562 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001563</div>
1564
1565<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>
1566
1567<p><em class="arg">Amount</em> defines the number of positions each
1568colormap entry is shifted.</p>
1569
1570
1571<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001572 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001573</div>
1574
1575<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>
1576
1577<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>
1578
1579
1580<p>For example, to log cache and blob events, use.</p>
1581
1582<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1583<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1584
1585<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1586
1587<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1588
1589<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1590
1591<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>
1592
1593
1594<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001595 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001596</div>
1597
1598<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>
1599
1600<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1601
1602<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1603
1604
1605<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001606 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001607</div>
1608
1609<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>
1610
1611<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>
1612
1613<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>
1614
1615<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1616
1617
1618<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001619 <h4><a id="define"></a>-define <em class="arg">key</em>{<em class="arg">=value</em>}<em class="arg">...</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001620</div>
1621
cristyd0bd44a2010-09-24 12:38:11 +00001622<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
cristyd0bda5e2010-09-21 16:22:45 +00001623coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001624
cristyd0bda5e2010-09-21 16:22:45 +00001625<p>This option creates one or more definitions for coders and decoders to use
1626while reading and writing image data. Definitions are generally used to
1627control image file format coder modules, and image processing operations,
1628beyond what is provided by normal means. Defined settings are listed in <a
1629href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1630as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001631
cristyd0bda5e2010-09-21 16:22:45 +00001632<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1633definition of a flag is created with that name. This used to control on/off
1634options. Use <a href="#define">+define key</a> to remove definitions
1635previously created. Use <a href="#define">+define "*"</a> to remove all
1636existing definitions.</p>
1637
cristyd0bd44a2010-09-24 12:38:11 +00001638<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001639href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001640>value</em>"</a> option, which also allows the use of <a href="../www/escape.html" >Format and Print Image
cristyd0bda5e2010-09-21 16:22:45 +00001641Properties</a> in the defined value. </p>
1642
cristyefb2bdb2010-11-20 19:35:22 +00001643<p>The <em>option</em> and <em>key</em> are case-independent (they are
1644converted to lowercase for use within the decoders) while the <em>value</em>
1645is case-dependent.</p>
1646
cristyd0bda5e2010-09-21 16:22:45 +00001647<p>Such settings are global in scope, and effect all images and operations. </p>
1648
1649<p>The following definitions are just some of the artifacts that are
1650available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001651
cristydcca3fa2010-12-29 21:50:07 +00001652<dl>
cristy045bd902010-01-30 18:56:24 +00001653<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001654<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001655 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001656
cristy045bd902010-01-30 18:56:24 +00001657<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001658<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001659 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001660
cristy045bd902010-01-30 18:56:24 +00001661<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001662<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001663 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001664
cristy045bd902010-01-30 18:56:24 +00001665<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001666<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1667 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001668 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001669
cristy045bd902010-01-30 18:56:24 +00001670<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001671<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1672 compression factor is the reciprocal of the compression ratio. The valid
1673 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1674 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001675 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001676
cristy3ed852e2009-09-05 21:47:34 +00001677<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001678 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001679
cristy045bd902010-01-30 18:56:24 +00001680<dt>png:bit-depth=<em class="arg">value</em></dt>
1681<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001682<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1683 encoder to use a different bit-depth and color-type than it would have
1684 normally selected, but only if this does not cause any loss of image
1685 quality. Any attempt to reduce image quality is treated as an error and no
1686 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1687 can use these "defines" to cause it to be written as an 8-bit grayscale,
1688 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1689 you cannot force it to be written as a grayscale or indexed PNG. If you
1690 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1691 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1692 reduce the image quality prior to using the PNG encoder. Note that in
1693 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001694 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001695 8-bit depth.</dd>
1696
1697<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1698<dt>png:include-chunk=<em class="arg">value</em></dt>
1699<dd>ancillary chunks to be excluded from or included in PNG output.
1700
1701 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1702 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1703 or the word <em class="arg">all</em> or
1704 the word <em class="arg">none</em>. There must be no spaces in the
1705 list. Although PNG chunk-names are case-dependent, you can use
1706 all lowercase names if you prefer.</p>
1707
1708 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1709 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1710 only be written if gamma is not 1/2.2, since most decoders assume
1711 sRGB and gamma=1/2.2 when no colorspace information is included in
1712 the PNG file. Because the list is processed from left to right, you
1713 can achieve this with a single define:</p>
1714
1715<pre class="text">
1716 -define png:include-chunk=none,gAMA
1717</pre>
1718
1719 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
1720 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any of
1721 these entries appearing in the list will be ignored.</p>
1722
1723 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1724 image has transparency, the PNG colortype is forced to be 4 or 6
1725 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1726 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1727 on the PNG colortype of the output image.</p>
1728
1729 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1730 following for PNG output:</p>
1731
1732<pre class="text">
1733 -define png:include-chunk=none,gama
1734</pre>
1735
1736 <p>The default behavior is to include all known PNG ancillary chunks
cristyf7964272011-01-30 03:49:12 +00001737 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk,
1738 and to exclude all PNG chunks that are unknown to ImageMagick,
1739 regardless of their PNG "copy-safe" status as described in the
1740 PNG specification.</p>
cristydcca3fa2010-12-29 21:50:07 +00001741 </dd>
cristyd0bda5e2010-09-21 16:22:45 +00001742
cristy3ed852e2009-09-05 21:47:34 +00001743<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001744<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1745 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001746 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001747
cristy045bd902010-01-30 18:56:24 +00001748<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001749<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1750 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1751 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001752 included, the result is a single precision floating point format.
1753 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001754 double precision floating point format.</dd>
1755
cristydcca3fa2010-12-29 21:50:07 +00001756</dl>
cristy3ed852e2009-09-05 21:47:34 +00001757
cristyd0bda5e2010-09-21 16:22:45 +00001758<p>For example, to create a postscript file that will render only the black
1759pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001760
1761<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 +00001762<p>Set attributes of the image registry by prefixing the value with
1763<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1764use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001765
1766<p class="crtsnip">
1767-define registry:temporary-path=/data/tmp
1768</p>
1769
cristyd0bda5e2010-09-21 16:22:45 +00001770
1771
cristy3ed852e2009-09-05 21:47:34 +00001772<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001773 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00001774</div>
1775
1776<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>
1777
1778<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>
1779
1780<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>
1781
1782
1783<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001784 <h4><a id="delete"></a>-delete <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001785</div>
1786
1787<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>
1788
1789<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>
1790
1791
1792<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001793 <h4><a id="density"></a>-density <em class="arg">width</em><br />-density <em class="arg">width</em>x<em class="arg">height</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001794</div>
1795
1796<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>
1797
1798<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>
1799
1800<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>
1801
1802<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>
1803
1804<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>
1805
1806<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001807 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001808</div>
1809
1810<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>
1811
1812<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>
1813
1814<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001815 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00001816</div>
1817
1818<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>
1819
1820<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001821 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001822</div>
1823
1824<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>
1825
1826<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>
1827
1828<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001829 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00001830</div>
1831
1832<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>
1833
1834<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001835 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001836</div>
1837
1838<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>
1839
1840<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001841 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00001842</div>
1843
1844<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>
1845
1846<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001847is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001848what part of the 'background' image is seen at each point of the overlaid
1849area. Much like the displacement map is a 'lens' that redirects light shining
1850through it so as to present a distorted view the original 'background' image
1851behind it. </p>
1852
1853<p>Any perfect grey areas of the displacement map produce a zero
1854displacement of the image. Black areas produce the given maximum negative
1855displacement of the lookup point, while white produce a maximum positive
1856displacement of the lookup. </p>
1857
1858<p>Note that it is the lookup of the 'background' that is displaced, not a
1859displacement of the image itself. As such an area of the displacement map
1860containing 'white' will have the lookup point 'shifted' by a positive amount,
1861and thus generating a copy of the destination image to the right/downward from
1862the correct position. That is the image will look like it may have been
1863'shifted' in a negative left/upward direction. Understanding this is a very
1864important in understanding how displacement maps work. </p>
1865
1866<p>The given arguments define the maximum amount of displacement in pixels
1867that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001868it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001869outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001870easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001871into the overlay area. </p>
1872
1873<p>The '%' flag makes the displacement scale relative to the size of the
1874overlay image (100% = half width/height of image). Using '!' switches
1875percentage arguments to refer to the destination image size instead.
1876these flags were added as of IM v6.5.3-5.</p>
1877
1878<p>Normally a single grayscale displacement map is provided, which with the
1879given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001880displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001881specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001882the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001883displacement, while the <em class="arg">mask image</em> is used for vertical Y
1884displacement. This allows you to define completely different displacement
1885values for the X and Y directions, and allowing you to lookup any point within
1886the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001887any other nearby pixel, producing complex 2 dimensional displacements, rather
1888than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001889
cristyd0bda5e2010-09-21 16:22:45 +00001890<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001891you can use the 'red' channel of the overlay image to specify the horizontal
1892or X displacement, and the 'green' channel for the vertical or Y displacement.
1893</p>
1894
cristyd0bd44a2010-09-24 12:38:11 +00001895<p>As of IM v6.5.3-5 any alpha channel in the overlay image is used as a
cristy3ed852e2009-09-05 21:47:34 +00001896mask the transparency of the destination image. However areas outside the
1897overlaid areas will not be effected. </p>
1898
1899
1900<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001901 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001902</div>
1903
1904<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>
1905
1906<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1907
1908<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001909 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001910</div>
1911
1912<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>
1913
1914<p>The layer disposal method defines the way each the displayed image is to be
1915modified after the current 'frame' of an animation has finished being
1916displayed (after its 'delay' period), but before the next frame on an
1917animation is to be overlaid onto the display. </p>
1918
1919<p>Here are the valid methods:</p>
1920
1921<pre class="text">
1922Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
1923None 1 Do not dispose, just overlay next frame image.
1924Background 2 Clear the frame area with the background color.
1925Previous 3 Clear to the image prior to this frames overlay.
1926</pre>
1927
1928<p>You can also use the numbers given above, which is what the GIF format
1929uses internally to represent the above settings. </p>
1930
cristyd0bda5e2010-09-21 16:22:45 +00001931<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00001932
1933<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
1934resetting the layer disposal methods of images being read in. </p>
1935
1936<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
1937disposal method for images already in memory.</p>
1938
1939<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001940 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001941</div>
1942
1943<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>
1944
1945
1946<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001947 <h4><a id="dissolve"></a>-dissolve <em class="arg">src_percent</em>[x<em class="arg">dst_percent</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00001948</div>
1949
1950<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>
1951
1952<p>The opacity of the composite image is multiplied by the given percent, then
1953it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00001954is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00001955transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
1956are given, each image are dissolved to the percentages given. </p>
1957
1958<p>Note that dissolve percentages do not add, two opaque images dissolved
1959'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
1960images, you would need to use dissolve values of '50,100'. </p>
1961
1962<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001963 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001964</div>
1965
1966<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>
1967
1968<p>The <em class="arg">arguments</em> is a single string containing a list
1969of floating point numbers separated by commas or spaces. The number of
1970and meaning of the floating point values depends on the distortion <em
1971class="arg">method</em> being used. </p>
1972
1973<p>Choose from these distortion types:</p>
1974
1975<table class="doc">
1976 <tr valign="top">
1977 <th align="left" style="width: 8%">Method</th>
1978 <th align="left">Description</th>
1979 </tr>
1980
1981 <tr valign="top">
1982 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
1983 <br/>or &nbsp; <kbd>SRT</kbd></td>
1984 <td valign="top">
1985 Distort image by first scaling and rotating about a given 'center',
1986 before translating that 'center' to the new location, in that order. It
1987 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
1988 distortion, but without shearing effects. It also provides a good way
1989 of rotating and displacing a smaller image for tiling onto a larger
1990 background (IE 2-dimensional animations). <br/>
1991
1992 The number of arguments determine the specific meaning of each
1993 argument for the scales, rotation, and translation operations. <br/>
1994
1995 <table style="margin-left:auto; margin-right:auto;">
1996 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
1997 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
1998 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00001999 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002000 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
2001 <tr><td>5:</td>
2002 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2003 <tr><td>6:</td>
2004 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
2005 <tr><td>7:</td>
2006 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
2007 &nbsp; NewX,NewY</em></td></tr>
2008 </table>
2009
cristyd0bda5e2010-09-21 16:22:45 +00002010 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00002011 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2012
2013 <tr valign="top">
2014 <td valign="top"><kbd>Affine</kbd></td>
2015 <td valign="top">
2016 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00002017 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002018 point values are given allowing the image to be linearly scaled,
2019 rotated, sheared, and translated, according to those three points. See
2020 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2021 distortions. <br/>
2022
2023 More than 3 sets given control point pairs (12 numbers) is least
2024 squares fitted to best match a lineary affine distortion. If only 2
2025 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002026 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002027 flipping or changes in aspect ratio to the resulting image. If only one
2028 control point pair is provides the image is only translated, (which may
2029 be a floating point non-integer translation). <br/>
2030
2031 This distortion does not include any form of perspective distortion.
2032 </td>
2033
2034 </tr>
2035
2036 <tr valign="top">
2037 <td valign="top"><kbd>AffineProjection</kbd></td>
2038 <td valign="top">
2039 Linearly distort an image using the given Affine Matrix of 6
2040 pre-calculated coefficients forming a set of Affine Equations to map
2041 the source image to the destination image.
2042
2043 <div style="text-align: center"><em>
2044 s<sub>x</sub>, r<sub>x</sub>,
2045 r<sub>y</sub>, s<sub>y</sub>,
2046 t<sub>x</sub>, t<sub>y</sub>
2047 </em></div>
2048
2049 See <a href="#affine" >-affine</a> setting for more detail, and
2050 meanings of these coefficients. <br/>
2051
2052 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002053 alternative methods of defining this distortion, with ImageMagick doing
2054 the calculations needed to generate the required coefficients. You can
2055 see the internally generated coefficients, by using a <a
2056 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002057
2058 </tr>
2059
cristy3ed852e2009-09-05 21:47:34 +00002060 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002061 <td valign="top"><kbd>BilinearForward</kbd><br/>
2062 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002063 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002064 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2065 16 values (see below). Not that lines may not appear straight after
2066 distortion, though the distance between coordinates will remain
2067 consistent. <br/>
2068
2069 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2070 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2071 quadrilateral to a rectangle, while preserving the straigth line edges
2072 in each case. <br/>
2073
2074 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2075 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2076 color setting. Also if the quadraterial becomes 'flipped' the image
2077 may dissappear. <br/>
2078
2079 There are future plans to produce a true Bilinear distortion that will
2080 attempt to map any quadrilateral to any other quadrilateral, while
2081 preserving edges (and edge distance ratios).
2082
2083 </td>
cristy3ed852e2009-09-05 21:47:34 +00002084 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002085
2086 <tr valign="top">
2087 <td valign="top"><kbd>Perspective</kbd></td>
2088 <td valign="top">
2089 Perspective distort the images, using a list of 4 or more sets of
2090 control points (as defined below). More that 4 sets (16 numbers) of
2091 control points provide least squares fitting for more accurate
2092 distortions (for the purposes of image registration and panarama
2093 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2094 linear distortion. <br/>
2095
2096 Perspective Distorted images ensures that straight lines remain
2097 straight, but the scale of the distorted image will vary. The horizon
2098 is anti-aliased, and the 'sky' color may be set using the
2099 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2100 </tr>
2101
2102 <tr valign="top">
2103 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2104 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002105 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002106 pre-calculated coefficients. You can get these coefficients by looking
2107 at the <a href="#verbose" >-verbose</a> output of a
2108 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2109 If the last two perspective scaling coefficients are zero, the
2110 remaining 6 represents a transposed 'Affine Matrix'. </td>
2111
2112 </tr>
2113
2114 <tr valign="top">
2115 <td valign="top"><kbd>Arc</kbd></td>
2116 <td valign="top">
2117 Arc the image (variation of polar mapping) over the angle given around
2118 a circle. <br/>
2119 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2120 <tr valign="top"><td>Argument</td>
2121 <td>Meaning</td></tr>
2122 <tr valign="top"><td><em>arc_angle</em></td>
2123 <td>The angle over which to arc the image side-to-side</td></tr>
2124 <tr valign="top"><td><em>rotate_angle</em></td>
2125 <td>Angle to rotate resulting image from vertical center</td></tr>
2126 <tr valign="top"><td><em>top_radius</em></td>
2127 <td>Set top edge of source image at this radius</td></tr>
2128 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2129 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2130 </table>
2131
2132 The resulting image is always resized to best fit the resulting image,
2133 (as if using <a href="#distort" >+distort</a>) while attempting to
2134 preserve scale and aspect ratio of the original image as much as
2135 possible with the arguments given by the user. All four arguments will
2136 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2137
2138 This a variation of a polar distortion designed to try to preserve the
2139 aspect ratio of the image rather than direct Cartesian to Polar
2140 conversion. </td>
2141 </tr>
2142
2143 <tr valign="top">
2144 <td valign="top"><kbd>Polar</kbd></td>
2145 <td valign="top">
2146 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2147 the image. that is the height of the input image is mapped to the
2148 radius limits, while the width is wrapped around between the
2149 angle limits. <br/>
2150
2151 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2152
2153 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2154 center to the center of the image, and the angles going from -180 (top)
2155 to +180 (top). If <em>Rmax</em> is given the special value of
2156 '<code>0</code>', the the distance from the center to the nearest edge
2157 is used for the radius of the output image, which will ensure the whole
2158 image is visible (though scaled smaller). However a special value of
2159 '<code>-1</code>' will use the distance from the center to the furthest
2160 corner, This may 'clip' the corners from the input rectangular image,
2161 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2162 the same arguments. <br/>
2163
2164 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2165 output image center will default to <code>0,0</code> of the virtual
2166 canvas, and the image size adjusted to ensure the whole input image is
2167 made visible in the output image on the virtual canvas. </td>
2168
2169 </tr>
2170
2171 <tr valign="top">
2172 <td valign="top"><kbd>DePolar</kbd></td>
2173 <td valign="top">
2174 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2175 but generates the reverse Polar to Cartesian distortion. <br/>
2176
2177 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2178 the corners of the input image. However using the special
2179 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2180 distance) will ensure the whole distorted image is preserved in the
2181 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2182 reverse the distortion re-producing the original.
2183
2184 Note that as this distortion requires the area resampling of a circular
2185 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002186 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002187 form of 'super-sampling' image processing technique be used to produce
2188 a high quality result. </td>
2189
2190 </tr>
2191
2192 <tr valign="top">
2193 <td valign="top"><kbd>Barrel</kbd></td>
2194 <td valign="top">
2195 Given the four coefficients (A,B,C,D) as defined by <a
2196 href="http://www.all-in-one.ee/~dersch/barrel/barrel.html" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002197 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002198 correct radial lens distortions. That is in photographs, make straight
2199 lines straight again. <br/>
2200
2201 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2202 <em>X</em> , <em>Y</em> ] ] <br/>
2203 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2204 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2205 [ <em>X</em> , <em>Y</em> ] <br/>
2206 So that it forms the function <br/>
2207 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2208 <em>C</em>*r + <em>D</em> )<br/>
2209
2210 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2211 (defaulting to the center of the image). <br/>
2212 The second form is typically used to distort images, rather than
2213 correct lens distortions. <br/>
2214 </td>
2215
2216 </tr>
2217
2218 <tr valign="top">
2219 <td valign="top"><kbd>BarrelInverse</kbd></td>
2220 <td valign="top">
2221 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2222 arguments, and argument handling. However it uses the inverse
2223 of the radial polynomial,
2224 so that it forms the function <br/>
2225 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002226 <em>C</em>*r + <em>D</em> )<br/>
2227 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2228 distortion, just a different barrel-like radial distortion method.
2229
cristy3ed852e2009-09-05 21:47:34 +00002230 </td>
2231 </tr>
2232
2233 <tr valign="top">
2234 <td valign="top"><kbd>Shepards</kbd></td>
2235 <td valign="top">
2236 Distort the given list control points (any number) using an Inverse
2237 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002238 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2239 Method</a>). The control points in effect do 'localized' displacement
2240 of the image around the given control point (preserving the look and
2241 the rotation of the area near the control points. For best results
2242 extra control points should be added to 'lock' the positions of the
2243 corners, edges and other unchanging parts of the image, to prevent
2244 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002245
cristyd0bd44a2010-09-24 12:38:11 +00002246 The distortion has been likened to 'taffy pulling' using nails, or
2247 pins' stuck in a block of 'jelly' which is then moved to the new
2248 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002249
cristyd0bd44a2010-09-24 12:38:11 +00002250 Internally it is equivelent to generating a displacement map (see <a
2251 href="#displace" >-displace</a>) for source image color look-up using
2252 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2253
2254 </td>
cristy3ed852e2009-09-05 21:47:34 +00002255 </tr>
2256
2257</table>
2258
cristyd0bd44a2010-09-24 12:38:11 +00002259<p>To print a complete list of distortion methods, use <a href="#list">-list
2260distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002261
2262<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2263'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2264defining how these points in the given image should be distorted in the
2265destination image. Each set of four floating point values represent a source
2266image coordinate, followed immediately by the destination image coordinate.
2267This produces a list of values such as...</p>
2268<div style="text-align: center"><em>
2269 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2270 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2271 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2272 ... &nbsp;
2273 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2274</em></div>
2275<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2276destination image. </p>
2277
2278<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2279needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2280perspective distortion of the built-in "rose:" image. Note how spaces were
2281used to group the 4 sets of coordinate pairs, to make it easier to read and
2282understand.</p>
2283
2284<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002285convert rose: -virtual-pixel black \<br/>
2286 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2287 rose_3d_rotated.gif</span></p>
2288<p>If more that the required number of coordinate pairs are given for
2289a distortion, the distortion method is 'least squares' fitted to produce the
2290best result for all the coordinate pairs given. If less than the ideal number
2291of points are given, the distort will generally fall back to a simpler form of
2292distortion that can handles the smaller number of coordinates (usally a linear
2293'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002294
cristyd0bda5e2010-09-21 16:22:45 +00002295<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002296find matching coordinate pairs in overlapping images, so as to improve the
2297'fit' of the distortion. Of course a bad coordinate pair can also make the
2298'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002299
2300<p>Colors are acquired from the source image according to the <a
2301href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002302magnified. However if the viewed image is minified (image becomes smaller),
2303a special area resampling function (added ImageMagick v6.3.5-9), is used to
2304produce a higher quality image. For example you can use
2305a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2306the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002307
cristyd0bd44a2010-09-24 12:38:11 +00002308<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2309convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2310 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2311 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002312<p>Note that a infinitely tiled perspective images involving the horizon can
2313be very slow to generate due to the use of the high quality 'area resampling'
2314function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2315using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2316(recommended if you plan to use super-sampling instead). </p>
2317
2318<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2319'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2320will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2321pixels. If you do not what these pixels to be visible, set the color to match
2322the rest of the ground. </p>
2323
2324<p>The output image size will by default be the same as the input image. This
2325means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002326the 'distorted space', those parts is clipped and lost. However if you use
2327the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2328will attempt (if possible) to show the whole of the distorted image, while
2329retaining a correct 'virtual canvas' offset, for image layering. This offset
2330may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2331is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002332
2333<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2334option:distort:viewport {geometry_string}</kbd>" setting which will specify
2335the size and the offset of the generated 'viewport' image of the distorted
2336image space.</p>
2337
2338<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2339{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2340that factor without changing the viewed contents of the distorted image. This
2341can be used either for 'super-sampling' the image for a higher quality result,
2342or for panning and zooming around the image (with appropriate viewport
2343changes, or post-distort cropping and resizing). </p>
2344
2345<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2346href="#distort" >-distort</a> to attempt to output the internal coefficients,
2347and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2348and debugging purposes. This many not be available for all distorts. </p>
2349
2350<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2351produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2352and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002353above settings. It is algorithmically slower however, though that may not be
2354the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002355
2356
2357<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002358 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002359</div>
2360
2361<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>
2362
cristyd0bda5e2010-09-21 16:22:45 +00002363<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 +00002364
2365<p>Dithering is turned on by default, to turn it off use the plus form of the
2366setting, <a href="#dither">+dither</a>. This will also also render PostScript
2367without text or graphic aliasing. Disabling dithering often (but not always)
2368leads to faster process, a smaller number of colors, but more cartoon like
2369image coloring. Generally resulting in 'color banding' effects in areas with
2370color gradients. </p>
2371
2372<p>The color reduction operators <a href="#colors">-colors</a>, <a
2373href="#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>
2374
2375<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>
2376
2377
2378<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002379 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002380</div>
2381
2382<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>
2383
2384<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>
2385
2386<p>The shape primitives:</p>
2387
2388<pre class="text">
2389 point x,y
2390 line x0,y0 x1,y1
2391 rectangle x0,y0 x1,y1
2392 roundRectangle x0,y0 x1,y1 wc,hc
2393 arc x0,y0 x1,y1 a0,a1
2394 ellipse x0,y0 rx,ry a0,a1
2395 circle x0,y0 x1,y1
2396 polyline x0,y0 ... xn,yn
2397 polygon x0,y0 ... xn,yn
2398 bezier x0,y0 ... xn,yn
2399 path path specification
2400 image operator x0,y0 w,h filename
2401</pre>
2402
2403<p>The text primitive:</p>
2404
2405<pre class="text">
2406 text x0,y0 string
2407</pre>
2408<p>The text gravity primitive:</p>
2409
2410<pre class="text">
2411 gravity NorthWest, North, NorthEast, West, Center,
2412 East, SouthWest, South, or SouthEast
2413</pre>
2414
2415<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>
2416
2417<p>The transformation primitives:</p>
2418
2419<pre class="text">
2420 rotate degrees
2421 translate dx,dy
2422 scale sx,sy
2423 skewX degrees
2424 skewY degrees
2425</pre>
2426
2427<p>The pixel operation primitives:</p>
2428
2429<pre class="text">
2430 color x0,y0 method
2431 matte x0,y0 method
2432</pre>
2433
2434<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>
2435
2436<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>
2437
2438<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2439
2440<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2441
2442<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>
2443
2444<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2445
2446<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>
2447
2448<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>
2449
2450<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>.
2451</p>
2452
2453<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2454
2455<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2456
2457<p class="crtsnip">
2458 -draw 'circle 100,100 150,150'
2459</p>
2460
2461<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
2462draw 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>
2463
2464<p class="crtsnip">
2465 -draw 'bezier 20,50 45,100 45,0 70,50'
2466</p>
2467<p class="crtsnip">
2468 -draw 'bezier 70,50 95,100 95,0 120,50'
2469</p>
2470
2471
2472<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>
2473
2474<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>
2475
2476<p class="crtsnip">
2477 -draw 'image SrcOver 100,100 225,225 image.jpg'
2478</p>
2479
cristybc9539a2010-08-16 18:06:20 +00002480<p>You can use 0,0 for the image size, which means to use the actual
2481dimensions found in the image header. Otherwise, it is scaled to the given
2482dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
2483a detailed discussion of alpha composition methods that are available. </p>
cristy3ed852e2009-09-05 21:47:34 +00002484
2485<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>
2486
2487<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2488
2489<p class="crtsnip">
2490 -draw 'text 100,100 "Works like magick!"'
2491</p>
2492
2493<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2494
2495<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>
2496
2497<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2498
2499<p>The <kbd>scale</kbd> primitive scales them.</p>
2500
2501<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>
2502
2503<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
2504matrix.</p>
2505
2506<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>
2507
2508<pre class="text">
2509 point
2510 replace
2511 floodfill
2512 filltoborder
2513 reset
2514</pre>
2515
2516<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>
2517
2518<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>
2519
2520<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>
2521
2522<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2523
2524<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2525
2526
2527<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002528 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002529</div>
2530
2531<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>
2532
2533<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002534 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002535</div>
2536
2537<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>
2538
2539<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002540 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002541</div>
2542
2543<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>
2544
2545<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2546
2547<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2548
cristyd0bda5e2010-09-21 16:22:45 +00002549
2550
cristy3ed852e2009-09-05 21:47:34 +00002551<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002552 <h4><a id="encoding"></a>-encoding <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002553</div>
2554
2555<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>
2556
2557<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>
2558
2559<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002560 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002561</div>
2562
2563<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>
2564
2565<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2566
2567<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2568
2569
2570<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002571 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002572</div>
2573
2574<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>
2575
2576
2577<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002578 <h4><a id="equalize"></a>-equalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00002579</div>
2580
2581<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>
2582
2583<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>
2584
2585<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2586
2587<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>
2588
2589<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002590 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002591</div>
2592
2593<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>
2594
2595<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>
2596
2597<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>
2598
2599<table class="doc">
2600 <col width="25%" />
2601 <col width="75%" />
2602 <thead>
2603 <tr>
2604 <th><em class="arg">operator</em></th>
2605 <th>Summary (see further below for details)</th>
2606 </tr>
2607 </thead>
2608 <tbody>
2609
cristy3c98a4f2010-08-13 20:09:41 +00002610 <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 +00002611 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2612 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2613 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2614 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2615 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002616 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2617 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002618 <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>
2619 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2620 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002621 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002622 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002623 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2624 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2625 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2626 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2627 <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>
2628 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2629 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2630 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2631 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2632
2633 <tr><td>&nbsp;</td></tr>
2634
2635 <tr><td>Gaussian-noise</td></tr>
2636 <tr><td>Impulse-noise</td></tr>
2637 <tr><td>Laplacian-noise</td></tr>
2638 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2639 <tr><td>PoissonNoise</td></tr>
2640 <tr><td>Uniform-noise</td></tr>
2641
2642 <tr><td>&nbsp;</td></tr>
2643
2644 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2645 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2646 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2647 </tbody>
2648 </table>
2649
2650<p>The specified functions are applied only to each previously set <a
2651href="#channel" >-channel</a> in the image. If necessary, the results of the
2652calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2653class="QR">QuantumRange</em>]. The transparency channel of the image is
2654represented as a 'alpha' values (0 = fully transparent), so, for example, a
2655<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2656semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2657as a percentage of the <em class="QR">QuantumRange</em>.</p>
2658
2659<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2660<a href="#list">-list evaluate</a>.</p>
2661
2662<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2663<kbd>Multiply</kbd> methods can also be achieved using either the <a
2664href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2665appropriate argument, to linearly modify the overall range of color values.
2666Please note, however, that <a href="#level" >-level</a> treats transparency as
2667'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2668'alpha' values.</p>
2669
2670<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>
2671
cristyce66ab12010-10-21 23:36:32 +00002672<p><kbd>Exp or Exponential</kbd> has been added as of ImageMagick 6.6.5-1 and works on normalized pixel values. The <em class="arg">value</em> used with <kbd>Exp</kbd> should be negative so as to produce a decaying exponential function. Non-negative values will always produce results larger unity and thus outside the interval [0,&nbsp;<em class="QR">QuantumRange</em>]. The formula is expressed below. </p>
2673
2674 <div style="text-align:center;">
2675 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2676 </div>
2677
2678<p> If the input image is squared, for example, using <a
2679href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2680
cristy3ed852e2009-09-05 21:47:34 +00002681<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>
2682
2683 <div style="text-align:center;">
2684 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2685 </div>
2686
2687<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2688normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2689href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2690to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2691with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2692with <kbd>Pow</kbd>.</p>
2693
2694<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2695converts the image values into a value according to a (co)sine wave function.
2696The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2697is biased 50% and normalized by 50% so as to fit in the respective color value
2698range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2699function (its frequency), and thus determines the number of 'waves' that will
2700be generated over the input color range. For example, if the <em
2701class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2702class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2703then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002704class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002705
2706 <div style="text-align:center;">
2707 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2708 </div>
2709
cristydcca3fa2010-12-29 21:50:07 +00002710<p>See also the <a href="#function" >-function</a> operator, which is a
2711multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002712
cristy63fed272010-03-07 19:08:45 +00002713<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002714 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002715</div>
2716
2717<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 +00002718
2719<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002720 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002721</div>
2722
2723<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>
2724
cristy3e2860c2010-01-24 01:36:30 +00002725<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>
cristy549177c2010-11-11 13:51:21 +00002726<p>This command reduces or expands a JPEG image to fit on an 800x600
2727display. If the aspect ratio of the input image isn't exactly 4:3, then the
2728image is centered on an 800x600 black canvas: </p>
2729
2730<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert input.jpg -resize 800x600 -background black -compose Copy \ <br /> -gravity center -extent 800x600 -quality 92 output.jpg</span></p>
2731
cristy3ed852e2009-09-05 21:47:34 +00002732
2733<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>
2734
2735<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002736 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002737</div>
2738
2739<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>
2740
2741<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2742
cristy4949d522010-03-12 18:41:34 +00002743<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 +00002744
cristy4949d522010-03-12 18:41:34 +00002745<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>
cristyd0bd44a2010-09-24 12:38:11 +00002746<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002747equivalent to:</p>
2748
2749<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>
2750<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>
2751
2752<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002753 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002754</div>
2755
2756<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>
2757
2758<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).
2759</p>
2760
2761<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>.
2762</p>
2763
2764<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002765 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002766</div>
2767
2768<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>
2769
2770<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002771 <h4><a id="fft"></a>-fft</h4>
cristy3ed852e2009-09-05 21:47:34 +00002772</div>
2773
2774<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>
2775
cristydcca3fa2010-12-29 21:50:07 +00002776<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">Fourier Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002777
cristydcca3fa2010-12-29 21:50:07 +00002778<p>A single image name is provided as output for this option. However, the output result will have two components. It is 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">Complex Numbers</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002779
2780<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>
2781
2782<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2783<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>
2784
2785<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2786<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>
2787
cristyd0bd44a2010-09-24 12:38:11 +00002788<p>The input image can be any size, but if not square and even-dimensioned, it is 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 is square at this size. The kind of padding relies on the <a href="#virtual-pixel">-virtual-pixel</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +00002789
2790<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>
2791
2792<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2793 -evaluate log 1000 fft_image_spectrum.png</span></p>
2794<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>
2795
cristydcca3fa2010-12-29 21:50:07 +00002796<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to use <a href="#fft">-fft</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002797
2798<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>
2799
2800<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>
2801
cristydcca3fa2010-12-29 21:50:07 +00002802<p>The real and imaginary component images resulting from <a href="#fft">+fft</a> is also square, even dimensioned images due to the same padding that was discussed above for the magnitude and phase component images.</p>
cristy3ed852e2009-09-05 21:47:34 +00002803
2804<p>See the discussion on HDRI implementations of ImageMagick on the page
2805<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.
2806</p>
2807
2808
2809<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002810 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002811</div>
2812
2813<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>
2814
2815<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>
2816
2817<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2818
2819<p>For example,</p>
2820
2821<p class="crtsnip">
2822 -fill blue
2823</p>
2824<p class="crtsnip">
2825 -fill "#ddddff"
2826</p>
2827<p class="crtsnip">
2828 -fill "rgb(255,255,255)"
2829</p>
2830
2831<p>See <a href="#draw">-draw</a> for further details.</p>
2832
2833<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2834
2835<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002836 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002837</div>
2838
cristyd0bda5e2010-09-21 16:22:45 +00002839<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
2840distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002841
cristyd0bda5e2010-09-21 16:22:45 +00002842<p>Use this option to affect the resizing operation of an image during
2843operations such as <a href="#resize">-resize</a> and <a href="#distort"
2844>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002845
2846<pre class="text">
2847 Point Hermite Cubic
2848 Box Gaussian Catrom
2849 Triangle Quadratic Mitchell
2850</pre>
2851
cristyd0bda5e2010-09-21 16:22:45 +00002852<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002853as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2854generally useless on their own as they are infinite filters that are being
2855clipped to the filters support size. Their direct use is not recommended
2856except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002857
cristydcca3fa2010-12-29 21:50:07 +00002858<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002859function that the <a href="#filter" >-filter</a> setting defines. That is
2860using these functions will define a 'Windowed' filter, appropriate to the
2861operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002862
2863<pre class="text">
2864 Lanczos Hamming Parzen
2865 Blackman Kaiser Welsh
2866 Hanning Bartlett Bohman
2867</pre>
2868
2869<p>Also one special self-windowing filter is also provided
2870<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2871on the current 'support' or 'lobes' expert settings (see below).</p>
2872
cristyd0bda5e2010-09-21 16:22:45 +00002873<p>If you do not select a filter with this option, the filter defaults to
2874<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2875if the image is enlarged. Otherwise the filter default to
2876<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002877
cristyd0bda5e2010-09-21 16:22:45 +00002878<p>To print a complete list of resize filters, use the <a href="#list">-list
2879filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002880
2881<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002882use of these expert settings (see also <a href="#define" >-define</a> and <a
2883href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002884
2885<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002886<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002887<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002888 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2889 Gaussian-like filters simple filters, or you may not get the expected
2890 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002891
cristyd0bda5e2010-09-21 16:22:45 +00002892<dt>-define filter:support=<em>radius</em></dt>
2893<dd>Set the filter support radius. Defines how large the filter should be and
2894 thus directly defines how slow the filtered resampling process is. All
2895 filters have a default 'prefered' support size. Some filters like
2896 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2897 this value. With simple filters this value either does nothing (but slow
2898 the resampling), or will clip the filter function in a detrimental way.
2899 </dd>
cristy3ed852e2009-09-05 21:47:34 +00002900
cristyd0bda5e2010-09-21 16:22:45 +00002901<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002902<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00002903 alternative way of specifying the 'support' range of the filter, that is
2904 designed to be more suited to windowed filters, especially when used for
2905 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002906
cristyd0bda5e2010-09-21 16:22:45 +00002907<dt>-define filter:b=<em>b-spline_factor</em></dt>
2908<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002909<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2910 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2911 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2912 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00002913 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00002914 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002915
cristyd0bda5e2010-09-21 16:22:45 +00002916<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002917<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00002918 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00002919 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00002920 'Bessel' functions. If defined, no windowing function is used, unless the
2921 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002922
cristyd0bda5e2010-09-21 16:22:45 +00002923<dt>-define filter:window=<em>filter_function</em></dt>
2924<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
2925 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
2926 support range) with the given filter. This allows you to specify a filter
2927 function that is not normally used as a windowing function, such as
2928 <kbd>Box</kbd>, (which effectively turns off the windowing function),
2929 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
2930 </dd>
2931
2932<dt>-define filter:verbose=<em>1</em></dt>
2933<dd>This causes IM to print information on the final internal filter
2934 selection to standard output. This includes a commented header on the
2935 filter settings being used, and data allowing the filter weights to be
2936 easily graphed. </dd>
2937
2938<dd>Note however that some filters are internally defined in terms of other
2939 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
2940 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
2941 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
2942 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002943
2944</dl>
2945
cristyd0bda5e2010-09-21 16:22:45 +00002946<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00002947
2948<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
2949 -set filter:window=bessel -set filter:lobes=8 \ <br/>
2950 -resize 150% image.jpg</span></p>
2951<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
2952
2953<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
2954 -resize 150% image.jpg</span></p>
2955<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00002956filters, and 'verbose' for viewing the internal filter selection), are
2957provided for image processing experts who have studied and understood how
2958resize filters work. Without this knowledge, and an understanding of the
2959definition of the actual filters involved, using expert settings are more
2960likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00002961
2962
2963<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002964 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00002965</div>
2966
2967<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>
2968
2969
2970<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002971 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00002972</div>
2973
2974<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>
2975
2976<p>reflect the scanlines in the vertical direction.</p>
2977
2978<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002979 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00002980</div>
2981
2982<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>
2983
2984<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002985 <h4><a id="flop"></a>-flop</h4>
cristy3ed852e2009-09-05 21:47:34 +00002986</div>
2987
2988<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>
2989
2990<p>reflect the scanlines in the horizontal direction.</p>
2991
2992
2993<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002994 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002995</div>
2996
2997<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>
2998
2999<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>
3000
3001<p>In addition to the fonts specified by the above pre-defined list, you can
3002also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
3003is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
3004<kbd>x:fixed</kbd> is X11 font.</p>
3005
3006<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>
3007
3008
3009<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003010 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003011</div>
3012
3013<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>
3014
3015<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3016
3017<p>The default foreground color is black.</p>
3018
3019<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003020 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003021</div>
3022
3023<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>
3024
3025<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>
3026
3027<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>
3028
3029<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003030 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003031</div>
3032
3033<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>
3034
3035<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>
3036
3037<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003038 <h4><a id="frame"></a>-frame <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003039</div>
3040
3041<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>
3042
cristybc9539a2010-08-16 18:06:20 +00003043<p>The color of the border is specified with the <a href="#mattecolor"
3044>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003045
cristybc9539a2010-08-16 18:06:20 +00003046<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
3047class="arg">geometry</em> argument indicates the amount of extra width and
3048height that is added to the dimensions of the image. If no offsets are given
3049in the <em class="arg">geometry</em> argument, then the border added is
3050a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3051the width and height of the border is partitioned to form an outer bevel of
3052thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3053<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3054</p>
3055
3056<p>The <a href="#frame">-frame</a> option is affected by the current <a
3057href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003058'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003059size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3060draws the frame of four distinct colors close to the current <a
3061href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3062center of this image. This means that with the default compose method of
3063'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3064href="#bordercolor">-bordercolor</a> setting.</p>
3065
3066<p>The image composition is not
3067affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003068
3069
3070<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003071 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003072</div>
3073
3074<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>
3075
3076<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003077 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003078</div>
3079
3080<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>
3081
3082<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>
3083
3084<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>
3085
3086<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>
3087
3088<pre class="text">
3089 Polynomial
3090 Sinusoid
3091 Arcsin
3092 Arctan
3093</pre>
3094
3095<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3096
3097<dl class="doc">
3098<dt><kbd>Polynomial</kbd></dt>
3099<dd>
3100<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>
3101
3102<div style="text-align: center">
3103 -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>
3104</div>
3105
3106<p>will invoke a polynomial function given by</p>
3107
3108<div style="text-align: center">
3109 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3110 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3111 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3112</div>
3113
3114<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3115
3116<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>
3117
3118<table class="doc">
3119 <col width="35%" />
3120 <col width="35%" />
3121 <col width="30%" />
3122 <tr>
3123 <td>-evaluate Set <em class="arg">value</em> </td>
3124 <td>-function Polynomial <em class="arg">value</em></td>
3125 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3126 </tr>
3127 <tr>
3128 <td>-evaluate Add <em class="arg">value</em> </td>
3129 <td>-function Polynomial 1,<em class="arg">value</em></td>
3130 </tr>
3131 <tr>
3132 <td>-evaluate Subtract <em class="arg">value</em> </td>
3133 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3134 </tr>
3135 <tr>
3136 <td>-evaluate Multiply <em class="arg">value</em> </td>
3137 <td>-function Polynomial <em class="arg">value</em>,0</td>
3138 </tr>
3139 <tr>
3140 <td>+level black% x white%</td>
3141 <td>-function Polynomial A,B</td>
3142 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3143 </tr>
3144</table>
3145
3146<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>
3147</dd>
3148
3149<dt><kbd>Sinusoid</kbd></dt>
3150<dd>
3151<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>
3152
3153<div style="text-align: center">
3154 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3155</div>
3156
3157<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>
3158
3159<div style="text-align: center">
3160<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>
3161</div>
3162
3163<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>
3164
3165<p class="crtsnip">
3166 -function Sinusoid 3,-90,.2,.7
3167</p>
3168
3169<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>
3170
3171<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>
3172
3173<table class="doc">
3174 <tr>
3175 <td>-evaluate Sin <em class="arg">freq</em> </td>
3176 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3177 </tr>
3178 <tr>
3179 <td>-evaluate Cos <em class="arg">freq</em> </td>
3180 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3181 </tr>
3182</table>
3183</dd>
3184
3185<dt><kbd>ArcSin</kbd></dt>
3186<dd>
3187<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3188and can be used to generate cylindrical distortion and displacement maps.
3189The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003190of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003191
cristydcca3fa2010-12-29 21:50:07 +00003192<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003193 -function <kbd>ArcSin</kbd> <em class="arg">width</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
cristydcca3fa2010-12-29 21:50:07 +00003194</p>
cristy3ed852e2009-09-05 21:47:34 +00003195
3196<p>with all values given in terms of noramlize color values (0.0 for black,
31971.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3198for bout input (<em class="arg">width</em>), and output (<em
3199class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3200
cristydcca3fa2010-12-29 21:50:07 +00003201<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003202<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>
cristydcca3fa2010-12-29 21:50:07 +00003203</p>
cristy3ed852e2009-09-05 21:47:34 +00003204
3205</dd>
3206
3207<dt><kbd>ArcTan</kbd></dt>
3208<dd>
3209<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3210limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003211All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003212
cristydcca3fa2010-12-29 21:50:07 +00003213<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003214 -function <kbd>ArcTan</kbd> <em class="arg">slope</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
cristydcca3fa2010-12-29 21:50:07 +00003215</p>
cristy3ed852e2009-09-05 21:47:34 +00003216
3217<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3218</p>
3219
cristydcca3fa2010-12-29 21:50:07 +00003220<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003221<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>
cristydcca3fa2010-12-29 21:50:07 +00003222</p>
cristy3ed852e2009-09-05 21:47:34 +00003223
3224</dd>
3225
3226</dl>
3227
3228
3229<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003230 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003231</div>
3232
3233<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>
3234
3235<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>
3236
3237<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>
3238
3239
3240<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003241 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003242</div>
3243
3244<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>
3245
3246<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>
3247
3248<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3249
3250
3251<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003252 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003253</div>
3254
3255<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>
3256
3257<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>
3258
3259<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>
3260
3261<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>
3262
3263<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>
3264
3265<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3266
3267<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003268 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00003269</div>
3270
3271<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>
3272
cristyb15553d2010-07-03 22:53:14 +00003273<p>Convolve the image with a Gaussian or normal distribution using the given
3274<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003275
3276<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3277</div>
3278
cristyb15553d2010-07-03 22:53:14 +00003279<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003280determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003281
3282<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003283array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003284integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003285radius that will provide meaningful results for the Gaussian distribution.
3286</p>
3287
3288<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3289operation is. However too small a <em class="arg" >Radius</em>, and sever
3290aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3291should be at least twice the <em class="arg" >Sigma</em> value, though three
3292times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003293
3294<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003295full 2-dimensional convolution is used to generate the weighted average of the
3296neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003297
3298<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3299pixels which are outside the image proper are blurred into the final result.
3300</p>
3301
3302
3303<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003304 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003305</div>
3306
3307<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>
3308
3309<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>
3310
3311<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003312 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003313</div>
3314
3315<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>
3316
3317<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3318<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3319<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3320list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3321installation.</p>
3322
3323<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>
3324
3325<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>
3326
3327<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>
3328
cristy4949d522010-03-12 18:41:34 +00003329<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 +00003330<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>
3331
3332<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>
3333
3334
3335<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003336 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003337</div>
3338
3339<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>
3340
3341
3342<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003343 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003344</div>
3345
3346<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>
3347
3348<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3349dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3350can apply any color transformation to the Hald image and then use this option
3351to apply the transform to the image. </p>
3352
3353<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3354<p>This option provides a convenient method for you to use Gimp or Photoshop
3355to make color corrections to the Hald CLUT image and subsequently apply them
3356to multiple images using an ImageMagick script. </p>
3357
3358<p>Note that the representation is only of the normal RGB color space and that
3359the whole color value triplet is used for the interpolated lookup of the
3360represented Hald color cube image. Because of this the operation is not <a
3361href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3362images transparency or alpha/matte channel.</p>
3363
3364<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3365of the individual color channels, usally involving a simplier gray-scale
3366image. E.g: gray-scale to color replacement, or modification by a histogram
3367mapping. </p>
3368
3369
3370<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003371 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003372</div>
3373
3374<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>
3375
3376<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003377 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003378</div>
3379
3380<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>
3381
3382<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003383 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003384</div>
3385
3386<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>
3387
3388<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>
3389
3390<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>
3391
3392<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003393 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003394</div>
3395
3396<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>
3397
3398<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003399 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003400</div>
3401
3402<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>
3403
3404<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>
3405
3406<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>
3407
cristyd0bda5e2010-09-21 16:22:45 +00003408<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003409amounts of image properties are displayed including image statistics, profiles,
3410image histogram, and others.</p>
3411
3412<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003413 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003414</div>
3415
3416<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>
3417
cristydcca3fa2010-12-29 21:50:07 +00003418<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">Fourier Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT">Discrete Fourier Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT">Fast Fourier Transform</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00003419
3420<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>
3421
3422<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3423<p>or</p>
3424
3425<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>
3426
cristydcca3fa2010-12-29 21:50:07 +00003427<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 is at the right and/or bottom sides of the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003428
cristydcca3fa2010-12-29 21:50:07 +00003429<p>The <a href="http://www.fftw.org/">FFTW</a> delegate library is required to use <a href="#ift">-ift</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00003430
cristydcca3fa2010-12-29 21:50:07 +00003431<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.</p>
cristy3ed852e2009-09-05 21:47:34 +00003432
3433<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003434 <h4><a id="immutable"></a>-immutable</h4>
cristy3ed852e2009-09-05 21:47:34 +00003435</div>
3436
3437<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>
3438
3439<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003440 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003441</div>
3442
3443<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>
3444
3445<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003446 <h4><a id="insert"></a>-insert <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003447</div>
3448
3449<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>
3450
3451<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>
3452
3453<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>
3454
3455<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003456 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003457</div>
3458
3459<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>
3460
3461<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>
3462
3463<p>The default intent is undefined.</p>
3464
3465<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3466
3467<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003468 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003469</div>
3470
3471<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>
3472
3473<p>Choose from:</p>
3474
3475<pre class="text">
3476 none
3477 line
3478 plane
3479 partition
3480 JPEG
3481 GIF
3482 PNG
3483</pre>
3484
3485<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>
3486
3487<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3488
3489<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3490
3491<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3492
3493<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3494image.G, and image.B).</p>
3495
3496<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>
3497image.</p>
3498
3499<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3500
3501<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003502 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003503</div>
3504
3505<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>
3506
cristyd0bda5e2010-09-21 16:22:45 +00003507<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003508value, you typically fall in between the pixel colors defined by the source
3509image. This setting determines how the color is determined from the colors of
3510the pixels surrounding that point. That is how to determine the color of a
3511point that falls between two, or even four different colored pixels. </p>
3512
3513<pre class="text">
3514 integer: The color of the top-left pixel (floor function)
3515 nearest-neighbor: The nearest pixel to the lookup point (rounded function)
3516 average: The average color of the surrounding four pixels
3517 bilinear A double linear interpolation of pixels (the default)
3518 mesh Divide area into two flat triangular interpolations
3519 bicubic Fitted bicubic-spines of surrounding 16 pixels
3520 spline Direct spline curves (colors are blurred)
3521 filter Use resize <a href="#filter">-filter</a> settings
3522</pre>
3523
3524<p>This most important for distortion operators such as <a href="#distort"
3525>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3526>-transform</a> and <a href="#fx" >-fx</a>. </p>
3527
3528<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3529
3530<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3531lookup for positions outside the boundaries of the image. </p>
3532
3533
3534<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003535 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003536</div>
3537
3538<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>
3539
3540<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003541 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003542</div>
3543
3544<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>
3545
3546<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003547 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003548</div>
3549
3550<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>
3551
3552<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003553 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003554</div>
3555
3556<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>
3557
cristy71a3f602010-09-15 12:38:16 +00003558<p>Use this option to assign a specific label to the image, as it is read in
3559or created. You can use the <a href="#set" >-set</a> operation to re-assign
3560a the labels of images already read in. Image formats such as TIFF, PNG,
3561MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003562
cristy71a3f602010-09-15 12:38:16 +00003563<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3564assigned to an image is used as a header string to print above the postscript
3565image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003566
cristybc9539a2010-08-16 18:06:20 +00003567<p>You can include the image filename, type, width, height, or other image
3568attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3569Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003570
3571<p>For example,</p>
3572
3573<p class="crtsnip">
3574 -label "%m:%f %wx%h" bird.miff
3575</p>
3576
cristy71a3f602010-09-15 12:38:16 +00003577<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3578"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3579is read in. If a <a href="#label">+label</a> option was used instead, any
3580existing label present in the image would be used. You can remove all labels
3581from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003582
cristy71a3f602010-09-15 12:38:16 +00003583<p>A label is not drawn on the image, but is embedded in the image datastream
3584via <em>Label</em> tag or similar mechanism. If you want the label to be
3585visible on the image itself, use the <a href="#draw">-draw</a> option, or
3586during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003587
cristy71a3f602010-09-15 12:38:16 +00003588<p>If the first character of <em class="arg">string</em> is <em
3589class="arg">@</em>, the image label is read from a file titled by the
3590remaining characters in the string. Labels in a file are literal, no embedded
3591formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003592
3593
3594<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003595 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00003596</div>
3597
3598<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>
3599
3600<p>Adaptively threshold each pixel based on the value of pixels in a
3601surrounding window. If the current pixel is lighter than this average plus
3602the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3603black. Small variations in pixel values such as found in scanned documents
3604can be ignored if offset is positive. A negative offset will make it more
3605sensitive to those small variations. </p>
3606
3607<p>This is commonly used to threshold images with an uneven background. It is
3608based on the assumption that average color of the small window is the
3609the local background color, from which to separate the forground color. </p>
3610
3611
3612<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003613 <h4><a id="layers"></a>-layers <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003614</div>
3615
3616<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>
3617
3618<p>Perform various image operation methods to a ordered sequence of images
3619which may represent either a set of overlaid 'image layers', a GIF disposal
3620animation, or a fully-'coalesced' animation sequence. </p>
3621
3622<table class="doc">
3623 <tbody>
3624 <tr valign="top">
3625 <th align="left" style="width: 8%">Method</th>
3626 <th align="left">Description</th>
3627 </tr>
3628
3629 <tr valign="top">
3630 <td valign="top">compare-any</td>
3631 <td valign="top">Crop the second and later frames to the smallest rectangle
3632 that contains all the differences between the two images. No GIF <a
3633 href="#dispose" >-dispose</a> methods are taken into account. </td>
3634 </tr>
3635
3636 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3637 >-deconstruct</a> operator, and does not preserve animations normal
3638 working, especially when animation used layer disposal methods such as
3639 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3640 </tr>
3641
3642 <tr valign="top">
3643 <td valign="top">compare-clear</td>
3644 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3645 opaque pixels which become transparent in the second frame. That is the
3646 smallest image needed to mask or erase pixels for the next frame. </td>
3647 </tr>
3648
3649 <tr valign="top">
3650 <td valign="top">compare-overlay</td>
3651 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3652 extra color to the next image, as a result of overlaying color pixels.
3653 That is the smallest single overlaid image to add or change colors. </td>
3654 </tr>
3655
3656 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3657 composition method '<kbd>change-mask</kbd>', to reduce the image to
3658 just the pixels that need to be overlaid. </td>
3659 </tr>
3660
3661 <tr valign="top">
3662 <td valign="top">coalesce</td>
3663 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3664 >-coalesce</a> operator. Apply the layer disposal methods set in the
3665 current image sequence to form a fully defined animation sequence, as
3666 it should be displayed. Effectively converting a GIF animation into a
3667 'film strip'-like animation. </td>
3668 </tr>
3669
3670 <tr valign="top">
3671 <td valign="top">composite</td>
3672 <td valign="top">Alpha Composition of two image lists, separated by a
3673 "<kbd>null:</kbd>" image, with the destination image list first, and
3674 the source images last. An image from each list are composited
3675 together until one list is finished. The separator image and source
3676 image lists are removed. </td>
3677 </tr>
3678
3679
cristybac7a162010-06-15 19:57:29 +00003680 <tr><td></td>
3681 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3682 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3683 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003684 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003685 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003686
cristybac7a162010-06-15 19:57:29 +00003687 <tr><td></td>
3688 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003689 applied to all the images in the other image list, regardless of which
3690 list it is. In this case it is the image meta-data of the list which
3691 preserved. </td>
3692 </tr>
3693
3694
3695 <tr valign="top">
3696 <td valign="top">dispose</td>
3697 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3698 the animation after the layer disposal method has been applied, before
3699 the next sub-frame image is overlaid. That is the 'dispose' image that
3700 results from the application of the GIF <a href="#dispose"
3701 >-dispose</a> method. This allows you to check what
3702 is going wrong with a particular animation you may be developing.
3703 </td>
3704 </tr>
3705
3706 <tr valign="top">
3707 <td valign="top">flatten</td>
3708 <td valign="top">Create a canvas the size of the first images virtual
3709 canvas using the current <a href="#background" >-background</a> color,
3710 and <a href="#compose" >-compose</a> each image in turn onto that
3711 canvas. Images falling outside that canvas is clipped. Final
3712 image will have a zero virtual canvas offset. </td>
3713 </tr>
3714
cristybac7a162010-06-15 19:57:29 +00003715 <tr><td></td>
3716 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003717 overlaying all the prepared image layers into a final image. </td>
3718 </tr>
3719
cristybac7a162010-06-15 19:57:29 +00003720 <tr><td></td>
3721 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003722 canvas with real pixels, or to underlay a opaque color to remove
3723 transparency from an image.</td>
3724 </tr>
3725
3726
3727 <tr valign="top">
3728 <td valign="top">merge</td>
3729 <td valign="top">As 'flatten' method but merging all the given image
3730 layers into a new layer image just large enough to hold all the image
3731 without clipping or extra space. The new images virtual offset will
3732 prevere the position of the new layer, even if this offset is
3733 negative. the virtual canvas size of the first image is preserved.
3734 </td>
3735 </tr>
3736
3737 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3738 as few image file formats handle them correctly. </td>
3739 </tr>
3740
3741 <tr valign="top">
3742 <td valign="top">mosaic</td>
3743 <td valign="top">As 'flatten' method but expanding the initial canvas size
3744 of the first image so as to hold all the image layers. However as a
cristyd0bda5e2010-09-21 16:22:45 +00003745 virtual canvas is 'locked' to the origin, by definition, image layers
cristy3ed852e2009-09-05 21:47:34 +00003746 with a negative offsets will still be clipped by the top and left
3747 edges.</td>
3748 </tr>
3749
3750 <tr><td></td><td>This method is commonly used to layout individual image using various
cristyd0bda5e2010-09-21 16:22:45 +00003751 offset but without knowing the final canvas size. The resulting image
cristy3ed852e2009-09-05 21:47:34 +00003752 will, like 'flatten' not have any virtual offset, so can be saved to
3753 any image file format. </td>
3754 </tr>
3755
3756
3757 <tr valign="top">
3758 <td valign="top">optimize</td>
3759 <td valign="top">Optimize a coalesced animation, into GIF animation using
3760 a number of general techniques. This currently a short cut to
3761 apply both the '<kbd>optimize-frame</kbd>', and
3762 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3763 include other optimization methods as they are developed. </td>
3764 </tr>
3765
3766 <tr valign="top">
3767 <td valign="top">optimize-frame</td>
3768 <td valign="top">Optimize a coalesced animation, into GIF animation by
3769 reducing the number of pixels per frame as much as possible by
3770 attempting to pick the best layer disposal method to use, while ensuring
3771 the result will continue to animate properly. </td>
3772 </tr>
3773
3774 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3775 then no reasonably fast GIF optimization algorithm can do this.
3776 However this does seem to do better than most other GIF frame
3777 optimizers seen. </td>
3778 </tr>
3779
3780 <tr valign="top">
3781 <td valign="top">optimize-plus</td>
3782 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3783 overall optimization by adding extra frames to the animation, without
3784 changing the final look or timing of the animation. The frames are
3785 added to attempt to separate the clearing of pixels from the
3786 overlaying of new additional pixels from one animation frame to the
3787 next. If this does not improve the optimization (for the next frame
3788 only), it will fall back to the results of the previous normal
3789 '<kbd>optimize-frame</kbd>' technique. </td>
3790 </tr>
3791
3792 <tr><td></td><td>There is the possibility that the change in the disposal style will
3793 result in a worsening in the optimization of later frames, though this
3794 is unlikely. In other words there no guarantee that it is better than
3795 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
cristyd0bda5e2010-09-21 16:22:45 +00003796 however you can get a vast improvement in the final animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003797 </tr>
3798
3799 <tr valign="top">
3800 <td valign="top">optimize-transparency</td>
3801 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3802 overlay images with transparency, if it does not change the resulting
3803 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3804 </td>
3805 </tr>
3806
3807 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3808 into a smaller file size due to larger areas of one (transparent)
3809 color rather than a pattern of multiple colors repeating the current
3810 disposed image of the last frame. </td>
3811 </tr>
3812
3813 <tr valign="top">
3814 <td valign="top">remove-dups</td>
3815 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3816 images, so as to simplify layer overlays of coalesced animations.
3817 </td>
3818 </tr>
3819
3820 <tr><td></td><td>Usually this a result of using a constant time delay across the
3821 whole animation, or after a larger animation was split into smaller
3822 sub-animations. The duplicate frames could also have been used as
3823 part of some frame optimization methods. </td>
3824 </tr>
3825
3826 <tr valign="top">
3827 <td valign="top">remove-zero</td>
3828 <td valign="top">Remove any image with a zero time delay, unless ALL the
3829 images have a zero time delay (and is not a proper timed animation, a
3830 warning is then issued). </td>
3831 </tr>
3832
3833 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3834 partial intermediary updates between the frames that are actually
3835 displayed to users. These frames are usally added for improved frame
3836 optimization in GIF animations. </td>
3837 </tr>
3838
3839 <tr valign="top">
3840 <td valign="top">trim-bounds</td>
3841 <td valign="top">Find the bounds of all the images in the current
3842 image sequence, then adjust the offsets so all images are contained on
3843 a minimal positive canvas. None of the image data is modified, only
3844 there virtual canvas size and offset. The all the image is given
3845 the same canvas size, and and will have a positive offset, but will
3846 remain in the same position relative to each other. As a result of the
3847 minimal canvas size at least one image will touch every edge of that
3848 canvas. The image data however may be transparent.
3849 </td>
3850 </tr>
3851
3852 </tbody>
3853</table>
3854
3855<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3856
3857<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3858>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3859>-mosaic</a> are only aliases for the above methods. Also see <a
3860href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3861href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3862>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3863
3864
3865<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003866 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00003867</div>
3868
3869<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>
3870
3871<p>Given one, two or three values delimited with commas: black-point,
3872white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3873white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3874point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3875contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3876both black and white points are percentages of the full color range. Gamma
3877will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3878omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3879
3880<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3881the given '<kbd>black_point</kbd>' value in the original image is set to
3882zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3883<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3884to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3885adjusted. </p>
3886
3887<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3888adding the special '!' flag anywhere in the argument list, will cause the
3889operator to do the reverse of the level adjustment. That is a zero, or
3890<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
3891adjusted to the given level values, allowing you to de-contrast, or compress
3892the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
3893
3894<p>Only the channels defined by the current <a href="#channel">-channel</a>
3895setting are adjusted (defaults to RGB color channels only), allowing you to
3896limit the effect of this operator. </p>
3897
3898<p>Please note that the transparency channel is treated as 'matte'
3899values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
3900
3901
3902<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003903 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00003904 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
3905</div>
3906
cristyd0bda5e2010-09-21 16:22:45 +00003907<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 +00003908
3909<p>This function is exactly like <a href="#level">-level</a>, except that the
3910value value for each color channel is determined by the
3911'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
3912described under the <a href="#fill">-fill</a> option). </p>
3913
cristyd0bda5e2010-09-21 16:22:45 +00003914<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
3915is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00003916colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00003917adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00003918
3919<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
3920will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00003921respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00003922those colors. This can also be used to convert a plain gray-scale image into a
3923one using the gradient of colors specified. </p>
3924
3925<p>By supplying a single color with a comma separator either before or after
3926that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00003927respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00003928used for both the black and white color points, making the operator either
3929threshold the images around that color (- form) or set all colors to that
3930color (+ form). </p>
3931
3932
3933<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003934 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003935</div>
3936
3937<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>
3938
3939<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>
3940
cristy6b636652009-12-05 17:16:11 +00003941<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 +00003942
3943<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00003944 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00003945</p>
3946
3947<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
3948
cristydcca3fa2010-12-29 21:50:07 +00003949<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list resource</span><span class='crtout'></span></p><pre class="text">
3950File Area Memory Map Disk Thread Time
cristy6b636652009-12-05 17:16:11 +00003951------------------------------------------------------------------------------
cristydcca3fa2010-12-29 21:50:07 +00003952 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
3953</pre>
3954
cristy3ed852e2009-09-05 21:47:34 +00003955<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>
3956
3957<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>
3958
3959<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>
3960
3961<p class="crtsnip">
3962-limit area 10mb
3963</p>
3964
cristyd0bda5e2010-09-21 16:22:45 +00003965<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 +00003966
3967<p class="crtsnip">
3968-limit area 10mb -limit disk 500mb
3969</p>
3970
3971<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
3972
3973<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>
3974
3975<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.
3976</p>
3977
3978<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.
3979</p>
3980
3981<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003982 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00003983</div>
3984
3985<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>
3986
cristyd934d102009-10-10 12:55:13 +00003987<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
3988and uses a 'histogram bin' to determine the range of color values that needs to
3989be stretched. However it then stretchs those colors using the <a
3990href="#level" >-level</a> operator.</p>
3991
3992<p>As such while the initial determination may have 'binning' round off
3993effects, the image colors are stretched mathematically, rather than using the
3994histogram bins. This makes the operator more accurate. </p>
3995
3996<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
3997'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
3998perfect stretch of the color range. </p>
3999
4000<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
4001normalization of mathematical images. </p>
4002
4003<p>This operator is under review for re-development. </p>
4004
4005
cristy3ed852e2009-09-05 21:47:34 +00004006<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004007 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00004008</div>
4009
4010<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>
4011
4012<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004013 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004014</div>
4015
4016<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>
4017
4018<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>
4019
4020<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004021 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004022</div>
4023
4024<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>
4025
4026<pre class="text">
cristyc1aee832010-05-08 00:36:47 +00004027 Align
4028 Alpha
4029 Boolean
4030 Channel
4031 Class
4032 ClipPath
4033 Coder
4034 Color
4035 Colorspace
4036 Command
4037 Compose
4038 Compress
4039 Configure
4040 DataType
4041 Debug
4042 Decoration
4043 Delegate
4044 Direction
4045 Dispose
4046 Distort
4047 Dither
4048 Endian
4049 Evaluate
4050 FillRule
4051 Filter
4052 Font
4053 Format
4054 Function
4055 Gravity
4056 ImageList
4057 Intent
4058 Interlace
4059 Interpolate
4060 Kernel
cristy787d4352010-03-06 13:55:58 +00004061 Layers
4062 LineCap
4063 LineJoin
4064 List
4065 Locale
4066 LogEvent
4067 Log
4068 Magic
4069 Method
4070 Metric
4071 Mime
4072 Mode
4073 Morphology
4074 Module
4075 Noise
4076 Orientation
4077 Policy
4078 PolicyDomain
4079 PolicyRights
4080 Preview
4081 Primitive
4082 QuantumFormat
4083 Resource
4084 SparseColor
4085 Storage
4086 Stretch
4087 Style
4088 Threshold
4089 Type
4090 Units
4091 Validate
4092 VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004093</pre>
4094
cristybac7a162010-06-15 19:57:29 +00004095<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4096list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4097available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004098
4099<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4100<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004101 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004102</div>
4103
4104<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>
4105
cristybac7a162010-06-15 19:57:29 +00004106<p>This option specifies the format for the log printed when the <a
4107href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004108
cristybac7a162010-06-15 19:57:29 +00004109<p>You can display the following components by embedding special format
4110characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004111
4112<pre class="text">
4113 %d domain
4114 %e event
4115 %f function
4116 %l line
4117 %m module
4118 %p process ID
4119 %r real CPU time
4120 %t wall clock time
4121 %u user CPU time
4122 %% percent sign
4123 \n newline
4124 \r carriage return
4125</pre>
4126
4127<p>For example:</p>
4128
4129<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>
4130<p>The default behavior is to print all of the components.</p>
4131
4132<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004133 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004134</div>
4135
4136<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>
4137
cristybac7a162010-06-15 19:57:29 +00004138<p>Set iterations to zero to repeat the animation an infinite number of times,
4139otherwise the animation repeats itself up to <em class="arg">iterations</em>
4140times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004141
4142<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004143 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004144</div>
4145
4146<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>
4147
4148<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004149 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004150</div>
4151
4152<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>
4153
4154
4155<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004156 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004157</div>
4158
4159<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>
4160
4161<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4162
4163<pre class="text">
4164 best
4165 default
4166 gray
4167 red
4168 green
4169 blue
4170</pre>
4171
cristybac7a162010-06-15 19:57:29 +00004172<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4173Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4174the type and <kbd>display</kbd> searches the list of colormap types in
4175<kbd>top-to-bottom</kbd> order until one is located. See <em
4176class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004177
4178
4179<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004180 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004181</div>
4182
4183<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>
4184
4185<p>Here are the valid components of a map:</p>
4186
4187<pre class="text">
4188 r red pixel component
4189 g green pixel component
4190 b blue pixel component
4191 a alpha pixel component (0 is transparent)
4192 o opacity pixel component (0 is opaque)
4193 i grayscale intensity pixel component
4194 c cyan pixel component
4195 m magenta pixel component
4196 y yellow pixel component
4197 k black pixel component
4198 p pad component (always 0)
4199</pre>
4200
cristybac7a162010-06-15 19:57:29 +00004201<p>You can specify as many of these components as needed in any order (e.g.
4202bgr). The components can repeat as well (e.g. rgbr).</p>
4203
cristy3ed852e2009-09-05 21:47:34 +00004204
4205<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004206 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004207<em class="arg">filename</em></h4>
4208</div>
4209
4210<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>
4211
4212<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
4213
4214<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004215 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004216</div>
4217
4218<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>
4219
4220<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4221
cristybac7a162010-06-15 19:57:29 +00004222<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4223style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004224
4225<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004226 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004227</div>
4228
4229<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>
4230
4231<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004232 <h4><a id="median"></a>-median <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004233</div>
4234
4235<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>
4236
4237<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004238 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004239</div>
4240
4241<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>
4242
4243<p>Choose from:</p>
4244
4245<pre class="text">
cristybac7a162010-06-15 19:57:29 +00004246 AE absolute error count, number of different pixels (-fuzz effected)
cristya20e3f92010-12-13 01:52:32 +00004247 FUZZ mean color distance
cristybac7a162010-06-15 19:57:29 +00004248 MAE mean absolute error (normalized), average channel error distance
4249 MEPP mean error per pixel (normalized mean error, normalized peak error)
4250 MSE mean error squared, average of the channel error squared
cristya20e3f92010-12-13 01:52:32 +00004251 NCC normalized cross correlation
cristybac7a162010-06-15 19:57:29 +00004252 PAE peak absolute (normalize peak absolute)
4253 PSNR peak signal to noise ratio
4254 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004255</pre>
4256
cristy771f7a72010-11-27 21:42:59 +00004257<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4258with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4259only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004260size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004261'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004262for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004263
4264<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4265('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004266normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004267
cristybac7a162010-06-15 19:57:29 +00004268<p>To print a complete list of metrics, use the <a href="#list">-list
4269metrics</a> option.</p>
4270
cristy3ed852e2009-09-05 21:47:34 +00004271
cristyd2baf7d2010-03-06 04:26:44 +00004272<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004273 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004274</div>
4275
4276<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>
4277
cristy3ed852e2009-09-05 21:47:34 +00004278
4279<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004280 <h4><a id="mode"></a>-mode <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004281</div>
4282
4283<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>
4284
cristybac7a162010-06-15 19:57:29 +00004285<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4286Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004287
cristybac7a162010-06-15 19:57:29 +00004288<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4289for a list of <a href="#mode" >-mode</a> arguments available in your
4290ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004291
4292
4293<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004294 <h4><a id="modulate"></a>-modulate <em class="arg">brightness</em>[,<em class="arg">saturation</em>,<em class="arg">hue</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00004295</div>
4296
cristybac7a162010-06-15 19:57:29 +00004297<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
4298class="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 +00004299
cristyb36feb22010-03-26 16:54:37 +00004300<p>The arguments are given as a percentages of variation. A value of 100 means
4301no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004302
cristyb36feb22010-03-26 16:54:37 +00004303<p>The <em class="arg">brightness</em> is a multiplier of the overall
4304brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4305twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4306before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004307
cristyb36feb22010-03-26 16:54:37 +00004308<p>The <em class="arg">saturation</em> controls the amount of color in an
4309image. For example, 0 produce a grayscale image, while a large value such as
4310200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004311
cristyb36feb22010-03-26 16:54:37 +00004312<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4313within the image by the amount specified. For example, 50 results in
4314a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4315A value of either 0 or 200 results in a complete 180 degree rotation of the
4316image. Using a value of 300 is a 360 degree rotation resulting in no change to
4317the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004318
cristyb36feb22010-03-26 16:54:37 +00004319<p>For example, to increase the color brightness by 20% and decrease the color
4320saturation by 10% and leave the hue unchanged, use <a
4321href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004322
cristyb36feb22010-03-26 16:54:37 +00004323<p>Use <a href="#set">-set</a> attribute of '<kbd
4324class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4325modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4326<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004327
4328<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 +00004329
cristy3ed852e2009-09-05 21:47:34 +00004330<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004331 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004332</div>
4333
4334<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>
4335
4336
4337<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004338 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004339</div>
4340
4341<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>
4342
4343
4344<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004345 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004346</div>
4347
4348<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>
4349
4350<p>Both the image pixels and size are linearly interpolated to give the
4351appearance of a meta-morphosis from one image to the next, over all the images
4352in the current image list. The added images are the equivalent of a <a
4353href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4354argument determine how many images to interpolate between each image. </p>
4355
4356
4357<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004358 <h4><a id="morphology"></a>-morphology</h4>
4359 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004360</div>
4361
cristy2c839602010-04-03 02:32:08 +00004362<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 +00004363
cristydcca3fa2010-12-29 21:50:07 +00004364<p>Until I get around to writing a option summary for this, see <a
4365href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4366Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004367
4368
cristy488844c2010-01-22 14:02:05 +00004369<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004370 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004371</div>
4372
4373<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>
4374
4375
4376<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004377 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00004378</div>
4379
4380<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>
4381
4382<p>Blur with the given radius, standard deviation (sigma), and angle. The
4383angle given is the angle toward which the image is blurred. That is the
4384direction people would consider the object is coming from. </p>
4385
4386<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004387definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004388
4389<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4390pixels which are outside the image proper are blurred into the final result.
4391</p>
4392
4393<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004394 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004395</div>
4396
4397<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>
4398<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004399 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004400</div>
4401
cristyb29bc032010-02-01 20:29:43 +00004402<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 +00004403
4404<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>
4405
4406<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004407 <h4><a id="noise"></a>-noise <em class="arg">radius</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004408 +noise <em class="arg">type</em></h4>
4409</div>
4410
4411<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>
4412
4413<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>
4414
4415<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>
4416
4417<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>
4418
4419<pre class="text">
4420Gaussian
4421Impulse
4422Laplacian
4423Multiplicative
4424Poisson
4425Random
4426Uniform
4427</pre>
4428
4429<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4430
cristy83543962009-10-16 19:04:28 +00004431<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4432the use of a controlling value to specify teh amount of noise that should be
4433added to an image. </p>
4434
cristy3ed852e2009-09-05 21:47:34 +00004435
4436<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004437 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004438</div>
4439
4440<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>
4441
cristyd934d102009-10-10 12:55:13 +00004442<p>The intensity values are stretched to cover the entire range of possible
4443values. While doing so, black-out at most <em>2%</em> of the pixels and
4444white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004445
cristyd934d102009-10-10 12:55:13 +00004446<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4447is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4448(Before this version, it was equivalent to <a href="#contrast-stretch"
4449>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004450
cristyd934d102009-10-10 12:55:13 +00004451<p>All the channels are normalized in concert by the came amount so as to
4452preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004453setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004454setting will normalize the RGB channels independently.</p>
4455
cristydcca3fa2010-12-29 21:50:07 +00004456<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004457Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004458that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004459
4460<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004461
4462
4463<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004464 <h4><a id="ordered-dither"></a>-ordered-dither <em class="arg">threshold_map</em>{,<em class="arg">level</em>...}</h4>
cristy3ed852e2009-09-05 21:47:34 +00004465</div>
4466
cristyd934d102009-10-10 12:55:13 +00004467<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
4468class="arg">threshold map</em> specified, and a uniform color map with the
4469given 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 +00004470
4471<p>You can choose from these standard threshold maps:</p>
4472
4473<pre class="text">
cristya6d7cf72010-11-07 15:58:34 +00004474threshold 1x1 Threshold 1x1 (non-dither)
4475checks 2x1 Checkerboard 2x1 (dither)
4476o2x2 2x2 Ordered 2x2 (dispersed)
4477o3x3 3x3 Ordered 3x3 (dispersed)
4478o4x4 4x4 Ordered 4x4 (dispersed)
4479o8x8 8x8 Ordered 8x8 (dispersed)
4480h4x4a 4x1 Halftone 4x4 (angled)
4481h6x6a 6x1 Halftone 6x6 (angled)
4482h8x8a 8x1 Halftone 8x8 (angled)
4483h4x4o Halftone 4x4 (orthogonal)
4484h6x6o Halftone 6x6 (orthogonal)
4485h8x8o Halftone 8x8 (orthogonal)
4486h16x16o Halftone 16x16 (orthogonal)
4487c5x5b c5x5 Circles 5x5 (black)
4488c5x5w Circles 5x5 (white)
4489c6x6b c6x6 Circles 6x6 (black)
4490c6x6w Circles 6x6 (white)
4491c7x7b c7x7 Circles 7x7 (black)
4492c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004493</pre>
4494
cristyde368992010-11-05 14:32:14 +00004495<p> The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
cristyd934d102009-10-10 12:55:13 +00004496pattern. Or you can define your own <em class="arg" >threshold map</em> in a
cristyde368992010-11-05 14:32:14 +00004497personal or system <kbd>thresholds.xml</kbd> XML file. </p>
cristy3ed852e2009-09-05 21:47:34 +00004498
cristyd934d102009-10-10 12:55:13 +00004499<p>To print a complete list of threshold, use the <a href="#list" >-list
4500threshold</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004501
cristyd934d102009-10-10 12:55:13 +00004502<p>It is recommended that the <a href="#map" >+map</a> operator be used after
4503applying <a href="#ordered-dither" >-ordered-dither</a> to reduce the number of
cristy3ed852e2009-09-05 21:47:34 +00004504colors an animated image sequence, to less that 256 colors. This ensures that
4505a common or global color table is used when saving the result to a color
4506limited file format such as GIF. </p>
4507
cristyd934d102009-10-10 12:55:13 +00004508<p>Note that at this time the exact same threshold dithering map is used for
4509all color channels, no attempt is made to offset or rotate the map for
4510different channels is made, to create an offset printing effect. (possible
4511future expansion) </p>
cristy3ed852e2009-09-05 21:47:34 +00004512
4513
4514<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004515 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004516</div>
4517
4518<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>
4519
cristyc54f5d42009-11-27 21:36:31 +00004520<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004521described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4522>-fuzz</a> setting can be used to match and replace colors similar to the one
4523given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004524
cristyb36feb22010-03-26 16:54:37 +00004525<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4526the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004527
cristyb36feb22010-03-26 16:54:37 +00004528<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4529as <a href="#opaque" >-opaque</a> but replaces the matching color with
4530transparency rather than the current <a href="#fill">-fill</a> color setting.
4531To ensure that it can do this it also ensures that the image has an alpha
4532channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4533the new transparent colors, and does not require you to modify the <a
4534href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004535
cristy3ed852e2009-09-05 21:47:34 +00004536
4537<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004538 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004539</div>
4540
4541<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>
4542
4543<p>Choose from these orientations:</p>
4544
4545<pre class="text">
4546 bottom-left
4547 bottom-right
4548 left-bottom
4549 left-top
4550 right-bottom
4551 right-top
4552 top-left
4553 top-right
4554 undefined
4555</pre>
4556
cristyd934d102009-10-10 12:55:13 +00004557<p>To print a complete list of orientations, use the <a href="#list" >-list
4558orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004559
4560
4561<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004562 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004563 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4564 +page
4565 </h4>
4566</div>
4567
4568<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>
4569
4570<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>
4571
4572<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>
4573
4574<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>
4575<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4576<thead>
4577 <tr valign="top">
4578 <th align="center"><em class="arg">media</em></th>
4579 <th align="center"><em class="arg">width</em></th>
4580 <th align="center"><em class="arg">height</em></th>
4581 </tr>
4582</thead>
4583<tbody>
4584<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4585<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4586<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4587<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4588<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4589<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4590<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4591<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4592<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4593<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4594<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4595<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4596<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4597<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4598<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4599<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4600<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4601<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4602<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4603<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4604<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4605<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4606<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4607<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4608<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4609<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4610<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4611<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4612<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4613<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4614<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4615<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4616<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4617<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4618<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4619<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4620<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4621<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4622</tbody>
4623</table>
4624
4625
4626
4627
4628<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>
4629
4630<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>
4631
4632<p>The default page dimensions for a TEXT image is 612x792.</p>
4633
4634<p>This option is used in concert with <a href="#density">-density</a>.</p>
4635
4636<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4637
4638<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004639 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004640</div>
4641
4642<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>
4643
4644<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>
4645
4646<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004647 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004648
4649<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>
4650
4651<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004652 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004653</div>
4654
4655<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>
4656
4657<p>Pause for the specified number of seconds before repeating the animation.</p>
4658
4659<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004660 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004661</div>
4662
4663<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>
4664
4665<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4666
4667<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004668 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004669</div>
4670
4671<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>
4672
4673<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004674 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004675</div>
4676
4677<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>
4678
4679<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004680 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004681</div>
4682
4683<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>
4684
4685<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4686
4687<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004688 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004689</div>
4690
4691<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>
4692
4693<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004694 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004695</div>
4696
4697<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>
4698
4699<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004700 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004701</div>
4702
4703<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>
4704
4705<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>
4706
4707<pre class="text">
4708 Rotate
4709 Shear
4710 Roll
4711 Hue
4712 Saturation
4713 Brightness
4714 Gamma
4715 Spiff
4716 Dull
4717 Grayscale
4718 Quantize
4719 Despeckle
4720 ReduceNoise
4721 Add Noise
4722 Sharpen
4723 Blur
4724 Threshold
4725 EdgeDetect
4726 Spread
4727 Shade
4728 Raise
4729 Segment
4730 Solarize
4731 Swirl
4732 Implode
4733 Wave
4734 OilPaint
4735 CharcoalDrawing
4736 JPEG
4737</pre>
4738
4739<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4740
4741<p>The default preview is <kbd>JPEG</kbd>.</p>
4742
4743<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004744 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004745</div>
4746
4747<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>
4748
4749<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004750 <h4><a id="process"></a>-process <em class="arg">command</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004751</div>
4752
4753<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>
4754
4755<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>
4756
4757<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004758 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004759 +profile <em class="arg">profile_name</em></h4>
4760</div>
4761
4762<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>
4763
4764<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>
4765
4766<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>
4767
4768<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>
4769
4770<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>
4771
4772<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4773
4774<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4775<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>
4776
4777<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>
4778<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4779CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4780</p>
4781
cristyf7964272011-01-30 03:49:12 +00004782<p>The <a href="#profile">-profile</a> option can also be used to inject
4783previously-formatted ancillary chunks into the output PNG file, using
4784the commandline option as shown below or by setting the profile via a
4785programming interface:
4786
4787<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>-profile PNG-chunk-x:<filename></span></p>
4788where <em>x</em> is a location flag and
4789<em class="arg">filename</em> is a file containing the chunk
4790name in the first 4 bytes, then a colon (":"), followed by the chunk data.
4791This encoder will compute the chunk length and CRC, so those must not
4792be included in the file.
4793
4794"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT),
4795or "e" (end, i.e., after IDAT). If you want to write multiple chunks
4796of the same type, then add a short unique string after the "x" to prevent
4797subsequent profiles from overwriting the preceding ones, e.g.,
4798
4799
4800<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>-profile PNG-chunk-b01:file01 -profile PNG-chunk-b02:file02</span></p>
cristy3ed852e2009-09-05 21:47:34 +00004801<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004802 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004803</div>
4804
4805<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>
4806
cristy851dbce2010-08-06 21:40:00 +00004807<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 +00004808
4809<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>
4810
cristy851dbce2010-08-06 21:40:00 +00004811<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 +00004812
cristy3c98a4f2010-08-13 20:09:41 +00004813<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 +00004814
4815<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4816
4817<pre class="text">
4818 0: none
4819 1: sub
4820 2: up
4821 3: average
4822 4: Paeth
4823</pre>
4824
4825<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>
4826
4827<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4828
4829<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>
4830
cristy3c98a4f2010-08-13 20:09:41 +00004831<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 +00004832
4833<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4834
cristy3ed852e2009-09-05 21:47:34 +00004835<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004836 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004837</div>
4838
cristy3c98a4f2010-08-13 20:09:41 +00004839<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 +00004840
cristy3c98a4f2010-08-13 20:09:41 +00004841<p>This setting defines the colorspace used to sort out and reduce the number
4842of colors needed by an image (for later dithering) by operators such as <a
4843href="#colors" >-colors</a>, Note that color reducion also happens
4844automatically when saving images to color-limited image file formats, such as
4845GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004846
4847
4848<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004849 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004850</div>
4851
4852<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>
4853
4854<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004855 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004856</div>
4857
4858<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>
4859
4860<p>Note that this is actually a rotational blur rather than a radial and as
4861such actually mis-named. </p>
4862
4863<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4864pixels which are outside the image proper are blurred into the final result.
4865</p>
4866
4867
4868<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004869 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004870</div>
4871
4872<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>
4873
4874<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>.
4875</p>
4876
4877<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4878
4879<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004880 <h4><a id="random-threshold"></a>-random-threshold <em class="arg">low</em>x<em class="arg">high</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004881</div>
4882
4883<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>
4884
4885<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004886 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004887</div>
4888
4889<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>
4890
4891<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004892 <h4><a id="regard-warnings"></a>-regard-warnings</h4>
cristy3ed852e2009-09-05 21:47:34 +00004893</div>
4894
4895<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>
4896
4897<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004898 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004899</div>
4900
4901<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>
4902
4903<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4904the given colors are dithered over the image as necessary, otherwise the closest
4905color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4906
4907<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4908images in the current image sequence, all the images will have the same color
4909table. That means that when saved to a file format such as GIF, it will use
4910that color table as a single common or global color table, for all the images,
4911without requiring extra local color tables. </p>
4912
4913<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4914sequence to use a common color map over all the images. This equivalent to
4915appending all the images together (without extra background colors) and color
4916reducing those images using <a href="#colors">-colors</a> with a 256 color
4917limit, then <a href="#remap">-remap</a> those colors over the original list of
4918images. This ensures all the images follow a single color map. </p>
4919
4920<p>If the number of colors over all the images is less than 256, then <a
4921href="#remap">+remap</a> should not perform any color reduction or dithering, as
4922no color changes are needed. In that case, its only effect is to force the use
4923of a global color table. This recommended after using either <a
4924href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
4925reduce the number of colors in an animated image sequence. </p>
4926
4927<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004928 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004929</div>
4930
4931<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>
4932
4933<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>
4934
4935<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>
4936
4937<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004938 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00004939</div>
4940
4941<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>
4942
4943<p>The only command recognized is the name of an image file to load.</p>
4944
4945<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>
4946
4947<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004948 <h4><a id="render"></a>-render</h4>
cristy3ed852e2009-09-05 21:47:34 +00004949</div>
4950
4951<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>
4952
4953<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>
4954
4955<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004956<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004957</div>
4958
4959<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>
4960
4961<p>This option is like <a href="#page">-page</a> but acts as an image operator
4962rather than a setting. You can separately set the canvas size or the offset
4963of the image on that canvas by only providing those components. </p>
4964
4965<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>
4966
4967<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
4968offset to move the image relative to its previous position. This useful for
4969animation sequences. </p>
4970
4971<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
4972recalculate the canvas size so the image (at its current offset) will appear
4973completely on that canvas (unless it has a negative offset).</p>
4974
4975<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
4976canvas meta-data from the images. </p>
4977
4978<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
4979directly assign virtual canvas meta-data. </p>
4980
4981
4982<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004983 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004984</div>
4985
4986<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>
4987
4988<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>
4989
4990<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>
4991
4992<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004993 <h4><a id="resize"></a>-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004994</div>
4995
4996<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>
4997
4998<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>
4999
5000<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>
5001
cristy13538962010-02-26 17:53:04 +00005002<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>
5003
cristy4949d522010-03-12 18:41:34 +00005004<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 +00005005<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005006 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00005007</div>
5008
5009<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>
5010
5011<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005012 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005013</div>
5014
5015<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>
5016
5017
5018<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005019 <h4><a id="roll"></a>-roll {<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005020</div>
5021
5022<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>
5023
5024<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>
5025
5026
5027<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005028 <h4><a id="rotate"></a>-rotate <em class="arg">degrees</em>{<em class="arg">&lt;</em>}{<em class="arg">&gt;</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005029</div>
5030
5031<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>
5032
5033<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>
5034
5035<p>Empty triangles in the corners, left over from rotating the image, are
5036filled with the <kbd>background</kbd> color. </p>
5037
5038<p>See also the <a href="#distort">-distort</a> operator and specifically the
5039'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5040
5041
5042<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005043 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005044</div>
5045
cristyd0bd44a2010-09-24 12:38:11 +00005046<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>minify/magnify the image using pixel subsampling and pixel replication, respectively.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005047
cristyd0bd44a2010-09-24 12:38:11 +00005048<p>Change the image size simply by directly sampling the pixels original
5049image. When magnifying, pixels are replicated in blocks. When minifying,
5050pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005051
cristyd0bd44a2010-09-24 12:38:11 +00005052<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5053a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5054neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5055avoids all the filter processing of the image. As such it completely ignores
5056the current <a href="#filter">-filter</a> setting. </p>
5057
5058<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5059will be added to the resulting image, though some colors may disappear. </p>
5060
5061<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
5062ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005063
5064
5065<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005066 <h4><a id="sampling-factor"></a>-sampling-factor <em class="arg">horizontal-factor</em>x<em class="arg">vertical-factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005067</div>
5068
5069<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>
5070
5071<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>
5072
5073<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005074 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005075</div>
5076
cristyd0bd44a2010-09-24 12:38:11 +00005077<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>minify/magnify the image using pixel block averaging and pixel replication, respectively.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005078
cristyd0bd44a2010-09-24 12:38:11 +00005079<p>Change the image size simply by replacing pixels by averaging pixels
5080together when minifying, or replacing pixels when magnifing. </p>
5081
5082<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5083a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5084faster, as it avoids all the filter processing of the image. As such it
5085completely ignores the current <a href="#filter">-filter</a> setting. </p>
5086
5087<p>If when shrinking (minifying) images the original image is some integer
5088multiple of the new image size, the number of pixels avergaed together to
5089produce the new pixel color is the same across the whole image. This is
5090a special case known as 'binning' and is often used as a method of reducing
5091noise in image such as those generated by digital cameras, especially in low
5092light conditions. </p>
5093
cristy3ed852e2009-09-05 21:47:34 +00005094
5095<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005096 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005097</div>
5098
5099<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>
5100
5101<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5102
5103<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005104 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005105</div>
5106
5107<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>
5108
5109<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>
5110
5111<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005112 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005113</div>
5114
5115<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>
5116
5117<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005118 <h4><a id="segment"></a>-segment <em class="arg">cluster-threshold</em>x<em class="arg">smoothing-threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005119</div>
5120
5121<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>
5122
5123<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>
5124
5125<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>
5126
5127<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5128of the color clusters is returned.</p>
5129
5130
5131<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005132 <h4><a id="selective-blur"></a>-selective-blur <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005133</div>
5134
cristy2e2662a2010-10-09 14:29:37 +00005135<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005136 <h4>-selective-blur <em class="arg">radius</em><br />-unsharp <em class="arg">radius</em>x<em class="arg">sigma</em>{<em class="arg">+threshold</em>}</h4>
cristy2e2662a2010-10-09 14:29:37 +00005137</div>
5138
cristy3ed852e2009-09-05 21:47:34 +00005139<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>
5140
cristy2e2662a2010-10-09 14:29:37 +00005141<p>Blurs those pixels that are less than or equal to the threshold in contrast. The threshold may be expressed as a fraction of <em class="QR">QuantumRange</em> or as a percentage.</p>
5142
cristy3ed852e2009-09-05 21:47:34 +00005143<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005144 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005145</div>
5146
5147<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>
5148
5149<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005150 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005151</div>
5152
5153<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>
5154
5155<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5156
5157<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>
5158
cristyd0bda5e2010-09-21 16:22:45 +00005159
5160
cristy3ed852e2009-09-05 21:47:34 +00005161<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005162 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5163 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005164</div>
5165
cristyd0bd44a2010-09-24 12:38:11 +00005166<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>sets image attributes and properties for images in the current
cristyd0bda5e2010-09-21 16:22:45 +00005167image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005168
cristyd0bd44a2010-09-24 12:38:11 +00005169<p>This will assign (or modify) specific settings attached to all the images
5170in the current image sequence. Using the <a href="#set">+set</a> form of the
5171option will either remove, or reset that setting to a default state, as
5172appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005173
cristyd0bd44a2010-09-24 12:38:11 +00005174<p>For example, it will modify specific well known image meta-data
5175'attributes' such as those normally overridden by: the options <a
5176href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5177href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5178assigned before the image is read in, by using a <em class="arg">key</em> of
5179the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005180
cristyd0bd44a2010-09-24 12:38:11 +00005181<p>If the given <em class="arg">key</em> does not match a specific known
5182'attribute ', such as shown above, the setting is stored as a a free form
cristyd0bda5e2010-09-21 16:22:45 +00005183'properity' string. Such settings are listed in <a href="#verbose"
5184>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5185</p>
5186
cristyd0bd44a2010-09-24 12:38:11 +00005187<p>This includes string 'properities' that are set by and assigned to images
5188using the options <a href="#comment" >-comment</a>, <a href="#label"
5189>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5190a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5191Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005192
cristyd0bd44a2010-09-24 12:38:11 +00005193<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' rose.png</span><span class='crtout'>identify -format %c rose.png</span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>Rose is a rose is a rose is a rose</span></p>
5194<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5195Properties</a> in the defined value. For example:</p>
5196
5197<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -set origsize '%wx%h' -resize 50% \</span><span class='crtout'> -format 'Old size = %[origsize] New size = %wx%h' info:</span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>Old size = 70x46 New size = 35x23</span></p>
5198<p>Other well known 'properities' that can be include:
5199'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5200'<kbd>signature</kbd>'. </p>
5201
5202<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5203the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5204see <a href="#repage">-page</a>). However it is designed to provide a finer
5205control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5206option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5207attribute. </p>
5208
5209<p>This option can also associate a colorspace or profile with your image.
5210For example,</p>
5211
5212<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.psd -set profile ISOcoated_v2_eci.icc image-icc.psd</span></p>
cristyd0bda5e2010-09-21 16:22:45 +00005213<p>Some 'properties' must be defined in a specific way to be used. For
5214example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5215modify the output filename of an image. For example</p>
5216
5217<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>
5218<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5219be saved as a global "Artifact" exactly as if it was set using the <a
cristyd0bd44a2010-09-24 12:38:11 +00005220href="#define" >-define</a> option. As such settings are globel in scope, they
5221can be used to pass 'attributes' and 'properities' of one specific image,
5222in a way that allows you to use them in a completely different image, even if
5223the original image has long since been modified or destroyed. For example: </p>
5224
5225<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -set option:rosesize '%wx%h' -delete 0 \</span><span class='crtout'> label:'%[rosesize]' label_size_of_rose.gif</span></p>
5226<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5227a 'artifact' if the given <em class="arg">key</em> does not match an existing
5228'attribute' or 'properity'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005229
5230<p>You can set the attributes of the image registry by prefixing the value
5231with <kbd>registry:</kbd>.</p>
5232
5233
cristy3ed852e2009-09-05 21:47:34 +00005234
5235<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005236 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005237</div>
5238
5239<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>shade the image using a distant light source.</td><td style='text-align:right;'></td></tr></table>
5240
5241<p>Specify <em class="arg">azimuth</em> and <em class="arg">elevation</em> as the position of the light source. Use <a href="#shade">+shade</a> to return the shading results as a grayscale image.</p>
5242
5243<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005244 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00005245</div>
5246
5247<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate an image shadow.</td><td style='text-align:right;'></td></tr></table>
5248
5249<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005250 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005251id="shared-memory"></a>-shared-memory</h4>
5252</div>
5253
5254<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>use shared memory.</td><td style='text-align:right;'></td></tr></table>
5255
5256<p>This option specifies whether the utility should attempt to use shared memory for pixmaps. ImageMagick must be compiled with shared memory support, and the display must support the <em class="arg">MIT-SHM</em> extension. Otherwise, this option is ignored. The default is <kbd>True</kbd>.</p>
5257
5258<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005259 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005260</div>
5261
5262<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>sharpen the image.</td><td style='text-align:right;'></td></tr></table>
5263
5264<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5265
5266<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005267 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005268</div>
5269
5270<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Shave pixels from the image edges.</td><td style='text-align:right;'></td></tr></table>
5271
5272<p>The <em class="arg">size</em> portion of the <em class="arg">geometry</em> argument specifies the width of the region to be removed from both sides of the image and the height of the regions to be removed from top and bottom. Offsets are ignored.</p>
5273
5274<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument.</p>
5275
5276<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005277 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005278</div>
5279
5280<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Shear the image along the x-axis and/or y-axis.</td><td style='text-align:right;'></td></tr></table>
5281
5282<p>The shear angles may be positive, negative, or zero. When <em class="arg">Ydegrees</em> is omitted it defaults to 0. When both angles are given, the horizontal component of the shear is performed before the vertical component.</p>
5283
5284<p>Shearing slides one edge of an image along the x-axis or y-axis (i.e., horizontally or vertically, respectively),creating a parallelogram. The amount of each is controlled by the respective shear angle. For horizontal shears, <em class="arg">Xdegrees</em> is measured clockwise relative to "up" (the negative y-axis), sliding the top edge to the right when 0&deg;&lt;<em class="arg">Xdegrees</em>&lt;90&deg; and to the left when 90&deg;&lt;<em class="arg">Xdegrees</em>&lt;180&deg;. For vertical shears <em class="arg">Ydegrees</em> is measured clockwise relative to "right" (the positive x-axis), sliding the right edge down when 0&deg;&lt;<em class="arg">Ydegrees</em>&lt;90&deg; and up when 90&deg;&lt;<em class="arg">Ydegrees</em>&lt;180&deg;.</p>
5285
5286<p>Empty triangles left over from shearing the image are filled with the color defined by the <a href="#fill">-background</a> option. The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5287
5288<p>The horizontal shear is performed before the vertical part. This is important to note, since horizontal and vertical shears do not <em>commute</em>, i.e., the order matters in a sequence of shears. For example, the following two commands are not equivalent.</p>
5289
5290<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x0 -shear 0x60 logo-sheared.png</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 0x60 -shear 20x0 logo-sheared.png</span></p>
5291<p>The first of the two commands above is equivalent to the following, except for the amount of empty space created; the command that follows generates a smaller image, and so is a better choice in terms of time and space.</p>
5292
5293<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5294<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005295 <h4><a id="sigmoidal-contrast"></a>-sigmoidal-contrast <em class="arg">contrast</em>x<em class="arg">mid-point</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005296</div>
5297
5298<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>increase the contrast without saturating highlights or shadows.</td><td style='text-align:right;'></td></tr></table>
5299
5300<p>Increase the contrast of the image using a sigmoidal transfer function without saturating highlights or shadows. <em class="arg">Contrast</em> indicates how much to increase the contrast (0 is none; 3 is typical; 20 is a lot); <em class="arg">mid-point</em> indicates where midtones fall in the resultant image (0 is white; 50% is middle-gray; 100% is black). By default the image contrast is increased, use <em class="arg">+sigmoidal-contrast</em> to decrease the contrast.</p>
5301
5302<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005303 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005304</div>
5305
5306<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>operate silently.</td><td style='text-align:right;'></td></tr></table>
5307
5308<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005309 <h4><a id="size"></a>-size <em class="arg">width</em>[x<em class="arg">height</em>][<em class="arg">+offset</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005310</div>
5311
5312<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set the width and height of the image.</td><td style='text-align:right;'></td></tr></table>
5313
5314<p>Use this option to specify the width and height of raw images whose dimensions are unknown such as <kbd>GRAY</kbd>, <kbd>RGB</kbd>, or <kbd>CMYK</kbd>. In addition to width and height, use <a href="#size">-size</a> with an offset to skip any header information in the image or tell the number of colors in a <kbd>MAP</kbd> image file, (e.g. -size 640x512+256).</p>
5315
5316<p>For Photo CD images, choose from these sizes:</p>
5317
5318<pre class="text">
5319 192x128
5320 384x256
5321 768x512
5322 1536x1024
5323 3072x2048
5324</pre>
5325
cristy3ed852e2009-09-05 21:47:34 +00005326<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005327 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00005328</div>
5329
5330<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate a pencil sketch.</td><td style='text-align:right;'></td></tr></table>
5331
5332<p>Sketch with the given radius, standard deviation (sigma), and angle. The angle given is the angle toward which the image is sketched. That is the direction people would consider the object is coming from. </p>
5333
5334<div style="margin: auto;">
cristy2d67ddd2011-02-13 15:38:23 +00005335 <h4><a id="smush"></a>-smush <em class="arg">offset</em></h4>
5336</div>
5337
5338<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>smush an image sequence together.</td><td style='text-align:right;'></td></tr></table>
5339
5340<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005341 <h4><a id="snaps"></a>-snaps <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005342</div>
5343
5344<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>
5345
5346<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5347
5348<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005349 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005350</div>
5351
5352<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>
5353
5354<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5355
5356<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5357
5358<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005359 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005360 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5361</div>
5362
5363<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>
5364
5365
5366<table class="doc">
5367 <tbody>
5368 <tr valign="top">
5369 <th align="left" style="width: 8%">Method</th>
5370 <th align="left">Description</th>
5371 </tr>
5372
5373 <tr valign="top">
5374 <td valign="top">voronoi</td>
5375 <td valign="top">Simply map each pixel to the to nearest color point
5376 given. The result are polygonal 'cells' of solid color. </td>
5377 </tr>
5378
5379 <tr valign="top">
5380 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005381 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005382 squared. Generating spots of color in a sea of the average of
5383 colors. </td>
5384 </tr>
5385
5386 <tr valign="top">
5387 <td valign="top">barycentric</td>
5388 <td valign="top">three point triangle of color given 3 points.
5389 Giving only 2 points will form a linear gradient between those points.
5390 Gradient is however not restricted to just the triangle or line. </td>
5391 </tr>
5392
5393 <tr valign="top">
5394 <td valign="top">bilinear</td>
5395 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5396 fall back to barycentric. </td>
5397 </tr>
5398
5399 </tbody>
5400</table>
5401
5402<p>The points are placed according to the images location on the virtual
5403canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5404offset), and do not actually have to exist on the given image, but may be
5405some point beyond the edge of the image. All points are floating point values.
5406</p>
5407
5408<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
5409modified, whcih means the matte/alpha transparency channel is not effected by
5410default. If enabled, the image also needs a the matte/alpha channel to be
5411enabled for this operator to effect an images transparency. This is typical
5412transparency handling for images. </p>
5413
5414<p>All the above methods when given a single point of color will replace all
5415the colors in the image with the color given, regardless of the point. This is
5416logical, and provides an alternative technique to recolor a image to some
5417default value. </p>
5418
5419
5420<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005421 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005422</div>
5423
5424<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>
5425
5426<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>
5427
5428<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005429 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005430</div>
5431
5432<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>
5433
5434<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>
5435
5436<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005437 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005438</div>
5439
5440<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>
5441
5442<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>
5443
5444<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005445 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005446</div>
5447
5448<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>
5449
5450<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>
5451
5452<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005453 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005454</div>
5455
5456<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>
5457
5458<pre class="text">
5459 char store pixels as unsigned characters
5460 double store pixels as doubles
5461 float store pixels as floats
5462 integer store pixels as integers
5463 long store pixels as longs
5464 quantum store pixels in the native depth of your ImageMagick distribution
5465 short store pixels as unsigned shorts
5466</pre>
5467
5468<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5469values range from 0 to the maximum value the storage type can support.</p>
5470
5471<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005472 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005473</div>
5474
5475<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>
5476
5477<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>
5478
5479<pre class="text">
5480 Any
5481 Condensed
5482 Expanded
5483 ExtraCondensed
5484 ExtraExpanded
5485 Normal
5486 SemiCondensed
5487 SemiExpanded
5488 UltraCondensed
5489 UltraExpanded
5490</pre>
5491
5492<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5493
5494<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>
5495
5496<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005497 <h4><a id="strip"></a>-strip</h4>
cristy3ed852e2009-09-05 21:47:34 +00005498</div>
5499
5500<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>
5501
5502<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005503 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005504</div>
5505
5506<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>
5507
5508<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5509
5510<p>See <a href="#draw">-draw</a> for further details.</p>
5511
5512<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005513 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005514</div>
5515
5516<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>
5517
5518<p>See <a href="#draw">-draw</a> for further details.</p>
5519
5520<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005521 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005522</div>
5523
5524<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>
5525
cristy71a3f602010-09-15 12:38:16 +00005526<p>This setting suggests a font style that ImageMagick should try to apply to
5527the currently selected font family. Select <em class="arg">fontStyle</em> from
5528the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005529
5530<pre class="text">
5531 Any
5532 Italic
5533 Normal
5534 Oblique
5535</pre>
5536
5537<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>
5538
5539<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005540 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005541</div>
5542
cristyd4d64ed2010-08-22 22:19:33 +00005543<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>
5544
cristy71a3f602010-09-15 12:38:16 +00005545<p>This option is required to have compare search for the best match location
5546of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005547(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005548be the "match score" image.</p>
5549
cristyd0bd44a2010-09-24 12:38:11 +00005550<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005551position of the top-left corner of the given sub-image. that is its size will
5552be the size of the larger_image - sub_image + 1. The brightest location in
5553this image is the location s the locate on the best match that is also
5554reported. Note that this may or may nor be a perfect match, and the actual
5555brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005556possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005557
cristyd0bda5e2010-09-21 16:22:45 +00005558<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005559location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005560sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005561
cristyae6203d2010-08-09 01:12:14 +00005562
5563<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005564 <h4><a id="swap"></a>-swap <em class="arg">index,index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005565</div>
5566
5567<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>
5568
cristy71a3f602010-09-15 12:38:16 +00005569<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5570images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5571the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005572
5573<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005574 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005575</div>
5576
5577<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>
5578
5579<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5580
5581<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005582 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005583</div>
5584
5585<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>synchronize image to storage device.</td><td style='text-align:right;'></td></tr></table>
5586
5587<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005588 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005589</div>
5590
cristy5063d812010-10-19 16:28:10 +00005591<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Mark the image as modified.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005592
5593<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005594 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005595</div>
5596
5597<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>
5598
5599<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>
5600
5601<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>
5602
5603<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005604 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005605</div>
5606
5607<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>
5608
5609<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005610 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005611</div>
5612
5613<!-- {<em class="arg">green,blue,opacity</em>}
5614<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>
5615-->
5616
5617<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>
5618
5619<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>
5620
5621<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.
5622</p>
5623
5624<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>
5625
5626<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5627<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>
5628
5629
5630<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>
5631<p>Note that the values of the transparency channel is treated as 'matte'
5632values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5633
5634<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>.
5635</p>
5636
5637<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005638 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005639</div>
5640
5641<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>
5642
5643<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>
5644
5645<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>
5646
5647<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005648 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005649</div>
5650
5651<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>
5652
5653<div style="margin: auto;">
5654 <h4>-tile <em class="arg">geometry</em></h4>
5655</div>
5656
5657<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>
5658
5659<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>
5660
5661<div style="margin: auto;">
5662 <h4>-tile</h4>
5663</div>
5664
5665<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>
5666
5667<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005668 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00005669</div>
5670
5671<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>
5672
5673<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>
5674
5675<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>
5676
5677<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005678 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005679</div>
5680
5681<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>
5682
5683<p>Tint the image with the fill color.</p>
5684
5685<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>
5686
5687<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005688 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005689</div>
5690
5691<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>
5692
5693<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>
5694
5695<p>For example,</p>
5696
5697<p class="crtsnip">
5698 -title "%m:%f %wx%h"
5699</p>
5700
5701<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>
5702
5703
5704<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005705 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005706</div>
5707
5708<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>
5709
5710<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5711
5712<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 +00005713
5714<p>This operator has been now been superseded by the <a
5715href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5716
5717
cristy3ed852e2009-09-05 21:47:34 +00005718<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005719 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005720</div>
5721
5722<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>
5723
5724<p>The <em class="arg">color</em> argument is defined using the format
5725described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5726>-fuzz</a> setting can be used to match and replace colors similar to the one
5727given. </p>
5728
cristyb36feb22010-03-26 16:54:37 +00005729<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5730that is make all non-matching colors transparent. </p>
5731
cristy3ed852e2009-09-05 21:47:34 +00005732<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005733href="#transparent" >-transparent</a> but replaces the matching color with the
5734current <a href="#fill">-fill</a> color setting, rather than transparent.
5735However the <a href="#transparent" >-transparent</a> operator also ensures
5736that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5737>-alpha</a> set</kbd>", and does not require you to modify the <a
5738href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005739
cristyb36feb22010-03-26 16:54:37 +00005740<p>Note that this does not define the color as being the 'transparency color'
5741used for color-mapped image formats, such as GIF. For that use <a
5742href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005743
5744
5745<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005746 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005747</div>
5748
5749<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>
5750
5751<p>Sometimes this is used for saving to image formats such as
5752GIF and PNG8 which uses this color to represent boolean transparency. This
5753does not make a color transparent, it only defines what color the transparent
5754color is in the color palette of the saved image. Use <a
5755href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5756
5757<p>This option allows you to have both an opaque visible color, as well as a
5758transparent color of the same color value without conflict. That is, you can
5759use the same color for both the transparent and opaque color areas within an
5760image. This, in turn, frees to you to select a transparent color that is
5761appropriate when an image is displayed by an application that does not handle a
5762transparent color index, while allowing ImageMagick to correctly handle images of this
5763type. </p>
5764
5765<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5766
5767<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005768 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005769</div>
5770
5771<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>
5772
5773<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5774</p>
5775
5776<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005777 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005778</div>
5779
5780<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>
5781
5782
5783<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005784 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005785</div>
5786
5787<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>
5788
5789<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>
5790
5791<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>
5792
5793<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>
5794
5795<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005796 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00005797</div>
5798
5799<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>
5800
5801<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>
5802
5803<p>The page or virtual canvas information of the image is preserved allowing
5804you to extract the result of the <a href="#trim">-trim</a> operation from the
5805image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5806information if it is unwanted.</p>
5807
5808<p>If the trimmed image 'disappears' an warning is produced, and a special
5809single pixel transparent 'missed' image is returned, in the same way as when a
5810<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5811
5812
5813<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005814 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005815</div>
5816
5817<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>
cristyefb2bdb2010-11-20 19:35:22 +00005818 <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>, or <kbd>ColorSeparationMatte</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00005819
5820<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>
5821
5822<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5823<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>
5824
5825<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5826
5827<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005828 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005829</div>
5830
5831<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>
5832
5833<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5834
5835<p>See <a href="#draw">-draw</a> for further details.</p>
5836
5837
5838<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005839 <h4><a id="update"></a>-update <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005840</div>
5841
5842<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>
5843
5844<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>
5845
5846
5847<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005848 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00005849</div>
5850
5851<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>
5852
5853
5854<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005855 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005856</div>
5857
5858<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>
5859
5860<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>
5861
5862
5863<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005864 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00005865</div>
5866
5867<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>
5868
5869<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>
5870
5871<p>The parameters are:</p>
5872
5873<pre class="text">
5874 radius: The radius of the Gaussian, in pixels, not counting the center
5875 pixel (default 0).
5876 sigma: The standard deviation of the Gaussian, in pixels (default 1.0).
5877 amount: The fraction of the difference between the original and the blur
5878 image that is added back into the original (default 1.0).
5879 threshold: The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5880 difference amount (default 0.05).
5881</pre>
5882
5883
5884<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005885 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005886</div>
5887
cristyd0bda5e2010-09-21 16:22:45 +00005888<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 +00005889
5890
5891<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005892 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00005893</div>
5894
5895<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>
5896
5897
5898<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005899 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005900</div>
5901
5902<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>
5903
5904
5905<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005906 <h4><a 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>
cristy3ed852e2009-09-05 21:47:34 +00005907</div>
5908
5909<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>
5910
5911
5912<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005913 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005914</div>
5915
5916<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>
5917
5918<p>This option defines what color source should be used if and when a color
5919lookup completely 'misses' the source image. The color(s) that appear to
5920surround the source image. Generally this color is derived from the source
5921image, but could also be set to a specify background color. </p>
5922
5923<p>Choose from these methods:</p>
5924
5925<pre class="text">
5926 background: the area surrounding the image is the background color
5927 black: the area surrounding the image is black
5928 checker-tile: alternate squares with image and background color
5929 dither: non-random 32x32 dithered pattern
5930 edge: extend the edge pixel toward infinity
5931 gray: the area surrounding the image is gray
5932 horizontal-tile: horizontally tile the image, background color above/below
5933 horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
5934 mirror: mirror tile the image
5935 random: choose a random pixel from the image
5936 tile: tile the image (default)
5937 transparent: the area surrounding the image is transparent blackness
5938 vertical-tile: vertically tile the image, sides are background color
5939 vertical-tile-edge: vertically tile the image and replicate the side edge pixels
5940 white: the area surrounding the image is white
5941</pre>
5942
5943<p>The default value is "edge".</p>
5944
5945<p>This most important for distortion operators such as <a href="#distort"
5946>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
5947However it also effects operations that may access pixels just outside the
5948image proper, such as <a href="#convolve">-convolve</a>, <a
5949href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
5950
5951<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
5952
5953
5954<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005955 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005956</div>
5957
5958<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>
5959
5960<p>Choose from these visual classes:</p>
5961
5962<pre class="text">
5963 StaticGray
5964 GrayScale
5965 StaticColor
5966 PseudoColor
5967 TrueColor
5968 DirectColor
5969 default
5970 visual id
5971</pre>
5972
5973<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>
5974
5975
5976<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005977 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00005978 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
5979</div>
5980
5981<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
5982saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5983
5984<p>Take a grayscale image (with alpha mask) and modify the destination image's
5985brightness according to watermark image's grayscale value and the <em
5986class="arg">brightness</em> percentage. The destinations color saturation
5987attribute is just direct modified by the <em class="arg">saturation</em>
5988percentage, which defaults to 100 percent (no color change). </p>
5989
5990
5991<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005992 <h4><a id="wave"></a>-wave <em class="arg">amplitude</em><br />-wave <em class="arg">amplitude</em>x<em class="arg">wavelength</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005993</div>
5994
5995<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>
5996
5997<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
5998
5999<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006000 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006001</div>
6002
6003<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>
6004
6005<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>
6006
6007<table class="doc">
6008 <col width="25%" />
6009 <col width="75%" />
6010 <thead>
6011 <tr>
6012 <th><em class="arg">fontWeight</em></th>
6013 <th>Description</th>
6014 </tr>
6015 </thead>
6016 <tbody>
6017 <tr><td>All </td> <td>No effect. </td></tr>
6018 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
6019 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
6020 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
6021 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
6022 </tbody>
6023 </table>
6024
6025<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
6026
6027<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>
6028
6029<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006030 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006031</div>
6032
6033<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>
6034
6035<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006036 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00006037</div>
6038
cristy5cadd612009-09-21 19:33:41 +00006039<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>
6040
6041<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.
6042</p>
cristy3ed852e2009-09-05 21:47:34 +00006043
6044<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006045 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006046</div>
6047
6048<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>
6049
6050<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>
6051
6052<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>
6053
6054<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>
6055
6056<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006057 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006058</div>
6059
6060<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>
6061
6062<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006063 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006064</div>
6065
6066<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>
6067 <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>
6068
6069<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006070</div>
6071</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006072
6073</div>
6074
6075<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006076 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006077 <span id="linkbar-center">
6078 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006079 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006080 </span>
6081 <span id="linkbar-east">&nbsp;</span>
6082 </div>
6083 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +00006084 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006085 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6086 </div>
6087 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006088 <script type="text/javascript">
6089 var _gaq = _gaq || [];
6090 _gaq.push(['_setAccount', 'UA-17690367-1']);
6091 _gaq.push(['_trackPageview']);
6092
6093 (function() {
6094 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6095 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6096 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6097 })();
6098 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006099</body>
6100</html>