Blame - www/command-line-processing.html - platform/external/ImageMagick

blob: a6da1568384724c5a754fe22c2c36d03f11b7545 [file] [log] [blame]

cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	1	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
				2	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
				3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	4	<head>
cristy	3c98a4f	2010-08-13 20:09:41 +0000	[diff] [blame]	5	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
				6	<meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristy	ffb69ed	2010-12-25 00:06:48 +0000	[diff] [blame]	7	<title>ImageMagick: Command-line Processing</title>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	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"/>
cristy	3c98a4f	2010-08-13 20:09:41 +0000	[diff] [blame]	11	<meta name="Application-name" content="ImageMagick"/>
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	12	<meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy	3c98a4f	2010-08-13 20:09:41 +0000	[diff] [blame]	13	<meta name="Application-url" content="http://www.imagemagick.org"/>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	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"/>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	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"/>
cristy	7e41fe8	2010-12-04 23:12:08 +0000	[diff] [blame]	22	<meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	23	<meta name="Distribution" content="Global"/>
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	24	<link rel="icon" href="../images/wand.png"/>
cristy	3c98a4f	2010-08-13 20:09:41 +0000	[diff] [blame]	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"/>
cristy	7a40ba8	2011-01-08 20:31:18 +0000	[diff] [blame]	27	<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy	3c98a4f	2010-08-13 20:09:41 +0000	[diff] [blame]	28	<style type="text/css" media="all">
				29	@import url("../www/magick.css");
				30	</style>
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	31	<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy	361f466	2010-12-31 23:02:52 +0000	[diff] [blame]	32	<script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
				33	<link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
				34	<script type="text/javascript">
				35	$(document).ready(function() {
				36	$("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
				37	'transitionIn' : 'elastic',
				38	'transitionOut' : 'elastic',
				39	'overlayShow' : false,
				40	'opacity' : true
				41	});
				42	});
				43	</script>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	44	</head>
				45
				46	<body id="www-imagemagick-org">
				47	<div class="titlebar">
				48	<a href="../index.html">
				49	<img src="../images/script.png" alt="[ImageMagick]"
				50	style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
				51	<a href="http://www.networkredux.com">
				52	<img src="../images/networkredux.png" alt="[sponsor]"
cristy	5292344	2011-01-15 22:54:31 +0000	[diff] [blame^]	53	style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	54	<a href="http://www.imagemagick.org/discourse-server/">
				55	<img src="../images/logo.jpg" alt=""
				56	style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
				57	<a href="../index.html">
				58	<img src="../images/sprite.jpg" alt=""
				59	style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
				60	</div>
				61
cristy	ce69bb0	2010-07-27 19:49:46 +0000	[diff] [blame]	62	<div class="westbar">
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	63
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	64	<div class="menu">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	65	<a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	66	</div>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	67	<div class="sep"></div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	68	<div class="menu">
cristy	bb50337	2010-05-27 20:51:26 +0000	[diff] [blame]	69	<a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
				70	</div>
				71	<div class="sub">
				72	<a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
				73	</div>
				74	<div class="sub">
				75	<a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
				76	</div>
				77	<div class="sub">
				78	<a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
				79	</div>
				80	<div class="sep"></div>
				81	<div class="menu">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	82	<a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	83	</div>
				84	<div class="sub">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	85	<a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	86	</div>
				87	<div class="sub">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	88	<a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	89	</div>
				90	<div class="sub">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	91	<a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	92	</div>
				93	<div class="menu">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	94	<a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	95	</div>
				96	<div class="sub">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	97	<a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	98	</div>
				99	<div class="sub">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	100	<a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	101	</div>
				102	<div class="sub">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	103	<a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	104	</div>
				105	<div class="sub">
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	106	<a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	107	</div>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	108	<div class="sep"></div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	109	<div class="menu">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	110	<a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	111	</div>
				112	<div class="sub">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	113	<a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	114	</div>
				115	<div class="sub">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	116	<a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	117	</div>
				118	<div class="menu">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	119	<a title="Resources" href="../www/resources.html">Resources</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	120	</div>
