blob: 2fc73f4b223bb29d44f8de22f7643e7f87639fb3 [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>
cristy3de29cc2010-04-15 02:34:44 +00006 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +00007 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
8 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +00009 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +000010 @import url("../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +000011 </style>
cristy3ed852e2009-09-05 21:47:34 +000012 <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/>
13 <title>ImageMagick: Command-line Tools: Stream</title>
14 <meta http-equiv="Content-Language" content="en-US"/>
15 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
16 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
17 <meta name="Generator" content="PHP"/>
18 <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"/>
19 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
20 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +000026 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000027 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +000028</head>
29
30<body id="www-imagemagick-org">
31<div class="titlebar">
32<a href="../index.html">
33 <img src="../images/script.png" alt="[ImageMagick]"
34 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
35<a href="http://www.networkredux.com">
36 <img src="../images/networkredux.png" alt="[sponsor]"
37 style="margin: 45px auto; border: 0px; float: left;" /></a>
38<a href="http://www.imagemagick.org/discourse-server/">
39 <img src="../images/logo.jpg" alt=""
40 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
41<a href="../index.html">
42 <img src="../images/sprite.jpg" alt=""
43 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
44</div>
45
cristyce69bb02010-07-27 19:49:46 +000046<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000047
cristy3ed852e2009-09-05 21:47:34 +000048<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000049 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000050</div>
cristy3eaa0ef2010-03-06 20:35:26 +000051<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000052<div class="menu">
cristybb503372010-05-27 20:51:26 +000053 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
54</div>
55<div class="sub">
56 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
57</div>
58<div class="sub">
59 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
60</div>
61<div class="sub">
62 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
63</div>
64<div class="sep"></div>
65<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000066 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000067</div>
68<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000069 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</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: Options" href="../www/command-line-options.html">Options</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: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000076</div>
77<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000078 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000079</div>
80<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000081 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000082</div>
83<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000084 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000085</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000087 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000088</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000090 <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000091</div>
cristy3eaa0ef2010-03-06 20:35:26 +000092<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000093<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000094 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</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: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000101 </div>
102<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
cristybb503372010-05-27 20:51:26 +0000105<div class="menu">
106 <a title="Architecture" href="../www/architecture.html">Architecture</a>
107</div>
cristy3ed852e2009-09-05 21:47:34 +0000108<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000111<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000112<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000113 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000114</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000115<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000116<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000117 <a title="Site Map"href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000118</div>
119<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000120 <a title="Site Map: Links"href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000121</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000122<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000123<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000124 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000125
126<div class="sponsbox">
127<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000128 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
129</div>
130<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000131 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy2c839602010-04-03 02:32:08 +0000132</div>
133<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000134 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristyd6a37032010-02-02 04:14:40 +0000135</div>
136<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000137 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy1f9e1ed2009-11-18 04:09:38 +0000138</div>
139<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000140 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000141</div>
142<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000143 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyc49f7992009-09-22 22:48:40 +0000144</div>
145<div class="sponsor">
cristy9c60d3f2010-08-09 02:29:30 +0000146 <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
cristy3ed852e2009-09-05 21:47:34 +0000147</div>
cristy3ed852e2009-09-05 21:47:34 +0000148</div>
149</div>
cristyce69bb02010-07-27 19:49:46 +0000150</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000151
cristyce69bb02010-07-27 19:49:46 +0000152<div class="eastbar">
153 <script type="text/javascript">
154 <!--
155 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000156 google_ad_slot = "0574824969";
157 google_ad_width = 160;
158 google_ad_height = 600;
159 //-->
160 </script>
161 <script type="text/javascript"
162 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
163 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000164</div>
165
166<div class="main">
167
cristy3ed852e2009-09-05 21:47:34 +0000168<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
169
170<div class="doc-section">
171<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>
172</div>
173
174<h2><a name="usage"></a>Example Usage</h2>
175<div class="doc-section">
176
177<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>
178
179<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>
180<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
181
182<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>
183<p>You can also associate the region to extract with the image filename:</p>
184
185<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>
186</div>
187
188<h2><a name="options"></a>Option Summary</h2>
189<div class="doc-section">
190
191<p>The <kbd>stream</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
192
193<table class="doc">
194 <tbody>
195 <tr>
196 <th align="left">Option</th>
197 <th align="left">Description</th>
198 </tr>
199
200 <tr>
201 <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
202 <td valign="top">decrypt image with this password</td>
203 </tr>
204
205 <tr>
206 <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
207 <td valign="top">apply option to select image channels</td>
208 </tr>
209
210 <tr>
211 <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
212 <td valign="top">set image colorspace</td>
213 </tr>
214
215 <tr>
216 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
217 <td valign="top">display copious debugging information</td>
218 </tr>
219
220 <tr>
221 <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
222 <td valign="top">define one or more image format options</td>
223 </tr>
224
225 <tr>
226 <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
227 <td valign="top">horizontal and vertical density of the image</td>
228 </tr>
229
230 <tr>
231 <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
232 <td valign="top">image depth</td>
233 </tr>
234
235 <tr>
236 <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
237 <td valign="top">extract area from image</td>
238 </tr>
239
240 <tr>
241 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
242 <td valign="top">print program options</td>
243 </tr>
244
245 <tr>
246 <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
247 <td valign="top">type of image interlacing scheme</td>
248 </tr>
249
250 <tr>
251 <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
252 <td valign="top">pixel color interpolation method</td>
253 </tr>
254
255 <tr>
256 <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
257 <td valign="top">pixel cache resource limit</td>
258 </tr>
259
260 <tr>
261 <td valign="top"><a href="../www/command-line-options.html#list">-list <em class="option">type</em></a></td>
262 <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
263 </tr>
264
265 <tr>
266 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
267 <td valign="top">format of debugging information</td>
268 </tr>
269
270 <tr>
271 <td valign="top"><a href="../www/command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
272 <td valign="top">store pixels in this format.</td>
273 </tr>
274
275 <tr>
276 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
277 <td valign="top">monitor progress</td>
278 </tr>
279
280 <tr>
281 <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
282 <td valign="top">reduce image colors in this colorspace</td>
283 </tr>
284
285 <tr>
286 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
287 <td valign="top">suppress all warning messages</td>
288 </tr>
289
290 <tr>
291 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
292 <td valign="top">pay attention to warning messages.</td>
293 </tr>
294
295 <tr>
296 <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
297 <td valign="top">settings remain in effect until parenthesis boundary.</td>
298 </tr>
299
300 <tr>
301 <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
302 <td valign="top">horizontal and vertical sampling factor</td>
303 </tr>
304
305 <tr>
306 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
307 <td valign="top">seed a new sequence of pseudo-random numbers</td>
308 </tr>
309
310 <tr>
311 <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
312 <td valign="top">set an image attribute</td>
313 </tr>
314
315 <tr>
316 <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
317 <td valign="top">width and height of image</td>
318 </tr>
319
320 <tr>
321 <td valign="top"><a href="../www/command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
322 <td valign="top">store pixels with this storage type.</td>
323 </tr>
324
325 <tr>
326 <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
327 <td valign="top">transparent color</td>
328 </tr>
329
330 <tr>
331 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
332 <td valign="top">print detailed information about the image</td>
333 </tr>
334
335 <tr>
336 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
337 <td valign="top">print version information</td>
338 </tr>
339
340 <tr>
341 <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
342 <td valign="top">access method for pixels outside the boundaries of the image</td>
343 </tr>
344
345 </tbody>
346</table>
347
348</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000349
350</div>
351
352<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000353 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000354 <span id="linkbar-center">
355 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000356 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000357 </span>
358 <span id="linkbar-east">&nbsp;</span>
359 </div>
360 <div class="footer">
361 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
362 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
363 </div>
364 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000365 <script type="text/javascript">
366 var _gaq = _gaq || [];
367 _gaq.push(['_setAccount', 'UA-17690367-1']);
368 _gaq.push(['_trackPageview']);
369
370 (function() {
371 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
372 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
373 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
374 })();
375 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000376</body>
377</html>