<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1,shrink-to-fit=no" />
<title>Command-line Tools: Stream @ ImageMagick</title>
<meta name="application-name" content="ImageMagick" />
<meta name="description" content="Use ImageMagick® to create, edit, compose, or convert bitmap images. You can resize your image, crop it, change its shades and colors, add captions, among other operations." />
<meta name="application-url" content="https://imagemagick.org" />
<meta name="generator" content="PHP" />
<meta name="keywords" content="command-line, tools:, stream, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert" />
<meta name="rating" content="GENERAL" />
<meta name="robots" content="INDEX, FOLLOW" />
<meta name="generator" content="ImageMagick Studio LLC" />
<meta name="author" content="ImageMagick Studio LLC" />
<meta name="revisit-after" content="2 DAYS" />
<meta name="resource-type" content="document" />
<meta name="copyright" content="Copyright (c) 1999-2019 ImageMagick Studio LLC" />
<meta name="distribution" content="Global" />
<meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
<meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
<link href="stream.html" rel="canonical" />
<link href="../images/wand.png" rel="icon" />
<link href="../images/wand.ico" rel="shortcut icon" />
<link href="assets/magick.css" rel="stylesheet" />
</head>
<body>
<header>
<nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark">
<a class="navbar-brand" href="../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../images/wand.ico"/></a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsMagick" aria-controls="navbarsMagick" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="navbar-collapse collapse" id="navbarsMagick" style="">
<ul class="navbar-nav mr-auto">
<li class="nav-item ">
<a class="nav-link" href="api/quantize.html">Home <span class="sr-only">(current)</span></a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../www/download.html">Download</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../www/command-line-tools.html">Tools</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../www/command-line-processing.html">Command-line</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../www/resources.html">Resources</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../www/develop.html">Develop</a>
</li>
<li class="nav-item">
<a class="nav-link" target="_blank" href="https://imagemagick.org/discourse-server/">Community</a>
</li>
</ul>
<form class="form-inline my-2 my-lg-0" action="https://imagemagick.org/script/search.php">
<input class="form-control mr-sm-2" type="text" name="q" placeholder="Search" aria-label="Search">
<button class="btn btn-outline-success my-2 my-sm-0" type="submit" name="sa">Search</button>
</form>
</div>
</nav>
<div class="container">
<script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-3129977114552745"
data-ad-slot="6345125851"
data-ad-format="auto"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
</div>
</header>
<main class="container">
<div class="magick-template">
<div class="magick-header">
<p class="text-center"><a href="stream.html#usage">Example Usage</a> • <a href="stream.html#options">Option Summary</a></p>
<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>
<h2><a class="anchor" id="usage"></a>Example Usage</h2>
<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>
<pre class="highlight"><code>magick stream -map rgb -storage-type char image.jpg pixels.dat
magick display -depth 8 -size 640x480 rgb:pixels.dat
</code></pre>
<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
<pre class="highlight"><code>magick stream -map i -storage-type double -extract 100x100+30+40 image.tif gray.raw
</code></pre>
<p>You can also associate the region to extract with the image filename:</p>
<pre class="highlight"><code>magick stream -map i -storage-type double 'image.tif[100x100+30+40]' gray.raw
</code></pre>
<h2><a class="anchor" id="options"></a>Option Summary</h2>
<p>The <code>stream</code> command recognizes these options. Click on an option to get more details about how that option works.</p>
<table class="table table-sm table-striped">
<tbody>
<tr>
<th align="left">Option</th>
<th align="left">Description</th>
</tr>
<tr>
<td><a href="../www/command-line-options.html#authenticate">-authenticate <var>value</var></a></td>
<td>decrypt image with this password</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#channel">-channel <var>type</var></a></td>
<td>apply option to select image channels</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#colorspace">-colorspace <var>type</var></a></td>
<td>set image colorspace</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#debug">-debug <var>events</var></a></td>
<td>display copious debugging information</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#define">-define <var>format:option</var></a></td>
<td>define one or more image format options</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#density">-density <var>geometry</var></a></td>
<td>horizontal and vertical density of the image</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#depth">-depth <var>value</var></a></td>
<td>image depth</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#extract">-extract <var>geometry</var></a></td>
<td>extract area from image</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#help">-help</a></td>
<td>print program options</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#interlace">-interlace <var>type</var></a></td>
<td>type of image interlacing scheme</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#interpolate">-interpolate <var>method</var></a></td>
<td>pixel color interpolation method</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#limit">-limit <var>type value</var></a></td>
<td>pixel cache resource limit</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#list">-list <var>type</var></a></td>
<td>Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#log">-log <var>format</var></a></td>
<td>format of debugging information</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#stream-map">-map <var>components</var></a></td>
<td>store pixels in this format.</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#monitor">-monitor</a></td>
<td>monitor progress</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#quantize">-quantize <var>colorspace</var></a></td>
<td>reduce image colors in this colorspace</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#quiet">-quiet</a></td>
<td>suppress all warning messages</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
<td>pay attention to warning messages.</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
<td>settings remain in effect until parenthesis boundary.</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <var>geometry</var></a></td>
<td>horizontal and vertical sampling factor</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#seed">-seed <var>value</var></a></td>
<td>seed a new sequence of pseudo-random numbers</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#set">-set <var>attribute value</var></a></td>
<td>set an image attribute</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#size">-size <var>geometry</var></a></td>
<td>width and height of image</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#storage-type">-storage-type <var>type</var></a></td>
<td>store pixels with this storage type.</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#synchronize">-synchronize</a></td>
<td>synchronize image to storage device</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#taint">-taint</a></td>
<td>mark the image as modified</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#transparent-color">-transparent-color <var>color</var></a></td>
<td>transparent color</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#verbose">-verbose</a></td>
<td>print detailed information about the image</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#version">-version</a></td>
<td>print version information</td>
</tr>
<tr>
<td><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <var>method</var></a></td>
<td>access method for pixels outside the boundaries of the image</td>
</tr>
</tbody>
</table>
</div>
</div>
</main><!-- /.container -->
<footer class="magick-footer">
<p><a href="../www/security-policy.html">Security</a> •
<a href="../www/architecture.html">Architecture</a> •
<a href="../www/links.html">Related</a> •
<a href="../www/sitemap.html">Sitemap</a>
<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>
<a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> •
<a href="../www/support.html">Donate</a> •
<a href="../www/https://imagemagick.org/script/contact.php">Contact Us</a>
<br/>
<small>© 1999-2019 ImageMagick Studio LLC</small></p>
</footer>
<!-- Javascript assets -->
<script src="assets/magick.js" crossorigin="anonymous"></script>
<script>window.jQuery || document.write('<script src="https://localhost/ajax/libs/jquery/3.3.1/jquery.min.js"><\/script>')</script>
</body>
</html>