cristy	bb50337	2010-05-27 20:51:26 +0000	[diff] [blame]	121	<div class="menu">
				122	<a title="Architecture" href="../www/architecture.html">Architecture</a>
				123	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	124	<div class="menu">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	125	<a title="Download" href="../www/download.html">Download</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	126	</div>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	127	<div class="sep"></div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	128	<div class="menu">
cristy	5292344	2011-01-15 22:54:31 +0000	[diff] [blame^]	129	<a title="Search" href="../www/search.html">Search</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	130	</div>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	131	<div class="sep"></div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	132	<div class="menu">
cristy	ffb69ed	2010-12-25 00:06:48 +0000	[diff] [blame]	133	<a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	134	</div>
				135	<div class="sub">
cristy	ffb69ed	2010-12-25 00:06:48 +0000	[diff] [blame]	136	<a title="Site Map: Links" href="../www/links.html">Links</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	137	</div>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	138	<div class="sep"></div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	139	<div class="menu">
cristy	83a272e	2010-05-07 20:40:35 +0000	[diff] [blame]	140	<a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	141
				142	<div class="sponsbox">
cristy	ec6b475	2011-01-08 03:16:23 +0000	[diff] [blame]	143	<div class="sponsor">
cristy	5292344	2011-01-15 22:54:31 +0000	[diff] [blame^]	144	<a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy	5c4585b	2010-11-11 00:13:57 +0000	[diff] [blame]	145	</div>
				146	<div class="sponsor">
cristy	7d52cd6	2010-10-01 17:26:59 +0000	[diff] [blame]	147	<a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy	73fd1cd	2010-09-12 19:14:25 +0000	[diff] [blame]	148	</div>
				149	<div class="sponsor">
cristy	c5baf4f	2010-08-31 15:05:33 +0000	[diff] [blame]	150	<a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
				151	</div>
				152	<div class="sponsor">
cristy	851dbce	2010-08-06 21:40:00 +0000	[diff] [blame]	153	<a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
				154	</div>
cristy	ec6b475	2011-01-08 03:16:23 +0000	[diff] [blame]	155	<div class="sponsor">
cristy	5292344	2011-01-15 22:54:31 +0000	[diff] [blame^]	156	<a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristy	ec6b475	2011-01-08 03:16:23 +0000	[diff] [blame]	157	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	158	</div>
				159	</div>
cristy	ce69bb0	2010-07-27 19:49:46 +0000	[diff] [blame]	160	</div>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	161
cristy	ce69bb0	2010-07-27 19:49:46 +0000	[diff] [blame]	162	<div class="eastbar">
				163	<script type="text/javascript">
				164	<!--
				165	google_ad_client = "pub-3129977114552745";
cristy	ce69bb0	2010-07-27 19:49:46 +0000	[diff] [blame]	166	google_ad_slot = "0574824969";
				167	google_ad_width = 160;
				168	google_ad_height = 600;
				169	//-->
				170	</script>
				171	<script type="text/javascript"
				172	src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
				173	</script>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	174	</div>
				175
				176	<div class="main">
				177
				178
				179
				180
cristy	ffb69ed	2010-12-25 00:06:48 +0000	[diff] [blame]	181	<h1>ImageMagick Command-line Processing</h1>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	182	<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>
				183
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	184	<div class="doc-section">
				185
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	186	<p>The ImageMagick command line can be as simple as this.</p>
				187
				188	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert image.jpg image.png</span></p>
				189	<p>Or it can be very complex, as in the following.</p>
				190
				191	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert label.gif +matte \ <br/>
				192	$ +clone -shade 110x90 -normalize -negate +clone -compose Plus -composite $ \<br/>
				193	$ -clone 0 -shade 110x50 -normalize -channel BG -fx 0 +channel -matte $ \<br/>
				194	-delete 0 +swap -compose Multiply -composite button.gif</span></p>
				195	<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>
				196
				197	<div class="image">
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	198	<a href="../images/label.gif"><img src="../images/label.gif" width="78" height="53" alt="label" /></a>
				199	<img style="margin-top:16px; margin-bottom:17px;" src="../images/right.gif" width="20" height="20" alt="==>" />
				200	<a href="../images/button.gif">
				201	<img src="../images/button.gif" width="78" height="53" alt="button" /></a>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	202	</div>
				203
