blob: f041995b3eb63278c8fa91e3a157637bfb9fb560 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001
2
3
4
5<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
6 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +00007<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00008<head>
cristy3c98a4f2010-08-13 20:09:41 +00009 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
11 <title>ImageMagick: Command-line Options</title/>
cristy3ed852e2009-09-05 21:47:34 +000012 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000015 <meta name="Application-name" content="ImageMagick"/>
16 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000018 <meta name="Generator" content="PHP"/>
19 <meta name="Keywords" content="command-line, options, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +000020 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +000026 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000027 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +000028 <link rel="icon" href="../images/wand.png" sizes="32x32"/>
29 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
31 <style type="text/css" media="all">
32 @import url("../www/magick.css");
33 </style>
cristy3eaa0ef2010-03-06 20:35:26 +000034</head>
35
36<body id="www-imagemagick-org">
37<div class="titlebar">
38<a href="../index.html">
39 <img src="../images/script.png" alt="[ImageMagick]"
40 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
41<a href="http://www.networkredux.com">
42 <img src="../images/networkredux.png" alt="[sponsor]"
43 style="margin: 45px auto; border: 0px; float: left;" /></a>
44<a href="http://www.imagemagick.org/discourse-server/">
45 <img src="../images/logo.jpg" alt=""
46 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
47<a href="../index.html">
48 <img src="../images/sprite.jpg" alt=""
49 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
50</div>
51
cristyce69bb02010-07-27 19:49:46 +000052<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000053
cristy3ed852e2009-09-05 21:47:34 +000054<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000055 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000056</div>
cristy3eaa0ef2010-03-06 20:35:26 +000057<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000058<div class="menu">
cristybb503372010-05-27 20:51:26 +000059 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
60</div>
61<div class="sub">
62 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
63</div>
64<div class="sub">
65 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
66</div>
67<div class="sub">
68 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
69</div>
70<div class="sep"></div>
71<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000072 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000073</div>
74<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000075 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000076</div>
77<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000078 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000079</div>
80<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000081 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000082</div>
83<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000084 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000085</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000087 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000088</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000090 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000091</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
cristy3eaa0ef2010-03-06 20:35:26 +000098<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000099<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000106 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000107 </div>
108<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
cristybb503372010-05-27 20:51:26 +0000111<div class="menu">
112 <a title="Architecture" href="../www/architecture.html">Architecture</a>
113</div>
cristy3ed852e2009-09-05 21:47:34 +0000114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Site Map"href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000124</div>
125<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Site Map: Links"href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000127</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000128<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000129<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000131
132<div class="sponsbox">
133<div class="sponsor">
cristy61365ad2010-11-28 02:38:34 +0000134 <a title="Sponsor: Notebook of repair" href="http://www.notebook-reparatur-berlin.de/">Notebook of Repair</a><!-- 2011030100025 -->
cristy7d52cd62010-10-01 17:26:59 +0000135</div>
136<div class="sponsor">
137 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000138</div>
139<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000140 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
141</div>
142<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000143 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
144</div>
145<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000146 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy787d4352010-03-06 13:55:58 +0000147</div>
148<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000149 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000150</div>
151<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000152 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000153</div>
cristy3ed852e2009-09-05 21:47:34 +0000154</div>
155</div>
cristyce69bb02010-07-27 19:49:46 +0000156</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000157
cristyce69bb02010-07-27 19:49:46 +0000158<div class="eastbar">
159 <script type="text/javascript">
160 <!--
161 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000162 google_ad_slot = "0574824969";
163 google_ad_width = 160;
164 google_ad_height = 600;
165 //-->
166 </script>
167 <script type="text/javascript"
168 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
169 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000170</div>
171
172<div class="main">
173
cristy5cadd612009-09-21 19:33:41 +0000174<p class="navigation-index">
cristy5063d812010-10-19 16:28:10 +0000175[ <a href="../www/command-line-options.html#adaptive-blur">&#x2011;adaptive&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adaptive-resize">&#x2011;adaptive&#x2011;resize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adaptive-sharpen">&#x2011;adaptive&#x2011;sharpen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#adjoin">&#x2011;adjoin</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#affine">&#x2011;affine</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#alpha">&#x2011;alpha</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#annotate">&#x2011;annotate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#antialias">&#x2011;antialias</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#append">&#x2011;append</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#attenuate">&#x2011;attenuate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#authenticate">&#x2011;authenticate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-gamma">&#x2011;auto&#x2011;gamma</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-level">&#x2011;auto&#x2011;level</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#auto-orient">&#x2011;auto&#x2011;orient</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#backdrop">&#x2011;backdrop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#background">&#x2011;background</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bench">&#x2011;bench</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bias">&#x2011;bias</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blackpoint-compensation">&#x2011;blackpoint&#x2011;compensation</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#black-threshold">&#x2011;black&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blend">&#x2011;blend</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blue-primary">&#x2011;blue&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blue-shift">&#x2011;blue&#x2011;shift</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#blur">&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#border">&#x2011;border</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#bordercolor">&#x2011;bordercolor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#borderwidth">&#x2011;borderwidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#brightness-contrast">&#x2011;brightness&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cache">&#x2011;cache</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#caption">&#x2011;caption</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cdl">&#x2011;cdl</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#channel">&#x2011;channel</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#charcoal">&#x2011;charcoal</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#chop">&#x2011;chop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clamp">&#x2011;clamp</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip">&#x2011;clip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip-mask">&#x2011;clip&#x2011;mask</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clip-path">&#x2011;clip&#x2011;path</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clone">&#x2011;clone</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#clut">&#x2011;clut</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#coalesce">&#x2011;coalesce</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colorize">&#x2011;colorize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colormap">&#x2011;colormap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#color-matrix">&#x2011;color&#x2011;matrix</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colors">&#x2011;colors</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#colorspace">&#x2011;colorspace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#combine">&#x2011;combine</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#comment">&#x2011;comment</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#compose">&#x2011;compose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#composite">&#x2011;composite</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#compress">&#x2011;compress</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#contrast">&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#contrast-stretch">&#x2011;contrast&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#convolve">&#x2011;convolve</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#crop">&#x2011;crop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#cycle">&#x2011;cycle</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#debug">&#x2011;debug</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#decipher">&#x2011;decipher</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#deconstruct">&#x2011;deconstruct</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#define">&#x2011;define</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#delay">&#x2011;delay</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#delete">&#x2011;delete</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#density">&#x2011;density</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#depth">&#x2011;depth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#descend">&#x2011;descend</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#deskew">&#x2011;deskew</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#despeckle">&#x2011;despeckle</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#direction">&#x2011;direction</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#displace">&#x2011;displace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#display">&#x2011;display</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dispose">&#x2011;dispose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dissimilarity-threshold">&#x2011;dissimilarity&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dissolve">&#x2011;dissolve</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#distort">&#x2011;distort</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#dither">&#x2011;dither</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#draw">&#x2011;draw</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#edge">&#x2011;edge</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#emboss">&#x2011;emboss</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#encipher">&#x2011;encipher</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#encoding">&#x2011;encoding</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#endian">&#x2011;endian</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#enhance">&#x2011;enhance</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#equalize">&#x2011;equalize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#evaluate">&#x2011;evaluate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#evaluate-sequence">&#x2011;evaluate&#x2011;sequence</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#extent">&#x2011;extent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#extract">&#x2011;extract</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#family">&#x2011;family</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#features">&#x2011;features</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fft">&#x2011;fft</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fill">&#x2011;fill</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#filter">&#x2011;filter</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flatten">&#x2011;flatten</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flip">&#x2011;flip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#floodfill">&#x2011;floodfill</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#flop">&#x2011;flop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#font">&#x2011;font</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#foreground">&#x2011;foreground</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#format">&#x2011;format</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#format_identify_">&#x2011;format[identify]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#frame">&#x2011;frame</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#frame_import_">&#x2011;frame[import]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#function">&#x2011;function</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fuzz">&#x2011;fuzz</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#fx">&#x2011;fx</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gamma">&#x2011;gamma</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gaussian-blur">&#x2011;gaussian&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#geometry">&#x2011;geometry</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#gravity">&#x2011;gravity</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#green-primary">&#x2011;green&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#hald-clut">&#x2011;hald&#x2011;clut</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#help">&#x2011;help</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#highlight-color">&#x2011;highlight&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#iconGeometry">&#x2011;iconGeometry</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#iconic">&#x2011;iconic</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#identify">&#x2011;identify</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ift">&#x2011;ift</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#immutable">&#x2011;immutable</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#implode">&#x2011;implode</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#insert">&#x2011;insert</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#intent">&#x2011;intent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interlace">&#x2011;interlace</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interpolate">&#x2011;interpolate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interline-spacing">&#x2011;interline&#x2011;spacing</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#interword-spacing">&#x2011;interword&#x2011;spacing</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#kerning">&#x2011;kerning</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#label">&#x2011;label</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#lat">&#x2011;lat</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#layers">&#x2011;layers</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#level">&#x2011;level</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#level-colors">&#x2011;level&#x2011;colors</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#limit">&#x2011;limit</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#linear-stretch">&#x2011;linear&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#linewidth">&#x2011;linewidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#liquid-rescale">&#x2011;liquid&#x2011;rescale</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#list">&#x2011;list</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#log">&#x2011;log</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#loop">&#x2011;loop</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#lowlight-color">&#x2011;lowlight&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#magnify">&#x2011;magnify</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#map">&#x2011;map</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#map_stream_">&#x2011;map[stream]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mask">&#x2011;mask</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mattecolor">&#x2011;mattecolor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#median">&#x2011;median</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#metric">&#x2011;metric</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mode">&#x2011;mode</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#modulate">&#x2011;modulate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#monitor">&#x2011;monitor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#monochrome">&#x2011;monochrome</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#morph">&#x2011;morph</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#morphology">&#x2011;morphology</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#mosaic">&#x2011;mosaic</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#motion-blur">&#x2011;motion&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#name">&#x2011;name</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#negate">&#x2011;negate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#noise">&#x2011;noise</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#normalize">&#x2011;normalize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#opaque">&#x2011;opaque</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ordered-dither">&#x2011;ordered&#x2011;dither</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#orient">&#x2011;orient</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#page">&#x2011;page</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#paint">&#x2011;paint</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#path">&#x2011;path</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pause_animate_">&#x2011;pause[animate]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pause_import_">&#x2011;pause[import]</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pen">&#x2011;pen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#ping">&#x2011;ping</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#pointsize">&#x2011;pointsize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#polaroid">&#x2011;polaroid</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#posterize">&#x2011;posterize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#precision">&#x2011;precision</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#preview">&#x2011;preview</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#print">&#x2011;print</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#process">&#x2011;process</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#profile">&#x2011;profile</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quality">&#x2011;quality</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quantize">&#x2011;quantize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#quiet">&#x2011;quiet</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#radial-blur">&#x2011;radial&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#raise">&#x2011;raise</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#random-threshold">&#x2011;random&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#red-primary">&#x2011;red&#x2011;primary</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#regard-warnings">&#x2011;regard&#x2011;warnings</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#region">&#x2011;region</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#remap">&#x2011;remap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#remote">&#x2011;remote</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#render">&#x2011;render</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#repage">&#x2011;repage</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#resample">&#x2011;resample</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#resize">&#x2011;resize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#respect-parentheses">&#x2011;respect&#x2011;parentheses</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#reverse">&#x2011;reverse</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#roll">&#x2011;roll</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#rotate">&#x2011;rotate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sample">&#x2011;sample</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sampling-factor">&#x2011;sampling&#x2011;factor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#scale">&#x2011;scale</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#scene">&#x2011;scene</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#screen">&#x2011;screen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#seed">&#x2011;seed</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#segment">&#x2011;segment</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#selective-blur">&#x2011;selective&#x2011;blur</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#separate">&#x2011;separate</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sepia-tone">&#x2011;sepia&#x2011;tone</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#set">&#x2011;set</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shade">&#x2011;shade</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shadow">&#x2011;shadow</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shared-memory">&#x2011;shared&#x2011;memory</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sharpen">&#x2011;sharpen</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shave">&#x2011;shave</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#shear">&#x2011;shear</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sigmoidal-contrast">&#x2011;sigmoidal&#x2011;contrast</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#silent">&#x2011;silent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#size">&#x2011;size</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sketch">&#x2011;sketch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#snaps">&#x2011;snaps</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#solarize">&#x2011;solarize</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#sparse-color">&#x2011;sparse&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#splice">&#x2011;splice</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#spread">&#x2011;spread</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stegano">&#x2011;stegano</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stereo">&#x2011;stereo</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stretch">&#x2011;stretch</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#strip">&#x2011;strip</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#stroke">&#x2011;stroke</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#strokewidth">&#x2011;strokewidth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#style">&#x2011;style</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#subimage-search">&#x2011;subimage&#x2011;search</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#swap">&#x2011;swap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#swirl">&#x2011;swirl</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#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 +0000176
cristyb36feb22010-03-26 16:54:37 +0000177<p>Below is list of command-line options recognized by the ImageMagick <a
178href="../www/command-line-tools.html">command-line
179tools</a>. If you want a description of a particular option, click on the
180option name in the navigation bar above and you will go right to it. Unless
cristya8902942010-07-30 00:49:52 +0000181otherwise noted, each option is recognized by the commands <a href="../www/convert.html">convert</a>, <a href="../www/mogrify.html">mogrify</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000182
183<div style="margin: auto;">
184 <h4><a name="adaptive-blur" id="adaptive-blur"></a>-adaptive-blur <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
185</div>
186
187<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Adaptively blur pixels, with decreasing effect near edges.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +0000188<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>
189
190<div style="margin: auto;">
191 <h4><a name="adaptive-resize" id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
192</div>
193
194<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>
195
196<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>
197
198<div style="margin: auto;">
199 <h4><a name="adaptive-sharpen" id="adaptive-sharpen"></a>-adaptive-sharpen <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
200</div>
201
202<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>
203
204<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>
205
206<div style="margin: auto;">
207 <h4><a name="adjoin" id="adjoin"></a>-adjoin</h4>
208</div>
209
210<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>
211
212<p>This option is enabled by default. An attempt is made to save all
213images of an image sequence into the given output file.
214However, some formats, such as JPEG and PNG, do not support more than one
215image per file, and in that case ImageMagick is forced to write each image as a separate file. As
216such, if more than one image needs to be written, the filename given is
217modified by adding a <a href="#scene">-scene</a> number before the
218suffix, in order to make distinct names for each image. </p>
219
220<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written
221to separate files, whether or not the file format allows multiple images
222per file (for example, GIF, MIFF, and TIFF). </p>
223
224<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>
225
226<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: rose: -morph 15 my%02dmorph.jpg</span></p>
227<p>will create a sequence of 17 images named my00morph.jpg, my01morph.jpg, my02morph.jpg, ..., my16morph.jpg.
228</p>
229
230<p>In summary, ImageMagick tries to write all images to one file, but will use
cristyefb2bdb2010-11-20 19:35:22 +0000231multiple files if either<br>
232 (1) the output image's file format does not allow multi-image files,<br>
233 (2) the <a href="#adjoin">+adjoin</a> option is given, or<br>
234 (3) a C-style integer format string is present in the output filename. </p>
cristy3ed852e2009-09-05 21:47:34 +0000235
236
237<div style="margin: auto;">
238 <h4><a name="affine" id="affine"></a>-affine <em class="arg">s<sub>x</sub></em>,<em class="arg">r<sub>x</sub></em>,<em class="arg">r<sub>y</sub></em>,<em class="arg">s<sub>y</sub></em>,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em><br/>
239 -affine <em class="arg">s<sub>x</sub></em>,<em class="arg">r<sub>x</sub></em>,<em class="arg">r<sub>y</sub></em>,<em class="arg">s<sub>y</sub></em></h4>
240</div>
241
242<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the drawing transformation matrix for combined rotating and scaling.</td><td style='text-align:right;'></td></tr></table>
243
244<p>This option sets a transformation matrix, encoded as (<em class="arg">s<sub>x</sub></em>, <em class="arg">r<sub>x</sub></em>, <em class="arg">r<sub>y</sub></em>, <em class="arg">s<sub>y</sub></em>, <em class="arg">t<sub>x</sub></em>, <em class="arg">t<sub>y</sub></em>), for use by subsequent <a href="#draw">-draw</a> or <a href="#transform">-transform</a> options.</p>
245
246<p>The matrix entries are entered as comma-separated numeric values <i>with no spaces</i>. </p>
247
248<p>Internally, the transformation matrix has 3x3 elements, but three of them are omitted from the input because they are constant. The new (transformed) coordinates (<em class="arg">x'</em>, <em class="arg">y'</em>) of a pixel at position (<em class="arg">x</em>, <em class="arg">y</em>) in the original image are calculated using the following matrix equation.</p>
249
250<div class="eqn">
251<img alt="affine transformation" src="../images/affine.png"/>
252</div>
253
254<p>
255The size of the resulting image is that of the smallest rectangle that contains the transformed source image. The parameters <em class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em> subsequently shift the image pixels so that those that are moved out of the image area are cut off.</p>
256
257<p>The transformation matrix complies with the left-handed pixel coordinate system: positive <em class="arg">x</em> and <em class="arg">y</em> directions are rightward and downward, resp.; positive rotation is clockwise.</p>
258
259<p> If the translation coefficients <em class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em> are omotted they default to 0,0. Therefore, four parameters suffice for rotation and scaling without translation.</p>
260
261<p>Scaling by the factors <em class="arg">s<sub>x</sub></em> and <em class="arg">s<sub>y</sub></em> in the <em>x</em> and <em>y</em> directions, respectively, is accomplished with the following.</p>
262
263<p class="crtsnip">
264 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
265</p>
266
267<p>Translation by a displacement (<em class="arg">t<sub>x</sub></em>, <em class="arg">t<sub>y</sub></em>) is accomplished like so:</p>
268
269<p class="crtsnip">
270 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
271</p>
272
273<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
274<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
275
276<p class="crtsnip">
277 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
278</p>
279
280<p>The cumulative effect of a sequence of <a href="#affine" >-affine</a> transformations can be accomplished by instead by a single <a href="#affine" >-affine</a> operation using the matrix equal to the product of the matrices of the individual transformations.</p>
281
282<p>An attempt is made to detect near-singular transformation matrices. If the matrix determinant has a sufficiently small absolute value it is rejected.</p>
283
284<div style="margin: auto;">
285 <h4><a name="alpha" id="alpha"></a>-alpha <em class="arg">type</em></h4>
286</div>
287
288<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Gives control of the alpha/matte channel of an image.</td><td style='text-align:right;'></td></tr></table>
289
290<p>Used to set a flag on an image indicating whether or not to use existing alpha
291channel data, to create an alpha channel, or to perform other operations on the alpha channel. Choose the argument <em class="arg">type</em> from the list below.</p>
292
293
294<table class="doc">
295 <tbody>
296 <tr valign="top">
297 <th align="left" style="width: 8%">type</th>
298 <th align="left">Description</th>
299 </tr>
300
301 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000302 <td valign="top"><kbd>Activate</kbd> or <kbd>On</kbd></td>
cristy83a272e2010-05-07 20:40:35 +0000303 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000304 Enable the image's transparency channel. Note normally <kbd>Set</kbd>
305 should be used instead of this, unless you specifically need to
306 preserve existing (but specifically turned <kbd>Off</kbd>) transparency
307 channel. </td></tr>
cristy83a272e2010-05-07 20:40:35 +0000308
309 <tr valign="top">
cristybac7a162010-06-15 19:57:29 +0000310 <td valign="top"><kbd>Deactivate</kbd> or <kbd>Off</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +0000311 <td valign="top">
312 Disables the image's transparency channel. Does not delete or change the
cristy83a272e2010-05-07 20:40:35 +0000313 existing data, just turns off the use of that data.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000314
315 <tr valign="top">
316 <td valign="top"><kbd>Set</kbd></td>
317 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000318 Activates the alpha/matte channel. If it was previously turned off
319 then it also resets the channel to opaque. If the image already had
320 the alpha channel turned on, it will have no effect.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000321
322 <tr valign="top">
323 <td valign="top"><kbd>Opaque</kbd></td>
324 <td valign="top">
cristybac7a162010-06-15 19:57:29 +0000325 Enables the alpha/matte channel and forces it to be fully opaque.
326 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000327
328 <tr valign="top">
329 <td valign="top"><kbd>Transparent</kbd></td>
330 <td valign="top">
cristy83a272e2010-05-07 20:40:35 +0000331 Activates the alpha/matte channel and forces it to be fully
cristybac7a162010-06-15 19:57:29 +0000332 transparent. This effectively creates a fully transparent image the
333 same size as the original and with all its original RGB data still
334 intact, but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000335
336 <tr valign="top">
337 <td valign="top"><kbd>Extract</kbd></td>
338 <td valign="top">
339 Copies the alpha channel values into all the color channels and turns
cristybac7a162010-06-15 19:57:29 +0000340 '<kbd>Off</kbd>' the the image's transparency, so as to generate
341 a gray-scale mask of the image's shape. The alpha channel data is left
342 intact just deactivated. This is the inverse of '<kbd>Copy</kbd>'.
343 </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000344
345 <tr valign="top">
346 <td valign="top"><kbd>Copy</kbd></td>
347 <td valign="top">
348 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
cristybac7a162010-06-15 19:57:29 +0000349 gray-scale intensity of the image, into the alpha channel, converting
350 a gray-scale mask into a transparent shaped mask ready to be colored
351 appropriately. The color channels are not modified. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000352
353 <tr valign="top">
354 <td valign="top"><kbd>Shape</kbd></td>
355 <td valign="top">
356 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000357 the current background color. That is the RGB color channels is
358 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000359 </td></tr>
360
361 <tr valign="top">
362 <td valign="top"><kbd>Background</kbd></td>
363 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000364 Set any fully-transparent pixel to the background color, while leaving
365 it fully-transparent. This can make some image file formats, such as
366 PNG, smaller as the RGB values of transparent pixels are more uniform,
367 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000368 </td></tr>
369 </tbody>
370</table>
371
372<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
cristybac7a162010-06-15 19:57:29 +0000373"<kbd><a href="#alpha" >-alpha</a> Off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000374>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
cristybac7a162010-06-15 19:57:29 +0000375Set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> On</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +0000376
377
378<div style="margin: auto;">
379 <h4><a name="annotate" id="annotate"></a>
380 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
381 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
382 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> {+-}<em class="arg">t<sub>x</sub></em>{+-}<em class="arg">t<sub>y</sub></em> <em class="arg">text</em></h4>
383</div>
384
385<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Annotate an image with text.</td><td style='text-align:right;'></td></tr></table>
386
387<p>This is a convenience for annotating an image with text. For more precise control over text annotations, use <a href="#draw">-draw</a>.</p>
388
389
390<p>The values <em class="arg">Xdegrees</em> and <em class="arg">Ydegrees</em> control the shears with respect to the , respectively, applied to the text, while <em class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em> are offsets that give the location of the text relative to the upper left corner of the image.</p>
391
392<p>Using <a href="#annotate">-annotate</a>&nbsp;<em class="arg">degrees</em> or <a href="#annotate">-annotate</a>&nbsp;<em class="arg">degrees</em>x<em class="arg">degrees</em> produces an unsheared rotation of the text. The direction of the rotation is positive, which means a clockwise rotation if <em class="arg">degrees</em> is positive. (This conforms to the usual mathematical convention once it is realized that the positive <em>y</em>&ndash;direction is conventionally considered to be <em>downward</em> for images.)</p>
393
394<p>The new (transformed) coordinates (<em class="arg">x'</em>, <em class="arg">y'</em>) of a pixel at position (<em class="arg">x</em>, <em class="arg">y</em>) in the image are calculated using the following matrix equation.</p>
395<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
396
397<p>If <em class="arg">t<sub>x</sub></em> and <em class="arg">t<sub>y</sub></em> are omitted, they default to 0. This makes the bottom-left of the text becomes the upper-left corner of the image, which is probably undesirable. Adding a <a href="#gravity" >-gravity</a> option in this case leads to nice results.</p>
398
399<p>Text is any UTF-8 encoded character sequence. If <em class="arg">text</em> is of the form '@mytext.txt', the text is read from the file <kbd>mytext.txt</kbd>. Text in a file is taken literally; no embedded formatting characters are recognized.</p>
400
401<div style="margin: auto;">
402 <h4><a name="antialias" id="antialias"></a>-antialias</h4>
403</div>
404
405<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Enable/Disable of the rendering of anti-aliasing pixels when
406drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
407
408<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
409drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
410antialiasing edge pixels. This will then reduce the number of colors added to
411an image to just the colors being directly drawn. That is, no mixed colors
cristyd0bd44a2010-09-24 12:38:11 +0000412are added when drawing such objects. </p>
cristy3ed852e2009-09-05 21:47:34 +0000413
414<div style="margin: auto;">
415 <h4><a name="append" id="append"></a>-append</h4>
416</div>
417
418<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Join current images vertically or horizontally.</td><td style='text-align:right;'></td></tr></table>
419
420<p>This option creates a single longer image image, by joining all the current
421images in sequence top-to-bottom. Use <a href="#append">+append</a> to
422stack images left-to-right. </p>
423
424<p>If they are not of the same width, narrower images are padded with the
425current <a href="#background">-background</a> color setting, and their
cristyd0bda5e2010-09-21 16:22:45 +0000426position relative to each other can be controlled by the current <a
cristy3ed852e2009-09-05 21:47:34 +0000427href="#gravity">-gravity</a> setting. </p>
428
429
430<div style="margin: auto;">
431 <h4><a name="attenuate" id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
432</div>
433
434<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Lessen (or intensify) when adding noise to an image.</td><td style='text-align:right;'></td></tr></table>
435
436
437<div style="margin: auto;">
438 <h4><a name="authenticate" id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
439</div>
440
441<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Decrypt a PDF with a password.</td><td style='text-align:right;'></td></tr></table>
442
443<p>Use this option to supply a <em class="arg">password</em> for decrypting a PDF that has been encrypted using Microsoft Crypto API (MSC API). The encrypting using the MSC API is not supported.</p>
444
445<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
446
cristyd934d102009-10-10 12:55:13 +0000447
448
cristy3ed852e2009-09-05 21:47:34 +0000449<div style="margin: auto;">
450 <h4><a name="auto-gamma" id="auto-gamma"></a>-auto-gamma</h4>
451</div>
452
453<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Automagically adjust gamma level of image.</td><td style='text-align:right;'></td></tr></table>
454
cristyd934d102009-10-10 12:55:13 +0000455<p>This calculates the mean values of an image, then applies a calculated <a
456href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
457image it will get a have a value of 50%. </p>
458
cristyd0bd44a2010-09-24 12:38:11 +0000459<p>This means that any solid 'gray' image becomes 50% gray. </p>
cristyd934d102009-10-10 12:55:13 +0000460
461<p>This works well for real-life images with little or no extreme dark and
462light areas, but tend to fail for images with large amounts of bright sky or
cristyd0bda5e2010-09-21 16:22:45 +0000463dark shadows. It also does not work well for diagrams or cartoon like images.
cristyd934d102009-10-10 12:55:13 +0000464</p>
465
466<p>It uses the <a href="#channel" >-channel</a> setting, (including the
467'<CODE>sync</CODE>' flag for channel syncronization), to determine which color
cristyd0bd44a2010-09-24 12:38:11 +0000468values is used and modified. As the default <a href="#channel"
469>-channel</a> setting is '<CODE>RGB,sync</CODE>', channels are modified
cristyd934d102009-10-10 12:55:13 +0000470together by the same gamma value, preserving colors. </p>
471
472
473
cristy3ed852e2009-09-05 21:47:34 +0000474<div style="margin: auto;">
475 <h4><a name="auto-level" id="auto-level"></a>-auto-level</h4>
476</div>
477
478<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Automagically adjust color levels of image.</td><td style='text-align:right;'></td></tr></table>
479
cristyd934d102009-10-10 12:55:13 +0000480<p>This is a 'perfect' image normalization operator. It finds the exact
cristyd0bda5e2010-09-21 16:22:45 +0000481minimum and maximum color values in the image and then applies a <a
cristyd934d102009-10-10 12:55:13 +0000482href="#level" >-level</a> operator to stretch the values to the full range of
483values. </p>
484
cristy83543962009-10-16 19:04:28 +0000485<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000486JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
487for the <a href="#level" >-level</a> operation. On the other hand it is the
488right operator to use for color stretching gradient images being used to
489generate Color lookup tables, distortion maps, or other 'mathematically'
490defined images. </p>
491
492<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
493href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
494>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
495problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000496>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000497
498<p>It uses the <a href="#channel" >-channel</a> setting, (including the
499special '<CODE>sync</CODE>' flag for channel syncronization), to determine
cristyd0bd44a2010-09-24 12:38:11 +0000500which color values are used and modified. As the default <a
cristy83543962009-10-16 19:04:28 +0000501href="#channel" >+channel</a> setting is '<CODE>RGB,sync</CODE>', the
cristyd0bd44a2010-09-24 12:38:11 +0000502'<CODE>sync</CODE>' ensures that the color channels will are modified
cristy83543962009-10-16 19:04:28 +0000503together by the same gamma value, preserving colors, and ignoring
504transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000505
506
cristy3ed852e2009-09-05 21:47:34 +0000507<div style="margin: auto;">
508 <h4><a name="auto-orient" id="auto-orient"></a>-auto-orient</h4>
509</div>
510
511<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Automagically orient (rotate) an image created by a digital camera.</td><td style='text-align:right;'></td></tr></table>
512
cristy83543962009-10-16 19:04:28 +0000513<p>This operator reads and resets the EXIF image profile setting 'Orientation'
514and then performs the appropriate 90 degree rotation on the image to orient
515the image, for correct viewing. </p>
516
517<p>This EXIF profile setting is usually set using a gravity sensor in digital
518camara, however photos taken directly downward or upward may not have an
519appropriate value. Also images that have been orientation 'corrected' without
520reseting this setting, may be 'corrected' again resulting in a incorrect
521result. If the he EXIF profile was previously stripped, the <a
522href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
523
524
cristy3ed852e2009-09-05 21:47:34 +0000525<div style="margin: auto;">
526 <h4><a name="average" id="average"></a>-average</h4>
527</div>
528
529<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Average a set of images.</td><td style='text-align:right;'></td></tr></table>
530
531<p>An error results if the images are not identically sized.</p>
532
cristy3ed852e2009-09-05 21:47:34 +0000533
534<div style="margin: auto;">
535 <h4><a name="backdrop" id="backdrop"></a>-backdrop</h4>
536</div>
537
538<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Display the image centered on a backdrop.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>]</td></tr></table>
539
540<p>This backdrop covers the entire workstation screen and is useful for hiding other X window activity while viewing the image. The color of the backdrop is specified as the background color. The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
541
542<div style="margin: auto;">
543 <h4><a name="background" id="background"></a>-background <em class="arg">color</em></h4>
544</div>
545
546<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the background color.</td><td style='text-align:right;'></td></tr></table>
547
548<p>The color is specified using the format described under the <a href="#fill">-fill</a> option. The default background color (if none is specified or found in the image) is white.</p>
549
550<div style="margin: auto;">
551 <h4><a name="bench" id="bench"></a>-bench <em class="arg">iterations</em></h4>
552</div>
553
554<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Measure performance.</td><td style='text-align:right;'></td></tr></table>
555
cristye6378132009-10-26 20:05:17 +0000556<p>Repeat the entire command for the given number of <em class="arg">iterations</em> and report the user-time and elapsed time. For instance, consider the following command and its output. Modify the benchmark with the -duration to run the benchmark for a fixed number of seconds and -concurrent to run the benchmark in parallel (requires the OpenMP feature).</p>
cristy3ed852e2009-09-05 21:47:34 +0000557
cristye6378132009-10-26 20:05:17 +0000558<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -resize 1000% -bench 5 logo.png</span><span class='crtout'>Performance: 5i 0.875657ips 6.880u 0:05.710</span></p>
559<p>In this example, 5 iterations were completed at 0.875657 iterations per second, using 6.88 seconds of the user's allotted time, for a total elapsed time of 5.71 seconds.</p>
cristy3ed852e2009-09-05 21:47:34 +0000560
561<div style="margin: auto;">
562 <h4><a name="bias" id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
563</div>
564
565<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Add bias when convolving an image.</td><td style='text-align:right;'></td></tr></table>
566
567<p>This option shifts the output of <a href="../www/command-line-options.html#convolve">&#x2011;convolve</a> so that positive and negative results are relative to the specified bias value. </p>
568
569<p>This is important for non-HDRI compilations of ImageMagick when dealing with convolutions that contain negative as well as positive values. This is especially the case with convolutions involving high pass filters or edge detection. Without an output bias, the negative values are clipped at zero.</p>
570
571<p>When using an ImageMagick with the HDRI compile-time setting, <a href="../www/command-line-options.html#bias">&#x2011;bias</a> is not needed, as ImageMagick is able to store/handle any
572negative results without clipping to the color value range
573(0..QuantumRange).</p>
574
575<p>See the discussion on HDRI implementations of ImageMagick on the page
576<a href="/www/high-dynamic-range.html">High Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this <a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a> entry.
577</p>
578
579<div style="margin: auto;">
580 <h4><a name="black-point-compensation" id="black-point-compensation"></a>-black-point-compensation</h4>
581</div>
582
583<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Use black point compensation.</td><td style='text-align:right;'></td></tr></table>
584
585<div style="margin: auto;">
cristy5cadd612009-09-21 19:33:41 +0000586 <h4><a name="black-threshold" id="black-threshold"></a>-black-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +0000587</div>
588
cristy5cadd612009-09-21 19:33:41 +0000589<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Force to black all pixels below the threshold while leaving all pixels at or above the threshold unchanged.</td><td style='text-align:right;'></td></tr></table>
590
591<p> The threshold value can be given as a percentage or as an absolute integer value within [0,&nbsp;<em class="QR">QuantumRange</em>] corresponding to the desired <a href="../www/command-line-options.html#channel">&#x2011;channel</a> value. See <a href="../www/command-line-options.html#threshold">&#x2011;threshold</a> for more details on thresholds and resulting values.
592</p>
cristy3ed852e2009-09-05 21:47:34 +0000593
594
595<div style="margin: auto;">
cristy83a272e2010-05-07 20:40:35 +0000596 <h4><a name="blend" id="blend"></a>-blend <em class="arg">geometry</em></h4>
cristy3ed852e2009-09-05 21:47:34 +0000597</div>
598
cristy83a272e2010-05-07 20:40:35 +0000599<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>blend an image into another by the given absolute value or percent.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +0000600
601<p>Blend will average the images together ('plus') according to the
602percentages given and each pixels transparency. If only a single percentage
603value is given it sets the weight of the composite or 'source' image, while
604the background image is weighted by the exact opposite amount. That is a
cristy83a272e2010-05-07 20:40:35 +0000605<kbd>-blend 30%</kbd> merges 30% of the 'source' image with 70% of the
606'destination' image. Thus it is equivalent to <kbd>-blend 30x70%</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000607
608
609<div style="margin: auto;">
610 <h4><a name="blue-primary" id="blue-primary"></a>-blue-primary <em class="arg">x</em>,<em class="arg">y</em></h4>
611</div>
612
613<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the blue chromaticity primary point.</td><td style='text-align:right;'></td></tr></table>
614
615<div style="margin: auto;">
616 <h4><a name="blue-shift" id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
617</div>
618
619<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>simulate a scene at nighttime in the moonlight. Start with a factor of 1.5</td><td style='text-align:right;'></td></tr></table>
620
621<div style="margin: auto;">
622
623<div style="margin: auto;">
624 <h4><a name="blur" id="blur"></a>-blur <em class="arg">radius</em><br />-blur <em class="arg">radius</em>x<em class="arg">sigma</em></h4>
625</div>
626
627<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Reduce image noise and reduce detail levels.</td><td style='text-align:right;'></td></tr></table>
628
cristyb15553d2010-07-03 22:53:14 +0000629<p>Convolve the image with a Gaussian or normal distribution using the given
630<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000631
632<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
633</div>
634
cristyb15553d2010-07-03 22:53:14 +0000635<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +0000636determines the actual amount of blurring that will take place. </p>
cristy3ed852e2009-09-05 21:47:34 +0000637
cristyb15553d2010-07-03 22:53:14 +0000638<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +0000639array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +0000640integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +0000641radius that will provide meaningful results for the Gaussian distribution.
642</p>
643
644<p>The larger the <em class="arg" >Radius</em> the radius the slower the
645operation is. However too small a <em class="arg" >Radius</em>, and sever
646aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
647should be at least twice the <em class="arg" >Sigma</em> value, though three
648times will produce a more accurite result. </p>
649
650<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply
651by taking advantage of the separability properties of the distribution. Here
652we apply a single-dimensional Gaussian matrix in the horizontal direction,
653then repeat the process in the vertical direction.</p>
cristy3ed852e2009-09-05 21:47:34 +0000654
655<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
656pixels which are outside the image proper are blurred into the final result.
657</p>
658
659
660<div style="margin: auto;">
661 <h4><a name="blur-composite" id="blur"></a>-blur <em class="arg">Width</em>[x<em class="arg">Height</em>[+<em class="arg">Angle</em>]]</h4>
662</div>
663
664<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Variably blur and image according to the overlay mapping.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
665
666<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
667Average (EWA) of the source image, scaled according to the grayscale
668mapping. </p>
669
670<p>The ellipse is weighted with sigma set to the given <em class="arg"
671>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
672defaults to the <em class="arg" >Width</em> for a normal circular Guassian
673weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
674horizontal clock-wise. </p>
675
676<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
677pixels which are outside the image proper are blurred into the final result.
678</p>
679
680
681<div style="margin: auto;">
682 <h4><a name="border" id="border"></a>-border <em class="arg">geometry</em></h4>
683</div>
684
685<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Surround the image with a border of color. </td><td style='text-align:right;'></td></tr></table>
686
cristybc9539a2010-08-16 18:06:20 +0000687<p>Set the width and height using the <em class="arg">size</em> portion of the
688<em class="arg">gravity</em> argument. See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Offsets are
689ignored. </p>
cristy3ed852e2009-09-05 21:47:34 +0000690
cristybc9539a2010-08-16 18:06:20 +0000691<p>Set the border color by preceding with the <a
692href="#bordercolor">-bordercolor</a> setting.</p>
cristy3ed852e2009-09-05 21:47:34 +0000693
cristybc9539a2010-08-16 18:06:20 +0000694<p>The <a href="#border">-border</a> operation is affected by the current <a
695href="#compose">-compose</a> setting and assumes that this is using the default
696'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
697size colors by the current <a href="#bordercolor">-bordercolor</a> before
698overlaying the original image in the center of this net image. This means that
699with the default compose method of '<kbd>Over</kbd>' any transparent parts may
cristyd0bda5e2010-09-21 16:22:45 +0000700be replaced by the current <a href="#bordercolor">-bordercolor</a> setting.</p>
cristybc9539a2010-08-16 18:06:20 +0000701<p>See also the <a href="#frame">-frame</a> option, which has more
702functionality.</p>
cristy3ed852e2009-09-05 21:47:34 +0000703
704<div style="margin: auto;">
705 <h4><a name="bordercolor" id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
706</div>
707
708<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the border color.</td><td style='text-align:right;'></td></tr></table>
709
710<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
711
712<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
713
714<div style="margin: auto;">
715 <h4><a name="borderwidth" id="borderwidth"></a>-borderwidth <em class="arg">geometry</em> </h4>
716</div>
717
718<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Set the border width.</td><td style='text-align:right;'>[<a href="../www/animate.html">animate</a>, <a href="../www/display.html">display</a>]</td></tr></table>
719
720<div style="margin: auto;">
cristy16ff93c2010-01-13 23:18:07 +0000721 <h4><a name="brightness-contrast" id="brightness-contrast"></a>-brightness-contrast <em class="arg">brightness</em><br />-brightness-contrast <em class="arg">brightness</em>{x<em class="arg">contrast</em>}{<em class="arg">%</em>}}</h4>
722</div>
723
724<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Adjust the brightness and/or contrast of the image.</td><td style='text-align:right;'></td></tr></table>
725
cristyefb2bdb2010-11-20 19:35:22 +0000726<p>Brightness and Contrast values apply changes to the input image. They are
727not absolute settings. A brightness or contrast value of zero means no change.
728The range of values is -100 to +100 on each. Positive values increase the
729brightness or contrast and negative values decrease the brightness or contrast.
730To control only contrast, set the brightness=0. To control only brightness,
731set contrast=0 or just leave it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000732
cristyefb2bdb2010-11-20 19:35:22 +0000733<p>You may also use <a href="#fill">-channel</a> to control which channels to
734apply the brightness and/or contrast change. The default is to apply the same
735transformation to all channels.</p>
cristy16ff93c2010-01-13 23:18:07 +0000736
cristyefb2bdb2010-11-20 19:35:22 +0000737<p>Brightness and Contrast arguments are converted to offset and slope of a
738linear transform and applied
739using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
cristy16ff93c2010-01-13 23:18:07 +0000740
cristyefb2bdb2010-11-20 19:35:22 +0000741<p>The slope varies from 0 at contrast=-100 to almost vertical at
742contrast=+100. For brightness=0 and contrast=-100, the result are totally
743midgray. For brightness=0 and contrast=+100, the result will approach but
744not quite reach a threshold at midgray; that is the linear transformation
745is a very steep vertical line at mid gray.</p>
cristy16ff93c2010-01-13 23:18:07 +0000746
cristyefb2bdb2010-11-20 19:35:22 +0000747<p>Negative slopes, i.e. negating the image, are not possible with this
748function. All achievable slopes are zero or positive.</p>
cristy16ff93c2010-01-13 23:18:07 +0000749
cristyefb2bdb2010-11-20 19:35:22 +0000750<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5
751at brightness=+100. Thus, when contrast=0 and brightness=100, the result is
752totally white. Similarly, when contrast=0 and brightness=-100, the result is
753totally black.</p>
cristy16ff93c2010-01-13 23:18:07 +0000754
cristyefb2bdb2010-11-20 19:35:22 +0000755<p>As the range of values for the arguments are -100 to +100, adding the '%'
756symbol is no different than leaving it off.</p>
cristy16ff93c2010-01-13 23:18:07 +0000757
758<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +0000759 <h4><a name="cache" id="cache"></a>-cache <em class="arg">threshold</em></h4>
760</div>
761
762<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>
763
764<div style="margin: auto;">
765 <h4><a name="caption" id="caption"></a>-caption <em class="arg">string</em></h4>
766</div>
767
768<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>
769
cristy71a3f602010-09-15 12:38:16 +0000770<p>This option sets the caption meta-data of an image read in after this
771option has been given. To modify a caption of images already in memory use
772"<kbd><a href="#set">-set</a> caption</kbd>". </p>
773
774<p>The caption can contain special format characters listed in the <a
775href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +0000776Print Image Properties</a>. These attributes are expanded when the caption
cristy71a3f602010-09-15 12:38:16 +0000777is finally assigned to the individual images. </p>
778
779<p>If the first character of <em class="arg">string</em> is <em
780class="arg">@</em>, the image caption is read from a file titled by the
781remaining characters in the string. Comments read in from a file are literal;
782no embedded formatting characters are recognized.</p>
783
784<p>Caption meta-data ais not visible on the image itself. To do that use the
785<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
786instead.</p>
787
788<p>For example,</p>
789
790<p class="crtsnip">
791 -caption "%m:%f %wx%h" bird.miff
792</p>
793
794<p>produces an image caption of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
795that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
796480.</p>
797
798
cristy3ed852e2009-09-05 21:47:34 +0000799<div style="margin: auto;">
800 <h4><a name="cdl" id="cdl"></a>-cdl <em class="arg">filename</em></h4>
801</div>
802
803<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>
804
805<p>Here is an example color correction collection:</p>
806
807<pre class="text">
cristybac7a162010-06-15 19:57:29 +0000808&lt;?xml version="1.0" encoding="UTF-8"?&gt;
809&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2"&gt;
810 &lt;ColorCorrection id="cc06668"&gt;
811 &lt;SOPNode&gt;
812 &lt;Slope&gt; 0.9 1.2 0.5 &lt;/Slope&gt;
813 &lt;Offset&gt; 0.4 -0.5 0.6 &lt;/Offset&gt;
814 &lt;Power&gt; 1.0 0.8 1.5 &lt;/Power&gt;
815 &lt;/SOPNode&gt;
816 &lt;SATNode&gt;
817 &lt;Saturation&gt; 0.85 &lt;/Saturation&gt;
818 &lt;/SATNode&gt;
819 &lt;/ColorCorrection&gt;
820&lt;/ColorCorrectionCollection&gt;
cristy3ed852e2009-09-05 21:47:34 +0000821</pre>
822
823<div style="margin: auto;">
824 <h4><a name="channel" id="channel"></a>-channel <em class="arg">type</em></h4>
825</div>
826
827<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>
828
cristyefb2bdb2010-11-20 19:35:22 +0000829<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>,
830<kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>,
831<kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>,
832<kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000833
cristy83a272e2010-05-07 20:40:35 +0000834<p>The channels above can also be specified as a comma-separated list or can be
cristyd934d102009-10-10 12:55:13 +0000835abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
836'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
837'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000838
cristy83a272e2010-05-07 20:40:35 +0000839For example, to only select the <kbd>Red</kbd> and <kbd>Blue</kbd> channels
840you can either use </p>
cristy3ed852e2009-09-05 21:47:34 +0000841<p class="crtsnip">
cristy83a272e2010-05-07 20:40:35 +0000842 -channel Red,Blue
843</p>
844<p>or you can use the short hand form</p>
845<p class="crtsnip">
846 -channel RB
cristy3ed852e2009-09-05 21:47:34 +0000847</p>
848
cristy83a272e2010-05-07 20:40:35 +0000849<p>All the channels that is present in an image can be specified using the
cristybac7a162010-06-15 19:57:29 +0000850special channel type <kbd>All</kbd>. Not all operators are 'channel capable',
851but generally any operators that are generally 'grey-scale' image operators,
852will understand this setting. See individual operator documentation. </p>
853
854<br>
cristy83a272e2010-05-07 20:40:35 +0000855
856<p>On top of the normal channel selection a extra flag can be specified,
857'<kbd>Sync</kbd>'. This is turned on by default and if set means that
cristybac7a162010-06-15 19:57:29 +0000858operators that understand this flag should perform: cross-channel
859syncronization of the channels. If not specified, then most grey-scale
860operators will apply their image processing operations to each individual
861channel (as specified by the rest of the <a href="#channel">-channel</a>
cristyd0bda5e2010-09-21 16:22:45 +0000862setting) completely independently from each other. </p>
cristy83a272e2010-05-07 20:40:35 +0000863
864<p>For example for operators such as <a href="#auto-level">-auto-level</a> and
cristyd0bd44a2010-09-24 12:38:11 +0000865<a href="#auto-gamma">-auto-gamma</a> the color channels are modified
cristy83a272e2010-05-07 20:40:35 +0000866together in exactly the same way so that colors will remain in-sync. Without
cristyd0bd44a2010-09-24 12:38:11 +0000867it being set, then each channel is modified separately and
cristyd0bda5e2010-09-21 16:22:45 +0000868independently, which may produce color distortion. </p>
cristy83a272e2010-05-07 20:40:35 +0000869
cristybac7a162010-06-15 19:57:29 +0000870<p>The <a href="#morphology">-morphology</a> '<kdb>Convolve</kdb>' method
871and the <a href="#compose">-compose</a> mathematical methods, also understands
872the '<kbd>Sync</kbd>' flag to modify the behaviour of pixel colors according
873to the alpha channel (if present). That is to say it will modify the image
874processing with the understanding that fully-transparent colors should not
875contribute to the final result. </p>
876
877Basically, by default, operators work with color channels in syncronous, and
878treats transparency as special, unless the <a href="#channel">-channel</a>
879setting is modified so as to remove the effect of the '<kbd>Sync</kbd>' flag.
880How each operator does this depends on that operators current implementation.
881Not all operators understands this flag at this time, but that is changing.
882</p>
cristy83a272e2010-05-07 20:40:35 +0000883
884<p>To print a complete list of channel types, use <a href="#list">-list
885channel</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000886
cristybac7a162010-06-15 19:57:29 +0000887<br>
cristyd934d102009-10-10 12:55:13 +0000888
889<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
cristybac7a162010-06-15 19:57:29 +0000890'<kbd>RGBK,sync</kbd>', which specifies that operators act on all color
891channels except the transparency channel, and that all the color channels are
892to be modified in exactly the same way, with a understanding of transprancy
893(depending on the operation being applied). The 'plus' form <a
894href="#channel" >+channel</a> will reset the value back to this default. </p>
cristyd934d102009-10-10 12:55:13 +0000895
896<p>Options that are affected by the <a href="#channel" >-channel</a> setting
897include the following.
898
899<a href="#auto-gamma">-auto-gamma</a>,
900<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000901<a href="#black-threshold">-black-threshold</a>,
902<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000903<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000904<a href="#clut">-clut</a>,
905<a href="#combine">-combine</a>,
cristybac7a162010-06-15 19:57:29 +0000906<a href="#composite">-composite</a> (Mathematical compose methods only),
907<a href="#convolve">-convolve</a>,
cristy3ed852e2009-09-05 21:47:34 +0000908<a href="#contrast-stretch">-contrast-stretch</a>,
909<a href="#evaluate">-evaluate</a>,
910<a href="#function">-function</a>,
911<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000912<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000913<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000914<a href="#motion-blur">-motion-blur</a>,
cristybac7a162010-06-15 19:57:29 +0000915<a href="#morphology">-morphology</a>,
cristy3ed852e2009-09-05 21:47:34 +0000916<a href="#negate">-negate</a>,
917<a href="#normalize">-normalize</a>,
918<a href="#ordered-dither">-ordered-dither</a>,
919<a href="#radial-blur">-radial-blur</a>,
920<a href="#random-threshold">-random-threshold</a>,
cristybac7a162010-06-15 19:57:29 +0000921<a href="#separate">-separate</a>,
cristyd934d102009-10-10 12:55:13 +0000922<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000923<a href="#white-threshold">-white-threshold</a>.
924</p>
925
cristyd0bda5e2010-09-21 16:22:45 +0000926<p>Warning, some operators behave differently when the <a href="#channel"
cristyd934d102009-10-10 12:55:13 +0000927>+channel</a> default setting is in effect, verses ANY user defined <a
cristyd0bda5e2010-09-21 16:22:45 +0000928href="#channel" >-channel</a> setting (including the equivalent of the
cristy83a272e2010-05-07 20:40:35 +0000929default). These operators have yet to be made to understand the newer 'Sync'
930flag. </p>
931
cristybac7a162010-06-15 19:57:29 +0000932<p>For example <a href="#threshold">-threshold</a> will by default gray-scale
933the image before thresholding, if no <a href="#channel" >-channel</a> setting
934has been defined. This is not 'Sync flag controlled, yet. </p>
cristyd934d102009-10-10 12:55:13 +0000935
936<p>Also some operators such as <a href="#blur">-blur</a>, <a
937href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
938color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
939href="#channel" >-channel</a>. Generally this done to ensure that
940fully-transparent colors are treated as being fully-transparent, and thus any
941underlying 'hidden' color has no effect on the final results. Typically
cristybac7a162010-06-15 19:57:29 +0000942resulting in 'halo' effects. The newer <a href="#morphology">-morphology</a>
cristyd0bda5e2010-09-21 16:22:45 +0000943convolution equivalents however does have a understanding of the 'Sync' flag
cristybac7a162010-06-15 19:57:29 +0000944and will thus handle transparency correctly by default. </p>
cristyd934d102009-10-10 12:55:13 +0000945
cristybac7a162010-06-15 19:57:29 +0000946<p>As a alpha channel is optional within images, some operators will read the
cristyd934d102009-10-10 12:55:13 +0000947color channels of an image as a greyscale alpha mask, when the image has no
cristybac7a162010-06-15 19:57:29 +0000948alpha channel present, and the <a href="#channel" >-channel</a> setting tells
949the operator to apply the operation using alpha channels. The <a
950href="#clut">-clut</a> operator is a good example of this. </p>
cristyd934d102009-10-10 12:55:13 +0000951
cristy3ed852e2009-09-05 21:47:34 +0000952
953<div style="margin: auto;">
cristyb4c03bb2009-09-27 13:55:46 +0000954 <h4><a name="clamp" id="clamp"></a>-clamp</h4>
955</div>
956
957<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>
958
959<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +0000960 <h4><a name="charcoal" id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
961</div>
962
963<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>
964
965<div style="margin: auto;">
966 <h4><a name="chop" id="chop"></a>-chop <em class="arg">geometry</em></h4>
967</div>
968
969<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>
970
cristyefb2bdb2010-11-20 19:35:22 +0000971<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>
972and <em class="arg">height</em> given in the of the <em class="arg">size</em>
973portion of the <em class="arg">geometry</em> argument give the number of
974columns and rows to remove. The <em class="arg">offset</em> portion of
975the <em class="arg">geometry</em> argument is influenced by
976a <a href="#gravity">-gravity</a> setting, if present.</p>
cristy3ed852e2009-09-05 21:47:34 +0000977
cristyefb2bdb2010-11-20 19:35:22 +0000978<p>The <a href="#chop">-chop</a> option removes entire rows and columns,
979and moves the remaining corner blocks leftward and upward to close the gaps.</p>
cristy3ed852e2009-09-05 21:47:34 +0000980
981<div style="margin: auto;">
982 <h4><a name="clip" id="clip"></a>-clip</h4>
983</div>
984
985<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>
986
987<p>If a clipping path is present, it is applied to subsequent operations.</p>
988
989<p>For example, in the command</p>
990
991<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
992<p>only the pixels within the clipping path are negated.</p>
993
994<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
995
996<div style="margin: auto;">
997 <h4><a name="clip-mask" id="clip-mask"></a>-clip-mask</h4>
998</div>
999
1000<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>
1001
1002<div style="margin: auto;">
1003 <h4><a name="clip-path" id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
1004</div>
1005
1006<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>
1007
1008<div style="margin: auto;">
1009 <h4><a name="clone" id="clone"></a>-clone <em class="arg">index(s)</em></h4>
1010</div>
1011
1012<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>
1013
1014<p>Specify the image by its index in the sequence. The first image is index
cristyefb2bdb2010-11-20 19:35:22 +000010150. Negative indexes are relative to the end of the sequence; for
1016example, &minus;1
cristy3ed852e2009-09-05 21:47:34 +00001017represents the last image of the sequence. Specify a range of images with a
cristyefb2bdb2010-11-20 19:35:22 +00001018dash (e.g. 0&minus;4). Separate multiple indexes with commas but no
1019spaces (e.g. 0,2,5). Use <a
cristy3ed852e2009-09-05 21:47:34 +00001020href="#clone">+clone</a> make a copy of the last image in the image
1021sequence.</p>
1022
1023<div style="margin: auto;">
1024 <h4><a name="clut" id="clut"></a>-clut</h4>
1025</div>
1026
1027<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
1028corresponding channel in the second image as a <b>c</b>olor
1029<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
1030
1031<p>The second (LUT) image is ordinarily a gradient image containing the
1032histogram mapping of how each channel should be modified. Typically it is a
1033either a single row or column image of replacement color values. If larger
1034than a single row or column, values are taken from a diagonal line from
1035top-left to bottom-right corners.</p>
1036
1037<p>The lookup is further controlled by the <a
1038href="#interpolate">-interpolate</a> setting, which is especially handy for an
1039LUT which is not the full length needed by the ImageMagick installed Quality
1040(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
1041'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
1042gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
1043lookup of color values. </p>
1044
1045<p>This operator is especially suited to replacing a grayscale image with a
1046specific color gradient from the CLUT image. </p>
1047
1048<p>Only the channel values defined by the <a href="#channel">-channel</a>
1049setting will have their values replaced. In particular, since the default <a
1050href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
1051transparency (alpha/matte channel) is not affected, unless the <a
1052href="#channel">-channel</a> setting is modified. When the alpha channel is
1053set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
1054as the other channels, implying that alpha/matte values are replaced using the
1055alpha/matte values of the original image. </p>
1056
cristyd0bda5e2010-09-21 16:22:45 +00001057<p>If either the image being modified, or the lookup image, contains no
cristy3ed852e2009-09-05 21:47:34 +00001058transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
1059href="#channel">-channel</a> setting includes alpha replacement, then it is
cristyd0bd44a2010-09-24 12:38:11 +00001060assumed that image represents a gray-scale gradient which is used for the
cristy3ed852e2009-09-05 21:47:34 +00001061replacement alpha values. That is you can use a gray-scale CLUT image to
1062adjust a existing images alpha channel, or you can color a gray-scale image
1063using colors form CLUT containing the desired colors, including transparency.
1064</p>
1065
cristyefb2bdb2010-11-20 19:35:22 +00001066<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors
1067according to the lookup of the full color RGB value from a 2D representation
1068of a 3D color cube. </p>
cristy3ed852e2009-09-05 21:47:34 +00001069
1070
1071<div style="margin: auto;">
1072 <h4><a name="coalesce" id="coalesce"></a>-coalesce</h4>
1073</div>
1074
1075<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>
1076
cristyefb2bdb2010-11-20 19:35:22 +00001077<p>Overlay each image in an image sequence according to
1078its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of
1079an animation at each point in the animation sequence. All images should be
1080the same size, and are assigned appropriate GIF disposal settings for the
1081animation to continue working as expected as a GIF animation. Such frames
1082are more easily viewed and processed than the highly optimized GIF overlay
1083images. </p>
cristy3ed852e2009-09-05 21:47:34 +00001084
cristyefb2bdb2010-11-20 19:35:22 +00001085<p>The animation can be re-optimized after processing using
1086the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', although
1087there is no guarantee that the restored GIF animation optimization is
1088better than the original. </p>
cristy3ed852e2009-09-05 21:47:34 +00001089
1090
1091<div style="margin: auto;">
1092 <h4><a name="colorize" id="colorize"></a>-colorize <em class="arg">value</em></h4>
1093</div>
1094
1095<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>
1096
cristyefb2bdb2010-11-20 19:35:22 +00001097<p>Specify the amount of colorization as a percentage. Separate colorization
1098values can be applied to the red, green, and blue channels of the image with
1099a comma-delimited list of colorization
1100values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001101
1102<div style="margin: auto;">
1103 <h4><a name="colormap" id="colormap"></a>-colormap <em class="arg">type</em></h4>
1104</div>
1105
1106<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>
1107
1108<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
1109
cristyefb2bdb2010-11-20 19:35:22 +00001110<p>This option only applies when the default X server visual
1111is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer
1112to <a href="#visual">-visual</a> for more details. By default,
1113a shared colormap is allocated. The image shares colors with
1114other X clients. Some image colors could be approximated,
1115therefore your image may look very different than intended.
1116If <kbd>private</kbd> is chosen, the image colors appear exactly
1117as they are defined. However, other clients may go <em>technicolor</em>
1118when the image colormap is installed.</p>
cristy3ed852e2009-09-05 21:47:34 +00001119
1120<div style="margin: auto;">
1121 <h4><a name="colors" id="colors"></a>-colors <em class="arg">value</em></h4>
1122</div>
1123
1124<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>
1125
cristyefb2bdb2010-11-20 19:35:22 +00001126<p>The actual number of colors in the image may be less than your request,
1127but never more. Note that this a color reduction option. Images with fewer
1128unique colors than specified by <em class="arg">value</em> will have any
1129duplicate or unused colors removed. The ordering of an existing color
1130palette may be altered. When converting an image from color to grayscale,
1131it is more efficient to convert the image to the gray colorspace before
1132reducing the number of colors. Refer to
1133the <a href="../www/quantize.html">
1134color reduction algorithm</a> for more details.</p>
cristy3ed852e2009-09-05 21:47:34 +00001135
1136<div style="margin: auto;">
cristy2c839602010-04-03 02:32:08 +00001137 <h4><a name="color-matrix" id="color-matrix"></a>-color-matrix <em class="arg">matrix</em></h4>
1138</div>
1139
1140<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>
1141
cristyefb2bdb2010-11-20 19:35:22 +00001142<p>This option permits saturation changes, hue rotation, luminance to alpha,
1143and various other effects. Although variable-sized transformation matrices
1144can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6
1145for CMYKA (or RGBA with offsets). The matrix is similar to those used by
1146Adobe Flash except offsets are in column 6 rather than 5 (in support of
1147CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
cristy2c839602010-04-03 02:32:08 +00001148
1149<p>As an example, to add contrast to an image with offsets, try this command:</p>
1150
1151<pre class="text">
1152convert kittens.jpg -color-matrix \
1153 " 1.5 0.0 0.0 0.0, 0.0, -0.157 \
1154 0.0 1.5 0.0 0.0, 0.0, -0.157 \
1155 0.0 0.0 1.5 0.0, 0.0, -0.157 \
1156 0.0 0.0 0.0 1.0, 0.0, 0.0 \
1157 0.0 0.0 0.0 0.0, 1.0, 0.0 \
1158 0.0 0.0 0.0 0.0, 0.0, 1.0" kittens.png
1159</pre>
1160<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00001161 <h4><a name="colorspace" id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
1162</div>
1163
1164<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>
1165
1166<p>Choices are:</p>
1167
1168<pre class="text">
1169 CMY
1170 CMYK
1171 Gray
1172 HSB
1173 HSL
1174 HWB
1175 Lab
1176 Log
1177 OHTA
1178 Rec601Luma
1179 Rec601YCbCr
1180 Rec709Luma
1181 Rec709YCbCr
1182 RGB
1183 sRGB
1184 Transparent
1185 XYZ
1186 YCbCr
1187 YCC
1188 YIQ
1189 YPbPr
1190 YUV
1191</pre>
1192
1193<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1194
1195<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>
1196
1197<table class="doc">
1198 <caption>Conversion Of RGB To Other Color Spaces</caption>
1199 <tr><th align="left" valign="middle">CMY</th></tr>
1200 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1201 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1202 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1203 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1204 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1205 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1206 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1207 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1208
1209 <tr><th align="left" valign="middle">Gray</th></tr>
1210 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1211
1212 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1213 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1214 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1215 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1216
1217 <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>
1218 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1219 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1220 <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>
1221
1222 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1223 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1224 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1225 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1226
1227 <tr><th align="left" valign="middle">LAB</th></tr>
1228 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1229 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1230 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1231
1232 <tr><th align="left" valign="middle">LOG</th></tr>
1233 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1234 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1235 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1236
1237 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1238 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1239 <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>
1240 <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>
1241
1242 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1243 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1244
1245 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1246 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1247 <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>
1248 <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>
1249
1250 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1251 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1252
1253 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1254 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1255 <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>
1256 <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>
1257
1258 <tr><th align="left" valign="middle">sRGB</th></tr>
1259 <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>
1260 <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>
1261 <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>
1262
1263 <tr><th align="left" valign="middle">XYZ</th></tr>
1264 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1265 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1266 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1267
1268 <tr><th align="left" valign="middle">YCC</th></tr>
1269 <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>
1270 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1271 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1272
1273 <tr><th align="left" valign="middle">YCbCr</th></tr>
1274 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1275 <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>
1276 <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>
1277
1278 <tr><th align="left" valign="middle">YIQ</th></tr>
1279 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1280 <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>
1281 <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>
1282
1283 <tr><th align="left" valign="middle">YPbPr</th></tr>
1284 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1285 <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>
1286 <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>
1287
1288 <tr><th align="left" valign="middle">YUV</th></tr>
1289 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1290 <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>
1291 <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>
1292</table>
1293
1294<div style="margin: auto;">
1295 <h4><a name="combine" id="combine"></a>-combine</h4>
1296</div>
1297
1298<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>
1299
1300<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>
1301
1302<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.
1303</p>
1304
cristy4949d522010-03-12 18:41:34 +00001305<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 +00001306<div style="margin: auto;">
1307 <h4><a name="comment" id="comment"></a>-comment <em class="arg">string</em></h4>
1308</div>
1309
1310<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>
1311
cristyd0bda5e2010-09-21 16:22:45 +00001312<p>This option sets the comment meta-data of an image read in after this
cristy71a3f602010-09-15 12:38:16 +00001313option has been given. To modify a comment of images already in memory use
1314"<kbd><a href="#set">-set</a> comment</kbd>". </p>
cristy3ed852e2009-09-05 21:47:34 +00001315
cristy71a3f602010-09-15 12:38:16 +00001316<p>The comment can contain special format characters listed in the <a
1317href="../www/escape.html">Format and
cristyd0bd44a2010-09-24 12:38:11 +00001318Print Image Properties</a>. These attributes are expanded when the comment
cristy71a3f602010-09-15 12:38:16 +00001319is finally assigned to the individual images. </p>
1320
1321<p>If the first character of <em class="arg">string</em> is <em
1322class="arg">@</em>, the image comment is read from a file titled by the
1323remaining characters in the string. Comments read in from a file are literal;
1324no embedded formatting characters are recognized.</p>
1325
1326<p>Comment meta-data are not visible on the image itself. To do that use the
1327<a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options
1328instead.</p>
cristy3ed852e2009-09-05 21:47:34 +00001329
1330<p>For example,</p>
1331
1332<p class="crtsnip">
cristy71a3f602010-09-15 12:38:16 +00001333 -comment "%m:%f %wx%h" bird.miff
cristy3ed852e2009-09-05 21:47:34 +00001334</p>
1335
cristy71a3f602010-09-15 12:38:16 +00001336<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> (assuming
1337that the image <kbd>bird.miff</kbd> has a width of 512 and a height of
1338480.</p>
cristy3ed852e2009-09-05 21:47:34 +00001339
1340<div style="margin: auto;">
1341 <h4><a name="compose" id="compose"></a>-compose <em class="arg">operator</em></h4>
1342</div>
1343
1344<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>
1345
cristybc9539a2010-08-16 18:06:20 +00001346<p>See <a href="../www/compose.html">Alpha Compositing</a> for
1347a detailed discussion of alpha compositing.</p>
cristy3ed852e2009-09-05 21:47:34 +00001348
cristybc9539a2010-08-16 18:06:20 +00001349<p>This setting effects image processing operators that merge two (or more)
1350images together in some way. This includes the operators,
1351<a href="#composite">-composite</a>,
1352<a href="#layers">-layers</a> composite,
1353<a href="#flatten">-flatten</a>,
1354<a href="#mosaic">-mosaic</a>,
1355<a href="#layers">-layers</a> merge,
1356<a href="#border">-border</a>,
1357<a href="#frame">-frame</a>,
1358and <a href="#extent">-extent</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00001359
cristybc9539a2010-08-16 18:06:20 +00001360<p>It is also one of the primary options for the "<kbd>composite</kbd>"
1361command. </p>
cristy3ed852e2009-09-05 21:47:34 +00001362
1363
1364<div style="margin: auto;">
1365 <h4><a name="composite" id="composite"></a>-composite</h4>
1366</div>
1367
cristybc9539a2010-08-16 18:06:20 +00001368<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 +00001369
1370<p>Take the first image 'destination' and overlay the second 'source' image
1371according to the current <a href="#compose">-compose</a> setting. The location
1372of the 'source' or 'overlay' image is controlled according to <a
1373href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1374settings. </p>
1375
1376<p>If a third image is given this is treated as a gray-scale 'mask' image
1377relative to the first 'destination' image. This mask will limit what parts of
1378the destination can be modified by the image composition. However for the
1379'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1380Y-displacement image instead. </p>
1381
1382<p>If a <a href="#compose">-compose</a> method requires extra numerical
1383arguments or flags these can be provided by setting the <a
1384href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00001385appropriately for the compose method. </p>
cristy3ed852e2009-09-05 21:47:34 +00001386
1387<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1388image outside the overlay area. You can disable this by setting the special <a
1389href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1390to '<kbd>false</kbd>'. </p>
1391
1392
1393<div style="margin: auto;">
1394 <h4><a name="compress" id="compress"></a>-compress <em class="arg">type</em></h4>
1395</div>
1396
1397<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>
1398
1399<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>
1400
1401<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1402
1403<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>
1404
1405<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>
1406
1407<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>
1408
1409<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>
1410
1411<div style="margin: auto;">
1412 <h4><a name="contrast" id="contrast"></a>-contrast</h4>
1413</div>
1414
1415<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>
1416
1417<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>
1418
1419<p>For a more pronounced effect you can repeat the option:</p>
1420
1421<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1422<div style="margin: auto;">
1423 <h4><a name="contrast-stretch" id="contrast-stretch"></a>-contrast-stretch <em class="arg">black-point</em><br />-contrast-stretch <em class="arg">black-point</em>{x<em class="arg">white-point</em>}{<em class="arg">%</em>}}</h4>
1424</div>
1425
1426<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>
1427
cristyd934d102009-10-10 12:55:13 +00001428<p>While performing the stretch, black-out at most <em
1429class="arg" >black-point</em> pixels and white-out at most <em
1430class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1431<em class="arg" >black-point %</em> pixels and white-out at most <em
1432class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001433
cristyd934d102009-10-10 12:55:13 +00001434<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1435>-contrast-stretch</a> will black-out at most <em class="arg"
1436>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1437minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1438class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1439>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001440
cristyd934d102009-10-10 12:55:13 +00001441<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1442the image's min and max values are stretched to 0 and <em class="QR"
1443>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1444clipping at either end. This is not the same as <a href="#normalize"
cristyd4d64ed2010-08-22 22:19:33 +00001445>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 0.15x0.05%</kbd> (or
cristyd934d102009-10-10 12:55:13 +00001446prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001447
cristyd934d102009-10-10 12:55:13 +00001448<p>Internally operator works by creating a histogram bin, and then uses that
1449bin to modify the image. As such some colors may be merged together when they
1450originally fell into the same 'bin'. </p>
1451
1452<p>All the channels are normalized in concert by the came amount so as to
1453preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00001454setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00001455setting will normalize the RGB channels independently.</p>
1456
1457<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1458normalization of mathematical images. </p>
1459
1460<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001461
1462
1463<div style="margin: auto;">
1464 <h4><a name="convolve" id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
1465</div>
1466
1467<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>
1468
cristy16ff93c2010-01-13 23:18:07 +00001469<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001470a comma-separated list of integers (with no spaces), ordered left-to right,
1471starting with the top row. Presently, only odd-dimensioned kernels are
1472supported, and therefore the number of entries in the specified <em
1473class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
14747<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001475
cristyd934d102009-10-10 12:55:13 +00001476<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
1477positive and negative results are relative to a user-specified bias value.
1478This is important for non-HDRI compilations of ImageMagick when dealing with
1479convolutions that contain negative as well as positive values. This is
1480especially the case with convolutions involving high pass filters or edge
1481detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001482</p>
1483
cristyd934d102009-10-10 12:55:13 +00001484<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
1485negative results without clipping to the color value range (0..QuantumRange).
1486See the discussion on HDRI implementations of ImageMagick on the page <a
1487href="/www/high-dynamic-range.html">High
1488Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1489href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1490<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1491entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001492
cristy3ed852e2009-09-05 21:47:34 +00001493
1494<div style="margin: auto;">
1495 <h4><a name="crop" id="crop"></a>-crop <em class="arg">geometry</em></h4>
1496</div>
1497
1498<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>
1499
1500<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>
1501
1502<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>
1503
1504<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>
1505
1506<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>
1507
1508<p>By adding a exclamation character flag to the geometry argument, the
1509cropped images virtual canvas page size and offset is set as if the
1510geometry argument was a viewport or window. This means the canvas page size
1511is set to exactly the same size you specified, the image offset set
1512relative top left corner of the region cropped. </p>
1513
1514<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1515special single pixel transparent 'missed' image is returned, and a 'crop
1516missed' warning given. </p>
1517
cristy739df912009-10-24 16:10:18 +00001518<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 +00001519
1520<div style="margin: auto;">
1521 <h4><a name="cycle" id="cycle"></a>-cycle <em class="arg">amount</em></h4>
1522</div>
1523
1524<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>
1525
1526<p><em class="arg">Amount</em> defines the number of positions each
1527colormap entry is shifted.</p>
1528
1529
1530<div style="margin: auto;">
1531 <h4><a name="debug" id="debug"></a>-debug <em class="arg">events</em></h4>
1532</div>
1533
1534<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>
1535
1536<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>
1537
1538
1539<p>For example, to log cache and blob events, use.</p>
1540
1541<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1542<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1543
1544<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1545
1546<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1547
1548<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1549
1550<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>
1551
1552
1553<div style="margin: auto;">
1554 <h4><a name="decipher" id="decipher"></a>-decipher <em class="arg">filename</em></h4>
1555</div>
1556
1557<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>
1558
1559<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1560
1561<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1562
1563
1564<div style="margin: auto;">
1565 <h4><a name="deconstruct" id="deconstruct"></a>-deconstruct</h4>
1566</div>
1567
1568<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>
1569
1570<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>
1571
1572<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>
1573
1574<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1575
1576
1577<div style="margin: auto;">
1578 <h4><a name="define" id="define"></a>-define <em class="arg">key</em>{<em class="arg">=value</em>}<em class="arg">...</em></h4>
1579</div>
1580
cristyd0bd44a2010-09-24 12:38:11 +00001581<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 +00001582coders and image processing operations.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00001583
cristyd0bda5e2010-09-21 16:22:45 +00001584<p>This option creates one or more definitions for coders and decoders to use
1585while reading and writing image data. Definitions are generally used to
1586control image file format coder modules, and image processing operations,
1587beyond what is provided by normal means. Defined settings are listed in <a
1588href="#verbose" >-verbose</a> information ("<kbd>info:</kbd>" output format)
1589as "Artifacts". </p>
cristy3ed852e2009-09-05 21:47:34 +00001590
cristyd0bda5e2010-09-21 16:22:45 +00001591<p>If <em class="arg">value</em> is missing for a definition, an empty-valued
1592definition of a flag is created with that name. This used to control on/off
1593options. Use <a href="#define">+define key</a> to remove definitions
1594previously created. Use <a href="#define">+define "*"</a> to remove all
1595existing definitions.</p>
1596
cristyd0bd44a2010-09-24 12:38:11 +00001597<p>The same 'artifact' settings can also be defined using the <a
cristyd0bda5e2010-09-21 16:22:45 +00001598href="#set" >-set "option:<em class="arg">key</em>" "<em class="arg"
cristyd0bd44a2010-09-24 12:38:11 +00001599>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 +00001600Properties</a> in the defined value. </p>
1601
cristyefb2bdb2010-11-20 19:35:22 +00001602<p>The <em>option</em> and <em>key</em> are case-independent (they are
1603converted to lowercase for use within the decoders) while the <em>value</em>
1604is case-dependent.</p>
1605
cristyd0bda5e2010-09-21 16:22:45 +00001606<p>Such settings are global in scope, and effect all images and operations. </p>
1607
1608<p>The following definitions are just some of the artifacts that are
1609available:</p>
cristy3ed852e2009-09-05 21:47:34 +00001610
1611<ul>
cristyd0bda5e2010-09-21 16:22:45 +00001612
cristy045bd902010-01-30 18:56:24 +00001613<dt>dcm:display-range=reset</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001614<dd>Set the display range to the minimum and maximum pixel values for the
1615 DCM image format.</dd><br />
1616
cristy045bd902010-01-30 18:56:24 +00001617<dt>dot:layout-engine=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001618<dd>Set the specify the layout engine for the DOT image format (e.g.
1619 <kbd>neato</kbd>).</dd><br />
1620
cristy045bd902010-01-30 18:56:24 +00001621<dt>jpeg:extent=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001622<dd>Restrict the maximum JPEG file size, for example <kbd>-define
1623 jpeg:extent=400kb</kbd>.</dd><br />
1624
cristy045bd902010-01-30 18:56:24 +00001625<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001626<dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128.
1627 It is most useful for increasing performance and reducing the memory
1628 requirements when reducing the size of a large JPEG image.</dd><br />
1629
cristy045bd902010-01-30 18:56:24 +00001630<dt>jp2:rate=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001631<dd>Specify the compression factor to use while writing JPEG-2000 files. The
1632 compression factor is the reciprocal of the compression ratio. The valid
1633 range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined,
1634 this value overrides the -quality setting. A quality setting of 75
1635 results in a rate value of 0.06641.</dd><br />
1636
cristy3ed852e2009-09-05 21:47:34 +00001637<dt>mng:need-cacheoff</dt>
1638 <dd>turn playback caching off for streaming MNG.</dd><br />
cristyd0bda5e2010-09-21 16:22:45 +00001639
cristy045bd902010-01-30 18:56:24 +00001640<dt>png:bit-depth=<em class="arg">value</em></dt>
1641<dt>png:color-type=<em class="arg">value</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001642<dd>desired bit-depth and color-type for PNG output. You can force the PNG
1643 encoder to use a different bit-depth and color-type than it would have
1644 normally selected, but only if this does not cause any loss of image
1645 quality. Any attempt to reduce image quality is treated as an error and no
1646 PNG file is written. E.g., if you have a 1-bit black-and-white image, you
1647 can use these "defines" to cause it to be written as an 8-bit grayscale,
1648 indexed, or even a 64-bit RGBA. But if you have a 16-million color image,
1649 you cannot force it to be written as a grayscale or indexed PNG. If you
1650 wish to do this, you must use the appropriate <a href="#depth">-depth</a>,
1651 <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to
1652 reduce the image quality prior to using the PNG encoder. Note that in
1653 indexed PNG files, "bit-depth" refers to the number of bits per index,
cristyefb2bdb2010-11-20 19:35:22 +00001654 which can be 1, 2, 4, or 8. In such files, the color samples always have
cristyd0bda5e2010-09-21 16:22:45 +00001655 8-bit depth.</dd><br />
1656
cristy3ed852e2009-09-05 21:47:34 +00001657<dt>ps:imagemask</dt>
cristyd0bda5e2010-09-21 16:22:45 +00001658<dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create
1659 Postscript files that render bilevel images with the Postscript imagemask
1660 operator instead of the image operator.</dd><br />
1661
cristy045bd902010-01-30 18:56:24 +00001662<dt>quantum:format=<em class="arg">type</em></dt>
cristyd0bda5e2010-09-21 16:22:45 +00001663<dd>Set the type to <kbd>floating-point</kbd> to specify a floating-point
1664 format for raw files (e.g. GRAY:) or for MIFF and TIFF images in HDRI mode
1665 to preserve negative values. If <a href="#depth">-depth</a> 16 is
cristyd0bd44a2010-09-24 12:38:11 +00001666 included, the result is a single precision floating point format.
1667 If <a href="#depth">-depth</a> 32 is included, the result is
cristyd0bda5e2010-09-21 16:22:45 +00001668 double precision floating point format.</dd>
1669
cristy3ed852e2009-09-05 21:47:34 +00001670</ul>
1671
cristyd0bda5e2010-09-21 16:22:45 +00001672<p>For example, to create a postscript file that will render only the black
1673pixels of a bilevel image, use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001674
1675<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 +00001676<p>Set attributes of the image registry by prefixing the value with
1677<kbd>registry:</kbd>. For example, to set a temporary path to put work files,
1678use:</p>
cristy3ed852e2009-09-05 21:47:34 +00001679
1680<p class="crtsnip">
1681-define registry:temporary-path=/data/tmp
1682</p>
1683
cristyd0bda5e2010-09-21 16:22:45 +00001684
1685
cristy3ed852e2009-09-05 21:47:34 +00001686<div style="margin: auto;">
1687 <h4><a name="delay" id="delay"></a>-delay <em class="arg">ticks</em> <br />-delay <em class="arg">ticks</em>x<em class="arg">ticks-per-second</em> {<em class="arg">&lt;</em>} {<em class="arg">&gt;</em>}</h4>
1688</div>
1689
1690<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>
1691
1692<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>
1693
1694<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>
1695
1696
1697<div style="margin: auto;">
1698 <h4><a name="delete" id="delete"></a>-delete <em class="arg">index</em></h4>
1699</div>
1700
1701<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>
1702
1703<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>
1704
1705
1706<div style="margin: auto;">
1707 <h4><a name="density" id="density"></a>-density <em class="arg">width</em><br />-density <em class="arg">width</em>x<em class="arg">height</em></h4>
1708</div>
1709
1710<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>
1711
1712<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>
1713
1714<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>
1715
1716<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>
1717
1718<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>
1719
1720<div style="margin: auto;">
1721 <h4><a name="depth" id="depth"></a>-depth <em class="arg">value</em></h4>
1722</div>
1723
1724<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>
1725
1726<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>
1727
1728<div style="margin: auto;">
1729 <h4><a name="descend" id="descend"></a>-descend</h4>
1730</div>
1731
1732<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>
1733
1734<div style="margin: auto;">
1735 <h4><a name="deskew" id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
1736</div>
1737
1738<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>
1739
1740<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>
1741
1742<div style="margin: auto;">
1743 <h4><a name="despeckle" id="despeckle"></a>-despeckle</h4>
1744</div>
1745
1746<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>
1747
1748<div style="margin: auto;">
cristy2c839602010-04-03 02:32:08 +00001749 <h4><a name="direction" id="direction"></a>-direction <em class="arg">type</em></h4>
1750</div>
1751
1752<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>
1753
1754<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00001755 <h4><a name="displace" id="displace"></a>-displace <em class="arg">horizontal-scale</em><br />-displace <em class="arg">horizontal-scale</em>x<em class="arg">vertical-scale</em></h4>
1756</div>
1757
1758<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>
1759
1760<p>With this option, the 'overlay' image, and optionally the 'mask' image,
cristyd0bd44a2010-09-24 12:38:11 +00001761is used as a displacement map, which is used to displace the lookup of
cristy3ed852e2009-09-05 21:47:34 +00001762what part of the 'background' image is seen at each point of the overlaid
1763area. Much like the displacement map is a 'lens' that redirects light shining
1764through it so as to present a distorted view the original 'background' image
1765behind it. </p>
1766
1767<p>Any perfect grey areas of the displacement map produce a zero
1768displacement of the image. Black areas produce the given maximum negative
1769displacement of the lookup point, while white produce a maximum positive
1770displacement of the lookup. </p>
1771
1772<p>Note that it is the lookup of the 'background' that is displaced, not a
1773displacement of the image itself. As such an area of the displacement map
1774containing 'white' will have the lookup point 'shifted' by a positive amount,
1775and thus generating a copy of the destination image to the right/downward from
1776the correct position. That is the image will look like it may have been
1777'shifted' in a negative left/upward direction. Understanding this is a very
1778important in understanding how displacement maps work. </p>
1779
1780<p>The given arguments define the maximum amount of displacement in pixels
1781that a particular map can produce. If the displacement scale is large enough
cristyd0bda5e2010-09-21 16:22:45 +00001782it is also possible to lookup parts of the 'background' image that lie well
cristy3ed852e2009-09-05 21:47:34 +00001783outside the bounds of the displacement map itself. That is you could very
cristyd0bda5e2010-09-21 16:22:45 +00001784easily copy a section of the original image from outside the overlay area
cristy3ed852e2009-09-05 21:47:34 +00001785into the overlay area. </p>
1786
1787<p>The '%' flag makes the displacement scale relative to the size of the
1788overlay image (100% = half width/height of image). Using '!' switches
1789percentage arguments to refer to the destination image size instead.
1790these flags were added as of IM v6.5.3-5.</p>
1791
1792<p>Normally a single grayscale displacement map is provided, which with the
1793given scaling values will determine a single direction (vector) in which
cristyd0bda5e2010-09-21 16:22:45 +00001794displacements can occur (positively or negatively). However, if you also
cristy3ed852e2009-09-05 21:47:34 +00001795specify a third image which is normally used as a <em class="arg">mask</em>,
cristyd0bd44a2010-09-24 12:38:11 +00001796the <em class="arg">composite image</em> is used for horizontal X
cristy3ed852e2009-09-05 21:47:34 +00001797displacement, while the <em class="arg">mask image</em> is used for vertical Y
1798displacement. This allows you to define completely different displacement
1799values for the X and Y directions, and allowing you to lookup any point within
1800the <em class="arg">scale</em> bounds. In other words each pixel can lookup
cristyd0bda5e2010-09-21 16:22:45 +00001801any other nearby pixel, producing complex 2 dimensional displacements, rather
1802than a simple 1 dimensional vector displacements. </p>
cristy3ed852e2009-09-05 21:47:34 +00001803
cristyd0bda5e2010-09-21 16:22:45 +00001804<p>Alteratively rather than suppling two separate images, as of IM v6.4.4-0,
cristy3ed852e2009-09-05 21:47:34 +00001805you can use the 'red' channel of the overlay image to specify the horizontal
1806or X displacement, and the 'green' channel for the vertical or Y displacement.
1807</p>
1808
cristyd0bd44a2010-09-24 12:38:11 +00001809<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 +00001810mask the transparency of the destination image. However areas outside the
1811overlaid areas will not be effected. </p>
1812
1813
1814<div style="margin: auto;">
1815 <h4><a name="display" id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
1816</div>
1817
1818<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>
1819
1820<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
1821
1822<div style="margin: auto;">
1823 <h4><a name="dispose" id="dispose"></a>-dispose <em class="arg">method</em></h4>
1824</div>
1825
1826<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>
1827
1828<p>The layer disposal method defines the way each the displayed image is to be
1829modified after the current 'frame' of an animation has finished being
1830displayed (after its 'delay' period), but before the next frame on an
1831animation is to be overlaid onto the display. </p>
1832
1833<p>Here are the valid methods:</p>
1834
1835<pre class="text">
1836Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
1837None 1 Do not dispose, just overlay next frame image.
1838Background 2 Clear the frame area with the background color.
1839Previous 3 Clear to the image prior to this frames overlay.
1840</pre>
1841
1842<p>You can also use the numbers given above, which is what the GIF format
1843uses internally to represent the above settings. </p>
1844
cristyd0bda5e2010-09-21 16:22:45 +00001845<p>To print a complete list of dispose methods, use <a href="#list">-list dispose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00001846
1847<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
1848resetting the layer disposal methods of images being read in. </p>
1849
1850<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
1851disposal method for images already in memory.</p>
1852
1853<div style="margin: auto;">
1854 <h4><a name="dissimilarity-threshold" id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
1855</div>
1856
1857<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>
1858
1859
1860<div style="margin: auto;">
1861 <h4><a name="dissolve" id="dissolve"></a>-dissolve <em class="arg">src_percent</em>[x<em class="arg">dst_percent</em>]</h4>
1862</div>
1863
1864<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>
1865
1866<p>The opacity of the composite image is multiplied by the given percent, then
1867it is composited 'over' the main image. If <em class="arg">src_percent</em>
cristyd0bd44a2010-09-24 12:38:11 +00001868is greater than 100, start dissolving the main image so it becomes
cristy3ed852e2009-09-05 21:47:34 +00001869transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
1870are given, each image are dissolved to the percentages given. </p>
1871
1872<p>Note that dissolve percentages do not add, two opaque images dissolved
1873'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
1874images, you would need to use dissolve values of '50,100'. </p>
1875
1876<div style="margin: auto;">
1877 <h4><a name="distort" id="distort"></a>-distort <em class="arg">method arguments</em></h4>
1878</div>
1879
1880<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>
1881
1882<p>The <em class="arg">arguments</em> is a single string containing a list
1883of floating point numbers separated by commas or spaces. The number of
1884and meaning of the floating point values depends on the distortion <em
1885class="arg">method</em> being used. </p>
1886
1887<p>Choose from these distortion types:</p>
1888
1889<table class="doc">
1890 <tr valign="top">
1891 <th align="left" style="width: 8%">Method</th>
1892 <th align="left">Description</th>
1893 </tr>
1894
1895 <tr valign="top">
1896 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
1897 <br/>or &nbsp; <kbd>SRT</kbd></td>
1898 <td valign="top">
1899 Distort image by first scaling and rotating about a given 'center',
1900 before translating that 'center' to the new location, in that order. It
1901 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
1902 distortion, but without shearing effects. It also provides a good way
1903 of rotating and displacing a smaller image for tiling onto a larger
1904 background (IE 2-dimensional animations). <br/>
1905
1906 The number of arguments determine the specific meaning of each
1907 argument for the scales, rotation, and translation operations. <br/>
1908
1909 <table style="margin-left:auto; margin-right:auto;">
1910 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
1911 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
1912 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
1913 <tr><td>3:</td><td><em>ScaleX,ScaleY &nbsp; Angle</em></td></tr>
1914 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
1915 <tr><td>5:</td>
1916 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
1917 <tr><td>6:</td>
1918 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
1919 <tr><td>7:</td>
1920 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
1921 &nbsp; NewX,NewY</em></td></tr>
1922 </table>
1923
cristyd0bda5e2010-09-21 16:22:45 +00001924 This is actually an alternative way of specifying a 2 dimensional linear
cristy3ed852e2009-09-05 21:47:34 +00001925 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
1926
1927 <tr valign="top">
1928 <td valign="top"><kbd>Affine</kbd></td>
1929 <td valign="top">
1930 Distort the image linearly by moving a list of at least 3 or more sets
cristyd0bda5e2010-09-21 16:22:45 +00001931 of control points (as defined below). Ideally 3 sets or 12 floating
cristy3ed852e2009-09-05 21:47:34 +00001932 point values are given allowing the image to be linearly scaled,
1933 rotated, sheared, and translated, according to those three points. See
1934 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
1935 distortions. <br/>
1936
1937 More than 3 sets given control point pairs (12 numbers) is least
1938 squares fitted to best match a lineary affine distortion. If only 2
1939 control point pairs (8 numbers) are given a two point image translation
cristyd0bda5e2010-09-21 16:22:45 +00001940 rotation and scaling is performed, without any possible shearing,
cristy3ed852e2009-09-05 21:47:34 +00001941 flipping or changes in aspect ratio to the resulting image. If only one
1942 control point pair is provides the image is only translated, (which may
1943 be a floating point non-integer translation). <br/>
1944
1945 This distortion does not include any form of perspective distortion.
1946 </td>
1947
1948 </tr>
1949
1950 <tr valign="top">
1951 <td valign="top"><kbd>AffineProjection</kbd></td>
1952 <td valign="top">
1953 Linearly distort an image using the given Affine Matrix of 6
1954 pre-calculated coefficients forming a set of Affine Equations to map
1955 the source image to the destination image.
1956
1957 <div style="text-align: center"><em>
1958 s<sub>x</sub>, r<sub>x</sub>,
1959 r<sub>y</sub>, s<sub>y</sub>,
1960 t<sub>x</sub>, t<sub>y</sub>
1961 </em></div>
1962
1963 See <a href="#affine" >-affine</a> setting for more detail, and
1964 meanings of these coefficients. <br/>
1965
1966 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
cristyd0bd44a2010-09-24 12:38:11 +00001967 alternative methods of defining this distortion, with ImageMagick doing
1968 the calculations needed to generate the required coefficients. You can
1969 see the internally generated coefficients, by using a <a
1970 href="#verbose" >-verbose</a> setting with those other varients. </td>
cristy3ed852e2009-09-05 21:47:34 +00001971
1972 </tr>
1973
cristy3ed852e2009-09-05 21:47:34 +00001974 <tr valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00001975 <td valign="top"><kbd>BilinearForward</kbd><br/>
1976 <kbd>BilinearReverse</kbd></td>
cristy3ed852e2009-09-05 21:47:34 +00001977 <td valign="top">
cristyd0bd44a2010-09-24 12:38:11 +00001978 Bilinear Distortion, given a minimum of 4 sets of coordinate pairs, or
1979 16 values (see below). Not that lines may not appear straight after
1980 distortion, though the distance between coordinates will remain
1981 consistent. <br/>
1982
1983 The '<kbd>BilinearForward</kbd>' is used to map rectangles to any
1984 quadrilateral, while the '<kbd>BilinearReverse</kbd>' form maps any
1985 quadrilateral to a rectangle, while preserving the straigth line edges
1986 in each case. <br/>
1987
1988 Note that '<kbd>BilinearForward</kbd>' can generate invalid pixels
1989 which will be colored using the <a href="#mattecolor" >-mattecolor</a>
1990 color setting. Also if the quadraterial becomes 'flipped' the image
1991 may dissappear. <br/>
1992
1993 There are future plans to produce a true Bilinear distortion that will
1994 attempt to map any quadrilateral to any other quadrilateral, while
1995 preserving edges (and edge distance ratios).
1996
1997 </td>
cristy3ed852e2009-09-05 21:47:34 +00001998 </tr>
cristy3ed852e2009-09-05 21:47:34 +00001999
2000 <tr valign="top">
2001 <td valign="top"><kbd>Perspective</kbd></td>
2002 <td valign="top">
2003 Perspective distort the images, using a list of 4 or more sets of
2004 control points (as defined below). More that 4 sets (16 numbers) of
2005 control points provide least squares fitting for more accurate
2006 distortions (for the purposes of image registration and panarama
2007 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2008 linear distortion. <br/>
2009
2010 Perspective Distorted images ensures that straight lines remain
2011 straight, but the scale of the distorted image will vary. The horizon
2012 is anti-aliased, and the 'sky' color may be set using the
2013 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2014 </tr>
2015
2016 <tr valign="top">
2017 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2018 <td valign="top">
cristyd0bda5e2010-09-21 16:22:45 +00002019 Do a '<kbd>Perspective</kbd>' distortion biased on a set of 8
cristy3ed852e2009-09-05 21:47:34 +00002020 pre-calculated coefficients. You can get these coefficients by looking
2021 at the <a href="#verbose" >-verbose</a> output of a
2022 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2023 If the last two perspective scaling coefficients are zero, the
2024 remaining 6 represents a transposed 'Affine Matrix'. </td>
2025
2026 </tr>
2027
2028 <tr valign="top">
2029 <td valign="top"><kbd>Arc</kbd></td>
2030 <td valign="top">
2031 Arc the image (variation of polar mapping) over the angle given around
2032 a circle. <br/>
2033 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2034 <tr valign="top"><td>Argument</td>
2035 <td>Meaning</td></tr>
2036 <tr valign="top"><td><em>arc_angle</em></td>
2037 <td>The angle over which to arc the image side-to-side</td></tr>
2038 <tr valign="top"><td><em>rotate_angle</em></td>
2039 <td>Angle to rotate resulting image from vertical center</td></tr>
2040 <tr valign="top"><td><em>top_radius</em></td>
2041 <td>Set top edge of source image at this radius</td></tr>
2042 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2043 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2044 </table>
2045
2046 The resulting image is always resized to best fit the resulting image,
2047 (as if using <a href="#distort" >+distort</a>) while attempting to
2048 preserve scale and aspect ratio of the original image as much as
2049 possible with the arguments given by the user. All four arguments will
2050 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2051
2052 This a variation of a polar distortion designed to try to preserve the
2053 aspect ratio of the image rather than direct Cartesian to Polar
2054 conversion. </td>
2055 </tr>
2056
2057 <tr valign="top">
2058 <td valign="top"><kbd>Polar</kbd></td>
2059 <td valign="top">
2060 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2061 the image. that is the height of the input image is mapped to the
2062 radius limits, while the width is wrapped around between the
2063 angle limits. <br/>
2064
2065 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2066
2067 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2068 center to the center of the image, and the angles going from -180 (top)
2069 to +180 (top). If <em>Rmax</em> is given the special value of
2070 '<code>0</code>', the the distance from the center to the nearest edge
2071 is used for the radius of the output image, which will ensure the whole
2072 image is visible (though scaled smaller). However a special value of
2073 '<code>-1</code>' will use the distance from the center to the furthest
2074 corner, This may 'clip' the corners from the input rectangular image,
2075 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2076 the same arguments. <br/>
2077
2078 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2079 output image center will default to <code>0,0</code> of the virtual
2080 canvas, and the image size adjusted to ensure the whole input image is
2081 made visible in the output image on the virtual canvas. </td>
2082
2083 </tr>
2084
2085 <tr valign="top">
2086 <td valign="top"><kbd>DePolar</kbd></td>
2087 <td valign="top">
2088 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2089 but generates the reverse Polar to Cartesian distortion. <br/>
2090
2091 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2092 the corners of the input image. However using the special
2093 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2094 distance) will ensure the whole distorted image is preserved in the
2095 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2096 reverse the distortion re-producing the original.
2097
2098 Note that as this distortion requires the area resampling of a circular
2099 arc, which can not be handled by the builtin EWA resampling function.
cristyd0bda5e2010-09-21 16:22:45 +00002100 As such the normal EWA filters are turned off. It is recommended some
cristy3ed852e2009-09-05 21:47:34 +00002101 form of 'super-sampling' image processing technique be used to produce
2102 a high quality result. </td>
2103
2104 </tr>
2105
2106 <tr valign="top">
2107 <td valign="top"><kbd>Barrel</kbd></td>
2108 <td valign="top">
2109 Given the four coefficients (A,B,C,D) as defined by <a
2110 href="http://www.all-in-one.ee/~dersch/barrel/barrel.html" >Helmut
cristyd0bda5e2010-09-21 16:22:45 +00002111 Dersch</a>, perform a barrell or pin-cushion distortion appropriate to
cristy3ed852e2009-09-05 21:47:34 +00002112 correct radial lens distortions. That is in photographs, make straight
2113 lines straight again. <br/>
2114
2115 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2116 <em>X</em> , <em>Y</em> ] ] <br/>
2117 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2118 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2119 [ <em>X</em> , <em>Y</em> ] <br/>
2120 So that it forms the function <br/>
2121 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2122 <em>C</em>*r + <em>D</em> )<br/>
2123
2124 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2125 (defaulting to the center of the image). <br/>
2126 The second form is typically used to distort images, rather than
2127 correct lens distortions. <br/>
2128 </td>
2129
2130 </tr>
2131
2132 <tr valign="top">
2133 <td valign="top"><kbd>BarrelInverse</kbd></td>
2134 <td valign="top">
2135 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2136 arguments, and argument handling. However it uses the inverse
2137 of the radial polynomial,
2138 so that it forms the function <br/>
2139 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
cristyd0bd44a2010-09-24 12:38:11 +00002140 <em>C</em>*r + <em>D</em> )<br/>
2141 Note that this is not the reverse of the '<kbd>Barrel</kbd>'
2142 distortion, just a different barrel-like radial distortion method.
2143
cristy3ed852e2009-09-05 21:47:34 +00002144 </td>
2145 </tr>
2146
2147 <tr valign="top">
2148 <td valign="top"><kbd>Shepards</kbd></td>
2149 <td valign="top">
2150 Distort the given list control points (any number) using an Inverse
2151 Squared Distance Interpolation Method (<a
cristyd0bd44a2010-09-24 12:38:11 +00002152 href="http://en.wikipedia.org/wiki/Shepard%27s_method" >Shepards
2153 Method</a>). The control points in effect do 'localized' displacement
2154 of the image around the given control point (preserving the look and
2155 the rotation of the area near the control points. For best results
2156 extra control points should be added to 'lock' the positions of the
2157 corners, edges and other unchanging parts of the image, to prevent
2158 their movement. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002159
cristyd0bd44a2010-09-24 12:38:11 +00002160 The distortion has been likened to 'taffy pulling' using nails, or
2161 pins' stuck in a block of 'jelly' which is then moved to the new
2162 position, distorting te surface of the jelly. <br/>
cristy3ed852e2009-09-05 21:47:34 +00002163
cristyd0bd44a2010-09-24 12:38:11 +00002164 Internally it is equivelent to generating a displacement map (see <a
2165 href="#displace" >-displace</a>) for source image color look-up using
2166 the <a href="#sparse-color" >-sparse-color</a> method of the same name.
2167
2168 </td>
cristy3ed852e2009-09-05 21:47:34 +00002169 </tr>
2170
2171</table>
2172
cristyd0bd44a2010-09-24 12:38:11 +00002173<p>To print a complete list of distortion methods, use <a href="#list">-list
2174distort</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002175
2176<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2177'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2178defining how these points in the given image should be distorted in the
2179destination image. Each set of four floating point values represent a source
2180image coordinate, followed immediately by the destination image coordinate.
2181This produces a list of values such as...</p>
2182<div style="text-align: center"><em>
2183 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2184 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2185 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2186 ... &nbsp;
2187 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2188</em></div>
2189<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2190destination image. </p>
2191
2192<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2193needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2194perspective distortion of the built-in "rose:" image. Note how spaces were
2195used to group the 4 sets of coordinate pairs, to make it easier to read and
2196understand.</p>
2197
2198<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
cristyd0bd44a2010-09-24 12:38:11 +00002199convert rose: -virtual-pixel black \<br/>
2200 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \<br/>
2201 rose_3d_rotated.gif</span></p>
2202<p>If more that the required number of coordinate pairs are given for
2203a distortion, the distortion method is 'least squares' fitted to produce the
2204best result for all the coordinate pairs given. If less than the ideal number
2205of points are given, the distort will generally fall back to a simpler form of
2206distortion that can handles the smaller number of coordinates (usally a linear
2207'<kbd>Affine</kbd>' distortion). </p>
cristy3ed852e2009-09-05 21:47:34 +00002208
cristyd0bda5e2010-09-21 16:22:45 +00002209<p>By using more coordinates you can make use of image registration tool to
cristyd0bd44a2010-09-24 12:38:11 +00002210find matching coordinate pairs in overlapping images, so as to improve the
2211'fit' of the distortion. Of course a bad coordinate pair can also make the
2212'fit' worse. Caution is always advised. </p>
cristy3ed852e2009-09-05 21:47:34 +00002213
2214<p>Colors are acquired from the source image according to the <a
2215href="#interpolate" >-interpolate</a> color lookup setting, when the image is
cristyd0bd44a2010-09-24 12:38:11 +00002216magnified. However if the viewed image is minified (image becomes smaller),
2217a special area resampling function (added ImageMagick v6.3.5-9), is used to
2218produce a higher quality image. For example you can use
2219a '<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all
2220the way to the horizon. </p>
cristy3ed852e2009-09-05 21:47:34 +00002221
cristyd0bd44a2010-09-24 12:38:11 +00002222<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2223convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \<br/>
2224 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \<br/>
2225 checks_tiled.jpg</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002226<p>Note that a infinitely tiled perspective images involving the horizon can
2227be very slow to generate due to the use of the high quality 'area resampling'
2228function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2229using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2230(recommended if you plan to use super-sampling instead). </p>
2231
2232<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2233'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2234will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2235pixels. If you do not what these pixels to be visible, set the color to match
2236the rest of the ground. </p>
2237
2238<p>The output image size will by default be the same as the input image. This
2239means that if the part of the distorted image falls outside the viewed area of
cristyd0bd44a2010-09-24 12:38:11 +00002240the 'distorted space', those parts is clipped and lost. However if you use
2241the plus form of the operator (<a href="#distort" >+distort</a>) the operator
2242will attempt (if possible) to show the whole of the distorted image, while
2243retaining a correct 'virtual canvas' offset, for image layering. This offset
2244may need to be removed using <a href="#repage" >+repage</a>, to remove if it
2245is unwanted. </p>
cristy3ed852e2009-09-05 21:47:34 +00002246
2247<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2248option:distort:viewport {geometry_string}</kbd>" setting which will specify
2249the size and the offset of the generated 'viewport' image of the distorted
2250image space.</p>
2251
2252<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2253{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2254that factor without changing the viewed contents of the distorted image. This
2255can be used either for 'super-sampling' the image for a higher quality result,
2256or for panning and zooming around the image (with appropriate viewport
2257changes, or post-distort cropping and resizing). </p>
2258
2259<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2260href="#distort" >-distort</a> to attempt to output the internal coefficients,
2261and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2262and debugging purposes. This many not be available for all distorts. </p>
2263
2264<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2265produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2266and/or <a href="#shear" >-shear</a> operation, with more control of due to the
cristyd0bd44a2010-09-24 12:38:11 +00002267above settings. It is algorithmically slower however, though that may not be
2268the case in ImageMagick's implementation. </p>
cristy3ed852e2009-09-05 21:47:34 +00002269
2270
2271<div style="margin: auto;">
2272 <h4><a name="dither" id="dither"></a>-dither <em class="arg">method</em></h4>
2273</div>
2274
2275<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>
2276
cristyd0bda5e2010-09-21 16:22:45 +00002277<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 +00002278
2279<p>Dithering is turned on by default, to turn it off use the plus form of the
2280setting, <a href="#dither">+dither</a>. This will also also render PostScript
2281without text or graphic aliasing. Disabling dithering often (but not always)
2282leads to faster process, a smaller number of colors, but more cartoon like
2283image coloring. Generally resulting in 'color banding' effects in areas with
2284color gradients. </p>
2285
2286<p>The color reduction operators <a href="#colors">-colors</a>, <a
2287href="#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>
2288
2289<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>
2290
2291
2292<div style="margin: auto;">
2293 <h4><a name="draw" id="draw"></a>-draw <em class="arg">string</em></h4>
2294</div>
2295
2296<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>
2297
2298<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>
2299
2300<p>The shape primitives:</p>
2301
2302<pre class="text">
2303 point x,y
2304 line x0,y0 x1,y1
2305 rectangle x0,y0 x1,y1
2306 roundRectangle x0,y0 x1,y1 wc,hc
2307 arc x0,y0 x1,y1 a0,a1
2308 ellipse x0,y0 rx,ry a0,a1
2309 circle x0,y0 x1,y1
2310 polyline x0,y0 ... xn,yn
2311 polygon x0,y0 ... xn,yn
2312 bezier x0,y0 ... xn,yn
2313 path path specification
2314 image operator x0,y0 w,h filename
2315</pre>
2316
2317<p>The text primitive:</p>
2318
2319<pre class="text">
2320 text x0,y0 string
2321</pre>
2322<p>The text gravity primitive:</p>
2323
2324<pre class="text">
2325 gravity NorthWest, North, NorthEast, West, Center,
2326 East, SouthWest, South, or SouthEast
2327</pre>
2328
2329<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>
2330
2331<p>The transformation primitives:</p>
2332
2333<pre class="text">
2334 rotate degrees
2335 translate dx,dy
2336 scale sx,sy
2337 skewX degrees
2338 skewY degrees
2339</pre>
2340
2341<p>The pixel operation primitives:</p>
2342
2343<pre class="text">
2344 color x0,y0 method
2345 matte x0,y0 method
2346</pre>
2347
2348<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>
2349
2350<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>
2351
2352<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2353
2354<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2355
2356<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>
2357
2358<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2359
2360<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>
2361
2362<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>
2363
2364<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>.
2365</p>
2366
2367<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2368
2369<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2370
2371<p class="crtsnip">
2372 -draw 'circle 100,100 150,150'
2373</p>
2374
2375<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
2376draw 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>
2377
2378<p class="crtsnip">
2379 -draw 'bezier 20,50 45,100 45,0 70,50'
2380</p>
2381<p class="crtsnip">
2382 -draw 'bezier 70,50 95,100 95,0 120,50'
2383</p>
2384
2385
2386<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>
2387
2388<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>
2389
2390<p class="crtsnip">
2391 -draw 'image SrcOver 100,100 225,225 image.jpg'
2392</p>
2393
cristybc9539a2010-08-16 18:06:20 +00002394<p>You can use 0,0 for the image size, which means to use the actual
2395dimensions found in the image header. Otherwise, it is scaled to the given
2396dimensions. See <a href="../www/compose.html">Alpha Compositing</a> for
2397a detailed discussion of alpha composition methods that are available. </p>
cristy3ed852e2009-09-05 21:47:34 +00002398
2399<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>
2400
2401<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2402
2403<p class="crtsnip">
2404 -draw 'text 100,100 "Works like magick!"'
2405</p>
2406
2407<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2408
2409<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>
2410
2411<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2412
2413<p>The <kbd>scale</kbd> primitive scales them.</p>
2414
2415<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>
2416
2417<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
2418matrix.</p>
2419
2420<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>
2421
2422<pre class="text">
2423 point
2424 replace
2425 floodfill
2426 filltoborder
2427 reset
2428</pre>
2429
2430<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>
2431
2432<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>
2433
2434<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>
2435
2436<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2437
2438<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2439
2440
2441<div style="margin: auto;">
2442 <h4><a name="edge" id="edge"></a>-edge <em class="arg">radius</em></h4>
2443</div>
2444
2445<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>
2446
2447<div style="margin: auto;">
2448 <h4><a name="emboss" id="emboss"></a>-emboss <em class="arg">radius</em></h4>
2449</div>
2450
2451<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>
2452
2453<div style="margin: auto;">
2454 <h4><a name="encipher" id="encipher"></a>-encipher <em class="arg">filename</em></h4>
2455</div>
2456
2457<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>
2458
2459<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2460
2461<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2462
cristyd0bda5e2010-09-21 16:22:45 +00002463
2464
cristy3ed852e2009-09-05 21:47:34 +00002465<div style="margin: auto;">
2466 <h4><a name="encoding" id="encoding"></a>-encoding <em class="arg">type</em></h4>
2467</div>
2468
2469<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>
2470
2471<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>
2472
2473<div style="margin: auto;">
2474 <h4><a name="endian" id="endian"></a>-endian <em class="arg">type</em></h4>
2475</div>
2476
2477<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>
2478
2479<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2480
2481<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2482
2483
2484<div style="margin: auto;">
2485 <h4><a name="enhance" id="enhance"></a>-enhance</h4>
2486</div>
2487
2488<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>
2489
2490
2491<div style="margin: auto;">
2492 <h4><a name="equalize" id="equalize"></a>-equalize</h4>
2493</div>
2494
2495<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>
2496
2497<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>
2498
2499<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2500
2501<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>
2502
2503<div style="margin: auto;">
2504 <h4><a name="evaluate" id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
2505</div>
2506
2507<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>
2508
2509<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>
2510
2511<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>
2512
2513<table class="doc">
2514 <col width="25%" />
2515 <col width="75%" />
2516 <thead>
2517 <tr>
2518 <th><em class="arg">operator</em></th>
2519 <th>Summary (see further below for details)</th>
2520 </tr>
2521 </thead>
2522 <tbody>
2523
cristy3c98a4f2010-08-13 20:09:41 +00002524 <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 +00002525 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2526 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2527 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2528 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2529 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
cristy5063d812010-10-19 16:28:10 +00002530 <tr><td>Exp </td> <td>base-e exponential function</td></tr>
2531 <tr><td>Exponential </td> <td>base-e exponential function</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002532 <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>
2533 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2534 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002535 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy61365ad2010-11-28 02:38:34 +00002536 <tr><td>Median </td> <td>Choose the median value from an image sequence.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002537 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2538 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2539 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2540 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2541 <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>
2542 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2543 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2544 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2545 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2546
2547 <tr><td>&nbsp;</td></tr>
2548
2549 <tr><td>Gaussian-noise</td></tr>
2550 <tr><td>Impulse-noise</td></tr>
2551 <tr><td>Laplacian-noise</td></tr>
2552 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2553 <tr><td>PoissonNoise</td></tr>
2554 <tr><td>Uniform-noise</td></tr>
2555
2556 <tr><td>&nbsp;</td></tr>
2557
2558 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2559 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2560 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2561 </tbody>
2562 </table>
2563
2564<p>The specified functions are applied only to each previously set <a
2565href="#channel" >-channel</a> in the image. If necessary, the results of the
2566calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2567class="QR">QuantumRange</em>]. The transparency channel of the image is
2568represented as a 'alpha' values (0 = fully transparent), so, for example, a
2569<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2570semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2571as a percentage of the <em class="QR">QuantumRange</em>.</p>
2572
2573<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2574<a href="#list">-list evaluate</a>.</p>
2575
2576<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2577<kbd>Multiply</kbd> methods can also be achieved using either the <a
2578href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2579appropriate argument, to linearly modify the overall range of color values.
2580Please note, however, that <a href="#level" >-level</a> treats transparency as
2581'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2582'alpha' values.</p>
2583
2584<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>
2585
cristyce66ab12010-10-21 23:36:32 +00002586<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>
2587
2588 <div style="text-align:center;">
2589 exp(<em class="arg">value</em> &times; <b><em>u</em></b>)
2590 </div>
2591
2592<p> If the input image is squared, for example, using <a
2593href="#-function" >-function polynomial "2 0 0"</a>, then a decaying Gaussian function will be the result.</p>
2594
cristy3ed852e2009-09-05 21:47:34 +00002595<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>
2596
2597 <div style="text-align:center;">
2598 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2599 </div>
2600
2601<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2602normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2603href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2604to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2605with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2606with <kbd>Pow</kbd>.</p>
2607
2608<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2609converts the image values into a value according to a (co)sine wave function.
2610The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2611is biased 50% and normalized by 50% so as to fit in the respective color value
2612range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2613function (its frequency), and thus determines the number of 'waves' that will
2614be generated over the input color range. For example, if the <em
2615class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2616class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2617then the effective period is the <em>half</em> the <em
2618class="QR">QuantumRange</em>.
2619
2620 <div style="text-align:center;">
2621 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2622 </div>
2623
2624See also the <a href="#function" >-function</a> operator, which is a
2625multi-value version of evaluate. </P>
2626
cristy63fed272010-03-07 19:08:45 +00002627<div style="margin: auto;">
2628 <h4><a name="evaluate-sequence" id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
2629</div>
2630
2631<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 +00002632
2633<div style="margin: auto;">
2634 <h4><a name="extent" id="extent"></a>-extent <em class="arg">geometry</em></h4>
2635</div>
2636
2637<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>
2638
cristy3e2860c2010-01-24 01:36:30 +00002639<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 +00002640<p>This command reduces or expands a JPEG image to fit on an 800x600
2641display. If the aspect ratio of the input image isn't exactly 4:3, then the
2642image is centered on an 800x600 black canvas: </p>
2643
2644<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>
2645
cristy3ed852e2009-09-05 21:47:34 +00002646
2647<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>
2648
2649<div style="margin: auto;">
2650 <h4><a name="extract" id="extract"></a>-extract <em class="arg">geometry</em></h4>
2651</div>
2652
2653<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>
2654
2655<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2656
cristy4949d522010-03-12 18:41:34 +00002657<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 +00002658
cristy4949d522010-03-12 18:41:34 +00002659<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 +00002660<p>the image is <em>resized</em> to the specified dimensions instead,
cristy3ed852e2009-09-05 21:47:34 +00002661equivalent to:</p>
2662
2663<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>
2664<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>
2665
2666<div style="margin: auto;">
2667 <h4><a name="family" id="family"></a>-family <em class="arg">fontFamily</em></h4>
2668</div>
2669
2670<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>
2671
2672<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).
2673</p>
2674
2675<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>.
2676</p>
2677
2678<div style="margin: auto;">
cristy7396d882010-01-27 02:37:56 +00002679 <h4><a name="features" id="features"></a>-features <em class="arg">distance</em></h4>
2680</div>
2681
2682<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>
2683
2684<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00002685 <h4><a name="fft" id="fft"></a>-fft</h4>
2686</div>
2687
2688<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>
2689
cristyb36feb22010-03-26 16:54:37 +00002690<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows users in ImageMagick 6.6.0-9). It transforms an image from the normal (spatial) domain to the frequency domain. In the frequency domain, an image is represented as a superposition of complex sinusoidal waves of varying amplitudes. The image x and y coordinates are the possible frequencies along the x and y directions, respectively, and the pixel intensity values are complex numbers that correspond to the sinusoidal wave amplitudes. See for example, <a href="http://en.wikipedia.org/wiki/Fourier_transform" target="_blank">Fourier Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT" target="_blank">Discrete Fourier Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT" target="_blank">Fast Fourier Transform</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002691
cristyd0bd44a2010-09-24 12:38:11 +00002692<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" target="_blank">Complex Numbers</a>.<p>
cristy3ed852e2009-09-05 21:47:34 +00002693
2694<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>
2695
2696<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2697<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>
2698
2699<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2700<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>
2701
cristyd0bd44a2010-09-24 12:38:11 +00002702<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 +00002703
2704<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>
2705
2706<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2707 -evaluate log 1000 fft_image_spectrum.png</span></p>
2708<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>
2709
2710<p>The <a href="http://www.fftw.org/" target="_blank">FFTW</a> delegate library is required to use <a href="#fft">-fft</a>.
2711
2712<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>
2713
2714<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>
2715
cristyd0bd44a2010-09-24 12:38:11 +00002716<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.</a>
cristy3ed852e2009-09-05 21:47:34 +00002717
2718<p>See the discussion on HDRI implementations of ImageMagick on the page
2719<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.
2720</p>
2721
2722
2723<div style="margin: auto;">
2724 <h4><a name="fill" id="fill"></a>-fill <em class="arg">color</em></h4>
2725</div>
2726
2727<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>
2728
2729<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>
2730
2731<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2732
2733<p>For example,</p>
2734
2735<p class="crtsnip">
2736 -fill blue
2737</p>
2738<p class="crtsnip">
2739 -fill "#ddddff"
2740</p>
2741<p class="crtsnip">
2742 -fill "rgb(255,255,255)"
2743</p>
2744
2745<p>See <a href="#draw">-draw</a> for further details.</p>
2746
2747<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2748
2749<div style="margin: auto;">
2750 <h4><a name="filter" id="filter"></a>-filter <em class="arg">type</em></h4>
2751</div>
2752
cristyd0bda5e2010-09-21 16:22:45 +00002753<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
2754distorting an image.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00002755
cristyd0bda5e2010-09-21 16:22:45 +00002756<p>Use this option to affect the resizing operation of an image during
2757operations such as <a href="#resize">-resize</a> and <a href="#distort"
2758>-distort</a>. For example you can use a simple resize filter such as:</p>
cristy3ed852e2009-09-05 21:47:34 +00002759
2760<pre class="text">
2761 Point Hermite Cubic
2762 Box Gaussian Catrom
2763 Triangle Quadratic Mitchell
2764</pre>
2765
cristyd0bda5e2010-09-21 16:22:45 +00002766<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided (as well
cristyd0bd44a2010-09-24 12:38:11 +00002767as a faster <kbd>SincFast</kbd> equivalent form). However these filters are
2768generally useless on their own as they are infinite filters that are being
2769clipped to the filters support size. Their direct use is not recommended
2770except via expert settings (see below). </p>
cristyd0bda5e2010-09-21 16:22:45 +00002771
2772Instead these special filter functions are typically windowed by a windowing
2773function that the <a href="#filter" >-filter</a> setting defines. That is
2774using these functions will define a 'Windowed' filter, appropriate to the
2775operator involved. Windowed filters include: </p>
cristy3ed852e2009-09-05 21:47:34 +00002776
2777<pre class="text">
2778 Lanczos Hamming Parzen
2779 Blackman Kaiser Welsh
2780 Hanning Bartlett Bohman
2781</pre>
2782
2783<p>Also one special self-windowing filter is also provided
2784<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2785on the current 'support' or 'lobes' expert settings (see below).</p>
2786
cristyd0bda5e2010-09-21 16:22:45 +00002787<p>If you do not select a filter with this option, the filter defaults to
2788<kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or
2789if the image is enlarged. Otherwise the filter default to
2790<kbd>Lanczos</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002791
cristyd0bda5e2010-09-21 16:22:45 +00002792<p>To print a complete list of resize filters, use the <a href="#list">-list
2793filter</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002794
2795<p>You can modify how the filter behaves as it scales your image through the
cristyd0bda5e2010-09-21 16:22:45 +00002796use of these expert settings (see also <a href="#define" >-define</a> and <a
2797href="#set" >-set</a>):-</p>
cristy3ed852e2009-09-05 21:47:34 +00002798
2799<dl class="doc">
cristyd0bda5e2010-09-21 16:22:45 +00002800<dt>-define filter:blur=<em>factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002801<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
cristyd0bda5e2010-09-21 16:22:45 +00002802 blurry or &lt; 1.0 for sharp. This should only be used with Gaussian and
2803 Gaussian-like filters simple filters, or you may not get the expected
2804 results. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002805
cristyd0bda5e2010-09-21 16:22:45 +00002806<dt>-define filter:support=<em>radius</em></dt>
2807<dd>Set the filter support radius. Defines how large the filter should be and
2808 thus directly defines how slow the filtered resampling process is. All
2809 filters have a default 'prefered' support size. Some filters like
2810 <kbd>Lagrange</kbd> and windowed filters adjust themselves depending on
2811 this value. With simple filters this value either does nothing (but slow
2812 the resampling), or will clip the filter function in a detrimental way.
2813 </dd>
cristy3ed852e2009-09-05 21:47:34 +00002814
cristyd0bda5e2010-09-21 16:22:45 +00002815<dt>-define filter:lobes=<em>count</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002816<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
cristyd0bda5e2010-09-21 16:22:45 +00002817 alternative way of specifying the 'support' range of the filter, that is
2818 designed to be more suited to windowed filters, especially when used for
2819 image distorts.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002820
cristyd0bda5e2010-09-21 16:22:45 +00002821<dt>-define filter:b=<em>b-spline_factor</em></dt>
2822<dt>-define filter:c=<em>keys_alpha_factor</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002823<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2824 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2825 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2826 are defined, the other is set so as to generate a 'Keys' type cubic
cristyd0bda5e2010-09-21 16:22:45 +00002827 filter. Values meaning was defined by a research paper by
2828 Mitchell-Netravali.
cristy3ed852e2009-09-05 21:47:34 +00002829
cristyd0bda5e2010-09-21 16:22:45 +00002830<dt>-define filter:filter=<em>filter_function</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00002831<dd>Use this function directly as the scaling filter. This will allow
cristyd0bda5e2010-09-21 16:22:45 +00002832 you to directly use a windowing filter such as <kbd>Blackman</kbd>,
cristy3ed852e2009-09-05 21:47:34 +00002833 rather than as its normal usage as a windowing function for 'Sinc' or
cristyd0bda5e2010-09-21 16:22:45 +00002834 'Bessel' functions. If defined, no windowing function is used, unless the
2835 following expert setting is also defined.</dd>
cristy3ed852e2009-09-05 21:47:34 +00002836
cristyd0bda5e2010-09-21 16:22:45 +00002837<dt>-define filter:window=<em>filter_function</em></dt>
2838<dd>The IIR (infinite impulse response) filters <kbd>Bessel</kbd> and
2839 <kbd>Sinc</kbd> are windowed (brought down to zero over the defined
2840 support range) with the given filter. This allows you to specify a filter
2841 function that is not normally used as a windowing function, such as
2842 <kbd>Box</kbd>, (which effectively turns off the windowing function),
2843 to window a <kbd>Sinc</kbd>, or the function the previous setting defined.
2844 </dd>
2845
2846<dt>-define filter:verbose=<em>1</em></dt>
2847<dd>This causes IM to print information on the final internal filter
2848 selection to standard output. This includes a commented header on the
2849 filter settings being used, and data allowing the filter weights to be
2850 easily graphed. </dd>
2851
2852<dd>Note however that some filters are internally defined in terms of other
2853 filters. The <kbd>Lanczos</kbd> filter for example is defined in terms of
2854 a <kbd>SincFast</kbd> windowed <kbd>SincFast</kbd> filter, while
2855 <kbd>Mitchell</kbd> is defined as a <kbd>Cubic</kbd> filter with specific
2856 'B' and 'C' settings. </dd>
cristy3ed852e2009-09-05 21:47:34 +00002857
2858</dl>
2859
cristyd0bda5e2010-09-21 16:22:45 +00002860<p>For example, to get a 8 lobe Bessel windowed Bessel filter:</p>
cristy3ed852e2009-09-05 21:47:34 +00002861
2862<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
2863 -set filter:window=bessel -set filter:lobes=8 \ <br/>
2864 -resize 150% image.jpg</span></p>
2865<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
2866
2867<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
2868 -resize 150% image.jpg</span></p>
2869<p>Note that the use of expert options (except for 'blur' with simple resize
cristyd0bda5e2010-09-21 16:22:45 +00002870filters, and 'verbose' for viewing the internal filter selection), are
2871provided for image processing experts who have studied and understood how
2872resize filters work. Without this knowledge, and an understanding of the
2873definition of the actual filters involved, using expert settings are more
2874likely to be detrimental to your image resizing.</p>
cristy3ed852e2009-09-05 21:47:34 +00002875
2876
2877<div style="margin: auto;">
2878 <h4><a name="flatten" id="flatten"></a>-flatten</h4>
2879</div>
2880
2881<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>
2882
2883
2884<div style="margin: auto;">
2885 <h4><a name="flip" id="flip"></a>-flip</h4>
2886</div>
2887
2888<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>
2889
2890<p>reflect the scanlines in the vertical direction.</p>
2891
2892<div style="margin: auto;">
2893 <h4><a name="floodfill" id="floodfill"></a>-floodfill {<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em> <em class="arg">color</em></h4>
2894</div>
2895
2896<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>
2897
2898<div style="margin: auto;">
2899 <h4><a name="flop" id="flop"></a>-flop</h4>
2900</div>
2901
2902<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>
2903
2904<p>reflect the scanlines in the horizontal direction.</p>
2905
2906
2907<div style="margin: auto;">
2908 <h4><a name="font" id="font"></a>-font <em class="arg">name</em></h4>
2909</div>
2910
2911<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>
2912
2913<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>
2914
2915<p>In addition to the fonts specified by the above pre-defined list, you can
2916also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
2917is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
2918<kbd>x:fixed</kbd> is X11 font.</p>
2919
2920<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>
2921
2922
2923<div style="margin: auto;">
2924 <h4><a name="foreground" id="foreground"></a>-foreground <em class="arg">color</em></h4>
2925</div>
2926
2927<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>
2928
2929<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
2930
2931<p>The default foreground color is black.</p>
2932
2933<div style="margin: auto;">
2934 <h4><a name="format" id="format"></a>-format <em class="arg">type</em></h4>
2935</div>
2936
2937<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>
2938
2939<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>
2940
2941<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>
2942
2943<div style="margin: auto;">
2944 <h4><a name="format_identify_" id="format_identify_"></a>-format <em class="arg">string</em></h4>
2945</div>
2946
2947<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>
2948
2949<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>
2950
2951<div style="margin: auto;">
2952 <h4><a name="frame" id="frame"></a>-frame <em class="arg">geometry</em></h4>
2953</div>
2954
2955<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>
2956
cristybc9539a2010-08-16 18:06:20 +00002957<p>The color of the border is specified with the <a href="#mattecolor"
2958>-mattecolor</a> command line option. </p>
cristy3ed852e2009-09-05 21:47:34 +00002959
cristybc9539a2010-08-16 18:06:20 +00002960<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
2961class="arg">geometry</em> argument indicates the amount of extra width and
2962height that is added to the dimensions of the image. If no offsets are given
2963in the <em class="arg">geometry</em> argument, then the border added is
2964a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that
2965the width and height of the border is partitioned to form an outer bevel of
2966thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness
2967<em>y</em>&nbsp;pixels. Negative offsets make no sense as frame arguments.
2968</p>
2969
2970<p>The <a href="#frame">-frame</a> option is affected by the current <a
2971href="#compose">-compose</a> setting and assumes that this is using the default
cristyd0bda5e2010-09-21 16:22:45 +00002972'<kbd>Over</kbd>' composition method. It generates a image of the appropriate
cristybc9539a2010-08-16 18:06:20 +00002973size with the current <a href="#bordercolor">-bordercolor</a> setting, and then
2974draws the frame of four distinct colors close to the current <a
2975href="#mattecolor">-mattecolor</a>. The original image is then overlaid onto
2976center of this image. This means that with the default compose method of
2977'<kbd>Over</kbd>' any transparent parts may be replaced by the current <a
2978href="#bordercolor">-bordercolor</a> setting.</p>
2979
2980<p>The image composition is not
2981affected by the <a href="#gravity">-gravity</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00002982
2983
2984<div style="margin: auto;">
2985 <h4><a name="frame_import_" id="frame_import_"></a>-frame</h4>
2986</div>
2987
2988<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>
2989
2990<div style="margin: auto;">
2991 <h4><a name="function" id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
2992</div>
2993
2994<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>
2995
2996<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>
2997
2998<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>
2999
3000<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>
3001
3002<pre class="text">
3003 Polynomial
3004 Sinusoid
3005 Arcsin
3006 Arctan
3007</pre>
3008
3009<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3010
3011<dl class="doc">
3012<dt><kbd>Polynomial</kbd></dt>
3013<dd>
3014<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>
3015
3016<div style="text-align: center">
3017 -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>
3018</div>
3019
3020<p>will invoke a polynomial function given by</p>
3021
3022<div style="text-align: center">
3023 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3024 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3025 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3026</div>
3027
3028<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3029
3030<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>
3031
3032<table class="doc">
3033 <col width="35%" />
3034 <col width="35%" />
3035 <col width="30%" />
3036 <tr>
3037 <td>-evaluate Set <em class="arg">value</em> </td>
3038 <td>-function Polynomial <em class="arg">value</em></td>
3039 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3040 </tr>
3041 <tr>
3042 <td>-evaluate Add <em class="arg">value</em> </td>
3043 <td>-function Polynomial 1,<em class="arg">value</em></td>
3044 </tr>
3045 <tr>
3046 <td>-evaluate Subtract <em class="arg">value</em> </td>
3047 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3048 </tr>
3049 <tr>
3050 <td>-evaluate Multiply <em class="arg">value</em> </td>
3051 <td>-function Polynomial <em class="arg">value</em>,0</td>
3052 </tr>
3053 <tr>
3054 <td>+level black% x white%</td>
3055 <td>-function Polynomial A,B</td>
3056 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3057 </tr>
3058</table>
3059
3060<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>
3061</dd>
3062
3063<dt><kbd>Sinusoid</kbd></dt>
3064<dd>
3065<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>
3066
3067<div style="text-align: center">
3068 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3069</div>
3070
3071<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>
3072
3073<div style="text-align: center">
3074<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>
3075</div>
3076
3077<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>
3078
3079<p class="crtsnip">
3080 -function Sinusoid 3,-90,.2,.7
3081</p>
3082
3083<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>
3084
3085<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>
3086
3087<table class="doc">
3088 <tr>
3089 <td>-evaluate Sin <em class="arg">freq</em> </td>
3090 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3091 </tr>
3092 <tr>
3093 <td>-evaluate Cos <em class="arg">freq</em> </td>
3094 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3095 </tr>
3096</table>
3097</dd>
3098
3099<dt><kbd>ArcSin</kbd></dt>
3100<dd>
3101<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3102and can be used to generate cylindrical distortion and displacement maps.
3103The curve can be adjusted relative to both the input values and output range
3104of values.
3105
3106<div style="text-align: center">
3107 -function <kbd>ArcSin</kbd> <em class="arg">width</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
3108</div>
3109
3110<p>with all values given in terms of noramlize color values (0.0 for black,
31111.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3112for bout input (<em class="arg">width</em>), and output (<em
3113class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3114
3115<div style="text-align: center">
3116<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>
3117</div>
3118
3119</dd>
3120
3121<dt><kbd>ArcTan</kbd></dt>
3122<dd>
3123<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3124limit values at infinities, though a center using the given slope value.
3125All these values can be adjusted via the arguments.
3126
3127<div style="text-align: center">
3128 -function <kbd>ArcTan</kbd> <em class="arg">slope</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
3129</div>
3130
3131<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3132</p>
3133
3134<div style="text-align: center">
3135<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>
3136</div>
3137
3138</dd>
3139
3140</dl>
3141
3142
3143<div style="margin: auto;">
3144 <h4><a name="fuzz" id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
3145</div>
3146
3147<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>
3148
3149<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>
3150
3151<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>
3152
3153
3154<div style="margin: auto;">
3155 <h4><a name="fx" id="fx"></a>-fx <em class="arg">expression</em></h4>
3156</div>
3157
3158<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>
3159
3160<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>
3161
3162<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3163
3164
3165<div style="margin: auto;">
3166 <h4><a name="gamma" id="gamma"></a>-gamma <em class="arg">value</em></h4>
3167</div>
3168
3169<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>
3170
3171<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>
3172
3173<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>
3174
3175<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>
3176
3177<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>
3178
3179<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3180
3181<div style="margin: auto;">
3182 <h4><a name="gaussian-blur" id="gaussian-blur"></a>-gaussian-blur <em class="arg">radius</em><br />-gaussian-blur <em class="arg">radius</em>x<em class="arg">sigma</em></h4>
3183</div>
3184
3185<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>
3186
cristyb15553d2010-07-03 22:53:14 +00003187<p>Convolve the image with a Gaussian or normal distribution using the given
3188<em class="arg" >Sigma</em> value. The formula is:</p>
cristy3ed852e2009-09-05 21:47:34 +00003189
3190<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3191</div>
3192
cristyb15553d2010-07-03 22:53:14 +00003193<p>The <em class="arg" >Sigma</em> value is the important argument, and
cristyefb2bdb2010-11-20 19:35:22 +00003194determines the actual amount of blurring that will take place. </p>
cristyb15553d2010-07-03 22:53:14 +00003195
3196<p>The <em class="arg" >Radius</em> is only used to determine the size of the
cristyefb2bdb2010-11-20 19:35:22 +00003197array which will hold the calculated Gaussian distribution. It should be an
cristyd0bda5e2010-09-21 16:22:45 +00003198integer. If not given, or set to zero, IM will calculate the largest possible
cristyb15553d2010-07-03 22:53:14 +00003199radius that will provide meaningful results for the Gaussian distribution.
3200</p>
3201
3202<p>The larger the <em class="arg" >Radius</em> the radius the slower the
3203operation is. However too small a <em class="arg" >Radius</em>, and sever
3204aliasing effects may result. As a guideline, <em class="arg" >Radius</em>
3205should be at least twice the <em class="arg" >Sigma</em> value, though three
3206times will produce a more accurite result. </p>
cristy3ed852e2009-09-05 21:47:34 +00003207
3208<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
cristyd0bda5e2010-09-21 16:22:45 +00003209full 2-dimensional convolution is used to generate the weighted average of the
3210neighboring pixels. </p>
cristy3ed852e2009-09-05 21:47:34 +00003211
3212<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3213pixels which are outside the image proper are blurred into the final result.
3214</p>
3215
3216
3217<div style="margin: auto;">
3218 <h4><a name="geometry" id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
3219</div>
3220
3221<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>
3222
3223<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>
3224
3225<div style="margin: auto;">
3226 <h4><a name="gravity" id="gravity"></a>-gravity <em class="arg">type</em></h4>
3227</div>
3228
3229<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>
3230
3231<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3232<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3233<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3234list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3235installation.</p>
3236
3237<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>
3238
3239<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>
3240
3241<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>
3242
cristy4949d522010-03-12 18:41:34 +00003243<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 +00003244<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>
3245
3246<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>
3247
3248
3249<div style="margin: auto;">
3250 <h4><a name="green-primary" id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
3251</div>
3252
3253<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>
3254
3255
3256<div style="margin: auto;">
3257 <h4><a name="hald-clut" id="hald-clut"></a>-hald-clut</h4>
3258</div>
3259
3260<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>
3261
3262<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3263dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3264can apply any color transformation to the Hald image and then use this option
3265to apply the transform to the image. </p>
3266
3267<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3268<p>This option provides a convenient method for you to use Gimp or Photoshop
3269to make color corrections to the Hald CLUT image and subsequently apply them
3270to multiple images using an ImageMagick script. </p>
3271
3272<p>Note that the representation is only of the normal RGB color space and that
3273the whole color value triplet is used for the interpolated lookup of the
3274represented Hald color cube image. Because of this the operation is not <a
3275href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3276images transparency or alpha/matte channel.</p>
3277
3278<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3279of the individual color channels, usally involving a simplier gray-scale
3280image. E.g: gray-scale to color replacement, or modification by a histogram
3281mapping. </p>
3282
3283
3284<div style="margin: auto;">
3285 <h4><a name="help" id="help"></a>-help</h4>
3286</div>
3287
3288<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>
3289
3290<div style="margin: auto;">
3291 <h4><a name="highlight-color" id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
3292</div>
3293
3294<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>
3295
3296<div style="margin: auto;">
3297 <h4><a name="iconGeometry" id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
3298</div>
3299
3300<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>
3301
3302<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>
3303
3304<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>
3305
3306<div style="margin: auto;">
3307 <h4><a name="iconic" id="iconic"></a>-iconic</h4>
3308</div>
3309
3310<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>
3311
3312<div style="margin: auto;">
3313 <h4><a name="identify" id="identify"></a>-identify</h4>
3314</div>
3315
3316<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>
3317
3318<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>
3319
3320<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>
3321
cristyd0bda5e2010-09-21 16:22:45 +00003322<p>If <a href="#verbose">-verbose</a> precedes this option, copious
cristy3ed852e2009-09-05 21:47:34 +00003323amounts of image properties are displayed including image statistics, profiles,
3324image histogram, and others.</p>
3325
3326<div style="margin: auto;">
3327 <h4><a name="ift" id="ift"></a>-ift</h4>
3328</div>
3329
3330<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>
3331
cristyb36feb22010-03-26 16:54:37 +00003332<p>This option is new as of ImageMagick 6.5.4-3 (and now working for Windows users in ImageMagick 6.6.0-9). It transforms a pair of magnitude and phase images from the frequency domain to a single image in the normal or spatial domain. See for example, <a href="http://en.wikipedia.org/wiki/Fourier_transform" target="_blank">Fourier Transform</a>, <a href="http://en.wikipedia.org/wiki/DFT" target="_blank">Discrete Fourier Transform</a> and <a href="http://en.wikipedia.org/wiki/FFT" target="_blank">Fast Fourier Transform</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00003333
3334<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>
3335
3336<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3337<p>or</p>
3338
3339<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>
3340
cristyd0bd44a2010-09-24 12:38:11 +00003341<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.
cristy3ed852e2009-09-05 21:47:34 +00003342
3343<p>The <a href="http://www.fftw.org/" target="_blank">FFTW</a> delegate library is required to use <a href="#ift">-ift</a>.
3344
3345<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.
3346
3347<div style="margin: auto;">
3348 <h4><a name="immutable" id="immutable"></a>-immutable</h4>
3349</div>
3350
3351<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>
3352
3353<div style="margin: auto;">
3354 <h4><a name="implode" id="implode"></a>-implode <em class="arg">factor</em></h4>
3355</div>
3356
3357<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>
3358
3359<div style="margin: auto;">
3360 <h4><a name="insert" id="insert"></a>-insert <em class="arg">index</em></h4>
3361</div>
3362
3363<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>
3364
3365<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>
3366
3367<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>
3368
3369<div style="margin: auto;">
3370 <h4><a name="intent" id="intent"></a>-intent <em class="arg">type</em></h4>
3371</div>
3372
3373<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>
3374
3375<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>
3376
3377<p>The default intent is undefined.</p>
3378
3379<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3380
3381<div style="margin: auto;">
3382 <h4><a name="interlace" id="interlace"></a>-interlace <em class="arg">type</em></h4>
3383</div>
3384
3385<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>
3386
3387<p>Choose from:</p>
3388
3389<pre class="text">
3390 none
3391 line
3392 plane
3393 partition
3394 JPEG
3395 GIF
3396 PNG
3397</pre>
3398
3399<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>
3400
3401<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3402
3403<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3404
3405<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3406
3407<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3408image.G, and image.B).</p>
3409
3410<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>
3411image.</p>
3412
3413<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3414
3415<div style="margin: auto;">
3416 <h4><a name="interpolate" id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
3417</div>
3418
3419<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>
3420
cristyd0bda5e2010-09-21 16:22:45 +00003421<p>When looking up the color of a pixel using a non-integer floating point
cristy3ed852e2009-09-05 21:47:34 +00003422value, you typically fall in between the pixel colors defined by the source
3423image. This setting determines how the color is determined from the colors of
3424the pixels surrounding that point. That is how to determine the color of a
3425point that falls between two, or even four different colored pixels. </p>
3426
3427<pre class="text">
3428 integer: The color of the top-left pixel (floor function)
3429 nearest-neighbor: The nearest pixel to the lookup point (rounded function)
3430 average: The average color of the surrounding four pixels
3431 bilinear A double linear interpolation of pixels (the default)
3432 mesh Divide area into two flat triangular interpolations
3433 bicubic Fitted bicubic-spines of surrounding 16 pixels
3434 spline Direct spline curves (colors are blurred)
3435 filter Use resize <a href="#filter">-filter</a> settings
3436</pre>
3437
3438<p>This most important for distortion operators such as <a href="#distort"
3439>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3440>-transform</a> and <a href="#fx" >-fx</a>. </p>
3441
3442<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3443
3444<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3445lookup for positions outside the boundaries of the image. </p>
3446
3447
3448<div style="margin: auto;">
cristyf3bb4782009-09-08 13:10:04 +00003449 <h4><a name="interline-spacing" id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
3450</div>
3451
3452<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>
3453
3454<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00003455 <h4><a name="interword-spacing" id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
3456</div>
3457
3458<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>
3459
3460<div style="margin: auto;">
3461 <h4><a name="kerning" id="kerning"></a>-kerning <em class="arg">value</em></h4>
3462</div>
3463
3464<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>
3465
3466<div style="margin: auto;">
3467 <h4><a name="label" id="label"></a>-label <em class="arg">name</em></h4>
3468</div>
3469
3470<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>
3471
cristy71a3f602010-09-15 12:38:16 +00003472<p>Use this option to assign a specific label to the image, as it is read in
3473or created. You can use the <a href="#set" >-set</a> operation to re-assign
3474a the labels of images already read in. Image formats such as TIFF, PNG,
3475MIFF, supports saving the label information with the image.</p>
cristy3ed852e2009-09-05 21:47:34 +00003476
cristy71a3f602010-09-15 12:38:16 +00003477<p>When saving an image to a <em class="arg">PostScript</em> file, any label
3478assigned to an image is used as a header string to print above the postscript
3479image. </p>
cristy3ed852e2009-09-05 21:47:34 +00003480
cristybc9539a2010-08-16 18:06:20 +00003481<p>You can include the image filename, type, width, height, or other image
3482attribute by embedding special format character. See <a href="../www/escape.html">Format and Print Image
3483Properties</a> for details of the percent escape codes.</p>
cristy3ed852e2009-09-05 21:47:34 +00003484
3485<p>For example,</p>
3486
3487<p class="crtsnip">
3488 -label "%m:%f %wx%h" bird.miff
3489</p>
3490
cristy71a3f602010-09-15 12:38:16 +00003491<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the
3492"<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it
3493is read in. If a <a href="#label">+label</a> option was used instead, any
3494existing label present in the image would be used. You can remove all labels
3495from an image by assigning the empty string. </p>
cristy3ed852e2009-09-05 21:47:34 +00003496
cristy71a3f602010-09-15 12:38:16 +00003497<p>A label is not drawn on the image, but is embedded in the image datastream
3498via <em>Label</em> tag or similar mechanism. If you want the label to be
3499visible on the image itself, use the <a href="#draw">-draw</a> option, or
3500during the final processing in the creation of a image montage.</p>
cristy3ed852e2009-09-05 21:47:34 +00003501
cristy71a3f602010-09-15 12:38:16 +00003502<p>If the first character of <em class="arg">string</em> is <em
3503class="arg">@</em>, the image label is read from a file titled by the
3504remaining characters in the string. Labels in a file are literal, no embedded
3505formatting characters are recognized.</p>
cristy3ed852e2009-09-05 21:47:34 +00003506
3507
3508<div style="margin: auto;">
3509 <h4><a name="lat" id="lat"></a>-lat <em class="arg">width</em><br />-lat <em class="arg">width</em>x<em class="arg">height</em>{<em class="arg">+-</em>}<em class="arg">offset</em>{<em class="arg">%</em>}</h4>
3510</div>
3511
3512<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>
3513
3514<p>Adaptively threshold each pixel based on the value of pixels in a
3515surrounding window. If the current pixel is lighter than this average plus
3516the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3517black. Small variations in pixel values such as found in scanned documents
3518can be ignored if offset is positive. A negative offset will make it more
3519sensitive to those small variations. </p>
3520
3521<p>This is commonly used to threshold images with an uneven background. It is
3522based on the assumption that average color of the small window is the
3523the local background color, from which to separate the forground color. </p>
3524
3525
3526<div style="margin: auto;">
3527 <h4><a name="layers" id="layers"></a>-layers <em class="arg">method</em></h4>
3528</div>
3529
3530<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>
3531
3532<p>Perform various image operation methods to a ordered sequence of images
3533which may represent either a set of overlaid 'image layers', a GIF disposal
3534animation, or a fully-'coalesced' animation sequence. </p>
3535
3536<table class="doc">
3537 <tbody>
3538 <tr valign="top">
3539 <th align="left" style="width: 8%">Method</th>
3540 <th align="left">Description</th>
3541 </tr>
3542
3543 <tr valign="top">
3544 <td valign="top">compare-any</td>
3545 <td valign="top">Crop the second and later frames to the smallest rectangle
3546 that contains all the differences between the two images. No GIF <a
3547 href="#dispose" >-dispose</a> methods are taken into account. </td>
3548 </tr>
3549
3550 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3551 >-deconstruct</a> operator, and does not preserve animations normal
3552 working, especially when animation used layer disposal methods such as
3553 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3554 </tr>
3555
3556 <tr valign="top">
3557 <td valign="top">compare-clear</td>
3558 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3559 opaque pixels which become transparent in the second frame. That is the
3560 smallest image needed to mask or erase pixels for the next frame. </td>
3561 </tr>
3562
3563 <tr valign="top">
3564 <td valign="top">compare-overlay</td>
3565 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3566 extra color to the next image, as a result of overlaying color pixels.
3567 That is the smallest single overlaid image to add or change colors. </td>
3568 </tr>
3569
3570 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3571 composition method '<kbd>change-mask</kbd>', to reduce the image to
3572 just the pixels that need to be overlaid. </td>
3573 </tr>
3574
3575 <tr valign="top">
3576 <td valign="top">coalesce</td>
3577 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3578 >-coalesce</a> operator. Apply the layer disposal methods set in the
3579 current image sequence to form a fully defined animation sequence, as
3580 it should be displayed. Effectively converting a GIF animation into a
3581 'film strip'-like animation. </td>
3582 </tr>
3583
3584 <tr valign="top">
3585 <td valign="top">composite</td>
3586 <td valign="top">Alpha Composition of two image lists, separated by a
3587 "<kbd>null:</kbd>" image, with the destination image list first, and
3588 the source images last. An image from each list are composited
3589 together until one list is finished. The separator image and source
3590 image lists are removed. </td>
3591 </tr>
3592
3593
cristybac7a162010-06-15 19:57:29 +00003594 <tr><td></td>
3595 <td>The <a href="#geometry" >-geometry</a> offset is adjusted according
3596 to <a href="#gravity" >-gravity</a> in accordance of the virtual
3597 canvas size of the first image in each list. Unlike a normal <a
cristy3ed852e2009-09-05 21:47:34 +00003598 href="#composite" >-composite</a> operation, the canvas offset is also
cristybac7a162010-06-15 19:57:29 +00003599 added to the final composite positioning of each image. </td> </tr>
cristy3ed852e2009-09-05 21:47:34 +00003600
cristybac7a162010-06-15 19:57:29 +00003601 <tr><td></td>
3602 <td>If one of the image lists only contains one image, that image is
cristy3ed852e2009-09-05 21:47:34 +00003603 applied to all the images in the other image list, regardless of which
3604 list it is. In this case it is the image meta-data of the list which
3605 preserved. </td>
3606 </tr>
3607
3608
3609 <tr valign="top">
3610 <td valign="top">dispose</td>
3611 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3612 the animation after the layer disposal method has been applied, before
3613 the next sub-frame image is overlaid. That is the 'dispose' image that
3614 results from the application of the GIF <a href="#dispose"
3615 >-dispose</a> method. This allows you to check what
3616 is going wrong with a particular animation you may be developing.
3617 </td>
3618 </tr>
3619
3620 <tr valign="top">
3621 <td valign="top">flatten</td>
3622 <td valign="top">Create a canvas the size of the first images virtual
3623 canvas using the current <a href="#background" >-background</a> color,
3624 and <a href="#compose" >-compose</a> each image in turn onto that
3625 canvas. Images falling outside that canvas is clipped. Final
3626 image will have a zero virtual canvas offset. </td>
3627 </tr>
3628
cristybac7a162010-06-15 19:57:29 +00003629 <tr><td></td>
3630 <td>This usally used as one of the final 'image layering' operations
cristy3ed852e2009-09-05 21:47:34 +00003631 overlaying all the prepared image layers into a final image. </td>
3632 </tr>
3633
cristybac7a162010-06-15 19:57:29 +00003634 <tr><td></td>
3635 <td>For a single image this method can also be used to fillout a virtual
cristy3ed852e2009-09-05 21:47:34 +00003636 canvas with real pixels, or to underlay a opaque color to remove
3637 transparency from an image.</td>
3638 </tr>
3639
3640
3641 <tr valign="top">
3642 <td valign="top">merge</td>
3643 <td valign="top">As 'flatten' method but merging all the given image
3644 layers into a new layer image just large enough to hold all the image
3645 without clipping or extra space. The new images virtual offset will
3646 prevere the position of the new layer, even if this offset is
3647 negative. the virtual canvas size of the first image is preserved.
3648 </td>
3649 </tr>
3650
3651 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3652 as few image file formats handle them correctly. </td>
3653 </tr>
3654
3655 <tr valign="top">
3656 <td valign="top">mosaic</td>
3657 <td valign="top">As 'flatten' method but expanding the initial canvas size
3658 of the first image so as to hold all the image layers. However as a
cristyd0bda5e2010-09-21 16:22:45 +00003659 virtual canvas is 'locked' to the origin, by definition, image layers
cristy3ed852e2009-09-05 21:47:34 +00003660 with a negative offsets will still be clipped by the top and left
3661 edges.</td>
3662 </tr>
3663
3664 <tr><td></td><td>This method is commonly used to layout individual image using various
cristyd0bda5e2010-09-21 16:22:45 +00003665 offset but without knowing the final canvas size. The resulting image
cristy3ed852e2009-09-05 21:47:34 +00003666 will, like 'flatten' not have any virtual offset, so can be saved to
3667 any image file format. </td>
3668 </tr>
3669
3670
3671 <tr valign="top">
3672 <td valign="top">optimize</td>
3673 <td valign="top">Optimize a coalesced animation, into GIF animation using
3674 a number of general techniques. This currently a short cut to
3675 apply both the '<kbd>optimize-frame</kbd>', and
3676 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3677 include other optimization methods as they are developed. </td>
3678 </tr>
3679
3680 <tr valign="top">
3681 <td valign="top">optimize-frame</td>
3682 <td valign="top">Optimize a coalesced animation, into GIF animation by
3683 reducing the number of pixels per frame as much as possible by
3684 attempting to pick the best layer disposal method to use, while ensuring
3685 the result will continue to animate properly. </td>
3686 </tr>
3687
3688 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3689 then no reasonably fast GIF optimization algorithm can do this.
3690 However this does seem to do better than most other GIF frame
3691 optimizers seen. </td>
3692 </tr>
3693
3694 <tr valign="top">
3695 <td valign="top">optimize-plus</td>
3696 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3697 overall optimization by adding extra frames to the animation, without
3698 changing the final look or timing of the animation. The frames are
3699 added to attempt to separate the clearing of pixels from the
3700 overlaying of new additional pixels from one animation frame to the
3701 next. If this does not improve the optimization (for the next frame
3702 only), it will fall back to the results of the previous normal
3703 '<kbd>optimize-frame</kbd>' technique. </td>
3704 </tr>
3705
3706 <tr><td></td><td>There is the possibility that the change in the disposal style will
3707 result in a worsening in the optimization of later frames, though this
3708 is unlikely. In other words there no guarantee that it is better than
3709 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
cristyd0bda5e2010-09-21 16:22:45 +00003710 however you can get a vast improvement in the final animation size. </td>
cristy3ed852e2009-09-05 21:47:34 +00003711 </tr>
3712
3713 <tr valign="top">
3714 <td valign="top">optimize-transparency</td>
3715 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3716 overlay images with transparency, if it does not change the resulting
3717 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3718 </td>
3719 </tr>
3720
3721 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3722 into a smaller file size due to larger areas of one (transparent)
3723 color rather than a pattern of multiple colors repeating the current
3724 disposed image of the last frame. </td>
3725 </tr>
3726
3727 <tr valign="top">
3728 <td valign="top">remove-dups</td>
3729 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3730 images, so as to simplify layer overlays of coalesced animations.
3731 </td>
3732 </tr>
3733
3734 <tr><td></td><td>Usually this a result of using a constant time delay across the
3735 whole animation, or after a larger animation was split into smaller
3736 sub-animations. The duplicate frames could also have been used as
3737 part of some frame optimization methods. </td>
3738 </tr>
3739
3740 <tr valign="top">
3741 <td valign="top">remove-zero</td>
3742 <td valign="top">Remove any image with a zero time delay, unless ALL the
3743 images have a zero time delay (and is not a proper timed animation, a
3744 warning is then issued). </td>
3745 </tr>
3746
3747 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3748 partial intermediary updates between the frames that are actually
3749 displayed to users. These frames are usally added for improved frame
3750 optimization in GIF animations. </td>
3751 </tr>
3752
3753 <tr valign="top">
3754 <td valign="top">trim-bounds</td>
3755 <td valign="top">Find the bounds of all the images in the current
3756 image sequence, then adjust the offsets so all images are contained on
3757 a minimal positive canvas. None of the image data is modified, only
3758 there virtual canvas size and offset. The all the image is given
3759 the same canvas size, and and will have a positive offset, but will
3760 remain in the same position relative to each other. As a result of the
3761 minimal canvas size at least one image will touch every edge of that
3762 canvas. The image data however may be transparent.
3763 </td>
3764 </tr>
3765
3766 </tbody>
3767</table>
3768
3769<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3770
3771<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3772>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3773>-mosaic</a> are only aliases for the above methods. Also see <a
3774href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3775href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3776>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3777
3778
3779<div style="margin: auto;">
3780 <h4><a name="level" id="level"></a>-level <em class="arg">black_point</em>{,<em class="arg">white_point</em>}{<em class="arg">%</em>}{,<em class="arg">gamma</em>}</h4>
3781</div>
3782
3783<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>
3784
3785<p>Given one, two or three values delimited with commas: black-point,
3786white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3787white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3788point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3789contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3790both black and white points are percentages of the full color range. Gamma
3791will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3792omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3793
3794<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3795the given '<kbd>black_point</kbd>' value in the original image is set to
3796zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3797<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3798to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3799adjusted. </p>
3800
3801<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3802adding the special '!' flag anywhere in the argument list, will cause the
3803operator to do the reverse of the level adjustment. That is a zero, or
3804<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
3805adjusted to the given level values, allowing you to de-contrast, or compress
3806the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
3807
3808<p>Only the channels defined by the current <a href="#channel">-channel</a>
3809setting are adjusted (defaults to RGB color channels only), allowing you to
3810limit the effect of this operator. </p>
3811
3812<p>Please note that the transparency channel is treated as 'matte'
3813values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
3814
3815
3816<div style="margin: auto;">
3817 <h4><a name="level-colors" id="level-colors"></a>-level-colors {<em
3818 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
3819</div>
3820
cristyd0bda5e2010-09-21 16:22:45 +00003821<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 +00003822
3823<p>This function is exactly like <a href="#level">-level</a>, except that the
3824value value for each color channel is determined by the
3825'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
3826described under the <a href="#fill">-fill</a> option). </p>
3827
cristyd0bda5e2010-09-21 16:22:45 +00003828<p>This effectually means the colors provided to <kbd>-level-colors</kbd>
3829is mapped to become 'black' and 'white' respectively, with all the other
cristy3ed852e2009-09-05 21:47:34 +00003830colors linearly adjusted (or clipped) to match that change. Each channel is
cristyd0bda5e2010-09-21 16:22:45 +00003831adjusted separately using the channel values of the colors specified. </p>
cristy3ed852e2009-09-05 21:47:34 +00003832
3833<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
3834will map the image color 'black' and 'white' to the given colors
cristyd0bda5e2010-09-21 16:22:45 +00003835respectively, resulting in a gradient (de-contrasting) tint of the image to
cristy3ed852e2009-09-05 21:47:34 +00003836those colors. This can also be used to convert a plain gray-scale image into a
3837one using the gradient of colors specified. </p>
3838
3839<p>By supplying a single color with a comma separator either before or after
3840that color, will just replace the respective 'black' or 'white' point
cristyd0bda5e2010-09-21 16:22:45 +00003841respectively. But if no comma separator is provided, the given color is
cristy3ed852e2009-09-05 21:47:34 +00003842used for both the black and white color points, making the operator either
3843threshold the images around that color (- form) or set all colors to that
3844color (+ form). </p>
3845
3846
3847<div style="margin: auto;">
3848 <h4><a name="limit" id="limit"></a>-limit <em class="arg">type value</em></h4>
3849</div>
3850
3851<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>
3852
3853<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>
3854
cristy6b636652009-12-05 17:16:11 +00003855<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 +00003856
3857<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00003858 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00003859</p>
3860
3861<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
3862
cristy6b636652009-12-05 17:16:11 +00003863<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list resource</span><span class='crtout'><pre>File Area Memory Map Disk Thread Time
3864------------------------------------------------------------------------------
3865 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited</pre>
cristy3ed852e2009-09-05 21:47:34 +00003866</span></p>
3867<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>
3868
3869<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>
3870
3871<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>
3872
3873<p class="crtsnip">
3874-limit area 10mb
3875</p>
3876
cristyd0bda5e2010-09-21 16:22:45 +00003877<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 +00003878
3879<p class="crtsnip">
3880-limit area 10mb -limit disk 500mb
3881</p>
3882
3883<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
3884
3885<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>
3886
3887<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.
3888</p>
3889
3890<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.
3891</p>
3892
3893<div style="margin: auto;">
3894 <h4><a name="linear-stretch" id="linear-stretch"></a>-linear-stretch <em class="arg">black-point</em><br />-linear-stretch <em class="arg">black-point</em>{x<em class="arg">white-point</em>}{<em class="arg">%</em>}}</h4>
3895</div>
3896
3897<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>
3898
cristyd934d102009-10-10 12:55:13 +00003899<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
3900and uses a 'histogram bin' to determine the range of color values that needs to
3901be stretched. However it then stretchs those colors using the <a
3902href="#level" >-level</a> operator.</p>
3903
3904<p>As such while the initial determination may have 'binning' round off
3905effects, the image colors are stretched mathematically, rather than using the
3906histogram bins. This makes the operator more accurate. </p>
3907
3908<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
3909'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
3910perfect stretch of the color range. </p>
3911
3912<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
3913normalization of mathematical images. </p>
3914
3915<p>This operator is under review for re-development. </p>
3916
3917
cristy3ed852e2009-09-05 21:47:34 +00003918<div style="margin: auto;">
3919 <h4><a name="linewidth" id="linewidth"></a>-linewidth</h4>
3920</div>
3921
3922<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>
3923
3924<div style="margin: auto;">
3925 <h4><a name="liquid-rescale" id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
3926</div>
3927
3928<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>
3929
3930<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>
3931
3932<div style="margin: auto;">
3933 <h4><a name="list" id="list"></a>-list <em class="arg">type</em></h4>
3934</div>
3935
3936<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>
3937
3938<pre class="text">
cristyc1aee832010-05-08 00:36:47 +00003939 Align
3940 Alpha
3941 Boolean
3942 Channel
3943 Class
3944 ClipPath
3945 Coder
3946 Color
3947 Colorspace
3948 Command
3949 Compose
3950 Compress
3951 Configure
3952 DataType
3953 Debug
3954 Decoration
3955 Delegate
3956 Direction
3957 Dispose
3958 Distort
3959 Dither
3960 Endian
3961 Evaluate
3962 FillRule
3963 Filter
3964 Font
3965 Format
3966 Function
3967 Gravity
3968 ImageList
3969 Intent
3970 Interlace
3971 Interpolate
3972 Kernel
cristy787d4352010-03-06 13:55:58 +00003973 Layers
3974 LineCap
3975 LineJoin
3976 List
3977 Locale
3978 LogEvent
3979 Log
3980 Magic
3981 Method
3982 Metric
3983 Mime
3984 Mode
3985 Morphology
3986 Module
3987 Noise
3988 Orientation
3989 Policy
3990 PolicyDomain
3991 PolicyRights
3992 Preview
3993 Primitive
3994 QuantumFormat
3995 Resource
3996 SparseColor
3997 Storage
3998 Stretch
3999 Style
4000 Threshold
4001 Type
4002 Units
4003 Validate
4004 VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004005</pre>
4006
cristybac7a162010-06-15 19:57:29 +00004007<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list
4008list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments
4009available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004010
4011<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4012<div style="margin: auto;">
4013 <h4><a name="log" id="log"></a>-log <em class="arg">string</em></h4>
4014</div>
4015
4016<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>
4017
cristybac7a162010-06-15 19:57:29 +00004018<p>This option specifies the format for the log printed when the <a
4019href="#debug">-debug</a> option is active.</p>
cristy3ed852e2009-09-05 21:47:34 +00004020
cristybac7a162010-06-15 19:57:29 +00004021<p>You can display the following components by embedding special format
4022characters:</p>
cristy3ed852e2009-09-05 21:47:34 +00004023
4024<pre class="text">
4025 %d domain
4026 %e event
4027 %f function
4028 %l line
4029 %m module
4030 %p process ID
4031 %r real CPU time
4032 %t wall clock time
4033 %u user CPU time
4034 %% percent sign
4035 \n newline
4036 \r carriage return
4037</pre>
4038
4039<p>For example:</p>
4040
4041<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>
4042<p>The default behavior is to print all of the components.</p>
4043
4044<div style="margin: auto;">
4045 <h4><a name="loop" id="loop"></a>-loop <em class="arg">iterations</em></h4>
4046</div>
4047
4048<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>
4049
cristybac7a162010-06-15 19:57:29 +00004050<p>Set iterations to zero to repeat the animation an infinite number of times,
4051otherwise the animation repeats itself up to <em class="arg">iterations</em>
4052times.</p>
cristy3ed852e2009-09-05 21:47:34 +00004053
4054<div style="margin: auto;">
4055 <h4><a name="lowlight-color" id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
4056</div>
4057
4058<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>
4059
4060<div style="margin: auto;">
4061 <h4><a name="magnify" id="magnify"></a>-magnify <em class="arg">factor</em></h4>
4062</div>
4063
4064<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>
4065
4066
4067<div style="margin: auto;">
4068 <h4><a name="map" id="map"></a>-map <em class="arg">type</em></h4>
4069</div>
4070
4071<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>
4072
4073<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4074
4075<pre class="text">
4076 best
4077 default
4078 gray
4079 red
4080 green
4081 blue
4082</pre>
4083
cristybac7a162010-06-15 19:57:29 +00004084<p>The <em class="arg">X server</em> must support the <em class="arg">Standard
4085Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as
4086the type and <kbd>display</kbd> searches the list of colormap types in
4087<kbd>top-to-bottom</kbd> order until one is located. See <em
4088class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
cristy3ed852e2009-09-05 21:47:34 +00004089
4090
4091<div style="margin: auto;">
4092 <h4><a name="map_stream_" id="map_stream_"></a>-map <em class="arg">components</em></h4>
4093</div>
4094
4095<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>
4096
4097<p>Here are the valid components of a map:</p>
4098
4099<pre class="text">
4100 r red pixel component
4101 g green pixel component
4102 b blue pixel component
4103 a alpha pixel component (0 is transparent)
4104 o opacity pixel component (0 is opaque)
4105 i grayscale intensity pixel component
4106 c cyan pixel component
4107 m magenta pixel component
4108 y yellow pixel component
4109 k black pixel component
4110 p pad component (always 0)
4111</pre>
4112
cristybac7a162010-06-15 19:57:29 +00004113<p>You can specify as many of these components as needed in any order (e.g.
4114bgr). The components can repeat as well (e.g. rgbr).</p>
4115
cristy3ed852e2009-09-05 21:47:34 +00004116
4117<div style="margin: auto;">
4118 <h4><a name="mask" id="mask"></a>-mask
4119<em class="arg">filename</em></h4>
4120</div>
4121
4122<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>
4123
4124<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
4125
4126<div style="margin: auto;">
4127 <h4><a name="mattecolor" id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
4128</div>
4129
4130<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>
4131
4132<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4133
cristybac7a162010-06-15 19:57:29 +00004134<p>The default matte color is <kbd>#BDBDBD</kbd>, <span
4135style="background-color: #bdbdbd;">this shade of gray</span>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004136
4137<div style="margin: auto;">
cristyd2baf7d2010-03-06 04:26:44 +00004138 <h4><a name="maximum" id="maximum"></a>-maximum</h4>
4139</div>
4140
4141<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>
4142
4143<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004144 <h4><a name="median" id="median"></a>-median <em class="arg">radius</em></h4>
4145</div>
4146
4147<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>
4148
4149<div style="margin: auto;">
4150 <h4><a name="metric" id="metric"></a>-metric <em class="arg">type</em></h4>
4151</div>
4152
4153<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>
4154
4155<p>Choose from:</p>
4156
4157<pre class="text">
cristybac7a162010-06-15 19:57:29 +00004158 AE absolute error count, number of different pixels (-fuzz effected)
4159 MAE mean absolute error (normalized), average channel error distance
4160 MEPP mean error per pixel (normalized mean error, normalized peak error)
4161 MSE mean error squared, average of the channel error squared
cristy771f7a72010-11-27 21:42:59 +00004162 NCC normalized cross correlation
cristybac7a162010-06-15 19:57:29 +00004163 PAE peak absolute (normalize peak absolute)
4164 PSNR peak signal to noise ratio
4165 RMSE root mean squared (normalized root mean squared)
cristy3ed852e2009-09-05 21:47:34 +00004166</pre>
4167
cristy771f7a72010-11-27 21:42:59 +00004168<p>Control the '<kbd>AE</kbd>', or absolute count of pixels that are different,
4169with the <a href="#fuzz" >-fuzz</a> factor (ignore pixels which
4170only changed by a small amount). Use '<kbd>PAE</kbd>' to find the
cristy3ed852e2009-09-05 21:47:34 +00004171size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
cristy771f7a72010-11-27 21:42:59 +00004172'similar', while '<kbd>MAE</kbd>' dtermines the factor needed
cristybac7a162010-06-15 19:57:29 +00004173for about half the pixels to be similar. </p>
cristy3ed852e2009-09-05 21:47:34 +00004174
4175<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4176('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
cristyd0bda5e2010-09-21 16:22:45 +00004177normalized) from a single comparison run. </p>
cristy3ed852e2009-09-05 21:47:34 +00004178
cristybac7a162010-06-15 19:57:29 +00004179<p>To print a complete list of metrics, use the <a href="#list">-list
4180metrics</a> option.</p>
4181
cristy3ed852e2009-09-05 21:47:34 +00004182
cristyd2baf7d2010-03-06 04:26:44 +00004183<div style="margin: auto;">
4184 <h4><a name="minimum" id="minimum"></a>-minimum</h4>
4185</div>
4186
4187<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>
4188
cristy3ed852e2009-09-05 21:47:34 +00004189
4190<div style="margin: auto;">
4191 <h4><a name="mode" id="mode"></a>-mode <em class="arg">value</em></h4>
4192</div>
4193
4194<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>
4195
cristybac7a162010-06-15 19:57:29 +00004196<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame,
4197Unframe, or Concatenate</kbd></p>
cristy3ed852e2009-09-05 21:47:34 +00004198
cristybac7a162010-06-15 19:57:29 +00004199<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>' argument
4200for a list of <a href="#mode" >-mode</a> arguments available in your
4201ImageMagick installation.</p>
cristy3ed852e2009-09-05 21:47:34 +00004202
4203
4204<div style="margin: auto;">
4205 <h4><a name="modulate" id="modulate"></a>-modulate <em class="arg">brightness</em>[,<em class="arg">saturation</em>,<em class="arg">hue</em>]</h4>
4206</div>
4207
cristybac7a162010-06-15 19:57:29 +00004208<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
4209class="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 +00004210
cristyb36feb22010-03-26 16:54:37 +00004211<p>The arguments are given as a percentages of variation. A value of 100 means
4212no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004213
cristyb36feb22010-03-26 16:54:37 +00004214<p>The <em class="arg">brightness</em> is a multiplier of the overall
4215brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4216twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4217before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004218
cristyb36feb22010-03-26 16:54:37 +00004219<p>The <em class="arg">saturation</em> controls the amount of color in an
4220image. For example, 0 produce a grayscale image, while a large value such as
4221200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004222
cristyb36feb22010-03-26 16:54:37 +00004223<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4224within the image by the amount specified. For example, 50 results in
4225a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4226A value of either 0 or 200 results in a complete 180 degree rotation of the
4227image. Using a value of 300 is a 360 degree rotation resulting in no change to
4228the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004229
cristyb36feb22010-03-26 16:54:37 +00004230<p>For example, to increase the color brightness by 20% and decrease the color
4231saturation by 10% and leave the hue unchanged, use <a
4232href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004233
cristyb36feb22010-03-26 16:54:37 +00004234<p>Use <a href="#set">-set</a> attribute of '<kbd
4235class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4236modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4237<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004238
4239<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 +00004240
cristy3ed852e2009-09-05 21:47:34 +00004241<div style="margin: auto;">
4242 <h4><a name="monitor" id="monitor"></a>-monitor</h4>
4243</div>
4244
4245<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>
4246
4247
4248<div style="margin: auto;">
4249 <h4><a name="monochrome" id="monochrome"></a>-monochrome</h4>
4250</div>
4251
4252<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>
4253
4254
4255<div style="margin: auto;">
4256 <h4><a name="morph" id="morph"></a>-morph <em class="arg">frames</em></h4>
4257</div>
4258
4259<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>
4260
4261<p>Both the image pixels and size are linearly interpolated to give the
4262appearance of a meta-morphosis from one image to the next, over all the images
4263in the current image list. The added images are the equivalent of a <a
4264href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4265argument determine how many images to interpolate between each image. </p>
4266
4267
4268<div style="margin: auto;">
cristy488844c2010-01-22 14:02:05 +00004269 <h4><a name="morphology" id="morphology"></a>-morphology</h4>
4270 <h4><a name="morphology" id="morphology"></a>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
4271</div>
4272
cristy2c839602010-04-03 02:32:08 +00004273<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 +00004274
cristy83a272e2010-05-07 20:40:35 +00004275Until I get around to writing a option summary for this, see <A
4276HREF="http://www.imagemagick.org/Usage/morphology/" >IM Usage Examples,
4277Morphology</A>. </P>
4278
4279
cristy488844c2010-01-22 14:02:05 +00004280<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004281 <h4><a name="mosaic" id="mosaic"></a>-mosaic</h4>
4282</div>
4283
4284<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>
4285
4286
4287<div style="margin: auto;">
4288 <h4><a name="motion-blur" id="motion-blur"></a>-motion-blur <em class="arg">radius</em><br />-motion-blur <em class="arg">radius</em>x<em class="arg">sigma</em>+<em class="arg">angle</em></h4>
4289</div>
4290
4291<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>
4292
4293<p>Blur with the given radius, standard deviation (sigma), and angle. The
4294angle given is the angle toward which the image is blurred. That is the
4295direction people would consider the object is coming from. </p>
4296
4297<p>Note that the blur is not uniform distribution, giving the motion a
cristyd0bda5e2010-09-21 16:22:45 +00004298definite sense of direction of movement. </p>
cristy3ed852e2009-09-05 21:47:34 +00004299
4300<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4301pixels which are outside the image proper are blurred into the final result.
4302</p>
4303
4304<div style="margin: auto;">
4305 <h4><a name="name" id="name"></a>-name</h4>
4306</div>
4307
4308<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>
4309<div style="margin: auto;">
4310 <h4><a name="negate" id="negate"></a>-negate</h4>
4311</div>
4312
cristyb29bc032010-02-01 20:29:43 +00004313<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 +00004314
4315<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>
4316
4317<div style="margin: auto;">
4318 <h4><a name="noise" id="noise"></a>-noise <em class="arg">radius</em><br/>
4319 +noise <em class="arg">type</em></h4>
4320</div>
4321
4322<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>
4323
4324<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>
4325
4326<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>
4327
4328<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>
4329
4330<pre class="text">
4331Gaussian
4332Impulse
4333Laplacian
4334Multiplicative
4335Poisson
4336Random
4337Uniform
4338</pre>
4339
4340<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4341
cristy83543962009-10-16 19:04:28 +00004342<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4343the use of a controlling value to specify teh amount of noise that should be
4344added to an image. </p>
4345
cristy3ed852e2009-09-05 21:47:34 +00004346
4347<div style="margin: auto;">
4348 <h4><a name="normalize" id="normalize"></a>-normalize</h4>
4349</div>
4350
4351<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>
4352
cristyd934d102009-10-10 12:55:13 +00004353<p>The intensity values are stretched to cover the entire range of possible
4354values. While doing so, black-out at most <em>2%</em> of the pixels and
4355white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004356
cristyd934d102009-10-10 12:55:13 +00004357<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4358is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4359(Before this version, it was equivalent to <a href="#contrast-stretch"
4360>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004361
cristyd934d102009-10-10 12:55:13 +00004362<p>All the channels are normalized in concert by the came amount so as to
4363preserve color integrity, when the default <a href="#channel" >+channel</a>
cristyd0bda5e2010-09-21 16:22:45 +00004364setting is in use. Specifying any other <a href="#channel" >-channel</a>
cristyd934d102009-10-10 12:55:13 +00004365setting will normalize the RGB channels independently.</p>
4366
4367<p>See <a href="#contrast-stretch" >-contrast-stretch</A> for more details.
4368Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004369that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004370
4371<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004372
4373
4374<div style="margin: auto;">
4375 <h4><a name="ordered-dither" id="ordered-dither"></a>-ordered-dither <em class="arg">threshold_map</em>{,<em class="arg">level</em>...}</h4>
4376</div>
4377
cristyd934d102009-10-10 12:55:13 +00004378<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
4379class="arg">threshold map</em> specified, and a uniform color map with the
4380given 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 +00004381
4382<p>You can choose from these standard threshold maps:</p>
4383
4384<pre class="text">
cristya6d7cf72010-11-07 15:58:34 +00004385threshold 1x1 Threshold 1x1 (non-dither)
4386checks 2x1 Checkerboard 2x1 (dither)
4387o2x2 2x2 Ordered 2x2 (dispersed)
4388o3x3 3x3 Ordered 3x3 (dispersed)
4389o4x4 4x4 Ordered 4x4 (dispersed)
4390o8x8 8x8 Ordered 8x8 (dispersed)
4391h4x4a 4x1 Halftone 4x4 (angled)
4392h6x6a 6x1 Halftone 6x6 (angled)
4393h8x8a 8x1 Halftone 8x8 (angled)
4394h4x4o Halftone 4x4 (orthogonal)
4395h6x6o Halftone 6x6 (orthogonal)
4396h8x8o Halftone 8x8 (orthogonal)
4397h16x16o Halftone 16x16 (orthogonal)
4398c5x5b c5x5 Circles 5x5 (black)
4399c5x5w Circles 5x5 (white)
4400c6x6b c6x6 Circles 6x6 (black)
4401c6x6w Circles 6x6 (white)
4402c7x7b c7x7 Circles 7x7 (black)
4403c7x7w Circles 7x7 (white)
cristy3ed852e2009-09-05 21:47:34 +00004404</pre>
4405
cristyde368992010-11-05 14:32:14 +00004406<p> The <kbd>checks</kbd> pattern produces a 3 level checkerbord dither
cristyd934d102009-10-10 12:55:13 +00004407pattern. Or you can define your own <em class="arg" >threshold map</em> in a
cristyde368992010-11-05 14:32:14 +00004408personal or system <kbd>thresholds.xml</kbd> XML file. </p>
cristy3ed852e2009-09-05 21:47:34 +00004409
cristyd934d102009-10-10 12:55:13 +00004410<p>To print a complete list of threshold, use the <a href="#list" >-list
4411threshold</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004412
cristyd934d102009-10-10 12:55:13 +00004413<p>It is recommended that the <a href="#map" >+map</a> operator be used after
4414applying <a href="#ordered-dither" >-ordered-dither</a> to reduce the number of
cristy3ed852e2009-09-05 21:47:34 +00004415colors an animated image sequence, to less that 256 colors. This ensures that
4416a common or global color table is used when saving the result to a color
4417limited file format such as GIF. </p>
4418
cristyd934d102009-10-10 12:55:13 +00004419<p>Note that at this time the exact same threshold dithering map is used for
4420all color channels, no attempt is made to offset or rotate the map for
4421different channels is made, to create an offset printing effect. (possible
4422future expansion) </p>
cristy3ed852e2009-09-05 21:47:34 +00004423
4424
4425<div style="margin: auto;">
4426 <h4><a name="opaque" id="opaque"></a>-opaque <em class="arg">color</em></h4>
4427</div>
4428
4429<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>
4430
cristyc54f5d42009-11-27 21:36:31 +00004431<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004432described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4433>-fuzz</a> setting can be used to match and replace colors similar to the one
4434given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004435
cristyb36feb22010-03-26 16:54:37 +00004436<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4437the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004438
cristyb36feb22010-03-26 16:54:37 +00004439<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4440as <a href="#opaque" >-opaque</a> but replaces the matching color with
4441transparency rather than the current <a href="#fill">-fill</a> color setting.
4442To ensure that it can do this it also ensures that the image has an alpha
4443channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4444the new transparent colors, and does not require you to modify the <a
4445href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004446
cristy3ed852e2009-09-05 21:47:34 +00004447
4448<div style="margin: auto;">
4449 <h4><a name="orient" id="orient"></a>-orient <em class="arg">image orientation</em></h4>
4450</div>
4451
4452<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>
4453
4454<p>Choose from these orientations:</p>
4455
4456<pre class="text">
4457 bottom-left
4458 bottom-right
4459 left-bottom
4460 left-top
4461 right-bottom
4462 right-top
4463 top-left
4464 top-right
4465 undefined
4466</pre>
4467
cristyd934d102009-10-10 12:55:13 +00004468<p>To print a complete list of orientations, use the <a href="#list" >-list
4469orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004470
4471
4472<div style="margin: auto;">
4473 <h4><a name="page" id="page"></a>-page <em class="arg">geometry</em><br/>
4474 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4475 +page
4476 </h4>
4477</div>
4478
4479<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>
4480
4481<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>
4482
4483<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>
4484
4485<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>
4486<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4487<thead>
4488 <tr valign="top">
4489 <th align="center"><em class="arg">media</em></th>
4490 <th align="center"><em class="arg">width</em></th>
4491 <th align="center"><em class="arg">height</em></th>
4492 </tr>
4493</thead>
4494<tbody>
4495<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4496<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4497<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4498<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4499<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4500<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4501<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4502<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4503<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4504<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4505<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4506<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4507<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4508<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4509<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4510<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4511<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4512<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4513<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4514<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4515<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4516<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4517<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4518<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4519<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4520<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4521<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4522<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4523<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4524<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4525<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4526<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4527<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4528<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4529<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4530<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4531<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4532<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4533</tbody>
4534</table>
4535
4536
4537
4538
4539<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>
4540
4541<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>
4542
4543<p>The default page dimensions for a TEXT image is 612x792.</p>
4544
4545<p>This option is used in concert with <a href="#density">-density</a>.</p>
4546
4547<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4548
4549<div style="margin: auto;">
4550 <h4><a name="paint" id="paint"></a>-paint <em class="arg">radius</em></h4>
4551</div>
4552
4553<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>
4554
4555<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>
4556
4557<div style="margin: auto;">
4558 <h4><a name="path" id="path"></a>-path <em class="arg">path</em></h4></div>
4559
4560<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>
4561
4562<div style="margin: auto;">
4563 <h4><a name="pause_animate_" id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
4564</div>
4565
4566<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>
4567
4568<p>Pause for the specified number of seconds before repeating the animation.</p>
4569
4570<div style="margin: auto;">
4571 <h4><a name="pause_import_" id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
4572</div>
4573
4574<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>
4575
4576<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4577
4578<div style="margin: auto;">
4579 <h4><a name="ping" id="ping"></a>-ping</h4>
4580</div>
4581
4582<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>
4583
4584<div style="margin: auto;">
4585 <h4><a name="pointsize" id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
4586</div>
4587
4588<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>
4589
4590<div style="margin: auto;">
4591 <h4><a name="polaroid" id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
4592</div>
4593
4594<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>
4595
4596<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4597
4598<div style="margin: auto;">
4599 <h4><a name="posterize" id="posterize"></a>-posterize <em class="arg">levels</em></h4>
4600</div>
4601
4602<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>
4603
4604<div style="margin: auto;">
cristyd43a46b2010-01-21 02:13:41 +00004605 <h4><a name="precision" id="precision"></a>-precision <em class="arg">value</em></h4>
4606</div>
4607
4608<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>
4609
4610<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004611 <h4><a name="preview" id="preview"></a>-preview <em class="arg">type</em></h4>
4612</div>
4613
4614<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>
4615
4616<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>
4617
4618<pre class="text">
4619 Rotate
4620 Shear
4621 Roll
4622 Hue
4623 Saturation
4624 Brightness
4625 Gamma
4626 Spiff
4627 Dull
4628 Grayscale
4629 Quantize
4630 Despeckle
4631 ReduceNoise
4632 Add Noise
4633 Sharpen
4634 Blur
4635 Threshold
4636 EdgeDetect
4637 Spread
4638 Shade
4639 Raise
4640 Segment
4641 Solarize
4642 Swirl
4643 Implode
4644 Wave
4645 OilPaint
4646 CharcoalDrawing
4647 JPEG
4648</pre>
4649
4650<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4651
4652<p>The default preview is <kbd>JPEG</kbd>.</p>
4653
4654<div style="margin: auto;">
4655 <h4><a name="print" id="print"></a>-print <em class="arg">string</em></h4>
4656</div>
4657
4658<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>
4659
4660<div style="margin: auto;">
4661 <h4><a name="process" id="process"></a>-process <em class="arg">command</em></h4>
4662</div>
4663
4664<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>
4665
4666<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>
4667
4668<div style="margin: auto;">
4669 <h4><a name="profile" id="profile"></a>-profile <em class="arg">filename</em><br/>
4670 +profile <em class="arg">profile_name</em></h4>
4671</div>
4672
4673<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>
4674
4675<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>
4676
4677<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>
4678
4679<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>
4680
4681<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>
4682
4683<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4684
4685<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4686<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>
4687
4688<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>
4689<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4690CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4691</p>
4692
4693<div style="margin: auto;">
4694 <h4><a name="quality" id="quality"></a>-quality <em class="arg">value</em></h4>
4695</div>
4696
4697<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>
4698
cristy851dbce2010-08-06 21:40:00 +00004699<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 +00004700
4701<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>
4702
cristy851dbce2010-08-06 21:40:00 +00004703<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 +00004704
cristy3c98a4f2010-08-13 20:09:41 +00004705<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 +00004706
4707<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4708
4709<pre class="text">
4710 0: none
4711 1: sub
4712 2: up
4713 3: average
4714 4: Paeth
4715</pre>
4716
4717<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>
4718
4719<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4720
4721<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>
4722
cristy3c98a4f2010-08-13 20:09:41 +00004723<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 +00004724
4725<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4726
cristy3ed852e2009-09-05 21:47:34 +00004727<div style="margin: auto;">
4728 <h4><a name="quantize" id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
4729</div>
4730
cristy3c98a4f2010-08-13 20:09:41 +00004731<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 +00004732
cristy3c98a4f2010-08-13 20:09:41 +00004733<p>This setting defines the colorspace used to sort out and reduce the number
4734of colors needed by an image (for later dithering) by operators such as <a
4735href="#colors" >-colors</a>, Note that color reducion also happens
4736automatically when saving images to color-limited image file formats, such as
4737GIF, and PNG8.</p>
cristy3ed852e2009-09-05 21:47:34 +00004738
4739
4740<div style="margin: auto;">
4741 <h4><a name="quiet" id="quiet"></a>-quiet</h4>
4742</div>
4743
4744<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>
4745
4746<div style="margin: auto;">
4747 <h4><a name="radial-blur" id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
4748</div>
4749
4750<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>
4751
4752<p>Note that this is actually a rotational blur rather than a radial and as
4753such actually mis-named. </p>
4754
4755<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4756pixels which are outside the image proper are blurred into the final result.
4757</p>
4758
4759
4760<div style="margin: auto;">
4761 <h4><a name="raise" id="raise"></a>-raise <em class="arg">thickness</em></h4>
4762</div>
4763
4764<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>
4765
4766<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>.
4767</p>
4768
4769<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4770
4771<div style="margin: auto;">
4772 <h4><a name="random-threshold" id="random-threshold"></a>-random-threshold <em class="arg">low</em>x<em class="arg">high</em></h4>
4773</div>
4774
4775<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>
4776
4777<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004778 <h4><a name="red-primary" id="red-primary"></a>-red-primary <em class="arg">x,y</em></h4>
4779</div>
4780
4781<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>
4782
4783<div style="margin: auto;">
4784 <h4><a name="regard-warnings" id="regard-warnings"></a>-regard-warnings</h4>
4785</div>
4786
4787<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>
4788
4789<div style="margin: auto;">
4790 <h4><a name="remap" id="remap"></a>-remap <em class="arg">filename</em></h4>
4791</div>
4792
4793<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>
4794
4795<p>If the <a href="#dither">-dither</a> setting is enabled (the default) then
4796the given colors are dithered over the image as necessary, otherwise the closest
4797color (in RGB colorspace) is selected to replace that pixel in the image. </p>
4798
4799<p>As a side effect of applying a <a href="#remap">-remap</a> of colors across all
4800images in the current image sequence, all the images will have the same color
4801table. That means that when saved to a file format such as GIF, it will use
4802that color table as a single common or global color table, for all the images,
4803without requiring extra local color tables. </p>
4804
4805<p>Use <a href="#remap">+remap</a> to reduce all images in the current image
4806sequence to use a common color map over all the images. This equivalent to
4807appending all the images together (without extra background colors) and color
4808reducing those images using <a href="#colors">-colors</a> with a 256 color
4809limit, then <a href="#remap">-remap</a> those colors over the original list of
4810images. This ensures all the images follow a single color map. </p>
4811
4812<p>If the number of colors over all the images is less than 256, then <a
4813href="#remap">+remap</a> should not perform any color reduction or dithering, as
4814no color changes are needed. In that case, its only effect is to force the use
4815of a global color table. This recommended after using either <a
4816href="#colors">-colors</a> or <a href="#ordered-dither">-ordered-dither</a> to
4817reduce the number of colors in an animated image sequence. </p>
4818
4819<div style="margin: auto;">
4820 <h4><a name="region" id="region"></a>-region <em class="arg">geometry</em></h4>
4821</div>
4822
4823<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>
4824
4825<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>
4826
4827<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>
4828
4829<div style="margin: auto;">
4830 <h4><a name="remote" id="remote"></a>-remote</h4>
4831</div>
4832
4833<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>
4834
4835<p>The only command recognized is the name of an image file to load.</p>
4836
4837<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>
4838
4839<div style="margin: auto;">
4840 <h4><a name="render" id="render"></a>-render</h4>
4841</div>
4842
4843<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>
4844
4845<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>
4846
4847<div style="margin: auto;">
4848<h4><a name="repage" id="repage"></a>-repage <em class="arg">geometry</em></h4>
4849</div>
4850
4851<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>
4852
4853<p>This option is like <a href="#page">-page</a> but acts as an image operator
4854rather than a setting. You can separately set the canvas size or the offset
4855of the image on that canvas by only providing those components. </p>
4856
4857<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>
4858
4859<p>If a <kbd>!</kbd> flag is given the offset given is added to the existing
4860offset to move the image relative to its previous position. This useful for
4861animation sequences. </p>
4862
4863<p>A given a canvas size of zero such as '<kbd>0x0</kbd>' forces it to
4864recalculate the canvas size so the image (at its current offset) will appear
4865completely on that canvas (unless it has a negative offset).</p>
4866
4867<p>Use <a href="#repage">+repage</a> to completely remove/reset the virtual
4868canvas meta-data from the images. </p>
4869
4870<p>The <a href="#set">-set</a> '<kbd>page</kbd>' option can be used to
4871directly assign virtual canvas meta-data. </p>
4872
4873
4874<div style="margin: auto;">
4875 <h4><a name="resample" id="resample"></a>-resample <em class="arg">horizontal</em>x<em class="arg">vertical</em></h4>
4876</div>
4877
4878<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>
4879
4880<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>
4881
4882<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>
4883
4884<div style="margin: auto;">
4885 <h4><a name="resize" id="resize"></a>-resize <em class="arg">geometry</em></h4>
4886</div>
4887
4888<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>
4889
4890<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>
4891
4892<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>
4893
cristy13538962010-02-26 17:53:04 +00004894<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>
4895
cristy4949d522010-03-12 18:41:34 +00004896<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 +00004897<div style="margin: auto;">
4898 <h4><a name="respect-parentheses" id="respect-parentheses"></a>-respect-parentheses</h4>
4899</div>
4900
4901<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>
4902
4903<div style="margin: auto;">
4904 <h4><a name="reverse" id="reverse"></a>-reverse</h4>
4905</div>
4906
4907<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>
4908
4909
4910<div style="margin: auto;">
4911 <h4><a name="roll" id="roll"></a>-roll {<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em></h4>
4912</div>
4913
4914<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>
4915
4916<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>
4917
4918
4919<div style="margin: auto;">
4920 <h4><a name="rotate" id="rotate"></a>-rotate <em class="arg">degrees</em>{<em class="arg">&lt;</em>}{<em class="arg">&gt;</em>}</h4>
4921</div>
4922
4923<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>
4924
4925<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>
4926
4927<p>Empty triangles in the corners, left over from rotating the image, are
4928filled with the <kbd>background</kbd> color. </p>
4929
4930<p>See also the <a href="#distort">-distort</a> operator and specifically the
4931'<kbd>ScaleRotateTranslate</kbd>' distort method. </p>
4932
4933
4934<div style="margin: auto;">
4935 <h4><a name="sample" id="sample"></a>-sample <em class="arg">geometry</em></h4>
4936</div>
4937
cristyd0bd44a2010-09-24 12:38:11 +00004938<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 +00004939
cristyd0bd44a2010-09-24 12:38:11 +00004940<p>Change the image size simply by directly sampling the pixels original
4941image. When magnifying, pixels are replicated in blocks. When minifying,
4942pixels are sub-sampled (i.e., some rows and columns are skipped over). </p>
cristy3ed852e2009-09-05 21:47:34 +00004943
cristyd0bd44a2010-09-24 12:38:11 +00004944<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
4945a <a href="#filter">-filter</a> setting of <kbd>point</kbd> (nearest
4946neighbour), though <a href="#sample">-sample</a> is a lot faster, as it
4947avoids all the filter processing of the image. As such it completely ignores
4948the current <a href="#filter">-filter</a> setting. </p>
4949
4950<p>The key feature of the <a href="#sample">-sample</a> is that no new colors
4951will be added to the resulting image, though some colors may disappear. </p>
4952
4953<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
4954ignored, unlike <a href="#resize">-resize</a>. </p>
cristy3ed852e2009-09-05 21:47:34 +00004955
4956
4957<div style="margin: auto;">
4958 <h4><a name="sampling-factor" id="sampling-factor"></a>-sampling-factor <em class="arg">horizontal-factor</em>x<em class="arg">vertical-factor</em></h4>
4959</div>
4960
4961<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>
4962
4963<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>
4964
4965<div style="margin: auto;">
4966 <h4><a name="scale" id="scale"></a>-scale <em class="arg">geometry</em></h4>
4967</div>
4968
cristyd0bd44a2010-09-24 12:38:11 +00004969<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 +00004970
cristyd0bd44a2010-09-24 12:38:11 +00004971<p>Change the image size simply by replacing pixels by averaging pixels
4972together when minifying, or replacing pixels when magnifing. </p>
4973
4974<p>The results are thus equivalent to using <a href="#resize">-resize</a> with
4975a <a href="#filter">-filter</a> setting of <kbd>box</kbd>. Though it is a lot
4976faster, as it avoids all the filter processing of the image. As such it
4977completely ignores the current <a href="#filter">-filter</a> setting. </p>
4978
4979<p>If when shrinking (minifying) images the original image is some integer
4980multiple of the new image size, the number of pixels avergaed together to
4981produce the new pixel color is the same across the whole image. This is
4982a special case known as 'binning' and is often used as a method of reducing
4983noise in image such as those generated by digital cameras, especially in low
4984light conditions. </p>
4985
cristy3ed852e2009-09-05 21:47:34 +00004986
4987<div style="margin: auto;">
4988 <h4><a name="scene" id="scene"></a>-scene <em class="arg">value</em></h4>
4989</div>
4990
4991<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>
4992
4993<p>This option sets the scene number of an image or the first image in an image sequence.</p>
4994
4995<div style="margin: auto;">
4996 <h4><a name="screen" id="screen"></a>-screen</h4>
4997</div>
4998
4999<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>
5000
5001<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>
5002
5003<div style="margin: auto;">
5004 <h4><a name="seed" id="seed"></a>-seed</h4>
5005</div>
5006
5007<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>
5008
5009<div style="margin: auto;">
5010 <h4><a name="segment" id="segment"></a>-segment <em class="arg">cluster-threshold</em>x<em class="arg">smoothing-threshold</em></h4>
5011</div>
5012
5013<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>
5014
5015<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>
5016
5017<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>
5018
5019<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
5020of the color clusters is returned.</p>
5021
5022
5023<div style="margin: auto;">
5024 <h4><a name="selective-blur" id="selective-blur"></a>-selective-blur <em class="arg">geometry</em></h4>
5025</div>
5026
cristy2e2662a2010-10-09 14:29:37 +00005027<div style="margin: auto;">
5028 <h4><a name="selective-blur" id="selective-blur"></a>-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>
5029</div>
5030
cristy3ed852e2009-09-05 21:47:34 +00005031<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>
5032
cristy2e2662a2010-10-09 14:29:37 +00005033<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>
5034
cristy3ed852e2009-09-05 21:47:34 +00005035<div style="margin: auto;">
5036 <h4><a name="separate" id="separate"></a>-separate</h4>
5037</div>
5038
5039<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>
5040
5041<div style="margin: auto;">
5042 <h4><a name="sepia-tone" id="sepia-tone"></a>-sepia-tone <em class="arg">threshold</em></h4>
5043</div>
5044
5045<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>
5046
5047<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5048
5049<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>
5050
cristyd0bda5e2010-09-21 16:22:45 +00005051
5052
cristy3ed852e2009-09-05 21:47:34 +00005053<div style="margin: auto;">
cristyd0bd44a2010-09-24 12:38:11 +00005054 <h4><a name="set" id="set"></a>-set <em class="arg">key value</em></h4>
5055 <h4><a name="set" id="set"></a>+set <em class="arg">key</em></h4>
cristy3ed852e2009-09-05 21:47:34 +00005056</div>
5057
cristyd0bd44a2010-09-24 12:38:11 +00005058<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 +00005059image sequence.</td><td style='text-align:right;'></td></tr></table>
cristy3ed852e2009-09-05 21:47:34 +00005060
cristyd0bd44a2010-09-24 12:38:11 +00005061<p>This will assign (or modify) specific settings attached to all the images
5062in the current image sequence. Using the <a href="#set">+set</a> form of the
5063option will either remove, or reset that setting to a default state, as
5064appropriate. </p>
cristy3ed852e2009-09-05 21:47:34 +00005065
cristyd0bd44a2010-09-24 12:38:11 +00005066<p>For example, it will modify specific well known image meta-data
5067'attributes' such as those normally overridden by: the options <a
5068href="#delay" >-delay</a>, <a href="#dispose" >-dispose</a>, and <a
5069href="#page" >-page</a>, <a href="#colorspace" >-colorspace</a>; generally
5070assigned before the image is read in, by using a <em class="arg">key</em> of
5071the same name. </p>
cristy3ed852e2009-09-05 21:47:34 +00005072
cristyd0bd44a2010-09-24 12:38:11 +00005073<p>If the given <em class="arg">key</em> does not match a specific known
5074'attribute ', such as shown above, the setting is stored as a a free form
cristyd0bda5e2010-09-21 16:22:45 +00005075'properity' string. Such settings are listed in <a href="#verbose"
5076>-verbose</a> information ("<kbd>info:</kbd>" output format) as "Properties".
5077</p>
5078
cristyd0bd44a2010-09-24 12:38:11 +00005079<p>This includes string 'properities' that are set by and assigned to images
5080using the options <a href="#comment" >-comment</a>, <a href="#label"
5081>-label</a>, <a href="#caption" >-caption</a>. These options actually assign
5082a global 'artifact' which are automatically assigned (and any <a href="../www/escape.html" >Format Percent
5083Escapes</a> expanded) to images as they are read in. For example:</p>
cristyd0bda5e2010-09-21 16:22:45 +00005084
cristyd0bd44a2010-09-24 12:38:11 +00005085<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>
5086<p>The set value can also make use of <a href="../www/escape.html" >Format and Print Image
5087Properties</a> in the defined value. For example:</p>
5088
5089<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>
5090<p>Other well known 'properities' that can be include:
5091'<kbd>date:create</kbd>' and '<kbd>date:modify</kbd>' and
5092'<kbd>signature</kbd>'. </p>
5093
5094<p>The <a href="#repage">-repage</a> operator will also allow you to modify
5095the '<kbd>page</kbd>' attribute of an image for images already in memory (also
5096see <a href="#repage">-page</a>). However it is designed to provide a finer
5097control of the sub-parts of this 'attribute'. The <a href="#set">-set page</a>
5098option will only provide a direct, unmodified assignment of '<kbd>page</kbd>'
5099attribute. </p>
5100
5101<p>This option can also associate a colorspace or profile with your image.
5102For example,</p>
5103
5104<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 +00005105<p>Some 'properties' must be defined in a specific way to be used. For
5106example only 'properties' prefixed with "<kbd>filename:</kbd>" can be used to
5107modify the output filename of an image. For example</p>
5108
5109<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>
5110<p>If the setting value is prefixed with "<kbd>option:</kbd>" the setting will
5111be saved as a global "Artifact" exactly as if it was set using the <a
cristyd0bd44a2010-09-24 12:38:11 +00005112href="#define" >-define</a> option. As such settings are globel in scope, they
5113can be used to pass 'attributes' and 'properities' of one specific image,
5114in a way that allows you to use them in a completely different image, even if
5115the original image has long since been modified or destroyed. For example: </p>
5116
5117<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>
5118<p>Note that <a href="../www/escape.html" >Format Percent Escapes</a> will only match
5119a 'artifact' if the given <em class="arg">key</em> does not match an existing
5120'attribute' or 'properity'. </p>
cristyd0bda5e2010-09-21 16:22:45 +00005121
5122<p>You can set the attributes of the image registry by prefixing the value
5123with <kbd>registry:</kbd>.</p>
5124
5125
cristy3ed852e2009-09-05 21:47:34 +00005126
5127<div style="margin: auto;">
5128 <h4><a name="shade" id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
5129</div>
5130
5131<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>
5132
5133<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>
5134
5135<div style="margin: auto;">
5136 <h4><a name="shadow" id="shadow"></a>-shadow <em class="arg">percent-opacity</em>{x<em class="arg">sigma</em>}{<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em>{<em class="arg">%</em>}</h4>
5137</div>
5138
5139<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>
5140
5141<div style="margin: auto;">
5142 <h4><a name="shared-memory"
5143id="shared-memory"></a>-shared-memory</h4>
5144</div>
5145
5146<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>
5147
5148<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>
5149
5150<div style="margin: auto;">
5151 <h4><a name="sharpen" id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
5152</div>
5153
5154<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>
5155
5156<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5157
5158<div style="margin: auto;">
5159 <h4><a name="shave" id="shave"></a>-shave <em class="arg">geometry</em></h4>
5160</div>
5161
5162<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>
5163
5164<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>
5165
5166<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>
5167
5168<div style="margin: auto;">
5169 <h4><a name="shear" id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
5170</div>
5171
5172<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>
5173
5174<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>
5175
5176<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>
5177
5178<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>
5179
5180<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>
5181
5182<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>
5183<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>
5184
5185<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5186<div style="margin: auto;">
5187 <h4><a name="sigmoidal" id="sigmoidal-contrast"></a>-sigmoidal-contrast <em class="arg">contrast</em>x<em class="arg">mid-point</em></h4>
5188</div>
5189
5190<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>
5191
5192<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>
5193
5194<div style="margin: auto;">
5195 <h4><a name="silent" id="silent"></a>-silent</h4>
5196</div>
5197
5198<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>
5199
5200<div style="margin: auto;">
5201 <h4><a name="size" id="size"></a>-size <em class="arg">width</em>[x<em class="arg">height</em>][<em class="arg">+offset</em>]</h4>
5202</div>
5203
5204<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>
5205
5206<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>
5207
5208<p>For Photo CD images, choose from these sizes:</p>
5209
5210<pre class="text">
5211 192x128
5212 384x256
5213 768x512
5214 1536x1024
5215 3072x2048
5216</pre>
5217
cristy3ed852e2009-09-05 21:47:34 +00005218<div style="margin: auto;">
5219 <h4><a name="sketch" id="sketch"></a>-sketch <em class="arg">radius</em><br />-sketch <em class="arg">radius</em>x<em class="arg">sigma</em>+<em class="arg">angle</em></h4>
5220</div>
5221
5222<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>
5223
5224<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>
5225
5226<div style="margin: auto;">
5227 <h4><a name="snaps" id="snaps"></a>-snaps <em class="arg">value</em></h4>
5228</div>
5229
5230<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>
5231
5232<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5233
5234<div style="margin: auto;">
5235 <h4><a name="solarize" id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
5236</div>
5237
5238<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>
5239
5240<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5241
5242<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5243
5244<div style="margin: auto;">
5245 <h4><a name="sparse-color" id="sparse-color"></a>-sparse-color <em
5246 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5247</div>
5248
5249<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>
5250
5251
5252<table class="doc">
5253 <tbody>
5254 <tr valign="top">
5255 <th align="left" style="width: 8%">Method</th>
5256 <th align="left">Description</th>
5257 </tr>
5258
5259 <tr valign="top">
5260 <td valign="top">voronoi</td>
5261 <td valign="top">Simply map each pixel to the to nearest color point
5262 given. The result are polygonal 'cells' of solid color. </td>
5263 </tr>
5264
5265 <tr valign="top">
5266 <td valign="top">shepards</td>
cristyd0bda5e2010-09-21 16:22:45 +00005267 <td valign="top">Colors points biased on the ratio of inverse distance
cristy3ed852e2009-09-05 21:47:34 +00005268 squared. Generating spots of color in a sea of the average of
5269 colors. </td>
5270 </tr>
5271
5272 <tr valign="top">
5273 <td valign="top">barycentric</td>
5274 <td valign="top">three point triangle of color given 3 points.
5275 Giving only 2 points will form a linear gradient between those points.
5276 Gradient is however not restricted to just the triangle or line. </td>
5277 </tr>
5278
5279 <tr valign="top">
5280 <td valign="top">bilinear</td>
5281 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5282 fall back to barycentric. </td>
5283 </tr>
5284
5285 </tbody>
5286</table>
5287
5288<p>The points are placed according to the images location on the virtual
5289canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5290offset), and do not actually have to exist on the given image, but may be
5291some point beyond the edge of the image. All points are floating point values.
5292</p>
5293
5294<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
5295modified, whcih means the matte/alpha transparency channel is not effected by
5296default. If enabled, the image also needs a the matte/alpha channel to be
5297enabled for this operator to effect an images transparency. This is typical
5298transparency handling for images. </p>
5299
5300<p>All the above methods when given a single point of color will replace all
5301the colors in the image with the color given, regardless of the point. This is
5302logical, and provides an alternative technique to recolor a image to some
5303default value. </p>
5304
5305
5306<div style="margin: auto;">
5307 <h4><a name="splice" id="splice"></a>-splice <em class="arg">geometry</em></h4>
5308</div>
5309
5310<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>
5311
5312<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>
5313
5314<div style="margin: auto;">
5315 <h4><a name="spread" id="spread"></a>-spread <em class="arg">amount</em></h4>
5316</div>
5317
5318<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>
5319
5320<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>
5321
5322<div style="margin: auto;">
5323 <h4><a name="stegano" id="stegano"></a>-stegano <em class="arg">offset</em></h4>
5324</div>
5325
5326<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>
5327
5328<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>
5329
5330<div style="margin: auto;">
5331 <h4><a name="stereo" id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
5332</div>
5333
5334<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>
5335
5336<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>
5337
5338<div style="margin: auto;">
5339 <h4><a name="storage-type" id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
5340</div>
5341
5342<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>
5343
5344<pre class="text">
5345 char store pixels as unsigned characters
5346 double store pixels as doubles
5347 float store pixels as floats
5348 integer store pixels as integers
5349 long store pixels as longs
5350 quantum store pixels in the native depth of your ImageMagick distribution
5351 short store pixels as unsigned shorts
5352</pre>
5353
5354<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5355values range from 0 to the maximum value the storage type can support.</p>
5356
5357<div style="margin: auto;">
5358 <h4><a name="stretch" id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
5359</div>
5360
5361<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>
5362
5363<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>
5364
5365<pre class="text">
5366 Any
5367 Condensed
5368 Expanded
5369 ExtraCondensed
5370 ExtraExpanded
5371 Normal
5372 SemiCondensed
5373 SemiExpanded
5374 UltraCondensed
5375 UltraExpanded
5376</pre>
5377
5378<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5379
5380<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>
5381
5382<div style="margin: auto;">
5383 <h4><a name="strip" id="strip"></a>-strip</h4>
5384</div>
5385
5386<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>
5387
5388<div style="margin: auto;">
5389 <h4><a name="stroke" id="stroke"></a>-stroke <em class="arg">color</em></h4>
5390</div>
5391
5392<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>
5393
5394<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5395
5396<p>See <a href="#draw">-draw</a> for further details.</p>
5397
5398<div style="margin: auto;">
5399 <h4><a name="strokewidth" id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
5400</div>
5401
5402<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>
5403
5404<p>See <a href="#draw">-draw</a> for further details.</p>
5405
5406<div style="margin: auto;">
5407 <h4><a name="style" id="style"></a>-style <em class="arg">fontStyle</em></h4>
5408</div>
5409
5410<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>
5411
cristy71a3f602010-09-15 12:38:16 +00005412<p>This setting suggests a font style that ImageMagick should try to apply to
5413the currently selected font family. Select <em class="arg">fontStyle</em> from
5414the following.</p>
cristy3ed852e2009-09-05 21:47:34 +00005415
5416<pre class="text">
5417 Any
5418 Italic
5419 Normal
5420 Oblique
5421</pre>
5422
5423<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>
5424
5425<div style="margin: auto;">
cristyae6203d2010-08-09 01:12:14 +00005426 <h4><a name="subimage-search" id="subimage-search"></a>-subimage-search</h4>
5427</div>
5428
cristyd4d64ed2010-08-22 22:19:33 +00005429<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>
5430
cristy71a3f602010-09-15 12:38:16 +00005431<p>This option is required to have compare search for the best match location
5432of a small image within a larger image. This search will produce two images
cristyd0bd44a2010-09-24 12:38:11 +00005433(or two frames). The first is the "difference" image and the second will
cristy71a3f602010-09-15 12:38:16 +00005434be the "match score" image.</p>
5435
cristyd0bd44a2010-09-24 12:38:11 +00005436<p>The "match-score" image is smaller containing a pixel for ever possible
cristy71a3f602010-09-15 12:38:16 +00005437position of the top-left corner of the given sub-image. that is its size will
5438be the size of the larger_image - sub_image + 1. The brightest location in
5439this image is the location s the locate on the best match that is also
5440reported. Note that this may or may nor be a perfect match, and the actual
5441brightness will reflect this. Other bright 'peaks' can be used to locate other
cristyd0bda5e2010-09-21 16:22:45 +00005442possible matching loctions. </p>
cristy71a3f602010-09-15 12:38:16 +00005443
cristyd0bda5e2010-09-21 16:22:45 +00005444<p>Note that the search will try to compare teh sub-image at every possible
cristy71a3f602010-09-15 12:38:16 +00005445location in the larger image, as such it can be very slow. The smaller the
cristyd0bd44a2010-09-24 12:38:11 +00005446sub-image the faster this search is. </p>
cristy71a3f602010-09-15 12:38:16 +00005447
cristyae6203d2010-08-09 01:12:14 +00005448
5449<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00005450 <h4><a name="swap" id="swap"></a>-swap <em class="arg">index,index</em></h4>
5451</div>
5452
5453<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>
5454
cristy71a3f602010-09-15 12:38:16 +00005455<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third
5456images in the current image sequence. Use <a href="#swap">+swap</a> to switch
5457the last two images in the sequence.</p>
cristy3ed852e2009-09-05 21:47:34 +00005458
5459<div style="margin: auto;">
5460 <h4><a name="swirl" id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
5461</div>
5462
5463<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>
5464
5465<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5466
5467<div style="margin: auto;">
cristy5063d812010-10-19 16:28:10 +00005468 <h4><a name="synchronize" id="synchronize"></a>-synchronize</h4>
5469</div>
5470
5471<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>
5472
5473<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00005474 <h4><a name="taint" id="taint"></a>-taint</h4>
5475</div>
5476
cristy5063d812010-10-19 16:28:10 +00005477<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 +00005478
5479<div style="margin: auto;">
5480 <h4><a name="text-font" id="text-font"></a>-text-font <em class="arg">name</em></h4>
5481</div>
5482
5483<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>
5484
5485<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>
5486
5487<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>
5488
5489<div style="margin: auto;">
5490 <h4><a name="texture" id="texture"></a>-texture <em class="arg">filename</em></h4>
5491</div>
5492
5493<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>
5494
5495<div style="margin: auto;">
5496 <h4><a name="threshold" id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
5497</div>
5498
5499<!-- {<em class="arg">green,blue,opacity</em>}
5500<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>
5501-->
5502
5503<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>
5504
5505<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>
5506
5507<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.
5508</p>
5509
5510<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>
5511
5512<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5513<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>
5514
5515
5516<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>
5517<p>Note that the values of the transparency channel is treated as 'matte'
5518values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5519
5520<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>.
5521</p>
5522
5523<div style="margin: auto;">
5524 <h4><a name="thumbnail" id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
5525</div>
5526
5527<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>
5528
5529<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>
5530
5531<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>
5532
5533<div style="margin: auto;">
5534 <h4><a name="tile" id="tile"></a>-tile <em class="arg">filename</em></h4>
5535</div>
5536
5537<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>
5538
5539<div style="margin: auto;">
5540 <h4>-tile <em class="arg">geometry</em></h4>
5541</div>
5542
5543<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>
5544
5545<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>
5546
5547<div style="margin: auto;">
5548 <h4>-tile</h4>
5549</div>
5550
5551<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>
5552
5553<div style="margin: auto;">
5554 <h4><a name="tile-offset" id="tile-offset"></a>-tile-offset {<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em></h4>
5555</div>
5556
5557<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>
5558
5559<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>
5560
5561<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>
5562
5563<div style="margin: auto;">
5564 <h4><a name="tint" id="tint"></a>-tint <em class="arg">value</em></h4>
5565</div>
5566
5567<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>
5568
5569<p>Tint the image with the fill color.</p>
5570
5571<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>
5572
5573<div style="margin: auto;">
5574 <h4><a name="title" id="title"></a>-title <em class="arg">string</em></h4>
5575</div>
5576
5577<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>
5578
5579<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>
5580
5581<p>For example,</p>
5582
5583<p class="crtsnip">
5584 -title "%m:%f %wx%h"
5585</p>
5586
5587<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>
5588
5589
5590<div style="margin: auto;">
5591 <h4><a name="transform" id="transform"></a>-transform</h4>
5592</div>
5593
5594<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>
5595
5596<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5597
5598<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 +00005599
5600<p>This operator has been now been superseded by the <a
5601href="#distort">-distort</a> '<kbd>AffineProjection</kbd>' method. </p>
5602
5603
cristy3ed852e2009-09-05 21:47:34 +00005604<div style="margin: auto;">
5605 <h4><a name="transparent" id="transparent"></a>-transparent <em class="arg">color</em></h4>
5606</div>
5607
5608<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>
5609
5610<p>The <em class="arg">color</em> argument is defined using the format
5611described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5612>-fuzz</a> setting can be used to match and replace colors similar to the one
5613given. </p>
5614
cristyb36feb22010-03-26 16:54:37 +00005615<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5616that is make all non-matching colors transparent. </p>
5617
cristy3ed852e2009-09-05 21:47:34 +00005618<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005619href="#transparent" >-transparent</a> but replaces the matching color with the
5620current <a href="#fill">-fill</a> color setting, rather than transparent.
5621However the <a href="#transparent" >-transparent</a> operator also ensures
5622that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5623>-alpha</a> set</kbd>", and does not require you to modify the <a
5624href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005625
cristyb36feb22010-03-26 16:54:37 +00005626<p>Note that this does not define the color as being the 'transparency color'
5627used for color-mapped image formats, such as GIF. For that use <a
5628href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005629
5630
5631<div style="margin: auto;">
5632 <h4><a name="transparent-color" id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
5633</div>
5634
5635<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>
5636
5637<p>Sometimes this is used for saving to image formats such as
5638GIF and PNG8 which uses this color to represent boolean transparency. This
5639does not make a color transparent, it only defines what color the transparent
5640color is in the color palette of the saved image. Use <a
5641href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5642
5643<p>This option allows you to have both an opaque visible color, as well as a
5644transparent color of the same color value without conflict. That is, you can
5645use the same color for both the transparent and opaque color areas within an
5646image. This, in turn, frees to you to select a transparent color that is
5647appropriate when an image is displayed by an application that does not handle a
5648transparent color index, while allowing ImageMagick to correctly handle images of this
5649type. </p>
5650
5651<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5652
5653<div style="margin: auto;">
5654 <h4><a name="transpose" id="transpose"></a>-transpose</h4>
5655</div>
5656
5657<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>
5658
5659<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5660</p>
5661
5662<div style="margin: auto;">
5663 <h4><a name="transverse" id="transverse"></a>-transverse</h4>
5664</div>
5665
5666<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>
5667
5668
5669<div style="margin: auto;">
5670 <h4><a name="treedepth" id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
5671</div>
5672
5673<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>
5674
5675<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>
5676
5677<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>
5678
5679<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>
5680
5681<div style="margin: auto;">
5682 <h4><a name="trim" id="trim"></a>-trim</h4>
5683</div>
5684
5685<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>
5686
5687<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>
5688
5689<p>The page or virtual canvas information of the image is preserved allowing
5690you to extract the result of the <a href="#trim">-trim</a> operation from the
5691image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5692information if it is unwanted.</p>
5693
5694<p>If the trimmed image 'disappears' an warning is produced, and a special
5695single pixel transparent 'missed' image is returned, in the same way as when a
5696<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5697
5698
5699<div style="margin: auto;">
5700 <h4><a name="type" id="type"></a>-type <em class="arg">type</em></h4>
5701</div>
5702
5703<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 +00005704 <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 +00005705
5706<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>
5707
5708<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5709<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>
5710
5711<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5712
5713<div style="margin: auto;">
5714 <h4><a name="undercolor" id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
5715</div>
5716
5717<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>
5718
5719<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5720
5721<p>See <a href="#draw">-draw</a> for further details.</p>
5722
5723
5724<div style="margin: auto;">
5725 <h4><a name="update" id="update"></a>-update <em class="arg">seconds</em></h4>
5726</div>
5727
5728<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>
5729
5730<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>
5731
5732
5733<div style="margin: auto;">
5734 <h4><a name="unique-colors" id="unique-colors"></a>-unique-colors</h4>
5735</div>
5736
5737<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>
5738
5739
5740<div style="margin: auto;">
5741 <h4><a name="units" id="units"></a>-units <em class="arg">type</em></h4>
5742</div>
5743
5744<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>
5745
5746<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>
5747
5748
5749<div style="margin: auto;">
5750 <h4><a name="unsharp" id="unsharp"></a>-unsharp <em class="arg">radius</em><br />-unsharp <em class="arg">radius</em>x<em class="arg">sigma</em>{<em class="arg">+amount</em>}{<em class="arg">+threshold</em>}</h4>
5751</div>
5752
5753<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>
5754
5755<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>
5756
5757<p>The parameters are:</p>
5758
5759<pre class="text">
5760 radius: The radius of the Gaussian, in pixels, not counting the center
5761 pixel (default 0).
5762 sigma: The standard deviation of the Gaussian, in pixels (default 1.0).
5763 amount: The fraction of the difference between the original and the blur
5764 image that is added back into the original (default 1.0).
5765 threshold: The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5766 difference amount (default 0.05).
5767</pre>
5768
5769
5770<div style="margin: auto;">
5771 <h4><a name="verbose" id="verbose"></a>-verbose</h4>
5772</div>
5773
cristyd0bda5e2010-09-21 16:22:45 +00005774<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 +00005775
5776
5777<div style="margin: auto;">
5778 <h4><a name="version" id="version"></a>-version</h4>
5779</div>
5780
5781<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>
5782
5783
5784<div style="margin: auto;">
5785 <h4><a name="view" id="view"></a>-view <em class="arg">string</em></h4>
5786</div>
5787
5788<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>
5789
5790
5791<div style="margin: auto;">
5792 <h4><a name="vignette" id="vignette"></a>-vignette <em class="arg">radius</em>{x<em class="arg">sigma</em>}{<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em>{<em class="arg">%</em>}</h4>
5793</div>
5794
5795<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>
5796
5797
5798<div style="margin: auto;">
5799 <h4><a name="virtual-pixel" id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
5800</div>
5801
5802<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>
5803
5804<p>This option defines what color source should be used if and when a color
5805lookup completely 'misses' the source image. The color(s) that appear to
5806surround the source image. Generally this color is derived from the source
5807image, but could also be set to a specify background color. </p>
5808
5809<p>Choose from these methods:</p>
5810
5811<pre class="text">
5812 background: the area surrounding the image is the background color
5813 black: the area surrounding the image is black
5814 checker-tile: alternate squares with image and background color
5815 dither: non-random 32x32 dithered pattern
5816 edge: extend the edge pixel toward infinity
5817 gray: the area surrounding the image is gray
5818 horizontal-tile: horizontally tile the image, background color above/below
5819 horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
5820 mirror: mirror tile the image
5821 random: choose a random pixel from the image
5822 tile: tile the image (default)
5823 transparent: the area surrounding the image is transparent blackness
5824 vertical-tile: vertically tile the image, sides are background color
5825 vertical-tile-edge: vertically tile the image and replicate the side edge pixels
5826 white: the area surrounding the image is white
5827</pre>
5828
5829<p>The default value is "edge".</p>
5830
5831<p>This most important for distortion operators such as <a href="#distort"
5832>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
5833However it also effects operations that may access pixels just outside the
5834image proper, such as <a href="#convolve">-convolve</a>, <a
5835href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
5836
5837<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
5838
5839
5840<div style="margin: auto;">
5841 <h4><a name="visual" id="visual"></a>-visual <em class="arg">type</em></h4>
5842</div>
5843
5844<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>
5845
5846<p>Choose from these visual classes:</p>
5847
5848<pre class="text">
5849 StaticGray
5850 GrayScale
5851 StaticColor
5852 PseudoColor
5853 TrueColor
5854 DirectColor
5855 default
5856 visual id
5857</pre>
5858
5859<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>
5860
5861
5862<div style="margin: auto;">
5863 <h4><a name="watermark" id="watermark"></a>-watermark <em
5864 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
5865</div>
5866
5867<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
5868saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5869
5870<p>Take a grayscale image (with alpha mask) and modify the destination image's
5871brightness according to watermark image's grayscale value and the <em
5872class="arg">brightness</em> percentage. The destinations color saturation
5873attribute is just direct modified by the <em class="arg">saturation</em>
5874percentage, which defaults to 100 percent (no color change). </p>
5875
5876
5877<div style="margin: auto;">
5878 <h4><a name="wave" id="wave"></a>-wave <em class="arg">amplitude</em><br />-wave <em class="arg">amplitude</em>x<em class="arg">wavelength</em></h4>
5879</div>
5880
5881<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>
5882
5883<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
5884
5885<div style="margin: auto;">
5886 <h4><a name="weight" id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
5887</div>
5888
5889<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>
5890
5891<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>
5892
5893<table class="doc">
5894 <col width="25%" />
5895 <col width="75%" />
5896 <thead>
5897 <tr>
5898 <th><em class="arg">fontWeight</em></th>
5899 <th>Description</th>
5900 </tr>
5901 </thead>
5902 <tbody>
5903 <tr><td>All </td> <td>No effect. </td></tr>
5904 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
5905 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
5906 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
5907 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
5908 </tbody>
5909 </table>
5910
5911<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
5912
5913<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>
5914
5915<div style="margin: auto;">
5916 <h4><a name="white-point" id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
5917</div>
5918
5919<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>
5920
5921<div style="margin: auto;">
cristy5cadd612009-09-21 19:33:41 +00005922 <h4><a name="white-threshold" id="white-threshold"></a>-white-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
cristy3ed852e2009-09-05 21:47:34 +00005923</div>
5924
cristy5cadd612009-09-21 19:33:41 +00005925<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>
5926
5927<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.
5928</p>
cristy3ed852e2009-09-05 21:47:34 +00005929
5930<div style="margin: auto;">
5931 <h4><a name="window" id="window"></a>-window <em class="arg">id</em></h4>
5932</div>
5933
5934<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>
5935
5936<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>
5937
5938<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>
5939
5940<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>
5941
5942<div style="margin: auto;">
5943 <h4><a name="window-group" id="window-group"></a>-window-group</h4>
5944</div>
5945
5946<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>
5947
5948<div style="margin: auto;">
5949 <h4><a name="write" id="write"></a>-write <em class="arg">filename</em></h4>
5950</div>
5951
5952<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>
5953 <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>
5954
5955<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
5956
cristy3eaa0ef2010-03-06 20:35:26 +00005957
5958</div>
5959
5960<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +00005961 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +00005962 <span id="linkbar-center">
5963 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +00005964 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00005965 </span>
5966 <span id="linkbar-east">&nbsp;</span>
5967 </div>
5968 <div class="footer">
5969 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
5970 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
5971 </div>
5972 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +00005973 <script type="text/javascript">
5974 var _gaq = _gaq || [];
5975 _gaq.push(['_setAccount', 'UA-17690367-1']);
5976 _gaq.push(['_trackPageview']);
5977
5978 (function() {
5979 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
5980 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
5981 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
5982 })();
5983 </script>
cristy3eaa0ef2010-03-06 20:35:26 +00005984</body>
5985</html>