1 2 3 4 5<!doctype html> 6<html lang="en"> 7<head> 8 <meta charset="utf-8" /> 9 <meta name="viewport" content="width=device-width, initial-scale=1" /> 10 <title>ImageMagick - Command-line Tools: Stream</title> 11 <meta name="application-name" content="ImageMagick" /> 12 <meta name="description" content="Use ImageMagick® to create, edit, compose, and convert digital images. Resize an image, crop it, change its shades and colors, add captions, and more." /> 13 <meta name="application-url" content="https://imagemagick.org" /> 14 <meta name="generator" content="PHP" /> 15 <meta name="keywords" content="command-line, tools:, stream, image processing software" /> 16 <meta name="rating" content="GENERAL" /> 17 <meta name="robots" content="INDEX, FOLLOW" /> 18 <meta name="generator" content="ImageMagick Studio LLC" /> 19 <meta name="author" content="ImageMagick Studio LLC" /> 20 <meta name="revisit-after" content="2 DAYS" /> 21 <meta name="resource-type" content="document" /> 22 <meta name="copyright" content="Copyright (c) 1999-2020 ImageMagick Studio LLC" /> 23 <meta name="distribution" content="Global" /> 24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" /> 25 <meta property='og:url' content='../' /> 26 <meta property='og:title' content='ImageMagick' /> 27 <meta property='og:image' content='../images/logo.png' /> 28 <meta property='og:type' content='website' /> 29 <meta property='og:site_name' content='ImageMagick' /> 30 <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" /> 31 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" /> 32 <link href="stream.html" rel="canonical" /> 33 <link href="../images/wand.png" rel="icon" /> 34 <link href="../images/wand.ico" rel="shortcut icon" /> 35 <link href="assets/magick.css" rel="stylesheet" /> 36</head> 37<body> 38 <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top"> 39 <div class="container-fluid"> 40 <a class="navbar-brand" href="../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../images/wand.ico"/></a> 41 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation"> 42 <span class="navbar-toggler-icon"></span> 43 </button> 44 45 <div class="collapse navbar-collapse" id="magick-navbars"> 46 <ul class="navbar-nav me-auto mb-2 mb-md-0"> 47 <li class="nav-item"> 48 <a class="nav-link " href="../www/index.html">Home</a> 49 </li> 50 <li class="nav-item"> 51 <a class="nav-link " href="../www/download.html">Download</a> 52 </li> 53 <li class="nav-item"> 54 <a class="nav-link " href="../www/command-line-tools.html">Tools</a> 55 </li> 56 <li class="nav-item"> 57 <a class="nav-link " href="../www/command-line-processing.html">CLI</a> 58 </li> 59 <li class="nav-item"> 60 <a class="nav-link " href="../www/develop.html">Develop</a> 61 </li> 62 <li class="nav-item"> 63 <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a> 64 </li> 65 <li class="nav-item"> 66 <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe> 67 </li> 68 </ul> 69 <form class="d-flex form-inline" action="search.html"> 70 <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search"> 71 <button class="btn btn-outline-success" type="submit" name="sa">Search</button> 72 </form> 73 </div> 74 </div> 75 </nav> 76 77 <div class="container"> 78 <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script> 79 <ins class="adsbygoogle" 80 style="display:block" 81 data-ad-client="ca-pub-3129977114552745" 82 data-ad-slot="6345125851" 83 data-full-width-responsive="true" 84 data-ad-format="horizontal"></ins> 85 <script> 86 (adsbygoogle = window.adsbygoogle || []).push({}); 87 </script> 88 89 </div> 90 91 <main class="container"> 92 <div class="magick-template"> 93<div class="magick-header"> 94<h1 class="text-center">Streaming Interface</h1> 95<p class="text-center"><a href="stream.html#usage">Example Usage</a> • <a href="stream.html#options">Option Summary</a></p> 96 97<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> 98 99<h2><a class="anchor" id="usage"></a>Example Usage</h2> 100 101<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> 102 103<ul><pre class="highlight"><code>magick stream -map rgb -storage-type char image.jpg pixels.dat 104magick display -depth 8 -size 640x480 rgb:pixels.dat 105</code></pre></ul> 106 107<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p> 108 109<ul><pre class="highlight"><code>magick stream -map i -storage-type double -extract 100x100+30+40 image.tif gray.raw 110</code></pre></ul> 111 112<p>You can also associate the region to extract with the image filename:</p> 113 114<ul><pre class="highlight"><code>magick stream -map i -storage-type double 'image.tif[100x100+30+40]' gray.raw 115</code></pre></ul> 116 117<p>Streaming requires that the image coder read the image pixels in row order. Not all formats adhere to this requirement. Verify a particular image format first, before you utilize streaming in your workflow.</p> 118 119 120<h2><a class="anchor" id="options"></a>Option Summary</h2> 121 122<p>The <code>stream</code> command recognizes these options. Click on an option to get more details about how that option works.</p> 123 124<table class="table table-sm table-hover"> 125 <thead> 126 <tr> 127 <th scope="col">Option</th> 128 <th scope="col">Description</th> 129 </tr> 130 </thead> 131 <tbody> 132 <tr> 133 <td><a href="../www/command-line-options.html#authenticate">-authenticate <var>value</var></a></td> 134 <td>decrypt image with this password</td> 135 </tr> 136 137 <tr> 138 <td><a href="../www/command-line-options.html#channel">-channel <var>type</var></a></td> 139 <td>apply option to select image channels</td> 140 </tr> 141 142 <tr> 143 <td><a href="../www/command-line-options.html#colorspace">-colorspace <var>type</var></a></td> 144 <td>set image colorspace</td> 145 </tr> 146 147 <tr> 148 <td><a href="../www/command-line-options.html#debug">-debug <var>events</var></a></td> 149 <td>display copious debugging information</td> 150 </tr> 151 152 <tr> 153 <td><a href="../www/command-line-options.html#define">-define <var>format:option</var></a></td> 154 <td>define one or more image format options</td> 155 </tr> 156 157 <tr> 158 <td><a href="../www/command-line-options.html#density">-density <var>geometry</var></a></td> 159 <td>horizontal and vertical density of the image</td> 160 </tr> 161 162 <tr> 163 <td><a href="../www/command-line-options.html#depth">-depth <var>value</var></a></td> 164 <td>image depth</td> 165 </tr> 166 167 <tr> 168 <td><a href="../www/command-line-options.html#extract">-extract <var>geometry</var></a></td> 169 <td>extract area from image</td> 170 </tr> 171 172 <tr> 173 <td><a href="../www/command-line-options.html#help">-help</a></td> 174 <td>print program options</td> 175 </tr> 176 177 <tr> 178 <td><a href="../www/command-line-options.html#interlace">-interlace <var>type</var></a></td> 179 <td>type of image interlacing scheme</td> 180 </tr> 181 182 <tr> 183 <td><a href="../www/command-line-options.html#interpolate">-interpolate <var>method</var></a></td> 184 <td>pixel color interpolation method</td> 185 </tr> 186 187 <tr> 188 <td><a href="../www/command-line-options.html#limit">-limit <var>type value</var></a></td> 189 <td>pixel cache resource limit</td> 190 </tr> 191 192 <tr> 193 <td><a href="../www/command-line-options.html#list">-list <var>type</var></a></td> 194 <td>Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td> 195 </tr> 196 197 <tr> 198 <td><a href="../www/command-line-options.html#log">-log <var>format</var></a></td> 199 <td>format of debugging information</td> 200 </tr> 201 202 <tr> 203 <td><a href="../www/command-line-options.html#stream-map">-map <var>components</var></a></td> 204 <td>store pixels in this format.</td> 205 </tr> 206 207 <tr> 208 <td><a href="../www/command-line-options.html#monitor">-monitor</a></td> 209 <td>monitor progress</td> 210 </tr> 211 212 <tr> 213 <td><a href="../www/command-line-options.html#quantize">-quantize <var>colorspace</var></a></td> 214 <td>reduce image colors in this colorspace</td> 215 </tr> 216 217 <tr> 218 <td><a href="../www/command-line-options.html#quiet">-quiet</a></td> 219 <td>suppress all warning messages</td> 220 </tr> 221 222 <tr> 223 <td><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td> 224 <td>pay attention to warning messages.</td> 225 </tr> 226 227 <tr> 228 <td><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td> 229 <td>settings remain in effect until parenthesis boundary.</td> 230 </tr> 231 232 <tr> 233 <td><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <var>geometry</var></a></td> 234 <td>horizontal and vertical sampling factor</td> 235 </tr> 236 237 <tr> 238 <td><a href="../www/command-line-options.html#seed">-seed <var>value</var></a></td> 239 <td>seed a new sequence of pseudo-random numbers</td> 240 </tr> 241 242 <tr> 243 <td><a href="../www/command-line-options.html#set">-set <var>attribute value</var></a></td> 244 <td>set an image attribute</td> 245 </tr> 246 247 <tr> 248 <td><a href="../www/command-line-options.html#size">-size <var>geometry</var></a></td> 249 <td>width and height of image</td> 250 </tr> 251 252 <tr> 253 <td><a href="../www/command-line-options.html#storage-type">-storage-type <var>type</var></a></td> 254 <td>store pixels with this storage type.</td> 255 </tr> 256 257 <tr> 258 <td><a href="../www/command-line-options.html#synchronize">-synchronize</a></td> 259 <td>synchronize image to storage device</td> 260 </tr> 261 262 <tr> 263 <td><a href="../www/command-line-options.html#taint">-taint</a></td> 264 <td>mark the image as modified</td> 265 </tr> 266 267 <tr> 268 <td><a href="../www/command-line-options.html#transparent-color">-transparent-color <var>color</var></a></td> 269 <td>transparent color</td> 270 </tr> 271 272 <tr> 273 <td><a href="../www/command-line-options.html#verbose">-verbose</a></td> 274 <td>print detailed information about the image</td> 275 </tr> 276 277 <tr> 278 <td><a href="../www/command-line-options.html#version">-version</a></td> 279 <td>print version information</td> 280 </tr> 281 282 <tr> 283 <td><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <var>method</var></a></td> 284 <td>access method for pixels outside the boundaries of the image</td> 285 </tr> 286 287 </tbody> 288</table> 289 290</div> 291 </div> 292 </main><!-- /.container --> 293 <footer class="magick-footer"> 294 <div class="container-fluid"> 295 <a href="../www/security-policy.html">Security</a> • 296 <a href="../www/news.html">News</a> 297 298 <a href="stream.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../images/wand.ico"/></a> 299 300 <a href="../www/links.html">Related</a> • 301 <a href="../www/sitemap.html">Sitemap</a> 302 <br/> 303 <a href="../www/support.html">Sponsor</a> • 304 <a href="../www/cite.html">Cite</a> • 305 <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • 306 <a href="../www/https://imagemagick.org/script/contact.php">Contact Us</a> 307 <br/> 308 <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> • 309 <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 416.32" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path fill="currentColor" d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92"/></svg></a> 310 <br/> 311 <small>© 1999-2021 ImageMagick Studio LLC</small> 312 </div> 313 </footer> 314 315 <!-- Javascript assets --> 316 <script src="assets/magick.js" ></script> 317 </body> 318</html> 319<!-- Magick Cache 13th February 2021 11:41 -->