cristy	e98012e	2010-11-28 21:27:53 +0000	[diff] [blame]	204	<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 formatted it for clarity by inserting backslashes (<kbd>\</kbd>). The backslash is the Unix <em>line continuation</em> character. In the Windows shell, use a carat character (<kbd>^</kbd>) for line continuation. We use the Unix style on these web pages, as above. Sometimes, however, the lines are 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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	205
cristy	e98012e	2010-11-28 21:27:53 +0000	[diff] [blame]	206	<p>Here we show percent completion of a task as a shaded cylinder:</p>
cristy	61365ad	2010-11-28 02:38:34 +0000	[diff] [blame]	207
				208	<div class="image">
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	209	<img src="../images/cylinder_shaded.png" width="320" height="200" alt="Shaded Cylinder" />
cristy	61365ad	2010-11-28 02:38:34 +0000	[diff] [blame]	210	</div>
				211
cristy	e98012e	2010-11-28 21:27:53 +0000	[diff] [blame]	212	<p>Given the complexity of the rendering, you might be surprised it is accomplished by a single command-line:</p>
cristy	61365ad	2010-11-28 02:38:34 +0000	[diff] [blame]	213
cristy	61365ad	2010-11-28 02:38:34 +0000	[diff] [blame]	214	<pre class="text">
cristy	e98012e	2010-11-28 21:27:53 +0000	[diff] [blame]	215	convert -size 320x90 xc:none -stroke snow4 -size 1x90 -tile gradient:white-snow4 \
				216	-draw 'roundrectangle 16, 5, 304, 85 20,40' +tile -fill snow \
				217	-draw 'roundrectangle 264, 5, 304, 85 20,40' -tile gradient:chartreuse-green \
				218	-draw 'roundrectangle 16, 5, 180, 85 20,40' -tile gradient:chartreuse1-chartreuse3 \
				219	-draw 'roundrectangle 140, 5, 180, 85 20,40' +tile -fill none \
				220	-draw 'roundrectangle 264, 5, 304, 85 20,40' -strokewidth 2 \
				221	-draw 'roundrectangle 16, 5, 304, 85 20,40' \( +clone -background snow4 \
				222	-shadow 80x3+3+3 \) +swap -background none -layers merge \( +size -font Helvetica \
				223	-pointsize 90 -strokewidth 1 -fill red label:'50 %' -trim +repage \( +clone \
				224	-background firebrick3 -shadow 80x3+3+3 \) +swap -background none -layers merge \) \
				225	-insert 0 -gravity center -append -background white -gravity center -extent 320x200 \
				226	cylinder_shaded.png
