blob: d64abba0bf08794b3523b17ef4b7870a6936613d [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001
cristydcca3fa2010-12-29 21:50:07 +00002<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml: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"/>
cristydcca3fa2010-12-29 21:50:07 +000013 <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."/>
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"/>
cristydcca3fa2010-12-29 21:50:07 +000025 <link rel="icon" href="../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000026 <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>
cristydcca3fa2010-12-29 21:50:07 +000031 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
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>
cristy3eaa0ef2010-03-06 20:35:26 +000044</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]"
53 style="margin: 45px auto; border: 0px; float: left;" /></a>
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
cristyce69bb02010-07-27 19:49:46 +000062<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000063
cristy3ed852e2009-09-05 21:47:34 +000064<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000065 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000066</div>
cristy3eaa0ef2010-03-06 20:35:26 +000067<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000068<div class="menu">
cristybb503372010-05-27 20:51:26 +000069 <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">
cristy83a272e2010-05-07 20:40:35 +000082 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000083</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000085 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000086</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000088 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000089</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000091 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000092</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000094 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000106 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000110 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000113 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristybb503372010-05-27 20:51:26 +0000121<div class="menu">
122 <a title="Architecture" href="../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000125 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000128<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000129 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000133 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000136 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000140 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000141
142<div class="sponsbox">
143<div class="sponsor">
cristydcca3fa2010-12-29 21:50:07 +0000144 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristy7d52cd62010-10-01 17:26:59 +0000145</div>
146<div class="sponsor">
147 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristy3ed852e2009-09-05 21:47:34 +0000155</div>
156</div>
cristyce69bb02010-07-27 19:49:46 +0000157</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000158
cristyce69bb02010-07-27 19:49:46 +0000159<div class="eastbar">
160 <script type="text/javascript">
161 <!--
162 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000163 google_ad_slot = "0574824969";
164 google_ad_width = 160;
165 google_ad_height = 600;
166 //-->
167 </script>
168 <script type="text/javascript"
169 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
170 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000171</div>
172
173<div class="main">
174
cristydcca3fa2010-12-29 21:50:07 +0000175<h1>ImageMagick Stream Command-line Tool</h1>
cristy3ed852e2009-09-05 21:47:34 +0000176<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
177
178<div class="doc-section">
179<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>
180</div>
181
cristydcca3fa2010-12-29 21:50:07 +0000182<h2><a id="usage"></a>Example Usage</h2>
cristy3ed852e2009-09-05 21:47:34 +0000183<div class="doc-section">
184
185<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>
186
187<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>
188<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
189
190<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>
191<p>You can also associate the region to extract with the image filename:</p>
192
193<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>
194</div>
195
cristydcca3fa2010-12-29 21:50:07 +0000196<h2><a id="options"></a>Option Summary</h2>
cristy3ed852e2009-09-05 21:47:34 +0000197<div class="doc-section">
198
199<p>The <kbd>stream</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
200
201<table class="doc">
202 <tbody>
203 <tr>
204 <th align="left">Option</th>
205 <th align="left">Description</th>
206 </tr>
207
208 <tr>
209 <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
210 <td valign="top">decrypt image with this password</td>
211 </tr>
212
213 <tr>
214 <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
215 <td valign="top">apply option to select image channels</td>
216 </tr>
217
218 <tr>
219 <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
220 <td valign="top">set image colorspace</td>
221 </tr>
222
223 <tr>
224 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
225 <td valign="top">display copious debugging information</td>
226 </tr>
227
228 <tr>
229 <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
230 <td valign="top">define one or more image format options</td>
231 </tr>
232
233 <tr>
234 <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
235 <td valign="top">horizontal and vertical density of the image</td>
236 </tr>
237
238 <tr>
239 <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
240 <td valign="top">image depth</td>
241 </tr>
242
243 <tr>
244 <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
245 <td valign="top">extract area from image</td>
246 </tr>
247
248 <tr>
249 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
250 <td valign="top">print program options</td>
251 </tr>
252
253 <tr>
254 <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
255 <td valign="top">type of image interlacing scheme</td>
256 </tr>
257
258 <tr>
259 <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
260 <td valign="top">pixel color interpolation method</td>
261 </tr>
262
263 <tr>
264 <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
265 <td valign="top">pixel cache resource limit</td>
266 </tr>
267
268 <tr>
269 <td valign="top"><a href="../www/command-line-options.html#list">-list <em class="option">type</em></a></td>
270 <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
271 </tr>
272
273 <tr>
274 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
275 <td valign="top">format of debugging information</td>
276 </tr>
277
278 <tr>
279 <td valign="top"><a href="../www/command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
280 <td valign="top">store pixels in this format.</td>
281 </tr>
282
283 <tr>
284 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
285 <td valign="top">monitor progress</td>
286 </tr>
287
288 <tr>
289 <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
290 <td valign="top">reduce image colors in this colorspace</td>
291 </tr>
292
293 <tr>
294 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
295 <td valign="top">suppress all warning messages</td>
296 </tr>
297
298 <tr>
299 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
300 <td valign="top">pay attention to warning messages.</td>
301 </tr>
302
303 <tr>
304 <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
305 <td valign="top">settings remain in effect until parenthesis boundary.</td>
306 </tr>
307
308 <tr>
309 <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
310 <td valign="top">horizontal and vertical sampling factor</td>
311 </tr>
312
313 <tr>
314 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
315 <td valign="top">seed a new sequence of pseudo-random numbers</td>
316 </tr>
317
318 <tr>
319 <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
320 <td valign="top">set an image attribute</td>
321 </tr>
322
323 <tr>
324 <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
325 <td valign="top">width and height of image</td>
326 </tr>
327
328 <tr>
329 <td valign="top"><a href="../www/command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
330 <td valign="top">store pixels with this storage type.</td>
331 </tr>
332
333 <tr>
cristy5063d812010-10-19 16:28:10 +0000334 <td valign="top"><a href="../www/command-line-options.html#synchronize">-synchronize</a></td>
335 <td valign="top">synchronize image to storage device</td>
336 </tr>
337
338 <tr>
339 <td valign="top"><a href="../www/command-line-options.html#taint">-taint</a></td>
340 <td valign="top">mark the image as modified</td>
341 </tr>
342
343 <tr>
cristy3ed852e2009-09-05 21:47:34 +0000344 <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
345 <td valign="top">transparent color</td>
346 </tr>
347
348 <tr>
349 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
350 <td valign="top">print detailed information about the image</td>
351 </tr>
352
353 <tr>
354 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
355 <td valign="top">print version information</td>
356 </tr>
357
358 <tr>
359 <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
360 <td valign="top">access method for pixels outside the boundaries of the image</td>
361 </tr>
362
363 </tbody>
364</table>
365
366</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000367
368</div>
369
370<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000371 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000372 <span id="linkbar-center">
373 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000374 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000375 </span>
376 <span id="linkbar-east">&nbsp;</span>
377 </div>
378 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +0000379 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000380 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
381 </div>
382 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000383 <script type="text/javascript">
384 var _gaq = _gaq || [];
385 _gaq.push(['_setAccount', 'UA-17690367-1']);
386 _gaq.push(['_trackPageview']);
387
388 (function() {
389 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
390 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
391 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
392 })();
393 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000394</body>
395</html>