• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1
2
3
4
5<!DOCTYPE html>
6<html lang="en">
7<head>
8    <title>ImageMagick: Command-line Tools: Stream</title>
9  <meta charset="utf-8" />
10  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
11  <meta name="viewport" content="width=device-width, initial-scale=1" />
12  <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
13  <meta name="application-name" content="ImageMagick"/>
14  <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves."/>
15  <meta name="application-url" content="http://www.imagemagick.org"/>
16  <meta name="generator" content="PHP"/>
17  <meta name="keywords" content="command-line, tools:, stream, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/>
18  <meta name="rating" content="GENERAL"/>
19  <meta name="robots" content="INDEX, FOLLOW"/>
20  <meta name="generator" content="ImageMagick Studio LLC"/>
21  <meta name="author" content="ImageMagick Studio LLC"/>
22  <meta name="revisit-after" content="2 DAYS"/>
23  <meta name="resource-type" content="document"/>
24  <meta name="copyright" content="Copyright (c) 1999-2016 ImageMagick Studio LLC"/>
25  <meta name="distribution" content="Global"/>
26  <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/>
27  <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
28  <link rel="icon" href="../images/wand.png"/>
29  <link rel="shortcut icon" href="../images/wand.ico"/>
30  <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Roboto:900,400,400italic,700,700italic,300,300italic|Open+Sans:300italic,400italic,700italic,300,400,600,700">
31  <link rel="stylesheet" href="css/magick.css"/>
32</head>
33<body>
34<div class="main">
35<div class="magick-masthead">
36  <div class="container">
37    <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script>    <ins class="adsbygoogle"
38         style="display:block"
39         data-ad-client="ca-pub-3129977114552745"
40         data-ad-slot="6345125851"
41         data-ad-format="auto"></ins>
42    <script>
43      (adsbygoogle = window.adsbygoogle || []).push({});
44    </script>
45    <nav class="magick-nav">
46      <a class="magick-nav-item " href="../index.html">Home</a>
47      <a class="magick-nav-item " href="binary-releases.html">Download</a>
48      <a class="magick-nav-item " href="command-line-tools.html">Tools</a>
49      <a class="magick-nav-item " href="command-line-processing.html">Command-line</a>
50      <a class="magick-nav-item " href="resources.html">Resources</a>
51      <a class="magick-nav-item " href="api.html">Develop</a>
52      <a class="magick-nav-item " href="http://www.imagemagick.org/script/search.php">Search</a>
53      <a class="magick-nav-item pull-right" href="https://www.imagemagick.org/discourse-server/">Community</a>
54    </nav>
55  </div>
56</div>
57<div class="container">
58<div class="magick-header">
59<p class="text-center"><a href="stream.html#usage">Example Usage</a> • <a href="stream.html#options">Option Summary</a></p>
60
61<p class="lead magick-description"><code>Stream</code> 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 <code>stream</code> desirable when working with large images or when you require raw pixel components.</p>
62
63<h2 class="magick-header"><a id="usage"></a>Example Usage</h2>
64
65<p>We list a few examples of the <code>stream</code> 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>
66
67<pre>
68stream -map rgb -storage-type char image.jpg pixels.dat
69display -depth 8 -size 640x480 rgb:pixels.dat
70</pre>
71
72<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
73
74<pre>
75stream -map i -storage-type double -extract 100x100+30+40 image.tif gray.raw
76</pre>
77
78<p>You can also associate the region to extract with the image filename:</p>
79
80<pre>
81stream -map i -storage-type double 'image.tif[100x100+30+40]' gray.raw
82</pre>
83
84
85<h2 class="magick-header"><a id="options"></a>Option Summary</h2>
86
87<p>The <code>stream</code> command recognizes these options.  Click on an option to get more details about how that option works.</p>
88
89<table class="table table-condensed table-striped">
90  <tbody>
91  <tr>
92    <th align="left">Option</th>
93    <th align="left">Description</th>
94  </tr>
95
96  <tr>
97    <td><a href="command-line-options.html#authenticate">-authenticate <var>value</var></a></td>
98    <td>decrypt image with this password</td>
99  </tr>
100
101  <tr>
102    <td><a href="command-line-options.html#channel">-channel <var>type</var></a></td>
103    <td>apply option to select image channels</td>
104  </tr>
105
106  <tr>
107    <td><a href="command-line-options.html#colorspace">-colorspace <var>type</var></a></td>
108    <td>set image colorspace</td>
109  </tr>
110
111  <tr>
112    <td><a href="command-line-options.html#debug">-debug <var>events</var></a></td>
113    <td>display copious debugging information</td>
114  </tr>
115
116  <tr>
117    <td><a href="command-line-options.html#define">-define <var>format:option</var></a></td>
118    <td>define one or more image format options</td>
119  </tr>
120
121  <tr>
122    <td><a href="command-line-options.html#density">-density <var>geometry</var></a></td>
123    <td>horizontal and vertical density of the image</td>
124  </tr>
125
126  <tr>
127    <td><a href="command-line-options.html#depth">-depth <var>value</var></a></td>
128    <td>image depth</td>
129  </tr>
130
131  <tr>
132    <td><a href="command-line-options.html#extract">-extract <var>geometry</var></a></td>
133    <td>extract area from image</td>
134  </tr>
135
136  <tr>
137    <td><a href="command-line-options.html#help">-help</a></td>
138    <td>print program options</td>
139  </tr>
140
141  <tr>
142    <td><a href="command-line-options.html#interlace">-interlace <var>type</var></a></td>
143    <td>type of image interlacing scheme</td>
144  </tr>
145
146  <tr>
147    <td><a href="command-line-options.html#interpolate">-interpolate <var>method</var></a></td>
148    <td>pixel color interpolation method</td>
149  </tr>
150
151  <tr>
152    <td><a href="command-line-options.html#limit">-limit <var>type value</var></a></td>
153    <td>pixel cache resource limit</td>
154  </tr>
155
156  <tr>
157    <td><a href="command-line-options.html#list">-list <var>type</var></a></td>
158    <td>Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
159  </tr>
160
161  <tr>
162    <td><a href="command-line-options.html#log">-log <var>format</var></a></td>
163    <td>format of debugging information</td>
164  </tr>
165
166  <tr>
167    <td><a href="command-line-options.html#stream-map">-map <var>components</var></a></td>
168    <td>store pixels in this format.</td>
169  </tr>
170
171  <tr>
172    <td><a href="command-line-options.html#monitor">-monitor</a></td>
173    <td>monitor progress</td>
174  </tr>
175
176  <tr>
177    <td><a href="command-line-options.html#quantize">-quantize <var>colorspace</var></a></td>
178    <td>reduce image colors in this colorspace</td>
179  </tr>
180
181  <tr>
182    <td><a href="command-line-options.html#quiet">-quiet</a></td>
183    <td>suppress all warning messages</td>
184  </tr>
185
186  <tr>
187    <td><a href="command-line-options.html#regard-warnings">-regard-warnings</a></td>
188    <td>pay attention to warning messages.</td>
189  </tr>
190
191  <tr>
192    <td><a href="command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
193    <td>settings remain in effect until parenthesis boundary.</td>
194  </tr>
195
196  <tr>
197    <td><a href="command-line-options.html#sampling-factor">-sampling-factor <var>geometry</var></a></td>
198    <td>horizontal and vertical sampling factor</td>
199  </tr>
200
201  <tr>
202    <td><a href="command-line-options.html#seed">-seed <var>value</var></a></td>
203    <td>seed a new sequence of pseudo-random numbers</td>
204  </tr>
205
206  <tr>
207    <td><a href="command-line-options.html#set">-set <var>attribute value</var></a></td>
208    <td>set an image attribute</td>
209  </tr>
210
211  <tr>
212    <td><a href="command-line-options.html#size">-size <var>geometry</var></a></td>
213    <td>width and height of image</td>
214  </tr>
215
216  <tr>
217    <td><a href="command-line-options.html#storage-type">-storage-type <var>type</var></a></td>
218    <td>store pixels with this storage type.</td>
219  </tr>
220
221  <tr>
222    <td><a href="command-line-options.html#synchronize">-synchronize</a></td>
223    <td>synchronize image to storage device</td>
224  </tr>
225
226  <tr>
227    <td><a href="command-line-options.html#taint">-taint</a></td>
228    <td>mark the image as modified</td>
229  </tr>
230
231  <tr>
232    <td><a href="command-line-options.html#transparent-color">-transparent-color <var>color</var></a></td>
233    <td>transparent color</td>
234  </tr>
235
236  <tr>
237    <td><a href="command-line-options.html#verbose">-verbose</a></td>
238    <td>print detailed information about the image</td>
239  </tr>
240
241  <tr>
242    <td><a href="command-line-options.html#version">-version</a></td>
243    <td>print version information</td>
244  </tr>
245
246  <tr>
247    <td><a href="command-line-options.html#virtual-pixel">-virtual-pixel <var>method</var></a></td>
248    <td>access method for pixels outside the boundaries of the image</td>
249  </tr>
250
251  </tbody>
252</table>
253
254</div>
255  <footer class="magick-footer">
256    <p><a href="support.html">Donate</a> •
257     <a href="sitemap.html">Sitemap</a> •
258    <a href="links.html">Related</a> •
259    <a href="architecture.html">Architecture</a>
260</p>
261    <p><a href="stream.html#">Back to top</a> •
262    <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
263    <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
264        <p><small>©  1999-2016 ImageMagick Studio LLC</small></p>
265  </footer>
266</div><!-- /.container -->
267
268  <script src="https://localhost/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
269  <script src="../js/magick.html"></script>
270</div>
271</body>
272</html>
273