cristy	61365ad	2010-11-28 02:38:34 +0000	[diff] [blame]	227	</pre>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	228
				229	<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>
				230
				231	<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>
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	232	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	233
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	234	<h2><a id="anatomy"></a>The Anatomy of the Command Line</h2>
				235	<div class="doc-section">
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	236	<p>The ImageMagick command line consists of</p>
				237
				238	<ol>
				239	<li>one or more required input filenames.</li>
				240	<li>zero, one, or more image settings.</li>
				241	<li>zero, one, or more image operators.</li>
				242	<li>zero, one, or more image sequence operators.</li>
				243	<li>zero, one, or more image stacks.</li>
				244	<li>zero or one output image filenames (required by
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	245	<a href="../www/convert.html">convert</a>,
				246	<a href="../www/composite.html">composite</a>,
				247	<a href="../www/montage.html.html">montage.html</a>,
				248	<a href="../www/compare.html">compare</a>,
				249	<a href="../www/import.html">import</a>,
				250	<a href="../www/conjure.html">conjure</a>).
				251	</li>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	252	</ol>
				253
				254	<p>You can find a detailed explanation of each of the constituent parts of the command line in the sections that follow.</p>
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	255	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	256
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	257	<h2><a id="input"></a>Input Filename</h2>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	258	<div class="doc-section">
				259
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	260	<p>ImageMagick extends the concept of an input filename to include:</p>
				261	<ul>
				262	<li>filename globbing</li>
				263	<li>an explicit image format</li>
				264	<li>using built-in images and patterns</li>
				265	<li>STDIN, STDOUT, and file descriptors</li>
				266	<li>selecting certain frames from an image</li>
				267	<li>selecting a region of an image</li>
				268	<li>forcing an inline image resize</li>
				269	<li>forcing an inline image crop</li>
				270	<li>using filename references</li>
				271	</ul>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	272
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	273	<p>These extensions are explained in the next few paragraphs.</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	274
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	275	<h3>Filename Globbing</h3>
				276	<div class="doc-section">
				277	<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:
				278	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	279
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	280	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert *.jpg images.gif</span></p>
				281	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	282
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	283	<h3>Explicit Image Format</h3>
				284	<div class="doc-section">
				285	<p>Images are stored in a myriad of image formats including
cristy	efb2bdb	2010-11-20 19:35:22 +0000	[diff] [blame]	286	the better known JPEG, PNG, TIFF and others. ImageMagick must know the format
				287	of the image before it can be read and processed. Most formats have a
				288	signature within the image that uniquely identifies the format. Failing
				289	that, ImageMagick leverages the filename extension to determine the format.
				290	For example, <kbd>image.jpg</kbd> or <kbd>image.JPG</kbd> tells ImageMagick
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	291	it is reading an image in the JPEG format. </p>
cristy	efb2bdb	2010-11-20 19:35:22 +0000	[diff] [blame]	292
				293	<p>In some cases the image may not contain a signature
				294	and/or the filename does not identify the image format. In these cases an
				295	explicit image format must be specified. For example, suppose our image
				296	is named <kbd>image</kbd> and contains raw red, green, and blue intensity
				297	values. ImageMagick has no way to automagically determine the image format
				298	so we explicitly set one:
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	299	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	300
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	301	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert -size 640x480 -depth 8 rgb:image image.png</span></p>
cristy	d3ef010	2009-09-12 18:11:06 +0000	[diff] [blame]	302	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	303
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	304	<h3>Built-in Images and Patterns</h3>
				305	<div class="doc-section">
				306	<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:
				307	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	308
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	309	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert -size 640x480 pattern:checkerboard checkerboard.png</span></p>
				310	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	311
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	312	<h3>STDIN, STDOUT, and file descriptors</h3>
				313	<div class="doc-section">
				314	<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
				315	<a href="../www/convert.html">convert</a> to the <a href="../www/display.html">display</a> program:
				316	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	317
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	318	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: gif:- \| display gif:-</span></p>
				319	<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:
				320	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	321
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	322	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert rose: gif:- \| convert - -resize "200%" bigrose.jpg</span></p>
				323	<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.
				324	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	325
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	326	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert fd:3 fd:4 -append fd:5</span></p>
				327	<p>When needed, explicit image formats can be given as mentioned earlier, as in the following.
				328	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	329
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	330	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert gif:fd:3 jpg:fd:4 -append tif:fd:5</span></p>
				331	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	332
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	333	<h3>Selecting Frames</h3>
				334	<div class="doc-section">
				335	<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:
				336	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	337
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	338	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert 'images.gif[0]' image.png</span></p>
				339	<p class="warn">[Unix shells generally interpret brackets so we enclosed the filename in quotes above.
cristy	efb2bdb	2010-11-20 19:35:22 +0000	[diff] [blame]	340	In 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.]
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	341	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	342
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	343	<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:
				344	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	345
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	346	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert 'images.gif[0-3]' images.mng</span></p>
				347	<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:
				348	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	349
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	350	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert 'images.gif[3,2,4]' images.mng</span></p>
				351	<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>.
				352	</p>
				353	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	354
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	355	<h3>Selecting an Image Region</h3>
				356	<div class="doc-section">
				357	<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:
				358	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	359
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	360	<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>
				361	<p>
				362	You can get the same results with the <a href="../www/command-line-options.html#extract">‑extract</a> option:
				363	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	364
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	365	<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>
				366	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	367
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	368	<h3>Inline Image Resize</h3>
				369	<div class="doc-section">
				370	<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:
				371	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	372
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	373	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert '*.jpg' -resize 120x120 thumbnail%03d.png</span></p>
				374	<p>Here <em>all</em> the images are read and subsequently
