Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 3ed852eea50f9d4cd633efb8c2b054b8e33c2530 / . / www / stream.html
blob: 1b63987c260a16231984c7c29024ebecf19b644a [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +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">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../www/magick.css");
10 --></style>
11 <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: Command-line Tools: Stream</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <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"/>
18 <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."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
25 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
26 <meta name="Distribution" content="Global"/>
27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../index.html">
32 <img src="../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../index.html">
41 <img src="../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
47<div class="menu">
48 <a href="../index.html">About ImageMagick</a>
49</div>
50<div class="sep"></div>
51<div class="menu">
52 <a href="../www/command-line-tools.html">Command-line Tools</a>
53</div>
54<div class="sub">
55 <a href="../www/command-line-processing.html">Processing</a>
56</div>
57<div class="sub">
58 <a href="../www/command-line-options.html">Options</a>
59</div>
60<div class="sub">
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
62</div>
63<div class="menu">
64 <a href="../www/api.html">Program Interfaces</a>
65</div>
66<div class="sub">
67 <a href="../www/magick-wand.html">MagickWand</a>
68</div>
69<div class="sub">
70 <a href="../www/magick-core.html">MagickCore</a>
71</div>
72<div class="sub">
73 <a href="../www/perl-magick.html">PerlMagick</a>
74</div>
75<div class="sub">
76 <a href="../Magick++/">Magick++</a>
77</div>
78<div class="menu">
79 <a href="../www/architecture.html">Architecture</a>
80</div>
81<div class="sep"></div>
82<div class="menu">
83 <a href="../www/install-source.html">Install from Source</a>
84</div>
85<div class="sub">
86 <a href="../www/install-source.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a href="../www/install-source.html#windows">Windows</a>
90 </div>
91<div class="menu">
92 <a href="../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a href="../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a href="../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
101 <a href="../www/binary-releases.html#windows">Windows</a>
102</div>
103<div class="menu">
104 <a href="../www/resources.html">Resources</a>
105</div>
106<div class="sep"></div>
107<div class="menu">
108 <a href="../www/download.html">Download</a>
109</div>
110<div class="sep"></div>
111<div class="menu">
112 <a href="http://www.imagemagick.org/script/search.php">Search</a>
113</div>
114<div class="sep"></div>
115<div class="menu">
116 <a href="../www/sitemap.html">Site Map</a>
117</div>
118<div class="sub">
119 <a href="../www/links.html">Links</a>
120</div>
121<div class="sep"></div>
122<div class="menu">
123 <a href="../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
127 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
128</div>
129<div class="sponsor">
130 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
131</div>
132<div class="sponsor">
133 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
134</div>
135<div class="sponsor">
136 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
137</div>
138<div class="sponsor">
139 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
140</div>
141</div>
142</div>
143
144
145</div>
146
147<div class="main">
148
149<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
150
151<div class="doc-section">
152<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>
153</div>
154
155<h2><a name="usage"></a>Example Usage</h2>
156<div class="doc-section">
157
158<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>
159
160<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>
161<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
162
163<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>
164<p>You can also associate the region to extract with the image filename:</p>
165
166<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>
167</div>
168
169<h2><a name="options"></a>Option Summary</h2>
170<div class="doc-section">
171
172<p>The <kbd>stream</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
173
174<table class="doc">
175 <tbody>
176 <tr>
177 <th align="left">Option</th>
178 <th align="left">Description</th>
179 </tr>
180
181 <tr>
182 <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
183 <td valign="top">decrypt image with this password</td>
184 </tr>
185
186 <tr>
187 <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
188 <td valign="top">apply option to select image channels</td>
189 </tr>
190
191 <tr>
192 <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
193 <td valign="top">set image colorspace</td>
194 </tr>
195
196 <tr>
197 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
198 <td valign="top">display copious debugging information</td>
199 </tr>
200
201 <tr>
202 <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
203 <td valign="top">define one or more image format options</td>
204 </tr>
205
206 <tr>
207 <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
208 <td valign="top">horizontal and vertical density of the image</td>
209 </tr>
210
211 <tr>
212 <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
213 <td valign="top">image depth</td>
214 </tr>
215
216 <tr>
217 <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
218 <td valign="top">extract area from image</td>
219 </tr>
220
221 <tr>
222 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
223 <td valign="top">print program options</td>
224 </tr>
225
226 <tr>
227 <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
228 <td valign="top">type of image interlacing scheme</td>
229 </tr>
230
231 <tr>
232 <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
233 <td valign="top">pixel color interpolation method</td>
234 </tr>
235
236 <tr>
237 <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
238 <td valign="top">pixel cache resource limit</td>
239 </tr>
240
241 <tr>
242 <td valign="top"><a href="../www/command-line-options.html#list">-list <em class="option">type</em></a></td>
243 <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
244 </tr>
245
246 <tr>
247 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
248 <td valign="top">format of debugging information</td>
249 </tr>
250
251 <tr>
252 <td valign="top"><a href="../www/command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
253 <td valign="top">store pixels in this format.</td>
254 </tr>
255
256 <tr>
257 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
258 <td valign="top">monitor progress</td>
259 </tr>
260
261 <tr>
262 <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
263 <td valign="top">reduce image colors in this colorspace</td>
264 </tr>
265
266 <tr>
267 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
268 <td valign="top">suppress all warning messages</td>
269 </tr>
270
271 <tr>
272 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
273 <td valign="top">pay attention to warning messages.</td>
274 </tr>
275
276 <tr>
277 <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
278 <td valign="top">settings remain in effect until parenthesis boundary.</td>
279 </tr>
280
281 <tr>
282 <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
283 <td valign="top">horizontal and vertical sampling factor</td>
284 </tr>
285
286 <tr>
287 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
288 <td valign="top">seed a new sequence of pseudo-random numbers</td>
289 </tr>
290
291 <tr>
292 <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
293 <td valign="top">set an image attribute</td>
294 </tr>
295
296 <tr>
297 <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
298 <td valign="top">width and height of image</td>
299 </tr>
300
301 <tr>
302 <td valign="top"><a href="../www/command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
303 <td valign="top">store pixels with this storage type.</td>
304 </tr>
305
306 <tr>
307 <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
308 <td valign="top">transparent color</td>
309 </tr>
310
311 <tr>
312 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
313 <td valign="top">print detailed information about the image</td>
314 </tr>
315
316 <tr>
317 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
318 <td valign="top">print version information</td>
319 </tr>
320
321 <tr>
322 <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
323 <td valign="top">access method for pixels outside the boundaries of the image</td>
324 </tr>
325
326 </tbody>
327</table>
328
329</div>
330
331</div>
332
333<div id="linkbar">
334 <!-- <span id="linkbar-west">&nbsp;</span> -->
335 <span id="linkbar-center">
336 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
337 <a href="../www/mailing-list.html">Mailing Lists</a> &bull;
338 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
339 </span>
340 <span id="linkbar-east">&nbsp;</span>
341 </div>
342 <div class="footer">
343 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
344 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
345 </div>
346 <div style="clear: both; margin: 0; width: 100%; "></div>
347</body>
348</html>