blob: 13fc1d1a5214206967ce501176dc340162c9c235 [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">
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8<head>
9 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
11 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
12 <style type="text/css" media="screen,projection"><!--
13 @import url("../www/magick.css");
14 --></style>
cristy3ed852e2009-09-05 21:47:34 +000015 <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/>
16 <title>ImageMagick: Command-line Options</title>
17 <meta http-equiv="Content-Language" content="en-US"/>
18 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
19 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
20 <meta name="Generator" content="PHP"/>
21 <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"/>
22 <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."/>
23 <meta name="Rating" content="GENERAL"/>
24 <meta name="Robots" content="INDEX, FOLLOW"/>
25 <meta name="Generator" content="ImageMagick Studio LLC"/>
26 <meta name="Author" content="ImageMagick Studio LLC"/>
27 <meta name="Revisit-after" content="2 DAYS"/>
28 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +000029 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000030 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +000031</head>
32
33<body id="www-imagemagick-org">
34<div class="titlebar">
35<a href="../index.html">
36 <img src="../images/script.png" alt="[ImageMagick]"
37 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
38<a href="http://www.networkredux.com">
39 <img src="../images/networkredux.png" alt="[sponsor]"
40 style="margin: 45px auto; border: 0px; float: left;" /></a>
41<a href="http://www.imagemagick.org/discourse-server/">
42 <img src="../images/logo.jpg" alt=""
43 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
44<a href="../index.html">
45 <img src="../images/sprite.jpg" alt=""
46 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
47</div>
48
49<div class="eastbar">
50
cristy3ed852e2009-09-05 21:47:34 +000051<div class="menu">
52 <a href="../index.html">About ImageMagick</a>
53</div>
cristy3eaa0ef2010-03-06 20:35:26 +000054<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000055<div class="menu">
56 <a href="../www/command-line-tools.html">Command-line Tools</a>
57</div>
58<div class="sub">
59 <a href="../www/command-line-processing.html">Processing</a>
60</div>
61<div class="sub">
62 <a href="../www/command-line-options.html">Options</a>
63</div>
64<div class="sub">
65 <a href="http://www.imagemagick.org/Usage/">Usage</a>
66</div>
67<div class="menu">
68 <a href="../www/api.html">Program Interfaces</a>
69</div>
70<div class="sub">
71 <a href="../www/magick-wand.html">MagickWand</a>
72</div>
73<div class="sub">
74 <a href="../www/magick-core.html">MagickCore</a>
75</div>
76<div class="sub">
77 <a href="../www/perl-magick.html">PerlMagick</a>
78</div>
79<div class="sub">
80 <a href="../Magick++/">Magick++</a>
81</div>
82<div class="menu">
83 <a href="../www/architecture.html">Architecture</a>
84</div>
cristy3eaa0ef2010-03-06 20:35:26 +000085<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000086<div class="menu">
87 <a href="../www/install-source.html">Install from Source</a>
88</div>
89<div class="sub">
90 <a href="../www/install-source.html#unix">Unix</a>
91</div>
92<div class="sub">
93 <a href="../www/install-source.html#windows">Windows</a>
94 </div>
95<div class="menu">
96 <a href="../www/binary-releases.html">Binary Releases</a>
97</div>
98<div class="sub">
99 <a href="../www/binary-releases.html#unix">Unix</a>
100</div>
101<div class="sub">
102 <a href="../www/binary-releases.html#macosx">Mac OS X</a>
103</div>
104<div class="sub">
105 <a href="../www/binary-releases.html#windows">Windows</a>
106</div>
107<div class="menu">
108 <a href="../www/resources.html">Resources</a>
109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
112 <a href="../www/download.html">Download</a>
113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
116 <a href="http://www.imagemagick.org/script/search.php">Search</a>
117</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000118<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000119<div class="menu">
120 <a href="../www/sitemap.html">Site Map</a>
121</div>
122<div class="sub">
123 <a href="../www/links.html">Links</a>
124</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000125<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000126<div class="menu">
127 <a href="../www/sponsors.html">Sponsors:</a>
128
129<div class="sponsbox">
130<div class="sponsor">
cristy7d34ef22010-03-25 01:11:22 +0000131 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
cristy787d4352010-03-06 13:55:58 +0000132</div>
133<div class="sponsor">
cristy8f900122010-03-05 15:26:31 +0000134 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
135</div>
136<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000137 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
138</div>
139<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000140 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristyc1c61662009-09-30 14:04:37 +0000141</div>
142<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000143 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristy916e1922009-10-01 12:52:47 +0000144</div>
145<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000146 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristyc49f7992009-09-22 22:48:40 +0000147</div>
148<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000149 <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
cristyf3bb4782009-09-08 13:10:04 +0000150</div>
151<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000152 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3ed852e2009-09-05 21:47:34 +0000153</div>
cristy3ed852e2009-09-05 21:47:34 +0000154</div>
155</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000156
157
158</div>
159
160<div class="main">
161
cristy5cadd612009-09-21 19:33:41 +0000162<p class="navigation-index">
cristy63fed272010-03-07 19:08:45 +0000163[ <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#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#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#recolor">&#x2011;recolor</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#swap">&#x2011;swap</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#swirl">&#x2011;swirl</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#taint">&#x2011;taint</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#text-font">&#x2011;text&#x2011;font</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#texture">&#x2011;texture</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#threshold">&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#thumbnail">&#x2011;thumbnail</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#tile">&#x2011;tile</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#tile-offset">&#x2011;tile&#x2011;offset</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#tint">&#x2011;tint</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#title">&#x2011;title</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transform">&#x2011;transform</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transparent">&#x2011;transparent</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transparent-color">&#x2011;transparent&#x2011;color</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transpose">&#x2011;transpose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#transverse">&#x2011;transverse</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#treedepth">&#x2011;treedepth</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#trim">&#x2011;trim</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#type">&#x2011;type</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#undercolor">&#x2011;undercolor</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#unique-colors">&#x2011;unique&#x2011;colors</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#units">&#x2011;units</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#unsharp">&#x2011;unsharp</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#update">&#x2011;update</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#verbose">&#x2011;verbose</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#version">&#x2011;version</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#view">&#x2011;view</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#vignette">&#x2011;vignette</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#virtual-pixel">&#x2011;virtual&#x2011;pixel</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#visual">&#x2011;visual</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#watermark">&#x2011;watermark</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#wave">&#x2011;wave</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#weight">&#x2011;weight</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#white-point">&#x2011;white&#x2011;point</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#white-threshold">&#x2011;white&#x2011;threshold</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#window">&#x2011;window</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#window-group">&#x2011;window&#x2011;group</a> <span class='bull'>&nbsp;&bull; </span> <a href="../www/command-line-options.html#write">&#x2011;write</a> ] </p>
cristy3ed852e2009-09-05 21:47:34 +0000164
cristyb36feb22010-03-26 16:54:37 +0000165<p>Below is list of command-line options recognized by the ImageMagick <a
166href="../www/command-line-tools.html">command-line
167tools</a>. If you want a description of a particular option, click on the
168option name in the navigation bar above and you will go right to it. Unless
169otherwise noted, each option is recognized by the commands <a href="../www/convert.html">convert</a>, <a href="../www/mogrify.html">mogrify</a>, and .... </p>
cristy3ed852e2009-09-05 21:47:34 +0000170
171<div style="margin: auto;">
172 <h4><a name="adaptive-blur" id="adaptive-blur"></a>-adaptive-blur <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
173</div>
174
175<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>
176
177<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>
178
179<div style="margin: auto;">
180 <h4><a name="adaptive-resize" id="adaptive-resize"></a>-adaptive-resize <em class="arg">geometry</em></h4>
181</div>
182
183<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>
184
185<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>
186
187<div style="margin: auto;">
188 <h4><a name="adaptive-sharpen" id="adaptive-sharpen"></a>-adaptive-sharpen <em class="arg">radius</em>[x<em class="arg">sigma</em>]</h4>
189</div>
190
191<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>
192
193<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>
194
195<div style="margin: auto;">
196 <h4><a name="adjoin" id="adjoin"></a>-adjoin</h4>
197</div>
198
199<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>
200
201<p>This option is enabled by default. An attempt is made to save all
202images of an image sequence into the given output file.
203However, some formats, such as JPEG and PNG, do not support more than one
204image per file, and in that case ImageMagick is forced to write each image as a separate file. As
205such, if more than one image needs to be written, the filename given is
206modified by adding a <a href="#scene">-scene</a> number before the
207suffix, in order to make distinct names for each image. </p>
208
209<p>Use <a href="#adjoin">+adjoin</a> to force each image to be written
210to separate files, whether or not the file format allows multiple images
211per file (for example, GIF, MIFF, and TIFF). </p>
212
213<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>
214
215<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: rose: -morph 15 my%02dmorph.jpg</span></p>
216<p>will create a sequence of 17 images named my00morph.jpg, my01morph.jpg, my02morph.jpg, ..., my16morph.jpg.
217</p>
218
219<p>In summary, ImageMagick tries to write all images to one file, but will use
220multiple files if either (1) the output image's file format does not allow multi-image files,
221(2) the <a href="#adjoin">+adjoin</a> option is given, or (3) a C-style integer format string is
222present in the output filename. </p>
223
224
225<div style="margin: auto;">
226 <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/>
227 -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>
228</div>
229
230<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>
231
232<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>
233
234<p>The matrix entries are entered as comma-separated numeric values <i>with no spaces</i>. </p>
235
236<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>
237
238<div class="eqn">
239<img alt="affine transformation" src="../images/affine.png"/>
240</div>
241
242<p>
243The 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>
244
245<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>
246
247<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>
248
249<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>
250
251<p class="crtsnip">
252 -affine <em class="arg">s<sub>x</sub></em>,0,0,<em class="arg">s<sub>y</sub></em>
253</p>
254
255<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>
256
257<p class="crtsnip">
258 -affine 1,0,0,1,<em class="arg">t<sub>x</sub></em>,<em class="arg">t<sub>y</sub></em>
259</p>
260
261<p>Rotate clockwise about the origin (the upper left-hand corner) by an angle <em>a</em> by letting
262<em>c</em> = cos(<em>a</em>), <em>s</em> = sin(<em>a</em>), and using the following.</p>
263
264<p class="crtsnip">
265 -affine <em>c</em>,<em>s</em>,-<em>s</em>,<em>c</em>
266</p>
267
268<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>
269
270<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>
271
272<div style="margin: auto;">
273 <h4><a name="alpha" id="alpha"></a>-alpha <em class="arg">type</em></h4>
274</div>
275
276<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>
277
278<p>Used to set a flag on an image indicating whether or not to use existing alpha
279channel 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>
280
281
282<table class="doc">
283 <tbody>
284 <tr valign="top">
285 <th align="left" style="width: 8%">type</th>
286 <th align="left">Description</th>
287 </tr>
288
289 <tr valign="top">
290 <td valign="top"><kbd>Off</kbd>&nbsp; or
291 <kbd>Deactivate</kbd></td>
292 <td valign="top">
293 Disables the image's transparency channel. Does not delete or change the
294 existing data, just turns off the use of that data. This is the same as
295 the older <a href="#matte" >+matte</a> operator. </td></tr>
296
297 <tr valign="top">
298 <td valign="top"><kbd>On</kbd>&nbsp; or
299 <kbd>Activate</kbd></td>
300 <td valign="top">
301 Enables the image's use of transparency. If transparency data does not
302 already exist, allocates the data and sets it to opaque. If the image has
303 transparency data, the channel is enabled and the transparency data is not changed or modified in any way. This is NOT
304 the same as the older <a href="#matte" >-matte</a> operator. </td></tr>
305
306 <tr valign="top">
307 <td valign="top"><kbd>Set</kbd></td>
308 <td valign="top">
309 Turns '<kbd>On</kbd>' the alpha/matte channel and if it was previously
310 turned off resets the channel to opaque. If the image already had the
311 alpha channel turned on, it will have no effect. This is the same as the older <a href="#matte">-matte</a> operator. </td></tr>
312
313 <tr valign="top">
314 <td valign="top"><kbd>Opaque</kbd></td>
315 <td valign="top">
316 Turns '<kbd>On</kbd>' the alpha/matte channel and forces it to be fully
317 opaque. </td></tr>
318
319 <tr valign="top">
320 <td valign="top"><kbd>Transparent</kbd></td>
321 <td valign="top">
322 Turns '<kbd>On</kbd>' the alpha/matte channel and forces it to be fully
323 transparent. This effectively creates a fully transparent image the same
cristyb36feb22010-03-26 16:54:37 +0000324 size as the original and with all its original RGB data still intact,
325 but fully transparent. </td></tr>
cristy3ed852e2009-09-05 21:47:34 +0000326
327 <tr valign="top">
328 <td valign="top"><kbd>Extract</kbd></td>
329 <td valign="top">
330 Copies the alpha channel values into all the color channels and turns
331 '<kbd>Off</kbd>' the the image's transparency, so as to generate a
332 gray-scale mask of the image's shape. This is the inverse of
333 '<kbd>Copy</kbd>'. </td></tr>
334
335 <tr valign="top">
336 <td valign="top"><kbd>Copy</kbd></td>
337 <td valign="top">
338 Turns '<kbd>On</kbd>' the alpha/matte channel, then copies the
339 gray-scale intensity of the image, as an alpha mask, into the alpha
340 channel, converting a gray-scale mask into a transparent shaped image
341 ready to be colored appropriately. The color channels are not modified.
342 </td></tr>
343
344 <tr valign="top">
345 <td valign="top"><kbd>Shape</kbd></td>
346 <td valign="top">
347 As per '<kbd>Copy</kbd>' but also colors the resulting shape mask with
cristyb36feb22010-03-26 16:54:37 +0000348 the current background color. That is the RGB color channels is
349 replaced, with appropriate alpha shape.
cristy3ed852e2009-09-05 21:47:34 +0000350 </td></tr>
351
352 <tr valign="top">
353 <td valign="top"><kbd>Background</kbd></td>
354 <td valign="top">
cristyb36feb22010-03-26 16:54:37 +0000355 Set any fully-transparent pixel to the background color, while leaving
356 it fully-transparent. This can make some image file formats, such as
357 PNG, smaller as the RGB values of transparent pixels are more uniform,
358 and thus can compress better.
cristy3ed852e2009-09-05 21:47:34 +0000359 </td></tr>
360 </tbody>
361</table>
362
363<p>Note that while the <a href="#matte" >+matte</a> operation is the same as
364"<kbd><a href="#alpha" >-alpha</a> off</kbd>", the <a href="#matte"
cristyb36feb22010-03-26 16:54:37 +0000365>-matte</a> operation is the same as "<kbd><a href="#alpha" >-alpha</a>
366set</kbd>" and not "<kbd><a href="#alpha" >-alpha</a> on</kbd>". That is,
367"<kbd><a href="#alpha" >-alpha</a> set</kbd>" will ensure that the written
368image is opaque if the original image had no transparency channel enabled,
369regardless if transparency data is already present. </p>
cristy3ed852e2009-09-05 21:47:34 +0000370
371
372<div style="margin: auto;">
373 <h4><a name="annotate" id="annotate"></a>
374 -annotate <em class="arg">degrees</em> <em class="arg">text</em><br />
375 -annotate <em class="arg">Xdegrees</em>x<em class="arg">Ydegrees</em> <em class="arg">text</em><br />
376 -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>
377</div>
378
379<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>
380
381<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>
382
383
384<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>
385
386<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>
387
388<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>
389<div class="eqn"><img alt="annotate transformation" src="../images/annotate.png"/></div>
390
391<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>
392
393<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>
394
395<div style="margin: auto;">
396 <h4><a name="antialias" id="antialias"></a>-antialias</h4>
397</div>
398
399<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
400drawing fonts and lines.</td><td style='text-align:right;'></td></tr></table>
401
402<p>By default, objects (e.g. text, lines, polygons, etc.) are antialiased when
403drawn. Use <a href="#antialias">+antialias</a> to disable the addition of
404antialiasing edge pixels. This will then reduce the number of colors added to
405an image to just the colors being directly drawn. That is, no mixed colors
406will be added when drawing such objects. </p>
407
408<div style="margin: auto;">
409 <h4><a name="append" id="append"></a>-append</h4>
410</div>
411
412<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>
413
414<p>This option creates a single longer image image, by joining all the current
415images in sequence top-to-bottom. Use <a href="#append">+append</a> to
416stack images left-to-right. </p>
417
418<p>If they are not of the same width, narrower images are padded with the
419current <a href="#background">-background</a> color setting, and their
420position relative to each other can be controled by the current <a
421href="#gravity">-gravity</a> setting. </p>
422
423
424<div style="margin: auto;">
425 <h4><a name="attenuate" id="attenuate"></a>-attenuate <em class="arg">value</em></h4>
426</div>
427
428<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>
429
430
431<div style="margin: auto;">
432 <h4><a name="authenticate" id="authenticate"></a>-authenticate <em class="arg">password</em></h4>
433</div>
434
435<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>
436
437<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>
438
439<p>For a different encryption method, see <a href="#encipher">-encipher</a> and <a href="#decipher">-decipher</a>. </p>
440
cristyd934d102009-10-10 12:55:13 +0000441
442
cristy3ed852e2009-09-05 21:47:34 +0000443<div style="margin: auto;">
444 <h4><a name="auto-gamma" id="auto-gamma"></a>-auto-gamma</h4>
445</div>
446
447<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>
448
cristyd934d102009-10-10 12:55:13 +0000449<p>This calculates the mean values of an image, then applies a calculated <a
450href="#gamma" >-gamma</a> adjustment so that is the mean color exists in the
451image it will get a have a value of 50%. </p>
452
453<p>This means that any solid 'gray' image will become 50% gray. </p>
454
455<p>This works well for real-life images with little or no extreme dark and
456light areas, but tend to fail for images with large amounts of bright sky or
457dark shadows. It also does not work well for diagrmas or cartoon like images.
458</p>
459
460<p>It uses the <a href="#channel" >-channel</a> setting, (including the
461'<CODE>sync</CODE>' flag for channel syncronization), to determine which color
462values will be used and modified. As the default <a href="#channel"
463>-channel</a> setting is '<CODE>RGB,sync</CODE>', channels will be modified
464together by the same gamma value, preserving colors. </p>
465
466
467
cristy3ed852e2009-09-05 21:47:34 +0000468<div style="margin: auto;">
469 <h4><a name="auto-level" id="auto-level"></a>-auto-level</h4>
470</div>
471
472<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>
473
cristyd934d102009-10-10 12:55:13 +0000474<p>This is a 'perfect' image normalization operator. It finds the exact
475mimimum and maximum color values in the image and then applies a <a
476href="#level" >-level</a> operator to stretch the values to the full range of
477values. </p>
478
cristy83543962009-10-16 19:04:28 +0000479<p>The operator is not typically used for real-life images, image scans, or
cristyd934d102009-10-10 12:55:13 +0000480JPEG format images, as a single 'out-rider' pixel can set a bad min/max values
481for the <a href="#level" >-level</a> operation. On the other hand it is the
482right operator to use for color stretching gradient images being used to
483generate Color lookup tables, distortion maps, or other 'mathematically'
484defined images. </p>
485
486<p>The operator is very similar to the <a href="#normalize">-normalize</a>, <a
487href="#contrast-stretch" >-contrast-stretch</a>, and <a href="#linear-stretch"
488>-linear-stretch</a> operators, but without 'histogram binning' or 'clipping'
489problems that these operators may have. That is <a href="#auto-level"
cristy83543962009-10-16 19:04:28 +0000490>-auto-level</a> is the perfect or ideal version these operators. </p>
cristyd934d102009-10-10 12:55:13 +0000491
492<p>It uses the <a href="#channel" >-channel</a> setting, (including the
493special '<CODE>sync</CODE>' flag for channel syncronization), to determine
494which color values will be used and modified. As the default <a
cristy83543962009-10-16 19:04:28 +0000495href="#channel" >+channel</a> setting is '<CODE>RGB,sync</CODE>', the
496'<CODE>sync</CODE>' will ensure that the color channels will be modified
497together by the same gamma value, preserving colors, and ignoring
498transparency. </p>
cristyd934d102009-10-10 12:55:13 +0000499
500
501
cristy3ed852e2009-09-05 21:47:34 +0000502<div style="margin: auto;">
503 <h4><a name="auto-orient" id="auto-orient"></a>-auto-orient</h4>
504</div>
505
506<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>
507
cristy83543962009-10-16 19:04:28 +0000508<p>This operator reads and resets the EXIF image profile setting 'Orientation'
509and then performs the appropriate 90 degree rotation on the image to orient
510the image, for correct viewing. </p>
511
512<p>This EXIF profile setting is usually set using a gravity sensor in digital
513camara, however photos taken directly downward or upward may not have an
514appropriate value. Also images that have been orientation 'corrected' without
515reseting this setting, may be 'corrected' again resulting in a incorrect
516result. If the he EXIF profile was previously stripped, the <a
517href="#auto-orient" >-auto-orient</a> operator will do nothing. </p>
518
519
cristy3ed852e2009-09-05 21:47:34 +0000520<div style="margin: auto;">
521 <h4><a name="average" id="average"></a>-average</h4>
522</div>
523
524<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>
525
526<p>An error results if the images are not identically sized.</p>
527
cristy3ed852e2009-09-05 21:47:34 +0000528
529<div style="margin: auto;">
530 <h4><a name="backdrop" id="backdrop"></a>-backdrop</h4>
531</div>
532
533<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>
534
535<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>
536
537<div style="margin: auto;">
538 <h4><a name="background" id="background"></a>-background <em class="arg">color</em></h4>
539</div>
540
541<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>
542
543<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>
544
545<div style="margin: auto;">
546 <h4><a name="bench" id="bench"></a>-bench <em class="arg">iterations</em></h4>
547</div>
548
549<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>
550
cristye6378132009-10-26 20:05:17 +0000551<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 +0000552
cristye6378132009-10-26 20:05:17 +0000553<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>
554<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 +0000555
556<div style="margin: auto;">
557 <h4><a name="bias" id="bias"></a>-bias <em class="arg">value</em>{<em class="arg">%</em>}</h4>
558</div>
559
560<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>
561
562<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>
563
564<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>
565
566<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
567negative results without clipping to the color value range
568(0..QuantumRange).</p>
569
570<p>See the discussion on HDRI implementations of ImageMagick on the page
571<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.
572</p>
573
574<div style="margin: auto;">
575 <h4><a name="black-point-compensation" id="black-point-compensation"></a>-black-point-compensation</h4>
576</div>
577
578<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>
579
580<div style="margin: auto;">
cristy5cadd612009-09-21 19:33:41 +0000581 <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 +0000582</div>
583
cristy5cadd612009-09-21 19:33:41 +0000584<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>
585
586<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.
587</p>
cristy3ed852e2009-09-05 21:47:34 +0000588
589
590<div style="margin: auto;">
591 <h4><a name="blend" id="blend"></a>-blend <em class="arg">percent</em></h4>
592</div>
593
594<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 percent.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
595
596<p>Blend will average the images together ('plus') according to the
597percentages given and each pixels transparency. If only a single percentage
598value is given it sets the weight of the composite or 'source' image, while
599the background image is weighted by the exact opposite amount. That is a
600<kbd>-blend 30</kbd> merges 30% of the 'source' image with 70% of the
601'destination' image. Thus it is equivalent to <kbd>-blend 30x70</kbd>.</p>
602
603
604<div style="margin: auto;">
605 <h4><a name="blue-primary" id="blue-primary"></a>-blue-primary <em class="arg">x</em>,<em class="arg">y</em></h4>
606</div>
607
608<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>
609
610<div style="margin: auto;">
611 <h4><a name="blue-shift" id="blue-shift"></a>-blue-shift <em class="arg">factor</em></h4>
612</div>
613
614<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>
615
616<div style="margin: auto;">
617
618<div style="margin: auto;">
619 <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>
620</div>
621
622<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>
623
624<p>Convolve the image with a Gaussian or normal distribution. The formula is:</p>
625
626<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
627</div>
628
629<p>Where <i>r</i> is the blur radius (<i>r</i><sup>2</sup> = <i>u</i><sup>2</sup> + <i>v</i><sup>2</sup>), and &sigma; is the standard deviation of the Gaussian distribution. As a guideline, set <i>r</i> to approximately 3&sigma;. If a radius of 0 is specified, ImageMagick selects a suitable radius for you.</p>
630
631<p>This option differs from <a href="#gaussian-blur">-gaussian-blur</a> simply by taking advantage of the separability properties of the distribution. Here we apply a single-dimensional Gaussian matrix in the horizontal direction, then repeat the process in the vertical direction.</p>
632
633<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
634pixels which are outside the image proper are blurred into the final result.
635</p>
636
637
638<div style="margin: auto;">
639 <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>
640</div>
641
642<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>
643
644<p>Each pixel in the overlaid region is replaced with an Elliptical Weighted
645Average (EWA) of the source image, scaled according to the grayscale
646mapping. </p>
647
648<p>The ellipse is weighted with sigma set to the given <em class="arg"
649>Width</em> and <em class="arg" >Height</em>. The <em class="arg" >Height</em>
650defaults to the <em class="arg" >Width</em> for a normal circular Guassian
651weighting. The <em class="arg" >Angle</em> will rotate the ellipse from
652horizontal clock-wise. </p>
653
654<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
655pixels which are outside the image proper are blurred into the final result.
656</p>
657
658
659<div style="margin: auto;">
660 <h4><a name="border" id="border"></a>-border <em class="arg">geometry</em></h4>
661</div>
662
663<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>
664
665<p>Set the width and height using the <em class="arg">size</em> portion of the <em class="arg">gravity</em> argument. See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. Offsets are ignored. </p>
666
667<p>Set the border color by preceding with the <a href="#bordercolor">-bordercolor</a> setting.</p>
668
669<p>See also the <a href="#frame">-frame</a> option, which has more functionality.</p>
670
671<div style="margin: auto;">
672 <h4><a name="bordercolor" id="bordercolor"></a>-bordercolor <em class="arg">color</em></h4>
673</div>
674
675<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>
676
677<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
678
679<p>The default border color is <kbd>#DFDFDF</kbd>, <span style="background-color: #dfdfdf;">this shade of gray</span>.</p>
680
681<div style="margin: auto;">
682 <h4><a name="borderwidth" id="borderwidth"></a>-borderwidth <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%'>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>
686
687<div style="margin: auto;">
cristy16ff93c2010-01-13 23:18:07 +0000688 <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>
689</div>
690
691<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>
692
693<p>Brightness and Contrast values apply changes to the input image. They are not absolute settings. A brightness or contrast value of zero means no change. The range of values is -100 to +100 on each. Positive values increase the brightness or contrast and negative values decrease the brightness or contrast. To control only contrast, set the brightness=0. To control only brightness, set contrast=0 or just leave it off.</p>
694
695<p>You may also use <a href="#fill">-channel</a> to control which channels to apply the brightness and/or contrast change. The default is to apply the same transformation to all channels.</p>
696
697<p>Brightness and Contrast arguments are converted to offset and slope of a linear transform and applied using <a href="#fill">-function polynomial "slope,offset"</a>.</p>
698
699<p>The slope varies from 0 at contrast=-100 to almost vertical at contrast=+100. For brightness=0 and contrast=-100, the result will be totally midgray. For brightness=0 and contrast=+100, the result will approach but not quite reach a threshold at midgray; that is the linear transformation will be a a very steep vertical line at mid gray.</p>
700
701<p>Negative slopes, i.e. negating the image, are not possible with this function. All achievable slopes will be zero or positive.</p>
702
703<p>The offset varies from -0.5 at brightness=-100 to 0 at brightness=0 to +0.5 at brightness=+100. Thus, when contrast=0 and brightness=100, the result will be totally white. Similarly, when contrast=0 and brightness=-100, the result will be totally black.</p>
704
705<p>As the range of values for the arguments are -100 to +100, adding the '%' symbol will be no different than leaving it off.</p>
706
707<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +0000708 <h4><a name="cache" id="cache"></a>-cache <em class="arg">threshold</em></h4>
709</div>
710
711<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>
712
713<div style="margin: auto;">
714 <h4><a name="caption" id="caption"></a>-caption <em class="arg">string</em></h4>
715</div>
716
717<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>
718
719<div style="margin: auto;">
720 <h4><a name="cdl" id="cdl"></a>-cdl <em class="arg">filename</em></h4>
721</div>
722
723<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>
724
725<p>Here is an example color correction collection:</p>
726
727<pre class="text">
728&lt;?xml version="1.0" encoding="UTF-8"?>
729&lt;ColorCorrectionCollection xmlns="urn:ASC:CDL:v1.2">
730 &lt;ColorCorrection id="cc06668">
731 &lt;SOPNode>
732 &lt;Slope> 0.9 1.2 0.5 &lt;/Slope>
733 &lt;Offset> 0.4 -0.5 0.6 &lt;/Offset>
734 &lt;Power> 1.0 0.8 1.5 &lt;/Power>
735 &lt;/SOPNode>
736 &lt;SATNode>
737 &lt;Saturation> 0.85 &lt;/Saturation>
738 &lt;/SATNode>
739 &lt;/ColorCorrection>
740&lt;/ColorCorrectionCollection>
741</pre>
742
743<div style="margin: auto;">
744 <h4><a name="channel" id="channel"></a>-channel <em class="arg">type</em></h4>
745</div>
746
747<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>
748
749<p>Choose from: <kbd>Red</kbd>, <kbd>Green</kbd>, <kbd>Blue</kbd>, <kbd>Alpha</kbd>, <kbd>Cyan</kbd>, <kbd>Magenta</kbd>, <kbd>Yellow</kbd>, <kbd>Black</kbd>, <kbd>Opacity</kbd>, <kbd>Index</kbd>, <kbd>RGB</kbd>, <kbd>RGBA</kbd>, <kbd>CMYK</kbd>, or <kbd>CMYKA</kbd>.</p>
750
751<p>To print a complete list of channel types, use <a href="#list">-list channel</a>.</p>
752
cristyd934d102009-10-10 12:55:13 +0000753<p>The channels above can be specified as a comma-separated list or can be
754abbreviated as a concatenation of the letters '<kbd>R</kbd>', '<kbd>G</kbd>',
755'<kbd>B</kbd>', '<kbd>A</kbd>', '<kbd>O</kbd>', '<kbd>C</kbd>',
756'<kbd>M</kbd>', '<kbd>Y</kbd>', '<kbd>K</kbd>'.
cristy3ed852e2009-09-05 21:47:34 +0000757
758For example, to negate only the alpha channel of an image, use</p>
759<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +0000760 -channel Alpha -negate
cristy3ed852e2009-09-05 21:47:34 +0000761</p>
762
cristyd934d102009-10-10 12:55:13 +0000763Some operators also allow the use of a special channel flag
764'<code>sync</code>'. If present operators that understand this flag will
765apply the exact same image modification to all the image channels in the image
766so as to ensure that colors are kept 'in-sync'. Without this flag such
767operators will apply there function to each channel separately. See <a
768href="#auto-level">-auto-level</a> and <a href="#auto-gamma">-auto-gamma</a>
769for examples of such an operator. </p>
cristy3ed852e2009-09-05 21:47:34 +0000770
cristyd934d102009-10-10 12:55:13 +0000771
772<p>By default, ImageMagick sets <a href="#channel">-channel</a> to the value
773'<kbd>RGB,sync</kbd>', which specifies that operators act on all channels
774except the opacity channel, and that all the color channels are to be modified
775in exactly the same way. The 'plus' form <a href="#channel" >+channel</a>
776will reset the value back to this default. </p>
777
778<p>Options that are affected by the <a href="#channel" >-channel</a> setting
779include the following.
780
781<a href="#auto-gamma">-auto-gamma</a>,
782<a href="#auto-level">-auto-level</a>,
cristy3ed852e2009-09-05 21:47:34 +0000783<a href="#black-threshold">-black-threshold</a>,
784<a href="#blur">-blur</a>,
cristyb4c03bb2009-09-27 13:55:46 +0000785<a href="#clamp">-clamp</a>,
cristy3ed852e2009-09-05 21:47:34 +0000786<a href="#clut">-clut</a>,
787<a href="#combine">-combine</a>,
788<a href="#contrast-stretch">-contrast-stretch</a>,
789<a href="#evaluate">-evaluate</a>,
790<a href="#function">-function</a>,
791<a href="#fx">-fx</a>,
cristy3ed852e2009-09-05 21:47:34 +0000792<a href="#gaussian-blur">-gaussian-blur</a>,
cristyd934d102009-10-10 12:55:13 +0000793<a href="#hald-clut">-hald-clut</a>,
cristy3ed852e2009-09-05 21:47:34 +0000794<a href="#motion-blur">-motion-blur</a>,
795<a href="#negate">-negate</a>,
796<a href="#normalize">-normalize</a>,
797<a href="#ordered-dither">-ordered-dither</a>,
798<a href="#radial-blur">-radial-blur</a>,
799<a href="#random-threshold">-random-threshold</a>,
800<a href="#separate">-separate</a>, and
cristyd934d102009-10-10 12:55:13 +0000801<a href="#threshold">-threshold</a>, and
cristy3ed852e2009-09-05 21:47:34 +0000802<a href="#white-threshold">-white-threshold</a>.
803</p>
804
cristyd934d102009-10-10 12:55:13 +0000805<p>Warning, some operators behave differentally when the <a href="#channel"
806>+channel</a> default setting is in effect, verses ANY user defined <a
807href="#channel" >-channel</a> setting (including the equivelent of the
808default). For example <a href="#threshold">-threshold</a> will by default
809gray-scale the image before thresholding, if no <a href="#channel"
810>-channel</a> setting has been defined. </p>
811
812<p>Also some operators such as <a href="#blur">-blur</a>, <a
813href="#gaussian-blur">-gaussian-blur</a>, will modify their handling of the
814color channels if the '<kbd>alpha</kbd>' channel is also enabled by <a
815href="#channel" >-channel</a>. Generally this done to ensure that
816fully-transparent colors are treated as being fully-transparent, and thus any
817underlying 'hidden' color has no effect on the final results. Typically
818resulting in 'halo' effects. </p>
819
820<p>As a alpha channel is optional within images some operators will read the
821color channels of an image as a greyscale alpha mask, when the image has no
822alpha channel present, but the <a href="#channel" >-channel</a> setting tells
823the operator to apply the alpha channel. The <a href="#clut">-clut</a>
824operator is a good example of this. </p>
825
cristy3ed852e2009-09-05 21:47:34 +0000826
827<div style="margin: auto;">
cristyb4c03bb2009-09-27 13:55:46 +0000828 <h4><a name="clamp" id="clamp"></a>-clamp</h4>
829</div>
830
831<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>
832
833<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +0000834 <h4><a name="charcoal" id="charcoal"></a>-charcoal <em class="arg">factor</em></h4>
835</div>
836
837<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>
838
839<div style="margin: auto;">
840 <h4><a name="chop" id="chop"></a>-chop <em class="arg">geometry</em></h4>
841</div>
842
843<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>
844
845<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <em class="arg">width</em> and <em class="arg">height</em> given in the of the <em class="arg">size</em> portion of the <em class="arg">geometry</em> argument give the number of columns and rows to remove. The <em class="arg">offset</em> portion of the <em class="arg">geometry</em> argument is influenced by a <a href="#gravity">-gravity</a> setting, if present.</p>
846
847<p>The <a href="#chop">-chop</a> option removes entire rows and columns, and moves the remaining corner blocks leftward and upward to close the gaps.</p>
848
849<div style="margin: auto;">
850 <h4><a name="clip" id="clip"></a>-clip</h4>
851</div>
852
853<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>
854
855<p>If a clipping path is present, it is applied to subsequent operations.</p>
856
857<p>For example, in the command</p>
858
859<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -clip -negate cockatoo.tif negated.tif</span></p>
860<p>only the pixels within the clipping path are negated.</p>
861
862<p>The <a href="#clip">-clip</a> feature requires the XML library. If the XML library is not present, the option is ignored.</p>
863
864<div style="margin: auto;">
865 <h4><a name="clip-mask" id="clip-mask"></a>-clip-mask</h4>
866</div>
867
868<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>
869
870<div style="margin: auto;">
871 <h4><a name="clip-path" id="clip-path"></a>-clip-path <em class="arg">id</em></h4>
872</div>
873
874<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>
875
876<div style="margin: auto;">
877 <h4><a name="clone" id="clone"></a>-clone <em class="arg">index(s)</em></h4>
878</div>
879
880<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>
881
882<p>Specify the image by its index in the sequence. The first image is index
8830. Negative indexes are relative to the end of the sequence; for example, &minus;1
884represents the last image of the sequence. Specify a range of images with a
885dash (e.g. 0&minus;4). Separate multiple indexes with commas but no spaces (e.g. 0,2,5). Use <a
886href="#clone">+clone</a> make a copy of the last image in the image
887sequence.</p>
888
889<div style="margin: auto;">
890 <h4><a name="clut" id="clut"></a>-clut</h4>
891</div>
892
893<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
894corresponding channel in the second image as a <b>c</b>olor
895<b>l</b>ook<b>u</b>p <b>t</b>able.</td><td style='text-align:right;'></td></tr></table>
896
897<p>The second (LUT) image is ordinarily a gradient image containing the
898histogram mapping of how each channel should be modified. Typically it is a
899either a single row or column image of replacement color values. If larger
900than a single row or column, values are taken from a diagonal line from
901top-left to bottom-right corners.</p>
902
903<p>The lookup is further controlled by the <a
904href="#interpolate">-interpolate</a> setting, which is especially handy for an
905LUT which is not the full length needed by the ImageMagick installed Quality
906(Q) level. Good settings for this are the '<kbd>bilinear</kbd>' and
907'<kbd>bicubic</kbd>' interpolation settings, which give smooth color
908gradients, and the '<kbd>integer</kbd>' setting for a direct, unsmoothed
909lookup of color values. </p>
910
911<p>This operator is especially suited to replacing a grayscale image with a
912specific color gradient from the CLUT image. </p>
913
914<p>Only the channel values defined by the <a href="#channel">-channel</a>
915setting will have their values replaced. In particular, since the default <a
916href="#channel">-channel</a> setting is <kbd>RGB</kbd>, this means that
917transparency (alpha/matte channel) is not affected, unless the <a
918href="#channel">-channel</a> setting is modified. When the alpha channel is
919set, it is treated by the <a href="#clut" >-clut</a> operator in the same way
920as the other channels, implying that alpha/matte values are replaced using the
921alpha/matte values of the original image. </p>
922
923<p>If either the image being modified, or the lookup image, conatins no
924transparency (i.e. <a href="#alpha" >-alpha</a> is turned 'off') but the <a
925href="#channel">-channel</a> setting includes alpha replacement, then it is
926assumed that image represents a gray-scale graident which will be used for the
927replacement alpha values. That is you can use a gray-scale CLUT image to
928adjust a existing images alpha channel, or you can color a gray-scale image
929using colors form CLUT containing the desired colors, including transparency.
930</p>
931
932<p>See also <a href="#hald-clut" >-hald-clut</a> which replaces colors according
933the lookup of the full color RGB value from a 2D representation of a 3D color
934cube. </p>
935
936
937<div style="margin: auto;">
938 <h4><a name="coalesce" id="coalesce"></a>-coalesce</h4>
939</div>
940
941<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>
942
943<p>Overlay each image in an image sequence according to its <a href="#dispose">-dispose</a> meta-data, to reproduce the look of an animation at each point in the animation sequence. All images should be the same size, and are assigned appropriate GIF disposal settings for the animation to continue working as expected as a GIF animation. Such frames are more easilly viewed and processed than the highly optimized GIF overlay images. </p>
944
945<p>The animation can be re-optimized after processing using the <a href="#layers">-layers</a> method '<kbd>optimize</kbd>', though there is no guarantee that the restored GIF animation optimization is better than the original. </p>
946
947
948<div style="margin: auto;">
949 <h4><a name="colorize" id="colorize"></a>-colorize <em class="arg">value</em></h4>
950</div>
951
952<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>
953
954<p>Specify the amount of colorization as a percentage. Separate colorization values can be applied to the red, green, and blue channels of the image with a comma-delimited list of colorization values (e.g., <kbd>-colorize 0,0,50</kbd>).</p>
955
956<div style="margin: auto;">
957 <h4><a name="colormap" id="colormap"></a>-colormap <em class="arg">type</em></h4>
958</div>
959
960<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>
961
962<p>The <em class="arg">type</em> can be <kbd>shared</kbd> or <kbd>private</kbd>.</p>
963
964<p>This option only applies when the default X server visual is <kbd>PseudoColor</kbd> or <kbd>GrayScale</kbd>. Refer to <a href="#visual">-visual</a> for more details. By default, a shared colormap is allocated. The image shares colors with other X clients. Some image colors could be approximated, therefore your image may look very different than intended. If <kbd>private</kbd> is chosen, the image colors appear exactly as they are defined. However, other clients may go <em>technicolor</em> when the image colormap is installed.</p>
965
966<div style="margin: auto;">
967 <h4><a name="colors" id="colors"></a>-colors <em class="arg">value</em></h4>
968</div>
969
970<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>
971
972<p>The actual number of colors in the image may be less than your request, but never more. Note that this a color reduction option. Images with fewer unique colors than specified by <em class="arg">value</em> will have any duplicate or unused colors removed. The ordering of an existing color palette may be altered. When converting an image from color to grayscale, it is more efficient to convert the image to the gray colorspace before reducing the number of colors. Refer to the <a href="../www/quantize.html">color reduction algorithm</a> for more details.</p>
973
974<div style="margin: auto;">
975 <h4><a name="colorspace" id="colorspace"></a>-colorspace <em class="arg">value</em></h4>
976</div>
977
978<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>
979
980<p>Choices are:</p>
981
982<pre class="text">
983 CMY
984 CMYK
985 Gray
986 HSB
987 HSL
988 HWB
989 Lab
990 Log
991 OHTA
992 Rec601Luma
993 Rec601YCbCr
994 Rec709Luma
995 Rec709YCbCr
996 RGB
997 sRGB
998 Transparent
999 XYZ
1000 YCbCr
1001 YCC
1002 YIQ
1003 YPbPr
1004 YUV
1005</pre>
1006
1007<p>To print a complete list of colorspaces, use <a href="#list">-list colorspace</a>.</p>
1008
1009<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>
1010
1011<table class="doc">
1012 <caption>Conversion Of RGB To Other Color Spaces</caption>
1013 <tr><th align="left" valign="middle">CMY</th></tr>
1014 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>&minus;R</td></tr>
1015 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>&minus;G</td></tr>
1016 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>&minus;B</td></tr>
1017 <tr><th align="left" valign="middle">CMYK &mdash; starts with CMY from above</th></tr>
1018 <tr><td align="left" valign="middle">K=min(C,Y,M)</td></tr>
1019 <tr><td align="left" valign="middle">C=<em class="QR">QuantumRange</em>*(C&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1020 <tr><td align="left" valign="middle">M=<em class="QR">QuantumRange</em>*(M&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1021 <tr><td align="left" valign="middle">Y=<em class="QR">QuantumRange</em>*(Y&minus;K)/(<em class="QR">QuantumRange</em>&minus;K)</td></tr>
1022
1023 <tr><th align="left" valign="middle">Gray</th></tr>
1024 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1025
1026 <tr><th align="left" valign="middle">HSB &mdash; Hue, Saturation, Brightness; like a cone peak downward</th></tr>
1027 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1028 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1029 <tr><td align="left" valign="middle">B=distance along axis from bottom upward; B=max(R,G,B); <em>intensity-like</em></td></tr>
1030
1031 <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>
1032 <tr><td align="left" valign="middle">H=angle around perimeter (0 to 360 deg); H=0 is red; increasing angles toward green</td></tr>
1033 <tr><td align="left" valign="middle">S=distance from axis outward</td></tr>
1034 <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>
1035
1036 <tr><th align="left" valign="middle">HWB &mdash; Hue, Whiteness, Blackness</th></tr>
1037 <tr><td align="left" valign="middle">Hue (complicated equation)</td></tr>
1038 <tr><td align="left" valign="middle">Whiteness (complicated equation)</td></tr>
1039 <tr><td align="left" valign="middle">Blackness (complicated equation)</td></tr>
1040
1041 <tr><th align="left" valign="middle">LAB</th></tr>
1042 <tr><td align="left" valign="middle">L (complicated equation relating X,Y,Z)</td></tr>
1043 <tr><td align="left" valign="middle">A (complicated equation relating X,Y,Z)</td></tr>
1044 <tr><td align="left" valign="middle">B (complicated equation relating X,Y,Z)</td></tr>
1045
1046 <tr><th align="left" valign="middle">LOG</th></tr>
1047 <tr><td align="left" valign="middle">I1 (complicated equation involving logarithm of R)</td></tr>
1048 <tr><td align="left" valign="middle">I2 (complicated equation involving logarithm of G)</td></tr>
1049 <tr><td align="left" valign="middle">I3 (complicated equation involving logarithm of B)</td></tr>
1050
1051 <tr><th align="left" valign="middle">OHTA &mdash; approximates principal components transformation</th></tr>
1052 <tr><td align="left" valign="middle">I1=0.33333*R+0.33334*G+0.33333*B; <em>intensity-like</em></td></tr>
1053 <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>
1054 <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>
1055
1056 <tr><th align="left" valign="middle">Rec601Luma</th></tr>
1057 <tr><td align="left" valign="middle">Gray = 0.29900*R+0.58700*G+0.11400*B</td></tr>
1058
1059 <tr><th align="left" valign="middle">Rec601YCbCr</th></tr>
1060 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1061 <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>
1062 <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>
1063
1064 <tr><th align="left" valign="middle">Rec709Luma</th></tr>
1065 <tr><td align="left" valign="middle">Gray=0.21260*R+0.71520*G+0.07220*B</td></tr>
1066
1067 <tr><th align="left" valign="middle">Rec709YCbCr</th></tr>
1068 <tr><td align="left" valign="middle">Y=0.212600*R+0.715200*G+0.072200*B; <em>intensity-like</em></td></tr>
1069 <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>
1070 <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>
1071
1072 <tr><th align="left" valign="middle">sRGB</th></tr>
1073 <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>
1074 <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>
1075 <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>
1076
1077 <tr><th align="left" valign="middle">XYZ</th></tr>
1078 <tr><td align="left" valign="middle">X=0.4124240*R+0.3575790*G+0.1804640*B</td></tr>
1079 <tr><td align="left" valign="middle">Y=0.2126560*R+0.7151580*G+0.0721856*B</td></tr>
1080 <tr><td align="left" valign="middle">Z=0.0193324*R+0.1191930*G+0.9504440*B</td></tr>
1081
1082 <tr><th align="left" valign="middle">YCC</th></tr>
1083 <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>
1084 <tr><td align="left" valign="middle">C1=(&minus;0.29900*R&minus;0.58700*G+0.88600*B) (with complicated scaling)</td></tr>
1085 <tr><td align="left" valign="middle">C2=(0.70100*R&minus;0.58700*G&minus;0.11400*B) (with complicated scaling)</td></tr>
1086
1087 <tr><th align="left" valign="middle">YCbCr</th></tr>
1088 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1089 <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>
1090 <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>
1091
1092 <tr><th align="left" valign="middle">YIQ</th></tr>
1093 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1094 <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>
1095 <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>
1096
1097 <tr><th align="left" valign="middle">YPbPr</th></tr>
1098 <tr><td align="left" valign="middle">Y=0.299000*R+0.587000*G+0.114000*B; <em>intensity-like</em></td></tr>
1099 <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>
1100 <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>
1101
1102 <tr><th align="left" valign="middle">YUV</th></tr>
1103 <tr><td align="left" valign="middle">Y=0.29900*R+0.58700*G+0.11400*B; <em>intensity-like</em></td></tr>
1104 <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>
1105 <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>
1106</table>
1107
1108<div style="margin: auto;">
1109 <h4><a name="combine" id="combine"></a>-combine</h4>
1110</div>
1111
1112<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>
1113
1114<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>
1115
1116<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.
1117</p>
1118
cristy4949d522010-03-12 18:41:34 +00001119<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 +00001120<div style="margin: auto;">
1121 <h4><a name="comment" id="comment"></a>-comment <em class="arg">string</em></h4>
1122</div>
1123
1124<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>
1125
1126<p>This option places comments in a non-pixel portion of the image file. For a comment to be visibly written on the image itself, use the <a href="#annotate">-annotate</a> or <a href="#draw">-draw</a> options.</p>
1127
1128<p>Use this option to assign a specific comment to the image, when writing to an image format that supports comments. You can include the image filename, type, width, height, or other image attribute by embedding special format characters listed under the <a href="#format">-format</a> option. The comment is not drawn on the image, but is embedded in the image datastream via "Comment" tag or similar mechanism. </p>
1129
1130<p>For example,</p>
1131
1132<p class="crtsnip">
1133 -comment "%m:%f %wx%h"
1134</p>
1135
1136<p>produces an image comment of <kbd>MIFF:bird.miff 512x480</kbd> for an image titled <kbd>bird.miff</kbd> and whose width is 512 and height is 480.</p>
1137
1138<p>If the first character of <em class="arg">string</em> is <em class="arg">@</em>, the image comment is read from a file titled by the remaining characters in the string. Comments in a file are literal; no embedded formatting characters are recognized.</p>
1139
1140<div style="margin: auto;">
1141 <h4><a name="compose" id="compose"></a>-compose <em class="arg">operator</em></h4>
1142</div>
1143
1144<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>
1145
1146<p>The description of composition uses abstract terminology in order to allow
1147the description to be more precise, while avoiding constant values which are
1148specific to a particular build configuration. Each image pixel is represented
1149by red, green, and blue levels (which are equal for a gray pixel). The
1150build-dependent value <em class="QR">QuantumRange</em> is the maximum integral
1151value which may be stored, per pixel, in the red, green, or blue channels of
1152the image. Each image pixel may also optionally (if the image matte channel is
1153enabled) have an associated level of opacity, ranging from <em>opaque</em> to
1154<em>transparent</em>, which may be used to determine the influence of the pixel
1155color when compositing the pixel with another image pixel. If the image matte
1156channel is disabled, then all pixels in the image are treated as opaque. The
1157color of an opaque pixel is fully visible while the color of a transparent
1158pixel color is entirely absent (pixel color is ignored).</p>
1159
1160<p>By definition, raster images have a rectangular shape. All image rows are of
1161equal length, as are all image columns. By treating the alpha channel as a
1162visual "mask" the rectangular image may be given a "shape" by treating the
1163alpha channel as a cookie-cutter for the image. This is done by setting the
1164pixels within the shape to be opaque, with pixels outside the shape set as
1165transparent. Pixels on the boundary of the shape may be between opaque and
1166transparent in order to provide antialiasing (visually smooth edges). The
1167description of the composition operators use this concept of image "shape" in
1168order to make the description of the operators easier to understand. While it
1169is convenient to describe the operators in terms of "shapes" they are by no
1170means limited to mask-style operations since they are based on continuous
1171floating-point mathematics rather than simple boolean operations.</p>
1172
1173<p>The following alpha blending (Duff-Porter) compose methods are available:</p>
1174
1175<table class="doc">
1176 <tbody>
1177 <tr valign="top">
1178 <th align="left" style="width: 8%">Method</th>
1179 <th align="left">Description</th>
1180 </tr>
1181
1182 <tr valign="top">
1183 <td valign="top">clear</td>
1184 <td valign="top">Both the color and the alpha of the destination are
1185 cleared. Neither the source nor the destination are used (except for
1186 destinations size and other meta-data which is always preserved.</td>
1187 </tr>
1188
1189 <tr valign="top">
1190 <td valign="top">src</td>
1191 <td valign="top">The source is copied to the destination. The destination
1192 is not used as input, though it is cleared.</td>
1193 </tr>
1194
1195 <tr valign="top">
1196 <td valign="top">dst</td>
1197 <td valign="top">The destination is left untouched. The source image is
1198 completely ignored.</td>
1199 </tr>
1200
1201 <tr valign="top">
1202 <td valign="top">src-over</td>
1203 <td valign="top">The source is composited over the destination. this is
1204 the default alpha blending compose method, when neither the compose
1205 setting is set, nor is set in the image meta-data.</td>
1206 </tr>
1207
1208 <tr valign="top">
1209 <td valign="top">dst-over</td>
1210 <td valign="top">The destination is composited over the source and the
1211 result replaces the destination.</td>
1212 </tr>
1213
1214 <tr valign="top">
1215 <td valign="top">src-in</td>
1216 <td valign="top">The part of the source lying inside of the destination
1217 replaces the destination.</td>
1218 </tr>
1219
1220 <tr valign="top">
1221 <td valign="top">dst-in</td>
1222 <td valign="top">The part of the destination lying inside of the source
1223 replaces the destination. Areas not overlaid are cleared.</td>
1224 </tr>
1225
1226 <tr valign="top">
1227 <td valign="top">src-out</td>
1228 <td valign="top">The part of the source lying outside of the destination
1229 replaces the destination.</td>
1230 </tr>
1231
1232 <tr valign="top">
1233 <td valign="top">dst-out</td>
1234 <td valign="top">The part of the destination lying outside of the source
1235 replaces the destination.</td>
1236 </tr>
1237
1238 <tr valign="top">
1239 <td valign="top">src-atop</td>
1240 <td valign="top">The part of the source lying inside of the destination is
1241 composited onto the destination.</td>
1242 </tr>
1243
1244 <tr valign="top">
1245 <td valign="top">dst-atop</td>
1246 <td valign="top">The part of the destination lying inside of the source is
1247 composited over the source and replaces the destination. Areas not
1248 overlaid are cleared. </td>
1249 </tr>
1250
1251 <tr valign="top">
1252 <td valign="top">xor</td>
1253 <td valign="top">The part of the source that lies outside of the
1254 destination is combined with the part of the destination that lies
1255 outside of the source. Source or Destination, but not both. </td>
1256 </tr>
1257
1258 </tbody>
1259</table>
1260
1261<p>Any of the 'Src-*' methods can also be specified without the 'Src-' part.
1262For example the defaul compose method can be specified as just 'Over'.</p>
1263
1264
1265<p>The following mathemathical composition methods are also available. </p>
1266
1267<p>Typically these use the default 'Over' alpha blending when transparencies
1268are also involved, except for 'Plus', 'Minus', 'Add', and 'Subtract', which
1269also composes the alpha channel using the same process as the color channels.
1270This allows them to be used for special image masking techniques. </p>
1271
1272<table class="doc">
1273 <tbody>
1274 <tr valign="top">
1275 <th align="left" style="width: 8%">Method</th>
1276 <th align="left">Description</th>
1277 </tr>
1278
1279 <tr valign="top">
1280 <td valign="top">multiply</td>
1281 <td valign="top">The source is multiplied by the destination and replaces the destination. The resultant color is always at least as dark as either of the two constituent colors. Multiplying any color with black produces black. Multiplying any color with white leaves the original color unchanged.</td>
1282 </tr>
1283
1284 <tr valign="top">
1285 <td valign="top">screen</td>
1286 <td valign="top">The source and destination are complemented and then multiplied and then replace the destination. The resultant color is always at least as light as either of the two constituent colors. Screening any color with white produces white. Screening any color with black leaves the original color unchanged.</td>
1287 </tr>
1288
1289 <tr valign="top">
1290 <td valign="top">plus</td>
1291 <td valign="top">The source is added to the destination and replaces the
1292 destination. This operator is useful for averaging or a controled
1293 merger of two images, rather than a direct overlay.</td>
1294 </tr>
1295
1296 <tr valign="top">
1297 <td valign="top">add</td>
1298 <td valign="top">As per 'plus' but transparency data is treated as matte
1299 values. As such any transparent areas in either image remain
1300 transparent. </td>
1301 </tr>
1302
1303 <tr valign="top">
1304 <td valign="top">minus</td>
1305 <td valign="top">Subtract the colors in the source image from the
1306 destination image. When transparency is involved, opaque areas is
1307 subtracted from any destination opaque areas. </td>
1308 </tr>
1309
1310 <tr valign="top">
1311 <td valign="top">subtract</td>
1312 <td valign="top">Subtract the colors in the source image from the
1313 destination image. When transparency is involved transparent areas are
1314 subtracted, so only the opaque areas in the source remain opaque in
1315 the destination image. </td>
1316 </tr>
1317
1318 <tr valign="top">
1319 <td valign="top">difference</td>
1320 <td valign="top">Subtracts the darker of the two constituent colors from
1321 the lighter. Painting with white inverts the destination color.
1322 Painting with black produces no change.</td>
1323 </tr>
1324
1325 <tr valign="top">
1326 <td valign="top">exclusion</td>
1327 <td valign="top">Produces an effect similar to that of 'difference', but
1328 appears as lower contrast. Painting with white inverts the
1329 destination color. Painting with black produces no change.</td>
1330 </tr>
1331
1332 <tr valign="top">
1333 <td valign="top">darken</td>
1334 <td valign="top">Selects the darker of the destination and source colors.
1335 The destination is replaced with the source when the source is darker,
1336 otherwise it is left unchanged.</td>
1337 </tr>
1338
1339 <tr valign="top">
1340 <td valign="top">lighten</td>
1341 <td valign="top">Selects the lighter of the destination and source colors.
1342 The destination is replaced with the source when the source is
1343 lighter, otherwise it is left unchanged. </td>
1344 </tr>
1345
1346 <tr valign="top">
1347 <td valign="top">linear-dodge</td>
1348 <td valign="top">This is equivelent to 'Plus' in that the color channels
1349 are simply added, however it does not 'Plus' the alpha channel, but
1350 uses the normal 'Over' alpha blending, which transparencies are
1351 involved. Produces a sort of additive multiply-like result. Added
1352 ImageMagick version 6.5.4-3. </td>
1353 </tr>
1354
1355 <tr valign="top">
1356 <td valign="top">linear-burn</td>
1357 <td valign="top">As 'Linear-Dodge', but also subtract one from the result.
1358 Sort of a additive 'Screen' of the images. Added ImageMagick version
1359 6.5.4-3. </td>
1360 </tr>
1361
1362 <tr valign="top">
1363 <td valign="top">color-dodge</td>
1364 <td valign="top">Brightens the destination color to reflect the source
1365 color. Painting with black produces no change.</td>
1366 </tr>
1367
1368 <tr valign="top">
1369 <td valign="top">color-burn</td>
1370 <td valign="top">Darkens the destination color to reflect the source
1371 color. Painting with white produces no change. Fixed in ImageMagick
1372 version 6.5.4-3. </td>
1373 </tr>
1374
1375 <tr valign="top">
1376 <td valign="top">overlay</td>
1377 <td valign="top">Multiplies or screens the colors, dependent on the
1378 destination color. Source colors overlay the destination whilst
1379 preserving its highlights and shadows. The destination color is not
1380 replaced, but is mixed with the source color to reflect the lightness
1381 or darkness of the destination.</td>
1382 </tr>
1383
1384 <tr valign="top">
1385 <td valign="top">hard-light</td>
1386 <td valign="top">Multiplies or screens the colors, dependent on the source
1387 color value. If the source color is lighter than 0.5, the destination
1388 is lightened as if it were screened. If the source color is darker
1389 than 0.5, the destination is darkened, as if it were multiplied. The
1390 degree of lightening or darkening is proportional to the difference
1391 between the source color and 0.5. If it is equal to 0.5 the
1392 destination is unchanged. Painting with pure black or white produces
1393 black or white.</td>
1394 </tr>
1395
1396
1397 <tr valign="top">
1398 <td valign="top">linear-light</td>
1399 <td valign="top">Like 'Hard-Light' but using linear-dodge and linear-burn
1400 instead. Increases contrast slightly with an impact on the
1401 foreground's tonal values.</td>
1402 </tr>
1403
1404 <tr valign="top">
1405 <td valign="top">soft-light</td>
1406 <td valign="top">Darkens or lightens the colors, dependent on the source
1407 color value. If the source color is lighter than 0.5, the destination
1408 is lightened. If the source color is darker than 0.5, the destination
1409 is darkened, as if it were burned in. The degree of darkening or
1410 lightening is proportional to the difference between the source color
1411 and 0.5. If it is equal to 0.5, the destination is unchanged. Painting
1412 with pure black or white produces a distinctly darker or lighter area,
1413 but does not result in pure black or white. Fixed in ImageMagick
1414 version 6.5.4-3. </td>
1415 </tr>
1416
1417 <tr valign="top">
1418 <td valign="top">pegtop-light</td>
1419 <td valign="top">Almost equivelent to 'Soft-Light', but using a
1420 continuious mathematical formula rather than two conditionally
1421 selected formulae. Added ImageMagick version 6.5.4-3. </td>
1422 </tr>
1423
1424 <tr valign="top">
1425 <td valign="top">vivid-light</td>
1426 <td valign="top">A modified 'Linear-Light' designed to preserve very stong
1427 primary and secondary colors in the image. Added ImageMagick version
1428 6.5.4-3. </td>
1429 </tr>
1430
1431 <tr valign="top">
1432 <td valign="top">pin-light</td>
1433 <td valign="top">Similar to 'Hard-Light', but using sharp linear shadings,
1434 to similate the effects of a strong 'pinhole' light source. Added
1435 ImageMagick version 6.5.4-3. </td>
1436 </tr>
1437
1438 </tbody>
1439</table>
1440
1441
1442<p>Also included are these special purpose compose methods:</p>
1443
1444<table class="doc">
1445 <tbody>
1446 <tr valign="top">
1447 <th align="left" style="width: 8%">Method</th>
1448 <th align="left">Description</th>
1449 </tr>
1450
1451 <tr valign="top">
1452 <td valign="top">copy-*</td>
1453 <td valign="top">Copy the specified channel (Red, Green, Blue, Cyan,
1454 Magenta, Yellow, Black, or Opacity) in the source image to the
1455 same channel in the destination image. If the channel specified
1456 does not exist in the source image, (which can only happen for methods,
1457 '<kbd>copy-opacity</kbd>' or '<kbd>copy-black</kbd>') then it is
1458 assumed that the source image is a special grayscale channel image
1459 of the values to be copied. </td>
1460 </tr>
1461
1462 <tr valign="top">
1463 <td valign="top">change-mask</td>
1464 <td valign="top">Replace any destination pixel that is the similar to the source images pixel (as defined by the current <a href="#fuzz">-fuzz</a> factor), with transparency. </td>
1465 </tr>
1466 </tbody>
1467</table>
1468
1469<p>On top of these composed methods are a few special ones that not only require
1470the two images that are being merged or overlaid, but have some extra numerical
1471arguments, which are tabled below. </p>
1472
1473<p>In the "<code>composite</code>" command these composition methods are
1474selected using special options with the arguments needed. They are usually,
1475but not always, the same name as the composte 'method' they use, and replaces
1476the normal use of the <a href="#compose" >-compose</a> setting in the
1477"<code>composite</code>" command. For example... </p>
1478
1479<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>composite ... -blend 50x50 ...</span></p>
1480<p>As of IM v6.5.3-4 the "<code>convert</code>" command can now also supply
1481these extra arguments to its <a href="#composite" >-composite</a> operator,
1482using the special <a href="#set">-set</a> attribute of '<kbd class="arg">option:compose:args</kbd>'. This means you can now make use of
1483these special argumented <a href="#compose" >-compose</a> methods, those the
1484argument and the method both need to be set separatally. For example... </p>
1485
1486<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert ... -compose blend -set option:compose:args 50x50 -composite ...</span></p>
1487<p>The following is a table of these special 'argumented' compose methods,
1488with a brief summary of what they do. For more details see the equivalent
1489"composite" command option name. </p>
1490
1491<table class="doc">
1492 <tbody>
1493 <tr valign="top">
1494 <th align="left" style="width: 8%">Method</th>
1495 <th align="left">Description</th>
1496 </tr>
1497
1498 <tr valign="top">
1499 <td valign="top">dissolve</td>
1500 <td valign="top">Arguments:
1501 <em class="arg">src_percent</em>[x<em class="arg">dst_percent</em>]
1502 <br>Equivalent to "<code>composite</code>" <a href="#dissolve">-dissolve</a>
1503 <br>Dissolve the 'source' image by the percentage given before overlaying
1504 'over' the 'destination' image. If <em class="arg">src_percent</em> is
1505 greater than 100, it starts dissolving the main image so it will
1506 become transparent at a value of '<kbd class="arg">200</kbd>'. If
1507 both percentages are given, each image are dissolved to the
1508 percentages given.
1509 </td>
1510 </tr>
1511
1512 <tr valign="top">
1513 <td valign="top">blend</td>
1514 <td valign="top">Arguments:
1515 <em class="arg">src_percent</em>[x<em class="arg">dst_percent</em>]
1516 <br>Equivalent to "<code>composite</code>" <a href="#blend">-blend</a>
1517 <br>Average the images together ('plus') according to the percentages
1518 given and each pixels transparency. If only a single percentage value
1519 is given it sets the weight of the composite or 'source' image, while
1520 the background image is weighted by the exact opposite amount. That is
1521 a <kbd>-blend 30</kbd> merges 30% of the 'source' image with 70% of
1522 the 'destination' image. Thus it is equivalent to <kbd>-blend
1523 30x70</kbd>.
1524 </td>
1525 </tr>
1526
1527 <tr valign="top">
1528 <td valign="top">mathematics</td>
1529 <td valign="top">Arguments: <em class="arg">A, B, C, D</em>
1530 <br>Not available in "<code>composite</code>" at this time.
1531 <br>Merge the source and destination images according to the formula
1532 <br>&nbsp; &nbsp; &nbsp;<code>A*Sc*Dc + B*Sc + C*Dc + D</code>
1533 <br>Can be used to generate a custom composition method that would
1534 otherwise need to be implemented using the slow <a href="#fx">-fx</a>
1535 DIY image operator. Added to ImageMagick version 6.5.4-3.
1536 </td>
1537 </tr>
1538
1539 <tr valign="top">
1540 <td valign="top">modulate</td>
1541 <td valign="top">Arguments:
1542 <em class="arg">brightness</em>[x<em class="arg">saturation</em>]
1543 <br>Equivalent to "<code>composite</code>" <a href="#watermark">-watermark</a>
1544 <br>Take a grayscale image (with alpha mask) and modify the destination
1545 image's brightness according to watermark image's grayscale value and
1546 the <em class="arg">brightness</em> percentage. The destinations
1547 color saturation attribute is just direct modified by the <em
1548 class="arg">saturation</em> percentage, which defaults to 100 percent
1549 (no color change).
1550
1551 </td>
1552 </tr>
1553
1554 <tr valign="top">
1555 <td valign="top">displace</td>
1556 <td valign="top">Arguments:
1557 <em class="arg">X-scale</em>[x<em class="arg">Y-scale</em>][!][%]
1558 <br>Equivalent to "<code>composite</code>" <a href="#displace">-displace</a>
1559 <br>With this option, the 'overlay' image, and optionally the 'mask'
1560 image, is used as a relative displacement map, which is used to
1561 displace the lookup of what part of the destination image is seen at
1562 each point of the overlaid area. Much like the displacement map is a
1563 'lens' that distorts the original 'background' image behind it.
1564 <br><br>
1565 The X-scale is modilated by the 'red' channel of the overlay image
1566 while the Y-scale is modulated by the green channel, (the mask image
1567 if given is rolled into green channel of the overlay image. This
1568 separation allows you to modulate the X and Y lookup displacement
1569 separatally allowing you to di 2 dimentional displacements, rather
1570 than 1 dimentional verctored displacements (using grayscale image).
1571 <br><br>
1572 If the overlay image contains transparency this is used as a mask
1573 of the resulting image to remove 'invalid' pixels.
1574 <br><br>
1575 The '%' flag makes the displacement scale relative to the size of the
1576 overlay image (100% = half width/height of image). Using '!' switches
1577 percentage arguments to refer to the destination image size instead.
1578 <br><br>
1579 Special flags were added Added to ImageMagick version 6.5.3-5.
1580 </td>
1581 </tr>
1582
1583 <tr valign="top">
1584 <td valign="top">distort</td>
1585 <td valign="top">Arguments:
1586 <em class="arg">X-scale</em>[x<em class="arg">Y-scale</em
1587 >[+<em class="arg">X-center</em>+<em class="arg">Y-center</em>]][!][%]
1588 <br>Not available in "<code>composite</code>" at this time.
1589 <br>Exactly as per 'Displace' (above), but using absolute coordinates,
1590 relative to the center of the overlay (or that given). Basically
1591 allows you to generate absolute distortion maps where 'black' will
1592 look up the left/top edge, and 'white' looks up the bottom/right
1593 edge of the destination image, according to the scale given.
1594 <br><br>
1595 The '!' flag not only switches percentage scaling, to use the
1596 destination image, but also the image the center offset of the lookup.
1597 This means the overlay can lookup a completely different region of the
1598 destination image.
1599 <br><br>
1600 Added to ImageMagick version 6.5.3-5.
1601 </td>
1602 </tr>
1603
1604 <tr valign="top">
1605 <td valign="top">blur</td>
1606 <td valign="top">Arguments:
1607 <em class="arg">Width</em>[x<em class="arg">Height</em
1608 >[+<em class="arg">Angle</em>]]
1609 <br>Equivalent to "<code>composite</code>"
1610 <a href="#blur-composite">-blur</a>
1611 <br>A Variable Blur Mapping Composition method, where each pixel in the
1612 overlaid region is replaced with an Elliptical Weighted Average (EWA),
1613 with an ellipse (typically a circle) of the given sigma size, scaled
1614 according to overlay (source image) grayscale mapping.
1615 <br><br>
1616 As per 'Displace' and 'Distort', the red channel will modulate the
1617 width of the ellipse, while the green channel will modulate the height
1618 of the ellipse. However at this time the ellipse angle is not
1619 modulated though this may be a future posibility (perhaps with a
1620 special flag to enable use of blur channel for this purpose).
1621 <br><br>
1622 Added to ImageMagick version 6.5.4-0.
1623 </td>
1624 </tr>
1625
1626 </tbody>
1627</table>
1628
1629<p>To print a complete list of all the available compose operators, use <a href="#list">-list compose</a>.</p>
1630
1631
1632<div style="margin: auto;">
1633 <h4><a name="composite" id="composite"></a>-composite</h4>
1634</div>
1635
1636<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Perform alpha composition on the current image sequence.</td><td style='text-align:right;'></td></tr></table>
1637
1638<p>Take the first image 'destination' and overlay the second 'source' image
1639according to the current <a href="#compose">-compose</a> setting. The location
1640of the 'source' or 'overlay' image is controlled according to <a
1641href="#geometry" >-geometry</a>, and <a href="#geometry" >-geometry</a>
1642settings. </p>
1643
1644<p>If a third image is given this is treated as a gray-scale 'mask' image
1645relative to the first 'destination' image. This mask will limit what parts of
1646the destination can be modified by the image composition. However for the
1647'<kbd>displace</kbd>' compose method, the mask is used to provide a separate
1648Y-displacement image instead. </p>
1649
1650<p>If a <a href="#compose">-compose</a> method requires extra numerical
1651arguments or flags these can be provided by setting the <a
1652href="#set">-set</a> '<kbd class="arg">option:compose:args</kbd>'
1653appropriatally for the compose method. </p>
1654
1655<p>Some <a href="#compose">-compose</a> methods can modify the 'destination'
1656image outside the overlay area. You can disable this by setting the special <a
1657href="#set">-set</a> '<kbd class="arg">option:compose:outside-overlay</kbd>'
1658to '<kbd>false</kbd>'. </p>
1659
1660
1661<div style="margin: auto;">
1662 <h4><a name="compress" id="compress"></a>-compress <em class="arg">type</em></h4>
1663</div>
1664
1665<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>
1666
1667<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>
1668
1669<p>To print a complete list of compression types, use <a href="#list">-list compress</a>.</p>
1670
1671<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>
1672
1673<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>
1674
1675<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>
1676
1677<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>
1678
1679<div style="margin: auto;">
1680 <h4><a name="contrast" id="contrast"></a>-contrast</h4>
1681</div>
1682
1683<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>
1684
1685<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>
1686
1687<p>For a more pronounced effect you can repeat the option:</p>
1688
1689<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -contrast -contrast rose_c2.png</span></p>
1690<div style="margin: auto;">
1691 <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>
1692</div>
1693
1694<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>
1695
cristyd934d102009-10-10 12:55:13 +00001696<p>While performing the stretch, black-out at most <em
1697class="arg" >black-point</em> pixels and white-out at most <em
1698class="arg" >white-point</em> pixels. Or, if percent is used, black-out at most
1699<em class="arg" >black-point %</em> pixels and white-out at most <em
1700class="arg" >white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001701
cristyd934d102009-10-10 12:55:13 +00001702<p>Prior to ImageMagick 6.4.7-0, <a href="#contrast-stretch"
1703>-contrast-stretch</a> will black-out at most <em class="arg"
1704>black-point</em> pixels and white-out at most <em class="arg" >total pixels
1705minus white-point</em> pixels. Or, if percent is used, black-out at most <em
1706class="arg">black-point %</em> pixels and white-out at most <em class="arg"
1707>100% minus white-point %</em> pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00001708
cristyd934d102009-10-10 12:55:13 +00001709<p>Note that <kbd>-contrast-stretch 0</kbd> will modify the image such that
1710the image's min and max values are stretched to 0 and <em class="QR"
1711>QuantumRange</em>, respectively, without any loss of data due to burn-out or
1712clipping at either end. This is not the same as <a href="#normalize"
1713>-normalize</a>, which is equivalent to <kbd>-contrast-stretch 2%x1%</kbd> (or
1714prior to ImageMagick 6.4.7-0, <kbd>-contrast-stretch 2%x99%</kbd>).</p>
cristy3ed852e2009-09-05 21:47:34 +00001715
cristyd934d102009-10-10 12:55:13 +00001716<p>Internally operator works by creating a histogram bin, and then uses that
1717bin to modify the image. As such some colors may be merged together when they
1718originally fell into the same 'bin'. </p>
1719
1720<p>All the channels are normalized in concert by the came amount so as to
1721preserve color integrity, when the default <a href="#channel" >+channel</a>
1722setting is in use. Specifing any other <a href="#channel" >-channel</a>
1723setting will normalize the RGB channels independently.</p>
1724
1725<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
1726normalization of mathematical images. </p>
1727
1728<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00001729
1730
1731<div style="margin: auto;">
1732 <h4><a name="convolve" id="convolve"></a>-convolve <em class="arg">kernel</em></h4>
1733</div>
1734
1735<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>
1736
cristy16ff93c2010-01-13 23:18:07 +00001737<p>The <em class="arg">kernel</em> is a matrix specified as
cristyd934d102009-10-10 12:55:13 +00001738a comma-separated list of integers (with no spaces), ordered left-to right,
1739starting with the top row. Presently, only odd-dimensioned kernels are
1740supported, and therefore the number of entries in the specified <em
1741class="arg">kernel</em> must be 3<sup>2</sup>=9, 5<sup>2</sup>=25,
17427<sup>2</sup>=49, etc. </p>
cristy3ed852e2009-09-05 21:47:34 +00001743
cristyd934d102009-10-10 12:55:13 +00001744<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
1745positive and negative results are relative to a user-specified bias value.
1746This is important for non-HDRI compilations of ImageMagick when dealing with
1747convolutions that contain negative as well as positive values. This is
1748especially the case with convolutions involving high pass filters or edge
1749detection. Without an output bias, the negative values is clipped at zero.
cristy3ed852e2009-09-05 21:47:34 +00001750</p>
1751
cristyd934d102009-10-10 12:55:13 +00001752<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
1753negative results without clipping to the color value range (0..QuantumRange).
1754See the discussion on HDRI implementations of ImageMagick on the page <a
1755href="/www/high-dynamic-range.html">High
1756Dynamic-Range Images</a>. For more about HDRI go the ImageMagick <a
1757href="http://www.imagemagick.org/Usage/basics/#hdri">Usage</a> pages or this
1758<a href="http://en.wikipedia.org/wiki/High_dynamic_range_imaging">Wikipedia</a>
1759entry. </p>
cristy3ed852e2009-09-05 21:47:34 +00001760
cristy3ed852e2009-09-05 21:47:34 +00001761
1762<div style="margin: auto;">
1763 <h4><a name="crop" id="crop"></a>-crop <em class="arg">geometry</em></h4>
1764</div>
1765
1766<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>
1767
1768<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>
1769
1770<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>
1771
1772<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>
1773
1774<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>
1775
1776<p>By adding a exclamation character flag to the geometry argument, the
1777cropped images virtual canvas page size and offset is set as if the
1778geometry argument was a viewport or window. This means the canvas page size
1779is set to exactly the same size you specified, the image offset set
1780relative top left corner of the region cropped. </p>
1781
1782<p>If the cropped image 'missed' the actual image on its virtual canvas, a
1783special single pixel transparent 'missed' image is returned, and a 'crop
1784missed' warning given. </p>
1785
cristy739df912009-10-24 16:10:18 +00001786<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 +00001787
1788<div style="margin: auto;">
1789 <h4><a name="cycle" id="cycle"></a>-cycle <em class="arg">amount</em></h4>
1790</div>
1791
1792<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>
1793
1794<p><em class="arg">Amount</em> defines the number of positions each
1795colormap entry is shifted.</p>
1796
1797
1798<div style="margin: auto;">
1799 <h4><a name="debug" id="debug"></a>-debug <em class="arg">events</em></h4>
1800</div>
1801
1802<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>
1803
1804<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>
1805
1806
1807<p>For example, to log cache and blob events, use.</p>
1808
1809<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -debug "Cache,Blob" rose: rose.png</span></p>
1810<p>The <kbd>User</kbd> domain is normally empty, but developers can log user events in their private copy of ImageMagick.</p>
1811
1812<p>To print the complete list of debug methods, use <a href="#list">-list debug</a>.</p>
1813
1814<p>Use the <a href="#log">-log</a> option to specify the format for debugging output.</p>
1815
1816<p>Use <a href="#debug">+debug</a> to turn off all logging.</p>
1817
1818<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>
1819
1820
1821<div style="margin: auto;">
1822 <h4><a name="decipher" id="decipher"></a>-decipher <em class="arg">filename</em></h4>
1823</div>
1824
1825<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>
1826
1827<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
1828
1829<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
1830
1831
1832<div style="margin: auto;">
1833 <h4><a name="deconstruct" id="deconstruct"></a>-deconstruct</h4>
1834</div>
1835
1836<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>
1837
1838<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>
1839
1840<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>
1841
1842<p>This option is actually equivalent to the <a href="#layers">-layers</a> method '<kbd>compare-any</kbd>'. </p>
1843
1844
1845<div style="margin: auto;">
1846 <h4><a name="define" id="define"></a>-define <em class="arg">key</em>{<em class="arg">=value</em>}<em class="arg">...</em></h4>
1847</div>
1848
1849<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>add coder/decoder specific options.</td><td style='text-align:right;'></td></tr></table>
1850
1851<p>This option creates one or more definitions for coders and decoders to use while reading and writing image data. Definitions may be passed to coders and decoders to control options that are specific to certain image formats. If <em class="arg">value</em> is missing for a definition, an empty-valued definition of a flag is created with that name. This used to control on/off options. Use <a href="#define">+define key</a> to remove definitions previously created. Use <a href="#define">+define "*"</a> to remove all existing definitions.</p>
1852
1853<p>The following definitions may be created:</p>
1854
1855<ul>
cristy045bd902010-01-30 18:56:24 +00001856<dt>dcm:display-range=reset</dt>
1857 <dd>Set the display range to the minimum and maximum pixel values for the DCM image format.</dd><br />
1858<dt>dot:layout-engine=<em class="arg">value</em></dt>
1859 <dd>Set the specify the layout engine for the DOT image format (e.g. <kbd>neato</kbd>).</dd><br />
1860<dt>jpeg:extent=<em class="arg">value</em></dt>
cristy7396d882010-01-27 02:37:56 +00001861 <dd>Restrict the maximum JPEG file size, for example <kbd>-define jpeg:extent=400kb</kbd>.</dd><br />
cristy045bd902010-01-30 18:56:24 +00001862<dt>jpeg:size=<em class="arg">geometry</em></dt>
cristy48dd1af2009-10-02 01:21:56 +00001863 <dd>Set the size hint of a JPEG image, for example, -define jpeg:size=128x128. It is most useful for increasing performance and reducing the memory requirements when reducing the size of a large JPEG image.</dd><br />
cristy045bd902010-01-30 18:56:24 +00001864<dt>jp2:rate=<em class="arg">value</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00001865 <dd>Specify the compression factor to use while writing JPEG-2000 files. The compression factor is the reciprocal of the compression ratio. The valid range is 0.0 to 1.0, with 1.0 indicating lossless compression. If defined, this value overrides the -quality setting. A quality setting of 75 results in a rate value of 0.06641.</dd><br />
1866<dt>mng:need-cacheoff</dt>
1867 <dd>turn playback caching off for streaming MNG.</dd><br />
cristy045bd902010-01-30 18:56:24 +00001868<dt>png:bit-depth=<em class="arg">value</em></dt>
1869<dt>png:color-type=<em class="arg">value</em></dt>
cristy3ed852e2009-09-05 21:47:34 +00001870 <dd>desired bit-depth and color-type for PNG output. You can force the PNG encoder to use a different bit-depth and color-type than it would have normally selected, but only if this does not cause any loss of image quality. Any attempt to reduce image quality is treated as an error and no PNG file is written. E.g., if you have a 1-bit black-and-white image, you can use these "defines" to cause it to be written as an 8-bit grayscale, indexed, or even a 64-bit RGBA. But if you have a 16-million color image, you cannot force it to be written as a grayscale or indexed PNG. If you wish to do this, you must use the appropriate <a href="#depth">-depth</a>, <a href="#colors">-colors</a>, or <a href="#type">-type</a> directives to reduce the image quality prior to using the PNG encoder. Note that in indexed PNG files, "bit-depth" refers to the number of bits per index, which can range from 1 to 8. In such files, the color samples always have 8-bit depth.</dd><br />
1871<dt>ps:imagemask</dt>
cristy045bd902010-01-30 18:56:24 +00001872 <dd>If the ps:imagemask flag is defined, the PS3 and EPS3 coders will create Postscript files that render bilevel images with the Postscript imagemask operator instead of the image operator.</dd><br />
1873<dt>quantum:format=<em class="arg">type</em></dt>
1874 <dd>Set the type to <kbd>floating-point</kbd> to specify a single precision floating-point format for raw files (e.g. GRAY:).</dd>
cristy3ed852e2009-09-05 21:47:34 +00001875</ul>
1876
1877<p>For example, to create a postscript file that will render only the black pixels of a bilevel image, use:</p>
1878
1879<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bilevel.tif -define ps:imagemask eps3:stencil.ps</span></p>
1880<p>Set attributes of the image registry by prefixing the value with <kbd>registry:</kbd>. For example, to set a temporary path to put work files, use:</p>
1881
1882<p class="crtsnip">
1883-define registry:temporary-path=/data/tmp
1884</p>
1885
1886<div style="margin: auto;">
1887 <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>
1888</div>
1889
1890<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>
1891
1892<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>
1893
1894<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>
1895
1896
1897<div style="margin: auto;">
1898 <h4><a name="delete" id="delete"></a>-delete <em class="arg">index</em></h4>
1899</div>
1900
1901<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>
1902
1903<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>
1904
1905
1906<div style="margin: auto;">
1907 <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>
1908</div>
1909
1910<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>
1911
1912<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>
1913
1914<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>
1915
1916<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>
1917
1918<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>
1919
1920<div style="margin: auto;">
1921 <h4><a name="depth" id="depth"></a>-depth <em class="arg">value</em></h4>
1922</div>
1923
1924<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>
1925
1926<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>
1927
1928<div style="margin: auto;">
1929 <h4><a name="descend" id="descend"></a>-descend</h4>
1930</div>
1931
1932<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>
1933
1934<div style="margin: auto;">
1935 <h4><a name="deskew" id="deskew"></a>-deskew <em class="arg">threshold</em></h4>
1936</div>
1937
1938<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>
1939
1940<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>
1941
1942<div style="margin: auto;">
1943 <h4><a name="despeckle" id="despeckle"></a>-despeckle</h4>
1944</div>
1945
1946<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>
1947
1948<div style="margin: auto;">
1949 <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>
1950</div>
1951
1952<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>
1953
1954<p>With this option, the 'overlay' image, and optionally the 'mask' image,
1955will be used as a displacement map, which is used to displace the lookup of
1956what part of the 'background' image is seen at each point of the overlaid
1957area. Much like the displacement map is a 'lens' that redirects light shining
1958through it so as to present a distorted view the original 'background' image
1959behind it. </p>
1960
1961<p>Any perfect grey areas of the displacement map produce a zero
1962displacement of the image. Black areas produce the given maximum negative
1963displacement of the lookup point, while white produce a maximum positive
1964displacement of the lookup. </p>
1965
1966<p>Note that it is the lookup of the 'background' that is displaced, not a
1967displacement of the image itself. As such an area of the displacement map
1968containing 'white' will have the lookup point 'shifted' by a positive amount,
1969and thus generating a copy of the destination image to the right/downward from
1970the correct position. That is the image will look like it may have been
1971'shifted' in a negative left/upward direction. Understanding this is a very
1972important in understanding how displacement maps work. </p>
1973
1974<p>The given arguments define the maximum amount of displacement in pixels
1975that a particular map can produce. If the displacement scale is large enough
1976it is also posible to lookup parts of the 'background' image that lie well
1977outside the bounds of the displacement map itself. That is you could very
1978easilly copy a section of the original image from outside the overlay area
1979into the overlay area. </p>
1980
1981<p>The '%' flag makes the displacement scale relative to the size of the
1982overlay image (100% = half width/height of image). Using '!' switches
1983percentage arguments to refer to the destination image size instead.
1984these flags were added as of IM v6.5.3-5.</p>
1985
1986<p>Normally a single grayscale displacement map is provided, which with the
1987given scaling values will determine a single direction (vector) in which
1988displacements can occur (positivally or negativally). However, if you also
1989specify a third image which is normally used as a <em class="arg">mask</em>,
1990then the <em class="arg">composite image</em> will be used for horizontal X
1991displacement, while the <em class="arg">mask image</em> is used for vertical Y
1992displacement. This allows you to define completely different displacement
1993values for the X and Y directions, and allowing you to lookup any point within
1994the <em class="arg">scale</em> bounds. In other words each pixel can lookup
1995any other nearby pixel, producing complex 2 dimentional displacements, rather
1996than a simple 1 dimentional vector displacements. </p>
1997
1998<p>Alternativally rather than suppling two separate images, as of IM v6.4.4-0,
1999you can use the 'red' channel of the overlay image to specify the horizontal
2000or X displacement, and the 'green' channel for the vertical or Y displacement.
2001</p>
2002
2003<p>As of IM v6.5.3-5 any alpha channel in the overlay image will be used as a
2004mask the transparency of the destination image. However areas outside the
2005overlaid areas will not be effected. </p>
2006
2007
2008<div style="margin: auto;">
2009 <h4><a name="display" id="display"></a>-display <em class="arg">host:display[.screen]</em></h4>
2010</div>
2011
2012<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>
2013
2014<p>This option is used with convert for obtaining image or font from this X server. See <em class="arg">X(1)</em>.</p>
2015
2016<div style="margin: auto;">
2017 <h4><a name="dispose" id="dispose"></a>-dispose <em class="arg">method</em></h4>
2018</div>
2019
2020<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>
2021
2022<p>The layer disposal method defines the way each the displayed image is to be
2023modified after the current 'frame' of an animation has finished being
2024displayed (after its 'delay' period), but before the next frame on an
2025animation is to be overlaid onto the display. </p>
2026
2027<p>Here are the valid methods:</p>
2028
2029<pre class="text">
2030Undefined 0 No disposal specified (equivalent to '<kbd>none</kbd>').
2031None 1 Do not dispose, just overlay next frame image.
2032Background 2 Clear the frame area with the background color.
2033Previous 3 Clear to the image prior to this frames overlay.
2034</pre>
2035
2036<p>You can also use the numbers given above, which is what the GIF format
2037uses internally to represent the above settings. </p>
2038
2039<p>To print a complete list of dispose methods, use <a href="#list">-list dipose</a>.</p>
2040
2041<p>Use <a href="#dispose" >+dispose</a>, turn off the setting and prevent
2042resetting the layer disposal methods of images being read in. </p>
2043
2044<p>Use <a href="#set">-set</a> '<kbd>dispose</kbd>' method to set the image
2045disposal method for images already in memory.</p>
2046
2047<div style="margin: auto;">
2048 <h4><a name="dissimilarity-threshold" id="dissimilarity-threshold"></a>-dissimilarity-threshold <em class="arg">value</em></h4>
2049</div>
2050
2051<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>
2052
2053
2054<div style="margin: auto;">
2055 <h4><a name="dissolve" id="dissolve"></a>-dissolve <em class="arg">src_percent</em>[x<em class="arg">dst_percent</em>]</h4>
2056</div>
2057
2058<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>
2059
2060<p>The opacity of the composite image is multiplied by the given percent, then
2061it is composited 'over' the main image. If <em class="arg">src_percent</em>
2062is greater than 100, start dissolving the main image so it will become
2063transparent at a value of '<kbd class="arg">200</kbd>'. If both percentages
2064are given, each image are dissolved to the percentages given. </p>
2065
2066<p>Note that dissolve percentages do not add, two opaque images dissolved
2067'50,50', produce a 75% transparency. For a 50% + 50% blending of the two
2068images, you would need to use dissolve values of '50,100'. </p>
2069
2070<div style="margin: auto;">
2071 <h4><a name="distort" id="distort"></a>-distort <em class="arg">method arguments</em></h4>
2072</div>
2073
2074<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>
2075
2076<p>The <em class="arg">arguments</em> is a single string containing a list
2077of floating point numbers separated by commas or spaces. The number of
2078and meaning of the floating point values depends on the distortion <em
2079class="arg">method</em> being used. </p>
2080
2081<p>Choose from these distortion types:</p>
2082
2083<table class="doc">
2084 <tr valign="top">
2085 <th align="left" style="width: 8%">Method</th>
2086 <th align="left">Description</th>
2087 </tr>
2088
2089 <tr valign="top">
2090 <td valign="top"><kbd>ScaleRotateTranslate</kbd>&nbsp;&nbsp;
2091 <br/>or &nbsp; <kbd>SRT</kbd></td>
2092 <td valign="top">
2093 Distort image by first scaling and rotating about a given 'center',
2094 before translating that 'center' to the new location, in that order. It
2095 is an alternative method of specifying a '<kbd>Affine</kbd>' type of
2096 distortion, but without shearing effects. It also provides a good way
2097 of rotating and displacing a smaller image for tiling onto a larger
2098 background (IE 2-dimensional animations). <br/>
2099
2100 The number of arguments determine the specific meaning of each
2101 argument for the scales, rotation, and translation operations. <br/>
2102
2103 <table style="margin-left:auto; margin-right:auto;">
2104 <tr><td># &nbsp;</td><td>arguments meaning</td></tr>
2105 <tr><td>1:</td><td><em>Angle_of_Rotation</em></td></tr>
2106 <tr><td>2:</td><td><em>Scale &nbsp; Angle</em></td></tr>
2107 <tr><td>3:</td><td><em>ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2108 <tr><td>4:</td><td><em>X,Y &nbsp; Scale &nbsp; Angle</em></td></tr>
2109 <tr><td>5:</td>
2110 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle</em></td></tr>
2111 <tr><td>6:</td>
2112 <td><em>X,Y &nbsp; Scale &nbsp; Angle &nbsp; NewX,NewY</em></td></tr>
2113 <tr><td>7:</td>
2114 <td><em>X,Y &nbsp; ScaleX,ScaleY &nbsp; Angle
2115 &nbsp; NewX,NewY</em></td></tr>
2116 </table>
2117
2118 This is actually an alternative way of specifing a 2 dimensional linear
2119 '<kbd>Affine</kbd>' or '<kbd>AffineProjection</kbd>' distortion. </td> </tr>
2120
2121 <tr valign="top">
2122 <td valign="top"><kbd>Affine</kbd></td>
2123 <td valign="top">
2124 Distort the image linearly by moving a list of at least 3 or more sets
2125 of control points (as defined below). Idealy 3 sets or 12 floating
2126 point values are given allowing the image to be linearly scaled,
2127 rotated, sheared, and translated, according to those three points. See
2128 also the related '<kbd>AffineProjection</kbd>' and '<kbd>SRT</kbd>'
2129 distortions. <br/>
2130
2131 More than 3 sets given control point pairs (12 numbers) is least
2132 squares fitted to best match a lineary affine distortion. If only 2
2133 control point pairs (8 numbers) are given a two point image translation
2134 rotation and scaling is performed, without any posible shearing,
2135 flipping or changes in aspect ratio to the resulting image. If only one
2136 control point pair is provides the image is only translated, (which may
2137 be a floating point non-integer translation). <br/>
2138
2139 This distortion does not include any form of perspective distortion.
2140 </td>
2141
2142 </tr>
2143
2144 <tr valign="top">
2145 <td valign="top"><kbd>AffineProjection</kbd></td>
2146 <td valign="top">
2147 Linearly distort an image using the given Affine Matrix of 6
2148 pre-calculated coefficients forming a set of Affine Equations to map
2149 the source image to the destination image.
2150
2151 <div style="text-align: center"><em>
2152 s<sub>x</sub>, r<sub>x</sub>,
2153 r<sub>y</sub>, s<sub>y</sub>,
2154 t<sub>x</sub>, t<sub>y</sub>
2155 </em></div>
2156
2157 See <a href="#affine" >-affine</a> setting for more detail, and
2158 meanings of these coefficients. <br/>
2159
2160 The distortions '<kbd>Affine</kbd>' and '<kbd>SRT</kbd>' provide
2161 alternative methods of defining this distortion, with ImageMagick doing the
2162 calculations needed to generate the required coefficients. You can see
2163 the internally generated coefficients, by using a <a href="#verbose"
2164 >-verbose</a> setting. </td>
2165
2166 </tr>
2167
2168<!-- still under development, do not display - Anthony
2169 <tr valign="top">
2170 <td valign="top"><kbd>Bilinear</kbd></td>
2171 <td valign="top">
2172 Bilinear (reversed) Distortion, given a minimum of 4 sets of
2173 coordinate pairs, or 16 values (see below). Not that lines may not
2174 appear straight after distortion, though the distance between
2175 coordinates will remain consistant. </td>
2176 </tr>
2177-->
2178
2179 <tr valign="top">
2180 <td valign="top"><kbd>Perspective</kbd></td>
2181 <td valign="top">
2182 Perspective distort the images, using a list of 4 or more sets of
2183 control points (as defined below). More that 4 sets (16 numbers) of
2184 control points provide least squares fitting for more accurate
2185 distortions (for the purposes of image registration and panarama
2186 effects). Less than 4 sets will fall back to a '<kbd>Affine</kbd>'
2187 linear distortion. <br/>
2188
2189 Perspective Distorted images ensures that straight lines remain
2190 straight, but the scale of the distorted image will vary. The horizon
2191 is anti-aliased, and the 'sky' color may be set using the
2192 <a href="#mattecolor" >-mattecolor</a> setting. </td>
2193 </tr>
2194
2195 <tr valign="top">
2196 <td valign="top"><kbd>PerspectiveProjection</kbd>&nbsp;&nbsp;</td>
2197 <td valign="top">
2198 Do a '<kbd>Perspective</kbd>' distortion basied on a set of 8
2199 pre-calculated coefficients. You can get these coefficients by looking
2200 at the <a href="#verbose" >-verbose</a> output of a
2201 '<kbd>Prespective</kbd>' distortion, or by calculating them yourself.
2202 If the last two perspective scaling coefficients are zero, the
2203 remaining 6 represents a transposed 'Affine Matrix'. </td>
2204
2205 </tr>
2206
2207 <tr valign="top">
2208 <td valign="top"><kbd>Arc</kbd></td>
2209 <td valign="top">
2210 Arc the image (variation of polar mapping) over the angle given around
2211 a circle. <br/>
2212 <table width="90%" style = "margin-left: auto; margin-right: auto;">
2213 <tr valign="top"><td>Argument</td>
2214 <td>Meaning</td></tr>
2215 <tr valign="top"><td><em>arc_angle</em></td>
2216 <td>The angle over which to arc the image side-to-side</td></tr>
2217 <tr valign="top"><td><em>rotate_angle</em></td>
2218 <td>Angle to rotate resulting image from vertical center</td></tr>
2219 <tr valign="top"><td><em>top_radius</em></td>
2220 <td>Set top edge of source image at this radius</td></tr>
2221 <tr valign="top"><td><em>bottom_radius</em>&nbsp;</td>
2222 <td>Set bottom edge to this radius (radial scaling)</td></tr>
2223 </table>
2224
2225 The resulting image is always resized to best fit the resulting image,
2226 (as if using <a href="#distort" >+distort</a>) while attempting to
2227 preserve scale and aspect ratio of the original image as much as
2228 possible with the arguments given by the user. All four arguments will
2229 be needed to change the overall aspect ratio of an 'Arc'ed image. <br/>
2230
2231 This a variation of a polar distortion designed to try to preserve the
2232 aspect ratio of the image rather than direct Cartesian to Polar
2233 conversion. </td>
2234 </tr>
2235
2236 <tr valign="top">
2237 <td valign="top"><kbd>Polar</kbd></td>
2238 <td valign="top">
2239 Like '<kbd>Arc</kbd>' but do a complete Cartesian to Polar mapping of
2240 the image. that is the height of the input image is mapped to the
2241 radius limits, while the width is wrapped around between the
2242 angle limits. <br/>
2243
2244 Arguments: <em>Rmax,Rmin CenterX,CenterY, start,end_angle</em> <br/>
2245
2246 All arguments are optional. With <em>Rmin</em> defaulting to zero, the
2247 center to the center of the image, and the angles going from -180 (top)
2248 to +180 (top). If <em>Rmax</em> is given the special value of
2249 '<code>0</code>', the the distance from the center to the nearest edge
2250 is used for the radius of the output image, which will ensure the whole
2251 image is visible (though scaled smaller). However a special value of
2252 '<code>-1</code>' will use the distance from the center to the furthest
2253 corner, This may 'clip' the corners from the input rectangular image,
2254 but will generate the exact reverse of a '<kbd>DePolar</kbd>' with
2255 the same arguments. <br/>
2256
2257 If the plus form of distort (<a href="#distort" >+distort</a>) is used
2258 output image center will default to <code>0,0</code> of the virtual
2259 canvas, and the image size adjusted to ensure the whole input image is
2260 made visible in the output image on the virtual canvas. </td>
2261
2262 </tr>
2263
2264 <tr valign="top">
2265 <td valign="top"><kbd>DePolar</kbd></td>
2266 <td valign="top">
2267 Uses the same arguments and meanings as a '<kbd>Polar</kbd>' distortion
2268 but generates the reverse Polar to Cartesian distortion. <br/>
2269
2270 The special <em>Rmax</em> setting of '<code>0</code>' may however clip
2271 the corners of the input image. However using the special
2272 <em>Rmax</em> setting of '<code>-1</code>' (maximum center to corner
2273 distance) will ensure the whole distorted image is preserved in the
2274 generated result, so that the same argument to '<kbd>Polar</kbd>' will
2275 reverse the distortion re-producing the original.
2276
2277 Note that as this distortion requires the area resampling of a circular
2278 arc, which can not be handled by the builtin EWA resampling function.
2279 As such the normal EWA filters are turned off. It is recomended some
2280 form of 'super-sampling' image processing technique be used to produce
2281 a high quality result. </td>
2282
2283 </tr>
2284
2285 <tr valign="top">
2286 <td valign="top"><kbd>Barrel</kbd></td>
2287 <td valign="top">
2288 Given the four coefficients (A,B,C,D) as defined by <a
2289 href="http://www.all-in-one.ee/~dersch/barrel/barrel.html" >Helmut
2290 Dersch</a>, perform a barrell or pincussion distortion appropriate to
2291 correct radial lens distortions. That is in photographs, make straight
2292 lines straight again. <br/>
2293
2294 Arguments: <em>A &nbsp; B &nbsp; C</em> &nbsp; [ <em>D</em> &nbsp; [
2295 <em>X</em> , <em>Y</em> ] ] <br/>
2296 or <em>A<sub>x</sub> B<sub>x</sub> C<sub>x</sub> D<sub>x</sub> &nbsp;
2297 A<sub>y</sub> B<sub>y</sub> C<sub>y</sub> D<sub>y</sub></em> &nbsp;
2298 [ <em>X</em> , <em>Y</em> ] <br/>
2299 So that it forms the function <br/>
2300 Rsrc = r * ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2301 <em>C</em>*r + <em>D</em> )<br/>
2302
2303 Where <em>X</em>,<em>Y</em> is the optional center of the distortion
2304 (defaulting to the center of the image). <br/>
2305 The second form is typically used to distort images, rather than
2306 correct lens distortions. <br/>
2307 </td>
2308
2309 </tr>
2310
2311 <tr valign="top">
2312 <td valign="top"><kbd>BarrelInverse</kbd></td>
2313 <td valign="top">
2314 This is very simular to '<kbd>Barrel</kbd>' with the same set of
2315 arguments, and argument handling. However it uses the inverse
2316 of the radial polynomial,
2317 so that it forms the function <br/>
2318 Rsrc = r / ( <em>A</em>*r<sup>3</sup> + <em>B</em>*r<sup>2</sup> +
2319 <em>C</em>*r + <em>D</em> )
2320 </td>
2321 </tr>
2322
2323 <tr valign="top">
2324 <td valign="top"><kbd>Shepards</kbd></td>
2325 <td valign="top">
2326 Distort the given list control points (any number) using an Inverse
2327 Squared Distance Interpolation Method (<a
2328 href="http://www.ems-i.com/smshelp/Data_Module/Interpolation/Inverse_Distance_Weighted.htm"
2329 >Shepards Method</a>). The control points in effect do 'localized'
2330 distortions of the image around the given control point. For best
2331 results extra control points should be added to 'lock' the positions of
2332 the corners and other unchanging parts of the image. <br/>
2333
2334 The distortion has been likened to 'taffy pulling' using nails, pins or
2335 sticks. It basically uses the <a href="#sparse-color"
2336 >-sparse-color</a> method of the same name to generate separate X and Y
2337 displacement maps (see <a href="#displace" >-displace</a>) for source
2338 image color look-up. </td>
2339
2340 </tr>
2341
2342</table>
2343
2344<p>To print a complete list of distortion methods, use <a href="#list">-list distort</a>.</p>
2345
2346<p>Many of the above distortion methods such as '<kbd>Affine</kbd>',
2347'<kbd>Perspective</kbd>', and '<kbd>Shepards</kbd>' use a list control points
2348defining how these points in the given image should be distorted in the
2349destination image. Each set of four floating point values represent a source
2350image coordinate, followed immediately by the destination image coordinate.
2351This produces a list of values such as...</p>
2352<div style="text-align: center"><em>
2353 U<sub>1</sub>,V<sub>1</sub> X<sub>1</sub>,Y<sub>1</sub> &nbsp;
2354 U<sub>2</sub>,V<sub>2</sub> X<sub>2</sub>,Y<sub>2</sub> &nbsp;
2355 U<sub>3</sub>,V<sub>3</sub> X<sub>3</sub>,Y<sub>3</sub> &nbsp;
2356 ... &nbsp;
2357 U<sub>n</sub>,V<sub>n</sub> X<sub>n</sub>,Y<sub>n</sub> &nbsp;
2358</em></div>
2359<p>where <em>U,V</em> on the source image is mapped to <em>X,Y</em> on the
2360destination image. </p>
2361
2362<p>For example, to warp an image using '<kbd>perspective</kbd>' distortion,
2363needs a list of at least 4 sets of coordinates, or 16 numbers. Here is the
2364perspective distortion of the built-in "rose:" image. Note how spaces were
2365used to group the 4 sets of coordinate pairs, to make it easier to read and
2366understand.</p>
2367
2368<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>
2369 convert rose: -virtual-pixel black \ <br/>
2370 -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35' \ <br/>
2371 rose_3d_rotated.gif</span></p>
2372<p>If more that the required number of coordinate pairs are given for a
2373distortion, the distortion method is 'least squares' fitted to
2374produce the best result for all the coordinate pairs given. If less than the
2375ideal number of points are given, the distort will generally fall back to a
2376simpler form of distortion that can handles the smaller number of coordinates
2377(usally a linear '<kbd>Affine</kbd>' distortion). </p>
2378
2379<p>By using more coodinates you can make use of image registration tool to
2380find matching coordinate pairs in overlaping images, so as to improve the 'fit'
2381of the distortion. Of course a bad coordinate pair can also make the 'fit'
2382worse. Caution is always advised. </p>
2383
2384<p>Colors are acquired from the source image according to the <a
2385href="#interpolate" >-interpolate</a> color lookup setting, when the image is
2386magnified. However if the viewed image is minified (image becomes smaller), a
2387special area resampling function (added ImageMagick v6.3.5-9), is used to
2388produce a higher quality image. For example you can use a
2389'<kbd>perspective</kbd>' distortion to view a infinitely tiled 'plane' all the
2390way to the horizon. </p>
2391
2392<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -size 90x90 pattern:checkerboard -normalize -virtual-pixel tile \ <br/>
2393 -distort perspective '0,0,5,45 89,0,45,46 0,89,0,89 89,89,89,89' \ <br/>
2394 checks_tiled.jpg</span></p>
2395<p>Note that a infinitely tiled perspective images involving the horizon can
2396be very slow to generate due to the use of the high quality 'area resampling'
2397function (added ImageMagick v6.3.5-9). You can turn off 'area resampling'
2398using a <a href="#filter" >-filter</a> setting of '<kbd>point</kbd>'
2399(recommended if you plan to use super-sampling instead). </p>
2400
2401<p>If an image generates <i>invalid pixels</i>, such as the 'sky' in the last
2402'<kbd>perspective</kbd>' distortion example, <a href="#distort" >-distort</a>
2403will use the current <a href="#mattecolor" >-mattecolor</a> setting for these
2404pixels. If you do not what these pixels to be visible, set the color to match
2405the rest of the ground. </p>
2406
2407<p>The output image size will by default be the same as the input image. This
2408means that if the part of the distorted image falls outside the viewed area of
2409the 'distorted space', those parts is clipped and lost. However if you
2410use the plus form of the operator (<a href="#distort" >+distort</a>) the
2411operator will attempt (if posible) to show the whole of the distorted image,
2412while retaining a correct 'virtual canvas' offset, for image layering. This
2413offset may need to be removed using <a href="#repage" >+repage</a>, to remove
2414if it is unwanted. </p>
2415
2416<p>You can alternatively specify a special "<kbd><a href="#set" >-set</a>
2417option:distort:viewport {geometry_string}</kbd>" setting which will specify
2418the size and the offset of the generated 'viewport' image of the distorted
2419image space.</p>
2420
2421<p>Adding a "<kbd><a href="#set" >-set</a> option:distort:scale
2422{scale_factor}</kbd>" will scale the output image (viewport or otherwise) by
2423that factor without changing the viewed contents of the distorted image. This
2424can be used either for 'super-sampling' the image for a higher quality result,
2425or for panning and zooming around the image (with appropriate viewport
2426changes, or post-distort cropping and resizing). </p>
2427
2428<p>Setting <a href="#verbose" >-verbose</a> setting, will cause <a
2429href="#distort" >-distort</a> to attempt to output the internal coefficients,
2430and the <a href="#fx" >-fx</a> equivalent to the distortion, for expert study,
2431and debugging purposes. This many not be available for all distorts. </p>
2432
2433<p>Affine rotations and shears (such as '<kbd>SRT</kbd>' distortion), tend to
2434produce a cleaner result that the equivalent <a href="#rotate" >-rotate</a>
2435and/or <a href="#shear" >-shear</a> operation, with more control of due to the
2436above settings. It is algorithmically slower, though in ImageMagick it may be faster.
2437</p>
2438
2439
2440<div style="margin: auto;">
2441 <h4><a name="dither" id="dither"></a>-dither <em class="arg">method</em></h4>
2442</div>
2443
2444<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>
2445
2446<p>Dithering places two or more colors in neighbouring pixels so that to the eye a closer approximation of the images original color is reproduced. This reduces the number of colors needed to reproduce the image but at the cost of a lower level pattern of colors. Error diffusion dithers can use any set of colors (generated or user defined) to an image. </p>
2447
2448<p>Dithering is turned on by default, to turn it off use the plus form of the
2449setting, <a href="#dither">+dither</a>. This will also also render PostScript
2450without text or graphic aliasing. Disabling dithering often (but not always)
2451leads to faster process, a smaller number of colors, but more cartoon like
2452image coloring. Generally resulting in 'color banding' effects in areas with
2453color gradients. </p>
2454
2455<p>The color reduction operators <a href="#colors">-colors</a>, <a
2456href="#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>
2457
2458<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>
2459
2460
2461<div style="margin: auto;">
2462 <h4><a name="draw" id="draw"></a>-draw <em class="arg">string</em></h4>
2463</div>
2464
2465<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>
2466
2467<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>
2468
2469<p>The shape primitives:</p>
2470
2471<pre class="text">
2472 point x,y
2473 line x0,y0 x1,y1
2474 rectangle x0,y0 x1,y1
2475 roundRectangle x0,y0 x1,y1 wc,hc
2476 arc x0,y0 x1,y1 a0,a1
2477 ellipse x0,y0 rx,ry a0,a1
2478 circle x0,y0 x1,y1
2479 polyline x0,y0 ... xn,yn
2480 polygon x0,y0 ... xn,yn
2481 bezier x0,y0 ... xn,yn
2482 path path specification
2483 image operator x0,y0 w,h filename
2484</pre>
2485
2486<p>The text primitive:</p>
2487
2488<pre class="text">
2489 text x0,y0 string
2490</pre>
2491<p>The text gravity primitive:</p>
2492
2493<pre class="text">
2494 gravity NorthWest, North, NorthEast, West, Center,
2495 East, SouthWest, South, or SouthEast
2496</pre>
2497
2498<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>
2499
2500<p>The transformation primitives:</p>
2501
2502<pre class="text">
2503 rotate degrees
2504 translate dx,dy
2505 scale sx,sy
2506 skewX degrees
2507 skewY degrees
2508</pre>
2509
2510<p>The pixel operation primitives:</p>
2511
2512<pre class="text">
2513 color x0,y0 method
2514 matte x0,y0 method
2515</pre>
2516
2517<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>
2518
2519<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>
2520
2521<p>A <kbd>line</kbd> primitive requires a start point and end point.</p>
2522
2523<p>A <kbd>rectangle</kbd> primitive is specified by the pair of points at the upper left and lower right corners.</p>
2524
2525<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>
2526
2527<p>The <kbd>circle</kbd> primitive makes a disk (filled) or circle (unfilled). Give the center and any point on the perimeter (boundary).</p>
2528
2529<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>
2530
2531<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>
2532
2533<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>.
2534</p>
2535
2536<p>A <em>coordinate</em> is a pair of integers separated by a space or optional comma. </p>
2537
2538<p>As an example, to define a circle centered at 100,100 that extends to 150,150 use:</p>
2539
2540<p class="crtsnip">
2541 -draw 'circle 100,100 150,150'
2542</p>
2543
2544<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
2545draw 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>
2546
2547<p class="crtsnip">
2548 -draw 'bezier 20,50 45,100 45,0 70,50'
2549</p>
2550<p class="crtsnip">
2551 -draw 'bezier 70,50 95,100 95,0 120,50'
2552</p>
2553
2554
2555<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>
2556
2557<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>
2558
2559<p class="crtsnip">
2560 -draw 'image SrcOver 100,100 225,225 image.jpg'
2561</p>
2562
2563<p>You can use 0,0 for the image size, which means to use the actual dimensions found in the image header. Otherwise, it is scaled to the given dimensions. See <a href="#compose">-compose</a> for a description of the composite operators.</p>
2564
2565<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>
2566
2567<p>For example, the following annotates the image with <kbd>Works like magick!</kbd> for an image titled <kbd>bird.miff</kbd>. </p>
2568
2569<p class="crtsnip">
2570 -draw 'text 100,100 "Works like magick!"'
2571</p>
2572
2573<p>See the <a href="#annotate">-annotate</a> option for another convenient way to annotate an image with text.</p>
2574
2575<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>
2576
2577<p>The <kbd>translate</kbd> primitive translates subsequent shape and text primitives.</p>
2578
2579<p>The <kbd>scale</kbd> primitive scales them.</p>
2580
2581<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>
2582
2583<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
2584matrix.</p>
2585
2586<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>
2587
2588<pre class="text">
2589 point
2590 replace
2591 floodfill
2592 filltoborder
2593 reset
2594</pre>
2595
2596<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>
2597
2598<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>
2599
2600<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>
2601
2602<p>Strings that begin with a number must be quoted (e.g. use '1.png' rather than 1.png).</p>
2603
2604<p>Drawing primitives conform to the <a href="../www/magick-vector-graphics.html">Magick Vector Graphics</a> format.</p>
2605
2606
2607<div style="margin: auto;">
2608 <h4><a name="edge" id="edge"></a>-edge <em class="arg">radius</em></h4>
2609</div>
2610
2611<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>
2612
2613<div style="margin: auto;">
2614 <h4><a name="emboss" id="emboss"></a>-emboss <em class="arg">radius</em></h4>
2615</div>
2616
2617<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>
2618
2619<div style="margin: auto;">
2620 <h4><a name="encipher" id="encipher"></a>-encipher <em class="arg">filename</em></h4>
2621</div>
2622
2623<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>
2624
2625<p>Get the passphrase from the file specified by <em class="arg">filename</em>.</p>
2626
2627<p>For more information, see the webpage, <a href="http://www.imagemagick.org/www/cipher.html">ImageMagick: Encipher or Decipher an Image</a>.</p>
2628
2629<div style="margin: auto;">
2630 <h4><a name="encoding" id="encoding"></a>-encoding <em class="arg">type</em></h4>
2631</div>
2632
2633<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>
2634
2635<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>
2636
2637<div style="margin: auto;">
2638 <h4><a name="endian" id="endian"></a>-endian <em class="arg">type</em></h4>
2639</div>
2640
2641<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>
2642
2643<p>To print a complete list of endian types, use the <a href="#list">-list endian</a> option.</p>
2644
2645<p>Use <a href="#endian">+endian</a> to revert to unspecified endianness.</p>
2646
2647
2648<div style="margin: auto;">
2649 <h4><a name="enhance" id="enhance"></a>-enhance</h4>
2650</div>
2651
2652<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>
2653
2654
2655<div style="margin: auto;">
2656 <h4><a name="equalize" id="equalize"></a>-equalize</h4>
2657</div>
2658
2659<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>
2660
2661<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>
2662
2663<p>For example using HSL, we have: ... <kbd>-colorspace HSL -channel lightness -equalize -colorspace RGB</kbd> ...</p>
2664
2665<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>
2666
2667<div style="margin: auto;">
2668 <h4><a name="evaluate" id="evaluate"></a>-evaluate <em class="arg">operator value</em></h4>
2669</div>
2670
2671<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>
2672
2673<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>
2674
2675<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>
2676
2677<table class="doc">
2678 <col width="25%" />
2679 <col width="75%" />
2680 <thead>
2681 <tr>
2682 <th><em class="arg">operator</em></th>
2683 <th>Summary (see further below for details)</th>
2684 </tr>
2685 </thead>
2686 <tbody>
2687
2688 <tr><td>Add </td> <td>Add <em class="arg">value</em> to pixels. </td></tr>
2689 <tr><td>AddModulus </td> <td>Add <em class="arg">value</em> to pixels modulo <em class="QR">QuantumRange</em>.</td></tr>
2690 <tr><td>And </td> <td>Binary AND of pixels with <em class="arg">value</em>.</td></tr>
2691 <tr><td>Cos, Cosine </td> <td>Apply cosine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2692 <tr><td>Divide </td> <td>Divide pixels by <em class="arg">value</em>.</td></tr>
2693 <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>
2694 <tr><td>Log </td> <td>Apply scaled logarithm to normalized pixels.</td></tr>
2695 <tr><td>Max </td> <td>Clip pixels at lower bound <em class="arg">value</em>.</td></tr>
cristy63fed272010-03-07 19:08:45 +00002696 <tr><td>Mean </td> <td>Add the <em class="arg">value</em> and divide by 2.</td></tr>
cristy3ed852e2009-09-05 21:47:34 +00002697 <tr><td>Min </td> <td>Clip pixels at upper bound <em class="arg">value</em>.</td></tr>
2698 <tr><td>Multiply </td> <td>Multiply pixels by <em class="arg">value</em>.</td></tr>
2699 <tr><td>Or </td> <td>Binary OR of pixels with <em class="arg">value</em>.</td></tr>
2700 <tr><td>Pow </td> <td>Raise normalized pixels to the power <em class="arg">value</em>.</td></tr>
2701 <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>
2702 <tr><td>Set </td> <td>Set pixel equal to <em class="arg">value</em>.</td></tr>
2703 <tr><td>Sin, Sine </td> <td>Apply sine to pixels with frequency <em class="arg">value</em> with 50% bias added.</td></tr>
2704 <tr><td>Subtract </td> <td>Subtract <em class="arg">value</em> from pixels.</td></tr>
2705 <tr><td>Xor </td> <td>Binary XOR of pixels with <em class="arg">value.</em></td></tr>
2706
2707 <tr><td>&nbsp;</td></tr>
2708
2709 <tr><td>Gaussian-noise</td></tr>
2710 <tr><td>Impulse-noise</td></tr>
2711 <tr><td>Laplacian-noise</td></tr>
2712 <tr><td>Multiplicative-noise</td> <td>(These are equivalent to the corresponding <a href="#noise" >-noise</a> operators.)</td></tr>
2713 <tr><td>PoissonNoise</td></tr>
2714 <tr><td>Uniform-noise</td></tr>
2715
2716 <tr><td>&nbsp;</td></tr>
2717
2718 <tr><td>Threshold </td> <td>Threshold pixels larger than <em class="arg">value</em>.</td></tr>
2719 <tr><td>ThresholdBlack </td> <td>Threshold pixels to zero values equal to or below <em class="arg">value</em>.</td></tr>
2720 <tr><td>ThresholdWhite </td> <td>Threshold pixels to maximum values above <em class="arg">value</em>. </td></tr>
2721 </tbody>
2722 </table>
2723
2724<p>The specified functions are applied only to each previously set <a
2725href="#channel" >-channel</a> in the image. If necessary, the results of the
2726calculations are truncated (clipped) to fit in the interval [0,&nbsp;<em
2727class="QR">QuantumRange</em>]. The transparency channel of the image is
2728represented as a 'alpha' values (0 = fully transparent), so, for example, a
2729<kbd>Divide</kbd> by&nbsp;2 of the alpha channel will make the image
2730semi-transparent. Append the percent symbol '<kbd>%</kbd>' to specify a value
2731as a percentage of the <em class="QR">QuantumRange</em>.</p>
2732
2733<p>To print a complete list of <a href="#evaluate">-evaluate</a> operators, use
2734<a href="#list">-list evaluate</a>.</p>
2735
2736<p>The results of the <kbd>Add</kbd>, <kbd>Subtract</kbd> and
2737<kbd>Multiply</kbd> methods can also be achieved using either the <a
2738href="#level" >-level</a> or the <a href="#level" >+level</a> operator, with
2739appropriate argument, to linearly modify the overall range of color values.
2740Please note, however, that <a href="#level" >-level</a> treats transparency as
2741'matte' values (0 = opaque), while <a href="#level" >-evaluate</a> works with
2742'alpha' values.</p>
2743
2744<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>
2745
2746<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>
2747
2748 <div style="text-align:center;">
2749 log(<em class="arg">value</em> &times; <b><em>u</em></b> + 1) / log(<em class="arg">value</em> + 1)
2750 </div>
2751
2752<p><kbd>Pow</kbd> has been added as of ImageMagick 6.4.1-9, and works on
2753normalized pixel values. Note that <kbd>Pow</kbd> is related to the <a
2754href="#gamma" >-gamma</a> operator. For example, <b>-gamma 2</b> is equivalent
2755to <b>-evaluate pow 0.5</b>, i.e., a 'square root' function. The value used
2756with <a href="#gamma" >-gamma</a> is simply the reciprocal of the value used
2757with <kbd>Pow</kbd>.</p>
2758
2759<p><kbd>Cosine</kbd> and <kbd>Sine</kbd> was added as of IM v6.4.8-8 and
2760converts the image values into a value according to a (co)sine wave function.
2761The synonyms <kbd>Cos</kbd> and <kbd>Sin</kbd> may also be used. The output
2762is biased 50% and normalized by 50% so as to fit in the respective color value
2763range. The <em class="arg">value</em> scaling of the <em>period</em> of the
2764function (its frequency), and thus determines the number of 'waves' that will
2765be generated over the input color range. For example, if the <em
2766class="arg">value</em> is&nbsp;1, the effective period is simply the <em
2767class="QR">QuantumRange</em>; but if the <em class="arg">value</em> is&nbsp;2,
2768then the effective period is the <em>half</em> the <em
2769class="QR">QuantumRange</em>.
2770
2771 <div style="text-align:center;">
2772 0.5 + 0.5 &times; cos(2 &pi; <b><em>u</em></b> &times; <em class="arg">value</em>).
2773 </div>
2774
2775See also the <a href="#function" >-function</a> operator, which is a
2776multi-value version of evaluate. </P>
2777
cristy63fed272010-03-07 19:08:45 +00002778<div style="margin: auto;">
2779 <h4><a name="evaluate-sequence" id="evaluate-sequence"></a>-evaluate-sequence <em class="arg">operator</em></h4>
2780</div>
2781
2782<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 +00002783
2784<div style="margin: auto;">
2785 <h4><a name="extent" id="extent"></a>-extent <em class="arg">geometry</em></h4>
2786</div>
2787
2788<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>
2789
cristy3e2860c2010-01-24 01:36:30 +00002790<p>If the image is enlarged, unfilled areas are set to the background color. To position the image, use offsets in the <em class="arg">geometry</em> specification or precede with a <a href="#gravity">-gravity</a> setting. To specify how to compose the image with the background, use <a href="#compose" >-compose</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00002791
2792<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>
2793
2794<div style="margin: auto;">
2795 <h4><a name="extract" id="extract"></a>-extract <em class="arg">geometry</em></h4>
2796</div>
2797
2798<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>
2799
2800<p>This option is most useful for extracting a subregion of a very large raw image. Note that these two commands are equivalent:</p>
2801
cristy4949d522010-03-12 18:41:34 +00002802<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 +00002803
cristy4949d522010-03-12 18:41:34 +00002804<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -size 16000x16000 -depth 8 -extract 640x480 \ <br/> image.rgb image.png</span></p>
cristy3ed852e2009-09-05 21:47:34 +00002805<p>then the image will be <em>resized</em> to the specified dimensions instead,
2806equivalent to:</p>
2807
2808<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>
2809<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>
2810
2811<div style="margin: auto;">
2812 <h4><a name="family" id="family"></a>-family <em class="arg">fontFamily</em></h4>
2813</div>
2814
2815<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>
2816
2817<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).
2818</p>
2819
2820<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>.
2821</p>
2822
2823<div style="margin: auto;">
cristy7396d882010-01-27 02:37:56 +00002824 <h4><a name="features" id="features"></a>-features <em class="arg">distance</em></h4>
2825</div>
2826
2827<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>
2828
2829<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00002830 <h4><a name="fft" id="fft"></a>-fft</h4>
2831</div>
2832
2833<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>
2834
cristyb36feb22010-03-26 16:54:37 +00002835<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 +00002836
2837<p>A single image name is provided as output for this option. However, the output result will have two components. It will be either a two-frame image or two separate images, depending upon whether the image format specified supports multi-frame images. The reason that we get a dual output result is because the frequency domain represents an image using complex numbers, which cannot be visualized directly. Therefore, the complex values are automagically separated into a two-component image representation. The first component is the magnitude of the complex number and the second is the phase of the complex number. See for example, <a href="http://en.wikipedia.org/wiki/Complex_numbers" target="_blank">Complex Numbers</a>.<p>
2838
2839<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>
2840
2841<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.miff</span></p>
2842<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>
2843
2844<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -fft fft_image.png</span></p>
2845<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>
2846
2847<p>The input image can be any size, but if not square and even-dimensioned, it will be padded automagically to the larger of the width or height of the input image and to an even number of pixels. The padding will occur at the bottom and/or right sides of the input image. The resulting output magnitude and phase images will be square at this size. The kind of padding relies on the <a href="#virtual-pixel">-virtual-pixel</a> setting.</p>
2848
2849<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>
2850
2851<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff[0] -contrast-stretch 0 \ <br />
2852 -evaluate log 1000 fft_image_spectrum.png</span></p>
2853<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>
2854
2855<p>The <a href="http://www.fftw.org/" target="_blank">FFTW</a> delegate library is required to use <a href="#fft">-fft</a>.
2856
2857<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>
2858
2859<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>
2860
2861<p>The real and imaginary component images resulting from <a href="#fft">+fft</a> also will be square, even dimensioned images due to the same padding that was discussed above for the magnitude and phase component images.</a>
2862
2863<p>See the discussion on HDRI implementations of ImageMagick on the page
2864<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.
2865</p>
2866
2867
2868<div style="margin: auto;">
2869 <h4><a name="fill" id="fill"></a>-fill <em class="arg">color</em></h4>
2870</div>
2871
2872<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>
2873
2874<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>
2875
2876<p>Enclose the color specification in quotation marks to prevent the "#" or the parentheses from being interpreted by your shell.</p>
2877
2878<p>For example,</p>
2879
2880<p class="crtsnip">
2881 -fill blue
2882</p>
2883<p class="crtsnip">
2884 -fill "#ddddff"
2885</p>
2886<p class="crtsnip">
2887 -fill "rgb(255,255,255)"
2888</p>
2889
2890<p>See <a href="#draw">-draw</a> for further details.</p>
2891
2892<p>To print a complete list of color names, use the <a href="#list">-list color</a> option.</p>
2893
2894<div style="margin: auto;">
2895 <h4><a name="filter" id="filter"></a>-filter <em class="arg">type</em></h4>
2896</div>
2897
2898<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Use this <em class="arg">type</em> of filter when resizing an image.</td><td style='text-align:right;'></td></tr></table>
2899
2900<p>Use this option to affect the resizing operation of an image (see <a
2901href="#resize">-resize</a>). For example you can use a simple resize filter
2902such as:</p>
2903
2904<pre class="text">
2905 Point Hermite Cubic
2906 Box Gaussian Catrom
2907 Triangle Quadratic Mitchell
2908</pre>
2909
2910<p>The <kbd>Bessel</kbd> and <kbd>Sinc</kbd> filter is also provided, but are
2911by default <kbd>blackman</kbd>-windowed. However these filters define a
2912windowing filter for the Sinc or Bessel filter function, as appropriate for
2913the scaling operator used (usally Sinc for orthogonal <a href="#resize"
2914>-resize</a>). Windowed filters include: </p>
2915
2916<pre class="text">
2917 Lanczos Hamming Parzen
2918 Blackman Kaiser Welsh
2919 Hanning Bartlett Bohman
2920</pre>
2921
2922<p>Also one special self-windowing filter is also provided
2923<kbd>Lagrange</kbd>, which will automagically re-adjust its function depending
2924on the current 'support' or 'lobes' expert settings (see below).</p>
2925
2926<p>If you do not select a filter with this option, the filter defaults to <kbd>Mitchell</kbd> for a colormapped image, a image with a matte channel, or if the image is enlarged. Otherwise the filter default to <kbd>Lanczos</kbd>.</p>
2927
2928<p>To print a complete list of resize filters, use the <a href="#list">-list filter</a> option.</p>
2929
2930<p>You can modify how the filter behaves as it scales your image through the
2931use of these expert settings:</p>
2932
2933<dl class="doc">
2934<dt>-set filter:blur <em>factor</em></dt>
2935<dd>Scale the X axis of the filter (and its window). Use &gt; 1.0 for
2936 blurry or &lt; 1.0 for sharp.</dd>
2937
2938<dt>-set filter:support <em>radius</em></dt>
2939<dd>Set the filter support radius.</dd>
2940
2941<dt>-set filter:lobes <em>count</em></dt>
2942<dd>Set the number of lobes to use for the Sinc/Bessel filter. This an
2943 alternative way of specifying the 'support' range of the filter.</dd>
2944
2945<dt>-set filter:b <em>b-spline_factor</em></dt>
2946<dt>-set filter:c <em>keys_alpha_factor</em></dt>
2947<dd>Redefine the values used for cubic filters such as <kbd>Cubic</kbd>,
2948 <kbd>Catrom</kbd>, <kbd>Mitchel</kbd>, and <kbd>Hermite</kbd>, as well as
2949 the <kbd>Parzen</kbd> Sinc windowing function. If only one of the values
2950 are defined, the other is set so as to generate a 'Keys' type cubic
2951 filter.
2952
2953<dt>-set filter:filter <em>filter</em></dt>
2954<dd>Use this function directly as the scaling filter. This will allow
2955 you to directly use a 'windowing filter' such as <kbd>blackman</kbd>,
2956 rather than as its normal usage as a windowing function for 'Sinc' or
2957 'Bessel'. If defined, no windowing function is used, unless the following
2958 expert setting is also defined.</dd>
2959
2960<dt>-set filter:window <em>filter</em></dt>
2961<dd>The IIR (infinite impulse response) filters <kbd>bessel</kbd> and
2962 <kbd>sinc</kbd> are windowed (brought down to zero over the defined
2963 support range) with the given filter. This allows you to use a filter that
2964 is not normally used as a windowing function, such as <kbd>box</kbd>,
2965 (which effectivally turns off the windowing function). </dd>
2966
2967</dl>
2968
2969<p>For example, to get a 8 lobe Lanczos-Bessel filter:</p>
2970
2971<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -filter bessel \ <br/>
2972 -set filter:window=bessel -set filter:lobes=8 \ <br/>
2973 -resize 150% image.jpg</span></p>
2974<p>Or a raw un-windowed Sinc filter with 4 lobes:</p>
2975
2976<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png -set filter:filter=sinc -set filter:lobes=4 \ <br/>
2977 -resize 150% image.jpg</span></p>
2978<p>Note that the use of expert options (except for 'blur' with simple resize
2979filters), are provided for image processing experts who have studied and
2980understood how resize filters work. Without this knowledge, and an
2981understanding of the defination of the actual filters involved, using expert
2982settings are more likely to be detremental to your image resizing.</p>
2983
2984
2985<div style="margin: auto;">
2986 <h4><a name="flatten" id="flatten"></a>-flatten</h4>
2987</div>
2988
2989<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>
2990
2991
2992<div style="margin: auto;">
2993 <h4><a name="flip" id="flip"></a>-flip</h4>
2994</div>
2995
2996<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>
2997
2998<p>reflect the scanlines in the vertical direction.</p>
2999
3000<div style="margin: auto;">
3001 <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>
3002</div>
3003
3004<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>
3005
3006<div style="margin: auto;">
3007 <h4><a name="flop" id="flop"></a>-flop</h4>
3008</div>
3009
3010<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>
3011
3012<p>reflect the scanlines in the horizontal direction.</p>
3013
3014
3015<div style="margin: auto;">
3016 <h4><a name="font" id="font"></a>-font <em class="arg">name</em></h4>
3017</div>
3018
3019<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>
3020
3021<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>
3022
3023<p>In addition to the fonts specified by the above pre-defined list, you can
3024also specify a font from a specific source. For example <kbd>Arial.ttf</kbd>
3025is a TrueType font file, <kbd>ps:helvetica</kbd> is PostScript font, and
3026<kbd>x:fixed</kbd> is X11 font.</p>
3027
3028<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>
3029
3030
3031<div style="margin: auto;">
3032 <h4><a name="foreground" id="foreground"></a>-foreground <em class="arg">color</em></h4>
3033</div>
3034
3035<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>
3036
3037<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
3038
3039<p>The default foreground color is black.</p>
3040
3041<div style="margin: auto;">
3042 <h4><a name="format" id="format"></a>-format <em class="arg">type</em></h4>
3043</div>
3044
3045<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>
3046
3047<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>
3048
3049<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>
3050
3051<div style="margin: auto;">
3052 <h4><a name="format_identify_" id="format_identify_"></a>-format <em class="arg">string</em></h4>
3053</div>
3054
3055<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>
3056
3057<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>
3058
3059<div style="margin: auto;">
3060 <h4><a name="frame" id="frame"></a>-frame <em class="arg">geometry</em></h4>
3061</div>
3062
3063<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>
3064
3065<p>The color of the border is specified with the <a href="#mattecolor">-mattecolor</a> command line option. </p>
3066
3067<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <em class="arg">size</em> portion of the <em class="arg">geometry</em> argument indicates the amount of extra width and height that is added to the dimensions of the image. If no offsets are given in the <em class="arg">geometry</em> argument, then the border added is a solid color. Offsets <em>x</em> and <em>y</em>, if present, specify that the width and height of the border is partitioned to form an outer bevel of thickness <em>x</em>&nbsp;pixels and an inner bevel of thickness <em>y</em>&nbsp;pixels. (Negative offsets make no sense here.) The <a href="#frame">-frame</a> option is not affected by the <a href="#gravity">-gravity</a> option.</p>
3068
3069
3070<div style="margin: auto;">
3071 <h4><a name="frame_import_" id="frame_import_"></a>-frame</h4>
3072</div>
3073
3074<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>include the X window frame in the imported image.</td><td style='text-align:right;'>[<a href="../www/import.html">import</a>]</td></tr></table>
3075
3076<div style="margin: auto;">
3077 <h4><a name="function" id="function"></a>-function <em class="arg">function</em> <em class="arg">parameters</em></h4>
3078</div>
3079
3080<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Apply a function to channel values.</td><td style='text-align:right;'></td></tr></table>
3081
3082<p>This operator performs calculations based on the given arguments to modify each of the color values for each previously set <a href="#channel">-channel</a> in the image. See <a href="#evaluate">-evaluate</a> for details concerning how the results of the calculations are handled.</p>
3083
3084<p>This is can be considered a multi-argument version of the <a href="#evaluate">-evaluate</a> operator. (Added in ImageMagick&nbsp;6.4.8&minus;8.)</p>
3085
3086<p>Here, <em class="arg">parameters</em> is a comma-separated list of numerical values. The number of values varies depending on which <em class="arg">function</em> is selected. Choose the <em class="arg">function</em> from:</p>
3087
3088<pre class="text">
3089 Polynomial
3090 Sinusoid
3091 Arcsin
3092 Arctan
3093</pre>
3094
3095<p>To print a complete list of <a href="#function">-function</a> operators, use <a href="#list">-list function</a>. Descriptions follow.</p>
3096
3097<dl class="doc">
3098<dt><kbd>Polynomial</kbd></dt>
3099<dd>
3100<p>The <kbd>Polynomial</kbd> function takes an arbitrary number of parameters, these being the coefficients of a polynomial, in decreasing order of degree. That is, entering</p>
3101
3102<div style="text-align: center">
3103 -function Polynomial <em>a</em><sub><em>n</em></sub>,<em>a</em><sub><em>n</em>-1</sub>,...<em>a</em><sub>1</sub>,<em>a</em><sub>0</sub>
3104</div>
3105
3106<p>will invoke a polynomial function given by</p>
3107
3108<div style="text-align: center">
3109 <em>a</em><sub><em>n</em></sub> <b><em>u</em></b><sup><em>n</em></sup> +
3110 <em>a</em><sub><em>n</em>-1</sub> <b><em>u</em></b><sup><em>n</em>-1</sup> +
3111 &middot;&middot;&middot; <em>a</em><sub>1</sub> <b><em>u</em></b> + <em>a</em><sub>0</sub>,
3112</div>
3113
3114<p>where <b><em>u</em></b> is pixel's original normalized channel value.</p>
3115
3116<p>The <kbd>Polynomial</kbd> function can be used in place of <kbd>Set</kbd> (the <em>constant</em> polynomial) and <kbd>Add</kbd>, <kbd>Divide</kbd>, <kbd>Multiply</kbd>, and <kbd>Subtract</kbd> (some <em>linear</em> polynomials) of the <a href="#evaluate">-evaluate</a> operator. The <a href="#level">-level</a> operator also affects channels linearly. Some correspondences follow.</p>
3117
3118<table class="doc">
3119 <col width="35%" />
3120 <col width="35%" />
3121 <col width="30%" />
3122 <tr>
3123 <td>-evaluate Set <em class="arg">value</em> </td>
3124 <td>-function Polynomial <em class="arg">value</em></td>
3125 <td>(Constant functions; set <em class="arg">value</em>&times;100% gray when channels are RGB.)</td>
3126 </tr>
3127 <tr>
3128 <td>-evaluate Add <em class="arg">value</em> </td>
3129 <td>-function Polynomial 1,<em class="arg">value</em></td>
3130 </tr>
3131 <tr>
3132 <td>-evaluate Subtract <em class="arg">value</em> </td>
3133 <td>-function Polynomial 1,&minus;<em class="arg">value</em></td>
3134 </tr>
3135 <tr>
3136 <td>-evaluate Multiply <em class="arg">value</em> </td>
3137 <td>-function Polynomial <em class="arg">value</em>,0</td>
3138 </tr>
3139 <tr>
3140 <td>+level black% x white%</td>
3141 <td>-function Polynomial A,B</td>
3142 <td>(Reduce contrast. Here, A=(white-black)/100 and B=black/100.)</td>
3143 </tr>
3144</table>
3145
3146<p>The <kbd>Polynomial</kbd> function gives great versatility, since polynomials can be used to fit any continuous curve to any degree of accuracy desired.</p>
3147</dd>
3148
3149<dt><kbd>Sinusoid</kbd></dt>
3150<dd>
3151<p>The <kbd>Sinusoid</kbd> function can be used to vary the channel values sinusoidally by setting frequency, phase shift, amplitude, and a bias. These values are given as one to four parameters, as follows,</p>
3152
3153<div style="text-align: center">
3154 -function <kbd>Sinusoid</kbd> <em class="arg">freq</em>,[<em class="arg">phase</em>,[<em class="arg">amp</em>,[<em class="arg">bias</em>]]]
3155</div>
3156
3157<p>where <em>phase</em> is in degrees. (The domain [0,1] of the function corresponds to 0 through <em class="arg">freq</em>&times;360&nbsp;degrees.) The result is that if a pixel's normalized channel value is originally <b><em>u</em></b>, its resulting normalized value is given by </p>
3158
3159<div style="text-align: center">
3160<em class="arg">amp</em> * sin(2*&pi;* (<em class="arg">freq</em> * <b><em>u</em></b> + <em class="arg">phase</em> / 360)) + <em class="arg">bias</em>
3161</div>
3162
3163<p> For example, the following generates a curve that starts and ends at 0.9 (when <b><em>u</em></b>=0 and 1, resp.), oscillating three times between .7&minus;.2=.5 and .7+.2=.9. </p>
3164
3165<p class="crtsnip">
3166 -function Sinusoid 3,-90,.2,.7
3167</p>
3168
3169<p>The default values of <em class="arg">amp</em> and <em class="arg">bias</em> are both .5. The default for <em class="arg">phase</em> is 0.</p>
3170
3171<p>The <kbd>Sinusoid</kbd> function generalizes <kbd>Sin</kbd> and <kbd>Cos</kbd> of the <a href="#evaluate">-evaluate</a> operator by allowing varying amplitude, phase and bias. The correspondence is as follows.</p>
3172
3173<table class="doc">
3174 <tr>
3175 <td>-evaluate Sin <em class="arg">freq</em> </td>
3176 <td>-function Sinusoid <em class="arg">freq</em>,0 </td>
3177 </tr>
3178 <tr>
3179 <td>-evaluate Cos <em class="arg">freq</em> </td>
3180 <td>-function Sinusoid <em class="arg">freq</em>,90 </td>
3181 </tr>
3182</table>
3183</dd>
3184
3185<dt><kbd>ArcSin</kbd></dt>
3186<dd>
3187<p>The <kbd>ArcSin</kbd> function generates the inverse curve of a Sinusoid,
3188and can be used to generate cylindrical distortion and displacement maps.
3189The curve can be adjusted relative to both the input values and output range
3190of values.
3191
3192<div style="text-align: center">
3193 -function <kbd>ArcSin</kbd> <em class="arg">width</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
3194</div>
3195
3196<p>with all values given in terms of noramlize color values (0.0 for black,
31971.0 for white). Defaulting to values covering the full range from 0.0 to 1.0
3198for bout input (<em class="arg">width</em>), and output (<em
3199class="arg">width</em>) values. '<code>1.0,0.5,1.0,0.5</code>' </p>
3200
3201<div style="text-align: center">
3202<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>
3203</div>
3204
3205</dd>
3206
3207<dt><kbd>ArcTan</kbd></dt>
3208<dd>
3209<p>The <kbd>ArcTan</kbd> function generates a curve that smooth crosses from
3210limit values at infinities, though a center using the given slope value.
3211All these values can be adjusted via the arguments.
3212
3213<div style="text-align: center">
3214 -function <kbd>ArcTan</kbd> <em class="arg">slope</em>,[<em class="arg">center</em>,[<em class="arg">range</em>,[<em class="arg">bias</em>]]]
3215</div>
3216
3217<p>Defaulting to '<code>1.0,0.5,1.0,0.5</code>'.
3218</p>
3219
3220<div style="text-align: center">
3221<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>
3222</div>
3223
3224</dd>
3225
3226</dl>
3227
3228
3229<div style="margin: auto;">
3230 <h4><a name="fuzz" id="fuzz"></a>-fuzz <em class="arg">distance</em>{<em class="arg">%</em>}</h4>
3231</div>
3232
3233<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Colors within this <em class="arg">distance</em> are considered equal.</td><td style='text-align:right;'></td></tr></table>
3234
3235<p>A number of algorithms search for a target color. By default the color must be exact. Use this option to match colors that are close to the target color in RGB space. For example, if you want to automagically trim the edges of an image with <a href="#trim">-trim</a> but the image was scanned and the target background color may differ by a small amount. This option can account for these differences.</p>
3236
3237<p>The <em class="arg">distance</em> can be in absolute intensity units or, by appending <kbd>%</kbd> as a percentage of the maximum possible intensity (255, 65535, or 4294967295).</p>
3238
3239
3240<div style="margin: auto;">
3241 <h4><a name="fx" id="fx"></a>-fx <em class="arg">expression</em></h4>
3242</div>
3243
3244<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>apply a mathematical expression to an image or image channels.</td><td style='text-align:right;'></td></tr></table>
3245
3246<p>If the first character of <em class="arg">expression</em> is <kbd>@</kbd>, the expression is read from a file titled by the remaining characters in the string.</p>
3247
3248<p>See <a href="../www/fx.html">FX, The Special Effects Image Operator</a> for a detailed discussion of this option.</p>
3249
3250
3251<div style="margin: auto;">
3252 <h4><a name="gamma" id="gamma"></a>-gamma <em class="arg">value</em></h4>
3253</div>
3254
3255<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>level of gamma correction.</td><td style='text-align:right;'></td></tr></table>
3256
3257<p>The same color image displayed on two different workstations may look different due to differences in the display monitor. Use gamma correction to adjust for this color difference. Reasonable values extend from <kbd>0.8</kbd> to <kbd>2.3</kbd>. Gamma less than 1.0 darkens the image and gamma greater than 1.0 lightens it. Large adjustments to image gamma may result in the loss of some image information if the pixel quantum size is only eight bits (quantum range 0 to 255).</p>
3258
3259<p>Gamma adjusts the image's channel values pixel-by-pixel according to a power law, namely, pow(pixel,1/gamma) or pixel^(1/gamma), where pixel is the normalized or 0 to 1 color value. For example, using a value of gamma=2 is the same as taking the square root of the image.</p>
3260
3261<p>You can apply separate gamma values to the red, green, and blue channels of the image with a gamma value list delimited with commas (e.g., <kbd>1.7,2.3,1.2</kbd>).</p>
3262
3263<p>Use <a href="#gamma">+gamma <em class="arg">value</em></a> to set the image gamma level without actually adjusting the image pixels. This option is useful if the image is of a known gamma but not set as an image attribute (e.g. PNG images).</p>
3264
3265<p>Note that gamma adjustments are also available via the <a href="#level">-level</a> operator.</p>
3266
3267<div style="margin: auto;">
3268 <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>
3269</div>
3270
3271<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Blur the image with a Gaussian operator.</td><td style='text-align:right;'></td></tr></table>
3272
3273<p>Convolve the image with a Gaussian or normal distribution. The formula is:</p>
3274
3275<div class="eqn"><img alt="gaussian distribution" width="243px" height="42px" src="../images/gaussian-blur.png"/>
3276</div>
3277
3278<p>where <i>r</i> is the blur radius (<i>r</i><sup>2</sup> = <i>u</i><sup>2</sup> + <i>v</i><sup>2</sup>), and &sigma; is the standard deviation of the Gaussian distribution. As a guideline, set <i>r</i> to approximately 3&sigma;. Specify a radius of 0 and ImageMagick selects a suitable radius for you.</p>
3279
3280<p>This differs from the faster <a href="#blur">-blur</a> operator in that a
3281full 2-dimentional convolution is used to generate the weighted average of the
3282neighbouring pixels. </p>
3283
3284<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
3285pixels which are outside the image proper are blurred into the final result.
3286</p>
3287
3288
3289<div style="margin: auto;">
3290 <h4><a name="geometry" id="geometry"></a>-geometry <em class="arg">geometry</em></h4>
3291</div>
3292
3293<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>
3294
3295<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>
3296
3297<div style="margin: auto;">
3298 <h4><a name="gravity" id="gravity"></a>-gravity <em class="arg">type</em></h4>
3299</div>
3300
3301<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>
3302
3303<p>Choices include: <kbd>NorthWest</kbd>, <kbd>North</kbd>, <kbd>NorthEast</kbd>,
3304<kbd>West</kbd>, <kbd>Center</kbd>, <kbd>East</kbd>, <kbd>SouthWest</kbd>,
3305<kbd>South</kbd>, <kbd>SouthEast</kbd>. Use <a href="#list">-list gravity</a> to get a complete
3306list of <a href="#gravity">-gravity</a> settings available in your ImageMagick
3307installation.</p>
3308
3309<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>
3310
3311<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>
3312
3313<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>
3314
cristy4949d522010-03-12 18:41:34 +00003315<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 +00003316<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>
3317
3318<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>
3319
3320
3321<div style="margin: auto;">
3322 <h4><a name="green-primary" id="green-primary"></a>-green-primary <em class="arg">x,y</em></h4>
3323</div>
3324
3325<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>
3326
3327
3328<div style="margin: auto;">
3329 <h4><a name="hald-clut" id="hald-clut"></a>-hald-clut</h4>
3330</div>
3331
3332<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>
3333
3334<p>A Hald color lookup table is a 3-dimensional color cube mapped to 2
3335dimensions. Create it with the <kbd>HALD:</kbd> prefix (e.g. HALD:8). You
3336can apply any color transformation to the Hald image and then use this option
3337to apply the transform to the image. </p>
3338
3339<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png hald.png -hald-clut transform.png</span></p>
3340<p>This option provides a convenient method for you to use Gimp or Photoshop
3341to make color corrections to the Hald CLUT image and subsequently apply them
3342to multiple images using an ImageMagick script. </p>
3343
3344<p>Note that the representation is only of the normal RGB color space and that
3345the whole color value triplet is used for the interpolated lookup of the
3346represented Hald color cube image. Because of this the operation is not <a
3347href="#channel" >-channel</a> setting effected, nor can it adjust or modify an
3348images transparency or alpha/matte channel.</p>
3349
3350<p>See also <a href="#clut" >-clut</a> which provides color value replacement
3351of the individual color channels, usally involving a simplier gray-scale
3352image. E.g: gray-scale to color replacement, or modification by a histogram
3353mapping. </p>
3354
3355
3356<div style="margin: auto;">
3357 <h4><a name="help" id="help"></a>-help</h4>
3358</div>
3359
3360<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>
3361
3362<div style="margin: auto;">
3363 <h4><a name="highlight-color" id="highlight-color"></a>-highlight-color <em class="arg">color</em></h4>
3364</div>
3365
3366<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>
3367
3368<div style="margin: auto;">
3369 <h4><a name="iconGeometry" id="iconGeometry"></a>-iconGeometry <em class="arg">geometry</em></h4>
3370</div>
3371
3372<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>
3373
3374<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>
3375
3376<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>
3377
3378<div style="margin: auto;">
3379 <h4><a name="iconic" id="iconic"></a>-iconic</h4>
3380</div>
3381
3382<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>
3383
3384<div style="margin: auto;">
3385 <h4><a name="identify" id="identify"></a>-identify</h4>
3386</div>
3387
3388<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>
3389
3390<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>
3391
3392<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>
3393
3394<p>If <a href="#verbose">-verbose</a> preceds this option, copious
3395amounts of image properties are displayed including image statistics, profiles,
3396image histogram, and others.</p>
3397
3398<div style="margin: auto;">
3399 <h4><a name="ift" id="ift"></a>-ift</h4>
3400</div>
3401
3402<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>
3403
cristyb36feb22010-03-26 16:54:37 +00003404<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 +00003405
3406<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>
3407
3408<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert fft_image.miff -ift fft_image_ift.png</span></p>
3409<p>or</p>
3410
3411<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>
3412
3413<p>The resulting image may need to be cropped due to padding introduced when the original image, prior to the <a href="#fft">-fft</a> or <a href="#fft">+fft</a>, was not square or even dimensioned. Any padding will be at the right and/or bottom sides of the image.
3414
3415<p>The <a href="http://www.fftw.org/" target="_blank">FFTW</a> delegate library is required to use <a href="#ift">-ift</a>.
3416
3417<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.
3418
3419<div style="margin: auto;">
3420 <h4><a name="immutable" id="immutable"></a>-immutable</h4>
3421</div>
3422
3423<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>
3424
3425<div style="margin: auto;">
3426 <h4><a name="implode" id="implode"></a>-implode <em class="arg">factor</em></h4>
3427</div>
3428
3429<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>
3430
3431<div style="margin: auto;">
3432 <h4><a name="insert" id="insert"></a>-insert <em class="arg">index</em></h4>
3433</div>
3434
3435<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>
3436
3437<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>
3438
3439<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>
3440
3441<div style="margin: auto;">
3442 <h4><a name="intent" id="intent"></a>-intent <em class="arg">type</em></h4>
3443</div>
3444
3445<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>
3446
3447<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>
3448
3449<p>The default intent is undefined.</p>
3450
3451<p>To print a complete list of rendering intents, use <a href="#list">-list intent</a>.</p>
3452
3453<div style="margin: auto;">
3454 <h4><a name="interlace" id="interlace"></a>-interlace <em class="arg">type</em></h4>
3455</div>
3456
3457<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>
3458
3459<p>Choose from:</p>
3460
3461<pre class="text">
3462 none
3463 line
3464 plane
3465 partition
3466 JPEG
3467 GIF
3468 PNG
3469</pre>
3470
3471<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>
3472
3473<p><kbd>None</kbd> means do not interlace (RGBRGBRGBRGBRGBRGB...),</p>
3474
3475<p><kbd>Line</kbd> uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...), and.</p>
3476
3477<p><kbd>Plane</kbd> uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).</p>
3478
3479<p><kbd>Partition</kbd> is like plane except the different planes are saved to individual files (e.g. image.R,
3480image.G, and image.B).</p>
3481
3482<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>
3483image.</p>
3484
3485<p>To print a complete list of interlacing schemes, use <a href="#list">-list interlace</a>.</p>
3486
3487<div style="margin: auto;">
3488 <h4><a name="interpolate" id="interpolate"></a>-interpolate <em class="arg">type</em></h4>
3489</div>
3490
3491<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>
3492
3493<p>When looking up the color of a pixel using a non-interger floating point
3494value, you typically fall in between the pixel colors defined by the source
3495image. This setting determines how the color is determined from the colors of
3496the pixels surrounding that point. That is how to determine the color of a
3497point that falls between two, or even four different colored pixels. </p>
3498
3499<pre class="text">
3500 integer: The color of the top-left pixel (floor function)
3501 nearest-neighbor: The nearest pixel to the lookup point (rounded function)
3502 average: The average color of the surrounding four pixels
3503 bilinear A double linear interpolation of pixels (the default)
3504 mesh Divide area into two flat triangular interpolations
3505 bicubic Fitted bicubic-spines of surrounding 16 pixels
3506 spline Direct spline curves (colors are blurred)
3507 filter Use resize <a href="#filter">-filter</a> settings
3508</pre>
3509
3510<p>This most important for distortion operators such as <a href="#distort"
3511>-distort</a>, <a href="#implode" >-implode</a>, <a href="#transform"
3512>-transform</a> and <a href="#fx" >-fx</a>. </p>
3513
3514<p>To print a complete list of interpolation methods, use <a href="#list">-list interpolate</a>.</p>
3515
3516<p>See also <a href="#virtual-pixel" >-virtual-pixel</a>, for control of the
3517lookup for positions outside the boundaries of the image. </p>
3518
3519
3520<div style="margin: auto;">
cristyf3bb4782009-09-08 13:10:04 +00003521 <h4><a name="interline-spacing" id="interline-spacing"></a>-interline-spacing <em class="arg">value</em></h4>
3522</div>
3523
3524<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>
3525
3526<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00003527 <h4><a name="interword-spacing" id="interword-spacing"></a>-interword-spacing <em class="arg">value</em></h4>
3528</div>
3529
3530<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>
3531
3532<div style="margin: auto;">
3533 <h4><a name="kerning" id="kerning"></a>-kerning <em class="arg">value</em></h4>
3534</div>
3535
3536<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>
3537
3538<div style="margin: auto;">
3539 <h4><a name="label" id="label"></a>-label <em class="arg">name</em></h4>
3540</div>
3541
3542<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>
3543
3544<p>Use this option to assign a specific label to the image, as it is read in or created. You can use the <a href="#set" >-set</a> operation to re-assign a the labels of images already read in. Image formats such as TIFF, PNG, MIFF, supports saving the label information with the image.</p>
3545
3546<p>When saving an image to a <em class="arg">PostScript</em> file, any label assigned to an image is used as a header string to print above the postscript image. </p>
3547
3548<p>You can include the image filename, type, width, height, or other image attribute by embedding special format character. See <a href="#format">-format</a> for details of the percent escape codes.</p>
3549
3550<p>For example,</p>
3551
3552<p class="crtsnip">
3553 -label "%m:%f %wx%h" bird.miff
3554</p>
3555
3556<p>assigns an image label of <kbd>MIFF:bird.miff 512x480</kbd> to the "<kbd>bird.miff</kbd>" image and whose width is 512 and height is 480, as it is read in. If a <a href="#label">+label</a> option was used instead, any existing label present in the image would be used. You can remove all labels from an image by assigning the empty string. </p>
3557
3558<p>A label is not drawn on the image, but is embedded in the image datastream via <em>Label</em> tag or similar mechanism. If you want the label to be visible on the image itself, use the <a href="#draw">-draw</a> option, or during the final processing in the creation of a image montage.</p>
3559
3560<p>The label font can be specified with <a href="#font">-font</a>, and the
3561other font attribute settings.</p>
3562
3563<p>If the first character of <em class="arg">string</em> is <em class="arg">@</em>, the image label is read from a file titled by the remaining characters in the string. Labels in a file are literal, no embedded formatting characters are recognized.</p>
3564
3565
3566<div style="margin: auto;">
3567 <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>
3568</div>
3569
3570<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>
3571
3572<p>Adaptively threshold each pixel based on the value of pixels in a
3573surrounding window. If the current pixel is lighter than this average plus
3574the optional <kbd>offset</kbd>, then it is made white, otherwise it is made
3575black. Small variations in pixel values such as found in scanned documents
3576can be ignored if offset is positive. A negative offset will make it more
3577sensitive to those small variations. </p>
3578
3579<p>This is commonly used to threshold images with an uneven background. It is
3580based on the assumption that average color of the small window is the
3581the local background color, from which to separate the forground color. </p>
3582
3583
3584<div style="margin: auto;">
3585 <h4><a name="layers" id="layers"></a>-layers <em class="arg">method</em></h4>
3586</div>
3587
3588<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>
3589
3590<p>Perform various image operation methods to a ordered sequence of images
3591which may represent either a set of overlaid 'image layers', a GIF disposal
3592animation, or a fully-'coalesced' animation sequence. </p>
3593
3594<table class="doc">
3595 <tbody>
3596 <tr valign="top">
3597 <th align="left" style="width: 8%">Method</th>
3598 <th align="left">Description</th>
3599 </tr>
3600
3601 <tr valign="top">
3602 <td valign="top">compare-any</td>
3603 <td valign="top">Crop the second and later frames to the smallest rectangle
3604 that contains all the differences between the two images. No GIF <a
3605 href="#dispose" >-dispose</a> methods are taken into account. </td>
3606 </tr>
3607
3608 <tr><td></td><td>This exactly the same as the <a href="#deconstruct"
3609 >-deconstruct</a> operator, and does not preserve animations normal
3610 working, especially when animation used layer disposal methods such as
3611 '<kbd>Previous</kbd>' or '<kbd>Background</kbd>'. </td>
3612 </tr>
3613
3614 <tr valign="top">
3615 <td valign="top">compare-clear</td>
3616 <td valign="top">As '<kbd>compare-any</kbd>' but crop to the bounds of any
3617 opaque pixels which become transparent in the second frame. That is the
3618 smallest image needed to mask or erase pixels for the next frame. </td>
3619 </tr>
3620
3621 <tr valign="top">
3622 <td valign="top">compare-overlay</td>
3623 <td valign="top">As '<kbd>compare-any</kbd>' but crop to pixels that add
3624 extra color to the next image, as a result of overlaying color pixels.
3625 That is the smallest single overlaid image to add or change colors. </td>
3626 </tr>
3627
3628 <tr><td></td><td>This can be used with the <a href="#compose" >-compose</a> alpha
3629 composition method '<kbd>change-mask</kbd>', to reduce the image to
3630 just the pixels that need to be overlaid. </td>
3631 </tr>
3632
3633 <tr valign="top">
3634 <td valign="top">coalesce</td>
3635 <td valign="top">Equivalent to a call to the <a href="#coalesce"
3636 >-coalesce</a> operator. Apply the layer disposal methods set in the
3637 current image sequence to form a fully defined animation sequence, as
3638 it should be displayed. Effectively converting a GIF animation into a
3639 'film strip'-like animation. </td>
3640 </tr>
3641
3642 <tr valign="top">
3643 <td valign="top">composite</td>
3644 <td valign="top">Alpha Composition of two image lists, separated by a
3645 "<kbd>null:</kbd>" image, with the destination image list first, and
3646 the source images last. An image from each list are composited
3647 together until one list is finished. The separator image and source
3648 image lists are removed. </td>
3649 </tr>
3650
3651
3652 <tr><td></td><td>The <a href="#geometry" >-geometry</a> offset is adjusted according to
3653 <a href="#gravity" >-gravity</a> in accordance of the virtual canvas
3654 size of the first image in each list. Unlike a normal <a
3655 href="#composite" >-composite</a> operation, the canvas offset is also
3656 added to the final composite positioning of each image. </td>
3657 </tr>
3658
3659 <tr><td></td><td>If one of the image lists only contains one image, that image is
3660 applied to all the images in the other image list, regardless of which
3661 list it is. In this case it is the image meta-data of the list which
3662 preserved. </td>
3663 </tr>
3664
3665
3666 <tr valign="top">
3667 <td valign="top">dispose</td>
3668 <td valign="top">This like '<kbd>coalesce</kbd>' but shows the look of
3669 the animation after the layer disposal method has been applied, before
3670 the next sub-frame image is overlaid. That is the 'dispose' image that
3671 results from the application of the GIF <a href="#dispose"
3672 >-dispose</a> method. This allows you to check what
3673 is going wrong with a particular animation you may be developing.
3674 </td>
3675 </tr>
3676
3677 <tr valign="top">
3678 <td valign="top">flatten</td>
3679 <td valign="top">Create a canvas the size of the first images virtual
3680 canvas using the current <a href="#background" >-background</a> color,
3681 and <a href="#compose" >-compose</a> each image in turn onto that
3682 canvas. Images falling outside that canvas is clipped. Final
3683 image will have a zero virtual canvas offset. </td>
3684 </tr>
3685
3686 <tr><td></td><td>This usally used as one of the final 'image layering' operations
3687 overlaying all the prepared image layers into a final image. </td>
3688 </tr>
3689
3690 <tr><td></td><td>For a single image this method can also be used to fillout a virtual
3691 canvas with real pixels, or to underlay a opaque color to remove
3692 transparency from an image.</td>
3693 </tr>
3694
3695
3696 <tr valign="top">
3697 <td valign="top">merge</td>
3698 <td valign="top">As 'flatten' method but merging all the given image
3699 layers into a new layer image just large enough to hold all the image
3700 without clipping or extra space. The new images virtual offset will
3701 prevere the position of the new layer, even if this offset is
3702 negative. the virtual canvas size of the first image is preserved.
3703 </td>
3704 </tr>
3705
3706 <tr><td></td><td>Caution is advised when handling image layers with negative offsets
3707 as few image file formats handle them correctly. </td>
3708 </tr>
3709
3710 <tr valign="top">
3711 <td valign="top">mosaic</td>
3712 <td valign="top">As 'flatten' method but expanding the initial canvas size
3713 of the first image so as to hold all the image layers. However as a
3714 virtual canvas is 'locked' to the origin, by defination, image layers
3715 with a negative offsets will still be clipped by the top and left
3716 edges.</td>
3717 </tr>
3718
3719 <tr><td></td><td>This method is commonly used to layout individual image using various
3720 offset but without knowning the final canvas size. The resulting image
3721 will, like 'flatten' not have any virtual offset, so can be saved to
3722 any image file format. </td>
3723 </tr>
3724
3725
3726 <tr valign="top">
3727 <td valign="top">optimize</td>
3728 <td valign="top">Optimize a coalesced animation, into GIF animation using
3729 a number of general techniques. This currently a short cut to
3730 apply both the '<kbd>optimize-frame</kbd>', and
3731 '<kbd>optimize-transparency</kbd>' methods but may be expanded to
3732 include other optimization methods as they are developed. </td>
3733 </tr>
3734
3735 <tr valign="top">
3736 <td valign="top">optimize-frame</td>
3737 <td valign="top">Optimize a coalesced animation, into GIF animation by
3738 reducing the number of pixels per frame as much as possible by
3739 attempting to pick the best layer disposal method to use, while ensuring
3740 the result will continue to animate properly. </td>
3741 </tr>
3742
3743 <tr><td></td><td> There is no guarantee that the best optimization is found. But
3744 then no reasonably fast GIF optimization algorithm can do this.
3745 However this does seem to do better than most other GIF frame
3746 optimizers seen. </td>
3747 </tr>
3748
3749 <tr valign="top">
3750 <td valign="top">optimize-plus</td>
3751 <td valign="top">As '<kbd>optimize-frame</kbd>' but attempt to improve the
3752 overall optimization by adding extra frames to the animation, without
3753 changing the final look or timing of the animation. The frames are
3754 added to attempt to separate the clearing of pixels from the
3755 overlaying of new additional pixels from one animation frame to the
3756 next. If this does not improve the optimization (for the next frame
3757 only), it will fall back to the results of the previous normal
3758 '<kbd>optimize-frame</kbd>' technique. </td>
3759 </tr>
3760
3761 <tr><td></td><td>There is the possibility that the change in the disposal style will
3762 result in a worsening in the optimization of later frames, though this
3763 is unlikely. In other words there no guarantee that it is better than
3764 the normal '<kbd>optimize-frame</kbd>' technique. For some animations
3765 however you can get a vast improvment in the final animation size. </td>
3766 </tr>
3767
3768 <tr valign="top">
3769 <td valign="top">optimize-transparency</td>
3770 <td valign="top">Given a GIF animation, replace any pixel in the sub-frame
3771 overlay images with transparency, if it does not change the resulting
3772 animation by more than the current <a href="#fuzz" >-fuzz</a> factor.
3773 </td>
3774 </tr>
3775
3776 <tr><td></td><td>This should allow a existing frame optimized GIF animation to compress
3777 into a smaller file size due to larger areas of one (transparent)
3778 color rather than a pattern of multiple colors repeating the current
3779 disposed image of the last frame. </td>
3780 </tr>
3781
3782 <tr valign="top">
3783 <td valign="top">remove-dups</td>
3784 <td valign="top">Remove (and merge time delays) of duplicate consecutive
3785 images, so as to simplify layer overlays of coalesced animations.
3786 </td>
3787 </tr>
3788
3789 <tr><td></td><td>Usually this a result of using a constant time delay across the
3790 whole animation, or after a larger animation was split into smaller
3791 sub-animations. The duplicate frames could also have been used as
3792 part of some frame optimization methods. </td>
3793 </tr>
3794
3795 <tr valign="top">
3796 <td valign="top">remove-zero</td>
3797 <td valign="top">Remove any image with a zero time delay, unless ALL the
3798 images have a zero time delay (and is not a proper timed animation, a
3799 warning is then issued). </td>
3800 </tr>
3801
3802 <tr><td></td><td>In a GIF animation, such images are usually frames which provide
3803 partial intermediary updates between the frames that are actually
3804 displayed to users. These frames are usally added for improved frame
3805 optimization in GIF animations. </td>
3806 </tr>
3807
3808 <tr valign="top">
3809 <td valign="top">trim-bounds</td>
3810 <td valign="top">Find the bounds of all the images in the current
3811 image sequence, then adjust the offsets so all images are contained on
3812 a minimal positive canvas. None of the image data is modified, only
3813 there virtual canvas size and offset. The all the image is given
3814 the same canvas size, and and will have a positive offset, but will
3815 remain in the same position relative to each other. As a result of the
3816 minimal canvas size at least one image will touch every edge of that
3817 canvas. The image data however may be transparent.
3818 </td>
3819 </tr>
3820
3821 </tbody>
3822</table>
3823
3824<p>To print a complete list of layer types, use <a href="#list">-list layers</a>.</p>
3825
3826<p>The operators <a href="#coalesce" >-coalesce</a>, <a href="#deconstruct"
3827>-deconstruct</a>, <a href="#flatten" >-flatten</a>, and <a href="#mosaic"
3828>-mosaic</a> are only aliases for the above methods. Also see <a
3829href="#page" >-page</a>, <a href="#repage" >-repage</a> operators, the <a
3830href="#compose" >-compose</a> setting, and the GIF <a href="#dispose"
3831>-dispose</a> and <a href="#delay" >-delay</a> settings. </p>
3832
3833
3834<div style="margin: auto;">
3835 <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>
3836</div>
3837
3838<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>
3839
3840<p>Given one, two or three values delimited with commas: black-point,
3841white-point, gamma (for example: 10,250,1.0 or 2%,98%,0.5). The black and
3842white points range from 0 to <em class="QR">QuantumRange</em>, or from 0 to 100%; if the white
3843point is omitted it is set to (<em class="QR">QuantumRange</em> - black_point), so as to center
3844contrast changes. If a <kbd>%</kbd> sign is present anywhere in the string,
3845both black and white points are percentages of the full color range. Gamma
3846will do a <a href="#gamma">-gamma</a> adjustment of the values. If it is
3847omitted, the default of 1.0 (no gamma correction) is assumed.</p>
3848
3849<p>In normal usage (<kbd>-level</kbd>) the image values are stretched so that
3850the given '<kbd>black_point</kbd>' value in the original image is set to
3851zero (or black), while the given '<kbd>white_point</kbd>' value is set to
3852<em class="QR">QuantumRange</em> (or white). This provides you with direct contrast adjustments
3853to the image. The '<kbd>gamma</kbd>' of the resulting image will then be
3854adjusted. </p>
3855
3856<p>From ImageMagick v6.4.1-9 using the plus form of the operator (<kbd>+level</kbd>) or
3857adding the special '!' flag anywhere in the argument list, will cause the
3858operator to do the reverse of the level adjustment. That is a zero, or
3859<em class="QR">QuantumRange</em> value (black, and white, resp.) in the original image, is
3860adjusted to the given level values, allowing you to de-contrast, or compress
3861the channel values within the image. The '<kbd>gamma</kbd>' is adjusted before the level adjustment to de-contrast the image is made. </p>
3862
3863<p>Only the channels defined by the current <a href="#channel">-channel</a>
3864setting are adjusted (defaults to RGB color channels only), allowing you to
3865limit the effect of this operator. </p>
3866
3867<p>Please note that the transparency channel is treated as 'matte'
3868values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
3869
3870
3871<div style="margin: auto;">
3872 <h4><a name="level-colors" id="level-colors"></a>-level-colors {<em
3873 class="arg">black_color</em>}{,}{<em class="arg">white_color</em>}</h4>
3874</div>
3875
3876<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>adjust the level of an image using the provided dash seperated colors.</td><td style='text-align:right;'></td></tr></table>
3877
3878<p>This function is exactly like <a href="#level">-level</a>, except that the
3879value value for each color channel is determined by the
3880'<kbd>black_color</kbd>' and '<kbd>white_color</kbd>' colors given (as
3881described under the <a href="#fill">-fill</a> option). </p>
3882
3883<p>This effectivally means the colors provided to <kbd>-level-colors</kbd>
3884is mapped to become 'black' and 'white' respectivally, with all the other
3885colors linearly adjusted (or clipped) to match that change. Each channel is
3886adjusted separatally using the channel values of the colors specified. </p>
3887
3888<p>On the other hand the plus form of the operator (<kbd>+level-colors</kbd>)
3889will map the image color 'black' and 'white' to the given colors
3890respectivally, resulting in a gradient (de-contrasting) tint of the image to
3891those colors. This can also be used to convert a plain gray-scale image into a
3892one using the gradient of colors specified. </p>
3893
3894<p>By supplying a single color with a comma separator either before or after
3895that color, will just replace the respective 'black' or 'white' point
3896respectivally. But if no comma separator is provided, the given color is
3897used for both the black and white color points, making the operator either
3898threshold the images around that color (- form) or set all colors to that
3899color (+ form). </p>
3900
3901
3902<div style="margin: auto;">
3903 <h4><a name="limit" id="limit"></a>-limit <em class="arg">type value</em></h4>
3904</div>
3905
3906<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>
3907
3908<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>
3909
cristy6b636652009-12-05 17:16:11 +00003910<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 +00003911
3912<p class="crtsnip">
cristyd934d102009-10-10 12:55:13 +00003913 -limit memory 32MiB -limit map 64MiB
cristy3ed852e2009-09-05 21:47:34 +00003914</p>
3915
3916<p>Use <a href="#list">-list resource</a> to list the current limits. For example, our system shows these limits:</p>
3917
cristy6b636652009-12-05 17:16:11 +00003918<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
3919------------------------------------------------------------------------------
3920 768 12.404GB 8.6642GiB 23.104GiB 18.446744EB 8 unlimited</pre>
cristy3ed852e2009-09-05 21:47:34 +00003921</span></p>
3922<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>
3923
3924<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>
3925
3926<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>
3927
3928<p class="crtsnip">
3929-limit area 10mb
3930</p>
3931
3932<p>Now whenever a large image is processed, the pixels are automagically cached to disk instead of memory. This of course implies that large images typically process very slowly, simply because pixel processing in memory can be an order of magnitude faster than on disk. Because your web site users might inadvertedly upload a huge image to process, you should set a disk limit as well:</p>
3933
3934<p class="crtsnip">
3935-limit area 10mb -limit disk 500mb
3936</p>
3937
3938<p>Here ImageMagick stops processing if an image requires more than 500MB of disk storage.</p>
3939
3940<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>
3941
3942<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.
3943</p>
3944
3945<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.
3946</p>
3947
3948<div style="margin: auto;">
3949 <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>
3950</div>
3951
3952<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>
3953
cristyd934d102009-10-10 12:55:13 +00003954<p>This is very similar to <a href="#contrast-stretch" >-contrast-stretch</a>,
3955and uses a 'histogram bin' to determine the range of color values that needs to
3956be stretched. However it then stretchs those colors using the <a
3957href="#level" >-level</a> operator.</p>
3958
3959<p>As such while the initial determination may have 'binning' round off
3960effects, the image colors are stretched mathematically, rather than using the
3961histogram bins. This makes the operator more accurate. </p>
3962
3963<p>note however that a <a href="#linear-stretch" >-linear-stretch</a> of
3964'<kbd>0</kbd>' does nothing, while a value of '<kbd>1</kbd>' does a near
3965perfect stretch of the color range. </p>
3966
3967<p>See also <a href="#auto-level" >-auto-level</a> for a 'perfect'
3968normalization of mathematical images. </p>
3969
3970<p>This operator is under review for re-development. </p>
3971
3972
cristy3ed852e2009-09-05 21:47:34 +00003973<div style="margin: auto;">
3974 <h4><a name="linewidth" id="linewidth"></a>-linewidth</h4>
3975</div>
3976
3977<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>
3978
3979<div style="margin: auto;">
3980 <h4><a name="liquid-rescale" id="liquid-rescale"></a>-liquid-rescale <em class="arg">geometry</em></h4>
3981</div>
3982
3983<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>
3984
3985<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>
3986
3987<div style="margin: auto;">
3988 <h4><a name="list" id="list"></a>-list <em class="arg">type</em></h4>
3989</div>
3990
3991<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>
3992
3993<pre class="text">
cristy787d4352010-03-06 13:55:58 +00003994 Layers
3995 LineCap
3996 LineJoin
3997 List
3998 Locale
3999 LogEvent
4000 Log
4001 Magic
4002 Method
4003 Metric
4004 Mime
4005 Mode
4006 Morphology
4007 Module
4008 Noise
4009 Orientation
4010 Policy
4011 PolicyDomain
4012 PolicyRights
4013 Preview
4014 Primitive
4015 QuantumFormat
4016 Resource
4017 SparseColor
4018 Storage
4019 Stretch
4020 Style
4021 Threshold
4022 Type
4023 Units
4024 Validate
4025 VirtualPixel
cristy3ed852e2009-09-05 21:47:34 +00004026</pre>
4027
cristy787d4352010-03-06 13:55:58 +00004028<p>These lists vary depending on your version of ImageMagick. Use "<kbd>-list list</kbd>" to get a complete listing of all the "<kbd>-list</kbd>" arguments available:</p>
cristy3ed852e2009-09-05 21:47:34 +00004029
4030<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list list</span></p>
4031<div style="margin: auto;">
4032 <h4><a name="log" id="log"></a>-log <em class="arg">string</em></h4>
4033</div>
4034
4035<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>
4036
4037<p>This option specifies the format for the log printed when the <a href="#debug">-debug</a> option is active.</p>
4038
4039<p>You can display the following components by embedding special format characters:</p>
4040
4041<pre class="text">
4042 %d domain
4043 %e event
4044 %f function
4045 %l line
4046 %m module
4047 %p process ID
4048 %r real CPU time
4049 %t wall clock time
4050 %u user CPU time
4051 %% percent sign
4052 \n newline
4053 \r carriage return
4054</pre>
4055
4056<p>For example:</p>
4057
4058<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>
4059<p>The default behavior is to print all of the components.</p>
4060
4061<div style="margin: auto;">
4062 <h4><a name="loop" id="loop"></a>-loop <em class="arg">iterations</em></h4>
4063</div>
4064
4065<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>
4066
4067<p>Set iterations to zero to repeat the animation an infinite number of times, otherwise the animation repeats itself up to <em class="arg">iterations</em> times.</p>
4068
4069<div style="margin: auto;">
4070 <h4><a name="lowlight-color" id="lowlight-color"></a>-lowlight-color <em class="arg">color</em></h4>
4071</div>
4072
4073<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>
4074
4075<div style="margin: auto;">
4076 <h4><a name="magnify" id="magnify"></a>-magnify <em class="arg">factor</em></h4>
4077</div>
4078
4079<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>
4080
4081
4082<div style="margin: auto;">
4083 <h4><a name="map" id="map"></a>-map <em class="arg">type</em></h4>
4084</div>
4085
4086<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>
4087
4088<p>Choose from these <em class="arg">Standard Colormap</em> types:</p>
4089
4090<pre class="text">
4091 best
4092 default
4093 gray
4094 red
4095 green
4096 blue
4097</pre>
4098
4099<p>The <em class="arg">X server</em> must support the <em class="arg">Standard Colormap</em> you choose, otherwise an error occurs. Use <kbd>list</kbd> as the type and <kbd>display</kbd> searches the list of colormap types in <kbd>top-to-bottom</kbd> order until one is located. See <em class="arg">xstdcmap(1)</em> for one way of creating Standard Colormaps.</p>
4100
4101
4102<div style="margin: auto;">
4103 <h4><a name="map_stream_" id="map_stream_"></a>-map <em class="arg">components</em></h4>
4104</div>
4105
4106<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>
4107
4108<p>Here are the valid components of a map:</p>
4109
4110<pre class="text">
4111 r red pixel component
4112 g green pixel component
4113 b blue pixel component
4114 a alpha pixel component (0 is transparent)
4115 o opacity pixel component (0 is opaque)
4116 i grayscale intensity pixel component
4117 c cyan pixel component
4118 m magenta pixel component
4119 y yellow pixel component
4120 k black pixel component
4121 p pad component (always 0)
4122</pre>
4123
4124<p>You can specify as many of these components as needed in any order (e.g. bgr). The components can repeat as well (e.g. rgbr).</p>
4125
4126<div style="margin: auto;">
4127 <h4><a name="mask" id="mask"></a>-mask
4128<em class="arg">filename</em></h4>
4129</div>
4130
4131<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>
4132
4133<p>Use <a href="#mask">+mask</a> to remove the image mask.</p>
4134
4135<div style="margin: auto;">
4136 <h4><a name="mattecolor" id="mattecolor"></a>-mattecolor <em class="arg">color</em></h4>
4137</div>
4138
4139<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>
4140
4141<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
4142
4143<p>The default matte color is <kbd>#BDBDBD</kbd>, <span style="background-color: #bdbdbd;">this shade of gray</span>.</p>
4144
4145<div style="margin: auto;">
cristyd2baf7d2010-03-06 04:26:44 +00004146 <h4><a name="maximum" id="maximum"></a>-maximum</h4>
4147</div>
4148
4149<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>
4150
4151<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004152 <h4><a name="median" id="median"></a>-median <em class="arg">radius</em></h4>
4153</div>
4154
4155<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>
4156
4157<div style="margin: auto;">
4158 <h4><a name="metric" id="metric"></a>-metric <em class="arg">type</em></h4>
4159</div>
4160
4161<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>
4162
4163<p>Choose from:</p>
4164
4165<pre class="text">
cristy4949d522010-03-12 18:41:34 +00004166 AE absolute number of different pixels
cristy3ed852e2009-09-05 21:47:34 +00004167 MAE mean absolute error (normalized), average channel error distance
4168 MEPP mean error per pixel (normalized mean error, normalized peak error)
4169 MSE mean error squared, average of the channel error squared
4170 PAE peak absolute (normalize peak absolute)
4171 PSNR peak signal to noise ratio
4172 RMSE root mean squared (normalized root mean squared)
4173</pre>
4174
4175<p>The '<kbd>AE</kbd>' or absolute count of pixels that are different, can be
4176controled using a <a href="#fuzz" >-fuzz</a> factor to ignore pixels which
4177only changed by a small amount. The '<kbd>PAE</kbd>' can be used to find the
4178size of the <a href="#fuzz" >-fuzz</a> factor needed to make all pixels
4179'similar'. </p>
4180
4181<p>The '<kbd>MEPP</kbd>' metric returns three different metrics
4182('<kbd>MAE</kbd>', '<kbd>MAE</kbd>' normalized, and '<kbd>PAE</kbd>'
4183normalized) from the single comparision run. </p>
4184
4185<p>To print a complete list of metrics, use the <a href="#list">-list metrics</a> option.</p>
4186
cristyd2baf7d2010-03-06 04:26:44 +00004187<div style="margin: auto;">
4188 <h4><a name="minimum" id="minimum"></a>-minimum</h4>
4189</div>
4190
4191<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>
4192
cristy3ed852e2009-09-05 21:47:34 +00004193
4194<div style="margin: auto;">
4195 <h4><a name="mode" id="mode"></a>-mode <em class="arg">value</em></h4>
4196</div>
4197
4198<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>
4199
4200<p>Choose the <em class="arg">value</em> from these styles: <kbd>Frame, Unframe, or Concatenate</kbd></p>
4201
4202<p>Use the <a href="#list" >-list</a> option with a '<kbd>Mode</kbd>'
4203argument for a list of <a href="#mode" >-mode</a> arguments available
4204in your ImageMagick installation.</p>
4205
4206
4207<div style="margin: auto;">
4208 <h4><a name="modulate" id="modulate"></a>-modulate <em class="arg">brightness</em>[,<em class="arg">saturation</em>,<em class="arg">hue</em>]</h4>
4209</div>
4210
4211<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 class="arg">saturation</em>, and <em class="arg">hue</em> of an image.</td><td style='text-align:right;'></td></tr></table>
4212
cristyb36feb22010-03-26 16:54:37 +00004213<p>The arguments are given as a percentages of variation. A value of 100 means
4214no change, and any missing values are taken to mean 100.</p>
cristy3ed852e2009-09-05 21:47:34 +00004215
cristyb36feb22010-03-26 16:54:37 +00004216<p>The <em class="arg">brightness</em> is a multiplier of the overall
4217brightness of the image, so 0 means pure black, 50 is half as bright, 200 is
4218twice as bright. To invert its meaning <a href="#negate">-negate</a> the image
4219before and after. </p>
cristy3ed852e2009-09-05 21:47:34 +00004220
cristyb36feb22010-03-26 16:54:37 +00004221<p>The <em class="arg">saturation</em> controls the amount of color in an
4222image. For example, 0 produce a grayscale image, while a large value such as
4223200 produce a very colorful, 'cartoonish' color.</p>
cristy3ed852e2009-09-05 21:47:34 +00004224
cristyb36feb22010-03-26 16:54:37 +00004225<p>The <em class="arg">hue</em> argument causes a "rotation" of the colors
4226within the image by the amount specified. For example, 50 results in
4227a counter-clockwise rotation of 90, mapping red shades to purple, and so on.
4228A value of either 0 or 200 results in a complete 180 degree rotation of the
4229image. Using a value of 300 is a 360 degree rotation resulting in no change to
4230the original image. </p>
cristy3ed852e2009-09-05 21:47:34 +00004231
cristyb36feb22010-03-26 16:54:37 +00004232<p>For example, to increase the color brightness by 20% and decrease the color
4233saturation by 10% and leave the hue unchanged, use <a
4234href="#modulate">-modulate 120,90</a>.</p>
cristy3ed852e2009-09-05 21:47:34 +00004235
cristyb36feb22010-03-26 16:54:37 +00004236<p>Use <a href="#set">-set</a> attribute of '<kbd
4237class="arg">option:modulate:colorspace</kbd>' to specify which colorspace to
4238modulate. Choose from <kbd>HSB</kbd>, <kbd>HSL</kbd> (the default), or
4239<kbd>HWB</kbd>. For example,</p>
cristy3ed852e2009-09-05 21:47:34 +00004240
4241<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 +00004242
cristy3ed852e2009-09-05 21:47:34 +00004243<div style="margin: auto;">
4244 <h4><a name="monitor" id="monitor"></a>-monitor</h4>
4245</div>
4246
4247<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>
4248
4249
4250<div style="margin: auto;">
4251 <h4><a name="monochrome" id="monochrome"></a>-monochrome</h4>
4252</div>
4253
4254<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>
4255
4256
4257<div style="margin: auto;">
4258 <h4><a name="morph" id="morph"></a>-morph <em class="arg">frames</em></h4>
4259</div>
4260
4261<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>
4262
4263<p>Both the image pixels and size are linearly interpolated to give the
4264appearance of a meta-morphosis from one image to the next, over all the images
4265in the current image list. The added images are the equivalent of a <a
4266href="#blend">-blend</a> composition. The <em class="arg">frames</em>
4267argument determine how many images to interpolate between each image. </p>
4268
4269
4270<div style="margin: auto;">
cristy488844c2010-01-22 14:02:05 +00004271 <h4><a name="morphology" id="morphology"></a>-morphology</h4>
4272 <h4><a name="morphology" id="morphology"></a>-morphology <em class="arg">method</em> <em class="arg">kernel</em></h4>
4273</div>
4274
4275<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>
4276
4277<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004278 <h4><a name="mosaic" id="mosaic"></a>-mosaic</h4>
4279</div>
4280
4281<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>
4282
4283
4284<div style="margin: auto;">
4285 <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>
4286</div>
4287
4288<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>
4289
4290<p>Blur with the given radius, standard deviation (sigma), and angle. The
4291angle given is the angle toward which the image is blurred. That is the
4292direction people would consider the object is coming from. </p>
4293
4294<p>Note that the blur is not uniform distribution, giving the motion a
4295definate sense of direction of movement. </p>
4296
4297<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4298pixels which are outside the image proper are blurred into the final result.
4299</p>
4300
4301<div style="margin: auto;">
4302 <h4><a name="name" id="name"></a>-name</h4>
4303</div>
4304
4305<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>
4306<div style="margin: auto;">
4307 <h4><a name="negate" id="negate"></a>-negate</h4>
4308</div>
4309
cristyb29bc032010-02-01 20:29:43 +00004310<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 +00004311
4312<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>
4313
4314<div style="margin: auto;">
4315 <h4><a name="noise" id="noise"></a>-noise <em class="arg">radius</em><br/>
4316 +noise <em class="arg">type</em></h4>
4317</div>
4318
4319<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>
4320
4321<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>
4322
4323<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>
4324
4325<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>
4326
4327<pre class="text">
4328Gaussian
4329Impulse
4330Laplacian
4331Multiplicative
4332Poisson
4333Random
4334Uniform
4335</pre>
4336
4337<p>To print a complete list of noises, use the <a href="#list">-list noise</a> option.</p>
4338
cristy83543962009-10-16 19:04:28 +00004339<p>Also see the <a href="#evaluate">-evaluate</a> noise functions that allos
4340the use of a controlling value to specify teh amount of noise that should be
4341added to an image. </p>
4342
cristy3ed852e2009-09-05 21:47:34 +00004343
4344<div style="margin: auto;">
4345 <h4><a name="normalize" id="normalize"></a>-normalize</h4>
4346</div>
4347
4348<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>
4349
cristyd934d102009-10-10 12:55:13 +00004350<p>The intensity values are stretched to cover the entire range of possible
4351values. While doing so, black-out at most <em>2%</em> of the pixels and
4352white-out at most <em>1%</em> of the pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +00004353
cristyd934d102009-10-10 12:55:13 +00004354<p>Note that as of ImageMagick 6.4.7-0, <a href="#normalize" >-normalize</a>
4355is equivalent to <a href="#contrast-stretch" >-contrast-stretch 2%x1%</a>.
4356(Before this version, it was equivalent to <a href="#contrast-stretch"
4357>-contrast-stretch 2%x99%</a>).</p>
cristy3ed852e2009-09-05 21:47:34 +00004358
cristyd934d102009-10-10 12:55:13 +00004359<p>All the channels are normalized in concert by the came amount so as to
4360preserve color integrity, when the default <a href="#channel" >+channel</a>
4361setting is in use. Specifing any other <a href="#channel" >-channel</a>
4362setting will normalize the RGB channels independently.</p>
4363
4364<p>See <a href="#contrast-stretch" >-contrast-stretch</A> for more details.
4365Also see <a href="#auto-level" >-auto-level</a> for a 'perfect' normalization
cristy83543962009-10-16 19:04:28 +00004366that is better suited to mathematically generated images. </p>
cristyd934d102009-10-10 12:55:13 +00004367
4368<p>This operator is under review for re-development. </p>
cristy3ed852e2009-09-05 21:47:34 +00004369
4370
4371<div style="margin: auto;">
4372 <h4><a name="ordered-dither" id="ordered-dither"></a>-ordered-dither <em class="arg">threshold_map</em>{,<em class="arg">level</em>...}</h4>
4373</div>
4374
cristyd934d102009-10-10 12:55:13 +00004375<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
4376class="arg">threshold map</em> specified, and a uniform color map with the
4377given 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 +00004378
4379<p>You can choose from these standard threshold maps:</p>
4380
4381<pre class="text">
cristyd934d102009-10-10 12:55:13 +00004382 threshold
cristy3ed852e2009-09-05 21:47:34 +00004383 checks
4384 o2x2
4385 o3x3
4386 o4x4
4387 o8x8
4388 h4x4a
4389 h6x6a
4390 h8x8a
4391 h4x4o
4392 h6x6o
4393 h8x8o
4394 h16x16o
4395</pre>
4396
cristyd934d102009-10-10 12:55:13 +00004397<p>The '<kbd>o</kbd>' maps are ordered diffused pixel threshold maps, while the
4398'<kbd>h</kbd>' maps are halftone threshold maps which are either 'a' angled, or
4399'o' orthogonal. The '<kbd>checks</kbd>' produce a 3 level checkerbord dither
4400pattern. Or you can define your own <em class="arg" >threshold map</em> in a
4401personal or system "<kbd>thresholds.xml</kbd>" XML file. </p>
cristy3ed852e2009-09-05 21:47:34 +00004402
cristyd934d102009-10-10 12:55:13 +00004403<p>To print a complete list of threshold, use the <a href="#list" >-list
4404threshold</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004405
cristyd934d102009-10-10 12:55:13 +00004406<p>It is recommended that the <a href="#map" >+map</a> operator be used after
4407applying <a href="#ordered-dither" >-ordered-dither</a> to reduce the number of
cristy3ed852e2009-09-05 21:47:34 +00004408colors an animated image sequence, to less that 256 colors. This ensures that
4409a common or global color table is used when saving the result to a color
4410limited file format such as GIF. </p>
4411
cristyd934d102009-10-10 12:55:13 +00004412<p>Note that at this time the exact same threshold dithering map is used for
4413all color channels, no attempt is made to offset or rotate the map for
4414different channels is made, to create an offset printing effect. (possible
4415future expansion) </p>
cristy3ed852e2009-09-05 21:47:34 +00004416
4417
4418<div style="margin: auto;">
4419 <h4><a name="opaque" id="opaque"></a>-opaque <em class="arg">color</em></h4>
4420</div>
4421
4422<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>
4423
cristyc54f5d42009-11-27 21:36:31 +00004424<p>The <em class="arg">color</em> argument is defined using the format
cristyd934d102009-10-10 12:55:13 +00004425described under the <a href="#fill" >-fill</a> option. The <a href="#fuzz"
4426>-fuzz</a> setting can be used to match and replace colors similar to the one
4427given.</p>
cristy3ed852e2009-09-05 21:47:34 +00004428
cristyb36feb22010-03-26 16:54:37 +00004429<p>Use <a href="#opaque">+opaque</a> to paint any pixel that does not match
4430the target color. </p>
cristy3ed852e2009-09-05 21:47:34 +00004431
cristyb36feb22010-03-26 16:54:37 +00004432<p>The <a href="#transparent">-transparent</a> operator is exactly the same
4433as <a href="#opaque" >-opaque</a> but replaces the matching color with
4434transparency rather than the current <a href="#fill">-fill</a> color setting.
4435To ensure that it can do this it also ensures that the image has an alpha
4436channel enabled, as per "<kbd><a href="#alpha" >-alpha</a> set</kbd>", for
4437the new transparent colors, and does not require you to modify the <a
4438href="#channel">-channel</a> to enable alpha channel handling. </p>
cristyd934d102009-10-10 12:55:13 +00004439
cristy3ed852e2009-09-05 21:47:34 +00004440
4441<div style="margin: auto;">
4442 <h4><a name="orient" id="orient"></a>-orient <em class="arg">image orientation</em></h4>
4443</div>
4444
4445<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>
4446
4447<p>Choose from these orientations:</p>
4448
4449<pre class="text">
4450 bottom-left
4451 bottom-right
4452 left-bottom
4453 left-top
4454 right-bottom
4455 right-top
4456 top-left
4457 top-right
4458 undefined
4459</pre>
4460
cristyd934d102009-10-10 12:55:13 +00004461<p>To print a complete list of orientations, use the <a href="#list" >-list
4462orientation</a> option.</p>
cristy3ed852e2009-09-05 21:47:34 +00004463
4464
4465<div style="margin: auto;">
4466 <h4><a name="page" id="page"></a>-page <em class="arg">geometry</em><br/>
4467 -page <em class="arg">media</em>[<em class="arg">offset</em>][{<em class="arg">^!&lt;&gt;</em>}]<br/>
4468 +page
4469 </h4>
4470</div>
4471
4472<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>
4473
4474<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>
4475
4476<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>
4477
4478<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>
4479<table id="geometryTable" cellpadding="2" cellspacing="0" border="1" width="50%" style="margin-left: auto; margin-right: auto;">
4480<thead>
4481 <tr valign="top">
4482 <th align="center"><em class="arg">media</em></th>
4483 <th align="center"><em class="arg">width</em></th>
4484 <th align="center"><em class="arg">height</em></th>
4485 </tr>
4486</thead>
4487<tbody>
4488<tr><td align="left"> 11x17 </td> <td align="right"> 792</td> <td align="right"> 1224</td> </tr>
4489<tr><td align="left"> Ledger </td> <td align="right"> 1224</td> <td align="right"> 792</td> </tr>
4490<tr><td align="left"> Legal </td> <td align="right"> 612</td> <td align="right"> 1008</td> </tr>
4491<tr><td align="left"> Letter </td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4492<tr><td align="left"> LetterSmall</td> <td align="right"> 612</td> <td align="right"> 792</td> </tr>
4493<tr><td align="left"> ArchE </td> <td align="right"> 2592</td> <td align="right"> 3456</td> </tr>
4494<tr><td align="left"> ArchD </td> <td align="right"> 1728</td> <td align="right"> 2592</td> </tr>
4495<tr><td align="left"> ArchC </td> <td align="right"> 1296</td> <td align="right"> 1728</td> </tr>
4496<tr><td align="left"> ArchB </td> <td align="right"> 864</td> <td align="right"> 1296</td> </tr>
4497<tr><td align="left"> ArchA </td> <td align="right"> 648</td> <td align="right"> 864</td> </tr>
4498<tr><td align="left"> A0 </td> <td align="right"> 2380</td> <td align="right"> 3368</td> </tr>
4499<tr><td align="left"> A1 </td> <td align="right"> 1684</td> <td align="right"> 2380</td> </tr>
4500<tr><td align="left"> A2 </td> <td align="right"> 1190</td> <td align="right"> 1684</td> </tr>
4501<tr><td align="left"> A3 </td> <td align="right"> 842</td> <td align="right"> 1190</td> </tr>
4502<tr><td align="left"> A4 </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4503<tr><td align="left"> A4Small </td> <td align="right"> 595</td> <td align="right"> 842</td> </tr>
4504<tr><td align="left"> A5 </td> <td align="right"> 421</td> <td align="right"> 595</td> </tr>
4505<tr><td align="left"> A6 </td> <td align="right"> 297</td> <td align="right"> 421</td> </tr>
4506<tr><td align="left"> A7 </td> <td align="right"> 210</td> <td align="right"> 297</td> </tr>
4507<tr><td align="left"> A8 </td> <td align="right"> 148</td> <td align="right"> 210</td> </tr>
4508<tr><td align="left"> A9 </td> <td align="right"> 105</td> <td align="right"> 148</td> </tr>
4509<tr><td align="left"> A10 </td> <td align="right"> 74</td> <td align="right"> 105</td> </tr>
4510<tr><td align="left"> B0 </td> <td align="right"> 2836</td> <td align="right"> 4008</td> </tr>
4511<tr><td align="left"> B1 </td> <td align="right"> 2004</td> <td align="right"> 2836</td> </tr>
4512<tr><td align="left"> B2 </td> <td align="right"> 1418</td> <td align="right"> 2004</td> </tr>
4513<tr><td align="left"> B3 </td> <td align="right"> 1002</td> <td align="right"> 1418</td> </tr>
4514<tr><td align="left"> B4 </td> <td align="right"> 709</td> <td align="right"> 1002</td> </tr>
4515<tr><td align="left"> B5 </td> <td align="right"> 501</td> <td align="right"> 709</td> </tr>
4516<tr><td align="left"> C0 </td> <td align="right"> 2600</td> <td align="right"> 3677</td> </tr>
4517<tr><td align="left"> C1 </td> <td align="right"> 1837</td> <td align="right"> 2600</td> </tr>
4518<tr><td align="left"> C2 </td> <td align="right"> 1298</td> <td align="right"> 1837</td> </tr>
4519<tr><td align="left"> C3 </td> <td align="right"> 918</td> <td align="right"> 1298</td> </tr>
4520<tr><td align="left"> C4 </td> <td align="right"> 649</td> <td align="right"> 918</td> </tr>
4521<tr><td align="left"> C5 </td> <td align="right"> 459</td> <td align="right"> 649</td> </tr>
4522<tr><td align="left"> C6 </td> <td align="right"> 323</td> <td align="right"> 459</td> </tr>
4523<tr><td align="left"> Flsa </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4524<tr><td align="left"> Flse </td> <td align="right"> 612</td> <td align="right"> 936</td> </tr>
4525<tr><td align="left"> HalfLetter </td> <td align="right"> 396</td> <td align="right"> 612</td> </tr>
4526</tbody>
4527</table>
4528
4529
4530
4531
4532<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>
4533
4534<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>
4535
4536<p>The default page dimensions for a TEXT image is 612x792.</p>
4537
4538<p>This option is used in concert with <a href="#density">-density</a>.</p>
4539
4540<p>Use <a href="#page">+page</a> to remove the page settings for an image.</p>
4541
4542<div style="margin: auto;">
4543 <h4><a name="paint" id="paint"></a>-paint <em class="arg">radius</em></h4>
4544</div>
4545
4546<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>
4547
4548<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>
4549
4550<div style="margin: auto;">
4551 <h4><a name="path" id="path"></a>-path <em class="arg">path</em></h4></div>
4552
4553<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>
4554
4555<div style="margin: auto;">
4556 <h4><a name="pause_animate_" id="pause_animate_"></a>-pause <em class="arg">seconds</em></h4>
4557</div>
4558
4559<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>
4560
4561<p>Pause for the specified number of seconds before repeating the animation.</p>
4562
4563<div style="margin: auto;">
4564 <h4><a name="pause_import_" id="pause_import_"></a>-pause <em class="arg">seconds</em></h4>
4565</div>
4566
4567<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>
4568
4569<p>Pause for the specified number of seconds before taking the next snapshot.</p>
4570
4571<div style="margin: auto;">
4572 <h4><a name="ping" id="ping"></a>-ping</h4>
4573</div>
4574
4575<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>
4576
4577<div style="margin: auto;">
4578 <h4><a name="pointsize" id="pointsize"></a>-pointsize <em class="arg">value</em></h4>
4579</div>
4580
4581<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>
4582
4583<div style="margin: auto;">
4584 <h4><a name="polaroid" id="polaroid"></a>-polaroid <em class="arg">angle</em></h4>
4585</div>
4586
4587<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>
4588
4589<p>Use <kbd>+polaroid</kbd> to rotate the image at a random angle between -15 and +15 degrees.</p>
4590
4591<div style="margin: auto;">
4592 <h4><a name="posterize" id="posterize"></a>-posterize <em class="arg">levels</em></h4>
4593</div>
4594
4595<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>
4596
4597<div style="margin: auto;">
cristyd43a46b2010-01-21 02:13:41 +00004598 <h4><a name="precision" id="precision"></a>-precision <em class="arg">value</em></h4>
4599</div>
4600
4601<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>
4602
4603<div style="margin: auto;">
cristy3ed852e2009-09-05 21:47:34 +00004604 <h4><a name="preview" id="preview"></a>-preview <em class="arg">type</em></h4>
4605</div>
4606
4607<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>
4608
4609<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>
4610
4611<pre class="text">
4612 Rotate
4613 Shear
4614 Roll
4615 Hue
4616 Saturation
4617 Brightness
4618 Gamma
4619 Spiff
4620 Dull
4621 Grayscale
4622 Quantize
4623 Despeckle
4624 ReduceNoise
4625 Add Noise
4626 Sharpen
4627 Blur
4628 Threshold
4629 EdgeDetect
4630 Spread
4631 Shade
4632 Raise
4633 Segment
4634 Solarize
4635 Swirl
4636 Implode
4637 Wave
4638 OilPaint
4639 CharcoalDrawing
4640 JPEG
4641</pre>
4642
4643<p>To print a complete list of previews, use the <a href="#list">-list preview</a> option.</p>
4644
4645<p>The default preview is <kbd>JPEG</kbd>.</p>
4646
4647<div style="margin: auto;">
4648 <h4><a name="print" id="print"></a>-print <em class="arg">string</em></h4>
4649</div>
4650
4651<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>
4652
4653<div style="margin: auto;">
4654 <h4><a name="process" id="process"></a>-process <em class="arg">command</em></h4>
4655</div>
4656
4657<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>
4658
4659<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>
4660
4661<div style="margin: auto;">
4662 <h4><a name="profile" id="profile"></a>-profile <em class="arg">filename</em><br/>
4663 +profile <em class="arg">profile_name</em></h4>
4664</div>
4665
4666<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>
4667
4668<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>
4669
4670<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>
4671
4672<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>
4673
4674<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>
4675
4676<p>For example, to extract the Exif data (which is stored in JPEG files in the <em class="arg">APP1</em> profile), use.</p>
4677
4678<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert cockatoo.jpg profile.exif</span></p>
4679<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>
4680
4681<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>
4682<p>Furthermore, since ICC profiles are not necessarily symmetric, extra conversion steps can yield unwanted results.
4683CMYK profiles are often very asymmetric since they involve 3&minus;&gt;4 and 4&minus;&gt;3 channel mapping.
4684</p>
4685
4686<div style="margin: auto;">
4687 <h4><a name="quality" id="quality"></a>-quality <em class="arg">value</em></h4>
4688</div>
4689
4690<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>
4691
4692<p>For the JPEG and MPEG image formats, quality is 0 (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 85. Use the <a href="#sampling-factor">-sampling-factor</a> option to specify the factors for chroma downsampling.</p>
4693
4694<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>
4695
4696<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 85 results in a request for 16:1 compression. The quality value 100 results in a request for non-lossy compression.</p>
4697
4698<p>For the MNG and PNG image formats, the quality value sets the zlib compression level (quality / 10) and filter-type (quality % 10). Compression levels range from 0 (fastest compression) to 100 (best but slowest). For compression level 0, the Huffman-only strategy is used, which is fastest but not necessarily the worst compression.</p>
4699
4700<p>If filter-type is 4 or less, the specified filter-type is used for all scanlines:</p>
4701
4702<pre class="text">
4703 0: none
4704 1: sub
4705 2: up
4706 3: average
4707 4: Paeth
4708</pre>
4709
4710<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>
4711
4712<p>If filter-type is 6, adaptive filtering with <em class="arg">minimum-sum-of-absolute-values</em> is used.</p>
4713
4714<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>
4715
4716<p>The default is quality is 85, which means nearly the best compression with adaptive filtering. The quality setting has no effect on the appearance of PNG and MNG images, since the compression is always lossless.</p>
4717
4718<p>For further information, see the <a href="http://www.w3.org/pub/WWW/TR">PNG</a> specification.</p>
4719
4720<p>When writing a JNG image with transparency, two quality values are required, one for the main image and one for the grayscale image that conveys the alpha channel. These are written as a single integer equal to the main image quality plus 1000 times the opacity quality. For example, if you want to use quality 85 for the main image and quality 90 to compress the opacity data, use <a href="#quality">-quality 90085</a>.</p>
4721
4722<div style="margin: auto;">
4723 <h4><a name="quantize" id="quantize"></a>-quantize <em class="arg">colorspace</em></h4>
4724</div>
4725
4726<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>reduce colors in this colorspace.</td><td style='text-align:right;'></td></tr></table>
4727
4728<p>To print a complete list of colorspaces, use the <a href="#list">-list colorspace</a> option.</p>
4729
4730
4731<div style="margin: auto;">
4732 <h4><a name="quiet" id="quiet"></a>-quiet</h4>
4733</div>
4734
4735<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>
4736
4737<div style="margin: auto;">
4738 <h4><a name="radial-blur" id="radial-blur"></a>-radial-blur <em class="arg">angle</em></h4>
4739</div>
4740
4741<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>
4742
4743<p>Note that this is actually a rotational blur rather than a radial and as
4744such actually mis-named. </p>
4745
4746<p>The <a href="#virtual-pixel">-virtual-pixel</a> setting will determine how
4747pixels which are outside the image proper are blurred into the final result.
4748</p>
4749
4750
4751<div style="margin: auto;">
4752 <h4><a name="raise" id="raise"></a>-raise <em class="arg">thickness</em></h4>
4753</div>
4754
4755<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>
4756
4757<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>.
4758</p>
4759
4760<p>Unlike the similar <a href="#frame">-frame</a> option, <a href="#raise">-raise</a> does not alter the dimensions of the image.</p>
4761
4762<div style="margin: auto;">
4763 <h4><a name="random-threshold" id="random-threshold"></a>-random-threshold <em class="arg">low</em>x<em class="arg">high</em></h4>
4764</div>
4765
4766<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>
4767
4768<div style="margin: auto;">
4769 <h4><a name="recolor" id="recolor"></a>-recolor <em class="arg">matrix</em></h4>
4770</div>
4771
4772<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Translate, scale, shear, or rotate image colors.</td><td style='text-align:right;'></td></tr></table>
4773
cristy2744bd92009-11-08 22:57:52 +00004774<p>Although variable-sized matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA. Populate the last row with normalized values to translate. The translation matrix is similar to that used by Adobe
4775Flash except that the offset is scaled to 1.0 (divide Flash offset by 255).</p>
cristy3ed852e2009-09-05 21:47:34 +00004776
4777<div style="margin: auto;">
4778 <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
4938<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>scale image using pixel sampling.</td><td style='text-align:right;'></td></tr></table>
4939
4940<p><a href="#sample">-sample</a> ignores the current <a href="#resize">-resize</a> <a href="#filter">-filter</a> setting. The results are equivalent to using <a href="#resize">-resize</a> with a <a href="#filter">-filter</a> setting of <kbd>point</kbd>, though <a href="#sample">-sample</a> is a lot faster. </p>
4941
4942<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>
4943
4944
4945<div style="margin: auto;">
4946 <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>
4947</div>
4948
4949<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>
4950
4951<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>
4952
4953<div style="margin: auto;">
4954 <h4><a name="scale" id="scale"></a>-scale <em class="arg">geometry</em></h4>
4955</div>
4956
4957<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>scale the image.</td><td style='text-align:right;'></td></tr></table>
4958
4959<p>See <a href="../www/command-line-processing.html#geometry">Image Geometry</a> for complete details about the <em class="arg">geometry</em> argument. The <a href="#scale">-scale</a> option uses a simpler, faster algorithm than <a href="#resize">-resize</a>, and it ignores the <a href="#filter">-filter</a> setting if one is present. Offsets, if present in the <em class="arg">geometry</em> string, are ignored, and the <a href="#gravity">-gravity</a> option has no effect.</p>
4960
4961<div style="margin: auto;">
4962 <h4><a name="scene" id="scene"></a>-scene <em class="arg">value</em></h4>
4963</div>
4964
4965<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>
4966
4967<p>This option sets the scene number of an image or the first image in an image sequence.</p>
4968
4969<div style="margin: auto;">
4970 <h4><a name="screen" id="screen"></a>-screen</h4>
4971</div>
4972
4973<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>
4974
4975<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>
4976
4977<div style="margin: auto;">
4978 <h4><a name="seed" id="seed"></a>-seed</h4>
4979</div>
4980
4981<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>
4982
4983<div style="margin: auto;">
4984 <h4><a name="segment" id="segment"></a>-segment <em class="arg">cluster-threshold</em>x<em class="arg">smoothing-threshold</em></h4>
4985</div>
4986
4987<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>
4988
4989<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>
4990
4991<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>
4992
4993<p>If the <a href="#verbose">-verbose</a> setting is defined, a detailed report
4994of the color clusters is returned.</p>
4995
4996
4997<div style="margin: auto;">
4998 <h4><a name="selective-blur" id="selective-blur"></a>-selective-blur <em class="arg">geometry</em></h4>
4999</div>
5000
5001<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>
5002
5003<div style="margin: auto;">
5004 <h4><a name="separate" id="separate"></a>-separate</h4>
5005</div>
5006
5007<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>
5008
5009<div style="margin: auto;">
5010 <h4><a name="sepia-tone" id="sepia-tone"></a>-sepia-tone <em class="arg">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%'>simulate a sepia-toned photo.</td><td style='text-align:right;'></td></tr></table>
5014
5015<p>Specify <em class="arg">threshold</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5016
5017<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>
5018
5019<div style="margin: auto;">
5020 <h4><a name="set" id="set"></a>-set <em class="arg">attribute value</em></h4>
5021</div>
5022
5023<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set an image attribute for all images in the current image sequence, after they have been created or read in. </td><td style='text-align:right;'></td></tr></table>
5024
5025<p>Attributes of interest include <a href="#comment">-comment</a>, <a href="#delay">-delay</a>, <a href="#dispose">-dispose</a>, and <a href="#page">-page</a>. For example:</p>
5026
cristy4949d522010-03-12 18:41:34 +00005027<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert rose: -set comment 'Rose is a rose is a rose is a rose' \ <br/> rose.png</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -format %c rose.png</span><span class='crtout'>Rose is a rose is a rose is a rose</span></p>
cristy3ed852e2009-09-05 21:47:34 +00005028<p>The <a href="#repage">-repage</a> operator will also set the
5029'<kbd>page</kbd>' attribute of images already in memory, but allows you to
5030separately set the virtual canvas's size and offset components, and also allows
5031relative offset changes, and automatic canvas size re-calculating. The above
5032<a href="#set">-set</a> option is purely a direct, unmodified assignment of the
5033virtual canvas (page) meta-data. </p>
5034
5035<p>Set image options by prefixing the value with <kbd>option:</kbd>. Set attributes of the image registry by prefixing the value with <kbd>registry:</kbd>.</p>
5036
5037<div style="margin: auto;">
5038 <h4><a name="shade" id="shade"></a>-shade <em class="arg">azimuth</em>x<em class="arg">elevation</em></h4>
5039</div>
5040
5041<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>
5042
5043<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>
5044
5045<div style="margin: auto;">
5046 <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>
5047</div>
5048
5049<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>
5050
5051<div style="margin: auto;">
5052 <h4><a name="shared-memory"
5053id="shared-memory"></a>-shared-memory</h4>
5054</div>
5055
5056<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>
5057
5058<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>
5059
5060<div style="margin: auto;">
5061 <h4><a name="sharpen" id="sharpen"></a>-sharpen <em class="arg">radius</em>{x<em class="arg">sigma</em>}</h4>
5062</div>
5063
5064<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>
5065
5066<p>Use a Gaussian operator of the given radius and standard deviation (sigma).</p>
5067
5068<div style="margin: auto;">
5069 <h4><a name="shave" id="shave"></a>-shave <em class="arg">geometry</em></h4>
5070</div>
5071
5072<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>
5073
5074<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>
5075
5076<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>
5077
5078<div style="margin: auto;">
5079 <h4><a name="shear" id="shear"></a>-shear <em class="arg">Xdegrees</em>[x<em class="arg">Ydegrees</em>]</h4>
5080</div>
5081
5082<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>
5083
5084<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>
5085
5086<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>
5087
5088<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>
5089
5090<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>
5091
5092<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>
5093<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>
5094
5095<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -shear 20x60 logo-sheared.png</span></p>
5096<div style="margin: auto;">
5097 <h4><a name="sigmoidal" id="sigmoidal-contrast"></a>-sigmoidal-contrast <em class="arg">contrast</em>x<em class="arg">mid-point</em></h4>
5098</div>
5099
5100<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>
5101
5102<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>
5103
5104<div style="margin: auto;">
5105 <h4><a name="silent" id="silent"></a>-silent</h4>
5106</div>
5107
5108<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>
5109
5110<div style="margin: auto;">
5111 <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>
5112</div>
5113
5114<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>
5115
5116<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>
5117
5118<p>For Photo CD images, choose from these sizes:</p>
5119
5120<pre class="text">
5121 192x128
5122 384x256
5123 768x512
5124 1536x1024
5125 3072x2048
5126</pre>
5127
cristy3ed852e2009-09-05 21:47:34 +00005128<div style="margin: auto;">
5129 <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>
5130</div>
5131
5132<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>
5133
5134<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>
5135
5136<div style="margin: auto;">
5137 <h4><a name="snaps" id="snaps"></a>-snaps <em class="arg">value</em></h4>
5138</div>
5139
5140<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>
5141
5142<p>Use this option to grab more than one image from the X server screen, to create an animation sequence.</p>
5143
5144<div style="margin: auto;">
5145 <h4><a name="solarize" id="solarize"></a>-solarize <em class="arg">threshold</em></h4>
5146</div>
5147
5148<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>
5149
5150<p>Specify <em class="arg">factor</em> as the percent threshold of the intensity (0 - 99.9%).</p>
5151
5152<p>This option produces a <em class="arg">solarization</em> effect seen when exposing a photographic film to light during the development process.</p>
5153
5154<div style="margin: auto;">
5155 <h4><a name="sparse-color" id="sparse-color"></a>-sparse-color <em
5156 class="arg">method</em> '<em class="arg">x</em>,<em class="arg">y</em> <em class="arg">color</em> ...'</h4>
5157</div>
5158
5159<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>
5160
5161
5162<table class="doc">
5163 <tbody>
5164 <tr valign="top">
5165 <th align="left" style="width: 8%">Method</th>
5166 <th align="left">Description</th>
5167 </tr>
5168
5169 <tr valign="top">
5170 <td valign="top">voronoi</td>
5171 <td valign="top">Simply map each pixel to the to nearest color point
5172 given. The result are polygonal 'cells' of solid color. </td>
5173 </tr>
5174
5175 <tr valign="top">
5176 <td valign="top">shepards</td>
5177 <td valign="top">Colors points basied on the ratio of inverse distance
5178 squared. Generating spots of color in a sea of the average of
5179 colors. </td>
5180 </tr>
5181
5182 <tr valign="top">
5183 <td valign="top">barycentric</td>
5184 <td valign="top">three point triangle of color given 3 points.
5185 Giving only 2 points will form a linear gradient between those points.
5186 Gradient is however not restricted to just the triangle or line. </td>
5187 </tr>
5188
5189 <tr valign="top">
5190 <td valign="top">bilinear</td>
5191 <td valign="top">Like barycentric but for 4 points. Less than 4 points
5192 fall back to barycentric. </td>
5193 </tr>
5194
5195 </tbody>
5196</table>
5197
5198<p>The points are placed according to the images location on the virtual
5199canvas (<a href="#page" >-page</a> or <a href="#repage" >-repage</a>
5200offset), and do not actually have to exist on the given image, but may be
5201some point beyond the edge of the image. All points are floating point values.
5202</p>
5203
5204<p>Only the color channels defined by the <a href="#channel" >-channel</a> are
5205modified, whcih means the matte/alpha transparency channel is not effected by
5206default. If enabled, the image also needs a the matte/alpha channel to be
5207enabled for this operator to effect an images transparency. This is typical
5208transparency handling for images. </p>
5209
5210<p>All the above methods when given a single point of color will replace all
5211the colors in the image with the color given, regardless of the point. This is
5212logical, and provides an alternative technique to recolor a image to some
5213default value. </p>
5214
5215
5216<div style="margin: auto;">
5217 <h4><a name="splice" id="splice"></a>-splice <em class="arg">geometry</em></h4>
5218</div>
5219
5220<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>
5221
5222<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>
5223
5224<div style="margin: auto;">
5225 <h4><a name="spread" id="spread"></a>-spread <em class="arg">amount</em></h4>
5226</div>
5227
5228<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>
5229
5230<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>
5231
5232<div style="margin: auto;">
5233 <h4><a name="stegano" id="stegano"></a>-stegano <em class="arg">offset</em></h4>
5234</div>
5235
5236<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>
5237
5238<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>
5239
5240<div style="margin: auto;">
5241 <h4><a name="stereo" id="stereo"></a>-stereo <em class="arg">+x</em>{<em class="arg">+y</em>}</h4>
5242</div>
5243
5244<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>
5245
5246<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>
5247
5248<div style="margin: auto;">
5249 <h4><a name="storage-type" id="storage-type"></a>-storage-type <em class="arg">type</em></h4>
5250</div>
5251
5252<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>
5253
5254<pre class="text">
5255 char store pixels as unsigned characters
5256 double store pixels as doubles
5257 float store pixels as floats
5258 integer store pixels as integers
5259 long store pixels as longs
5260 quantum store pixels in the native depth of your ImageMagick distribution
5261 short store pixels as unsigned shorts
5262</pre>
5263
5264<p>Float and double types are normalized from 0.0 to 1.0 otherwise the pixels
5265values range from 0 to the maximum value the storage type can support.</p>
5266
5267<div style="margin: auto;">
5268 <h4><a name="stretch" id="stretch"></a>-stretch <em class="arg">fontStretch</em></h4>
5269</div>
5270
5271<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>
5272
5273<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>
5274
5275<pre class="text">
5276 Any
5277 Condensed
5278 Expanded
5279 ExtraCondensed
5280 ExtraExpanded
5281 Normal
5282 SemiCondensed
5283 SemiExpanded
5284 UltraCondensed
5285 UltraExpanded
5286</pre>
5287
5288<p>To print a complete list of stretch types, use <a href="#list">-list stretch</a>.</p>
5289
5290<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>
5291
5292<div style="margin: auto;">
5293 <h4><a name="strip" id="strip"></a>-strip</h4>
5294</div>
5295
5296<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>
5297
5298<div style="margin: auto;">
5299 <h4><a name="stroke" id="stroke"></a>-stroke <em class="arg">color</em></h4>
5300</div>
5301
5302<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>
5303
5304<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5305
5306<p>See <a href="#draw">-draw</a> for further details.</p>
5307
5308<div style="margin: auto;">
5309 <h4><a name="strokewidth" id="strokewidth"></a>-strokewidth <em class="arg">value</em></h4>
5310</div>
5311
5312<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>set the stroke width.</td><td style='text-align:right;'></td></tr></table>
5313
5314<p>See <a href="#draw">-draw</a> for further details.</p>
5315
5316<div style="margin: auto;">
5317 <h4><a name="style" id="style"></a>-style <em class="arg">fontStyle</em></h4>
5318</div>
5319
5320<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>
5321
5322<p>This setting suggests a font style that ImageMagick should try to apply to the currently selected font family. Select <em class="arg">fontStyle</em> from the following.</p>
5323
5324<pre class="text">
5325 Any
5326 Italic
5327 Normal
5328 Oblique
5329</pre>
5330
5331<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>
5332
5333<div style="margin: auto;">
5334 <h4><a name="swap" id="swap"></a>-swap <em class="arg">index,index</em></h4>
5335</div>
5336
5337<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>
5338
5339<p>For example, <a href="#swap">-swap 0,2</a> swaps the first and the third images in the current image sequence. Use <a href="#swap">+swap</a> to switch the last two images in the sequence.</p>
5340
5341<div style="margin: auto;">
5342 <h4><a name="swirl" id="swirl"></a>-swirl <em class="arg">degrees</em></h4>
5343</div>
5344
5345<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>
5346
5347<p><em class="arg">Degrees</em> defines the tightness of the swirl.</p>
5348
5349<div style="margin: auto;">
5350 <h4><a name="taint" id="taint"></a>-taint</h4>
5351</div>
5352
5353<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>Mark the image as modified even if it isn't.</td><td style='text-align:right;'></td></tr></table>
5354
5355<div style="margin: auto;">
5356 <h4><a name="text-font" id="text-font"></a>-text-font <em class="arg">name</em></h4>
5357</div>
5358
5359<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>
5360
5361<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>
5362
5363<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>
5364
5365<div style="margin: auto;">
5366 <h4><a name="texture" id="texture"></a>-texture <em class="arg">filename</em></h4>
5367</div>
5368
5369<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>
5370
5371<div style="margin: auto;">
5372 <h4><a name="threshold" id="threshold"></a>-threshold <em class="arg">value</em>{<em class="arg">%</em>}</h4>
5373</div>
5374
5375<!-- {<em class="arg">green,blue,opacity</em>}
5376<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>
5377-->
5378
5379<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>
5380
5381<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>
5382
5383<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.
5384</p>
5385
5386<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>
5387
5388<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert in.png -channel red -threshold 50% out.png</span></p>
5389<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>
5390
5391
5392<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>
5393<p>Note that the values of the transparency channel is treated as 'matte'
5394values (0 is opaque) and not as 'alpha' values (0 is transparent).</p>
5395
5396<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>.
5397</p>
5398
5399<div style="margin: auto;">
5400 <h4><a name="thumbnail" id="thumbnail"></a>-thumbnail <em class="arg">geometry</em></h4>
5401</div>
5402
5403<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>
5404
5405<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>
5406
5407<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>
5408
5409<div style="margin: auto;">
5410 <h4><a name="tile" id="tile"></a>-tile <em class="arg">filename</em></h4>
5411</div>
5412
5413<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>
5414
5415<div style="margin: auto;">
5416 <h4>-tile <em class="arg">geometry</em></h4>
5417</div>
5418
5419<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>
5420
5421<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>
5422
5423<div style="margin: auto;">
5424 <h4>-tile</h4>
5425</div>
5426
5427<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>
5428
5429<div style="margin: auto;">
5430 <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>
5431</div>
5432
5433<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>
5434
5435<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>
5436
5437<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>
5438
5439<div style="margin: auto;">
5440 <h4><a name="tint" id="tint"></a>-tint <em class="arg">value</em></h4>
5441</div>
5442
5443<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>
5444
5445<p>Tint the image with the fill color.</p>
5446
5447<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>
5448
5449<div style="margin: auto;">
5450 <h4><a name="title" id="title"></a>-title <em class="arg">string</em></h4>
5451</div>
5452
5453<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>
5454
5455<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>
5456
5457<p>For example,</p>
5458
5459<p class="crtsnip">
5460 -title "%m:%f %wx%h"
5461</p>
5462
5463<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>
5464
5465
5466<div style="margin: auto;">
5467 <h4><a name="transform" id="transform"></a>-transform</h4>
5468</div>
5469
5470<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>
5471
5472<p>This option applies the transformation matrix from a previous <a href="#affine">-affine</a> option.</p>
5473
5474<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>
5475<div style="margin: auto;">
5476 <h4><a name="transparent" id="transparent"></a>-transparent <em class="arg">color</em></h4>
5477</div>
5478
5479<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>
5480
5481<p>The <em class="arg">color</em> argument is defined using the format
5482described under the <a href="#fill">-fill</a> option. The <a href="#fuzz"
5483>-fuzz</a> setting can be used to match and replace colors similar to the one
5484given. </p>
5485
cristyb36feb22010-03-26 16:54:37 +00005486<p>Use <a href="#transparent" >+transparent</a> to invert the pixels matched.
5487that is make all non-matching colors transparent. </p>
5488
cristy3ed852e2009-09-05 21:47:34 +00005489<p>The <a href="#opaque">-opaque</a> operator is exactly the same as <a
cristyb36feb22010-03-26 16:54:37 +00005490href="#transparent" >-transparent</a> but replaces the matching color with the
5491current <a href="#fill">-fill</a> color setting, rather than transparent.
5492However the <a href="#transparent" >-transparent</a> operator also ensures
5493that the image has an alpha channel enabled, as per "<kbd><a href="#alpha"
5494>-alpha</a> set</kbd>", and does not require you to modify the <a
5495href="#channel">-channel</a> to enable alpha channel handling. </p>
cristy3ed852e2009-09-05 21:47:34 +00005496
cristyb36feb22010-03-26 16:54:37 +00005497<p>Note that this does not define the color as being the 'transparency color'
5498used for color-mapped image formats, such as GIF. For that use <a
5499href="#transparent-color" >-transparent-color</a> </p>
cristy3ed852e2009-09-05 21:47:34 +00005500
5501
5502<div style="margin: auto;">
5503 <h4><a name="transparent-color" id="transparent-color"></a>-transparent-color <em class="arg">color</em></h4>
5504</div>
5505
5506<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>
5507
5508<p>Sometimes this is used for saving to image formats such as
5509GIF and PNG8 which uses this color to represent boolean transparency. This
5510does not make a color transparent, it only defines what color the transparent
5511color is in the color palette of the saved image. Use <a
5512href="#transparent">-transparent</a> to make an opaque color transparent.</p>
5513
5514<p>This option allows you to have both an opaque visible color, as well as a
5515transparent color of the same color value without conflict. That is, you can
5516use the same color for both the transparent and opaque color areas within an
5517image. This, in turn, frees to you to select a transparent color that is
5518appropriate when an image is displayed by an application that does not handle a
5519transparent color index, while allowing ImageMagick to correctly handle images of this
5520type. </p>
5521
5522<p>The default transparent color is <kbd>#00000000</kbd>, which is fully transparent black.</p>
5523
5524<div style="margin: auto;">
5525 <h4><a name="transpose" id="transpose"></a>-transpose</h4>
5526</div>
5527
5528<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>
5529
5530<p> This option mathematically transposes the pixel array. It is equivalent to the sequence <kbd>-flip -rotate 90</kbd>.
5531</p>
5532
5533<div style="margin: auto;">
5534 <h4><a name="transverse" id="transverse"></a>-transverse</h4>
5535</div>
5536
5537<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>
5538
5539
5540<div style="margin: auto;">
5541 <h4><a name="treedepth" id="treedepth"></a>-treedepth <em class="arg">value</em></h4>
5542</div>
5543
5544<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>
5545
5546<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>
5547
5548<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>
5549
5550<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>
5551
5552<div style="margin: auto;">
5553 <h4><a name="trim" id="trim"></a>-trim</h4>
5554</div>
5555
5556<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>
5557
5558<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>
5559
5560<p>The page or virtual canvas information of the image is preserved allowing
5561you to extract the result of the <a href="#trim">-trim</a> operation from the
5562image. Use a <a href="#repage">+repage</a> to remove the virtual canvas page
5563information if it is unwanted.</p>
5564
5565<p>If the trimmed image 'disappears' an warning is produced, and a special
5566single pixel transparent 'missed' image is returned, in the same way as when a
5567<a href="#crop">-crop</a> operation 'misses' the image proper. </p>
5568
5569
5570<div style="margin: auto;">
5571 <h4><a name="type" id="type"></a>-type <em class="arg">type</em></h4>
5572</div>
5573
5574<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>
5575 <p>Choose from: <kbd>Bilevel</kbd>, <kbd>Grayscale</kbd>, <kbd>GrayscaleMatte</kbd>, <kbd>Palette</kbd>, <kbd>PaletteMatte</kbd>, <kbd>TrueColor</kbd>, <kbd>TrueColorMatte</kbd>, <kbd>ColorSeparation</kbd>, <kbd>ColorSeparationMatte</kbd>, or <kbd>Optimize</kbd>.</p>
5576
5577<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>
5578
5579<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert bird.png -type TrueColor bird.jpg</span></p>
5580<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>
5581
5582<p>Use <a href="#type">-type optimize</a> to ensure the image is written in the smallest possible file size.</p>
5583
5584<div style="margin: auto;">
5585 <h4><a name="undercolor" id="undercolor"></a>-undercolor <em class="arg">color</em></h4>
5586</div>
5587
5588<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>
5589
5590<p>The color is specified using the format described under the <a href="#fill">-fill</a> option.</p>
5591
5592<p>See <a href="#draw">-draw</a> for further details.</p>
5593
5594
5595<div style="margin: auto;">
5596 <h4><a name="update" id="update"></a>-update <em class="arg">seconds</em></h4>
5597</div>
5598
5599<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>
5600
5601<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>
5602
5603
5604<div style="margin: auto;">
5605 <h4><a name="unique-colors" id="unique-colors"></a>-unique-colors</h4>
5606</div>
5607
5608<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>
5609
5610
5611<div style="margin: auto;">
5612 <h4><a name="units" id="units"></a>-units <em class="arg">type</em></h4>
5613</div>
5614
5615<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>
5616
5617<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>
5618
5619
5620<div style="margin: auto;">
5621 <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>
5622</div>
5623
5624<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>
5625
5626<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>
5627
5628<p>The parameters are:</p>
5629
5630<pre class="text">
5631 radius: The radius of the Gaussian, in pixels, not counting the center
5632 pixel (default 0).
5633 sigma: The standard deviation of the Gaussian, in pixels (default 1.0).
5634 amount: The fraction of the difference between the original and the blur
5635 image that is added back into the original (default 1.0).
5636 threshold: The threshold, as a fraction of <em class="QR">QuantumRange</em>, needed to apply the
5637 difference amount (default 0.05).
5638</pre>
5639
5640
5641<div style="margin: auto;">
5642 <h4><a name="verbose" id="verbose"></a>-verbose</h4>
5643</div>
5644
5645<table style='background-color:#FFFFE0; margin-left:40px; margin-right:40px; width:88%'><tr><td style='width:75%'>print detailed information about the image when this option preceds the <a href="#identify">-identify</a> option or <kbd>info:</kbd>.</td><td style='text-align:right;'></td></tr></table>
5646
5647
5648<div style="margin: auto;">
5649 <h4><a name="version" id="version"></a>-version</h4>
5650</div>
5651
5652<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>
5653
5654
5655<div style="margin: auto;">
5656 <h4><a name="view" id="view"></a>-view <em class="arg">string</em></h4>
5657</div>
5658
5659<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>
5660
5661
5662<div style="margin: auto;">
5663 <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>
5664</div>
5665
5666<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>
5667
5668
5669<div style="margin: auto;">
5670 <h4><a name="virtual-pixel" id="virtual-pixel"></a>-virtual-pixel <em class="arg">method</em></h4>
5671</div>
5672
5673<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>
5674
5675<p>This option defines what color source should be used if and when a color
5676lookup completely 'misses' the source image. The color(s) that appear to
5677surround the source image. Generally this color is derived from the source
5678image, but could also be set to a specify background color. </p>
5679
5680<p>Choose from these methods:</p>
5681
5682<pre class="text">
5683 background: the area surrounding the image is the background color
5684 black: the area surrounding the image is black
5685 checker-tile: alternate squares with image and background color
5686 dither: non-random 32x32 dithered pattern
5687 edge: extend the edge pixel toward infinity
5688 gray: the area surrounding the image is gray
5689 horizontal-tile: horizontally tile the image, background color above/below
5690 horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
5691 mirror: mirror tile the image
5692 random: choose a random pixel from the image
5693 tile: tile the image (default)
5694 transparent: the area surrounding the image is transparent blackness
5695 vertical-tile: vertically tile the image, sides are background color
5696 vertical-tile-edge: vertically tile the image and replicate the side edge pixels
5697 white: the area surrounding the image is white
5698</pre>
5699
5700<p>The default value is "edge".</p>
5701
5702<p>This most important for distortion operators such as <a href="#distort"
5703>-distort</a>, <a href="#implode" >-implode</a>, and <a href="#fx" >-fx</a>.
5704However it also effects operations that may access pixels just outside the
5705image proper, such as <a href="#convolve">-convolve</a>, <a
5706href="#blur">-blur</a>, and <a href="#sharpen">-sharpen</a>. </p>
5707
5708<p>To print a complete list of virtual pixel types, use the <a href="#list">-list virtual-pixel</a> option.</p>
5709
5710
5711<div style="margin: auto;">
5712 <h4><a name="visual" id="visual"></a>-visual <em class="arg">type</em></h4>
5713</div>
5714
5715<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>
5716
5717<p>Choose from these visual classes:</p>
5718
5719<pre class="text">
5720 StaticGray
5721 GrayScale
5722 StaticColor
5723 PseudoColor
5724 TrueColor
5725 DirectColor
5726 default
5727 visual id
5728</pre>
5729
5730<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>
5731
5732
5733<div style="margin: auto;">
5734 <h4><a name="watermark" id="watermark"></a>-watermark <em
5735 class="arg">brightness</em>x<em class="arg">saturation</em></h4>
5736</div>
5737
5738<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
5739saturation.</td><td style='text-align:right;'>[<a href="../www/composite.html">composite</a>]</td></tr></table>
5740
5741<p>Take a grayscale image (with alpha mask) and modify the destination image's
5742brightness according to watermark image's grayscale value and the <em
5743class="arg">brightness</em> percentage. The destinations color saturation
5744attribute is just direct modified by the <em class="arg">saturation</em>
5745percentage, which defaults to 100 percent (no color change). </p>
5746
5747
5748<div style="margin: auto;">
5749 <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>
5750</div>
5751
5752<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>
5753
5754<p>Specify <em class="arg">amplitude</em> and <em class="arg">wavelength</em> of the wave.</p>
5755
5756<div style="margin: auto;">
5757 <h4><a name="weight" id="weight"></a>-weight <em class="arg">fontWeight</em></h4>
5758</div>
5759
5760<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>
5761
5762<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>
5763
5764<table class="doc">
5765 <col width="25%" />
5766 <col width="75%" />
5767 <thead>
5768 <tr>
5769 <th><em class="arg">fontWeight</em></th>
5770 <th>Description</th>
5771 </tr>
5772 </thead>
5773 <tbody>
5774 <tr><td>All </td> <td>No effect. </td></tr>
5775 <tr><td>Bold </td> <td>Same as <em class="arg">fontWeight</em> = 700.</td></tr>
5776 <tr><td>Bolder </td> <td>Add 100 to font weight if currently &le; 800.</td></tr>
5777 <tr><td>Lighter </td> <td>Subtract 100 to font weight if currently &le; 100.</td></tr>
5778 <tr><td>Normal </td> <td>Same as <em class="arg">fontWeight</em> = 400.</td></tr>
5779 </tbody>
5780 </table>
5781
5782<p>To print a complete list of weight types, use <a href="#list">-list weight</a>.</p>
5783
5784<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>
5785
5786<div style="margin: auto;">
5787 <h4><a name="white-point" id="white-point"></a>-white-point <em class="arg">x,y</em></h4>
5788</div>
5789
5790<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>
5791
5792<div style="margin: auto;">
cristy5cadd612009-09-21 19:33:41 +00005793 <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 +00005794</div>
5795
cristy5cadd612009-09-21 19:33:41 +00005796<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>
5797
5798<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.
5799</p>
cristy3ed852e2009-09-05 21:47:34 +00005800
5801<div style="margin: auto;">
5802 <h4><a name="window" id="window"></a>-window <em class="arg">id</em></h4>
5803</div>
5804
5805<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>
5806
5807<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>
5808
5809<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>
5810
5811<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>
5812
5813<div style="margin: auto;">
5814 <h4><a name="window-group" id="window-group"></a>-window-group</h4>
5815</div>
5816
5817<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>
5818
5819<div style="margin: auto;">
5820 <h4><a name="write" id="write"></a>-write <em class="arg">filename</em></h4>
5821</div>
5822
5823<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>
5824 <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>
5825
5826<p>Use <a href="#compress">-compress</a> to specify the type of image compression.</p>
5827
cristy3eaa0ef2010-03-06 20:35:26 +00005828
5829</div>
5830
5831<div id="linkbar">
5832 <!-- <span id="linkbar-west">&nbsp;</span> -->
5833 <span id="linkbar-center">
5834 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristyb36feb22010-03-26 16:54:37 +00005835 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +00005836 </span>
5837 <span id="linkbar-east">&nbsp;</span>
5838 </div>
5839 <div class="footer">
5840 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
5841 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
5842 </div>
5843 <div style="clear: both; margin: 0; width: 100%; "></div>
5844</body>
5845</html>