cristy	efb2bdb	2010-11-20 19:35:22 +0000	[diff] [blame]	375	resized. It is faster and less resource intensive to resize each image it
				376	is read:
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	377	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	378
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	379	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert '*.jpg[120x120]' thumbnail%03d.png</span></p>
				380	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	381
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	382	<h3>Inline Image Crop</h3>
				383	<div class="doc-section">
				384	<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:
				385	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	386
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	387	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert '*.jpg' -crop 120x120+10+5 thumbnail%03d.png</span></p>
				388	<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:
				389	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	390
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	391	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert '*.jpg[120x120+10+5]' thumbnail%03d.png</span></p>
				392	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	393
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	394	<h3>Filename References</h3>
				395	<div class="doc-section">
				396	<p>There are two methods to use a filename to reference other image filenames.
				397	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:
				398	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	399
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	400	<pre class="text">
cristy	6110536	2010-12-19 23:22:14 +0000	[diff] [blame]	401	frame001.jpg
				402	frame002.jpg
				403	frame003.jpg
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	404	</pre>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	405
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	406	<p>We then expect this command:</p>
				407	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert @myimages.txt mymovie.gif</span></p><p>to read the images <kbd>frame001.jpg</kbd>, <kbd>frame002.jpg</kbd>, and <kbd>frame003.jpg</kbd> and convert them to a GIF image sequence. </p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	408
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	409
cristy	efb2bdb	2010-11-20 19:35:22 +0000	[diff] [blame]	410	<p>Some ImageMagick command-line options may exceed the capabilities of
				411	your command line processor. Windows, for example, limits command lines
				412	to 8192 characters. If, for example, you have a draw option with polygon
				413	points that exceed the command-line length limit, put the draw option instead
				414	in a file and reference the file with
				415	the <kbd>@</kbd> (e.g. <kbd>@mypoly.txt</kbd>).</p>
				416
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	417	<p>Another method of referring to other image files is by
cristy	efb2bdb	2010-11-20 19:35:22 +0000	[diff] [blame]	418	embedding a formatting character in the filename with a scene range. Consider
				419	the filename <kbd>image-%d.jpg[1-5]</kbd>. The command</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	420
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	421	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert image-%d.jpg[1-5]</span></p>
				422	<p>causes ImageMagick to attempt to read images with these filenames:
				423	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	424
cristy	6110536	2010-12-19 23:22:14 +0000	[diff] [blame]	425	<pre class="text">
cristy	5292344	2011-01-15 22:54:31 +0000	[diff] [blame^]	426	image-1.jpg
				427	image-2.jpg
				428	image-3.jpg
				429	image-4.jpg
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	430	image-5.jpg
cristy	6110536	2010-12-19 23:22:14 +0000	[diff] [blame]	431	</pre>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	432
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	433	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	434	</div>
				435
				436
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	437	<h2><a id="setting"></a>Image Setting</h2>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	438	<div class="doc-section">
				439
cristy	efb2bdb	2010-11-20 19:35:22 +0000	[diff] [blame]	440	<p>An image setting persists as it appears on the command line and may affect
				441	subsequent processing such as reading an image, an image operator, or when
				442	writing an image as appropriate. An image setting stays in effect until it
				443	is reset or the command line terminates. The image settings include:</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	444
				445	<p class="options">
