granicus.if.org Git - imagemagick/blob - www/stream.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html version="-//W3C//DTD XHTML 1.1//EN"
   5       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   6       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   7       xsi:schemaLocation="http://www.w3.org/1999/xhtml
   8                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
   9 <head>
  10   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
  11   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
  12   <title>ImageMagick: Command-line Tools: Stream</title>
  13   <meta http-equiv="content-language" content="en-US"/>
  14   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="application-name" content="ImageMagick"/>
  17   <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images automagically."/>
  18   <meta name="application-url" content="http://www.imagemagick.org"/>
  19   <meta name="generator" content="PHP"/>
  20   <meta name="keywords" content="command-line, tools:, stream, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
  21   <meta name="rating" content="GENERAL"/>
  22   <meta name="robots" content="INDEX, FOLLOW"/>
  23   <meta name="generator" content="ImageMagick Studio LLC"/>
  24   <meta name="author" content="ImageMagick Studio LLC"/>
  25   <meta name="revisit-after" content="2 DAYS"/>
  26   <meta name="resource-type" content="document"/>
  27   <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
  28   <meta name="distribution" content="Global"/>
  29   <link rel="icon" href="../images/wand.png"/>
  30   <link rel="shortcut icon" href="../images/wand.ico"  type="images/x-icon"/>
  31   <link rel="canonical" href="http://www.imagemagick.org" />
  32   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  33   <!-- Add jQuery library -->
  34   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
  35
  36   <!-- Optionaly include easing and/or mousewheel plugins -->
  37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
  38   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
  39
  40   <!-- Add fancyBox -->
  41   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
  42   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
  43
  44   <!-- Optionaly include button and/or thumbnail helpers -->
  45   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
  46   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
  47
  48   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
  49   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
  50   <script type="text/javascript">
  51         $(document).ready(function() {
  52                 $(".fancybox").fancybox();
  53         });
  54   </script>
  55   <!-- ImageMagick style -->
  56   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
  57   <style type="text/css" media="all">
  58     @import url("../www/magick.css");
  59   </style>
  60 </head>
  61
  62 <body id="www-imagemagick-org">
  63 <div class="titlebar">
  64 <div style="margin: 17px auto; float: left;">
  65   <script type="text/javascript">
  66   <!--
  67     google_ad_client = "pub-3129977114552745";
  68     google_ad_slot = "5439289906";
  69     google_ad_width = 728;
  70     google_ad_height = 90;
  71   //-->
  72   </script>
  73   <script type="text/javascript"
  74     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  75   </script>
  76 </div>
  77 <a href="../discourse-server">
  78   <img src="../images/logo.jpg"
  79   alt="ImageMagick Logo"
  80   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  81 <a href="../index.html">
  82   <img src="../images/sprite.jpg"
  83   alt="ImageMagick Sprite"
  84   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  85 </div>
  86
  87 <div class="westbar">
  88
  89 <div class="menu">
  90   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  91 </div>
  92 <div class="menu">
  93   <a title="Binary Releases" href="binary-releases.html">Binary Releases</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Binary Release: Unix" href="binary-releases.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Binary Release: MacOS X" href="binary-releases.html#macosx">Mac OS X</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Binary Release: iOS" href="binary-releases.html#iOS">iOS</a>
 103 </div>
 104 <div class="sub">
 105     <a title="Binary Release: Windows" href="binary-releases.html#windows">Windows</a>
 106 </div>
 107 <div class="sep"></div>
 108 <div class="menu">
 109   <a title="Command-line Tools" href="command-line-tools.html">Command-line Tools</a>
 110 </div>
 111 <div class="sub">
 112     <a title="Command-line Tools: Processing" href="command-line-processing.html">Processing</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Command-line Tools: Options" href="command-line-options.html">Options</a>
 116 </div>
 117 <div class="sub">
 118     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 119 </div>
 120 <div class="menu">
 121   <a title="Program Interfaces" href="api.html">Program Interfaces</a>
 122 </div>
 123 <div class="sub">
 124     <a title="Program Interface: MagickWand" href="magick-wand.html">MagickWand</a>
 125 </div>
 126 <div class="sub">
 127     <a title="Program Interface: MagickCore" href="magick-core.html">MagickCore</a>
 128 </div>
 129 <div class="sub">
 130     <a title="Program Interface: PerlMagick" href="perl-magick.html">PerlMagick</a>
 131 </div>
 132 <div class="sub">
 133     <a title="Program Interface: Magick++" href="magick++.html">Magick++</a>
 134 </div>
 135 <div class="sep"></div>
 136 <div  class="menu">
 137    <a title="Install from Source" href="install-source.html">Install from Source</a>
 138 </div>
 139 <div class="sub">
 140     <a title="Install from Source: Unix" href="install-source.html#unix">Unix</a>
 141 </div>
 142 <div class="sub">
 143     <a title="Install from Source: Windows" href="install-source.html#windows">Windows</a>
 144  </div>
 145 <div class="menu">
 146   <a title="Resources" href="resources.html">Resources</a>
 147 </div>
 148 <div class="menu">
 149   <a title="Architecture" href="architecture.html">Architecture</a>
 150 </div>
 151 <div class="menu">
 152   <a title="Download" href="download.html">Download</a>
 153 </div>
 154 <div class="sep"></div>
 155 <div class="menu">
 156   <a title="Search" href="search.html">Search</a>
 157 </div>
 158 <div class="sep"></div>
 159 <div class="menu">
 160   <a title="Site Map" href="sitemap.html">Site Map</a>
 161 </div>
 162 <div  class="sub">
 163   <a title="Site Map: Links" href="links.html">Links</a>
 164 </div>
 165 <div class="sep"></div>
 166 <div class="menu">
 167   <a rel="follow" title="Sponsors" href="sponsors.html">Sponsors:</a>
 168
 169   <a href="http://www.networkredux.com"> <img src="../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 170   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
 171 <div class="sponsbox">
 172 <div class="sponsor">
 173   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
 174 </div>
 175 <div class="sponsor">
 176   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
 177 </div>
 178 <div class="sponsor">
 179   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
 180 </div>
 181 <div class="sponsor">
 182   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
 183 </div>
 184 <div class="sponsor">
 185   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
 186 </div>
 187 <div class="sponsor">
 188   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
 189 </div>
 190 <div class="sponsor">
 191   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
 192 </div>
 193 <div class="sponsor">
 194   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
 195 </div>
 196 <div class="sponsor">
 197    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
 198 </div>
 199 <div class="sponsor">
 200    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
 201 </div>
 202 <div class="sponsor">
 203   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
 204 </div>
 205 <div class="sponsor">
 206   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 207 </div>
 208 <div class="sponsor">
 209    <a rel="follow" title="Sponsor: Names List" href="http://www.listofnames.info">Names List</a><!-- 2012110100180 grimshrat@busyb-->
 210 </div>
 211 <div class="sponsor">
 212    <a rel="follow" title="Sponsor: Web Hosting" href="http://www.hostucan.com">Web Hosting</a><!-- 2012120100150 racent marketing@webhosting...-->
 213 </div>
 214 </div>
 215 </div>
 216 </div>
 217
 218 <div class="eastbar">
 219   <div class="g-plusone" id="gplusone"></div>
 220   <script type="text/javascript">
 221     window.___gcfg = {
 222       lang: 'en-US'
 223     };
 224
 225     (function() {
 226       var po = document.createElement('script');
 227       po.type = 'text/javascript'; po.async = true;
 228       po.src = 'https://apis.google.com/js/plusone.js';
 229       var script = document.getElementsByTagName('script')[0];
 230       script.parentNode.insertBefore(po, script);
 231     })();
 232     var gplusone = document.getElementById("gplusone");
 233     gplusone.setAttribute("data-size","medium");
 234     gplusone.setAttribute("data-count","false");
 235   </script>
 236 </div>
 237
 238 <div class="main">
 239
 240 <h1>ImageMagick Stream Command-line Tool</h1>
 241 <p class="navigation-index">[<a href="stream.html#usage">Example Usage</a> &bull; <a href="stream.html#options">Option Summary</a>]</p>
 242
 243 <div class="doc-section">
 244 <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>
 245 </div>
 246
 247 <h2><a id="usage"></a>Example Usage</h2>
 248 <div class="doc-section">
 249
 250 <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>
 251
 252 <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>
 253 <p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
 254
 255 <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>
 256 <p>You can also associate the region to extract with the image filename:</p>
 257
 258 <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>
 259 </div>
 260
 261 <h2><a id="options"></a>Option Summary</h2>
 262 <div class="doc-section">
 263
 264 <p>The <kbd>stream</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 265
 266 <table class="doc">
 267   <tbody>
 268   <tr>
 269     <th align="left">Option</th>
 270     <th align="left">Description</th>
 271   </tr>
 272
 273   <tr>
 274     <td valign="top"><a href="command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
 275     <td valign="top">decrypt image with this password</td>
 276   </tr>
 277
 278   <tr>
 279     <td valign="top"><a href="command-line-options.html#channel">-channel <em class="option">type</em></a></td>
 280     <td valign="top">apply option to select image channels</td>
 281   </tr>
 282
 283   <tr>
 284     <td valign="top"><a href="command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
 285     <td valign="top">set image colorspace</td>
 286   </tr>
 287
 288   <tr>
 289     <td valign="top"><a href="command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 290     <td valign="top">display copious debugging information</td>
 291   </tr>
 292
 293   <tr>
 294     <td valign="top"><a href="command-line-options.html#define">-define <em class="option">format:option</em></a></td>
 295     <td valign="top">define one or more image format options</td>
 296   </tr>
 297
 298   <tr>
 299     <td valign="top"><a href="command-line-options.html#density">-density <em class="option">geometry</em></a></td>
 300     <td valign="top">horizontal and vertical density of the image</td>
 301   </tr>
 302
 303   <tr>
 304     <td valign="top"><a href="command-line-options.html#depth">-depth <em class="option">value</em></a></td>
 305     <td valign="top">image depth</td>
 306   </tr>
 307
 308   <tr>
 309     <td valign="top"><a href="command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
 310     <td valign="top">extract area from image</td>
 311   </tr>
 312
 313   <tr>
 314     <td valign="top"><a href="command-line-options.html#help">-help</a></td>
 315     <td valign="top">print program options</td>
 316   </tr>
 317
 318   <tr>
 319     <td valign="top"><a href="command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
 320     <td valign="top">type of image interlacing scheme</td>
 321   </tr>
 322
 323   <tr>
 324     <td valign="top"><a href="command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
 325     <td valign="top">pixel color interpolation method</td>
 326   </tr>
 327
 328   <tr>
 329     <td valign="top"><a href="command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
 330     <td valign="top">pixel cache resource limit</td>
 331   </tr>
 332
 333   <tr>
 334     <td valign="top"><a href="command-line-options.html#list">-list <em class="option">type</em></a></td>
 335     <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
 336   </tr>
 337
 338   <tr>
 339     <td valign="top"><a href="command-line-options.html#log">-log <em class="option">format</em></a></td>
 340     <td valign="top">format of debugging information</td>
 341   </tr>
 342
 343   <tr>
 344     <td valign="top"><a href="command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
 345     <td valign="top">store pixels in this format.</td>
 346   </tr>
 347
 348   <tr>
 349     <td valign="top"><a href="command-line-options.html#monitor">-monitor</a></td>
 350     <td valign="top">monitor progress</td>
 351   </tr>
 352
 353   <tr>
 354     <td valign="top"><a href="command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
 355     <td valign="top">reduce image colors in this colorspace</td>
 356   </tr>
 357
 358   <tr>
 359     <td valign="top"><a href="command-line-options.html#quiet">-quiet</a></td>
 360     <td valign="top">suppress all warning messages</td>
 361   </tr>
 362
 363   <tr>
 364     <td valign="top"><a href="command-line-options.html#regard-warnings">-regard-warnings</a></td>
 365     <td valign="top">pay attention to warning messages.</td>
 366   </tr>
 367
 368   <tr>
 369     <td valign="top"><a href="command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
 370     <td valign="top">settings remain in effect until parenthesis boundary.</td>
 371   </tr>
 372
 373   <tr>
 374     <td valign="top"><a href="command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
 375     <td valign="top">horizontal and vertical sampling factor</td>
 376   </tr>
 377
 378   <tr>
 379     <td valign="top"><a href="command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 380     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 381   </tr>
 382
 383   <tr>
 384     <td valign="top"><a href="command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
 385     <td valign="top">set an image attribute</td>
 386   </tr>
 387
 388   <tr>
 389     <td valign="top"><a href="command-line-options.html#size">-size <em class="option">geometry</em></a></td>
 390     <td valign="top">width and height of image</td>
 391   </tr>
 392
 393   <tr>
 394     <td valign="top"><a href="command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
 395     <td valign="top">store pixels with this storage type.</td>
 396   </tr>
 397
 398   <tr>
 399     <td valign="top"><a href="command-line-options.html#synchronize">-synchronize</a></td>
 400     <td valign="top">synchronize image to storage device</td>
 401   </tr>
 402
 403   <tr>
 404     <td valign="top"><a href="command-line-options.html#taint">-taint</a></td>
 405     <td valign="top">mark the image as modified</td>
 406   </tr>
 407
 408   <tr>
 409     <td valign="top"><a href="command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
 410     <td valign="top">transparent color</td>
 411   </tr>
 412
 413   <tr>
 414     <td valign="top"><a href="command-line-options.html#verbose">-verbose</a></td>
 415     <td valign="top">print detailed information about the image</td>
 416   </tr>
 417
 418   <tr>
 419     <td valign="top"><a href="command-line-options.html#version">-version</a></td>
 420     <td valign="top">print version information</td>
 421   </tr>
 422
 423   <tr>
 424     <td valign="top"><a href="command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
 425     <td valign="top">access method for pixels outside the boundaries of the image</td>
 426   </tr>
 427
 428   </tbody>
 429 </table>
 430
 431 </div>
 432
 433 </div>
 434
 435 <div id="linkbar">
 436     <span id="linkbar-west">&nbsp;</span>
 437     <span id="linkbar-center">
 438       <a href="../discourse-server">Discourse Server</a> &bull;
 439       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
 440     </span>
 441     <span id="linkbar-east">&nbsp;</span>
 442   </div>
 443   <div class="footer">
 444     <span id="footer-west">&copy; 1999-2012 ImageMagick Studio LLC</span>
 445     <span id="footer-east"> <a href="contact.html">Contact the Wizards</a></span>
 446   </div>
 447   <div style="clear: both; margin: 0; width: 100%; "></div>
 448   <script type="text/javascript">
 449     var _gaq = _gaq || [];
 450     _gaq.push(['_setAccount', 'UA-17690367-1']);
 451     _gaq.push(['_trackPageview']);
 452
 453     (function() {
 454       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 455       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 456       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 457     })();
 458   </script>
 459 </body>
 460 </html>