blob: 738389cb95fde63299f20135863b98b003d7c0f8 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="-//W3C//DTD XHTML 1.1//EN" xml:lang="en" xsi:schemaLocation="http://www.w3.org/1999/xhtml http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8"></meta>
<meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"></meta>
<title>ImageMagick: Command-line Tools: Stream</title>
<meta http-equiv="content-language" content="en-US"></meta>
<meta http-equiv="content-type" content="text/html; charset=utf-8"></meta>
<meta http-equiv="reply-to" content="magick-users@imagemagick.org"></meta>
<meta name="application-name" content="ImageMagick"></meta>
<meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."></meta>
<meta name="application-url" content="http://www.imagemagick.org"></meta>
<meta name="generator" content="PHP"></meta>
<meta name="keywords" content="command-line, tools:, stream, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"></meta>
<meta name="rating" content="GENERAL"></meta>
<meta name="robots" content="INDEX, FOLLOW"></meta>
<meta name="generator" content="ImageMagick Studio LLC"></meta>
<meta name="author" content="ImageMagick Studio LLC"></meta>
<meta name="revisit-after" content="2 DAYS"></meta>
<meta name="resource-type" content="document"></meta>
<meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"></meta>
<meta name="distribution" content="Global"></meta>
<link rel="icon" href="../images/wand.png"></link>
<link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"></link>
<link rel="canonical" href="../index.html"></link>
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"></link>
<!-- Add jQuery library -->
<script type="text/javascript" src="http://localhost/ajax/libs/jquery/1.7/jquery.min.js"></script>
<!-- Add mousewheel plugin (this is optional) -->
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
<!-- Add fancyBox -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen"></link>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
<!-- Optionally add helpers - button, thumbnail and/or media -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen"></link>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen"></link>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
<script type="text/javascript">
$(document).ready(function() {
$(".fancybox").fancybox();
});
</script>
<!-- ImageMagick style -->
<style type="text/css" media="all">
@import url("../www/magick.css");
</style>
</head>
<body id="www-imagemagick-org">
<div class="titlebar">
<div style="margin: 17px auto; float: left;">
<script type="text/javascript">
<!--
google_ad_client = "pub-3129977114552745";
google_ad_slot = "5439289906";
google_ad_width = 728;
google_ad_height = 90;
//-->
</script>
</div>
<a href="../discourse-server">
<img src="../images/logo.jpg" alt="ImageMagick Logo" style="width: 123px; height: 118px; border: 0px; float: right;"></img></a>
<a href="../index.html">
<img src="../images/sprite.jpg" alt="ImageMagick Sprite" style="width: 114px; height: 118px; border: 0px; float: right;"></img></a>
</div>
<div class="westbar">
<div class="menu">
<a title="About ImageMagick" href="../index.html">About ImageMagick</a>
</div>
<div class="menu">
<a title="Binary Releases" href="binary-releases.html">Binary Releases</a>
</div>
<div class="sub">
<a title="Binary Release: Unix" href="binary-releases.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Binary Release: MacOS X" href="binary-releases.html#macosx">Mac OS X</a>
</div>
<div class="sub">
<a title="Binary Release: iOS" href="binary-releases.html#iOS">iOS</a>
</div>
<div class="sub">
<a title="Binary Release: Windows" href="binary-releases.html#windows">Windows</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Command-line Tools" href="command-line-tools.html">Command-line Tools</a>
</div>
<div class="sub">
<a title="Command-line Tools: Processing" href="command-line-processing.html">Processing</a>
</div>
<div class="sub">
<a title="Command-line Tools: Options" href="command-line-options.html">Options</a>
</div>
<div class="sub">
<a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a title="Program Interfaces" href="api.html">Program Interfaces</a>
</div>
<div class="sub">
<a title="Program Interface: MagickWand" href="magick-wand.html">MagickWand</a>
</div>
<div class="sub">
<a title="Program Interface: MagickCore" href="magick-core.html">MagickCore</a>
</div>
<div class="sub">
<a title="Program Interface: PerlMagick" href="perl-magick.html">PerlMagick</a>
</div>
<div class="sub">
<a title="Program Interface: Magick++" href="magick++.html">Magick++</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Install from Source" href="install-source.html">Install from Source</a>
</div>
<div class="sub">
<a title="Install from Source: Unix" href="install-source.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Install from Source: Windows" href="install-source.html#windows">Windows</a>
</div>
<div class="menu">
<a title="Resources" href="resources.html">Resources</a>
</div>
<div class="menu">
<a title="Architecture" href="architecture.html">Architecture</a>
</div>
<div class="menu">
<a title="Download" href="download.html">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Search" href="search.html">Search</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Site Map" href="sitemap.html">Site Map</a>
</div>
<div class="sub">
<a title="Site Map: Links" href="links.html">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Support ImageMagick Development" href="support.html">Support ImageMagick Development</a>
</div>
</div>
<div class="eastbar">
<div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../index.html"></a></div>
<noscript>
<a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
<img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0"></img></a>
</noscript>
</div>
<div class="main">
<h1>ImageMagick Stream Command-line Tool</h1>
<p class="navigation-index">[<a href="stream.html#usage">Example Usage</a><a href="stream.html#options">Option Summary</a>]</p>
<div class="doc-section">
<p><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>
</div>
<h2><a id="usage"></a>Example Usage</h2>
<div class="doc-section">
<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>
<p class="crt"><span class="crtprompt"> $ </span><span class="crtin">stream -map rgb -storage-type char image.jpg pixels.dat</span><span class="crtout"></span><span class="crtprompt"> $ </span><span class="crtin">display -depth 8 -size 640x480 rgb:pixels.dat</span></p>
<p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
<p class="crt"><span class="crtprompt"> $ </span><span class="crtin">stream -map i -storage-type double -extract 100x100+30+40 image.tif gray.raw</span></p>
<p>You can also associate the region to extract with the image filename:</p>
<p class="crt"><span class="crtprompt"> $ </span><span class="crtin">stream -map i -storage-type double 'image.tif[100x100+30+40]' gray.raw</span></p>
</div>
<h2><a id="options"></a>Option Summary</h2>
<div class="doc-section">
<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="doc">
<tbody>
<tr>
<th align="left">Option</th>
<th align="left">Description</th>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
<td valign="top">decrypt image with this password</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#channel">-channel <em class="option">type</em></a></td>
<td valign="top">apply option to select image channels</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
<td valign="top">set image colorspace</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#debug">-debug <em class="option">events</em></a></td>
<td valign="top">display copious debugging information</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#define">-define <em class="option">format:option</em></a></td>
<td valign="top">define one or more image format options</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#density">-density <em class="option">geometry</em></a></td>
<td valign="top">horizontal and vertical density of the image</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#depth">-depth <em class="option">value</em></a></td>
<td valign="top">image depth</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
<td valign="top">extract area from image</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#help">-help</a></td>
<td valign="top">print program options</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
<td valign="top">type of image interlacing scheme</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
<td valign="top">pixel color interpolation method</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
<td valign="top">pixel cache resource limit</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#list">-list <em class="option">type</em></a></td>
<td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#log">-log <em class="option">format</em></a></td>
<td valign="top">format of debugging information</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
<td valign="top">store pixels in this format.</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#monitor">-monitor</a></td>
<td valign="top">monitor progress</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
<td valign="top">reduce image colors in this colorspace</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#quiet">-quiet</a></td>
<td valign="top">suppress all warning messages</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#regard-warnings">-regard-warnings</a></td>
<td valign="top">pay attention to warning messages.</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
<td valign="top">settings remain in effect until parenthesis boundary.</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
<td valign="top">horizontal and vertical sampling factor</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#seed">-seed <em class="option">value</em></a></td>
<td valign="top">seed a new sequence of pseudo-random numbers</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
<td valign="top">set an image attribute</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#size">-size <em class="option">geometry</em></a></td>
<td valign="top">width and height of image</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
<td valign="top">store pixels with this storage type.</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#synchronize">-synchronize</a></td>
<td valign="top">synchronize image to storage device</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#taint">-taint</a></td>
<td valign="top">mark the image as modified</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
<td valign="top">transparent color</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#verbose">-verbose</a></td>
<td valign="top">print detailed information about the image</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#version">-version</a></td>
<td valign="top">print version information</td>
</tr>
<tr>
<td valign="top"><a href="command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
<td valign="top">access method for pixels outside the boundaries of the image</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="linkbar">
<span id="linkbar-west"> </span>
<span id="linkbar-center">
<a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
<a href="../discourse-server">Discourse Server</a>
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
<a href="http://jqmagick.imagemagick.org/">JqMagick</a>
</span>
<span id="linkbar-east"> </span>
</div>
<div class="footer">
<span id="footer-west">© 1999-2013 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="contact.html">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>