blob: 81f449178f8329e0355fbb8f8613535716d91586 [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"/>
cristy7a40ba82011-01-08 20:31:18 +000028 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000029 <style type="text/css" media="all">
30 @import url("../www/magick.css");
31 </style>
cristydcca3fa2010-12-29 21:50:07 +000032 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000033 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
34 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
35 <script type="text/javascript">
36 $(document).ready(function() {
37 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
38 'transitionIn' : 'elastic',
39 'transitionOut' : 'elastic',
40 'overlayShow' : false,
41 'opacity' : true
42 });
43 });
44 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000045</head>
46
47<body id="www-imagemagick-org">
48<div class="titlebar">
49<a href="../index.html">
50 <img src="../images/script.png" alt="[ImageMagick]"
51 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
52<a href="http://www.networkredux.com">
53 <img src="../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000054 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000055<a href="http://www.imagemagick.org/discourse-server/">
56 <img src="../images/logo.jpg" alt=""
cristy178edaf2011-01-23 03:42:39 +000057 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000058<a href="../index.html">
59 <img src="../images/sprite.jpg" alt=""
60 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
61</div>
62
cristyce69bb02010-07-27 19:49:46 +000063<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000064
cristy3ed852e2009-09-05 21:47:34 +000065<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000066 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000067</div>
cristy3eaa0ef2010-03-06 20:35:26 +000068<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000069<div class="menu">
cristybb503372010-05-27 20:51:26 +000070 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
71</div>
72<div class="sub">
73 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
74</div>
75<div class="sub">
76 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
77</div>
78<div class="sub">
79 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
80</div>
81<div class="sep"></div>
82<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000092 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000093</div>
94<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000095 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000096</div>
97<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000098 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000099</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000101 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000102</div>
103<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000104 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000105</div>
106<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000107 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000108</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000109<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
113<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000114 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000115</div>
116<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000117 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000118 </div>
119<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000120 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000121</div>
cristybb503372010-05-27 20:51:26 +0000122<div class="menu">
123 <a title="Architecture" href="../www/architecture.html">Architecture</a>
124</div>
cristy3ed852e2009-09-05 21:47:34 +0000125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000127</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000128<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000129<div class="menu">
cristy52923442011-01-15 22:54:31 +0000130 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000131</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000132<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000133<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000134 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000135</div>
136<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000137 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000138</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000139<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000140<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000141 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000142
143<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000144<div class="sponsor">
145 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
146</div>
cristyec6b4752011-01-08 03:16:23 +0000147<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000148 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000149</div>
150<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000151 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
152</div>
153<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000154 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
155</div>
cristyec6b4752011-01-08 03:16:23 +0000156<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000157 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
158</div>
159<div class="sponsor">
cristyc7a6e3e2011-01-26 16:54:03 +0000160 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000161</div>
cristy3ed852e2009-09-05 21:47:34 +0000162</div>
163</div>
cristyce69bb02010-07-27 19:49:46 +0000164</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000165
cristyce69bb02010-07-27 19:49:46 +0000166<div class="eastbar">
167 <script type="text/javascript">
168 <!--
169 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000170 google_ad_slot = "0574824969";
171 google_ad_width = 160;
172 google_ad_height = 600;
173 //-->
174 </script>
175 <script type="text/javascript"
176 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
177 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000178</div>
179
180<div class="main">
181
cristydcca3fa2010-12-29 21:50:07 +0000182<h1>ImageMagick Stream Command-line Tool</h1>
cristy3ed852e2009-09-05 21:47:34 +0000183<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
184
185<div class="doc-section">
186<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>
187</div>
188
cristydcca3fa2010-12-29 21:50:07 +0000189<h2><a id="usage"></a>Example Usage</h2>
cristy3ed852e2009-09-05 21:47:34 +0000190<div class="doc-section">
191
192<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>
193
194<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>
195<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
196
197<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>
198<p>You can also associate the region to extract with the image filename:</p>
199
200<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>
201</div>
202
cristydcca3fa2010-12-29 21:50:07 +0000203<h2><a id="options"></a>Option Summary</h2>
cristy3ed852e2009-09-05 21:47:34 +0000204<div class="doc-section">
205
206<p>The <kbd>stream</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
207
208<table class="doc">
209 <tbody>
210 <tr>
211 <th align="left">Option</th>
212 <th align="left">Description</th>
213 </tr>
214
215 <tr>
216 <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
217 <td valign="top">decrypt image with this password</td>
218 </tr>
219
220 <tr>
221 <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
222 <td valign="top">apply option to select image channels</td>
223 </tr>
224
225 <tr>
226 <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
227 <td valign="top">set image colorspace</td>
228 </tr>
229
230 <tr>
231 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
232 <td valign="top">display copious debugging information</td>
233 </tr>
234
235 <tr>
236 <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
237 <td valign="top">define one or more image format options</td>
238 </tr>
239
240 <tr>
241 <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
242 <td valign="top">horizontal and vertical density of the image</td>
243 </tr>
244
245 <tr>
246 <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
247 <td valign="top">image depth</td>
248 </tr>
249
250 <tr>
251 <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
252 <td valign="top">extract area from image</td>
253 </tr>
254
255 <tr>
256 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
257 <td valign="top">print program options</td>
258 </tr>
259
260 <tr>
261 <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
262 <td valign="top">type of image interlacing scheme</td>
263 </tr>
264
265 <tr>
266 <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
267 <td valign="top">pixel color interpolation method</td>
268 </tr>
269
270 <tr>
271 <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
272 <td valign="top">pixel cache resource limit</td>
273 </tr>
274
275 <tr>
276 <td valign="top"><a href="../www/command-line-options.html#list">-list <em class="option">type</em></a></td>
277 <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
278 </tr>
279
280 <tr>
281 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
282 <td valign="top">format of debugging information</td>
283 </tr>
284
285 <tr>
286 <td valign="top"><a href="../www/command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
287 <td valign="top">store pixels in this format.</td>
288 </tr>
289
290 <tr>
291 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
292 <td valign="top">monitor progress</td>
293 </tr>
294
295 <tr>
296 <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
297 <td valign="top">reduce image colors in this colorspace</td>
298 </tr>
299
300 <tr>
301 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
302 <td valign="top">suppress all warning messages</td>
303 </tr>
304
305 <tr>
306 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
307 <td valign="top">pay attention to warning messages.</td>
308 </tr>
309
310 <tr>
311 <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
312 <td valign="top">settings remain in effect until parenthesis boundary.</td>
313 </tr>
314
315 <tr>
316 <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
317 <td valign="top">horizontal and vertical sampling factor</td>
318 </tr>
319
320 <tr>
321 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
322 <td valign="top">seed a new sequence of pseudo-random numbers</td>
323 </tr>
324
325 <tr>
326 <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
327 <td valign="top">set an image attribute</td>
328 </tr>
329
330 <tr>
331 <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
332 <td valign="top">width and height of image</td>
333 </tr>
334
335 <tr>
336 <td valign="top"><a href="../www/command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
337 <td valign="top">store pixels with this storage type.</td>
338 </tr>
339
340 <tr>
cristy5063d812010-10-19 16:28:10 +0000341 <td valign="top"><a href="../www/command-line-options.html#synchronize">-synchronize</a></td>
342 <td valign="top">synchronize image to storage device</td>
343 </tr>
344
345 <tr>
346 <td valign="top"><a href="../www/command-line-options.html#taint">-taint</a></td>
347 <td valign="top">mark the image as modified</td>
348 </tr>
349
350 <tr>
cristy3ed852e2009-09-05 21:47:34 +0000351 <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
352 <td valign="top">transparent color</td>
353 </tr>
354
355 <tr>
356 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
357 <td valign="top">print detailed information about the image</td>
358 </tr>
359
360 <tr>
361 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
362 <td valign="top">print version information</td>
363 </tr>
364
365 <tr>
366 <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
367 <td valign="top">access method for pixels outside the boundaries of the image</td>
368 </tr>
369
370 </tbody>
371</table>
372
373</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000374
375</div>
376
377<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000378 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000379 <span id="linkbar-center">
380 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000381 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000382 </span>
383 <span id="linkbar-east">&nbsp;</span>
384 </div>
385 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +0000386 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000387 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
388 </div>
389 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000390 <script type="text/javascript">
391 var _gaq = _gaq || [];
392 _gaq.push(['_setAccount', 'UA-17690367-1']);
393 _gaq.push(['_trackPageview']);
394
395 (function() {
396 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
397 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
398 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
399 })();
400 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000401</body>
402</html>