Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ce69bb0630da050618321fbefe3c5010e5414c3d / . / www / stream.html
blob: 6f82ee579a3619a019a7946f72a5f783066363d9 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1
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 +0000[diff] [blame]4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]5<head>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]6 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]7 <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 +0000[diff] [blame]9 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]10 @import url("../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]11 </style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]12 <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 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]28</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 +0000[diff] [blame^]46<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]47
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]48<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]49 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]51<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]52<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]53 <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 +0000[diff] [blame]66 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]67</div>
68<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]69 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]70</div>
71<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]72 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]73</div>
74<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]75 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]76</div>
77<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]78 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79</div>
80<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]81 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82</div>
83<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]84 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]87 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]88</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]90 <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]91</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]92<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101 </div>
102<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]105<div class="menu">
106 <a title="Architecture" href="../www/architecture.html">Architecture</a>
107</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]108<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]109 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]111<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]115<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]117 <a title="Site Map"href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]120 <a title="Site Map: Links"href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]122<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]124 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125
126<div class="sponsbox">
127<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]128 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]129</div>
130<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]131 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristyd6a37032010-02-02 04:14:40 +0000[diff] [blame]132</div>
133<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]134 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]135</div>
136<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]137 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]138</div>
139<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyc49f7992009-09-22 22:48:40 +0000[diff] [blame]141</div>
142<div class="sponsor">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]143 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145</div>
146</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]147</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]148
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]149<div class="eastbar">
150 <script type="text/javascript">
151 <!--
152 google_ad_client = "pub-3129977114552745";
153 /* 160x600, created 7/27/10 */
154 google_ad_slot = "0574824969";
155 google_ad_width = 160;
156 google_ad_height = 600;
157 //-->
158 </script>
159 <script type="text/javascript"
160 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
161 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]162</div>
163
164<div class="main">
165
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]166<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
167
168<div class="doc-section">
169<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>
170</div>
171
172<h2><a name="usage"></a>Example Usage</h2>
173<div class="doc-section">
174
175<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>
176
177<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>
178<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
179
180<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>
181<p>You can also associate the region to extract with the image filename:</p>
182
183<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>
184</div>
185
186<h2><a name="options"></a>Option Summary</h2>
187<div class="doc-section">
188
189<p>The <kbd>stream</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
190
191<table class="doc">
192 <tbody>
193 <tr>
194 <th align="left">Option</th>
195 <th align="left">Description</th>
196 </tr>
197
198 <tr>
199 <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
200 <td valign="top">decrypt image with this password</td>
201 </tr>
202
203 <tr>
204 <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
205 <td valign="top">apply option to select image channels</td>
206 </tr>
207
208 <tr>
209 <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
210 <td valign="top">set image colorspace</td>
211 </tr>
212
213 <tr>
214 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
215 <td valign="top">display copious debugging information</td>
216 </tr>
217
218 <tr>
219 <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
220 <td valign="top">define one or more image format options</td>
221 </tr>
222
223 <tr>
224 <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
225 <td valign="top">horizontal and vertical density of the image</td>
226 </tr>
227
228 <tr>
229 <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
230 <td valign="top">image depth</td>
231 </tr>
232
233 <tr>
234 <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
235 <td valign="top">extract area from image</td>
236 </tr>
237
238 <tr>
239 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
240 <td valign="top">print program options</td>
241 </tr>
242
243 <tr>
244 <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
245 <td valign="top">type of image interlacing scheme</td>
246 </tr>
247
248 <tr>
249 <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
250 <td valign="top">pixel color interpolation method</td>
251 </tr>
252
253 <tr>
254 <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
255 <td valign="top">pixel cache resource limit</td>
256 </tr>
257
258 <tr>
259 <td valign="top"><a href="../www/command-line-options.html#list">-list <em class="option">type</em></a></td>
260 <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
261 </tr>
262
263 <tr>
264 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
265 <td valign="top">format of debugging information</td>
266 </tr>
267
268 <tr>
269 <td valign="top"><a href="../www/command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
270 <td valign="top">store pixels in this format.</td>
271 </tr>
272
273 <tr>
274 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
275 <td valign="top">monitor progress</td>
276 </tr>
277
278 <tr>
279 <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
280 <td valign="top">reduce image colors in this colorspace</td>
281 </tr>
282
283 <tr>
284 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
285 <td valign="top">suppress all warning messages</td>
286 </tr>
287
288 <tr>
289 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
290 <td valign="top">pay attention to warning messages.</td>
291 </tr>
292
293 <tr>
294 <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
295 <td valign="top">settings remain in effect until parenthesis boundary.</td>
296 </tr>
297
298 <tr>
299 <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
300 <td valign="top">horizontal and vertical sampling factor</td>
301 </tr>
302
303 <tr>
304 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
305 <td valign="top">seed a new sequence of pseudo-random numbers</td>
306 </tr>
307
308 <tr>
309 <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
310 <td valign="top">set an image attribute</td>
311 </tr>
312
313 <tr>
314 <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
315 <td valign="top">width and height of image</td>
316 </tr>
317
318 <tr>
319 <td valign="top"><a href="../www/command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
320 <td valign="top">store pixels with this storage type.</td>
321 </tr>
322
323 <tr>
324 <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
325 <td valign="top">transparent color</td>
326 </tr>
327
328 <tr>
329 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
330 <td valign="top">print detailed information about the image</td>
331 </tr>
332
333 <tr>
334 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
335 <td valign="top">print version information</td>
336 </tr>
337
338 <tr>
339 <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
340 <td valign="top">access method for pixels outside the boundaries of the image</td>
341 </tr>
342
343 </tbody>
344</table>
345
346</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]347
348</div>
349
350<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame^]351 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]352 <span id="linkbar-center">
353 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]354 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]355 </span>
356 <span id="linkbar-east">&nbsp;</span>
357 </div>
358 <div class="footer">
359 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
360 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
361 </div>
362 <div style="clear: both; margin: 0; width: 100%; "></div>
363</body>
364</html>