root / ImageMagick / trunk / www / stream.html

Revision 11927, 15.7 kB (checked in by cristy, 3 days ago)
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
4<head>
5  <style type="text/css" media="screen,projection"><!--
6    @import url("../www/magick.css");
7  //--></style>
8  <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
9  <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
10  <title>ImageMagick: Command-line Tools: Stream</title>
11  <meta http-equiv="Content-Language" content="en-US"/>
12  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
13  <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
14  <meta name="Generator" content="PHP"/>
15  <meta name="Keywords" content="command-line, tools:, stream, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject"/>
16  <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."/>
17  <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"/>
23  <meta name="Copyright" content="Copyright (c) 1999-2008 ImageMagick Studio LLC"/>
24  <meta name="Distribution" content="Global"/>
25  <link rel="shortcut icon" href="../images/wand.ico"  type="images/vnd.microsoft.icon"/>
26</head>
27
28<body id="www-imagemagick-org">
29  <table id="titlebar" style="width: 100%;background-color: #f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="ImageMagick">
30    <tbody>
31      <tr valign="top">
32        <td align="left"><a href="../index.html"><img id="titlebar-west" src="../images/script.png" alt="[ImageMagick]" width="350" height="60" vspace="28" name="titlebar-west"/></a></td>
33        <td align="left"><a href="https://secure.networkredux.com/affiliate/idevaffiliate.html?id=146" target="1040876748"><img id="titlebar-west" src="../images/networkredux.png" alt="[sponsor]" border="0" vspace="45" name="titlebar-west"/></a></td>
34        <td width="99%"><br /> </td>
35        <td style="background-color: white" align="right"><a href="../index.html"><img src="../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
36        <td style="background-color: white" align="right"><a href="http://www.imagemagick.org/discourse-server/" target="2013400712"><img id="titlebar-east" src="../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
37      </tr>
38    </tbody>
39  </table>
40
41  <table style="width: 100%" border="0" cellpadding="0" cellspacing="0" summary="">
42  <tbody>
43
44    <tr valign="top" style="height: 100%;">
45      <td id="menu" width="1%" height="100%">
46      <p><a href="#main">Skip to page contents</a></p>
47      <font size="-1">
48      <span>[</span>
49      <a href="../index.html">About ImageMagick</a>
50  <span>]</span><br /><span>[</span>
51      <a href="../www/command-line-tools.html">Command-line Tools</a>
52      <a href="../www/command-line-processing.html" class="sub">Processing</a>
53      <a href="../www/command-line-options.html" class="sub">Options</a>
54      <a href="http://www.imagemagick.org/Usage/" target="1673768117" class="sub">Usage</a>
55      <a href="../www/api.html">Program Interfaces</a>
56      <a href="../www/magick-wand.html" class="sub">MagickWand</a>
57      <a href="../www/magick-core.html" class="sub">MagickCore</a>
58      <a href="../www/perl-magick.html" class="sub">PerlMagick</a>
59      <a href="../www/Magick++/" target="844363297" class="sub">Magick++</a>
60      <a href="../www/architecture.html">Architecture</a>
61  <span>]</span><br /><span>[</span>
62      <a href="../www/install-source.html">Install from Source</a>
63      <a href="../www/install-source.html#unix" class="sub">Unix</a>
64      <a href="../www/install-source.html#windows" class="sub">Windows</a>
65      <a href="../www/binary-releases.html">Binary Releases</a>
66      <a href="../www/binary-releases.html#unix" class="sub">Unix</a>
67      <a href="../www/binary-releases.html#macosx" class="sub">Mac OS X</a>
68      <a href="../www/binary-releases.html#windows" class="sub">Windows</a>
69      <a href="../www/resources.html">Resources</a>
70  <span>]</span><br /><span>[</span>
71      <a href="../www/download.html">Download</a>
72  <span>]</span><br /><span>[</span>
73      <a href="../www/sitemap.html">Site Map</a>
74                        <a href="../www/links.html" class="sub">Links</a>
75  <span>]</span><br /><span>[</span>
76      <a href="../www/sponsors.html">Sponsors:</a>
77      <fieldset>
78  <a href="http://www.nationalrelocation.com/real-estate/" class="sponsor" target="sponsor">Real Estate</a><!-- 200902010250 -->
79      <br />
80      <a href="http://www.brothersoft.com" class="sponsor" target="sponsor">Software Download</a><!-- 200809010200 -->
81      <br />
82      <a href="http://www.posters555.com" class="sponsor" target="sponsor">Poster</a><!-- 200903010800 -->
83      <br />
84      <a href="http://www.iceposter.com" class="sponsor" target="sponsor">Posters</a><!-- 200812010200 -->
85      <br />
86      <a href="http://meta-preisvergleich.de" class="sponsor" target="sponsor">Preisvergleich</a><!-- 200810010120 -->
87      <br />
88      <a href="http://www.hotel-erb.de"><img src="../images/bw_erb.gif" alt="[Munich Hotel]" width="110" height="40" border="0" name="Munich Hotel"/></a> <!-- 200809010160 -->
89      <br />
90      <a href="http://www.imade-art.de"><img src="../images/imade_art2.jpg" alt="[Kunst bei imade-art]" width="116" height="28" border="0" name="Kunst bei imade-art"/></a> <!-- 200811010160 -->
91      </fieldset>
92      <span>]</span>
93      </font>
94      </td>
95
96      <td id="main" valign="top">
97<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
98
99<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>
100
101<div style="margin: auto;">
102  <h2><a name="usage"></a>Example Usage</h2>
103</div>
104
105<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>
106
107<pre class="text">
108  stream -map rgb -storage-type char image.jpg pixels.dat
109  display -depth 8 -size 640x480 rgb:pixels.dat
110</pre>
111
112<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
113
114<pre class="text">
115  stream -map i -storage-type double -extract 100x100+30+40 image.tif gray.raw
116</pre>
117
118<p>You can also associate the region to extract with the image filename:</p>
119
120<pre class="text">
121  stream -map i -storage-type double 'image.tif[100x100+30+40]' gray.raw
122</pre>
123
124<div style="margin: auto;">
125  <h2><a name="options"></a>Option Summary</h2>
126</div>
127
128<p>The <kbd>stream</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
129
130<table id="table" cellpadding="2" cellspacing="0" style="width: 93%">
131  <tbody>
132  <tr>
133    <th align="left">Option</th>
134    <th align="left">Description</th>
135  </tr>
136
137  <tr>
138    <td valign="top"><a href="../www/command-line-options.html#authenticate" target="magick-options">-authenticate <em class="option">value</em></a></td>
139    <td valign="top">decrypt image with this password</td>
140  </tr>
141
142  <tr>
143    <td valign="top"><a href="../www/command-line-options.html#channel" target="magick-options">-channel <em class="option">type</em></a></td>
144    <td valign="top">apply option to select image channels</td>
145  </tr>
146
147  <tr>
148    <td valign="top"><a href="../www/command-line-options.html#colorspace" target="magick-options">-colorspace <em class="option">type</em></a></td>
149    <td valign="top">set image colorspace</td>
150  </tr>
151
152  <tr>
153    <td valign="top"><a href="../www/command-line-options.html#debug" target="magick-options">-debug <em class="option">events</em></a></td>
154    <td valign="top">display copious debugging information</td>
155  </tr>
156
157  <tr>
158    <td valign="top"><a href="../www/command-line-options.html#define" target="magick-options">-define <em class="option">format:option</em></a></td>
159    <td valign="top">define one or more image format options</td>
160  </tr>
161
162  <tr>
163    <td valign="top"><a href="../www/command-line-options.html#density" target="magick-options">-density <em class="option">geometry</em></a></td>
164    <td valign="top">horizontal and vertical density of the image</td>
165  </tr>
166
167  <tr>
168    <td valign="top"><a href="../www/command-line-options.html#depth" target="magick-options">-depth <em class="option">value</em></a></td>
169    <td valign="top">image depth</td>
170  </tr>
171
172  <tr>
173    <td valign="top"><a href="../www/command-line-options.html#extract" target="magick-options">-extract <em class="option">geometry</em></a></td>
174    <td valign="top">extract area from image</td>
175  </tr>
176
177  <tr>
178    <td valign="top"><a href="../www/command-line-options.html#help" target="magick-options">-help</a></td>
179    <td valign="top">print program options</td>
180  </tr>
181
182  <tr>
183    <td valign="top"><a href="../www/command-line-options.html#interlace" target="magick-options">-interlace <em class="option">type</em></a></td>
184    <td valign="top">type of image interlacing scheme</td>
185  </tr>
186
187  <tr>
188    <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
189    <td valign="top">pixel color interpolation method</td>
190  </tr>
191
192  <tr>
193    <td valign="top"><a href="../www/command-line-options.html#limit" target="magick-options">-limit <em class="option">type value</em></a></td>
194    <td valign="top">pixel cache resource limit</td>
195  </tr>
196
197  <tr>
198    <td valign="top"><a href="../www/command-line-options.html#list" target="magick-options">-list <em class="option">type</em></a></td>
199    <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
200  </tr>
201
202  <tr>
203    <td valign="top"><a href="../www/command-line-options.html#log" target="magick-options">-log <em class="option">format</em></a></td>
204    <td valign="top">format of debugging information</td>
205  </tr>
206
207  <tr>
208    <td valign="top"><a href="../www/command-line-options.html#stream-map" target="magick-options">-map <em class="option">components</em></a></td>
209    <td valign="top">store pixels in this format.</td>
210  </tr>
211
212  <tr>
213    <td valign="top"><a href="../www/command-line-options.html#monitor" target="magick-options">-monitor</a></td>
214    <td valign="top">monitor progress</td>
215  </tr>
216
217  <tr>
218    <td valign="top"><a href="../www/command-line-options.html#quantize" target="magick-options">-quantize <em class="option">colorspace</em></a></td>
219    <td valign="top">reduce image colors in this colorspace</td>
220  </tr>
221
222  <tr>
223    <td valign="top"><a href="../www/command-line-options.html#quiet" target="magick-options">-quiet</a></td>
224    <td valign="top">suppress all warning messages</td>
225  </tr>
226
227  <tr>
228    <td valign="top"><a href="../www/command-line-options.html#regard-warnings" target="magick-options">-regard-warnings</a></td>
229    <td valign="top">pay attention to warning messages.</td>
230  </tr>
231
232  <tr>
233    <td valign="top"><a href="../www/command-line-options.html#respect-parenthesis" target="magick-options">-respect-parenthesis</a></td>
234    <td valign="top">settings remain in effect until parenthesis boundary.</td>
235  </tr>
236
237  <tr>
238    <td valign="top"><a href="../www/command-line-options.html#sampling-factor" target="magick-options">-sampling-factor <em class="option">geometry</em></a></td>
239    <td valign="top">horizontal and vertical sampling factor</td>
240  </tr>
241
242  <tr>
243    <td valign="top"><a href="../www/command-line-options.html#seed" target="magick-options">-seed <em class="option">value</em></a></td>
244    <td valign="top">seed a new sequence of pseudo-random numbers</td>
245  </tr>
246
247  <tr>
248    <td valign="top"><a href="../www/command-line-options.html#set" target="magick-options">-set <em class="option">attribute value</em></a></td>
249    <td valign="top">set an image attribute</td>
250  </tr>
251
252  <tr>
253    <td valign="top"><a href="../www/command-line-options.html#size" target="magick-options">-size <em class="option">geometry</em></a></td>
254    <td valign="top">width and height of image</td>
255  </tr>
256
257  <tr>
258    <td valign="top"><a href="../www/command-line-options.html#storage-type" target="magick-options">-storage-type <em class="option">type</em></a></td>
259    <td valign="top">store pixels with this storage type.</td>
260  </tr>
261
262  <tr>
263    <td valign="top"><a href="../www/command-line-options.html#transparent-color" target="magick-options">-transparent-color <em class="option">color</em></a></td>
264    <td valign="top">transparent color</td>
265  </tr>
266
267  <tr>
268    <td valign="top"><a href="../www/command-line-options.html#verbose" target="magick-options">-verbose</a></td>
269    <td valign="top">print detailed information about the image</td>
270  </tr>
271
272  <tr>
273    <td valign="top"><a href="../www/command-line-options.html#version" target="magick-options">-version</a></td>
274    <td valign="top">print version information</td>
275  </tr>
276
277  <tr>
278    <td valign="top"><a href="../www/command-line-options.html#virtual-pixel" target="magick-options">-virtual-pixel <em class="option">method</em></a></td>
279    <td valign="top">access method for pixels outside the boundaries of the image</td>
280  </tr>
281
282  </tbody>
283</table>
284      </td>
285      <td id="margin" width="1%" height="100%" valign="top" align="right">&nbsp;</td>
286    </tr>
287  </tbody>
288  </table>
289  <div id="linkbar">
290    <span id="linkbar-west">
291      <font size="-1">
292      <a href="http://www.downloadroute.com/" target="1606457536">Downloads and Opinions</a><!-- 200810010100 -->
293      </font>
294    </span>
295    <span id="linkbar-center">
296      <a href="http://www.imagemagick.org/discourse-server/" target="267589032">Discourse Server</a> &bull;
297      <a href="../www/mailing-list.html">Mailing Lists</a> &bull;
298      <a href="http://cafe.imagemagick.org" target="434870782">Cafe</a> &bull;
299    <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="47967750">Studio</a>
300    </span>
301  </div>
302  <div id="footer">
303    <span id="footer-west">&copy; 1999-2008 ImageMagick Studio LLC</span>
304  </div>
305  <div style="clear: both; margin: 0; width: 100%; "></div>
306</body>
307</html>
Note: See TracBrowser for help on using the browser.