cristy	2c83960	2010-04-03 02:32:08 +0000	[diff] [blame]	446	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	447
				448	<p>In this example, <em class="arg">-channel</em> applies to each of the images, since, as we mentioned, settings persist:
				449	</p>
				450
cristy	d3ef010	2009-09-12 18:11:06 +0000	[diff] [blame]	451	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert -channel RGB wand.png wizard.png images.png</span></p>
cristy	d3ef010	2009-09-12 18:11:06 +0000	[diff] [blame]	452	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	453
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	454	<h2><a id="operator"></a>Image Operator</h2>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	455	<div class="doc-section">
				456
cristy	efb2bdb	2010-11-20 19:35:22 +0000	[diff] [blame]	457	<p>An image operator differs from a setting in that it affects the image
				458	immediately as it appears on the command line. An operator is
				459	any <a href="/script../www/command-line-options.html">command line option</a>
				460	not listed as a <a href="#setting">image setting</a>
				461	or <a href="#sequence">image sequence operator</a>. Unlike an
				462	image setting, which persists until the command line terminates,
				463	an operator is applied to an image and forgotten. The image operators
				464	include:</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	465
				466	<p class="options">
cristy	51853f0	2010-03-18 20:03:12 +0000	[diff] [blame]	467	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	468
				469	<p>In this example, <em class="arg">-negate</em> negates the wand image but not the wizard:</p>
				470
				471	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert wand.png -negate wizard.png images.png</span></p></div>
				472
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	473	<h2><a id="sequence"></a>Image Sequence Operator</h2>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	474	<div class="doc-section">
				475
cristy	efb2bdb	2010-11-20 19:35:22 +0000	[diff] [blame]	476	<p>An image sequence operator differs from a setting in that it affects an
				477	image sequence immediately as it appears on the command line. Choose from
				478	these image sequence operators:</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	479
				480	<p class="options">
cristy	c496086	2010-05-23 22:24:24 +0000	[diff] [blame]	481	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	482	</div>
				483
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	484	<h2><a id="geometry"></a>Image Geometry</h2>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	485	<div class="doc-section">
				486
cristy	efb2bdb	2010-11-20 19:35:22 +0000	[diff] [blame]	487	<p>Many command-line options take a <em class="arg">geometry</em> argument
				488	to specify such things as the desired width and height of an image and other
				489	dimensional quantities. Because users want so many variations on the resulting
				490	dimensions, sizes, and positions of images (and because ImageMagick wants to
				491	provide them), the <em class="arg">geometry</em> argument can take many
				492	forms. We describe many of these in this section. </p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	493
cristy	efb2bdb	2010-11-20 19:35:22 +0000	[diff] [blame]	494	<p>The image options and settings that take some form of
				495	a <em class="arg">geometry</em> argument include the following.
				496	Keep in mind that some of these parse their arguments in slightly
				497	different ways. See the documentation for the individual option or
				498	setting for more specifics.</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	499
				500	<p class="options" style="text-align:justify">
