blob: 117598ceb242da906d7d8e10c51a4824a1aa67de [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"/>
cristydcca3fa2010-12-29 21:50:07 +000016 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, 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"/>
31 <style type="text/css" media="all">
32 @import url("../www/magick.css");
33 </style>
cristydcca3fa2010-12-29 21:50:07 +000034 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
35 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
36 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
37 <script type="text/javascript">
38 $(document).ready(function() {
39 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
40 'transitionIn' : 'elastic',
41 'transitionOut' : 'elastic',
42 'overlayShow' : false,
43 'opacity' : true
44 });
45 });
46 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000047</head>
48
49<body id="www-imagemagick-org">
50<div class="titlebar">
51<a href="../index.html">
52 <img src="../images/script.png" alt="[ImageMagick]"
53 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
54<a href="http://www.networkredux.com">
55 <img src="../images/networkredux.png" alt="[sponsor]"
56 style="margin: 45px auto; border: 0px; float: left;" /></a>
57<a href="http://www.imagemagick.org/discourse-server/">
58 <img src="../images/logo.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60<a href="../index.html">
61 <img src="../images/sprite.jpg" alt=""
62 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
63</div>
64
cristyce69bb02010-07-27 19:49:46 +000065<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000066
cristy3ed852e2009-09-05 21:47:34 +000067<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000069</div>
cristy3eaa0ef2010-03-06 20:35:26 +000070<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000071<div class="menu">
cristybb503372010-05-27 20:51:26 +000072 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
79</div>
80<div class="sub">
81 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
82</div>
83<div class="sep"></div>
84<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000085 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000086</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000088 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</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: Options" href="../www/command-line-options.html">Options</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: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000106 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
108<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000109 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000111<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000112<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000113 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</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: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000120 </div>
121<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000122 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000123</div>
cristybb503372010-05-27 20:51:26 +0000124<div class="menu">
125 <a title="Architecture" href="../www/architecture.html">Architecture</a>
126</div>
cristy3ed852e2009-09-05 21:47:34 +0000127<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000128 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000129</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000130<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000131<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000132 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000133</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000134<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000135<div class="menu">
cristydcca3fa2010-12-29 21:50:07 +0000136 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
138<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000139 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000140</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000141<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000142<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000143 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000144
145<div class="sponsbox">
146<div class="sponsor">
cristy61105362010-12-19 23:22:14 +0000147 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011040100025 gabi.schulze-->
cristy7d52cd62010-10-01 17:26:59 +0000148</div>
149<div class="sponsor">
150 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000151</div>
152<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000153 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
154</div>
155<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000156 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
157</div>
cristy3ed852e2009-09-05 21:47:34 +0000158</div>
159</div>
cristyce69bb02010-07-27 19:49:46 +0000160</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000161
cristyce69bb02010-07-27 19:49:46 +0000162<div class="eastbar">
163 <script type="text/javascript">
164 <!--
165 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000166 google_ad_slot = "0574824969";
167 google_ad_width = 160;
168 google_ad_height = 600;
169 //-->
170 </script>
171 <script type="text/javascript"
172 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
173 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000174</div>
175
176<div class="main">
177
cristydcca3fa2010-12-29 21:50:07 +0000178<h1>Create, Edit, or Compose Bitmap Images With These Command-line Options</h1>
cristy5cadd612009-09-21 19:33:41 +0000179<p class="navigation-index">
cristy5063d812010-10-19 16:28:10 +0000180[ <a href="../www/command-line-options.html#adaptive-blur">&#x2011;adaptive&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adaptive-resize">&#x2011;adaptive&#x2011;resize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adaptive-sharpen">&#x2011;adaptive&#x2011;sharpen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adjoin">&#x2011;adjoin</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#affine">&#x2011;affine</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#alpha">&#x2011;alpha</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#annotate">&#x2011;annotate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#antialias">&#x2011;antialias</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#append">&#x2011;append</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#attenuate">&#x2011;attenuate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#authenticate">&#x2011;authenticate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-gamma">&#x2011;auto&#x2011;gamma</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-level">&#x2011;auto&#x2011;level</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-orient">&#x2011;auto&#x2011;orient</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#backdrop">&#x2011;backdrop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#background">&#x2011;background</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bench">&#x2011;bench</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bias">&#x2011;bias</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blackpoint-compensation">&#x2011;blackpoint&#x2011;compensation</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#black-threshold">&#x2011;black&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blend">&#x2011;blend</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blue-primary">&#x2011;blue&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blue-shift">&#x2011;blue&#x2011;shift</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blur">&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#border">&#x2011;border</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bordercolor">&#x2011;bordercolor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#borderwidth">&#x2011;borderwidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#brightness-contrast">&#x2011;brightness&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cache">&#x2011;cache</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#caption">&#x2011;caption</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cdl">&#x2011;cdl</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#channel">&#x2011;channel</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#charcoal">&#x2011;charcoal</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#chop">&#x2011;chop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clamp">&#x2011;clamp</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip">&#x2011;clip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip-mask">&#x2011;clip&#x2011;mask</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip-path">&#x2011;clip&#x2011;path</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clone">&#x2011;clone</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clut">&#x2011;clut</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#coalesce">&#x2011;coalesce</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colorize">&#x2011;colorize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colormap">&#x2011;colormap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#color-matrix">&#x2011;color&#x2011;matrix</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colors">&#x2011;colors</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colorspace">&#x2011;colorspace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#combine">&#x2011;combine</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#comment">&#x2011;comment</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#compose">&#x2011;compose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#composite">&#x2011;composite</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#compress">&#x2011;compress</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#contrast">&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#contrast-stretch">&#x2011;contrast&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#convolve">&#x2011;convolve</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#crop">&#x2011;crop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cycle">&#x2011;cycle</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#debug">&#x2011;debug</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#decipher">&#x2011;decipher</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#deconstruct">&#x2011;deconstruct</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#define">&#x2011;define</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#delay">&#x2011;delay</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#delete">&#x2011;delete</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#density">&#x2011;density</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#depth">&#x2011;depth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#descend">&#x2011;descend</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#deskew">&#x2011;deskew</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#despeckle">&#x2011;despeckle</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#direction">&#x2011;direction</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#displace">&#x2011;displace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#display">&#x2011;display</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dispose">&#x2011;dispose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dissimilarity-threshold">&#x2011;dissimilarity&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dissolve">&#x2011;dissolve</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#distort">&#x2011;distort</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dither">&#x2011;dither</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#draw">&#x2011;draw</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#edge">&#x2011;edge</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#emboss">&#x2011;emboss</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#encipher">&#x2011;encipher</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#encoding">&#x2011;encoding</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#endian">&#x2011;endian</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#enhance">&#x2011;enhance</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#equalize">&#x2011;equalize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#evaluate">&#x2011;evaluate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#evaluate-sequence">&#x2011;evaluate&#x2011;sequence</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#extent">&#x2011;extent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#extract">&#x2011;extract</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#family">&#x2011;family</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#features">&#x2011;features</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fft">&#x2011;fft</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fill">&#x2011;fill</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#filter">&#x2011;filter</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flatten">&#x2011;flatten</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flip">&#x2011;flip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#floodfill">&#x2011;floodfill</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flop">&#x2011;flop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#font">&#x2011;font</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#foreground">&#x2011;foreground</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#format">&#x2011;format</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#format_identify_">&#x2011;format[identify]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#frame">&#x2011;frame</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#frame_import_">&#x2011;frame[import]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#function">&#x2011;function</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fuzz">&#x2011;fuzz</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fx">&#x2011;fx</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gamma">&#x2011;gamma</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gaussian-blur">&#x2011;gaussian&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#geometry">&#x2011;geometry</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gravity">&#x2011;gravity</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#green-primary">&#x2011;green&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#hald-clut">&#x2011;hald&#x2011;clut</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#help">&#x2011;help</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#highlight-color">&#x2011;highlight&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#iconGeometry">&#x2011;iconGeometry</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#iconic">&#x2011;iconic</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#identify">&#x2011;identify</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ift">&#x2011;ift</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#immutable">&#x2011;immutable</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#implode">&#x2011;implode</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#insert">&#x2011;insert</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#intent">&#x2011;intent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interlace">&#x2011;interlace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interpolate">&#x2011;interpolate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interline-spacing">&#x2011;interline&#x2011;spacing</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interword-spacing">&#x2011;interword&#x2011;spacing</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#kerning">&#x2011;kerning</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#label">&#x2011;label</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#lat">&#x2011;lat</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#layers">&#x2011;layers</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#level">&#x2011;level</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#level-colors">&#x2011;level&#x2011;colors</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#limit">&#x2011;limit</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#linear-stretch">&#x2011;linear&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#linewidth">&#x2011;linewidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#liquid-rescale">&#x2011;liquid&#x2011;rescale</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#list">&#x2011;list</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#log">&#x2011;log</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#loop">&#x2011;loop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#lowlight-color">&#x2011;lowlight&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#magnify">&#x2011;magnify</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#map">&#x2011;map</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#map_stream_">&#x2011;map[stream]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mask">&#x2011;mask</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mattecolor">&#x2011;mattecolor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#median">&#x2011;median</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#metric">&#x2011;metric</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mode">&#x2011;mode</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#modulate">&#x2011;modulate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#monitor">&#x2011;monitor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#monochrome">&#x2011;monochrome</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#morph">&#x2011;morph</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#morphology">&#x2011;morphology</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mosaic">&#x2011;mosaic</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#motion-blur">&#x2011;motion&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#name">&#x2011;name</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#negate">&#x2011;negate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#noise">&#x2011;noise</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#normalize">&#x2011;normalize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#opaque">&#x2011;opaque</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ordered-dither">&#x2011;ordered&#x2011;dither</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#orient">&#x2011;orient</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#page">&#x2011;page</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#paint">&#x2011;paint</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#path">&#x2011;path</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pause_animate_">&#x2011;pause[animate]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pause_import_">&#x2011;pause[import]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pen">&#x2011;pen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ping">&#x2011;ping</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pointsize">&#x2011;pointsize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#polaroid">&#x2011;polaroid</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#posterize">&#x2011;posterize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#precision">&#x2011;precision</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#preview">&#x2011;preview</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#print">&#x2011;print</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#process">&#x2011;process</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#profile">&#x2011;profile</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quality">&#x2011;quality</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quantize">&#x2011;quantize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quiet">&#x2011;quiet</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#radial-blur">&#x2011;radial&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#raise">&#x2011;raise</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#random-threshold">&#x2011;random&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#red-primary">&#x2011;red&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#regard-warnings">&#x2011;regard&#x2011;warnings</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#region">&#x2011;region</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#remap">&#x2011;remap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#remote">&#x2011;remote</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#render">&#x2011;render</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#repage">&#x2011;repage</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#resample">&#x2011;resample</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#resize">&#x2011;resize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#respect-parentheses">&#x2011;respect&#x2011;parentheses</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#reverse">&#x2011;reverse</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#roll">&#x2011;roll</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#rotate">&#x2011;rotate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sample">&#x2011;sample</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sampling-factor">&#x2011;sampling&#x2011;factor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#scale">&#x2011;scale</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#scene">&#x2011;scene</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#screen">&#x2011;screen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#seed">&#x2011;seed</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#segment">&#x2011;segment</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#selective-blur">&#x2011;selective&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#separate">&#x2011;separate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sepia-tone">&#x2011;sepia&#x2011;tone</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#set">&#x2011;set</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shade">&#x2011;shade</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shadow">&#x2011;shadow</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shared-memory">&#x2011;shared&#x2011;memory</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sharpen">&#x2011;sharpen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shave">&#x2011;shave</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shear">&#x2011;shear</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sigmoidal-contrast">&#x2011;sigmoidal&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#silent">&#x2011;silent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#size">&#x2011;size</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sketch">&#x2011;sketch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#snaps">&#x2011;snaps</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#solarize">&#x2011;solarize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sparse-color">&#x2011;sparse&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#splice">&#x2011;splice</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#spread">&#x2011;spread</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stegano">&#x2011;stegano</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stereo">&#x2011;stereo</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stretch">&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#strip">&#x2011;strip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stroke">&#x2011;stroke</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#strokewidth">&#x2011;strokewidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#style">&#x2011;style</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#subimage-search">&#x2011;subimage&#x2011;search</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#swap">&#x2011;swap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#swirl">&#x2011;swirl</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#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 +0000181
cristydcca3fa2010-12-29 21:50:07 +0000182<div class="doc-section">
183
cristyb36feb22010-03-26 16:54:37 +0000184<p>Below is list of command-line options recognized by the ImageMagick <a
185href="../www/command-line-tools.html">command-line
186tools</a>. If you want a description of a particular option, click on the
187option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000188otherwise 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 +0000189
190<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000191 <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 +0000192</div>
193
194<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 +0000195<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>
196
197<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000198 <h4><a id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000199</div>
200
201<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>
202
203<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>
204
205<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000206 <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 +0000207</div>
208
209<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>
210
211<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>
212
213<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000214 <h4><a id="adjoin"></a>-adjoin</h4>
cristy3ed852e2009-09-05 21:47:34 +0000215</div>
216
217<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>
218
219<p>This option is enabled by default. An attempt is made to save all
220images of an image sequence into the given output file.
221However, some formats, such as JPEG and PNG, do not support more than one
222image per file, and in that case ImageMagick is forced to write each image as a separate file. As
223such, if more than one image needs to be written, the filename given is
224modified by adding a <a href="#scene">-scene</a> number before the
225suffix, in order to make distinct names for each image. </p>
226
227<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written
228to separate files, whether or not the file format allows multiple images
229per file (for example, GIF, MIFF, and TIFF). </p>
230
231<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>
232
233<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: rose: -morph 15 my%02dmorph.jpg</span></p>
234<p>will create a sequence of 17 images named my00morph.jpg, my01morph.jpg, my02morph.jpg, ..., my16morph.jpg.
235</p>
236
237<p>In summary, ImageMagick tries to write all images to one file, but will use
cristydcca3fa2010-12-29 21:50:07 +0000238multiple files if either<br />
239 (1) the output image's file format does not allow multi-image files,<br />
240 (2) the <a href="#adjoin">+adjoin</a> option is given, or<br />
241 (3) a printf() integer format string (eg: "%d") is present in the output filename. </p>
cristy3ed852e2009-09-05 21:47:34 +0000242
243
244<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000245 <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 +0000246 -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>
247</div>
248
249<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>
250
251<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>
252
253<p>The matrix entries are entered as comma-separated numeric values <i>with no spaces</i>. </p>
254
255<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>
256
257<div class="eqn">
258<img alt="affine transformation" src="../images/affine.png"/>
259</div>
260
261<p>
262The 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>
263
264<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>
265
266<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>
267
268<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>
269
270<p class="crtsnip">
271 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
272</p>
273
274<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>
275
276<p class="crtsnip">
277 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
278</p>
279
280<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
281<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
282
283<p class="crtsnip">
284 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
285</p>
286
287<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>
288
289<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>
290
291<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000292 <h4><a id="alpha"></a>-alpha <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000293</div>
294
295<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>
296
297<p>Used to set a flag on an image indicating whether or not to use existing alpha
298channel 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>
299
300
301<table class="doc">
302 <tbody>
303 <tr valign="top">
304 <th align="left" style="width: 8%">type</th>
305 <th align="left">Description</th>
306 </tr>
307
308 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000309 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000310 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000311 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
312 should be used instead of this, unless you specifically need to
313 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
314 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000315
316 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000317 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000318 <td valign="top">
319 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000320 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000321
322 <tr valign="top">
323 <td valign="top"><kbd>Set</kbd></td>
324 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000325 Activates the alpha/matte channel. If it was previously turned off
326 then it also resets the channel to opaque. If the image already had
327 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000328
329 <tr valign="top">
330 <td valign="top"><kbd>Opaque</kbd></td>
331 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000332 Enables the alpha/matte channel and forces it to be fully opaque.
333 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000334
335 <tr valign="top">
336 <td valign="top"><kbd>Transparent</kbd></td>
337 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000338 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000339 transparent. This effectively creates a fully transparent image the
340 same size as the original and with all its original RGB data still
341 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000342
343 <tr valign="top">
344 <td valign="top"><kbd>Extract</kbd></td>
345 <td valign="top">
346 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000347 '<kbd>Off</kbd>' the the image's transparency, so as to generate
348 a gray-scale mask of the image's shape. The alpha channel data is left
349 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
350 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000351
352 <tr valign="top">
353 <td valign="top"><kbd>Copy</kbd></td>
354 <td valign="top">
355 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000356 gray-scale intensity of the image, into the alpha channel, converting
357 a gray-scale mask into a transparent shaped mask ready to be colored
358 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000359
360 <tr valign="top">
361 <td valign="top"><kbd>Shape</kbd></td>
362 <td valign="top">
363 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000364 the current background color. That is the RGB color channels is
365 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000366 </td></tr>
367
368 <tr valign="top">
369 <td valign="top"><kbd>Background</kbd></td>
370 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000371 Set any fully-transparent pixel to the background color, while leaving
372 it fully-transparent. This can make some image file formats, such as
373 PNG, smaller as the RGB values of transparent pixels are more uniform,
374 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000375 </td></tr>
376 </tbody>
377</table>
378
379<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000380"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000381>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000382Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000383
384
385<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000386 <h4><a id="annotate"></a>
cristy3ed852e2009-09-05 21:47:34 +0000387 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
388 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
389 -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>
390</div>
391
392<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>
393
394<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>
395
396
397<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>
398
399<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>
400
401<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>
402<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
403
404<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>
405
406<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>
407
408<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000409 <h4><a id="antialias"></a>-antialias</h4>
cristy3ed852e2009-09-05 21:47:34 +0000410</div>
411
412<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
413drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
414
415<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
416drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
417antialiasing edge pixels. This will then reduce the number of colors added to
418an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000419are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000420
421<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000422 <h4><a id="append"></a>-append</h4>
cristy3ed852e2009-09-05 21:47:34 +0000423</div>
424
425<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>
426
427<p>This option creates a single longer image image, by joining all the current
428images in sequence top-to-bottom. Use <a href="#append">+append</a> to
429stack images left-to-right. </p>
430
431<p>If they are not of the same width, narrower images are padded with the
432current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000433position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000434href="#gravity">-gravity</a> setting. </p>
435
436
437<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000438 <h4><a id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000439</div>
440
441<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>
442
443
444<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000445 <h4><a id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000446</div>
447
448<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>
449
450<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>
451
452<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
453
cristyd934d102009-10-10 12:55:13 +0000454
455
cristy3ed852e2009-09-05 21:47:34 +0000456<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000457 <h4><a id="auto-gamma"></a>-auto-gamma</h4>
cristy3ed852e2009-09-05 21:47:34 +0000458</div>
459
460<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>
461
cristyd934d102009-10-10 12:55:13 +0000462<p>This calculates the mean values of an image, then applies a calculated <a
463href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
464image it will get a have a value of 50%. </p>
465
cristyd0bd44a2010-09-24 12:38:11 +0000466<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000467
468<p>This works well for real-life images with little or no extreme dark and
469light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000470dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000471</p>
472
473<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000474'<em>sync</em>' flag for channel syncronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000475values is used and modified. As the default <a href="#channel"
cristydcca3fa2010-12-29 21:50:07 +0000476>-channel</a> setting is '<em>RGB,sync</em>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000477together by the same gamma value, preserving colors. </p>
478
479
480
cristy3ed852e2009-09-05 21:47:34 +0000481<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000482 <h4><a id="auto-level"></a>-auto-level</h4>
cristy3ed852e2009-09-05 21:47:34 +0000483</div>
484
485<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>
486
cristyd934d102009-10-10 12:55:13 +0000487<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000488minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000489href="#level" >-level</a> operator to stretch the values to the full range of
490values. </p>
491
cristy83543962009-10-16 19:04:28 +0000492<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000493JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
494for the <a href="#level" >-level</a> operation. On the other hand it is the
495right operator to use for color stretching gradient images being used to
496generate Color lookup tables, distortion maps, or other 'mathematically'
497defined images. </p>
498
499<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
500href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
501>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
502problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000503>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000504
505<p>It uses the <a href="#channel" >-channel</a> setting, (including the
cristydcca3fa2010-12-29 21:50:07 +0000506special '<em>sync</em>' flag for channel syncronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000507which color values are used and modified. As the default <a
cristydcca3fa2010-12-29 21:50:07 +0000508href="#channel" >+channel</a> setting is '<em>RGB,sync</em>', the
509'<em>sync</em>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000510together by the same gamma value, preserving colors, and ignoring
511transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000512
513
cristy3ed852e2009-09-05 21:47:34 +0000514<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000515 <h4><a id="auto-orient"></a>-auto-orient</h4>
cristy3ed852e2009-09-05 21:47:34 +0000516</div>
517
518<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>
519
cristy83543962009-10-16 19:04:28 +0000520<p>This operator reads and resets the EXIF image profile setting 'Orientation'
521and then performs the appropriate 90 degree rotation on the image to orient
522the image, for correct viewing. </p>
523
524<p>This EXIF profile setting is usually set using a gravity sensor in digital
525camara, however photos taken directly downward or upward may not have an
526appropriate value. Also images that have been orientation 'corrected' without
527reseting this setting, may be 'corrected' again resulting in a incorrect
528result. If the he EXIF profile was previously stripped, the <a
529href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
530
531
cristy3ed852e2009-09-05 21:47:34 +0000532<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000533 <h4><a id="average"></a>-average</h4>
cristy3ed852e2009-09-05 21:47:34 +0000534</div>
535
536<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>
537
538<p>An error results if the images are not identically sized.</p>
539
cristy3ed852e2009-09-05 21:47:34 +0000540
541<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000542 <h4><a id="backdrop"></a>-backdrop</h4>
cristy3ed852e2009-09-05 21:47:34 +0000543</div>
544
545<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>
546
547<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>
548
549<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000550 <h4><a id="background"></a>-background <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000551</div>
552
553<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>
554
555<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>
556
557<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000558 <h4><a id="bench"></a>-bench <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000559</div>
560
561<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>
562
cristye6378132009-10-26 20:05:17 +0000563<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 +0000564
cristye6378132009-10-26 20:05:17 +0000565<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>
566<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 +0000567
568<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000569 <h4><a id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000570</div>
571
572<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>
573
574<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>
575
576<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>
577
578<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
579negative results without clipping to the color value range
580(0..QuantumRange).</p>
581
582<p>See the discussion on HDRI implementations of ImageMagick on the page
583<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.
584</p>
585
586<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000587 <h4><a id="black-point-compensation"></a>-black-point-compensation</h4>
cristy3ed852e2009-09-05 21:47:34 +0000588</div>
589
590<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>
591
592<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000593 <h4><a id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000594</div>
595
cristy5cadd612009-09-21 19:33:41 +0000596<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>
597
598<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.
599</p>
cristy3ed852e2009-09-05 21:47:34 +0000600
601
602<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000603 <h4><a id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000604</div>
605
cristy83a272e2010-05-07 20:40:35 +0000606<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 +0000607
608<p>Blend will average the images together ('plus') according to the
609percentages given and each pixels transparency. If only a single percentage
610value is given it sets the weight of the composite or 'source' image, while
611the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000612<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
613'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000614
615
616<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000617 <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 +0000618</div>
619
620<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>
621
622<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000623 <h4><a id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000624</div>
625
626<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>
627
628<div style="margin: auto;">
629
630<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000631 <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 +0000632</div>
633
634<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>
635
cristyb15553d2010-07-03 22:53:14 +0000636<p>Convolve the image with a Gaussian or normal distribution using the given
637<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000638
639<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
640</div>
641
cristyb15553d2010-07-03 22:53:14 +0000642<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000643determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000644
cristyb15553d2010-07-03 22:53:14 +0000645<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000646array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000647integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000648radius that will provide meaningful results for the Gaussian distribution.
649</p>
650
651<p>The larger the <em class="arg" >Radius</em> the radius the slower the
652operation is. However too small a <em class="arg" >Radius</em>, and sever
653aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
654should be at least twice the <em class="arg" >Sigma</em> value, though three
655times will produce a more accurite result. </p>
656
657<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
658by taking advantage of the separability properties of the distribution. Here
659we apply a single-dimensional Gaussian matrix in the horizontal direction,
660then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000661
662<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
663pixels which are outside the image proper are blurred into the final result.
664</p>
665
666
667<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000668 <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 +0000669</div>
670
671<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>
672
673<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
674Average (EWA) of the source image, scaled according to the grayscale
675mapping. </p>
676
677<p>The ellipse is weighted with sigma set to the given <em class="arg"
678>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
679defaults to the <em class="arg" >Width</em> for a normal circular Guassian
680weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
681horizontal clock-wise. </p>
682
683<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
684pixels which are outside the image proper are blurred into the final result.
685</p>
686
687
688<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000689 <h4><a id="border"></a>-border <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000690</div>
691
692<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>
693
cristybc9539a2010-08-16 18:06:20 +0000694<p>Set the width and height using the <em class="arg">size</em> portion of the
695<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
696ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000697
cristybc9539a2010-08-16 18:06:20 +0000698<p>Set the border color by preceding with the <a
699href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000700
cristybc9539a2010-08-16 18:06:20 +0000701<p>The <a href="#border">-border</a> operation is affected by the current <a
702href="#compose">-compose</a> setting and assumes that this is using the default
703'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
704size colors by the current <a href="#bordercolor">-bordercolor</a> before
705overlaying the original image in the center of this net image. This means that
706with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000707be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000708<p>See also the <a href="#frame">-frame</a> option, which has more
709functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000710
711<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000712 <h4><a id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000713</div>
714
715<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>
716
717<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
718
719<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
720
721<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000722 <h4><a id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
cristy3ed852e2009-09-05 21:47:34 +0000723</div>
724
725<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>
726
727<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000728 <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 +0000729</div>
730
731<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>
732
cristyefb2bdb2010-11-20 19:35:22 +0000733<p>Brightness and Contrast values apply changes to the input image. They are
734not absolute settings. A brightness or contrast value of zero means no change.
735The range of values is -100 to +100 on each. Positive values increase the
736brightness or contrast and negative values decrease the brightness or contrast.
737To control only contrast, set the brightness=0. To control only brightness,
738set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000739
cristyefb2bdb2010-11-20 19:35:22 +0000740<p>You may also use <a href="#fill">-channel</a> to control which channels to
741apply the brightness and/or contrast change. The default is to apply the same
742transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000743
cristyefb2bdb2010-11-20 19:35:22 +0000744<p>Brightness and Contrast arguments are converted to offset and slope of a
745linear transform and applied
746using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000747
cristyefb2bdb2010-11-20 19:35:22 +0000748<p>The slope varies from 0 at contrast=-100 to almost vertical at
749contrast=+100. For brightness=0 and contrast=-100, the result are totally
750midgray. For brightness=0 and contrast=+100, the result will approach but
751not quite reach a threshold at midgray; that is the linear transformation
752is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000753
cristyefb2bdb2010-11-20 19:35:22 +0000754<p>Negative slopes, i.e. negating the image, are not possible with this
755function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000756
cristyefb2bdb2010-11-20 19:35:22 +0000757<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
758at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
759totally white. Similarly, when contrast=0 and brightness=-100, the result is
760totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000761
cristyefb2bdb2010-11-20 19:35:22 +0000762<p>As the range of values for the arguments are -100 to +100, adding the '%'
763symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000764
765<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000766 <h4><a id="cache"></a>-cache <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000767</div>
768
769<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>
770
771<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000772 <h4><a id="caption"></a>-caption <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000773</div>
774
775<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>
776
cristy71a3f602010-09-15 12:38:16 +0000777<p>This option sets the caption meta-data of an image read in after this
778option has been given. To modify a caption of images already in memory use
779"<kbd><a href="#set">-set</a> caption</kbd>". </p>
780
781<p>The caption can contain special format characters listed in the <a
782href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000783Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000784is finally assigned to the individual images. </p>
785
786<p>If the first character of <em class="arg">string</em> is <em
787class="arg">@</em>, the image caption is read from a file titled by the
788remaining characters in the string. Comments read in from a file are literal;
789no embedded formatting characters are recognized.</p>
790
791<p>Caption meta-data ais not visible on the image itself. To do that use the
792<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
793instead.</p>
794
795<p>For example,</p>
796
797<p class="crtsnip">
798 -caption "%m:%f %wx%h" bird.miff
799</p>
800
801<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
802that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
803480.</p>
804
805
cristy3ed852e2009-09-05 21:47:34 +0000806<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000807 <h4><a id="cdl"></a>-cdl <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000808</div>
809
810<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>
811
812<p>Here is an example color correction collection:</p>
813
814<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000815&lt;?xml version="1.0" encoding="UTF-8"?&gt;
816&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
817 &lt;ColorCorrection id="cc06668"&gt;
818 &lt;SOPNode&gt;
819 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
820 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
821 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
822 &lt;/SOPNode&gt;
823 &lt;SATNode&gt;
824 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
825 &lt;/SATNode&gt;
826 &lt;/ColorCorrection&gt;
827&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000828</pre>
829
830<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000831 <h4><a id="channel"></a>-channel <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000832</div>
833
834<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>
835
cristyefb2bdb2010-11-20 19:35:22 +0000836<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
837<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
838<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
839<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000840
cristy83a272e2010-05-07 20:40:35 +0000841<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000842abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
843'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
844'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000845
cristy83a272e2010-05-07 20:40:35 +0000846For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
847you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000848<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000849 -channel Red,Blue
850</p>
851<p>or you can use the short hand form</p>
852<p class="crtsnip">
853 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000854</p>
855
cristy83a272e2010-05-07 20:40:35 +0000856<p>All the channels that is present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000857special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
858but generally any operators that are generally 'grey-scale' image operators,
859will understand this setting. See individual operator documentation. </p>
860
cristydcca3fa2010-12-29 21:50:07 +0000861<br />
cristy83a272e2010-05-07 20:40:35 +0000862
863<p>On top of the normal channel selection a extra flag can be specified,
864'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000865operators that understand this flag should perform: cross-channel
866syncronization of the channels. If not specified, then most grey-scale
867operators will apply their image processing operations to each individual
868channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000869setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000870
871<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000872<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000873together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000874it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000875independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000876
cristydcca3fa2010-12-29 21:50:07 +0000877<p>The <a href="#morphology">-morphology</a> '<kbd>Convolve</kbd>' method
cristybac7a162010-06-15 19:57:29 +0000878and the <a href="#compose">-compose</a> mathematical methods, also understands
879the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
880to the alpha channel (if present). That is to say it will modify the image
881processing with the understanding that fully-transparent colors should not
882contribute to the final result. </p>
883
cristydcca3fa2010-12-29 21:50:07 +0000884<p>Basically, by default, operators work with color channels in syncronous, and
cristybac7a162010-06-15 19:57:29 +0000885treats transparency as special, unless the <a href="#channel">-channel</a>
886setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
887How each operator does this depends on that operators current implementation.
888Not all operators understands this flag at this time, but that is changing.
889</p>
cristy83a272e2010-05-07 20:40:35 +0000890
891<p>To print a complete list of channel types, use <a href="#list">-list
892channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000893
cristydcca3fa2010-12-29 21:50:07 +0000894<br />
cristyd934d102009-10-10 12:55:13 +0000895
896<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000897'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
898channels except the transparency channel, and that all the color channels are
899to be modified in exactly the same way, with a understanding of transprancy
900(depending on the operation being applied). The 'plus' form <a
901href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000902
903<p>Options that are affected by the <a href="#channel" >-channel</a> setting
904include the following.
905
906<a href="#auto-gamma">-auto-gamma</a>,
907<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000908<a href="#black-threshold">-black-threshold</a>,
909<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000910<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000911<a href="#clut">-clut</a>,
912<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000913<a href="#composite">-composite</a> (Mathematical compose methods only),
914<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000915<a href="#contrast-stretch">-contrast-stretch</a>,
916<a href="#evaluate">-evaluate</a>,
917<a href="#function">-function</a>,
918<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000919<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000920<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000921<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000922<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000923<a href="#negate">-negate</a>,
924<a href="#normalize">-normalize</a>,
925<a href="#ordered-dither">-ordered-dither</a>,
926<a href="#radial-blur">-radial-blur</a>,
927<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000928<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000929<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000930<a href="#white-threshold">-white-threshold</a>.
931</p>
932
cristyd0bda5e2010-09-21 16:22:45 +0000933<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +0000934>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +0000935href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +0000936default). These operators have yet to be made to understand the newer 'Sync'
937flag. </p>
938
cristybac7a162010-06-15 19:57:29 +0000939<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
940the image before thresholding, if no <a href="#channel" >-channel</a> setting
941has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +0000942
943<p>Also some operators such as <a href="#blur">-blur</a>, <a
944href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
945color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
946href="#channel" >-channel</a>. Generally this done to ensure that
947fully-transparent colors are treated as being fully-transparent, and thus any
948underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +0000949resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +0000950convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +0000951and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +0000952
cristybac7a162010-06-15 19:57:29 +0000953<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +0000954color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +0000955alpha channel present, and the <a href="#channel" >-channel</a> setting tells
956the operator to apply the operation using alpha channels. The <a
957href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +0000958
cristy3ed852e2009-09-05 21:47:34 +0000959
960<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000961 <h4><a id="clamp"></a>-clamp</h4>
cristyb4c03bb2009-09-27 13:55:46 +0000962</div>
963
964<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>
965
966<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000967 <h4><a id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000968</div>
969
970<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>
971
972<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +0000973 <h4><a id="chop"></a>-chop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000974</div>
975
976<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>
977
cristyefb2bdb2010-11-20 19:35:22 +0000978<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>
979and <em class="arg">height</em> given in the of the <em class="arg">size</em>
980portion of the <em class="arg">geometry</em> argument give the number of
981columns and rows to remove. The <em class="arg">offset</em> portion of
982the <em class="arg">geometry</em> argument is influenced by
983a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +0000984
cristyefb2bdb2010-11-20 19:35:22 +0000985<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
986and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +0000987
cristydcca3fa2010-12-29 21:50:07 +0000988<p>While it can remove internal rows and columns of pixels, it is more typically
989used with as <a href="#gravity">-gravity</a> setting and a '<kbd>+0+0</kbd>' offset
990so as to remove a single edge from an image. Compare this to <a href="#shave"
991>-shave</a> whcih removes equal numbers of pixels from oppisite sides of the image.
992</p>
993
994<p>Using <a href="#chop">-chop</a> will effectivally undo the results of a
995<a href="#splice">-splice</a> that was given the same <em class="arg">geometry</em>
996and <a href="#gravity">-gravity</a> settings. </p>
997
998
cristy3ed852e2009-09-05 21:47:34 +0000999<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001000 <h4><a id="clip"></a>-clip</h4>
cristy3ed852e2009-09-05 21:47:34 +00001001</div>
1002
1003<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>
1004
1005<p>If a clipping path is present, it is applied to subsequent operations.</p>
1006
1007<p>For example, in the command</p>
1008
1009<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
1010<p>only the pixels within the clipping path are negated.</p>
1011
1012<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
1013
1014<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001015 <h4><a id="clip-mask"></a>-clip-mask</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%'>Clip the image as defined by this mask.</td><td style='text-align:right;'></td></tr></table>
1019
1020<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001021 <h4><a id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001022</div>
1023
1024<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>
1025
1026<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001027 <h4><a id="clone"></a>-clone <em class="arg">index(s)</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001028</div>
1029
1030<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>
1031
cristydcca3fa2010-12-29 21:50:07 +00001032<p>Inside parenthesis (where the operator is normally used) it will make a
1033clone of the images from the last 'pushed' image sequence, and adds them to
1034the end of the current image sequence. Outside parenthesis
1035(not recommended) it clones the images from the current image sequence. </p>
1036
cristy3ed852e2009-09-05 21:47:34 +00001037<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000010380. Negative indexes are relative to the end of the sequence; for
cristydcca3fa2010-12-29 21:50:07 +00001039example, <kbd>&minus;1</kbd>
cristy3ed852e2009-09-05 21:47:34 +00001040represents the last image of the sequence. Specify a range of images with a
cristydcca3fa2010-12-29 21:50:07 +00001041dash (e.g. <kbd>0&minus;4</kbd>). Separate multiple indexes with commas but no
1042spaces (e.g. <kbd>0,2,5</kbd>). A value of '<kbd>0&minus;&minus;1</kbd> will
1043effectivally clone all the images. </p>
1044
1045<p>The <a href="#clone">+clone</a> will simply make a copy of the last image
1046in the image sequence, and is thus equivelent to using a argument of
1047'<kbd>&minus;1</kbd>'. </p>
cristy3ed852e2009-09-05 21:47:34 +00001048
1049<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001050 <h4><a id="clut"></a>-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00001051</div>
1052
1053<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
1054corresponding channel in the second image as a <b>c</b>olor
1055<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1056
1057<p>The second (LUT) image is ordinarily a gradient image containing the
1058histogram mapping of how each channel should be modified. Typically it is a
1059either a single row or column image of replacement color values. If larger
1060than a single row or column, values are taken from a diagonal line from
1061top-left to bottom-right corners.</p>
1062
1063<p>The lookup is further controlled by the <a
1064href="#interpolate">-interpolate</a> setting, which is especially handy for an
1065LUT which is not the full length needed by the ImageMagick installed Quality
1066(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1067'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1068gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1069lookup of color values. </p>
1070
1071<p>This operator is especially suited to replacing a grayscale image with a
1072specific color gradient from the CLUT image. </p>
1073
1074<p>Only the channel values defined by the <a href="#channel">-channel</a>
1075setting will have their values replaced. In particular, since the default <a
1076href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1077transparency (alpha/matte channel) is not affected, unless the <a
1078href="#channel">-channel</a> setting is modified. When the alpha channel is
1079set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1080as the other channels, implying that alpha/matte values are replaced using the
1081alpha/matte values of the original image. </p>
1082
cristyd0bda5e2010-09-21 16:22:45 +00001083<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001084transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1085href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001086assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001087replacement alpha values. That is you can use a gray-scale CLUT image to
1088adjust a existing images alpha channel, or you can color a gray-scale image
1089using colors form CLUT containing the desired colors, including transparency.
1090</p>
1091
cristyefb2bdb2010-11-20 19:35:22 +00001092<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1093according to the lookup of the full color RGB value from a 2D representation
1094of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001095
1096
1097<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001098 <h4><a id="coalesce"></a>-coalesce</h4>
cristy3ed852e2009-09-05 21:47:34 +00001099</div>
1100
1101<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>
1102
cristyefb2bdb2010-11-20 19:35:22 +00001103<p>Overlay each image in an image sequence according to
1104its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1105an animation at each point in the animation sequence. All images should be
1106the same size, and are assigned appropriate GIF disposal settings for the
1107animation to continue working as expected as a GIF animation. Such frames
1108are more easily viewed and processed than the highly optimized GIF overlay
1109images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001110
cristyefb2bdb2010-11-20 19:35:22 +00001111<p>The animation can be re-optimized after processing using
1112the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1113there is no guarantee that the restored GIF animation optimization is
1114better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001115
1116
1117<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001118 <h4><a id="colorize"></a>-colorize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001119</div>
1120
1121<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>
1122
cristyefb2bdb2010-11-20 19:35:22 +00001123<p>Specify the amount of colorization as a percentage. Separate colorization
1124values can be applied to the red, green, and blue channels of the image with
1125a comma-delimited list of colorization
1126values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001127
1128<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001129 <h4><a id="colormap"></a>-colormap <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001130</div>
1131
1132<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>
1133
1134<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1135
cristyefb2bdb2010-11-20 19:35:22 +00001136<p>This option only applies when the default X server visual
1137is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1138to <a href="#visual">-visual</a> for more details. By default,
1139a shared colormap is allocated. The image shares colors with
1140other X clients. Some image colors could be approximated,
1141therefore your image may look very different than intended.
1142If <kbd>private</kbd> is chosen, the image colors appear exactly
1143as they are defined. However, other clients may go <em>technicolor</em>
1144when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001145
1146<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001147 <h4><a id="colors"></a>-colors <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001148</div>
1149
1150<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>
1151
cristyefb2bdb2010-11-20 19:35:22 +00001152<p>The actual number of colors in the image may be less than your request,
1153but never more. Note that this a color reduction option. Images with fewer
1154unique colors than specified by <em class="arg">value</em> will have any
1155duplicate or unused colors removed. The ordering of an existing color
1156palette may be altered. When converting an image from color to grayscale,
1157it is more efficient to convert the image to the gray colorspace before
1158reducing the number of colors. Refer to
1159the <a href="../www/quantize.html">
1160color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001161
1162<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001163 <h4><a id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
cristy2c839602010-04-03 02:32:08 +00001164</div>
1165
1166<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>
1167
cristyefb2bdb2010-11-20 19:35:22 +00001168<p>This option permits saturation changes, hue rotation, luminance to alpha,
1169and various other effects. Although variable-sized transformation matrices
1170can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1171for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1172Adobe Flash except offsets are in column 6 rather than 5 (in support of
1173CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001174
1175<p>As an example, to add contrast to an image with offsets, try this command:</p>
1176
1177<pre class="text">
1178convert kittens.jpg -color-matrix \
1179 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1180 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1181 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1182 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1183 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1184 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1185</pre>
1186<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001187 <h4><a id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001188</div>
1189
1190<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>
1191
1192<p>Choices are:</p>
1193
1194<pre class="text">
1195 CMY
1196 CMYK
1197 Gray
1198 HSB
1199 HSL
1200 HWB
1201 Lab
1202 Log
1203 OHTA
1204 Rec601Luma
1205 Rec601YCbCr
1206 Rec709Luma
1207 Rec709YCbCr
1208 RGB
1209 sRGB
1210 Transparent
1211 XYZ
1212 YCbCr
1213 YCC
1214 YIQ
1215 YPbPr
1216 YUV
1217</pre>
1218
1219<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1220
1221<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>
1222
1223<table class="doc">
1224 <caption>Conversion Of RGB To Other Color Spaces</caption>
1225 <tr><th align="left" valign="middle">CMY</th></tr>
1226 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1227 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1228 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1229 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1230 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1231 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1232 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1233 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1234
1235 <tr><th align="left" valign="middle">Gray</th></tr>
1236 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1237
1238 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1239 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1240 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1241 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1242
1243 <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>
1244 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1245 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1246 <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>
1247
1248 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1249 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1250 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1251 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1252
1253 <tr><th align="left" valign="middle">LAB</th></tr>
1254 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1255 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1256 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1257
1258 <tr><th align="left" valign="middle">LOG</th></tr>
1259 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1260 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1261 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1262
1263 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1264 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1265 <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>
1266 <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>
1267
1268 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1269 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1270
1271 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1272 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1273 <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>
1274 <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>
1275
1276 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1277 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1278
1279 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1280 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1281 <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>
1282 <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>
1283
1284 <tr><th align="left" valign="middle">sRGB</th></tr>
1285 <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>
1286 <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>
1287 <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>
1288
1289 <tr><th align="left" valign="middle">XYZ</th></tr>
1290 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1291 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1292 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1293
1294 <tr><th align="left" valign="middle">YCC</th></tr>
1295 <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>
1296 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1297 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1298
1299 <tr><th align="left" valign="middle">YCbCr</th></tr>
1300 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1301 <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>
1302 <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>
1303
1304 <tr><th align="left" valign="middle">YIQ</th></tr>
1305 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1306 <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>
1307 <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>
1308
1309 <tr><th align="left" valign="middle">YPbPr</th></tr>
1310 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1311 <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>
1312 <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>
1313
1314 <tr><th align="left" valign="middle">YUV</th></tr>
1315 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1316 <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>
1317 <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>
1318</table>
1319
1320<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001321 <h4><a id="combine"></a>-combine</h4>
cristy3ed852e2009-09-05 21:47:34 +00001322</div>
1323
1324<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>
1325
1326<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>
1327
1328<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.
1329</p>
1330
cristy4949d522010-03-12 18:41:34 +00001331<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 +00001332<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001333 <h4><a id="comment"></a>-comment <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001334</div>
1335
1336<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>
1337
cristyd0bda5e2010-09-21 16:22:45 +00001338<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001339option has been given. To modify a comment of images already in memory use
1340"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001341
cristy71a3f602010-09-15 12:38:16 +00001342<p>The comment can contain special format characters listed in the <a
1343href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001344Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001345is finally assigned to the individual images. </p>
1346
1347<p>If the first character of <em class="arg">string</em> is <em
1348class="arg">@</em>, the image comment is read from a file titled by the
1349remaining characters in the string. Comments read in from a file are literal;
1350no embedded formatting characters are recognized.</p>
1351
1352<p>Comment meta-data are not visible on the image itself. To do that use the
1353<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1354instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001355
1356<p>For example,</p>
1357
1358<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001359 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001360</p>
1361
cristy71a3f602010-09-15 12:38:16 +00001362<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1363that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1364480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001365
1366<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001367 <h4><a id="compose"></a>-compose <em class="arg">operator</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001368</div>
1369
1370<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>
1371
cristybc9539a2010-08-16 18:06:20 +00001372<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1373a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001374
cristybc9539a2010-08-16 18:06:20 +00001375<p>This setting effects image processing operators that merge two (or more)
1376images together in some way. This includes the operators,
1377<a href="#composite">-composite</a>,
1378<a href="#layers">-layers</a> composite,
1379<a href="#flatten">-flatten</a>,
1380<a href="#mosaic">-mosaic</a>,
1381<a href="#layers">-layers</a> merge,
1382<a href="#border">-border</a>,
1383<a href="#frame">-frame</a>,
1384and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001385
cristybc9539a2010-08-16 18:06:20 +00001386<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1387command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001388
1389
1390<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001391 <h4><a id="composite"></a>-composite</h4>
cristy3ed852e2009-09-05 21:47:34 +00001392</div>
1393
cristybc9539a2010-08-16 18:06:20 +00001394<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 +00001395
1396<p>Take the first image 'destination' and overlay the second 'source' image
1397according to the current <a href="#compose">-compose</a> setting. The location
1398of the 'source' or 'overlay' image is controlled according to <a
1399href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1400settings. </p>
1401
1402<p>If a third image is given this is treated as a gray-scale 'mask' image
1403relative to the first 'destination' image. This mask will limit what parts of
1404the destination can be modified by the image composition. However for the
1405'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1406Y-displacement image instead. </p>
1407
1408<p>If a <a href="#compose">-compose</a> method requires extra numerical
1409arguments or flags these can be provided by setting the <a
1410href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001411appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001412
1413<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1414image outside the overlay area. You can disable this by setting the special <a
1415href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1416to '<kbd>false</kbd>'. </p>
1417
1418
1419<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001420 <h4><a id="compress"></a>-compress <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001421</div>
1422
1423<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>
1424
1425<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>
1426
1427<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1428
1429<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>
1430
1431<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>
1432
1433<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>
1434
1435<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>
1436
1437<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001438 <h4><a id="contrast"></a>-contrast</h4>
cristy3ed852e2009-09-05 21:47:34 +00001439</div>
1440
1441<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>
1442
1443<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>
1444
1445<p>For a more pronounced effect you can repeat the option:</p>
1446
1447<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1448<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001449 <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 +00001450</div>
1451
1452<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>
1453
cristyd934d102009-10-10 12:55:13 +00001454<p>While performing the stretch, black-out at most <em
1455class="arg" >black-point</em> pixels and white-out at most <em
1456class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1457<em class="arg" >black-point %</em> pixels and white-out at most <em
1458class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001459
cristyd934d102009-10-10 12:55:13 +00001460<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1461>-contrast-stretch</a> will black-out at most <em class="arg"
1462>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1463minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1464class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1465>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001466
cristyd934d102009-10-10 12:55:13 +00001467<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1468the image's min and max values are stretched to 0 and <em class="QR"
1469>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1470clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001471>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001472prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001473
cristyd934d102009-10-10 12:55:13 +00001474<p>Internally operator works by creating a histogram bin, and then uses that
1475bin to modify the image. As such some colors may be merged together when they
1476originally fell into the same 'bin'. </p>
1477
1478<p>All the channels are normalized in concert by the came amount so as to
1479preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001480setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001481setting will normalize the RGB channels independently.</p>
1482
1483<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1484normalization of mathematical images. </p>
1485
1486<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001487
1488
1489<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001490 <h4><a id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001491</div>
1492
1493<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>
1494
cristy16ff93c2010-01-13 23:18:07 +00001495<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001496a comma-separated list of integers (with no spaces), ordered left-to right,
1497starting with the top row. Presently, only odd-dimensioned kernels are
1498supported, and therefore the number of entries in the specified <em
1499class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
15007<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001501
cristyd934d102009-10-10 12:55:13 +00001502<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
1503positive and negative results are relative to a user-specified bias value.
1504This is important for non-HDRI compilations of ImageMagick when dealing with
1505convolutions that contain negative as well as positive values. This is
1506especially the case with convolutions involving high pass filters or edge
1507detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001508</p>
1509
cristyd934d102009-10-10 12:55:13 +00001510<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
1511negative results without clipping to the color value range (0..QuantumRange).
1512See the discussion on HDRI implementations of ImageMagick on the page <a
1513href="/www/high-dynamic-range.html">High
1514Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1515href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1516<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1517entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001518
cristy3ed852e2009-09-05 21:47:34 +00001519
1520<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001521 <h4><a id="crop"></a>-crop <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001522</div>
1523
1524<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>
1525
1526<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>
1527
1528<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>
1529
1530<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>
1531
1532<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>
1533
1534<p>By adding a exclamation character flag to the geometry argument, the
1535cropped images virtual canvas page size and offset is set as if the
1536geometry argument was a viewport or window. This means the canvas page size
1537is set to exactly the same size you specified, the image offset set
1538relative top left corner of the region cropped. </p>
1539
1540<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1541special single pixel transparent 'missed' image is returned, and a 'crop
1542missed' warning given. </p>
1543
cristy739df912009-10-24 16:10:18 +00001544<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 +00001545
1546<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001547 <h4><a id="cycle"></a>-cycle <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001548</div>
1549
1550<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>
1551
1552<p><em class="arg">Amount</em> defines the number of positions each
1553colormap entry is shifted.</p>
1554
1555
1556<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001557 <h4><a id="debug"></a>-debug <em class="arg">events</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001558</div>
1559
1560<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>
1561
1562<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>
1563
1564
1565<p>For example, to log cache and blob events, use.</p>
1566
1567<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1568<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1569
1570<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1571
1572<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1573
1574<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1575
1576<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>
1577
1578
1579<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001580 <h4><a id="decipher"></a>-decipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001581</div>
1582
1583<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>
1584
1585<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1586
1587<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1588
1589
1590<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001591 <h4><a id="deconstruct"></a>-deconstruct</h4>
cristy3ed852e2009-09-05 21:47:34 +00001592</div>
1593
1594<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>
1595
1596<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>
1597
1598<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>
1599
1600<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1601
1602
1603<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001604 <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 +00001605</div>
1606
cristyd0bd44a2010-09-24 12:38:11 +00001607<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 +00001608coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001609
cristyd0bda5e2010-09-21 16:22:45 +00001610<p>This option creates one or more definitions for coders and decoders to use
1611while reading and writing image data. Definitions are generally used to
1612control image file format coder modules, and image processing operations,
1613beyond what is provided by normal means. Defined settings are listed in <a
1614href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1615as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001616
cristyd0bda5e2010-09-21 16:22:45 +00001617<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1618definition of a flag is created with that name. This used to control on/off
1619options. Use <a href="#define">+define key</a> to remove definitions
1620previously created. Use <a href="#define">+define "*"</a> to remove all
1621existing definitions.</p>
1622
cristyd0bd44a2010-09-24 12:38:11 +00001623<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001624href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001625>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 +00001626Properties</a> in the defined value. </p>
1627
cristyefb2bdb2010-11-20 19:35:22 +00001628<p>The <em>option</em> and <em>key</em> are case-independent (they are
1629converted to lowercase for use within the decoders) while the <em>value</em>
1630is case-dependent.</p>
1631
cristyd0bda5e2010-09-21 16:22:45 +00001632<p>Such settings are global in scope, and effect all images and operations. </p>
1633
1634<p>The following definitions are just some of the artifacts that are
1635available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001636
cristydcca3fa2010-12-29 21:50:07 +00001637<dl>
cristy045bd902010-01-30 18:56:24 +00001638<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001639<dd>Set the display range to the minimum and maximum pixel values for the
cristydcca3fa2010-12-29 21:50:07 +00001640 DCM image format.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001641
cristy045bd902010-01-30 18:56:24 +00001642<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001643<dd>Set the specify the layout engine for the DOT image format (e.g.
cristydcca3fa2010-12-29 21:50:07 +00001644 <kbd>neato</kbd>).</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001645
cristy045bd902010-01-30 18:56:24 +00001646<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001647<dd>Restrict the maximum JPEG file size, for example <kbd>-define
cristydcca3fa2010-12-29 21:50:07 +00001648 jpeg:extent=400kb</kbd>.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001649
cristy045bd902010-01-30 18:56:24 +00001650<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001651<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1652 It is most useful for increasing performance and reducing the memory
cristydcca3fa2010-12-29 21:50:07 +00001653 requirements when reducing the size of a large JPEG image.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001654
cristy045bd902010-01-30 18:56:24 +00001655<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001656<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1657 compression factor is the reciprocal of the compression ratio. The valid
1658 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1659 this value overrides the -quality setting. A quality setting of 75
cristydcca3fa2010-12-29 21:50:07 +00001660 results in a rate value of 0.06641.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001661
cristy3ed852e2009-09-05 21:47:34 +00001662<dt>mng:need-cacheoff</dt>
cristydcca3fa2010-12-29 21:50:07 +00001663 <dd>turn playback caching off for streaming MNG.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001664
cristy045bd902010-01-30 18:56:24 +00001665<dt>png:bit-depth=<em class="arg">value</em></dt>
1666<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001667<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1668 encoder to use a different bit-depth and color-type than it would have
1669 normally selected, but only if this does not cause any loss of image
1670 quality. Any attempt to reduce image quality is treated as an error and no
1671 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1672 can use these "defines" to cause it to be written as an 8-bit grayscale,
1673 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1674 you cannot force it to be written as a grayscale or indexed PNG. If you
1675 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1676 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1677 reduce the image quality prior to using the PNG encoder. Note that in
1678 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001679 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristydcca3fa2010-12-29 21:50:07 +00001680 8-bit depth.</dd>
1681
1682<dt>png:exclude-chunk=<em class="arg">value</em></dt>
1683<dt>png:include-chunk=<em class="arg">value</em></dt>
1684<dd>ancillary chunks to be excluded from or included in PNG output.
1685
1686 <p>The<em class="arg">value</em> can be the name of a PNG chunk-type such
1687 as <em class="arg">bKGD</em>, a comma-separated list of chunk-types,
1688 or the word <em class="arg">all</em> or
1689 the word <em class="arg">none</em>. There must be no spaces in the
1690 list. Although PNG chunk-names are case-dependent, you can use
1691 all lowercase names if you prefer.</p>
1692
1693 <p>As a special case, if the <kbd>sRGB</kbd> chunk is excluded and
1694 the <kbd>gAMA</kbd> chunk is included, the <kbd>gAMA</kbd> chunk will
1695 only be written if gamma is not 1/2.2, since most decoders assume
1696 sRGB and gamma=1/2.2 when no colorspace information is included in
1697 the PNG file. Because the list is processed from left to right, you
1698 can achieve this with a single define:</p>
1699
1700<pre class="text">
1701 -define png:include-chunk=none,gAMA
1702</pre>
1703
1704 <p>The critical PNG chunks <kbd>IHDR</kbd>, <kbd>PLTE</kbd>,
1705 <kbd>IDAT</kbd>, and <kbd>IEND</kbd> cannot be excluded. Any of
1706 these entries appearing in the list will be ignored.</p>
1707
1708 <p>If the ancillary PNG <kbd>tRNS</kbd> chunk is excluded and the
1709 image has transparency, the PNG colortype is forced to be 4 or 6
1710 (GRAY_ALPHA or RGBA). If the image is not transparent, then the
1711 <kbd>tRNS</kbd> chunk isn't written anyhow, and there is no effect
1712 on the PNG colortype of the output image.</p>
1713
1714 <p>The <a href="#strip">-strip</a> option does the equivalent of the
1715 following for PNG output:</p>
1716
1717<pre class="text">
1718 -define png:include-chunk=none,gama
1719</pre>
1720
1721 <p>The default behavior is to include all known PNG ancillary chunks
1722 plus ImageMagick's private <kbd>vpAg</kbd> ("virtual page") chunk.</p>
1723 </dd>
cristyd0bda5e2010-09-21 16:22:45 +00001724
cristy3ed852e2009-09-05 21:47:34 +00001725<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001726<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1727 Postscript files that render bilevel images with the Postscript imagemask
cristydcca3fa2010-12-29 21:50:07 +00001728 operator instead of the image operator.</dd>
cristyd0bda5e2010-09-21 16:22:45 +00001729
cristy045bd902010-01-30 18:56:24 +00001730<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001731<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1732 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1733 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001734 included, the result is a single precision floating point format.
1735 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001736 double precision floating point format.</dd>
1737
cristydcca3fa2010-12-29 21:50:07 +00001738</dl>
cristy3ed852e2009-09-05 21:47:34 +00001739
cristyd0bda5e2010-09-21 16:22:45 +00001740<p>For example, to create a postscript file that will render only the black
1741pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001742
1743<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 +00001744<p>Set attributes of the image registry by prefixing the value with
1745<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1746use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001747
1748<p class="crtsnip">
1749-define registry:temporary-path=/data/tmp
1750</p>
1751
cristyd0bda5e2010-09-21 16:22:45 +00001752
1753
cristy3ed852e2009-09-05 21:47:34 +00001754<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001755 <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 +00001756</div>
1757
1758<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>
1759
1760<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>
1761
1762<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>
1763
1764
1765<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001766 <h4><a id="delete"></a>-delete <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001767</div>
1768
1769<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>
1770
1771<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>
1772
1773
1774<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001775 <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 +00001776</div>
1777
1778<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>
1779
1780<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>
1781
1782<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>
1783
1784<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>
1785
1786<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>
1787
1788<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001789 <h4><a id="depth"></a>-depth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001790</div>
1791
1792<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>
1793
1794<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>
1795
1796<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001797 <h4><a id="descend"></a>-descend</h4>
cristy3ed852e2009-09-05 21:47:34 +00001798</div>
1799
1800<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>
1801
1802<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001803 <h4><a id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001804</div>
1805
1806<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>
1807
1808<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>
1809
1810<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001811 <h4><a id="despeckle"></a>-despeckle</h4>
cristy3ed852e2009-09-05 21:47:34 +00001812</div>
1813
1814<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>
1815
1816<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001817 <h4><a id="direction"></a>-direction <em class="arg">type</em></h4>
cristy2c839602010-04-03 02:32:08 +00001818</div>
1819
1820<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>
1821
1822<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001823 <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 +00001824</div>
1825
1826<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>
1827
1828<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001829is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001830what part of the 'background' image is seen at each point of the overlaid
1831area. Much like the displacement map is a 'lens' that redirects light shining
1832through it so as to present a distorted view the original 'background' image
1833behind it. </p>
1834
1835<p>Any perfect grey areas of the displacement map produce a zero
1836displacement of the image. Black areas produce the given maximum negative
1837displacement of the lookup point, while white produce a maximum positive
1838displacement of the lookup. </p>
1839
1840<p>Note that it is the lookup of the 'background' that is displaced, not a
1841displacement of the image itself. As such an area of the displacement map
1842containing 'white' will have the lookup point 'shifted' by a positive amount,
1843and thus generating a copy of the destination image to the right/downward from
1844the correct position. That is the image will look like it may have been
1845'shifted' in a negative left/upward direction. Understanding this is a very
1846important in understanding how displacement maps work. </p>
1847
1848<p>The given arguments define the maximum amount of displacement in pixels
1849that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001850it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001851outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001852easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001853into the overlay area. </p>
1854
1855<p>The '%' flag makes the displacement scale relative to the size of the
1856overlay image (100% = half width/height of image). Using '!' switches
1857percentage arguments to refer to the destination image size instead.
1858these flags were added as of IM v6.5.3-5.</p>
1859
1860<p>Normally a single grayscale displacement map is provided, which with the
1861given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001862displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001863specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001864the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001865displacement, while the <em class="arg">mask image</em> is used for vertical Y
1866displacement. This allows you to define completely different displacement
1867values for the X and Y directions, and allowing you to lookup any point within
1868the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001869any other nearby pixel, producing complex 2 dimensional displacements, rather
1870than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001871
cristyd0bda5e2010-09-21 16:22:45 +00001872<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001873you can use the 'red' channel of the overlay image to specify the horizontal
1874or X displacement, and the 'green' channel for the vertical or Y displacement.
1875</p>
1876
cristyd0bd44a2010-09-24 12:38:11 +00001877<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 +00001878mask the transparency of the destination image. However areas outside the
1879overlaid areas will not be effected. </p>
1880
1881
1882<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001883 <h4><a id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001884</div>
1885
1886<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>
1887
1888<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1889
1890<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001891 <h4><a id="dispose"></a>-dispose <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001892</div>
1893
1894<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>
1895
1896<p>The layer disposal method defines the way each the displayed image is to be
1897modified after the current 'frame' of an animation has finished being
1898displayed (after its 'delay' period), but before the next frame on an
1899animation is to be overlaid onto the display. </p>
1900
1901<p>Here are the valid methods:</p>
1902
1903<pre class="text">
1904Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
1905None 1 Do not dispose, just overlay next frame image.
1906Background 2 Clear the frame area with the background color.
1907Previous 3 Clear to the image prior to this frames overlay.
1908</pre>
1909
1910<p>You can also use the numbers given above, which is what the GIF format
1911uses internally to represent the above settings. </p>
1912
cristyd0bda5e2010-09-21 16:22:45 +00001913<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00001914
1915<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
1916resetting the layer disposal methods of images being read in. </p>
1917
1918<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
1919disposal method for images already in memory.</p>
1920
1921<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001922 <h4><a id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001923</div>
1924
1925<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>
1926
1927
1928<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001929 <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 +00001930</div>
1931
1932<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>
1933
1934<p>The opacity of the composite image is multiplied by the given percent, then
1935it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00001936is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00001937transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
1938are given, each image are dissolved to the percentages given. </p>
1939
1940<p>Note that dissolve percentages do not add, two opaque images dissolved
1941'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
1942images, you would need to use dissolve values of '50,100'. </p>
1943
1944<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00001945 <h4><a id="distort"></a>-distort <em class="arg">method arguments</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00001946</div>
1947
1948<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>
1949
1950<p>The <em class="arg">arguments</em> is a single string containing a list
1951of floating point numbers separated by commas or spaces. The number of
1952and meaning of the floating point values depends on the distortion <em
1953class="arg">method</em> being used. </p>
1954
1955<p>Choose from these distortion types:</p>
1956
1957<table class="doc">
1958 <tr valign="top">
1959 <th align="left" style="width: 8%">Method</th>
1960 <th align="left">Description</th>
1961 </tr>
1962
1963 <tr valign="top">
1964 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
1965 <br/>or &nbsp; <kbd>SRT</kbd></td>
1966 <td valign="top">
1967 Distort image by first scaling and rotating about a given 'center',
1968 before translating that 'center' to the new location, in that order. It
1969 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
1970 distortion, but without shearing effects. It also provides a good way
1971 of rotating and displacing a smaller image for tiling onto a larger
1972 background (IE 2-dimensional animations). <br/>
1973
1974 The number of arguments determine the specific meaning of each
1975 argument for the scales, rotation, and translation operations. <br/>
1976
1977 <table style="margin-left:auto; margin-right:auto;">
1978 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
1979 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
1980 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
cristydcca3fa2010-12-29 21:50:07 +00001981 <tr><td>3:</td><td><em>X,Y &nbsp; &nbsp; Angle</em></td></tr>
cristy3ed852e2009-09-05 21:47:34 +00001982 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
1983 <tr><td>5:</td>
1984 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
1985 <tr><td>6:</td>
1986 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
1987 <tr><td>7:</td>
1988 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
1989 &nbsp; NewX,NewY</em></td></tr>
1990 </table>
1991
cristyd0bda5e2010-09-21 16:22:45 +00001992 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00001993 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
1994
1995 <tr valign="top">
1996 <td valign="top"><kbd>Affine</kbd></td>
1997 <td valign="top">
1998 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00001999 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00002000 point values are given allowing the image to be linearly scaled,
2001 rotated, sheared, and translated, according to those three points. See
2002 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2003 distortions. <br/>
2004
2005 More than 3 sets given control point pairs (12 numbers) is least
2006 squares fitted to best match a lineary affine distortion. If only 2
2007 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00002008 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00002009 flipping or changes in aspect ratio to the resulting image. If only one
2010 control point pair is provides the image is only translated, (which may
2011 be a floating point non-integer translation). <br/>
2012
2013 This distortion does not include any form of perspective distortion.
2014 </td>
2015
2016 </tr>
2017
2018 <tr valign="top">
2019 <td valign="top"><kbd>AffineProjection</kbd></td>
2020 <td valign="top">
2021 Linearly distort an image using the given Affine Matrix of 6
2022 pre-calculated coefficients forming a set of Affine Equations to map
2023 the source image to the destination image.
2024
2025 <div style="text-align: center"><em>
2026 s<sub>x</sub>, r<sub>x</sub>,
2027 r<sub>y</sub>, s<sub>y</sub>,
2028 t<sub>x</sub>, t<sub>y</sub>
2029 </em></div>
2030
2031 See <a href="#affine" >-affine</a> setting for more detail, and
2032 meanings of these coefficients. <br/>
2033
2034 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00002035 alternative methods of defining this distortion, with ImageMagick doing
2036 the calculations needed to generate the required coefficients. You can
2037 see the internally generated coefficients, by using a <a
2038 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00002039
2040 </tr>
2041
cristy3ed852e2009-09-05 21:47:34 +00002042 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002043 <td valign="top"><kbd>BilinearForward</kbd><br/>
2044 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00002045 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00002046 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
2047 16 values (see below). Not that lines may not appear straight after
2048 distortion, though the distance between coordinates will remain
2049 consistent. <br/>
2050
2051 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
2052 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
2053 quadrilateral to a rectangle, while preserving the straigth line edges
2054 in each case. <br/>
2055
2056 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
2057 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
2058 color setting. Also if the quadraterial becomes 'flipped' the image
2059 may dissappear. <br/>
2060
2061 There are future plans to produce a true Bilinear distortion that will
2062 attempt to map any quadrilateral to any other quadrilateral, while
2063 preserving edges (and edge distance ratios).
2064
2065 </td>
cristy3ed852e2009-09-05 21:47:34 +00002066 </tr>
cristy3ed852e2009-09-05 21:47:34 +00002067
2068 <tr valign="top">
2069 <td valign="top"><kbd>Perspective</kbd></td>
2070 <td valign="top">
2071 Perspective distort the images, using a list of 4 or more sets of
2072 control points (as defined below). More that 4 sets (16 numbers) of
2073 control points provide least squares fitting for more accurate
2074 distortions (for the purposes of image registration and panarama
2075 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2076 linear distortion. <br/>
2077
2078 Perspective Distorted images ensures that straight lines remain
2079 straight, but the scale of the distorted image will vary. The horizon
2080 is anti-aliased, and the 'sky' color may be set using the
2081 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2082 </tr>
2083
2084 <tr valign="top">
2085 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2086 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002087 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002088 pre-calculated coefficients. You can get these coefficients by looking
2089 at the <a href="#verbose" >-verbose</a> output of a
2090 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2091 If the last two perspective scaling coefficients are zero, the
2092 remaining 6 represents a transposed 'Affine Matrix'. </td>
2093
2094 </tr>
2095
2096 <tr valign="top">
2097 <td valign="top"><kbd>Arc</kbd></td>
2098 <td valign="top">
2099 Arc the image (variation of polar mapping) over the angle given around
2100 a circle. <br/>
2101 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2102 <tr valign="top"><td>Argument</td>
2103 <td>Meaning</td></tr>
2104 <tr valign="top"><td><em>arc_angle</em></td>
2105 <td>The angle over which to arc the image side-to-side</td></tr>
2106 <tr valign="top"><td><em>rotate_angle</em></td>
2107 <td>Angle to rotate resulting image from vertical center</td></tr>
2108 <tr valign="top"><td><em>top_radius</em></td>
2109 <td>Set top edge of source image at this radius</td></tr>
2110 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2111 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2112 </table>
2113
2114 The resulting image is always resized to best fit the resulting image,
2115 (as if using <a href="#distort" >+distort</a>) while attempting to
2116 preserve scale and aspect ratio of the original image as much as
2117 possible with the arguments given by the user. All four arguments will
2118 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2119
2120 This a variation of a polar distortion designed to try to preserve the
2121 aspect ratio of the image rather than direct Cartesian to Polar
2122 conversion. </td>
2123 </tr>
2124
2125 <tr valign="top">
2126 <td valign="top"><kbd>Polar</kbd></td>
2127 <td valign="top">
2128 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2129 the image. that is the height of the input image is mapped to the
2130 radius limits, while the width is wrapped around between the
2131 angle limits. <br/>
2132
2133 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2134
2135 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2136 center to the center of the image, and the angles going from -180 (top)
2137 to +180 (top). If <em>Rmax</em> is given the special value of
2138 '<code>0</code>', the the distance from the center to the nearest edge
2139 is used for the radius of the output image, which will ensure the whole
2140 image is visible (though scaled smaller). However a special value of
2141 '<code>-1</code>' will use the distance from the center to the furthest
2142 corner, This may 'clip' the corners from the input rectangular image,
2143 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2144 the same arguments. <br/>
2145
2146 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2147 output image center will default to <code>0,0</code> of the virtual
2148 canvas, and the image size adjusted to ensure the whole input image is
2149 made visible in the output image on the virtual canvas. </td>
2150
2151 </tr>
2152
2153 <tr valign="top">
2154 <td valign="top"><kbd>DePolar</kbd></td>
2155 <td valign="top">
2156 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2157 but generates the reverse Polar to Cartesian distortion. <br/>
2158
2159 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2160 the corners of the input image. However using the special
2161 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2162 distance) will ensure the whole distorted image is preserved in the
2163 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2164 reverse the distortion re-producing the original.
2165
2166 Note that as this distortion requires the area resampling of a circular
2167 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002168 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002169 form of 'super-sampling' image processing technique be used to produce
2170 a high quality result. </td>
2171
2172 </tr>
2173
2174 <tr valign="top">
2175 <td valign="top"><kbd>Barrel</kbd></td>
2176 <td valign="top">
2177 Given the four coefficients (A,B,C,D) as defined by <a
2178 href="http://www.all-in-one.ee/~dersch/barrel/barrel.html" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002179 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002180 correct radial lens distortions. That is in photographs, make straight
2181 lines straight again. <br/>
2182
2183 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2184 <em>X</em> , <em>Y</em> ] ] <br/>
2185 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2186 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2187 [ <em>X</em> , <em>Y</em> ] <br/>
2188 So that it forms the function <br/>
2189 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2190 <em>C</em>*r + <em>D</em> )<br/>
2191
2192 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2193 (defaulting to the center of the image). <br/>
2194 The second form is typically used to distort images, rather than
2195 correct lens distortions. <br/>
2196 </td>
2197
2198 </tr>
2199
2200 <tr valign="top">
2201 <td valign="top"><kbd>BarrelInverse</kbd></td>
2202 <td valign="top">
2203 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2204 arguments, and argument handling. However it uses the inverse
2205 of the radial polynomial,
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> +
cristyd0bd44a2010-09-24 12:38:11 +00002208 <em>C</em>*r + <em>D</em> )<br/>
2209 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2210 distortion, just a different barrel-like radial distortion method.
2211
cristy3ed852e2009-09-05 21:47:34 +00002212 </td>
2213 </tr>
2214
2215 <tr valign="top">
2216 <td valign="top"><kbd>Shepards</kbd></td>
2217 <td valign="top">
2218 Distort the given list control points (any number) using an Inverse
2219 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002220 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2221 Method</a>). The control points in effect do 'localized' displacement
2222 of the image around the given control point (preserving the look and
2223 the rotation of the area near the control points. For best results
2224 extra control points should be added to 'lock' the positions of the
2225 corners, edges and other unchanging parts of the image, to prevent
2226 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002227
cristyd0bd44a2010-09-24 12:38:11 +00002228 The distortion has been likened to 'taffy pulling' using nails, or
2229 pins' stuck in a block of 'jelly' which is then moved to the new
2230 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002231
cristyd0bd44a2010-09-24 12:38:11 +00002232 Internally it is equivelent to generating a displacement map (see <a
2233 href="#displace" >-displace</a>) for source image color look-up using
2234 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2235
2236 </td>
cristy3ed852e2009-09-05 21:47:34 +00002237 </tr>
2238
2239</table>
2240
cristyd0bd44a2010-09-24 12:38:11 +00002241<p>To print a complete list of distortion methods, use <a href="#list">-list
2242distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002243
2244<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2245'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2246defining how these points in the given image should be distorted in the
2247destination image. Each set of four floating point values represent a source
2248image coordinate, followed immediately by the destination image coordinate.
2249This produces a list of values such as...</p>
2250<div style="text-align: center"><em>
2251 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2252 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2253 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2254 ... &nbsp;
2255 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2256</em></div>
2257<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2258destination image. </p>
2259
2260<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2261needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2262perspective distortion of the built-in "rose:" image. Note how spaces were
2263used to group the 4 sets of coordinate pairs, to make it easier to read and
2264understand.</p>
2265
2266<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002267convert rose: -virtual-pixel black \<br/>
2268 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2269 rose_3d_rotated.gif</span></p>
2270<p>If more that the required number of coordinate pairs are given for
2271a distortion, the distortion method is 'least squares' fitted to produce the
2272best result for all the coordinate pairs given. If less than the ideal number
2273of points are given, the distort will generally fall back to a simpler form of
2274distortion that can handles the smaller number of coordinates (usally a linear
2275'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002276
cristyd0bda5e2010-09-21 16:22:45 +00002277<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002278find matching coordinate pairs in overlapping images, so as to improve the
2279'fit' of the distortion. Of course a bad coordinate pair can also make the
2280'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002281
2282<p>Colors are acquired from the source image according to the <a
2283href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002284magnified. However if the viewed image is minified (image becomes smaller),
2285a special area resampling function (added ImageMagick v6.3.5-9), is used to
2286produce a higher quality image. For example you can use
2287a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2288the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002289
cristyd0bd44a2010-09-24 12:38:11 +00002290<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2291convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2292 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2293 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002294<p>Note that a infinitely tiled perspective images involving the horizon can
2295be very slow to generate due to the use of the high quality 'area resampling'
2296function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2297using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2298(recommended if you plan to use super-sampling instead). </p>
2299
2300<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2301'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2302will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2303pixels. If you do not what these pixels to be visible, set the color to match
2304the rest of the ground. </p>
2305
2306<p>The output image size will by default be the same as the input image. This
2307means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002308the 'distorted space', those parts is clipped and lost. However if you use
2309the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2310will attempt (if possible) to show the whole of the distorted image, while
2311retaining a correct 'virtual canvas' offset, for image layering. This offset
2312may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2313is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002314
2315<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2316option:distort:viewport {geometry_string}</kbd>" setting which will specify
2317the size and the offset of the generated 'viewport' image of the distorted
2318image space.</p>
2319
2320<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2321{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2322that factor without changing the viewed contents of the distorted image. This
2323can be used either for 'super-sampling' the image for a higher quality result,
2324or for panning and zooming around the image (with appropriate viewport
2325changes, or post-distort cropping and resizing). </p>
2326
2327<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2328href="#distort" >-distort</a> to attempt to output the internal coefficients,
2329and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2330and debugging purposes. This many not be available for all distorts. </p>
2331
2332<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2333produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2334and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002335above settings. It is algorithmically slower however, though that may not be
2336the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002337
2338
2339<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002340 <h4><a id="dither"></a>-dither <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002341</div>
2342
2343<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>
2344
cristyd0bda5e2010-09-21 16:22:45 +00002345<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 +00002346
2347<p>Dithering is turned on by default, to turn it off use the plus form of the
2348setting, <a href="#dither">+dither</a>. This will also also render PostScript
2349without text or graphic aliasing. Disabling dithering often (but not always)
2350leads to faster process, a smaller number of colors, but more cartoon like
2351image coloring. Generally resulting in 'color banding' effects in areas with
2352color gradients. </p>
2353
2354<p>The color reduction operators <a href="#colors">-colors</a>, <a
2355href="#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>
2356
2357<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>
2358
2359
2360<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002361 <h4><a id="draw"></a>-draw <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002362</div>
2363
2364<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>
2365
2366<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>
2367
2368<p>The shape primitives:</p>
2369
2370<pre class="text">
2371 point x,y
2372 line x0,y0 x1,y1
2373 rectangle x0,y0 x1,y1
2374 roundRectangle x0,y0 x1,y1 wc,hc
2375 arc x0,y0 x1,y1 a0,a1
2376 ellipse x0,y0 rx,ry a0,a1
2377 circle x0,y0 x1,y1
2378 polyline x0,y0 ... xn,yn
2379 polygon x0,y0 ... xn,yn
2380 bezier x0,y0 ... xn,yn
2381 path path specification
2382 image operator x0,y0 w,h filename
2383</pre>
2384
2385<p>The text primitive:</p>
2386
2387<pre class="text">
2388 text x0,y0 string
2389</pre>
2390<p>The text gravity primitive:</p>
2391
2392<pre class="text">
2393 gravity NorthWest, North, NorthEast, West, Center,
2394 East, SouthWest, South, or SouthEast
2395</pre>
2396
2397<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>
2398
2399<p>The transformation primitives:</p>
2400
2401<pre class="text">
2402 rotate degrees
2403 translate dx,dy
2404 scale sx,sy
2405 skewX degrees
2406 skewY degrees
2407</pre>
2408
2409<p>The pixel operation primitives:</p>
2410
2411<pre class="text">
2412 color x0,y0 method
2413 matte x0,y0 method
2414</pre>
2415
2416<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>
2417
2418<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>
2419
2420<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2421
2422<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2423
2424<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>
2425
2426<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2427
2428<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>
2429
2430<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>
2431
2432<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>.
2433</p>
2434
2435<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2436
2437<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2438
2439<p class="crtsnip">
2440 -draw 'circle 100,100 150,150'
2441</p>
2442
2443<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
2444draw 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>
2445
2446<p class="crtsnip">
2447 -draw 'bezier 20,50 45,100 45,0 70,50'
2448</p>
2449<p class="crtsnip">
2450 -draw 'bezier 70,50 95,100 95,0 120,50'
2451</p>
2452
2453
2454<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>
2455
2456<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>
2457
2458<p class="crtsnip">
2459 -draw 'image SrcOver 100,100 225,225 image.jpg'
2460</p>
2461
cristybc9539a2010-08-16 18:06:20 +00002462<p>You can use 0,0 for the image size, which means to use the actual
2463dimensions found in the image header. Otherwise, it is scaled to the given
2464dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
2465a detailed discussion of alpha composition methods that are available. </p>
cristy3ed852e2009-09-05 21:47:34 +00002466
2467<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>
2468
2469<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2470
2471<p class="crtsnip">
2472 -draw 'text 100,100 "Works like magick!"'
2473</p>
2474
2475<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2476
2477<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>
2478
2479<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2480
2481<p>The <kbd>scale</kbd> primitive scales them.</p>
2482
2483<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>
2484
2485<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
2486matrix.</p>
2487
2488<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>
2489
2490<pre class="text">
2491 point
2492 replace
2493 floodfill
2494 filltoborder
2495 reset
2496</pre>
2497
2498<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>
2499
2500<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>
2501
2502<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>
2503
2504<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2505
2506<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2507
2508
2509<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002510 <h4><a id="edge"></a>-edge <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002511</div>
2512
2513<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>
2514
2515<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002516 <h4><a id="emboss"></a>-emboss <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002517</div>
2518
2519<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>
2520
2521<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002522 <h4><a id="encipher"></a>-encipher <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002523</div>
2524
2525<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>
2526
2527<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2528
2529<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2530
cristyd0bda5e2010-09-21 16:22:45 +00002531
2532
cristy3ed852e2009-09-05 21:47:34 +00002533<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002534 <h4><a id="encoding"></a>-encoding <em class="arg">type</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%'>specify the text encoding.</td><td style='text-align:right;'></td></tr></table>
2538
2539<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>
2540
2541<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002542 <h4><a id="endian"></a>-endian <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002543</div>
2544
2545<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>
2546
2547<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2548
2549<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2550
2551
2552<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002553 <h4><a id="enhance"></a>-enhance</h4>
cristy3ed852e2009-09-05 21:47:34 +00002554</div>
2555
2556<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>
2557
2558
2559<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002560 <h4><a id="equalize"></a>-equalize</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%'>perform histogram equalization on the image channel-by-channel.</td><td style='text-align:right;'></td></tr></table>
2564
2565<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>
2566
2567<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2568
2569<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>
2570
2571<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002572 <h4><a id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002573</div>
2574
2575<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>
2576
2577<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>
2578
2579<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>
2580
2581<table class="doc">
2582 <col width="25%" />
2583 <col width="75%" />
2584 <thead>
2585 <tr>
2586 <th><em class="arg">operator</em></th>
2587 <th>Summary (see further below for details)</th>
2588 </tr>
2589 </thead>
2590 <tbody>
2591
cristy3c98a4f2010-08-13 20:09:41 +00002592 <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 +00002593 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2594 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2595 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2596 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2597 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002598 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2599 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002600 <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>
2601 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2602 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002603 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002604 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002605 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2606 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2607 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2608 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2609 <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>
2610 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2611 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2612 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2613 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2614
2615 <tr><td>&nbsp;</td></tr>
2616
2617 <tr><td>Gaussian-noise</td></tr>
2618 <tr><td>Impulse-noise</td></tr>
2619 <tr><td>Laplacian-noise</td></tr>
2620 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2621 <tr><td>PoissonNoise</td></tr>
2622 <tr><td>Uniform-noise</td></tr>
2623
2624 <tr><td>&nbsp;</td></tr>
2625
2626 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2627 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2628 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2629 </tbody>
2630 </table>
2631
2632<p>The specified functions are applied only to each previously set <a
2633href="#channel" >-channel</a> in the image. If necessary, the results of the
2634calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2635class="QR">QuantumRange</em>]. The transparency channel of the image is
2636represented as a 'alpha' values (0 = fully transparent), so, for example, a
2637<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2638semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2639as a percentage of the <em class="QR">QuantumRange</em>.</p>
2640
2641<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2642<a href="#list">-list evaluate</a>.</p>
2643
2644<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2645<kbd>Multiply</kbd> methods can also be achieved using either the <a
2646href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2647appropriate argument, to linearly modify the overall range of color values.
2648Please note, however, that <a href="#level" >-level</a> treats transparency as
2649'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2650'alpha' values.</p>
2651
2652<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>
2653
cristyce66ab12010-10-21 23:36:32 +00002654<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>
2655
2656 <div style="text-align:center;">
2657 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2658 </div>
2659
2660<p> If the input image is squared, for example, using <a
2661href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2662
cristy3ed852e2009-09-05 21:47:34 +00002663<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>
2664
2665 <div style="text-align:center;">
2666 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2667 </div>
2668
2669<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2670normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2671href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2672to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2673with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2674with <kbd>Pow</kbd>.</p>
2675
2676<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2677converts the image values into a value according to a (co)sine wave function.
2678The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2679is biased 50% and normalized by 50% so as to fit in the respective color value
2680range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2681function (its frequency), and thus determines the number of 'waves' that will
2682be generated over the input color range. For example, if the <em
2683class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2684class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2685then the effective period is the <em>half</em> the <em
cristydcca3fa2010-12-29 21:50:07 +00002686class="QR">QuantumRange</em>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002687
2688 <div style="text-align:center;">
2689 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2690 </div>
2691
cristydcca3fa2010-12-29 21:50:07 +00002692<p>See also the <a href="#function" >-function</a> operator, which is a
2693multi-value version of evaluate. </p>
cristy3ed852e2009-09-05 21:47:34 +00002694
cristy63fed272010-03-07 19:08:45 +00002695<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002696 <h4><a id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
cristy63fed272010-03-07 19:08:45 +00002697</div>
2698
2699<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 +00002700
2701<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002702 <h4><a id="extent"></a>-extent <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002703</div>
2704
2705<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>
2706
cristy3e2860c2010-01-24 01:36:30 +00002707<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 +00002708<p>This command reduces or expands a JPEG image to fit on an 800x600
2709display. If the aspect ratio of the input image isn't exactly 4:3, then the
2710image is centered on an 800x600 black canvas: </p>
2711
2712<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>
2713
cristy3ed852e2009-09-05 21:47:34 +00002714
2715<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>
2716
2717<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002718 <h4><a id="extract"></a>-extract <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002719</div>
2720
2721<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>
2722
2723<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2724
cristy4949d522010-03-12 18:41:34 +00002725<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 +00002726
cristy4949d522010-03-12 18:41:34 +00002727<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 +00002728<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002729equivalent to:</p>
2730
2731<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>
2732<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>
2733
2734<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002735 <h4><a id="family"></a>-family <em class="arg">fontFamily</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002736</div>
2737
2738<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>
2739
2740<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).
2741</p>
2742
2743<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>.
2744</p>
2745
2746<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002747 <h4><a id="features"></a>-features <em class="arg">distance</em></h4>
cristy7396d882010-01-27 02:37:56 +00002748</div>
2749
2750<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>
2751
2752<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002753 <h4><a id="fft"></a>-fft</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%'>implements the forward discrete Fourier transform (DFT).</td><td style='text-align:right;'></td></tr></table>
2757
cristydcca3fa2010-12-29 21:50:07 +00002758<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 +00002759
cristydcca3fa2010-12-29 21:50:07 +00002760<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 +00002761
2762<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>
2763
2764<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2765<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>
2766
2767<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2768<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>
2769
cristyd0bd44a2010-09-24 12:38:11 +00002770<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 +00002771
2772<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>
2773
2774<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2775 -evaluate log 1000 fft_image_spectrum.png</span></p>
2776<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>
2777
cristydcca3fa2010-12-29 21:50:07 +00002778<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 +00002779
2780<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>
2781
2782<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>
2783
cristydcca3fa2010-12-29 21:50:07 +00002784<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 +00002785
2786<p>See the discussion on HDRI implementations of ImageMagick on the page
2787<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.
2788</p>
2789
2790
2791<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002792 <h4><a id="fill"></a>-fill <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002793</div>
2794
2795<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>
2796
2797<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>
2798
2799<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2800
2801<p>For example,</p>
2802
2803<p class="crtsnip">
2804 -fill blue
2805</p>
2806<p class="crtsnip">
2807 -fill "#ddddff"
2808</p>
2809<p class="crtsnip">
2810 -fill "rgb(255,255,255)"
2811</p>
2812
2813<p>See <a href="#draw">-draw</a> for further details.</p>
2814
2815<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2816
2817<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002818 <h4><a id="filter"></a>-filter <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002819</div>
2820
cristyd0bda5e2010-09-21 16:22:45 +00002821<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
2822distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002823
cristyd0bda5e2010-09-21 16:22:45 +00002824<p>Use this option to affect the resizing operation of an image during
2825operations such as <a href="#resize">-resize</a> and <a href="#distort"
2826>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002827
2828<pre class="text">
2829 Point Hermite Cubic
2830 Box Gaussian Catrom
2831 Triangle Quadratic Mitchell
2832</pre>
2833
cristyd0bda5e2010-09-21 16:22:45 +00002834<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002835as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2836generally useless on their own as they are infinite filters that are being
2837clipped to the filters support size. Their direct use is not recommended
2838except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002839
cristydcca3fa2010-12-29 21:50:07 +00002840<p>Instead these special filter functions are typically windowed by a windowing
cristyd0bda5e2010-09-21 16:22:45 +00002841function that the <a href="#filter" >-filter</a> setting defines. That is
2842using these functions will define a 'Windowed' filter, appropriate to the
2843operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002844
2845<pre class="text">
2846 Lanczos Hamming Parzen
2847 Blackman Kaiser Welsh
2848 Hanning Bartlett Bohman
2849</pre>
2850
2851<p>Also one special self-windowing filter is also provided
2852<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2853on the current 'support' or 'lobes' expert settings (see below).</p>
2854
cristyd0bda5e2010-09-21 16:22:45 +00002855<p>If you do not select a filter with this option, the filter defaults to
2856<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2857if the image is enlarged. Otherwise the filter default to
2858<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002859
cristyd0bda5e2010-09-21 16:22:45 +00002860<p>To print a complete list of resize filters, use the <a href="#list">-list
2861filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002862
2863<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002864use of these expert settings (see also <a href="#define" >-define</a> and <a
2865href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002866
2867<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002868<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002869<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002870 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2871 Gaussian-like filters simple filters, or you may not get the expected
2872 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002873
cristyd0bda5e2010-09-21 16:22:45 +00002874<dt>-define filter:support=<em>radius</em></dt>
2875<dd>Set the filter support radius. Defines how large the filter should be and
2876 thus directly defines how slow the filtered resampling process is. All
2877 filters have a default 'prefered' support size. Some filters like
2878 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2879 this value. With simple filters this value either does nothing (but slow
2880 the resampling), or will clip the filter function in a detrimental way.
2881 </dd>
cristy3ed852e2009-09-05 21:47:34 +00002882
cristyd0bda5e2010-09-21 16:22:45 +00002883<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002884<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00002885 alternative way of specifying the 'support' range of the filter, that is
2886 designed to be more suited to windowed filters, especially when used for
2887 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002888
cristyd0bda5e2010-09-21 16:22:45 +00002889<dt>-define filter:b=<em>b-spline_factor</em></dt>
2890<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002891<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2892 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2893 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2894 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00002895 filter. Values meaning was defined by a research paper by
cristydcca3fa2010-12-29 21:50:07 +00002896 Mitchell-Netravali.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002897
cristyd0bda5e2010-09-21 16:22:45 +00002898<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002899<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00002900 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00002901 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00002902 'Bessel' functions. If defined, no windowing function is used, unless the
2903 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002904
cristyd0bda5e2010-09-21 16:22:45 +00002905<dt>-define filter:window=<em>filter_function</em></dt>
2906<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
2907 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
2908 support range) with the given filter. This allows you to specify a filter
2909 function that is not normally used as a windowing function, such as
2910 <kbd>Box</kbd>, (which effectively turns off the windowing function),
2911 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
2912 </dd>
2913
2914<dt>-define filter:verbose=<em>1</em></dt>
2915<dd>This causes IM to print information on the final internal filter
2916 selection to standard output. This includes a commented header on the
2917 filter settings being used, and data allowing the filter weights to be
2918 easily graphed. </dd>
2919
2920<dd>Note however that some filters are internally defined in terms of other
2921 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
2922 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
2923 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
2924 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002925
2926</dl>
2927
cristyd0bda5e2010-09-21 16:22:45 +00002928<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00002929
2930<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
2931 -set filter:window=bessel -set filter:lobes=8 \ <br/>
2932 -resize 150% image.jpg</span></p>
2933<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
2934
2935<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
2936 -resize 150% image.jpg</span></p>
2937<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00002938filters, and 'verbose' for viewing the internal filter selection), are
2939provided for image processing experts who have studied and understood how
2940resize filters work. Without this knowledge, and an understanding of the
2941definition of the actual filters involved, using expert settings are more
2942likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00002943
2944
2945<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002946 <h4><a id="flatten"></a>-flatten</h4>
cristy3ed852e2009-09-05 21:47:34 +00002947</div>
2948
2949<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>
2950
2951
2952<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002953 <h4><a id="flip"></a>-flip</h4>
cristy3ed852e2009-09-05 21:47:34 +00002954</div>
2955
2956<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>
2957
2958<p>reflect the scanlines in the vertical direction.</p>
2959
2960<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002961 <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 +00002962</div>
2963
2964<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>
2965
2966<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002967 <h4><a id="flop"></a>-flop</h4>
cristy3ed852e2009-09-05 21:47:34 +00002968</div>
2969
2970<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>
2971
2972<p>reflect the scanlines in the horizontal direction.</p>
2973
2974
2975<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002976 <h4><a id="font"></a>-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002977</div>
2978
2979<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>
2980
2981<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>
2982
2983<p>In addition to the fonts specified by the above pre-defined list, you can
2984also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
2985is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
2986<kbd>x:fixed</kbd> is X11 font.</p>
2987
2988<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>
2989
2990
2991<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00002992 <h4><a id="foreground"></a>-foreground <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00002993</div>
2994
2995<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>
2996
2997<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
2998
2999<p>The default foreground color is black.</p>
3000
3001<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003002 <h4><a id="format"></a>-format <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003003</div>
3004
3005<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>
3006
3007<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>
3008
3009<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>
3010
3011<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003012 <h4><a id="format_identify_"></a>-format <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003013</div>
3014
3015<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>
3016
3017<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>
3018
3019<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003020 <h4><a id="frame"></a>-frame <em class="arg">geometry</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%'>Surround the image with a border or beveled frame.</td><td style='text-align:right;'></td></tr></table>
3024
cristybc9539a2010-08-16 18:06:20 +00003025<p>The color of the border is specified with the <a href="#mattecolor"
3026>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00003027
cristybc9539a2010-08-16 18:06:20 +00003028<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
3029class="arg">geometry</em> argument indicates the amount of extra width and
3030height that is added to the dimensions of the image. If no offsets are given
3031in the <em class="arg">geometry</em> argument, then the border added is
3032a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
3033the width and height of the border is partitioned to form an outer bevel of
3034thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
3035<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
3036</p>
3037
3038<p>The <a href="#frame">-frame</a> option is affected by the current <a
3039href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00003040'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00003041size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
3042draws the frame of four distinct colors close to the current <a
3043href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
3044center of this image. This means that with the default compose method of
3045'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
3046href="#bordercolor">-bordercolor</a> setting.</p>
3047
3048<p>The image composition is not
3049affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00003050
3051
3052<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003053 <h4><a id="frame_import_"></a>-frame</h4>
cristy3ed852e2009-09-05 21:47:34 +00003054</div>
3055
3056<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>
3057
3058<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003059 <h4><a id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003060</div>
3061
3062<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>
3063
3064<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>
3065
3066<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>
3067
3068<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>
3069
3070<pre class="text">
3071 Polynomial
3072 Sinusoid
3073 Arcsin
3074 Arctan
3075</pre>
3076
3077<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3078
3079<dl class="doc">
3080<dt><kbd>Polynomial</kbd></dt>
3081<dd>
3082<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>
3083
3084<div style="text-align: center">
3085 -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>
3086</div>
3087
3088<p>will invoke a polynomial function given by</p>
3089
3090<div style="text-align: center">
3091 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3092 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3093 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3094</div>
3095
3096<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3097
3098<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>
3099
3100<table class="doc">
3101 <col width="35%" />
3102 <col width="35%" />
3103 <col width="30%" />
3104 <tr>
3105 <td>-evaluate Set <em class="arg">value</em> </td>
3106 <td>-function Polynomial <em class="arg">value</em></td>
3107 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3108 </tr>
3109 <tr>
3110 <td>-evaluate Add <em class="arg">value</em> </td>
3111 <td>-function Polynomial 1,<em class="arg">value</em></td>
3112 </tr>
3113 <tr>
3114 <td>-evaluate Subtract <em class="arg">value</em> </td>
3115 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3116 </tr>
3117 <tr>
3118 <td>-evaluate Multiply <em class="arg">value</em> </td>
3119 <td>-function Polynomial <em class="arg">value</em>,0</td>
3120 </tr>
3121 <tr>
3122 <td>+level black% x white%</td>
3123 <td>-function Polynomial A,B</td>
3124 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3125 </tr>
3126</table>
3127
3128<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>
3129</dd>
3130
3131<dt><kbd>Sinusoid</kbd></dt>
3132<dd>
3133<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>
3134
3135<div style="text-align: center">
3136 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3137</div>
3138
3139<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>
3140
3141<div style="text-align: center">
3142<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>
3143</div>
3144
3145<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>
3146
3147<p class="crtsnip">
3148 -function Sinusoid 3,-90,.2,.7
3149</p>
3150
3151<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>
3152
3153<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>
3154
3155<table class="doc">
3156 <tr>
3157 <td>-evaluate Sin <em class="arg">freq</em> </td>
3158 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3159 </tr>
3160 <tr>
3161 <td>-evaluate Cos <em class="arg">freq</em> </td>
3162 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3163 </tr>
3164</table>
3165</dd>
3166
3167<dt><kbd>ArcSin</kbd></dt>
3168<dd>
3169<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3170and can be used to generate cylindrical distortion and displacement maps.
3171The curve can be adjusted relative to both the input values and output range
cristydcca3fa2010-12-29 21:50:07 +00003172of values.</p>
cristy3ed852e2009-09-05 21:47:34 +00003173
cristydcca3fa2010-12-29 21:50:07 +00003174<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003175 -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 +00003176</p>
cristy3ed852e2009-09-05 21:47:34 +00003177
3178<p>with all values given in terms of noramlize color values (0.0 for black,
31791.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3180for bout input (<em class="arg">width</em>), and output (<em
3181class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3182
cristydcca3fa2010-12-29 21:50:07 +00003183<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003184<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 +00003185</p>
cristy3ed852e2009-09-05 21:47:34 +00003186
3187</dd>
3188
3189<dt><kbd>ArcTan</kbd></dt>
3190<dd>
3191<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3192limit values at infinities, though a center using the given slope value.
cristydcca3fa2010-12-29 21:50:07 +00003193All these values can be adjusted via the arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +00003194
cristydcca3fa2010-12-29 21:50:07 +00003195<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003196 -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 +00003197</p>
cristy3ed852e2009-09-05 21:47:34 +00003198
3199<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3200</p>
3201
cristydcca3fa2010-12-29 21:50:07 +00003202<p style="text-align: center">
cristy3ed852e2009-09-05 21:47:34 +00003203<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 +00003204</p>
cristy3ed852e2009-09-05 21:47:34 +00003205
3206</dd>
3207
3208</dl>
3209
3210
3211<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003212 <h4><a id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00003213</div>
3214
3215<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>
3216
3217<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>
3218
3219<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>
3220
3221
3222<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003223 <h4><a id="fx"></a>-fx <em class="arg">expression</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003224</div>
3225
3226<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>
3227
3228<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>
3229
3230<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3231
3232
3233<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003234 <h4><a id="gamma"></a>-gamma <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003235</div>
3236
3237<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>
3238
3239<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>
3240
3241<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>
3242
3243<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>
3244
3245<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>
3246
3247<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3248
3249<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003250 <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 +00003251</div>
3252
3253<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>
3254
cristyb15553d2010-07-03 22:53:14 +00003255<p>Convolve the image with a Gaussian or normal distribution using the given
3256<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003257
3258<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3259</div>
3260
cristyb15553d2010-07-03 22:53:14 +00003261<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003262determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003263
3264<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003265array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003266integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003267radius that will provide meaningful results for the Gaussian distribution.
3268</p>
3269
3270<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3271operation is. However too small a <em class="arg" >Radius</em>, and sever
3272aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3273should be at least twice the <em class="arg" >Sigma</em> value, though three
3274times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003275
3276<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003277full 2-dimensional convolution is used to generate the weighted average of the
3278neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003279
3280<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3281pixels which are outside the image proper are blurred into the final result.
3282</p>
3283
3284
3285<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003286 <h4><a id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003287</div>
3288
3289<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>
3290
3291<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>
3292
3293<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003294 <h4><a id="gravity"></a>-gravity <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003295</div>
3296
3297<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>
3298
3299<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3300<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3301<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3302list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3303installation.</p>
3304
3305<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>
3306
3307<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>
3308
3309<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>
3310
cristy4949d522010-03-12 18:41:34 +00003311<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 +00003312<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>
3313
3314<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>
3315
3316
3317<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003318 <h4><a id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003319</div>
3320
3321<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>
3322
3323
3324<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003325 <h4><a id="hald-clut"></a>-hald-clut</h4>
cristy3ed852e2009-09-05 21:47:34 +00003326</div>
3327
3328<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>
3329
3330<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3331dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3332can apply any color transformation to the Hald image and then use this option
3333to apply the transform to the image. </p>
3334
3335<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3336<p>This option provides a convenient method for you to use Gimp or Photoshop
3337to make color corrections to the Hald CLUT image and subsequently apply them
3338to multiple images using an ImageMagick script. </p>
3339
3340<p>Note that the representation is only of the normal RGB color space and that
3341the whole color value triplet is used for the interpolated lookup of the
3342represented Hald color cube image. Because of this the operation is not <a
3343href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3344images transparency or alpha/matte channel.</p>
3345
3346<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3347of the individual color channels, usally involving a simplier gray-scale
3348image. E.g: gray-scale to color replacement, or modification by a histogram
3349mapping. </p>
3350
3351
3352<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003353 <h4><a id="help"></a>-help</h4>
cristy3ed852e2009-09-05 21:47:34 +00003354</div>
3355
3356<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>
3357
3358<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003359 <h4><a id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003360</div>
3361
3362<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>
3363
3364<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003365 <h4><a id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003366</div>
3367
3368<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>
3369
3370<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>
3371
3372<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>
3373
3374<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003375 <h4><a id="iconic"></a>-iconic</h4>
cristy3ed852e2009-09-05 21:47:34 +00003376</div>
3377
3378<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>
3379
3380<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003381 <h4><a id="identify"></a>-identify</h4>
cristy3ed852e2009-09-05 21:47:34 +00003382</div>
3383
3384<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>
3385
3386<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>
3387
3388<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>
3389
cristyd0bda5e2010-09-21 16:22:45 +00003390<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003391amounts of image properties are displayed including image statistics, profiles,
3392image histogram, and others.</p>
3393
3394<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003395 <h4><a id="ift"></a>-ift</h4>
cristy3ed852e2009-09-05 21:47:34 +00003396</div>
3397
3398<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>
3399
cristydcca3fa2010-12-29 21:50:07 +00003400<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 +00003401
3402<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>
3403
3404<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3405<p>or</p>
3406
3407<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>
3408
cristydcca3fa2010-12-29 21:50:07 +00003409<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 +00003410
cristydcca3fa2010-12-29 21:50:07 +00003411<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 +00003412
cristydcca3fa2010-12-29 21:50:07 +00003413<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 +00003414
3415<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003416 <h4><a id="immutable"></a>-immutable</h4>
cristy3ed852e2009-09-05 21:47:34 +00003417</div>
3418
3419<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>
3420
3421<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003422 <h4><a id="implode"></a>-implode <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003423</div>
3424
3425<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>
3426
3427<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003428 <h4><a id="insert"></a>-insert <em class="arg">index</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003429</div>
3430
3431<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>
3432
3433<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>
3434
3435<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>
3436
3437<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003438 <h4><a id="intent"></a>-intent <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003439</div>
3440
3441<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>
3442
3443<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>
3444
3445<p>The default intent is undefined.</p>
3446
3447<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3448
3449<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003450 <h4><a id="interlace"></a>-interlace <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003451</div>
3452
3453<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>
3454
3455<p>Choose from:</p>
3456
3457<pre class="text">
3458 none
3459 line
3460 plane
3461 partition
3462 JPEG
3463 GIF
3464 PNG
3465</pre>
3466
3467<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>
3468
3469<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3470
3471<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3472
3473<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3474
3475<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3476image.G, and image.B).</p>
3477
3478<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>
3479image.</p>
3480
3481<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3482
3483<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003484 <h4><a id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003485</div>
3486
3487<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>
3488
cristyd0bda5e2010-09-21 16:22:45 +00003489<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003490value, you typically fall in between the pixel colors defined by the source
3491image. This setting determines how the color is determined from the colors of
3492the pixels surrounding that point. That is how to determine the color of a
3493point that falls between two, or even four different colored pixels. </p>
3494
3495<pre class="text">
3496 integer: The color of the top-left pixel (floor function)
3497 nearest-neighbor: The nearest pixel to the lookup point (rounded function)
3498 average: The average color of the surrounding four pixels
3499 bilinear A double linear interpolation of pixels (the default)
3500 mesh Divide area into two flat triangular interpolations
3501 bicubic Fitted bicubic-spines of surrounding 16 pixels
3502 spline Direct spline curves (colors are blurred)
3503 filter Use resize <a href="#filter">-filter</a> settings
3504</pre>
3505
3506<p>This most important for distortion operators such as <a href="#distort"
3507>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3508>-transform</a> and <a href="#fx" >-fx</a>. </p>
3509
3510<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3511
3512<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3513lookup for positions outside the boundaries of the image. </p>
3514
3515
3516<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003517 <h4><a id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
cristyf3bb4782009-09-08 13:10:04 +00003518</div>
3519
3520<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>
3521
3522<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003523 <h4><a id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003524</div>
3525
3526<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>
3527
3528<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003529 <h4><a id="kerning"></a>-kerning <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003530</div>
3531
3532<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>
3533
3534<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003535 <h4><a id="label"></a>-label <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003536</div>
3537
3538<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>
3539
cristy71a3f602010-09-15 12:38:16 +00003540<p>Use this option to assign a specific label to the image, as it is read in
3541or created. You can use the <a href="#set" >-set</a> operation to re-assign
3542a the labels of images already read in. Image formats such as TIFF, PNG,
3543MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003544
cristy71a3f602010-09-15 12:38:16 +00003545<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3546assigned to an image is used as a header string to print above the postscript
3547image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003548
cristybc9539a2010-08-16 18:06:20 +00003549<p>You can include the image filename, type, width, height, or other image
3550attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3551Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003552
3553<p>For example,</p>
3554
3555<p class="crtsnip">
3556 -label "%m:%f %wx%h" bird.miff
3557</p>
3558
cristy71a3f602010-09-15 12:38:16 +00003559<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3560"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3561is read in. If a <a href="#label">+label</a> option was used instead, any
3562existing label present in the image would be used. You can remove all labels
3563from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003564
cristy71a3f602010-09-15 12:38:16 +00003565<p>A label is not drawn on the image, but is embedded in the image datastream
3566via <em>Label</em> tag or similar mechanism. If you want the label to be
3567visible on the image itself, use the <a href="#draw">-draw</a> option, or
3568during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003569
cristy71a3f602010-09-15 12:38:16 +00003570<p>If the first character of <em class="arg">string</em> is <em
3571class="arg">@</em>, the image label is read from a file titled by the
3572remaining characters in the string. Labels in a file are literal, no embedded
3573formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003574
3575
3576<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003577 <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 +00003578</div>
3579
3580<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>
3581
3582<p>Adaptively threshold each pixel based on the value of pixels in a
3583surrounding window. If the current pixel is lighter than this average plus
3584the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3585black. Small variations in pixel values such as found in scanned documents
3586can be ignored if offset is positive. A negative offset will make it more
3587sensitive to those small variations. </p>
3588
3589<p>This is commonly used to threshold images with an uneven background. It is
3590based on the assumption that average color of the small window is the
3591the local background color, from which to separate the forground color. </p>
3592
3593
3594<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003595 <h4><a id="layers"></a>-layers <em class="arg">method</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%'>handle multiple images forming a set of image layers or animation frames.</td><td style='text-align:right;'></td></tr></table>
3599
3600<p>Perform various image operation methods to a ordered sequence of images
3601which may represent either a set of overlaid 'image layers', a GIF disposal
3602animation, or a fully-'coalesced' animation sequence. </p>
3603
3604<table class="doc">
3605 <tbody>
3606 <tr valign="top">
3607 <th align="left" style="width: 8%">Method</th>
3608 <th align="left">Description</th>
3609 </tr>
3610
3611 <tr valign="top">
3612 <td valign="top">compare-any</td>
3613 <td valign="top">Crop the second and later frames to the smallest rectangle
3614 that contains all the differences between the two images. No GIF <a
3615 href="#dispose" >-dispose</a> methods are taken into account. </td>
3616 </tr>
3617
3618 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3619 >-deconstruct</a> operator, and does not preserve animations normal
3620 working, especially when animation used layer disposal methods such as
3621 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3622 </tr>
3623
3624 <tr valign="top">
3625 <td valign="top">compare-clear</td>
3626 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3627 opaque pixels which become transparent in the second frame. That is the
3628 smallest image needed to mask or erase pixels for the next frame. </td>
3629 </tr>
3630
3631 <tr valign="top">
3632 <td valign="top">compare-overlay</td>
3633 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3634 extra color to the next image, as a result of overlaying color pixels.
3635 That is the smallest single overlaid image to add or change colors. </td>
3636 </tr>
3637
3638 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3639 composition method '<kbd>change-mask</kbd>', to reduce the image to
3640 just the pixels that need to be overlaid. </td>
3641 </tr>
3642
3643 <tr valign="top">
3644 <td valign="top">coalesce</td>
3645 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3646 >-coalesce</a> operator. Apply the layer disposal methods set in the
3647 current image sequence to form a fully defined animation sequence, as
3648 it should be displayed. Effectively converting a GIF animation into a
3649 'film strip'-like animation. </td>
3650 </tr>
3651
3652 <tr valign="top">
3653 <td valign="top">composite</td>
3654 <td valign="top">Alpha Composition of two image lists, separated by a
3655 "<kbd>null:</kbd>" image, with the destination image list first, and
3656 the source images last. An image from each list are composited
3657 together until one list is finished. The separator image and source
3658 image lists are removed. </td>
3659 </tr>
3660
3661
cristybac7a162010-06-15 19:57:29 +00003662 <tr><td></td>
3663 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3664 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3665 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003666 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003667 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003668
cristybac7a162010-06-15 19:57:29 +00003669 <tr><td></td>
3670 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003671 applied to all the images in the other image list, regardless of which
3672 list it is. In this case it is the image meta-data of the list which
3673 preserved. </td>
3674 </tr>
3675
3676
3677 <tr valign="top">
3678 <td valign="top">dispose</td>
3679 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3680 the animation after the layer disposal method has been applied, before
3681 the next sub-frame image is overlaid. That is the 'dispose' image that
3682 results from the application of the GIF <a href="#dispose"
3683 >-dispose</a> method. This allows you to check what
3684 is going wrong with a particular animation you may be developing.
3685 </td>
3686 </tr>
3687
3688 <tr valign="top">
3689 <td valign="top">flatten</td>
3690 <td valign="top">Create a canvas the size of the first images virtual
3691 canvas using the current <a href="#background" >-background</a> color,
3692 and <a href="#compose" >-compose</a> each image in turn onto that
3693 canvas. Images falling outside that canvas is clipped. Final
3694 image will have a zero virtual canvas offset. </td>
3695 </tr>
3696
cristybac7a162010-06-15 19:57:29 +00003697 <tr><td></td>
3698 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003699 overlaying all the prepared image layers into a final image. </td>
3700 </tr>
3701
cristybac7a162010-06-15 19:57:29 +00003702 <tr><td></td>
3703 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003704 canvas with real pixels, or to underlay a opaque color to remove
3705 transparency from an image.</td>
3706 </tr>
3707
3708
3709 <tr valign="top">
3710 <td valign="top">merge</td>
3711 <td valign="top">As 'flatten' method but merging all the given image
3712 layers into a new layer image just large enough to hold all the image
3713 without clipping or extra space. The new images virtual offset will
3714 prevere the position of the new layer, even if this offset is
3715 negative. the virtual canvas size of the first image is preserved.
3716 </td>
3717 </tr>
3718
3719 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3720 as few image file formats handle them correctly. </td>
3721 </tr>
3722
3723 <tr valign="top">
3724 <td valign="top">mosaic</td>
3725 <td valign="top">As 'flatten' method but expanding the initial canvas size
3726 of the first image so as to hold all the image layers. However as a
cristyd0bda5e2010-09-21 16:22:45 +00003727 virtual canvas is 'locked' to the origin, by definition, image layers
cristy3ed852e2009-09-05 21:47:34 +00003728 with a negative offsets will still be clipped by the top and left
3729 edges.</td>
3730 </tr>
3731
3732 <tr><td></td><td>This method is commonly used to layout individual image using various
cristyd0bda5e2010-09-21 16:22:45 +00003733 offset but without knowing the final canvas size. The resulting image
cristy3ed852e2009-09-05 21:47:34 +00003734 will, like 'flatten' not have any virtual offset, so can be saved to
3735 any image file format. </td>
3736 </tr>
3737
3738
3739 <tr valign="top">
3740 <td valign="top">optimize</td>
3741 <td valign="top">Optimize a coalesced animation, into GIF animation using
3742 a number of general techniques. This currently a short cut to
3743 apply both the '<kbd>optimize-frame</kbd>', and
3744 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3745 include other optimization methods as they are developed. </td>
3746 </tr>
3747
3748 <tr valign="top">
3749 <td valign="top">optimize-frame</td>
3750 <td valign="top">Optimize a coalesced animation, into GIF animation by
3751 reducing the number of pixels per frame as much as possible by
3752 attempting to pick the best layer disposal method to use, while ensuring
3753 the result will continue to animate properly. </td>
3754 </tr>
3755
3756 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3757 then no reasonably fast GIF optimization algorithm can do this.
3758 However this does seem to do better than most other GIF frame
3759 optimizers seen. </td>
3760 </tr>
3761
3762 <tr valign="top">
3763 <td valign="top">optimize-plus</td>
3764 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3765 overall optimization by adding extra frames to the animation, without
3766 changing the final look or timing of the animation. The frames are
3767 added to attempt to separate the clearing of pixels from the
3768 overlaying of new additional pixels from one animation frame to the
3769 next. If this does not improve the optimization (for the next frame
3770 only), it will fall back to the results of the previous normal
3771 '<kbd>optimize-frame</kbd>' technique. </td>
3772 </tr>
3773
3774 <tr><td></td><td>There is the possibility that the change in the disposal style will
3775 result in a worsening in the optimization of later frames, though this
3776 is unlikely. In other words there no guarantee that it is better than
3777 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
cristyd0bda5e2010-09-21 16:22:45 +00003778 however you can get a vast improvement in the final animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003779 </tr>
3780
3781 <tr valign="top">
3782 <td valign="top">optimize-transparency</td>
3783 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3784 overlay images with transparency, if it does not change the resulting
3785 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3786 </td>
3787 </tr>
3788
3789 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3790 into a smaller file size due to larger areas of one (transparent)
3791 color rather than a pattern of multiple colors repeating the current
3792 disposed image of the last frame. </td>
3793 </tr>
3794
3795 <tr valign="top">
3796 <td valign="top">remove-dups</td>
3797 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3798 images, so as to simplify layer overlays of coalesced animations.
3799 </td>
3800 </tr>
3801
3802 <tr><td></td><td>Usually this a result of using a constant time delay across the
3803 whole animation, or after a larger animation was split into smaller
3804 sub-animations. The duplicate frames could also have been used as
3805 part of some frame optimization methods. </td>
3806 </tr>
3807
3808 <tr valign="top">
3809 <td valign="top">remove-zero</td>
3810 <td valign="top">Remove any image with a zero time delay, unless ALL the
3811 images have a zero time delay (and is not a proper timed animation, a
3812 warning is then issued). </td>
3813 </tr>
3814
3815 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3816 partial intermediary updates between the frames that are actually
3817 displayed to users. These frames are usally added for improved frame
3818 optimization in GIF animations. </td>
3819 </tr>
3820
3821 <tr valign="top">
3822 <td valign="top">trim-bounds</td>
3823 <td valign="top">Find the bounds of all the images in the current
3824 image sequence, then adjust the offsets so all images are contained on
3825 a minimal positive canvas. None of the image data is modified, only
3826 there virtual canvas size and offset. The all the image is given
3827 the same canvas size, and and will have a positive offset, but will
3828 remain in the same position relative to each other. As a result of the
3829 minimal canvas size at least one image will touch every edge of that
3830 canvas. The image data however may be transparent.
3831 </td>
3832 </tr>
3833
3834 </tbody>
3835</table>
3836
3837<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3838
3839<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3840>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3841>-mosaic</a> are only aliases for the above methods. Also see <a
3842href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3843href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3844>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3845
3846
3847<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003848 <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 +00003849</div>
3850
3851<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>
3852
3853<p>Given one, two or three values delimited with commas: black-point,
3854white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3855white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3856point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3857contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3858both black and white points are percentages of the full color range. Gamma
3859will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3860omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3861
3862<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3863the given '<kbd>black_point</kbd>' value in the original image is set to
3864zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3865<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3866to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3867adjusted. </p>
3868
3869<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3870adding the special '!' flag anywhere in the argument list, will cause the
3871operator to do the reverse of the level adjustment. That is a zero, or
3872<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
3873adjusted to the given level values, allowing you to de-contrast, or compress
3874the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
3875
3876<p>Only the channels defined by the current <a href="#channel">-channel</a>
3877setting are adjusted (defaults to RGB color channels only), allowing you to
3878limit the effect of this operator. </p>
3879
3880<p>Please note that the transparency channel is treated as 'matte'
3881values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
3882
3883
3884<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003885 <h4><a id="level-colors"></a>-level-colors {<em
cristy3ed852e2009-09-05 21:47:34 +00003886 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
3887</div>
3888
cristyd0bda5e2010-09-21 16:22:45 +00003889<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 +00003890
3891<p>This function is exactly like <a href="#level">-level</a>, except that the
3892value value for each color channel is determined by the
3893'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
3894described under the <a href="#fill">-fill</a> option). </p>
3895
cristyd0bda5e2010-09-21 16:22:45 +00003896<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
3897is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00003898colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00003899adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00003900
3901<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
3902will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00003903respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00003904those colors. This can also be used to convert a plain gray-scale image into a
3905one using the gradient of colors specified. </p>
3906
3907<p>By supplying a single color with a comma separator either before or after
3908that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00003909respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00003910used for both the black and white color points, making the operator either
3911threshold the images around that color (- form) or set all colors to that
3912color (+ form). </p>
3913
3914
3915<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003916 <h4><a id="limit"></a>-limit <em class="arg">type value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003917</div>
3918
3919<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>
3920
3921<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>
3922
cristy6b636652009-12-05 17:16:11 +00003923<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 +00003924
3925<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00003926 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00003927</p>
3928
3929<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
3930
cristydcca3fa2010-12-29 21:50:07 +00003931<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list resource</span><span class='crtout'></span></p><pre class="text">
3932File Area Memory Map Disk Thread Time
cristy6b636652009-12-05 17:16:11 +00003933------------------------------------------------------------------------------
cristydcca3fa2010-12-29 21:50:07 +00003934 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited
3935</pre>
3936
cristy3ed852e2009-09-05 21:47:34 +00003937<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>
3938
3939<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>
3940
3941<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>
3942
3943<p class="crtsnip">
3944-limit area 10mb
3945</p>
3946
cristyd0bda5e2010-09-21 16:22:45 +00003947<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 +00003948
3949<p class="crtsnip">
3950-limit area 10mb -limit disk 500mb
3951</p>
3952
3953<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
3954
3955<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>
3956
3957<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.
3958</p>
3959
3960<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.
3961</p>
3962
3963<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003964 <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 +00003965</div>
3966
3967<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>
3968
cristyd934d102009-10-10 12:55:13 +00003969<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
3970and uses a 'histogram bin' to determine the range of color values that needs to
3971be stretched. However it then stretchs those colors using the <a
3972href="#level" >-level</a> operator.</p>
3973
3974<p>As such while the initial determination may have 'binning' round off
3975effects, the image colors are stretched mathematically, rather than using the
3976histogram bins. This makes the operator more accurate. </p>
3977
3978<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
3979'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
3980perfect stretch of the color range. </p>
3981
3982<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
3983normalization of mathematical images. </p>
3984
3985<p>This operator is under review for re-development. </p>
3986
3987
cristy3ed852e2009-09-05 21:47:34 +00003988<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003989 <h4><a id="linewidth"></a>-linewidth</h4>
cristy3ed852e2009-09-05 21:47:34 +00003990</div>
3991
3992<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>
3993
3994<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00003995 <h4><a id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00003996</div>
3997
3998<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>
3999
4000<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>
4001
4002<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004003 <h4><a id="list"></a>-list <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004004</div>
4005
4006<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>
4007
4008<pre class="text">
cristyc1aee832010-05-08 00:36:47 +00004009 Align
4010 Alpha
4011 Boolean
4012 Channel
4013 Class
4014 ClipPath
4015 Coder
4016 Color
4017 Colorspace
4018 Command
4019 Compose
4020 Compress
4021 Configure
4022 DataType
4023 Debug
4024 Decoration
4025 Delegate
4026 Direction
4027 Dispose
4028 Distort
4029 Dither
4030 Endian
4031 Evaluate
4032 FillRule
4033 Filter
4034 Font
4035 Format
4036 Function
4037 Gravity
4038 ImageList
4039 Intent
4040 Interlace
4041 Interpolate
4042 Kernel
cristy787d4352010-03-06 13:55:58 +00004043 Layers
4044 LineCap
4045 LineJoin
4046 List
4047 Locale
4048 LogEvent
4049 Log
4050 Magic
4051 Method
4052 Metric
4053 Mime
4054 Mode
4055 Morphology
4056 Module
4057 Noise
4058 Orientation
4059 Policy
4060 PolicyDomain
4061 PolicyRights
4062 Preview
4063 Primitive
4064 QuantumFormat
4065 Resource
4066 SparseColor
4067 Storage
4068 Stretch
4069 Style
4070 Threshold
4071 Type
4072 Units
4073 Validate
4074 VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004075</pre>
4076
cristybac7a162010-06-15 19:57:29 +00004077<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4078list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4079available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004080
4081<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4082<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004083 <h4><a id="log"></a>-log <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004084</div>
4085
4086<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>
4087
cristybac7a162010-06-15 19:57:29 +00004088<p>This option specifies the format for the log printed when the <a
4089href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004090
cristybac7a162010-06-15 19:57:29 +00004091<p>You can display the following components by embedding special format
4092characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004093
4094<pre class="text">
4095 %d domain
4096 %e event
4097 %f function
4098 %l line
4099 %m module
4100 %p process ID
4101 %r real CPU time
4102 %t wall clock time
4103 %u user CPU time
4104 %% percent sign
4105 \n newline
4106 \r carriage return
4107</pre>
4108
4109<p>For example:</p>
4110
4111<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>
4112<p>The default behavior is to print all of the components.</p>
4113
4114<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004115 <h4><a id="loop"></a>-loop <em class="arg">iterations</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004116</div>
4117
4118<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>
4119
cristybac7a162010-06-15 19:57:29 +00004120<p>Set iterations to zero to repeat the animation an infinite number of times,
4121otherwise the animation repeats itself up to <em class="arg">iterations</em>
4122times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004123
4124<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004125 <h4><a id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004126</div>
4127
4128<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>
4129
4130<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004131 <h4><a id="magnify"></a>-magnify <em class="arg">factor</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004132</div>
4133
4134<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>
4135
4136
4137<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004138 <h4><a id="map"></a>-map <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004139</div>
4140
4141<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>
4142
4143<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4144
4145<pre class="text">
4146 best
4147 default
4148 gray
4149 red
4150 green
4151 blue
4152</pre>
4153
cristybac7a162010-06-15 19:57:29 +00004154<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4155Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4156the type and <kbd>display</kbd> searches the list of colormap types in
4157<kbd>top-to-bottom</kbd> order until one is located. See <em
4158class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004159
4160
4161<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004162 <h4><a id="map_stream_"></a>-map <em class="arg">components</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004163</div>
4164
4165<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>
4166
4167<p>Here are the valid components of a map:</p>
4168
4169<pre class="text">
4170 r red pixel component
4171 g green pixel component
4172 b blue pixel component
4173 a alpha pixel component (0 is transparent)
4174 o opacity pixel component (0 is opaque)
4175 i grayscale intensity pixel component
4176 c cyan pixel component
4177 m magenta pixel component
4178 y yellow pixel component
4179 k black pixel component
4180 p pad component (always 0)
4181</pre>
4182
cristybac7a162010-06-15 19:57:29 +00004183<p>You can specify as many of these components as needed in any order (e.g.
4184bgr). The components can repeat as well (e.g. rgbr).</p>
4185
cristy3ed852e2009-09-05 21:47:34 +00004186
4187<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004188 <h4><a id="mask"></a>-mask
cristy3ed852e2009-09-05 21:47:34 +00004189<em class="arg">filename</em></h4>
4190</div>
4191
4192<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>
4193
4194<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
4195
4196<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004197 <h4><a id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004198</div>
4199
4200<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>
4201
4202<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4203
cristybac7a162010-06-15 19:57:29 +00004204<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4205style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004206
4207<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004208 <h4><a id="maximum"></a>-maximum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004209</div>
4210
4211<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>
4212
4213<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004214 <h4><a id="median"></a>-median <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004215</div>
4216
4217<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>
4218
4219<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004220 <h4><a id="metric"></a>-metric <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004221</div>
4222
4223<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>
4224
4225<p>Choose from:</p>
4226
4227<pre class="text">
cristybac7a162010-06-15 19:57:29 +00004228 AE absolute error count, number of different pixels (-fuzz effected)
cristya20e3f92010-12-13 01:52:32 +00004229 FUZZ mean color distance
cristybac7a162010-06-15 19:57:29 +00004230 MAE mean absolute error (normalized), average channel error distance
4231 MEPP mean error per pixel (normalized mean error, normalized peak error)
4232 MSE mean error squared, average of the channel error squared
cristya20e3f92010-12-13 01:52:32 +00004233 NCC normalized cross correlation
cristybac7a162010-06-15 19:57:29 +00004234 PAE peak absolute (normalize peak absolute)
4235 PSNR peak signal to noise ratio
4236 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004237</pre>
4238
cristy771f7a72010-11-27 21:42:59 +00004239<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4240with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4241only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004242size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004243'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004244for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004245
4246<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4247('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004248normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004249
cristybac7a162010-06-15 19:57:29 +00004250<p>To print a complete list of metrics, use the <a href="#list">-list
4251metrics</a> option.</p>
4252
cristy3ed852e2009-09-05 21:47:34 +00004253
cristyd2baf7d2010-03-06 04:26:44 +00004254<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004255 <h4><a id="minimum"></a>-minimum</h4>
cristyd2baf7d2010-03-06 04:26:44 +00004256</div>
4257
4258<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>
4259
cristy3ed852e2009-09-05 21:47:34 +00004260
4261<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004262 <h4><a id="mode"></a>-mode <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004263</div>
4264
4265<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>
4266
cristybac7a162010-06-15 19:57:29 +00004267<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4268Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004269
cristybac7a162010-06-15 19:57:29 +00004270<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4271for a list of <a href="#mode" >-mode</a> arguments available in your
4272ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004273
4274
4275<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004276 <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 +00004277</div>
4278
cristybac7a162010-06-15 19:57:29 +00004279<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
4280class="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 +00004281
cristyb36feb22010-03-26 16:54:37 +00004282<p>The arguments are given as a percentages of variation. A value of 100 means
4283no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004284
cristyb36feb22010-03-26 16:54:37 +00004285<p>The <em class="arg">brightness</em> is a multiplier of the overall
4286brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4287twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4288before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004289
cristyb36feb22010-03-26 16:54:37 +00004290<p>The <em class="arg">saturation</em> controls the amount of color in an
4291image. For example, 0 produce a grayscale image, while a large value such as
4292200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004293
cristyb36feb22010-03-26 16:54:37 +00004294<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4295within the image by the amount specified. For example, 50 results in
4296a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4297A value of either 0 or 200 results in a complete 180 degree rotation of the
4298image. Using a value of 300 is a 360 degree rotation resulting in no change to
4299the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004300
cristyb36feb22010-03-26 16:54:37 +00004301<p>For example, to increase the color brightness by 20% and decrease the color
4302saturation by 10% and leave the hue unchanged, use <a
4303href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004304
cristyb36feb22010-03-26 16:54:37 +00004305<p>Use <a href="#set">-set</a> attribute of '<kbd
4306class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4307modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4308<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004309
4310<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 +00004311
cristy3ed852e2009-09-05 21:47:34 +00004312<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004313 <h4><a id="monitor"></a>-monitor</h4>
cristy3ed852e2009-09-05 21:47:34 +00004314</div>
4315
4316<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>
4317
4318
4319<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004320 <h4><a id="monochrome"></a>-monochrome</h4>
cristy3ed852e2009-09-05 21:47:34 +00004321</div>
4322
4323<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>
4324
4325
4326<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004327 <h4><a id="morph"></a>-morph <em class="arg">frames</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004328</div>
4329
4330<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>
4331
4332<p>Both the image pixels and size are linearly interpolated to give the
4333appearance of a meta-morphosis from one image to the next, over all the images
4334in the current image list. The added images are the equivalent of a <a
4335href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4336argument determine how many images to interpolate between each image. </p>
4337
4338
4339<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004340 <h4><a id="morphology"></a>-morphology</h4>
4341 <h4>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
cristy488844c2010-01-22 14:02:05 +00004342</div>
4343
cristy2c839602010-04-03 02:32:08 +00004344<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 +00004345
cristydcca3fa2010-12-29 21:50:07 +00004346<p>Until I get around to writing a option summary for this, see <a
4347href="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4348Morphology</a>. </p>
cristy83a272e2010-05-07 20:40:35 +00004349
4350
cristy488844c2010-01-22 14:02:05 +00004351<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004352 <h4><a id="mosaic"></a>-mosaic</h4>
cristy3ed852e2009-09-05 21:47:34 +00004353</div>
4354
4355<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>
4356
4357
4358<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004359 <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 +00004360</div>
4361
4362<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>
4363
4364<p>Blur with the given radius, standard deviation (sigma), and angle. The
4365angle given is the angle toward which the image is blurred. That is the
4366direction people would consider the object is coming from. </p>
4367
4368<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004369definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004370
4371<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4372pixels which are outside the image proper are blurred into the final result.
4373</p>
4374
4375<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004376 <h4><a id="name"></a>-name</h4>
cristy3ed852e2009-09-05 21:47:34 +00004377</div>
4378
4379<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>
4380<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004381 <h4><a id="negate"></a>-negate</h4>
cristy3ed852e2009-09-05 21:47:34 +00004382</div>
4383
cristyb29bc032010-02-01 20:29:43 +00004384<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 +00004385
4386<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>
4387
4388<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004389 <h4><a id="noise"></a>-noise <em class="arg">radius</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004390 +noise <em class="arg">type</em></h4>
4391</div>
4392
4393<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>
4394
4395<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>
4396
4397<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>
4398
4399<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>
4400
4401<pre class="text">
4402Gaussian
4403Impulse
4404Laplacian
4405Multiplicative
4406Poisson
4407Random
4408Uniform
4409</pre>
4410
4411<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4412
cristy83543962009-10-16 19:04:28 +00004413<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4414the use of a controlling value to specify teh amount of noise that should be
4415added to an image. </p>
4416
cristy3ed852e2009-09-05 21:47:34 +00004417
4418<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004419 <h4><a id="normalize"></a>-normalize</h4>
cristy3ed852e2009-09-05 21:47:34 +00004420</div>
4421
4422<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>
4423
cristyd934d102009-10-10 12:55:13 +00004424<p>The intensity values are stretched to cover the entire range of possible
4425values. While doing so, black-out at most <em>2%</em> of the pixels and
4426white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004427
cristyd934d102009-10-10 12:55:13 +00004428<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4429is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4430(Before this version, it was equivalent to <a href="#contrast-stretch"
4431>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004432
cristyd934d102009-10-10 12:55:13 +00004433<p>All the channels are normalized in concert by the came amount so as to
4434preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004435setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004436setting will normalize the RGB channels independently.</p>
4437
cristydcca3fa2010-12-29 21:50:07 +00004438<p>See <a href="#contrast-stretch" >-contrast-stretch</a> for more details.
cristyd934d102009-10-10 12:55:13 +00004439Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004440that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004441
4442<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004443
4444
4445<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004446 <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 +00004447</div>
4448
cristyd934d102009-10-10 12:55:13 +00004449<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
4450class="arg">threshold map</em> specified, and a uniform color map with the
4451given 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 +00004452
4453<p>You can choose from these standard threshold maps:</p>
4454
4455<pre class="text">
cristya6d7cf72010-11-07 15:58:34 +00004456threshold 1x1 Threshold 1x1 (non-dither)
4457checks 2x1 Checkerboard 2x1 (dither)
4458o2x2 2x2 Ordered 2x2 (dispersed)
4459o3x3 3x3 Ordered 3x3 (dispersed)
4460o4x4 4x4 Ordered 4x4 (dispersed)
4461o8x8 8x8 Ordered 8x8 (dispersed)
4462h4x4a 4x1 Halftone 4x4 (angled)
4463h6x6a 6x1 Halftone 6x6 (angled)
4464h8x8a 8x1 Halftone 8x8 (angled)
4465h4x4o Halftone 4x4 (orthogonal)
4466h6x6o Halftone 6x6 (orthogonal)
4467h8x8o Halftone 8x8 (orthogonal)
4468h16x16o Halftone 16x16 (orthogonal)
4469c5x5b c5x5 Circles 5x5 (black)
4470c5x5w Circles 5x5 (white)
4471c6x6b c6x6 Circles 6x6 (black)
4472c6x6w Circles 6x6 (white)
4473c7x7b c7x7 Circles 7x7 (black)
4474c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004475</pre>
4476
cristyde368992010-11-05 14:32:14 +00004477<p> The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
cristyd934d102009-10-10 12:55:13 +00004478pattern. Or you can define your own <em class="arg" >threshold map</em> in a
cristyde368992010-11-05 14:32:14 +00004479personal or system <kbd>thresholds.xml</kbd> XML file. </p>
cristy3ed852e2009-09-05 21:47:34 +00004480
cristyd934d102009-10-10 12:55:13 +00004481<p>To print a complete list of threshold, use the <a href="#list" >-list
4482threshold</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004483
cristyd934d102009-10-10 12:55:13 +00004484<p>It is recommended that the <a href="#map" >+map</a> operator be used after
4485applying <a href="#ordered-dither" >-ordered-dither</a> to reduce the number of
cristy3ed852e2009-09-05 21:47:34 +00004486colors an animated image sequence, to less that 256 colors. This ensures that
4487a common or global color table is used when saving the result to a color
4488limited file format such as GIF. </p>
4489
cristyd934d102009-10-10 12:55:13 +00004490<p>Note that at this time the exact same threshold dithering map is used for
4491all color channels, no attempt is made to offset or rotate the map for
4492different channels is made, to create an offset printing effect. (possible
4493future expansion) </p>
cristy3ed852e2009-09-05 21:47:34 +00004494
4495
4496<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004497 <h4><a id="opaque"></a>-opaque <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004498</div>
4499
4500<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>
4501
cristyc54f5d42009-11-27 21:36:31 +00004502<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004503described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4504>-fuzz</a> setting can be used to match and replace colors similar to the one
4505given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004506
cristyb36feb22010-03-26 16:54:37 +00004507<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4508the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004509
cristyb36feb22010-03-26 16:54:37 +00004510<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4511as <a href="#opaque" >-opaque</a> but replaces the matching color with
4512transparency rather than the current <a href="#fill">-fill</a> color setting.
4513To ensure that it can do this it also ensures that the image has an alpha
4514channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4515the new transparent colors, and does not require you to modify the <a
4516href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004517
cristy3ed852e2009-09-05 21:47:34 +00004518
4519<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004520 <h4><a id="orient"></a>-orient <em class="arg">image orientation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004521</div>
4522
4523<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>
4524
4525<p>Choose from these orientations:</p>
4526
4527<pre class="text">
4528 bottom-left
4529 bottom-right
4530 left-bottom
4531 left-top
4532 right-bottom
4533 right-top
4534 top-left
4535 top-right
4536 undefined
4537</pre>
4538
cristyd934d102009-10-10 12:55:13 +00004539<p>To print a complete list of orientations, use the <a href="#list" >-list
4540orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004541
4542
4543<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004544 <h4><a id="page"></a>-page <em class="arg">geometry</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004545 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4546 +page
4547 </h4>
4548</div>
4549
4550<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>
4551
4552<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>
4553
4554<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>
4555
4556<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>
4557<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4558<thead>
4559 <tr valign="top">
4560 <th align="center"><em class="arg">media</em></th>
4561 <th align="center"><em class="arg">width</em></th>
4562 <th align="center"><em class="arg">height</em></th>
4563 </tr>
4564</thead>
4565<tbody>
4566<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4567<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4568<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4569<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4570<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4571<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4572<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4573<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4574<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4575<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4576<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4577<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4578<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4579<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4580<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4581<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4582<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4583<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4584<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4585<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4586<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4587<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4588<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4589<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4590<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4591<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4592<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4593<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4594<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4595<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4596<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4597<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4598<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4599<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4600<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4601<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4602<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4603<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4604</tbody>
4605</table>
4606
4607
4608
4609
4610<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>
4611
4612<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>
4613
4614<p>The default page dimensions for a TEXT image is 612x792.</p>
4615
4616<p>This option is used in concert with <a href="#density">-density</a>.</p>
4617
4618<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4619
4620<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004621 <h4><a id="paint"></a>-paint <em class="arg">radius</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004622</div>
4623
4624<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>
4625
4626<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>
4627
4628<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004629 <h4><a id="path"></a>-path <em class="arg">path</em></h4></div>
cristy3ed852e2009-09-05 21:47:34 +00004630
4631<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>
4632
4633<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004634 <h4><a id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004635</div>
4636
4637<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>
4638
4639<p>Pause for the specified number of seconds before repeating the animation.</p>
4640
4641<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004642 <h4><a id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004643</div>
4644
4645<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>
4646
4647<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4648
4649<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004650 <h4><a id="ping"></a>-ping</h4>
cristy3ed852e2009-09-05 21:47:34 +00004651</div>
4652
4653<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>
4654
4655<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004656 <h4><a id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004657</div>
4658
4659<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>
4660
4661<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004662 <h4><a id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004663</div>
4664
4665<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>
4666
4667<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4668
4669<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004670 <h4><a id="posterize"></a>-posterize <em class="arg">levels</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004671</div>
4672
4673<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>
4674
4675<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004676 <h4><a id="precision"></a>-precision <em class="arg">value</em></h4>
cristyd43a46b2010-01-21 02:13:41 +00004677</div>
4678
4679<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>
4680
4681<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004682 <h4><a id="preview"></a>-preview <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004683</div>
4684
4685<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>
4686
4687<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>
4688
4689<pre class="text">
4690 Rotate
4691 Shear
4692 Roll
4693 Hue
4694 Saturation
4695 Brightness
4696 Gamma
4697 Spiff
4698 Dull
4699 Grayscale
4700 Quantize
4701 Despeckle
4702 ReduceNoise
4703 Add Noise
4704 Sharpen
4705 Blur
4706 Threshold
4707 EdgeDetect
4708 Spread
4709 Shade
4710 Raise
4711 Segment
4712 Solarize
4713 Swirl
4714 Implode
4715 Wave
4716 OilPaint
4717 CharcoalDrawing
4718 JPEG
4719</pre>
4720
4721<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4722
4723<p>The default preview is <kbd>JPEG</kbd>.</p>
4724
4725<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004726 <h4><a id="print"></a>-print <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004727</div>
4728
4729<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>
4730
4731<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004732 <h4><a id="process"></a>-process <em class="arg">command</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004733</div>
4734
4735<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>
4736
4737<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>
4738
4739<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004740 <h4><a id="profile"></a>-profile <em class="arg">filename</em><br/>
cristy3ed852e2009-09-05 21:47:34 +00004741 +profile <em class="arg">profile_name</em></h4>
4742</div>
4743
4744<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>
4745
4746<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>
4747
4748<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>
4749
4750<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>
4751
4752<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>
4753
4754<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4755
4756<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4757<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>
4758
4759<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>
4760<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4761CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4762</p>
4763
4764<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004765 <h4><a id="quality"></a>-quality <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004766</div>
4767
4768<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>
4769
cristy851dbce2010-08-06 21:40:00 +00004770<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 +00004771
4772<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>
4773
cristy851dbce2010-08-06 21:40:00 +00004774<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 +00004775
cristy3c98a4f2010-08-13 20:09:41 +00004776<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 +00004777
4778<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4779
4780<pre class="text">
4781 0: none
4782 1: sub
4783 2: up
4784 3: average
4785 4: Paeth
4786</pre>
4787
4788<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>
4789
4790<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4791
4792<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>
4793
cristy3c98a4f2010-08-13 20:09:41 +00004794<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 +00004795
4796<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4797
cristy3ed852e2009-09-05 21:47:34 +00004798<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004799 <h4><a id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004800</div>
4801
cristy3c98a4f2010-08-13 20:09:41 +00004802<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 +00004803
cristy3c98a4f2010-08-13 20:09:41 +00004804<p>This setting defines the colorspace used to sort out and reduce the number
4805of colors needed by an image (for later dithering) by operators such as <a
4806href="#colors" >-colors</a>, Note that color reducion also happens
4807automatically when saving images to color-limited image file formats, such as
4808GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004809
4810
4811<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004812 <h4><a id="quiet"></a>-quiet</h4>
cristy3ed852e2009-09-05 21:47:34 +00004813</div>
4814
4815<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>
4816
4817<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004818 <h4><a id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004819</div>
4820
4821<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>
4822
4823<p>Note that this is actually a rotational blur rather than a radial and as
4824such actually mis-named. </p>
4825
4826<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4827pixels which are outside the image proper are blurred into the final result.
4828</p>
4829
4830
4831<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004832 <h4><a id="raise"></a>-raise <em class="arg">thickness</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004833</div>
4834
4835<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>
4836
4837<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>.
4838</p>
4839
4840<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4841
4842<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004843 <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 +00004844</div>
4845
4846<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>
4847
4848<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004849 <h4><a id="red-primary"></a>-red-primary <em class="arg">x,y</em></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%'>Set the red chromaticity primary point.</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="regard-warnings"></a>-regard-warnings</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%'>Pay attention to warning messages.</td><td style='text-align:right;'></td></tr></table>
4859
4860<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004861 <h4><a id="remap"></a>-remap <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004862</div>
4863
4864<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>
4865
4866<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4867the given colors are dithered over the image as necessary, otherwise the closest
4868color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4869
4870<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4871images in the current image sequence, all the images will have the same color
4872table. That means that when saved to a file format such as GIF, it will use
4873that color table as a single common or global color table, for all the images,
4874without requiring extra local color tables. </p>
4875
4876<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4877sequence to use a common color map over all the images. This equivalent to
4878appending all the images together (without extra background colors) and color
4879reducing those images using <a href="#colors">-colors</a> with a 256 color
4880limit, then <a href="#remap">-remap</a> those colors over the original list of
4881images. This ensures all the images follow a single color map. </p>
4882
4883<p>If the number of colors over all the images is less than 256, then <a
4884href="#remap">+remap</a> should not perform any color reduction or dithering, as
4885no color changes are needed. In that case, its only effect is to force the use
4886of a global color table. This recommended after using either <a
4887href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
4888reduce the number of colors in an animated image sequence. </p>
4889
4890<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004891 <h4><a id="region"></a>-region <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004892</div>
4893
4894<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>
4895
4896<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>
4897
4898<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>
4899
4900<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004901 <h4><a id="remote"></a>-remote</h4>
cristy3ed852e2009-09-05 21:47:34 +00004902</div>
4903
4904<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>
4905
4906<p>The only command recognized is the name of an image file to load.</p>
4907
4908<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>
4909
4910<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004911 <h4><a id="render"></a>-render</h4>
cristy3ed852e2009-09-05 21:47:34 +00004912</div>
4913
4914<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>
4915
4916<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>
4917
4918<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004919<h4><a id="repage"></a>-repage <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004920</div>
4921
4922<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>
4923
4924<p>This option is like <a href="#page">-page</a> but acts as an image operator
4925rather than a setting. You can separately set the canvas size or the offset
4926of the image on that canvas by only providing those components. </p>
4927
4928<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>
4929
4930<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
4931offset to move the image relative to its previous position. This useful for
4932animation sequences. </p>
4933
4934<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
4935recalculate the canvas size so the image (at its current offset) will appear
4936completely on that canvas (unless it has a negative offset).</p>
4937
4938<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
4939canvas meta-data from the images. </p>
4940
4941<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
4942directly assign virtual canvas meta-data. </p>
4943
4944
4945<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004946 <h4><a id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00004947</div>
4948
4949<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>
4950
4951<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>
4952
4953<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>
4954
4955<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004956 <h4><a id="resize"></a>-resize <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%'>Resize an image.</td><td style='text-align:right;'></td></tr></table>
4960
4961<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>
4962
4963<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>
4964
cristy13538962010-02-26 17:53:04 +00004965<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>
4966
cristy4949d522010-03-12 18:41:34 +00004967<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 +00004968<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004969 <h4><a id="respect-parentheses"></a>-respect-parentheses</h4>
cristy3ed852e2009-09-05 21:47:34 +00004970</div>
4971
4972<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>
4973
4974<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004975 <h4><a id="reverse"></a>-reverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00004976</div>
4977
4978<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>
4979
4980
4981<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004982 <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 +00004983</div>
4984
4985<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>
4986
4987<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>
4988
4989
4990<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00004991 <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 +00004992</div>
4993
4994<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>
4995
4996<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>
4997
4998<p>Empty triangles in the corners, left over from rotating the image, are
4999filled with the <kbd>background</kbd> color. </p>
5000
5001<p>See also the <a href="#distort">-distort</a> operator and specifically the
5002'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
5003
5004
5005<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005006 <h4><a id="sample"></a>-sample <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005007</div>
5008
cristyd0bd44a2010-09-24 12:38:11 +00005009<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 +00005010
cristyd0bd44a2010-09-24 12:38:11 +00005011<p>Change the image size simply by directly sampling the pixels original
5012image. When magnifying, pixels are replicated in blocks. When minifying,
5013pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00005014
cristyd0bd44a2010-09-24 12:38:11 +00005015<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5016a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
5017neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
5018avoids all the filter processing of the image. As such it completely ignores
5019the current <a href="#filter">-filter</a> setting. </p>
5020
5021<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
5022will be added to the resulting image, though some colors may disappear. </p>
5023
5024<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
5025ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00005026
5027
5028<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005029 <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 +00005030</div>
5031
5032<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>
5033
5034<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>
5035
5036<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005037 <h4><a id="scale"></a>-scale <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005038</div>
5039
cristyd0bd44a2010-09-24 12:38:11 +00005040<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 +00005041
cristyd0bd44a2010-09-24 12:38:11 +00005042<p>Change the image size simply by replacing pixels by averaging pixels
5043together when minifying, or replacing pixels when magnifing. </p>
5044
5045<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
5046a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
5047faster, as it avoids all the filter processing of the image. As such it
5048completely ignores the current <a href="#filter">-filter</a> setting. </p>
5049
5050<p>If when shrinking (minifying) images the original image is some integer
5051multiple of the new image size, the number of pixels avergaed together to
5052produce the new pixel color is the same across the whole image. This is
5053a special case known as 'binning' and is often used as a method of reducing
5054noise in image such as those generated by digital cameras, especially in low
5055light conditions. </p>
5056
cristy3ed852e2009-09-05 21:47:34 +00005057
5058<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005059 <h4><a id="scene"></a>-scene <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005060</div>
5061
5062<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>
5063
5064<p>This option sets the scene number of an image or the first image in an image sequence.</p>
5065
5066<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005067 <h4><a id="screen"></a>-screen</h4>
cristy3ed852e2009-09-05 21:47:34 +00005068</div>
5069
5070<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>
5071
5072<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>
5073
5074<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005075 <h4><a id="seed"></a>-seed</h4>
cristy3ed852e2009-09-05 21:47:34 +00005076</div>
5077
5078<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>
5079
5080<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005081 <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 +00005082</div>
5083
5084<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>
5085
5086<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>
5087
5088<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>
5089
5090<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5091of the color clusters is returned.</p>
5092
5093
5094<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005095 <h4><a id="selective-blur"></a>-selective-blur <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005096</div>
5097
cristy2e2662a2010-10-09 14:29:37 +00005098<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005099 <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 +00005100</div>
5101
cristy3ed852e2009-09-05 21:47:34 +00005102<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>
5103
cristy2e2662a2010-10-09 14:29:37 +00005104<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>
5105
cristy3ed852e2009-09-05 21:47:34 +00005106<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005107 <h4><a id="separate"></a>-separate</h4>
cristy3ed852e2009-09-05 21:47:34 +00005108</div>
5109
5110<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>
5111
5112<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005113 <h4><a id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005114</div>
5115
5116<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>
5117
5118<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5119
5120<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>
5121
cristyd0bda5e2010-09-21 16:22:45 +00005122
5123
cristy3ed852e2009-09-05 21:47:34 +00005124<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005125 <h4><a id="set"></a>-set <em class="arg">key value</em></h4>
5126 <h4>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005127</div>
5128
cristyd0bd44a2010-09-24 12:38:11 +00005129<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 +00005130image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005131
cristyd0bd44a2010-09-24 12:38:11 +00005132<p>This will assign (or modify) specific settings attached to all the images
5133in the current image sequence. Using the <a href="#set">+set</a> form of the
5134option will either remove, or reset that setting to a default state, as
5135appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005136
cristyd0bd44a2010-09-24 12:38:11 +00005137<p>For example, it will modify specific well known image meta-data
5138'attributes' such as those normally overridden by: the options <a
5139href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5140href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5141assigned before the image is read in, by using a <em class="arg">key</em> of
5142the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005143
cristyd0bd44a2010-09-24 12:38:11 +00005144<p>If the given <em class="arg">key</em> does not match a specific known
5145'attribute ', such as shown above, the setting is stored as a a free form
cristyd0bda5e2010-09-21 16:22:45 +00005146'properity' string. Such settings are listed in <a href="#verbose"
5147>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5148</p>
5149
cristyd0bd44a2010-09-24 12:38:11 +00005150<p>This includes string 'properities' that are set by and assigned to images
5151using the options <a href="#comment" >-comment</a>, <a href="#label"
5152>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5153a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5154Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005155
cristyd0bd44a2010-09-24 12:38:11 +00005156<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>
5157<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5158Properties</a> in the defined value. For example:</p>
5159
5160<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>
5161<p>Other well known 'properities' that can be include:
5162'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5163'<kbd>signature</kbd>'. </p>
5164
5165<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5166the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5167see <a href="#repage">-page</a>). However it is designed to provide a finer
5168control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5169option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5170attribute. </p>
5171
5172<p>This option can also associate a colorspace or profile with your image.
5173For example,</p>
5174
5175<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 +00005176<p>Some 'properties' must be defined in a specific way to be used. For
5177example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5178modify the output filename of an image. For example</p>
5179
5180<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>
5181<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5182be saved as a global "Artifact" exactly as if it was set using the <a
cristyd0bd44a2010-09-24 12:38:11 +00005183href="#define" >-define</a> option. As such settings are globel in scope, they
5184can be used to pass 'attributes' and 'properities' of one specific image,
5185in a way that allows you to use them in a completely different image, even if
5186the original image has long since been modified or destroyed. For example: </p>
5187
5188<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>
5189<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5190a 'artifact' if the given <em class="arg">key</em> does not match an existing
5191'attribute' or 'properity'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005192
5193<p>You can set the attributes of the image registry by prefixing the value
5194with <kbd>registry:</kbd>.</p>
5195
5196
cristy3ed852e2009-09-05 21:47:34 +00005197
5198<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005199 <h4><a id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005200</div>
5201
5202<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>
5203
5204<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>
5205
5206<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005207 <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 +00005208</div>
5209
5210<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>
5211
5212<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005213 <h4><a
cristy3ed852e2009-09-05 21:47:34 +00005214id="shared-memory"></a>-shared-memory</h4>
5215</div>
5216
5217<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>
5218
5219<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>
5220
5221<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005222 <h4><a id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005223</div>
5224
5225<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>
5226
5227<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5228
5229<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005230 <h4><a id="shave"></a>-shave <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005231</div>
5232
5233<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>
5234
5235<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>
5236
5237<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>
5238
5239<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005240 <h4><a id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
cristy3ed852e2009-09-05 21:47:34 +00005241</div>
5242
5243<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>
5244
5245<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>
5246
5247<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>
5248
5249<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>
5250
5251<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>
5252
5253<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>
5254<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>
5255
5256<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5257<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005258 <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 +00005259</div>
5260
5261<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>
5262
5263<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>
5264
5265<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005266 <h4><a id="silent"></a>-silent</h4>
cristy3ed852e2009-09-05 21:47:34 +00005267</div>
5268
5269<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>
5270
5271<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005272 <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 +00005273</div>
5274
5275<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>
5276
5277<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>
5278
5279<p>For Photo CD images, choose from these sizes:</p>
5280
5281<pre class="text">
5282 192x128
5283 384x256
5284 768x512
5285 1536x1024
5286 3072x2048
5287</pre>
5288
cristy3ed852e2009-09-05 21:47:34 +00005289<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005290 <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 +00005291</div>
5292
5293<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>
5294
5295<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>
5296
5297<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005298 <h4><a id="snaps"></a>-snaps <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005299</div>
5300
5301<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>
5302
5303<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5304
5305<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005306 <h4><a id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005307</div>
5308
5309<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>
5310
5311<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5312
5313<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5314
5315<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005316 <h4><a id="sparse-color"></a>-sparse-color <em
cristy3ed852e2009-09-05 21:47:34 +00005317 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5318</div>
5319
5320<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>
5321
5322
5323<table class="doc">
5324 <tbody>
5325 <tr valign="top">
5326 <th align="left" style="width: 8%">Method</th>
5327 <th align="left">Description</th>
5328 </tr>
5329
5330 <tr valign="top">
5331 <td valign="top">voronoi</td>
5332 <td valign="top">Simply map each pixel to the to nearest color point
5333 given. The result are polygonal 'cells' of solid color. </td>
5334 </tr>
5335
5336 <tr valign="top">
5337 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005338 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005339 squared. Generating spots of color in a sea of the average of
5340 colors. </td>
5341 </tr>
5342
5343 <tr valign="top">
5344 <td valign="top">barycentric</td>
5345 <td valign="top">three point triangle of color given 3 points.
5346 Giving only 2 points will form a linear gradient between those points.
5347 Gradient is however not restricted to just the triangle or line. </td>
5348 </tr>
5349
5350 <tr valign="top">
5351 <td valign="top">bilinear</td>
5352 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5353 fall back to barycentric. </td>
5354 </tr>
5355
5356 </tbody>
5357</table>
5358
5359<p>The points are placed according to the images location on the virtual
5360canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5361offset), and do not actually have to exist on the given image, but may be
5362some point beyond the edge of the image. All points are floating point values.
5363</p>
5364
5365<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
5366modified, whcih means the matte/alpha transparency channel is not effected by
5367default. If enabled, the image also needs a the matte/alpha channel to be
5368enabled for this operator to effect an images transparency. This is typical
5369transparency handling for images. </p>
5370
5371<p>All the above methods when given a single point of color will replace all
5372the colors in the image with the color given, regardless of the point. This is
5373logical, and provides an alternative technique to recolor a image to some
5374default value. </p>
5375
5376
5377<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005378 <h4><a id="splice"></a>-splice <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005379</div>
5380
5381<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>
5382
5383<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>
5384
5385<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005386 <h4><a id="spread"></a>-spread <em class="arg">amount</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005387</div>
5388
5389<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>
5390
5391<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>
5392
5393<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005394 <h4><a id="stegano"></a>-stegano <em class="arg">offset</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005395</div>
5396
5397<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>
5398
5399<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>
5400
5401<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005402 <h4><a id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005403</div>
5404
5405<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>
5406
5407<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>
5408
5409<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005410 <h4><a id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005411</div>
5412
5413<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>
5414
5415<pre class="text">
5416 char store pixels as unsigned characters
5417 double store pixels as doubles
5418 float store pixels as floats
5419 integer store pixels as integers
5420 long store pixels as longs
5421 quantum store pixels in the native depth of your ImageMagick distribution
5422 short store pixels as unsigned shorts
5423</pre>
5424
5425<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5426values range from 0 to the maximum value the storage type can support.</p>
5427
5428<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005429 <h4><a id="stretch"></a>-stretch <em class="arg">fontStretch</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%'>Set a type of stretch style for fonts.</td><td style='text-align:right;'></td></tr></table>
5433
5434<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>
5435
5436<pre class="text">
5437 Any
5438 Condensed
5439 Expanded
5440 ExtraCondensed
5441 ExtraExpanded
5442 Normal
5443 SemiCondensed
5444 SemiExpanded
5445 UltraCondensed
5446 UltraExpanded
5447</pre>
5448
5449<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5450
5451<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>
5452
5453<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005454 <h4><a id="strip"></a>-strip</h4>
cristy3ed852e2009-09-05 21:47:34 +00005455</div>
5456
5457<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>
5458
5459<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005460 <h4><a id="stroke"></a>-stroke <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005461</div>
5462
5463<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>
5464
5465<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5466
5467<p>See <a href="#draw">-draw</a> for further details.</p>
5468
5469<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005470 <h4><a id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005471</div>
5472
5473<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>
5474
5475<p>See <a href="#draw">-draw</a> for further details.</p>
5476
5477<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005478 <h4><a id="style"></a>-style <em class="arg">fontStyle</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005479</div>
5480
5481<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>
5482
cristy71a3f602010-09-15 12:38:16 +00005483<p>This setting suggests a font style that ImageMagick should try to apply to
5484the currently selected font family. Select <em class="arg">fontStyle</em> from
5485the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005486
5487<pre class="text">
5488 Any
5489 Italic
5490 Normal
5491 Oblique
5492</pre>
5493
5494<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>
5495
5496<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005497 <h4><a id="subimage-search"></a>-subimage-search</h4>
cristyae6203d2010-08-09 01:12:14 +00005498</div>
5499
cristyd4d64ed2010-08-22 22:19:33 +00005500<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>
5501
cristy71a3f602010-09-15 12:38:16 +00005502<p>This option is required to have compare search for the best match location
5503of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005504(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005505be the "match score" image.</p>
5506
cristyd0bd44a2010-09-24 12:38:11 +00005507<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005508position of the top-left corner of the given sub-image. that is its size will
5509be the size of the larger_image - sub_image + 1. The brightest location in
5510this image is the location s the locate on the best match that is also
5511reported. Note that this may or may nor be a perfect match, and the actual
5512brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005513possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005514
cristyd0bda5e2010-09-21 16:22:45 +00005515<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005516location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005517sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005518
cristyae6203d2010-08-09 01:12:14 +00005519
5520<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005521 <h4><a id="swap"></a>-swap <em class="arg">index,index</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%'>Swap the positions of two images in the image sequence.</td><td style='text-align:right;'></td></tr></table>
5525
cristy71a3f602010-09-15 12:38:16 +00005526<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5527images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5528the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005529
5530<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005531 <h4><a id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005532</div>
5533
5534<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>
5535
5536<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5537
5538<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005539 <h4><a id="synchronize"></a>-synchronize</h4>
cristy5063d812010-10-19 16:28:10 +00005540</div>
5541
5542<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>
5543
5544<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005545 <h4><a id="taint"></a>-taint</h4>
cristy3ed852e2009-09-05 21:47:34 +00005546</div>
5547
cristy5063d812010-10-19 16:28:10 +00005548<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 +00005549
5550<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005551 <h4><a id="text-font"></a>-text-font <em class="arg">name</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005552</div>
5553
5554<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>
5555
5556<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>
5557
5558<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>
5559
5560<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005561 <h4><a id="texture"></a>-texture <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005562</div>
5563
5564<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>
5565
5566<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005567 <h4><a id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005568</div>
5569
5570<!-- {<em class="arg">green,blue,opacity</em>}
5571<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>
5572-->
5573
5574<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>
5575
5576<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>
5577
5578<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.
5579</p>
5580
5581<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>
5582
5583<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5584<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>
5585
5586
5587<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>
5588<p>Note that the values of the transparency channel is treated as 'matte'
5589values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5590
5591<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>.
5592</p>
5593
5594<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005595 <h4><a id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005596</div>
5597
5598<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>
5599
5600<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>
5601
5602<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>
5603
5604<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005605 <h4><a id="tile"></a>-tile <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005606</div>
5607
5608<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>
5609
5610<div style="margin: auto;">
5611 <h4>-tile <em class="arg">geometry</em></h4>
5612</div>
5613
5614<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>
5615
5616<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>
5617
5618<div style="margin: auto;">
5619 <h4>-tile</h4>
5620</div>
5621
5622<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>
5623
5624<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005625 <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 +00005626</div>
5627
5628<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>
5629
5630<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>
5631
5632<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>
5633
5634<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005635 <h4><a id="tint"></a>-tint <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005636</div>
5637
5638<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>
5639
5640<p>Tint the image with the fill color.</p>
5641
5642<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>
5643
5644<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005645 <h4><a id="title"></a>-title <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005646</div>
5647
5648<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>
5649
5650<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>
5651
5652<p>For example,</p>
5653
5654<p class="crtsnip">
5655 -title "%m:%f %wx%h"
5656</p>
5657
5658<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>
5659
5660
5661<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005662 <h4><a id="transform"></a>-transform</h4>
cristy3ed852e2009-09-05 21:47:34 +00005663</div>
5664
5665<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>
5666
5667<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5668
5669<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 +00005670
5671<p>This operator has been now been superseded by the <a
5672href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5673
5674
cristy3ed852e2009-09-05 21:47:34 +00005675<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005676 <h4><a id="transparent"></a>-transparent <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005677</div>
5678
5679<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>
5680
5681<p>The <em class="arg">color</em> argument is defined using the format
5682described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5683>-fuzz</a> setting can be used to match and replace colors similar to the one
5684given. </p>
5685
cristyb36feb22010-03-26 16:54:37 +00005686<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5687that is make all non-matching colors transparent. </p>
5688
cristy3ed852e2009-09-05 21:47:34 +00005689<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005690href="#transparent" >-transparent</a> but replaces the matching color with the
5691current <a href="#fill">-fill</a> color setting, rather than transparent.
5692However the <a href="#transparent" >-transparent</a> operator also ensures
5693that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5694>-alpha</a> set</kbd>", and does not require you to modify the <a
5695href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005696
cristyb36feb22010-03-26 16:54:37 +00005697<p>Note that this does not define the color as being the 'transparency color'
5698used for color-mapped image formats, such as GIF. For that use <a
5699href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005700
5701
5702<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005703 <h4><a id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005704</div>
5705
5706<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>
5707
5708<p>Sometimes this is used for saving to image formats such as
5709GIF and PNG8 which uses this color to represent boolean transparency. This
5710does not make a color transparent, it only defines what color the transparent
5711color is in the color palette of the saved image. Use <a
5712href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5713
5714<p>This option allows you to have both an opaque visible color, as well as a
5715transparent color of the same color value without conflict. That is, you can
5716use the same color for both the transparent and opaque color areas within an
5717image. This, in turn, frees to you to select a transparent color that is
5718appropriate when an image is displayed by an application that does not handle a
5719transparent color index, while allowing ImageMagick to correctly handle images of this
5720type. </p>
5721
5722<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5723
5724<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005725 <h4><a id="transpose"></a>-transpose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005726</div>
5727
5728<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>
5729
5730<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5731</p>
5732
5733<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005734 <h4><a id="transverse"></a>-transverse</h4>
cristy3ed852e2009-09-05 21:47:34 +00005735</div>
5736
5737<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Mirror the image along the images bottom-left top-right diagonal. Equivalent to the operations <kbd>-flop -rotate 90</kbd>.</td><td style='text-align:right;'></td></tr></table>
5738
5739
5740<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005741 <h4><a id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005742</div>
5743
5744<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>
5745
5746<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>
5747
5748<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>
5749
5750<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>
5751
5752<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005753 <h4><a id="trim"></a>-trim</h4>
cristy3ed852e2009-09-05 21:47:34 +00005754</div>
5755
5756<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>
5757
5758<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>
5759
5760<p>The page or virtual canvas information of the image is preserved allowing
5761you to extract the result of the <a href="#trim">-trim</a> operation from the
5762image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5763information if it is unwanted.</p>
5764
5765<p>If the trimmed image 'disappears' an warning is produced, and a special
5766single pixel transparent 'missed' image is returned, in the same way as when a
5767<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5768
5769
5770<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005771 <h4><a id="type"></a>-type <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005772</div>
5773
5774<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 +00005775 <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 +00005776
5777<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>
5778
5779<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5780<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>
5781
5782<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5783
5784<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005785 <h4><a id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005786</div>
5787
5788<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>
5789
5790<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5791
5792<p>See <a href="#draw">-draw</a> for further details.</p>
5793
5794
5795<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005796 <h4><a id="update"></a>-update <em class="arg">seconds</em></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%'>detect when image file is modified and redisplay.</td><td style='text-align:right;'></td></tr></table>
5800
5801<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>
5802
5803
5804<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005805 <h4><a id="unique-colors"></a>-unique-colors</h4>
cristy3ed852e2009-09-05 21:47:34 +00005806</div>
5807
5808<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>
5809
5810
5811<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005812 <h4><a id="units"></a>-units <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005813</div>
5814
5815<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>
5816
5817<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>
5818
5819
5820<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005821 <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 +00005822</div>
5823
5824<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>
5825
5826<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>
5827
5828<p>The parameters are:</p>
5829
5830<pre class="text">
5831 radius: The radius of the Gaussian, in pixels, not counting the center
5832 pixel (default 0).
5833 sigma: The standard deviation of the Gaussian, in pixels (default 1.0).
5834 amount: The fraction of the difference between the original and the blur
5835 image that is added back into the original (default 1.0).
5836 threshold: The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5837 difference amount (default 0.05).
5838</pre>
5839
5840
5841<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005842 <h4><a id="verbose"></a>-verbose</h4>
cristy3ed852e2009-09-05 21:47:34 +00005843</div>
5844
cristyd0bda5e2010-09-21 16:22:45 +00005845<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 +00005846
5847
5848<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005849 <h4><a id="version"></a>-version</h4>
cristy3ed852e2009-09-05 21:47:34 +00005850</div>
5851
5852<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>
5853
5854
5855<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005856 <h4><a id="view"></a>-view <em class="arg">string</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005857</div>
5858
5859<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>
5860
5861
5862<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005863 <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 +00005864</div>
5865
5866<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>
5867
5868
5869<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005870 <h4><a id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005871</div>
5872
5873<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>
5874
5875<p>This option defines what color source should be used if and when a color
5876lookup completely 'misses' the source image. The color(s) that appear to
5877surround the source image. Generally this color is derived from the source
5878image, but could also be set to a specify background color. </p>
5879
5880<p>Choose from these methods:</p>
5881
5882<pre class="text">
5883 background: the area surrounding the image is the background color
5884 black: the area surrounding the image is black
5885 checker-tile: alternate squares with image and background color
5886 dither: non-random 32x32 dithered pattern
5887 edge: extend the edge pixel toward infinity
5888 gray: the area surrounding the image is gray
5889 horizontal-tile: horizontally tile the image, background color above/below
5890 horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
5891 mirror: mirror tile the image
5892 random: choose a random pixel from the image
5893 tile: tile the image (default)
5894 transparent: the area surrounding the image is transparent blackness
5895 vertical-tile: vertically tile the image, sides are background color
5896 vertical-tile-edge: vertically tile the image and replicate the side edge pixels
5897 white: the area surrounding the image is white
5898</pre>
5899
5900<p>The default value is "edge".</p>
5901
5902<p>This most important for distortion operators such as <a href="#distort"
5903>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
5904However it also effects operations that may access pixels just outside the
5905image proper, such as <a href="#convolve">-convolve</a>, <a
5906href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
5907
5908<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
5909
5910
5911<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005912 <h4><a id="visual"></a>-visual <em class="arg">type</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005913</div>
5914
5915<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>
5916
5917<p>Choose from these visual classes:</p>
5918
5919<pre class="text">
5920 StaticGray
5921 GrayScale
5922 StaticColor
5923 PseudoColor
5924 TrueColor
5925 DirectColor
5926 default
5927 visual id
5928</pre>
5929
5930<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>
5931
5932
5933<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005934 <h4><a id="watermark"></a>-watermark <em
cristy3ed852e2009-09-05 21:47:34 +00005935 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
5936</div>
5937
5938<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
5939saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5940
5941<p>Take a grayscale image (with alpha mask) and modify the destination image's
5942brightness according to watermark image's grayscale value and the <em
5943class="arg">brightness</em> percentage. The destinations color saturation
5944attribute is just direct modified by the <em class="arg">saturation</em>
5945percentage, which defaults to 100 percent (no color change). </p>
5946
5947
5948<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005949 <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 +00005950</div>
5951
5952<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>
5953
5954<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
5955
5956<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005957 <h4><a id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005958</div>
5959
5960<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>
5961
5962<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>
5963
5964<table class="doc">
5965 <col width="25%" />
5966 <col width="75%" />
5967 <thead>
5968 <tr>
5969 <th><em class="arg">fontWeight</em></th>
5970 <th>Description</th>
5971 </tr>
5972 </thead>
5973 <tbody>
5974 <tr><td>All </td> <td>No effect. </td></tr>
5975 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
5976 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
5977 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
5978 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
5979 </tbody>
5980 </table>
5981
5982<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
5983
5984<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>
5985
5986<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005987 <h4><a id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005988</div>
5989
5990<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>
5991
5992<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00005993 <h4><a id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005994</div>
5995
cristy5cadd612009-09-21 19:33:41 +00005996<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>
5997
5998<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.
5999</p>
cristy3ed852e2009-09-05 21:47:34 +00006000
6001<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006002 <h4><a id="window"></a>-window <em class="arg">id</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006003</div>
6004
6005<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>
6006
6007<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>
6008
6009<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>
6010
6011<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>
6012
6013<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006014 <h4><a id="window-group"></a>-window-group</h4>
cristy3ed852e2009-09-05 21:47:34 +00006015</div>
6016
6017<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>
6018
6019<div style="margin: auto;">
cristydcca3fa2010-12-29 21:50:07 +00006020 <h4><a id="write"></a>-write <em class="arg">filename</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00006021</div>
6022
6023<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>
6024 <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>
6025
6026<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
cristydcca3fa2010-12-29 21:50:07 +00006027</div>
6028</div>
cristy3eaa0ef2010-03-06 20:35:26 +00006029
6030</div>
6031
6032<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00006033 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006034 <span id="linkbar-center">
6035 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00006036 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00006037 </span>
6038 <span id="linkbar-east">&nbsp;</span>
6039 </div>
6040 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +00006041 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +00006042 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
6043 </div>
6044 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00006045 <script type="text/javascript">
6046 var _gaq = _gaq || [];
6047 _gaq.push(['_setAccount', 'UA-17690367-1']);
6048 _gaq.push(['_trackPageview']);
6049
6050 (function() {
6051 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
6052 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
6053 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
6054 })();
6055 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00006056</body>
6057</html>