command-line-processing.html revision 8adecc3e64c966c3a62c31411cc2ba16451ca86d
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" 2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr"> 4<head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> 6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/> 7 <title>ImageMagick: Command-line Processing</title/> 8 <meta http-equiv="Content-Language" content="en-US"/> 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> 10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/> 11 <meta name="Application-name" content="ImageMagick"/> 12 <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."/> 13 <meta name="Application-url" content="http://www.imagemagick.org"/> 14 <meta name="Generator" content="PHP"/> 15 <meta name="Keywords" content="command-line, processing, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/> 16 <meta name="Rating" content="GENERAL"/> 17 <meta name="Robots" content="INDEX, FOLLOW"/> 18 <meta name="Generator" content="ImageMagick Studio LLC"/> 19 <meta name="Author" content="ImageMagick Studio LLC"/> 20 <meta name="Revisit-after" content="2 DAYS"/> 21 <meta name="Resource-type" content="document"/> 22 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/> 23 <meta name="Distribution" content="Global"/> 24 <link rel="icon" href="/images/wand.png" sizes="32x32"/> 25 <link rel="shortcut icon" href="/images/wand.ico" type="images/x-icon"/> 26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/> 27 <style type="text/css" media="all"> 28 @import url("/www/magick.css"); 29 </style> 30</head> 31 32<body id="www-imagemagick-org"> 33<div class="titlebar"> 34<a href="/index.html"> 35 <img src="/images/script.png" alt="[ImageMagick]" 36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a> 37<a href="http://www.networkredux.com"> 38 <img src="/images/networkredux.png" alt="[sponsor]" 39 style="margin: 45px auto; border: 0px; float: left;" /></a> 40<a href="http://www.imagemagick.org/discourse-server/"> 41 <img src="/images/logo.jpg" alt="" 42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a> 43<a href="/index.html"> 44 <img src="/images/sprite.jpg" alt="" 45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a> 46</div> 47 48<div class="westbar"> 49 50<div class="menu"> 51 <a title="About ImageMagick" href="/index.html">About ImageMagick</a> 52</div> 53<div class="sep"></div> 54<div class="menu"> 55 <a title="Binary Releases" href="/www/binary-releases.html">Binary Releases</a> 56</div> 57<div class="sub"> 58 <a title="Binary Release: Unix" href="/www/binary-releases.html#unix">Unix</a> 59</div> 60<div class="sub"> 61 <a title="Binary Release: MacOS X" href="/www/binary-releases.html#macosx">Mac OS X</a> 62</div> 63<div class="sub"> 64 <a title="Binary Release: Windows" href="/www/binary-releases.html#windows">Windows</a> 65</div> 66<div class="sep"></div> 67<div class="menu"> 68 <a title="Command-line Tools" href="/www/command-line-tools.html">Command-line Tools</a> 69</div> 70<div class="sub"> 71 <a title="Command-line Tools: Processing" href="/www/command-line-processing.html">Processing</a> 72</div> 73<div class="sub"> 74 <a title="Command-line Tools: Options" href="/www/command-line-options.html">Options</a> 75</div> 76<div class="sub"> 77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a> 78</div> 79<div class="menu"> 80 <a title="Program Interfaces" href="/www/api.html">Program Interfaces</a> 81</div> 82<div class="sub"> 83 <a title="Program Interface: MagickWand" href="/www/magick-wand.html">MagickWand</a> 84</div> 85<div class="sub"> 86 <a title="Program Interface: MagickCore" href="/www/magick-core.html">MagickCore</a> 87</div> 88<div class="sub"> 89 <a title="Program Interface: PerlMagick" href="/www/perl-magick.html">PerlMagick</a> 90</div> 91<div class="sub"> 92 <a title="Program Interface: Magick++" href="/Magick++/">Magick++</a> 93</div> 94<div class="sep"></div> 95<div class="menu"> 96 <a title="Install from Source" href="/www/install-source.html">Install from Source</a> 97</div> 98<div class="sub"> 99 <a title="Install from Source: Unix" href="/www/install-source.html#unix">Unix</a> 100</div> 101<div class="sub"> 102 <a title="Install from Source: Windows" href="/www/install-source.html#windows">Windows</a> 103 </div> 104<div class="menu"> 105 <a title="Resources" href="/www/resources.html">Resources</a> 106</div> 107<div class="menu"> 108 <a title="Architecture" href="/www/architecture.html">Architecture</a> 109</div> 110<div class="menu"> 111 <a title="Download" href="/www/download.html">Download</a> 112</div> 113<div class="sep"></div> 114<div class="menu"> 115 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a> 116</div> 117<div class="sep"></div> 118<div class="menu"> 119 <a title="Site Map"href="/www/sitemap.html">Site Map</a> 120</div> 121<div class="sub"> 122 <a title="Site Map: Links"href="/www/links.html">Links</a> 123</div> 124<div class="sep"></div> 125<div class="menu"> 126 <a title="Sponsors" href="/www/sponsors.html">Sponsors:</a> 127 128<div class="sponsbox"> 129<div class="sponsor"> 130 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 --> 131</div> 132<div class="sponsor"> 133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 --> 134</div> 135<div class="sponsor"> 136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee--> 137</div> 138<div class="sponsor"> 139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter--> 140</div> 141<div class="sponsor"> 142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de--> 143</div> 144<div class="sponsor"> 145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 --> 146</div> 147<div class="sponsor"> 148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen--> 149</div> 150<div class="sponsor"> 151 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de--> 152</div> 153</div> 154</div> 155</div> 156 157<div class="eastbar"> 158 <script type="text/javascript"> 159 <!-- 160 google_ad_client = "pub-3129977114552745"; 161 google_ad_slot = "0574824969"; 162 google_ad_width = 160; 163 google_ad_height = 600; 164 //--> 165 </script> 166 <script type="text/javascript" 167 src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 168 </script> 169</div> 170 171<div class="main"> 172 173 174 175 176<p class="navigation-index">[<a href="#anatomy">The Anatomy of the Command Line</a> • <a href="#input">Input Filename</a> • <a href="#setting">Image Setting</a> • <a href="#operator">Image Operator</a> • <a href="#sequence">Image Sequence Operator</a> • <a href="#geometry">Image Geometry</a> • <a href="#stack">Image Stack</a> • <a href="#output">Output Filename</a>]</p> 177 178<p>The ImageMagick command line can be as simple as this.</p> 179 180<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert image.jpg image.png</span></p> 181<p>Or it can be very complex, as in the following.</p> 182 183<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert label.gif +matte \ <br/> 184 \( +clone -shade 110x90 -normalize -negate +clone -compose Plus -composite \) \<br/> 185 \( -clone 0 -shade 110x50 -normalize -channel BG -fx 0 +channel -matte \) \<br/> 186 -delete 0 +swap -compose Multiply -composite button.gif</span></p> 187<p>Without knowing much about the ImageMagick command line, you can probably figure out that the first command above converts an image in the JPEG format to one in the PNG format. However, very few may realize the second, more complex command, gives a flat two-dimensional label a three-dimensional look with rich textures and simulated depth:</p> 188 189<div class="image"> 190<p> 191 <a href="/images/label.gif"><img src="/images/label.gif" width="78" height="53" alt="label" /></a> 192<img style="margin-top:16px; margin-bottom:17px;" src="/images/right.gif" width="20" height="20" alt="==>" /> 193 <a href="/images/button.gif"> 194 <img src="/images/button.gif" width="78" height="53" alt="button" /></a> 195</p> 196</div> 197 198<p class="warn">[<em>A quick word about our formatting of commands:</em> The second example above is long enough that the command must be written across several lines, so we have formatted it for clarity by inserting backslashes (<kbd>\</kbd>). The backslash is the Unix <em>line continuation</em> character. In the Windows shell, a carat character (<kbd>^</kbd>) may be used for line continuation. We will use the Unix style on these web pages, as above. Sometimes, however, the lines may be wrapped by your browser if the browser window is small enough, but the command lines, shown in white, are still intended to be typed as one line. Line continuation characters need not be entered. The <em>parentheses</em> that are <em>escaped</em> above using the backslash are not escaped in Windows. There are some other differences between Windows and Unix (involving quotation marks, for instance), but we'll discuss some of those issues later, as they arise.]</p> 199 200 201<p>In the next sections we dissect the anatomy of the ImageMagick command line. Hopefully, after carefully reading and better understanding how the command line works, you should be able to accomplish complex image-processing tasks without resorting to the sometimes daunting <a href="/www/api.html">program interfaces</a>.</p> 202 203<p>See <a href="http://www.imagemagick.org/Usage/">Examples of ImageMagick Usage</a> for additional help when using ImageMagick from the command-line.</p> 204 205<h2><a name="anatomy"></a>The Anatomy of the Command Line</h2> 206<p>The ImageMagick command line consists of</p> 207 208<ol> 209<li>one or more required input filenames.</li> 210<li>zero, one, or more image settings.</li> 211<li>zero, one, or more image operators.</li> 212<li>zero, one, or more image sequence operators.</li> 213<li>zero, one, or more image stacks.</li> 214<li>zero or one output image filenames (required by 215 <a href="/www/convert.html">convert</a>, 216 <a href="/www/composite.html">composite</a>, 217 <a href="/www/montage.html.html">montage.html</a>, 218 <a href="/www/compare.html">compare</a>, 219 <a href="/www/import.html">import</a>, 220 <a href="/www/conjure.html">conjure</a>). 221 </li> 222</ol> 223 224<p>You can find a detailed explanation of each of the constituent parts of the command line in the sections that follow.</p> 225 226<h2><a name="input"></a>Input Filename</h2> 227<div class="doc-section"> 228 229 <p>ImageMagick extends the concept of an input filename to include:</p> 230 <ul> 231 <li>filename globbing</li> 232 <li>an explicit image format</li> 233 <li>using built-in images and patterns</li> 234 <li>STDIN, STDOUT, and file descriptors</li> 235 <li>selecting certain frames from an image</li> 236 <li>selecting a region of an image</li> 237 <li>forcing an inline image resize</li> 238 <li>forcing an inline image crop</li> 239 <li>using filename references</li> 240 </ul> 241 242 <p>These extensions are explained in the next few paragraphs.</p> 243 244 <h3>Filename Globbing</h3> 245 <div class="doc-section"> 246 <p>In Unix shells, certain characters such as the asterisk (<kbd>*</kbd>) and question mark (<kbd>?</kbd>) automagically cause lists of filenames to be generated based on pattern matches. This feature is known as globbing. ImageMagick supports filename globbing for systems, such as Windows, that does not natively support it. For example, suppose you want to convert <kbd>1.jpg</kbd>, <kbd>2.jpg</kbd>, <kbd>3.jpg</kbd>, <kbd>4.jpg</kbd>, and <kbd>5.jpg</kbd> in your current directory to a GIF animation. You can conveniently refer to all of the JPEG files with this command: 247 </p> 248 249 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert *.jpg images.gif</span></p> 250 </div> 251 252 <h3>Explicit Image Format</h3> 253 <div class="doc-section"> 254 <p>Images are stored in a myriad of image formats including 255the better known JPEG, PNG, TIFF and others. ImageMagick must know the format 256of the image before it can be read and processed. Most formats have a 257signature within the image that uniquely identifies the format. Failing 258that, ImageMagick leverages the filename extension to determine the format. 259For example, <kbd>image.jpg</kbd> or <kbd>image.JPG</kbd> tells ImageMagick 260it is reading an image in the JPEG format. </> 261 262 <p>In some cases the image may not contain a signature 263and/or the filename does not identify the image format. In these cases an 264explicit image format must be specified. For example, suppose our image 265is named <kbd>image</kbd> and contains raw red, green, and blue intensity 266values. ImageMagick has no way to automagically determine the image format 267so we explicitly set one: 268 </p> 269 270 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert -size 640x480 -depth 8 rgb:image image.png</span></p> 271 </div> 272 273 <h3>Built-in Images and Patterns</h3> 274 <div class="doc-section"> 275 <p>ImageMagick has a number of built-in <a href="/www/formats.html#builtin-images">images</a> and <a href="/www/formats.html#builtin-patterns">patterns</a>. To utilize the checkerboard pattern, for example, use: 276 </p> 277 278 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert -size 640x480 pattern:checkerboard checkerboard.png</span></p> 279 </div> 280 281 <h3>STDIN, STDOUT, and file descriptors</h3> 282 <div class="doc-section"> 283 <p>Unix and Windows permit the output of one command to be piped to the input of another. ImageMagick permits image data to be read and written from the <a href="http://en.wikipedia.org/wiki/Standard_streams">standard streams</a> STDIN (<em>standard in</em>) and STDOUT (<em>standard out</em>), respectively, using a pseudo-filename of <kbd>-</kbd>. In this example we pipe the output of 284 <a href="/www/convert.html">convert</a> to the <a href="/www/display.html">display</a> program: 285 </p> 286 287 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: gif:- | display gif:-</span></p> 288 <p>The second explicit format "<kbd>gif:</kbd>" is optional in the preceding example. The GIF image format has a unique signature within the image so ImageMagick's <a href="/www/display.html">display</a> command can readily recognize the format as GIF. The <a href="/www/convert.html">convert</a> program also accepts STDIN as input in this way: 289 </p> 290 291 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert rose: gif:- | convert - -resize "200%" bigrose.jpg</span></p> 292 <p>Other pipes can be accessed via their <em>file descriptors</em> (as of version 6.4.9-3). The file descriptors 0, 1, and 2 are reserved for the standard streams STDIN, STDOUT, and STDERR, respectively, but a pipe associated with a file descriptor number <em>N</em>>2 can be accessed using the pseudonym <kbd>fd:</kbd><em>N</em>. (The pseudonyms <kbd>fd:0</kbd> and <kbd>fd:1</kbd> can be used for STDIN and STDOUT.) The next example shows how to append image data piped from files with descriptors 3 and 4 and direct the result to the file with descriptor number 5. 293 </p> 294 295 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert fd:3 fd:4 -append fd:5</span></p> 296 <p>When needed, explicit image formats can be given as mentioned earlier, as in the following. 297 </p> 298 299 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert gif:fd:3 jpg:fd:4 -append tif:fd:5</span></p> 300 </div> 301 302 <h3>Selecting Frames</h3> 303 <div class="doc-section"> 304 <p>Some images formats contain more than one image frame. Perhaps you only want the first image, or the last, or some number of images in-between. You can specify which image frames to read by appending the image filename with the frame range enclosed in brackets. Here our image (an animated GIF) contains more than one frame but we only want the first: 305 </p> 306 307 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert 'images.gif[0]' image.png</span></p> 308 <p class="warn">[Unix shells generally interpret brackets so we enclosed the filename in quotes above. 309In a Windows command shell the brackets are not interpreted but using quotes doesn't hurt. However, in most cases the roles of single-quotes and double-quotes are reversed with respect to Unix and Windows, so Windows users should usually try double-quotes where we display single-quotes, and vice versa.] 310 </p> 311 312 <p>You can read more than one image from a sequence with a frame range. For example, you can extract the first four frames of an image sequence: 313 </p> 314 315 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert 'images.gif[0-3]' images.mng</span></p> 316 <p>Finally, you can read more than one image from a sequence, out-of-order. The next command gets the third image in the sequence, followed by the second, and then the fourth: 317 </p> 318 319 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert 'images.gif[3,2,4]' images.mng</span></p> 320 <p>Notice that in the last two commands, a single image is written. The output in this case, where the image type is MNG, is a multi-frame file because the MNG format supports multiple frames. Had the output format been JPG, which only supports single frames, the output would have consisted of separate frames. More about that below, in the section about the <a href="#output">Output Filename</a>. 321 </p> 322 </div> 323 324 <h3>Selecting an Image Region</h3> 325 <div class="doc-section"> 326 <p>Raw images are a sequence of color intensities without additional meta information such as width, height, or image signature. With raw image formats, you must specify the image width and height but you can also specify a region of the image to read. In our example, the image is in the raw 8-bit RGB format and is 6000 pixels wide and 4000 pixels high. However, we only want a region of 600 by 400 near the center of the image: 327 </p> 328 329 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert -size 6000x4000 -depth 8 \ <br/> 'rgb:image[600x400+1900+2900]' image.jpg</span></p> 330 <p> 331 You can get the same results with the <a href="/www/command-line-options.html#extract">‑extract</a> option: 332 </p> 333 334 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert -size 6000x4000 -depth 8 \ <br/> -extract 600x400+1900+2900 rgb:image image.jpg</span></p> 335 </div> 336 337 <h3>Inline Image Resize</h3> 338 <div class="doc-section"> 339 <p>It is sometimes convenient to resize an image as they are read. Suppose you have hundreds of large JPEG images you want to convert to a sequence of PNG thumbails: 340 </p> 341 342 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert '*.jpg' -resize 120x120 thumbnail%03d.png</span></p> 343 <p>Here <em>all</em> the images are read and subsequently 344resized. It is faster and less resource intensive to resize each image it 345is read: 346 </p> 347 348 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert '*.jpg[120x120]' thumbnail%03d.png</span></p> 349 </div> 350 351 <h3>Inline Image Crop</h3> 352 <div class="doc-section"> 353 <p>It is sometimes convenient to crop an image as they are read. Suppose you have hundreds of large JPEG images you want to convert to a sequence of PNG thumbails: 354 </p> 355 356 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert '*.jpg' -crop 120x120+10+5 thumbnail%03d.png</span></p> 357 <p>Here <em>all</em> the images are read and subsequently cropped. It is faster and less resource-intensive to crop each image as it is read: 358 </p> 359 360 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert '*.jpg[120x120+10+5]' thumbnail%03d.png</span></p> 361 </div> 362 363 <h3>Filename References</h3> 364 <div class="doc-section"> 365 <p>There are two methods to use a filename to reference other image filenames. 366 The first is with '<kbd>@</kbd>' which reads image filenames from the specified file. Assume the file <kbd>myimages.txt</kbd> consists of a list of filenames, like so: 367 </p> 368 369 <p class="text"> 370 frame001.jpg <br/> 371 frame002.jpg <br/> 372 frame003.jpg <br/> 373 374 </p> 375 376 <p>Then with the following command, ImageMagick reads the images <kbd>image-1.jpg</kbd>, <kbd>image-2.jpg</kbd>, and <kbd>image-3.jpg</kbd>. </p> 377 378 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert @myimages.txt mymovie.gif</span></p> 379 <p>Some ImageMagick command-line options may exceed the capabilities of 380your command line processor. Windows, for example, limits command lines 381to 8192 characters. If, for example, you have a draw option with polygon 382points that exceed the command-line length limit, put the draw option instead 383in a file and reference the file with 384the <kbd>@</kbd> (e.g. <kbd>@mypoly.txt</kbd>).</p> 385 386 <p>Another method of referring to other image files is by 387embedding a formatting character in the filename with a scene range. Consider 388the filename <kbd>image-%d.jpg[1-5]</kbd>. The command</p> 389 390 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert image-%d.jpg[1-5]</span></p> 391 <p>causes ImageMagick to attempt to read images with these filenames: 392 </p> 393 394 <p class="text"> 395 image-1.jpg <br/> 396 image-2.jpg <br/> 397 image-3.jpg <br/> 398 image-4.jpg <br/> 399 image-5.jpg 400 </p> 401 402 </div> 403</div> 404 405 406<h2><a name="setting"></a>Image Setting</h2> 407<div class="doc-section"> 408 409<p>An image setting persists as it appears on the command line and may affect 410subsequent processing such as reading an image, an image operator, or when 411writing an image as appropriate. An image setting stays in effect until it 412is reset or the command line terminates. The image settings include:</p> 413 414<p class="options"> 415<a href="/www/command-line-options.html#adjoin">‑adjoin</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#affine">‑affine</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#alpha">‑alpha</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#antialias">‑antialias</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#authenticate">‑authenticate</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#background">‑background</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#bias">‑bias</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#black-point-compensation">‑black‑point‑compensation</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#blue-primary">‑blue‑primary</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#bordercolor">‑bordercolor</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#caption">‑caption</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#channel">‑channel</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#comment">‑comment</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#compress">‑compress</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#debug">‑debug</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#define">‑define</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#delay">‑delay</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#density">‑density</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#depth">‑depth</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#direction">‑direction</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#display">‑display</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#dispose">‑dispose</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#dither">‑dither</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#encoding">‑encoding</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#endian">‑endian</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#extract">‑extract</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#family">‑family</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#fill">‑fill</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#filter">‑filter</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#font">‑font</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#format">‑format</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#fuzz">‑fuzz</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#geometry">‑geometry</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#gravity">‑gravity</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#green-primary">‑green‑primary</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#interlace">‑interlace</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#intent">‑intent</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#interpolate">‑interpolate</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#label">‑label</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#limit">‑limit</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#linewidth">‑linewidth</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#log">‑log</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#loop">‑loop</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#mask">‑mask</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#mattecolor">‑mattecolor</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#monitor">‑monitor</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#orient">‑orient</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#page">‑page</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#pointsize">‑pointsize</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#preview">‑preview</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#quality">‑quality</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#quiet">‑quiet</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#red-primary">‑red‑primary</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#region">‑region</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#render">‑render</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#repage">‑repage</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#sampling-factor">‑sampling‑factor</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#scene">‑scene</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#seed">‑seed</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#size">‑size</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#stretch">‑stretch</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#stroke">‑stroke</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#strokewidth">‑strokewidth</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#style">‑style</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#texture">‑texture</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#tile">‑tile</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#transparent-color">‑transparent‑color</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#treedepth">‑treedepth</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#type">‑type</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#undercolor">‑undercolor</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#units">‑units</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#verbose">‑verbose</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#virtual-pixel">‑virtual‑pixel</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#weight">‑weight</a> </p> 416 417<p>In this example, <em class="arg">-channel</em> applies to each of the images, since, as we mentioned, settings persist: 418</p> 419 420<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert -channel RGB wand.png wizard.png images.png</span></p> 421</div> 422 423<h2><a name="operator"></a>Image Operator</h2> 424<div class="doc-section"> 425 426<p>An image operator differs from a setting in that it affects the image 427immediately as it appears on the command line. An operator is 428any <a href="/script../www/command-line-options.html">command line option</a> 429not listed as a <a href="#setting">image setting</a> 430or <a href="#sequence">image sequence operator</a>. Unlike an 431image setting, which persists until the command line terminates, 432an operator is applied to an image and forgotten. The image operators 433include:</p> 434 435<p class="options"> 436<a href="/www/command-line-options.html#annotate">‑annotate</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#black-threshold">‑black‑threshold</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#blur">‑blur</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#border">‑border</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#charcoal">‑charcoal</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#chop">‑chop</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#clip">‑clip</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#clip-path">‑clip‑path</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#clip-mask">‑clip‑mask</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#colors">‑colors</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#colorize">‑colorize</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#colorspace">‑colorspace</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#compose">‑compose</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#contrast">‑contrast</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#convolve">‑convolve</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#crop">‑crop</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#cycle">‑cycle</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#despeckle">‑despeckle</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#draw">‑draw</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#edge">‑edge</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#emboss">‑emboss</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#enhance">‑enhance</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#equalize">‑equalize</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#evaluate">‑evaluate</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#extent">‑extent</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#flip">‑flip</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#flop">‑flop</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#floodfill">‑floodfill</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#frame">‑frame</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#gamma">‑gamma</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#gaussian-blur">‑gaussian‑blur</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#implode">‑implode</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#lat">‑lat</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#level">‑level</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#map">‑map</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#median">‑median</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#modulate">‑modulate</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#monochrome">‑monochrome</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#negate">‑negate</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#noise">‑noise</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#normalize">‑normalize</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#opaque">‑opaque</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#ordered-dither">‑ordered‑dither</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#paint">‑paint</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#posterize">‑posterize</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#raise">‑raise</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#profile">‑profile</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#radial-blur">‑radial‑blur</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#raise">‑raise</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#random-threshold">‑random‑threshold</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#resample">‑resample</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#resize">‑resize</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#roll">‑roll</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#rotate">‑rotate</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#sample">‑sample</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#scale">‑scale</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#sepia-tone">‑sepia‑tone</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#segment">‑segment</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#shade">‑shade</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#shadow">‑shadow</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#sharpen">‑sharpen</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#shave">‑shave</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#shear">‑shear</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#sigmoidal-contrast">‑sigmoidal‑contrast</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#solarize">‑solarize</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#splice">‑splice</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#spread">‑spread</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#strip">‑strip</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#swirl">‑swirl</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#threshold">‑threshold</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#transparent">‑transparent</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#thumbnail">‑thumbnail</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#tint">‑tint</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#transform">‑transform</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#trim">‑trim</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#unsharp">‑unsharp</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#version">‑version</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#wave">‑wave</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#white-point">‑white‑point</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#white-threshold">‑white‑threshold</a> </p> 437 438<p>In this example, <em class="arg">-negate</em> negates the wand image but not the wizard:</p> 439 440<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert wand.png -negate wizard.png images.png</span></p></div> 441 442<h2><a name="sequence"></a>Image Sequence Operator</h2> 443<div class="doc-section"> 444 445<p>An image sequence operator differs from a setting in that it affects an 446image sequence immediately as it appears on the command line. Choose from 447these image sequence operators:</p> 448 449<p class="options"> 450<a href="/www/command-line-options.html#append">‑append</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#affinity">‑affinity</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#average">‑average</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#clut">‑clut</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#coalesce">‑coalesce</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#combine">‑combine</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#composite">‑composite</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#crop">‑crop</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#debug">‑debug</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#deconstruct">‑deconstruct</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#delete">‑delete</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#evaluate-seqence">‑evaluate‑seqence</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#fft">‑fft</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#flatten">‑flatten</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#fx">‑fx</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#hald-clut">‑hald‑clut</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#ift">‑ift</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#identify">‑identify</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#insert">‑insert</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#layers">‑layers</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#limit">‑limit</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#map">‑map</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#maximum">‑maximum</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#minimum">‑minimum</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#morph">‑morph</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#mosaic">‑mosaic</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#optimize">‑optimize</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#print">‑print</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#process">‑process</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#quiet">‑quiet</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#separate">‑separate</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#swap">‑swap</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#write">‑write</a> </p> 451</div> 452 453<h2><a name="geometry"></a>Image Geometry</h2> 454<div class="doc-section"> 455 456<p>Many command-line options take a <em class="arg">geometry</em> argument 457to specify such things as the desired width and height of an image and other 458dimensional quantities. Because users want so many variations on the resulting 459dimensions, sizes, and positions of images (and because ImageMagick wants to 460provide them), the <em class="arg">geometry</em> argument can take many 461forms. We describe many of these in this section. </p> 462 463<p>The image options and settings that take some form of 464a <em class="arg">geometry</em> argument include the following. 465Keep in mind that some of these parse their arguments in slightly 466different ways. See the documentation for the individual option or 467setting for more specifics.</p> 468 469<p class="options" style="text-align:justify"> 470<a href="/www/command-line-options.html#adaptive-resize">‑adaptive‑resize</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#border">‑border</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#borderwidth">‑borderwidth</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#chop">‑chop</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#crop">‑crop</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#density">‑density</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#extent">‑extent</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#extract">‑extract</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#frame">‑frame</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#geometry">‑geometry</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#iconGeometry">‑iconGeometry</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#liquid-rescale">‑liquid‑rescale</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#page">‑page</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#region">‑region</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#repage">‑repage</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#resize">‑resize</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#sample">‑sample</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#scale">‑scale</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#shave">‑shave</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#splice">‑splice</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#thumbnail">‑thumbnail</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#window">‑window</a> </p> 471 472<p>The <em class="arg">geometry</em> argument might take any of the forms listed in the table below. These will described in more detail in the subsections following the table. The usual form is <em class="arg">size</em>[<em class="arg">offset</em>], meaning <em class="arg">size</em> is required and <em class="arg">offset</em> is optional. Occasionally, [<em class="arg">size</em>]<em class="arg">offset</em> is possible. In no cases are spaces permitted within the <em class="arg">geometry</em> argument.</p> 473 474 475<table id="geometryTable" class="doc"> 476 <col width="20%"/> <col width="80%"/> 477 <thead> 478 <tr valign="top"> 479 <th style="text-align:center"><em class="arg">size</em></th> 480 <th>General description (actual behavior can vary for different options and settings)</th> 481 </tr> 482 </thead> 483 <tbody> 484 <tr valign="top"> 485 <td><em class="arg">scale</em>%</td> 486 <td>Height and width both scaled by specified percentage.</td> 487 </tr> 488 <tr valign="top"> 489 <td><em class="arg">scale-x</em>%x<em class="arg">scale-y</em>%</td> 490 <td>Height and width individually scaled by specified percentages. (Only one % symbol needed.)</td> 491 </tr> 492 <tr valign="top"> 493 <td><em class="arg">width</em></td> 494 <td>Width given, height automagically selected to preserve aspect ratio.</td> 495 </tr> 496 <tr valign="top"> 497 <td>x<em class="arg">height</em></td> 498 <td>Height given, width automagically selected to preserve aspect ratio.</td> 499 </tr> 500 <tr valign="top"> 501 <td><em class="arg">width</em>x<em class="arg">height</em></td> 502 <td>Maximum values of height and width given, aspect ratio preserved.</td> 503 </tr> 504 <tr valign="top"> 505 <td><em class="arg">width</em>x<em class="arg">height</em>^</td> 506 <td>Minimum values of width and height given, aspect ratio preserved.</td> 507 </tr> 508 <tr valign="top"> 509 <td><em class="arg">width</em>x<em class="arg">height</em>!</td> 510 <td>Width and height emphatically given, original aspect ratio ignored.</td> 511 </tr> 512 <tr valign="top"> 513 <td><em class="arg">width</em>x<em class="arg">height</em>></td> 514 <td>Change as per <em class="arg">width</em>x<em class="arg">height</em> but only if an image dimension exceeds a specified dimension.</td> 515 </tr> 516 <tr valign="top"> 517 <td><em class="arg">width</em>x<em class="arg">height</em><</td> 518 <td>Change dimensions only if both image dimensions exceed specified dimensions.</td> 519 </tr> 520 <tr valign="top"> 521 <td><em class="arg">area</em>@</td> 522 <td>Resize image to have specified area in pixels. Aspect ratio is preserved.</td> 523 </tr> 524 </tbody> 525 </table> 526 <table class="doc"> 527 <col width="20%"/> <col width="80%"/> 528 <thead> 529 <tr valign="top"> 530 <th style="text-align:center">{<em class="arg">size</em>}{<em class="arg">offset</em>}</th> 531 <th>Specifying the <em class="arg">offset</em> (default is <kbd>+0+0</kbd>). Below, {<em class="arg">size</em>} refers to any of the forms above.</th> 532 </tr> 533 </thead> 534 535 <tbody> 536 <tr valign="top"> 537 <td>{<em class="arg">size</em>}{<em class="arg">+-</em>}<em class="arg">x</em>{<em class="arg">+-</em>}<em class="arg">y</em></td> 538 <td>Horizontal and vertical offsets <em class="arg">x</em> and <em class="arg">y</em>, specified in pixels. Signs are required for both. Offsets are affected by <a href="/www/command-line-options.html#gravity">‑gravity</a> setting. Offsets are not affected by <kbd>%</kbd> or other <em class="arg">size</em> operators.</td> 539 </tr> 540 </tbody> 541</table> 542 543 544<h3>Basic adjustments to width and height; the operators <kbd>%</kbd>, <kbd>^</kbd>, and <kbd>!</kbd> </h3> 545 <div class="doc-section"> 546 <p>Here, just below, are a few simple examples of <em class="arg">geometry</em>, showing how it might be used as an argument to the <a href="/www/command-line-options.html#resize">‑resize</a> option. We'll use the internal image <kbd>logo:</kbd> for our input image. 547 <a href="/images/logo-fullsize.png"> 548 This fine image</a> is 640 pixels wide and 480 pixels high. We say its <em>dimensions</em> are 640x480. When we give dimensions of an image, the width (the horizontal dimension) always precedes the height (the vertical dimension). This will be true when we speak of coordinates or <em>offsets</em> into an image, which will always be <em>x</em>–value followed by <em>y</em>. Just think of your high school algebra classes and the <em>xy</em>–plane. (Well, almost: our <em>y</em>–axis will always go downward!) 549 </p> 550 551 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '200%' bigWiz.png</span></p> 552 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '200x50%' longShortWiz.png</span></p> 553 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100x200' notThinWiz.png</span></p> 554 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100x200^' biggerNotThinWiz.png</span></p> 555 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100x200!' dochThinWiz.png</span></p> 556 557 <p>The first of the four commands is simple—it stretches both the width and height of the input image by <kbd>200%</kbd> in each direction; it magnifies the whole thing by a factor of two. The second command specifies different percentages for each direction, stretching the width to <kbd>200</kbd>% and squashing the height to <kbd>50%</kbd>. The resulting image (in this example) has dimensions 1280x240. Notice that the percent symbol needn't be repeated; the following are equivalent: <kbd>200x50%</kbd>, <kbd>200%x50</kbd>, <kbd>200%x50%</kbd>. 558 </p> 559 560 <p>By default, the width and height given in a <em class="arg">geometry</em> argument are <em>maximum</em> values unless a percentage is specified. That is, the image is expanded or contracted to fit the specified width and height value while maintaining the <em>aspect ratio</em> (the ratio of its height to its width) of the image. For instance, the third command above "tries" to set the dimensions to <kbd>100x200</kbd>. Imagine gradually shrinking the original image (which is 640x480), keeping is aspect ratio constant, until it just fits into a 100x200 rectangle. Since the image is longer than it is tall, it will fit when its width shrinks to 100 pixels. To preserve the aspect ratio, the height will therefore have to be (480/640)×100 pixels=75 pixels, so the final dimensions will be 100x75.</p> 561 562 <p> Notice that in the previous example, at least one of the specified dimensions will be attained (in this case, the width, 100 pixels). The resulting image fits snugly within the original. One can do just the opposite of this by invoking the <kbd>^</kbd> operator, as in the fourth example above. In that case, when <kbd>100x200^</kbd> is given as the argument, again at least one of the dimensions will be attained, but in this case the resulting image can snugly contain the original. Here the <em class="arg">geometry</em> argument gives <em>minimum</em> values. In our example, the height will become 200 and the width will be scaled to preserve the aspect ratio, becoming (640/480)×200 pixels=267 pixels. With the <kbd>^</kbd> operator, one of those dimensions will match the requested size, but the image will likely overflow the dimensions requested to preserve its aspect ratio. (The <kbd>^</kbd> feature is new as of IM 6.3.8-2.)</p> 563 564 <p>We see that ImageMagick is very good about preserving aspect ratios of images, to prevent distortion of your favorite photos and images. But you might really want the dimensions to be <kbd>100x200</kbd>, thereby stretching the image. In this case just tell ImageMagick you really mean it (!) by appending an exclamation operator to the geometry. This will force the image size to exactly what you specify. So, for example, if you specify <kbd>100x200!</kbd> the dimensions will become exactly 100x200 (giving a small, vertically elongated wizard).</p> 565 </div> 566 567<h3>Bounding the width, height, and area; the operators <kbd>></kbd>, <kbd><</kbd>, and <kbd>@</kbd> </h3> 568<div class="doc-section"> 569 <p> 570 Here are a few more examples: 571 </p> 572 573 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100' wiz1.png</span></p> 574 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize 'x200' wiz2.png</span></p> 575 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100x200>' wiz3.png</span></p> 576 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100x200<' wiz4.png</span></p> 577 <p>If only one dimension is given it is taken to be the width. When only the width is specified, as in the first example above, the width is accepted as given and the height is chosen to maintain the aspect ratio of the input image. Similarly, if only the height is specified, as in the second example above, the height is accepted and the width is chosen to maintain the aspect ratio.</p> 578 579 580 <p>Use <kbd>></kbd> to change the dimensions of the image <em>only</em> if the original width or height is exeeded by one of the <em class="arg">geometry</em> specifications. Use <kbd><</kbd> to resize the image <em>only</em> if the original dimensions are more than the <em class="arg">geometry</em> specifications. In either case, if a change is made, the result is as if the <kbd>></kbd> or <kbd>></kbd> operator was not present. So, in the third example above, we specified <kbd>100x200></kbd> and the original image size is 640x480, so the image size is reduced as if we had specified <kbd>100x200</kbd>. However, in the fourth example above, there will be no change to its size.</p> 581 582 <p>Finally, use <kbd>@</kbd> to specify the maximum area in pixels of an image, again while attempting to preserve aspect ratio. (Pixels take only integer values, so some approximation is always at work.) In the following example, an area of 10000 pixels is requested. The resulting file has dimensions 115x86, which has 9890 pixels. </p> 583 584 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '@10000' wiz10000.png</span></p> 585 <p class="warn">Another word about the quotation marks: In all the examples above and below, we have enclosed the <em class="arg">geometry</em> arguments within quotation marks. Doing so is optional in many cases, but not always. We <em>must</em> enclose the geometry specifications in quotation marks when using <kbd><</kbd> or <kbd>></kbd> to prevent these characters from being interpreted by the shell as <em>file redirection</em>. On Windows systems, the carat <kbd>^</kbd> needs to be within quotes, else it is ignored. To be safe, one should probably maintain a habit of enclosing all <em class="arg">geometry</em> arguments in quotes, as we have here. 586 </p> 587 </div> 588 589<h3>Offsets in geometry</h3> 590<div class="doc-section"> 591 <p> 592 Here are some examples to illustrate the use of <em>offsets</em> in <em class="arg">geometry</em> arguments. One typical use of offsets is in conjunction with the 593 <a href="/www/command-line-options.html#region">‑region</a> option. This option allows many other options to modify the pixels within a specified rectangular subregion of an image. As such, it needs to be given the width and height of that region, and also an <em>offset</em> into the image, which is a pair of coordinates that indicate the location of the region within the larger image. Below, in the first example, we specify a region of size <kbd>100x200</kbd> to be located at the <em>xy</em>–coordinates <em>x</em>=10, <em>y</em>=20. Let's use the usual algebraic notation (<em>x</em>,<em>y</em>)=(10,20), for convenience. 594 </p> 595 596 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -region '100x200+10+20' -negate wizNeg1.png</span></p> 597 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -region '100x200-10+20' -negate wizNeg2.png</span></p> 598 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -gravity center -region '100x200-10+20' \ <br/> -negate wizNeg3.png</span></p> 599 600 <p>Note that offsets always require +/− signs. The offset is not actually a true location within the image; its coordinates must be added to some other location. Let's refer to that as the <em>current location</em>. In the first two examples above, though, that location is the upper-left hand corner of the image, which has coordinates (0,0). (That is the default situation when there are no other directives given to change it.) The first example above puts the <kbd>100x200</kbd> rectangle's own upper-left corner at (10,20). </p> 601 602 <p>A negative offset can make sense in many cases. In the second example above, the offset is (-10,20), specified by <kbd>-10+20</kbd>. In that case, only the portion of the (virtual) rectangle obtained that lies within the image can be negated; here it is equivalent to specifying the geometry as <kbd>90x200+0+20</kbd>.</p> 603 604 <p>In the third example above, the <a href="/www/command-line-options.html#gravity">‑gravity</a> setting precedes the others and sets the current location within the image at the very center of the image. In this case that is at pixel (320,240), since the size of the image is 640x480. This means that the offsets apply to that location, which thereby gets moved, in this case, to (320-10,240+20)=(310,260). But the <kbd>100x200</kbd> region itself is affected by the <a href="/www/command-line-options.html#gravity">‑gravity</a> setting, so instead of affecting its upper-left corner, the region's own center (at (+50,+100) within it) is determined. Therefore the center of the <kbd>100x200</kbd> rectangle is moved to (310,260). The negated rectangle's upper-left corner is now at (310-50,260-100)=(260,160). 605 </p> 606 </div> 607</div> 608 609 610<h2><a name="stack"></a>Image Stack</h2> 611<div class="doc-section"> 612 613<p>In school, your teacher probably permitted you to work on problems on a scrap of paper and then copy the results to your test paper. An image stack is similar. It permits you to work on an image or image sequence in isolation and subsequently introduce the results back into the command line. The image stack is delineated with parenthesis. Image operators only affect images in the current stack. For example, we can limit the image rotation to just the wizard image like this:</p> 614 615<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert wand.gif \( wizard.gif -rotate 30 \) +append images.gif</span></p> 616 617<p class="warn">Notice again that the parentheses are <em>escaped</em> by preceding them with 618backslashes. This is required under Unix, where parentheses are special 619<em>shell</em> characters. The backslash tells the shell not to interpret 620these characters, but to pass them directly to the command being executed. Do 621not escape the parentheses under Windows. Each parenthesis (or escaped 622parenthesis) must have spaces on either side, as in the example shown 623above.</p> 624 625<p>In addition to the image operators already discussed, the following image operators are most useful when processing images in an image stack:</p> 626 627<p class="options"> 628<span class='bull'> • </span> 629<a href="/www/command-line-options.html#clone">‑clone</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#delete">‑delete</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#insert">‑insert</a> <span class='bull'> • </span> <a href="/www/command-line-options.html#swap">‑swap</a> <span class='bull'> • </span> 630</p> 631 632<p>The arguments to these operators are indexes into the image sequence by number, starting with zero, for the first image, and so on. However if you give a negative index, the images are indexed from the end (last image added). That is, an index of -1 is the last image in the current image sequence, -2 gives the second-to-last, and so on.</p> 633 634</div> <!-- end Image Stack section --> 635 636<h2><a name="output"></a>Output Filename</h2> 637<div class="doc-section"> 638 639<p>ImageMagick extends the concept of an output filename to include:</p> 640 641<ol> 642<li>an explicit image format</li> 643<li>write to <em>standard out</em></li> 644<li>filename references</li> 645</ol> 646 647<p>Each of these extensions are explained in the next few paragraphs.</p> 648 649 <h3>Explicit Image Format</h3> 650 <div class="doc-section"> 651 <p>Images can be stored in a mryiad of image formats including the better known JPEG, PNG, TIFF and others. ImageMagick must know the desired format of the image before it is written. ImageMagick leverages the filename extension to determine the format. For example, <kbd>image.jpg</kbd> tells ImageMagick to write the image in the JPEG format. In some cases the filename does not identify the image format. In these cases, the image is written in the format it was originally read unless an explicit image format is specified. For example, suppose we want to write our image to a filename of <kbd>image</kbd> in the raw red, green, and blue intensity format: 652 </p> 653 654 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert image.jpg rgb:image</span></p> 655 </div> 656 657 <h3>Standard Out</h3> 658 <div class="doc-section"> 659 <p>Unix permits the output of one command to be piped to another. ImageMagick permits piping one command to another with a filename of <kbd>-</kbd>. In this example we pipe the output of <a href="/www/convert.html">convert</a> to the <a href="/www/display.html">display</a> program: 660 </p> 661 662 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: gif:- | display gif:-</span></p> 663 <p>Here the explicit format is optional. The GIF image format has a signature that uniquely identifies it so ImageMagick can readily recognize the format as GIF. 664 </p> 665 </div> 666 667 <h3>Filename References</h3> 668 <div class="doc-section"> 669 <p>Optionally, use an embedded formatting character to write a sequential image list. Suppose our output filename is <kbd>image-%d.jpg</kbd> and our image list includes 3 images. You can expect these images files to be written: 670 </p> 671 672 <p class="text"> 673 image-0.jpg <br/> 674 image-1.jpg <br/> 675 image-2.jpg 676 </p> 677 678 <p>Or retrieve image properties to modify the image filename. For example, the command 679 </p> 680 681 <p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert rose: -set filename:area '%wx%h' \ <br/> 'rose-%[filename:area].png'</span></p> 682 <p>writes an image with this filename: 683 </p> 684 685 <p class="text"> 686 rose-70x46.png 687 </p> 688 689 </div> 690 691</div> <!-- end Output Filename section --> 692 693</div> 694 695<div id="linkbar"> 696 <span id="linkbar-west"> </span> 697 <span id="linkbar-center"> 698 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> • 699 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> 700 </span> 701 <span id="linkbar-east"> </span> 702 </div> 703 <div class="footer"> 704 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span> 705 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span> 706 </div> 707 <div style="clear: both; margin: 0; width: 100%; "></div> 708 <script type="text/javascript"> 709 var _gaq = _gaq || []; 710 _gaq.push(['_setAccount', 'UA-17690367-1']); 711 _gaq.push(['_trackPageview']); 712 713 (function() { 714 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; 715 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; 716 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); 717 })(); 718 </script> 719</body> 720</html> 721