cristy	5f2356f	2009-11-16 00:40:46 +0000	[diff] [blame]	501	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	502
				503	<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>
				504
				505
				506	<table id="geometryTable" class="doc">
				507	<col width="20%"/> <col width="80%"/>
				508	<thead>
				509	<tr valign="top">
				510	<th style="text-align:center"><em class="arg">size</em></th>
				511	<th>General description (actual behavior can vary for different options and settings)</th>
				512	</tr>
				513	</thead>
				514	<tbody>
				515	<tr valign="top">
				516	<td><em class="arg">scale</em>%</td>
				517	<td>Height and width both scaled by specified percentage.</td>
				518	</tr>
				519	<tr valign="top">
				520	<td><em class="arg">scale-x</em>%x<em class="arg">scale-y</em>%</td>
				521	<td>Height and width individually scaled by specified percentages. (Only one % symbol needed.)</td>
				522	</tr>
				523	<tr valign="top">
				524	<td><em class="arg">width</em></td>
				525	<td>Width given, height automagically selected to preserve aspect ratio.</td>
				526	</tr>
				527	<tr valign="top">
				528	<td>x<em class="arg">height</em></td>
				529	<td>Height given, width automagically selected to preserve aspect ratio.</td>
				530	</tr>
				531	<tr valign="top">
				532	<td><em class="arg">width</em>x<em class="arg">height</em></td>
				533	<td>Maximum values of height and width given, aspect ratio preserved.</td>
				534	</tr>
				535	<tr valign="top">
				536	<td><em class="arg">width</em>x<em class="arg">height</em>^</td>
				537	<td>Minimum values of width and height given, aspect ratio preserved.</td>
				538	</tr>
				539	<tr valign="top">
				540	<td><em class="arg">width</em>x<em class="arg">height</em>!</td>
				541	<td>Width and height emphatically given, original aspect ratio ignored.</td>
				542	</tr>
				543	<tr valign="top">
				544	<td><em class="arg">width</em>x<em class="arg">height</em>></td>
				545	<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>
				546	</tr>
				547	<tr valign="top">
				548	<td><em class="arg">width</em>x<em class="arg">height</em><</td>
				549	<td>Change dimensions only if both image dimensions exceed specified dimensions.</td>
				550	</tr>
				551	<tr valign="top">
				552	<td><em class="arg">area</em>@</td>
				553	<td>Resize image to have specified area in pixels. Aspect ratio is preserved.</td>
				554	</tr>
				555	</tbody>
				556	</table>
				557	<table class="doc">
				558	<col width="20%"/> <col width="80%"/>
				559	<thead>
				560	<tr valign="top">
				561	<th style="text-align:center">{<em class="arg">size</em>}{<em class="arg">offset</em>}</th>
				562	<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>
				563	</tr>
				564	</thead>
				565
				566	<tbody>
				567	<tr valign="top">
				568	<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>
				569	<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>
				570	</tr>
				571	</tbody>
				572	</table>
				573
				574
				575	<h3>Basic adjustments to width and height; the operators <kbd>%</kbd>, <kbd>^</kbd>, and <kbd>!</kbd> </h3>
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	576	<div class="doc-section">
				577	<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.
				578	<a href="../images/logo-fullsize.png">
				579	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!)
				580	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	581
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	582	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '200%' bigWiz.png</span></p>
				583	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '200x50%' longShortWiz.png</span></p>
				584	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100x200' notThinWiz.png</span></p>
				585	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100x200^' biggerNotThinWiz.png</span></p>
				586	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100x200!' dochThinWiz.png</span></p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	587
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	588	<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>.
				589	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	590
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	591	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	592
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	593	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	594
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	595	<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>
				596	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	597
				598	<h3>Bounding the width, height, and area; the operators <kbd>></kbd>, <kbd><</kbd>, and <kbd>@</kbd> </h3>
				599	<div class="doc-section">
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	600	<p>
				601	Here are a few more examples:
				602	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	603
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	604	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100' wiz1.png</span></p>
				605	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize 'x200' wiz2.png</span></p>
				606	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100x200>' wiz3.png</span></p>
				607	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '100x200<' wiz4.png</span></p>
				608	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	609
				610
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	611	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	612
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	613	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	614
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	615	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -resize '@10000' wiz10000.png</span></p>
				616	<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.
				617	</p>
				618	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	619
				620	<h3>Offsets in geometry</h3>
				621	<div class="doc-section">
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	622	<p>
				623	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
				624	<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.
				625	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	626
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	627	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -region '100x200+10+20' -negate wizNeg1.png</span></p>
				628	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -region '100x200-10+20' -negate wizNeg2.png</span></p>
				629	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	630
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	631	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	632
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	633	<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>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	634
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	635	<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).
				636	</p>
				637	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	638	</div>
				639
				640
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	641	<h2><a id="stack"></a>Image Stack</h2>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	642	<div class="doc-section">
				643
				644	<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>
				645
				646	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert wand.gif $ wizard.gif -rotate 30 $ +append images.gif</span></p>
				647
				648	<p class="warn">Notice again that the parentheses are <em>escaped</em> by preceding them with
				649	backslashes. This is required under Unix, where parentheses are special
				650	<em>shell</em> characters. The backslash tells the shell not to interpret
				651	these characters, but to pass them directly to the command being executed. Do
				652	not escape the parentheses under Windows. Each parenthesis (or escaped
				653	parenthesis) must have spaces on either side, as in the example shown
				654	above.</p>
				655
				656	<p>In addition to the image operators already discussed, the following image operators are most useful when processing images in an image stack:</p>
				657
				658	<p class="options">
				659	<span class='bull'> • </span>
				660	<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>
				661	</p>
				662
				663	<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>
				664
				665	</div> <!-- end Image Stack section -->
				666
