blob: ef1ab104cf6603378bb2d8e91114af54a5f57219 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +00004<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00005<head>
cristy3c98a4f2010-08-13 20:09:41 +00006 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
7 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00008 <title>ImageMagick: Command-line Tools: Stream</title>
cristy3ed852e2009-09-05 21:47:34 +00009 <meta http-equiv="Content-Language" content="en-US"/>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
11 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000012 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +000013 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000014 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000015 <meta name="Generator" content="PHP"/>
16 <meta name="Keywords" content="command-line, tools:, stream, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +000017 <meta name="Rating" content="GENERAL"/>
18 <meta name="Robots" content="INDEX, FOLLOW"/>
19 <meta name="Generator" content="ImageMagick Studio LLC"/>
20 <meta name="Author" content="ImageMagick Studio LLC"/>
21 <meta name="Revisit-after" content="2 DAYS"/>
22 <meta name="Resource-type" content="document"/>
cristy7e41fe82010-12-04 23:12:08 +000023 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000024 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +000025 <link rel="icon" href="../images/wand.png" sizes="32x32"/>
26 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
27 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
28 <style type="text/css" media="all">
29 @import url("../www/magick.css");
30 </style>
cristy3eaa0ef2010-03-06 20:35:26 +000031</head>
32
33<body id="www-imagemagick-org">
34<div class="titlebar">
35<a href="../index.html">
36 <img src="../images/script.png" alt="[ImageMagick]"
37 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
38<a href="http://www.networkredux.com">
39 <img src="../images/networkredux.png" alt="[sponsor]"
40 style="margin: 45px auto; border: 0px; float: left;" /></a>
41<a href="http://www.imagemagick.org/discourse-server/">
42 <img src="../images/logo.jpg" alt=""
43 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
44<a href="../index.html">
45 <img src="../images/sprite.jpg" alt=""
46 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
47</div>
48
cristyce69bb02010-07-27 19:49:46 +000049<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000050
cristy3ed852e2009-09-05 21:47:34 +000051<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000052 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000053</div>
cristy3eaa0ef2010-03-06 20:35:26 +000054<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000055<div class="menu">
cristybb503372010-05-27 20:51:26 +000056 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
57</div>
58<div class="sub">
59 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
60</div>
61<div class="sub">
62 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
63</div>
64<div class="sub">
65 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
66</div>
67<div class="sep"></div>
68<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000069 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000070</div>
71<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000072 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000073</div>
74<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000075 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000076</div>
77<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000078 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000079</div>
80<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000081 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000082</div>
83<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000084 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000085</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000087 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000088</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000090 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000091</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
cristy3eaa0ef2010-03-06 20:35:26 +000095<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000096<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000104 </div>
105<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000106 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
cristybb503372010-05-27 20:51:26 +0000108<div class="menu">
109 <a title="Architecture" href="../www/architecture.html">Architecture</a>
110</div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000118<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000119<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000120 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000121</div>
122<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000123 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000124</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000125<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000128
129<div class="sponsbox">
130<div class="sponsor">
cristy307ba182010-12-25 01:00:34 +0000131 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011040100025 atlas.multimedia-->
cristy7d52cd62010-10-01 17:26:59 +0000132</div>
133<div class="sponsor">
134 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000135</div>
136<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000137 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
138</div>
139<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000140 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
141</div>
142<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000143 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy2c839602010-04-03 02:32:08 +0000144</div>
145<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000146 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristyd6a37032010-02-02 04:14:40 +0000147</div>
148<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000149 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000150</div>
cristy3ed852e2009-09-05 21:47:34 +0000151</div>
152</div>
cristyce69bb02010-07-27 19:49:46 +0000153</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000154
cristyce69bb02010-07-27 19:49:46 +0000155<div class="eastbar">
156 <script type="text/javascript">
157 <!--
158 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000159 google_ad_slot = "0574824969";
160 google_ad_width = 160;
161 google_ad_height = 600;
162 //-->
163 </script>
164 <script type="text/javascript"
165 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
166 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000167</div>
168
169<div class="main">
170
cristyffb69ed2010-12-25 00:06:48 +0000171<h1>ImageMagick Stream Command-line Utility</h1>
cristy3ed852e2009-09-05 21:47:34 +0000172<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
173
174<div class="doc-section">
175<p><kbd>Stream</kbd> is a lightweight tool to stream one or more pixel components of the image or portion of the image to your choice of storage formats. It writes the pixel components as they are read from the input image a row at a time making <kbd>stream</kbd> desirable when working with large images or when you require raw pixel components.</p>
176</div>
177
178<h2><a name="usage"></a>Example Usage</h2>
179<div class="doc-section">
180
181<p>We list a few examples of the <kbd>stream</kbd> command here to illustrate its usefulness and ease of use. To get started, lets stream the red, green, blue components of a 640x480 JPEG image to disk as unsigned characters:</p>
182
183<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>stream -map rgb -storage-type char image.jpg pixels.dat</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>display -depth 8 -size 640x480 rgb:pixels.dat</span></p>
184<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
185
186<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>stream -map i -storage-type double -extract 100x100+30+40 image.tif gray.raw</span></p>
187<p>You can also associate the region to extract with the image filename:</p>
188
189<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>stream -map i -storage-type double 'image.tif[100x100+30+40]' gray.raw</span></p>
190</div>
191
192<h2><a name="options"></a>Option Summary</h2>
193<div class="doc-section">
194
195<p>The <kbd>stream</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
196
197<table class="doc">
198 <tbody>
199 <tr>
200 <th align="left">Option</th>
201 <th align="left">Description</th>
202 </tr>
203
204 <tr>
205 <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
206 <td valign="top">decrypt image with this password</td>
207 </tr>
208
209 <tr>
210 <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
211 <td valign="top">apply option to select image channels</td>
212 </tr>
213
214 <tr>
215 <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
216 <td valign="top">set image colorspace</td>
217 </tr>
218
219 <tr>
220 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
221 <td valign="top">display copious debugging information</td>
222 </tr>
223
224 <tr>
225 <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
226 <td valign="top">define one or more image format options</td>
227 </tr>
228
229 <tr>
230 <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
231 <td valign="top">horizontal and vertical density of the image</td>
232 </tr>
233
234 <tr>
235 <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
236 <td valign="top">image depth</td>
237 </tr>
238
239 <tr>
240 <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
241 <td valign="top">extract area from image</td>
242 </tr>
243
244 <tr>
245 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
246 <td valign="top">print program options</td>
247 </tr>
248
249 <tr>
250 <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
251 <td valign="top">type of image interlacing scheme</td>
252 </tr>
253
254 <tr>
255 <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
256 <td valign="top">pixel color interpolation method</td>
257 </tr>
258
259 <tr>
260 <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
261 <td valign="top">pixel cache resource limit</td>
262 </tr>
263
264 <tr>
265 <td valign="top"><a href="../www/command-line-options.html#list">-list <em class="option">type</em></a></td>
266 <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
267 </tr>
268
269 <tr>
270 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
271 <td valign="top">format of debugging information</td>
272 </tr>
273
274 <tr>
275 <td valign="top"><a href="../www/command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
276 <td valign="top">store pixels in this format.</td>
277 </tr>
278
279 <tr>
280 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
281 <td valign="top">monitor progress</td>
282 </tr>
283
284 <tr>
285 <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
286 <td valign="top">reduce image colors in this colorspace</td>
287 </tr>
288
289 <tr>
290 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
291 <td valign="top">suppress all warning messages</td>
292 </tr>
293
294 <tr>
295 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
296 <td valign="top">pay attention to warning messages.</td>
297 </tr>
298
299 <tr>
300 <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
301 <td valign="top">settings remain in effect until parenthesis boundary.</td>
302 </tr>
303
304 <tr>
305 <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
306 <td valign="top">horizontal and vertical sampling factor</td>
307 </tr>
308
309 <tr>
310 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
311 <td valign="top">seed a new sequence of pseudo-random numbers</td>
312 </tr>
313
314 <tr>
315 <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
316 <td valign="top">set an image attribute</td>
317 </tr>
318
319 <tr>
320 <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
321 <td valign="top">width and height of image</td>
322 </tr>
323
324 <tr>
325 <td valign="top"><a href="../www/command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
326 <td valign="top">store pixels with this storage type.</td>
327 </tr>
328
329 <tr>
cristy5063d812010-10-19 16:28:10 +0000330 <td valign="top"><a href="../www/command-line-options.html#synchronize">-synchronize</a></td>
331 <td valign="top">synchronize image to storage device</td>
332 </tr>
333
334 <tr>
335 <td valign="top"><a href="../www/command-line-options.html#taint">-taint</a></td>
336 <td valign="top">mark the image as modified</td>
337 </tr>
338
339 <tr>
cristy3ed852e2009-09-05 21:47:34 +0000340 <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
341 <td valign="top">transparent color</td>
342 </tr>
343
344 <tr>
345 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
346 <td valign="top">print detailed information about the image</td>
347 </tr>
348
349 <tr>
350 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
351 <td valign="top">print version information</td>
352 </tr>
353
354 <tr>
355 <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
356 <td valign="top">access method for pixels outside the boundaries of the image</td>
357 </tr>
358
359 </tbody>
360</table>
361
362</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000363
364</div>
365
366<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000367 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000368 <span id="linkbar-center">
369 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000370 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000371 </span>
372 <span id="linkbar-east">&nbsp;</span>
373 </div>
374 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +0000375 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000376 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
377 </div>
378 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000379 <script type="text/javascript">
380 var _gaq = _gaq || [];
381 _gaq.push(['_setAccount', 'UA-17690367-1']);
382 _gaq.push(['_trackPageview']);
383
384 (function() {
385 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
386 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
387 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
388 })();
389 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000390</body>
391</html>