blob: 6bc69efb4cf4e1bf1333db75a20f92eaf3b86881 [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=""
57 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
58<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">
cristyec6b4752011-01-08 03:16:23 +0000144<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000145 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000146</div>
147<div class="sponsor">
148 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +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">
cristy52923442011-01-15 22:54:31 +0000157 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristyec6b4752011-01-08 03:16:23 +0000158</div>
cristy3ed852e2009-09-05 21:47:34 +0000159</div>
160</div>
cristyce69bb02010-07-27 19:49:46 +0000161</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000162
cristyce69bb02010-07-27 19:49:46 +0000163<div class="eastbar">
164 <script type="text/javascript">
165 <!--
166 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000167 google_ad_slot = "0574824969";
168 google_ad_width = 160;
169 google_ad_height = 600;
170 //-->
171 </script>
172 <script type="text/javascript"
173 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
174 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000175</div>
176
177<div class="main">
178
cristydcca3fa2010-12-29 21:50:07 +0000179<h1>ImageMagick Stream Command-line Tool</h1>
cristy3ed852e2009-09-05 21:47:34 +0000180<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
181
182<div class="doc-section">
183<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>
184</div>
185
cristydcca3fa2010-12-29 21:50:07 +0000186<h2><a id="usage"></a>Example Usage</h2>
cristy3ed852e2009-09-05 21:47:34 +0000187<div class="doc-section">
188
189<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>
190
191<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>
192<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
193
194<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>
195<p>You can also associate the region to extract with the image filename:</p>
196
197<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>
198</div>
199
cristydcca3fa2010-12-29 21:50:07 +0000200<h2><a id="options"></a>Option Summary</h2>
cristy3ed852e2009-09-05 21:47:34 +0000201<div class="doc-section">
202
203<p>The <kbd>stream</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
204
205<table class="doc">
206 <tbody>
207 <tr>
208 <th align="left">Option</th>
209 <th align="left">Description</th>
210 </tr>
211
212 <tr>
213 <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
214 <td valign="top">decrypt image with this password</td>
215 </tr>
216
217 <tr>
218 <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
219 <td valign="top">apply option to select image channels</td>
220 </tr>
221
222 <tr>
223 <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
224 <td valign="top">set image colorspace</td>
225 </tr>
226
227 <tr>
228 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
229 <td valign="top">display copious debugging information</td>
230 </tr>
231
232 <tr>
233 <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
234 <td valign="top">define one or more image format options</td>
235 </tr>
236
237 <tr>
238 <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
239 <td valign="top">horizontal and vertical density of the image</td>
240 </tr>
241
242 <tr>
243 <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
244 <td valign="top">image depth</td>
245 </tr>
246
247 <tr>
248 <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
249 <td valign="top">extract area from image</td>
250 </tr>
251
252 <tr>
253 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
254 <td valign="top">print program options</td>
255 </tr>
256
257 <tr>
258 <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
259 <td valign="top">type of image interlacing scheme</td>
260 </tr>
261
262 <tr>
263 <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
264 <td valign="top">pixel color interpolation method</td>
265 </tr>
266
267 <tr>
268 <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
269 <td valign="top">pixel cache resource limit</td>
270 </tr>
271
272 <tr>
273 <td valign="top"><a href="../www/command-line-options.html#list">-list <em class="option">type</em></a></td>
274 <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
275 </tr>
276
277 <tr>
278 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
279 <td valign="top">format of debugging information</td>
280 </tr>
281
282 <tr>
283 <td valign="top"><a href="../www/command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
284 <td valign="top">store pixels in this format.</td>
285 </tr>
286
287 <tr>
288 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
289 <td valign="top">monitor progress</td>
290 </tr>
291
292 <tr>
293 <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
294 <td valign="top">reduce image colors in this colorspace</td>
295 </tr>
296
297 <tr>
298 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
299 <td valign="top">suppress all warning messages</td>
300 </tr>
301
302 <tr>
303 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
304 <td valign="top">pay attention to warning messages.</td>
305 </tr>
306
307 <tr>
308 <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
309 <td valign="top">settings remain in effect until parenthesis boundary.</td>
310 </tr>
311
312 <tr>
313 <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
314 <td valign="top">horizontal and vertical sampling factor</td>
315 </tr>
316
317 <tr>
318 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
319 <td valign="top">seed a new sequence of pseudo-random numbers</td>
320 </tr>
321
322 <tr>
323 <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
324 <td valign="top">set an image attribute</td>
325 </tr>
326
327 <tr>
328 <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
329 <td valign="top">width and height of image</td>
330 </tr>
331
332 <tr>
333 <td valign="top"><a href="../www/command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
334 <td valign="top">store pixels with this storage type.</td>
335 </tr>
336
337 <tr>
cristy5063d812010-10-19 16:28:10 +0000338 <td valign="top"><a href="../www/command-line-options.html#synchronize">-synchronize</a></td>
339 <td valign="top">synchronize image to storage device</td>
340 </tr>
341
342 <tr>
343 <td valign="top"><a href="../www/command-line-options.html#taint">-taint</a></td>
344 <td valign="top">mark the image as modified</td>
345 </tr>
346
347 <tr>
cristy3ed852e2009-09-05 21:47:34 +0000348 <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
349 <td valign="top">transparent color</td>
350 </tr>
351
352 <tr>
353 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
354 <td valign="top">print detailed information about the image</td>
355 </tr>
356
357 <tr>
358 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
359 <td valign="top">print version information</td>
360 </tr>
361
362 <tr>
363 <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
364 <td valign="top">access method for pixels outside the boundaries of the image</td>
365 </tr>
366
367 </tbody>
368</table>
369
370</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000371
372</div>
373
374<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000375 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000376 <span id="linkbar-center">
377 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000378 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000379 </span>
380 <span id="linkbar-east">&nbsp;</span>
381 </div>
382 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +0000383 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000384 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
385 </div>
386 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000387 <script type="text/javascript">
388 var _gaq = _gaq || [];
389 _gaq.push(['_setAccount', 'UA-17690367-1']);
390 _gaq.push(['_trackPageview']);
391
392 (function() {
393 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
394 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
395 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
396 })();
397 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000398</body>
399</html>