cristy	dcca3fa	2010-12-29 21:50:07 +0000	[diff] [blame]	667	<h2><a id="output"></a>Output Filename</h2>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	668	<div class="doc-section">
				669
				670	<p>ImageMagick extends the concept of an output filename to include:</p>
				671
				672	<ol>
				673	<li>an explicit image format</li>
				674	<li>write to <em>standard out</em></li>
				675	<li>filename references</li>
				676	</ol>
				677
				678	<p>Each of these extensions are explained in the next few paragraphs.</p>
				679
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	680	<h3>Explicit Image Format</h3>
				681	<div class="doc-section">
				682	<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:
				683	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	684
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	685	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert image.jpg rgb:image</span></p>
				686	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	687
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	688	<h3>Standard Out</h3>
				689	<div class="doc-section">
				690	<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:
				691	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	692
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	693	<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: gif:- \| display gif:-</span></p>
				694	<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.
				695	</p>
				696	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	697
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	698	<h3>Filename References</h3>
				699	<div class="doc-section">
				700	<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:
				701	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	702
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	703	<pre class="text">
cristy	6110536	2010-12-19 23:22:14 +0000	[diff] [blame]	704	image-0.jpg
				705	image-1.jpg
				706	image-2.jpg
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	707	</pre>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	708
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	709	<p>Or retrieve image properties to modify the image filename. For example, the command
				710	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	711
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	712	<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>
				713	<p>writes an image with this filename:
				714	</p>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	715
cristy	6110536	2010-12-19 23:22:14 +0000	[diff] [blame]	716	<pre class="text">
				717	rose-70x46.png
				718	</pre>
				719
				720	<p>Finally to convert multiple JPEG images to individual PDF pages, use:</p>
				721
				722	<pre class="text">
				723	convert *.jpg +adjoin page-%d.pdf
				724	</pre>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	725
cristy	4103d56	2010-12-10 01:38:54 +0000	[diff] [blame]	726	</div>
cristy	3ed852e	2009-09-05 21:47:34 +0000	[diff] [blame]	727
				728	</div> <!-- end Output Filename section -->
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	729
				730	</div>
				731
				732	<div id="linkbar">
cristy	ce69bb0	2010-07-27 19:49:46 +0000	[diff] [blame]	733	<span id="linkbar-west"> </span>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	734	<span id="linkbar-center">
				735	<a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
cristy	a890294	2010-07-30 00:49:52 +0000	[diff] [blame]	736	<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	737	</span>
				738	<span id="linkbar-east"> </span>
				739	</div>
				740	<div class="footer">
cristy	7e41fe8	2010-12-04 23:12:08 +0000	[diff] [blame]	741	<span id="footer-west">© 1999-2011 ImageMagick Studio LLC</span>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	742	<span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
				743	</div>
				744	<div style="clear: both; margin: 0; width: 100%; "></div>
cristy	a890294	2010-07-30 00:49:52 +0000	[diff] [blame]	745	<script type="text/javascript">
				746	var _gaq = _gaq \|\| [];
				747	_gaq.push(['_setAccount', 'UA-17690367-1']);
				748	_gaq.push(['_trackPageview']);
				749
				750	(function() {
				751	var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
				752	ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
				753	var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
				754	})();
				755	</script>
cristy	3eaa0ef	2010-03-06 20:35:26 +0000	[diff] [blame]	756	</body>
				757	</html>