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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   2 <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">
   3 <head>
   4   <meta http-equiv="content-type" content="text/html; charset=UTF-8"></meta>
   5   <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"></meta>
   6   <title>ImageMagick: Command-line Tools: Stream</title>
   7   <meta http-equiv="content-language" content="en-US"></meta>
   8   <meta http-equiv="content-type" content="text/html; charset=utf-8"></meta>
   9   <meta http-equiv="reply-to" content="magick-users@imagemagick.org"></meta>
  10   <meta name="application-name" content="ImageMagick"></meta>
  11   <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>
  12   <meta name="application-url" content="http://www.imagemagick.org"></meta>
  13   <meta name="generator" content="PHP"></meta>
  14   <meta name="keywords" content="command-line, tools:, stream, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"></meta>
  15   <meta name="rating" content="GENERAL"></meta>
  16   <meta name="robots" content="INDEX, FOLLOW"></meta>
  17   <meta name="generator" content="ImageMagick Studio LLC"></meta>
  18   <meta name="author" content="ImageMagick Studio LLC"></meta>
  19   <meta name="revisit-after" content="2 DAYS"></meta>
  20   <meta name="resource-type" content="document"></meta>
  21   <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"></meta>
  22   <meta name="distribution" content="Global"></meta>
  23   <link rel="icon" href="../images/wand.png"></link>
  24   <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"></link>
  25   <link rel="canonical" href="../index.html"></link>
  26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"></link>
  27
  28   <!-- Add jQuery library -->
  29   <script type="text/javascript" src="http://localhost/ajax/libs/jquery/1.7/jquery.min.js"></script>
  30
  31   <!-- Add mousewheel plugin (this is optional) -->
  32   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
  33
  34   <!-- Add fancyBox -->
  35   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen"></link>
  36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
  37
  38   <!-- Optionally add helpers - button, thumbnail and/or media -->
  39   <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>
  40   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
  41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
  42
  43   <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>
  44   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
  45
  46   <script type="text/javascript">
  47         $(document).ready(function() {
  48                 $(".fancybox").fancybox();
  49         });
  50   </script>
  51
  52   <!-- ImageMagick style -->
  53   <style type="text/css" media="all">
  54     @import url("../www/magick.css");
  55   </style>
  56 </head>
  57
  58 <body id="www-imagemagick-org">
  59
  60
  61
  62 <div class="titlebar">
  63 <div style="margin: 17px auto; float: left;">
  64   <script type="text/javascript">
  65   <!--
  66     google_ad_client = "pub-3129977114552745";
  67     google_ad_slot = "5439289906";
  68     google_ad_width = 728;
  69     google_ad_height = 90;
  70   //-->
  71   </script>
  72
  73 </div>
  74 <a href="../discourse-server">
  75   <img src="../images/logo.jpg" alt="ImageMagick Logo" style="width: 123px; height: 118px; border: 0px; float: right;"></img></a>
  76 <a href="../index.html">
  77   <img src="../images/sprite.jpg" alt="ImageMagick Sprite" style="width: 114px; height: 118px; border: 0px; float: right;"></img></a>
  78 </div>
  79
  80 <div class="westbar">
  81
  82 <div class="menu">
  83   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  84 </div>
  85 <div class="menu">
  86   <a title="Binary Releases" href="binary-releases.html">Binary Releases</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Binary Release: Unix" href="binary-releases.html#unix">Unix</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Binary Release: MacOS X" href="binary-releases.html#macosx">Mac OS X</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: iOS" href="binary-releases.html#iOS">iOS</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: Windows" href="binary-releases.html#windows">Windows</a>
  99 </div>
 100 <div class="sep"></div>
 101 <div class="menu">
 102   <a title="Command-line Tools" href="command-line-tools.html">Command-line Tools</a>
 103 </div>
 104 <div class="sub">
 105     <a title="Command-line Tools: Processing" href="command-line-processing.html">Processing</a>
 106 </div>
 107 <div class="sub">
 108     <a title="Command-line Tools: Options" href="command-line-options.html">Options</a>
 109 </div>
 110 <div class="sub">
 111     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 112 </div>
 113 <div class="menu">
 114   <a title="Program Interfaces" href="api.html">Program Interfaces</a>
 115 </div>
 116 <div class="sub">
 117     <a title="Program Interface: MagickWand" href="magick-wand.html">MagickWand</a>
 118 </div>
 119 <div class="sub">
 120     <a title="Program Interface: MagickCore" href="magick-core.html">MagickCore</a>
 121 </div>
 122 <div class="sub">
 123     <a title="Program Interface: PerlMagick" href="perl-magick.html">PerlMagick</a>
 124 </div>
 125 <div class="sub">
 126     <a title="Program Interface: Magick++" href="magick++.html">Magick++</a>
 127 </div>
 128 <div class="sep"></div>
 129 <div class="menu">
 130    <a title="Install from Source" href="install-source.html">Install from Source</a>
 131 </div>
 132 <div class="sub">
 133     <a title="Install from Source: Unix" href="install-source.html#unix">Unix</a>
 134 </div>
 135 <div class="sub">
 136     <a title="Install from Source: Windows" href="install-source.html#windows">Windows</a>
 137  </div>
 138 <div class="menu">
 139   <a title="Resources" href="resources.html">Resources</a>
 140 </div>
 141 <div class="menu">
 142   <a title="Architecture" href="architecture.html">Architecture</a>
 143 </div>
 144 <div class="menu">
 145   <a title="Download" href="download.html">Download</a>
 146 </div>
 147 <div class="sep"></div>
 148 <div class="menu">
 149   <a title="Search" href="search.html">Search</a>
 150 </div>
 151 <div class="sep"></div>
 152 <div class="menu">
 153   <a title="Site Map" href="sitemap.html">Site Map</a>
 154 </div>
 155 <div class="sub">
 156   <a title="Site Map: Links" href="links.html">Links</a>
 157 </div>
 158 <div class="sep"></div>
 159 <div class="menu">
 160   <a title="Support ImageMagick Development" href="support.html">Support ImageMagick Development</a>
 161 </div>
 162 </div>
 163
 164 <div class="eastbar">
 165
 166   <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../index.html"></a></div>
 167   <noscript>
 168     <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
 169     <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>
 170   </noscript>
 171
 172
 173 </div>
 174
 175 <div class="main">
 176
 177 <h1>ImageMagick Stream Command-line Tool</h1>
 178 <p class="navigation-index">[<a href="stream.html#usage">Example Usage</a> • <a href="stream.html#options">Option Summary</a>]</p>
 179
 180 <div class="doc-section">
 181 <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>
 182 </div>
 183
 184 <h2><a id="usage"></a>Example Usage</h2>
 185 <div class="doc-section">
 186
 187 <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>
 188
 189 <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>
 190 <p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
 191
 192 <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>
 193 <p>You can also associate the region to extract with the image filename:</p>
 194
 195 <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>
 196 </div>
 197
 198 <h2><a id="options"></a>Option Summary</h2>
 199 <div class="doc-section">
 200
 201 <p>The <code>stream</code> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 202
 203 <table class="doc">
 204   <tbody>
 205   <tr>
 206     <th align="left">Option</th>
 207     <th align="left">Description</th>
 208   </tr>
 209
 210   <tr>
 211     <td valign="top"><a href="command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
 212     <td valign="top">decrypt image with this password</td>
 213   </tr>
 214
 215   <tr>
 216     <td valign="top"><a href="command-line-options.html#channel">-channel <em class="option">type</em></a></td>
 217     <td valign="top">apply option to select image channels</td>
 218   </tr>
 219
 220   <tr>
 221     <td valign="top"><a href="command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
 222     <td valign="top">set image colorspace</td>
 223   </tr>
 224
 225   <tr>
 226     <td valign="top"><a href="command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 227     <td valign="top">display copious debugging information</td>
 228   </tr>
 229
 230   <tr>
 231     <td valign="top"><a href="command-line-options.html#define">-define <em class="option">format:option</em></a></td>
 232     <td valign="top">define one or more image format options</td>
 233   </tr>
 234
 235   <tr>
 236     <td valign="top"><a href="command-line-options.html#density">-density <em class="option">geometry</em></a></td>
 237     <td valign="top">horizontal and vertical density of the image</td>
 238   </tr>
 239
 240   <tr>
 241     <td valign="top"><a href="command-line-options.html#depth">-depth <em class="option">value</em></a></td>
 242     <td valign="top">image depth</td>
 243   </tr>
 244
 245   <tr>
 246     <td valign="top"><a href="command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
 247     <td valign="top">extract area from image</td>
 248   </tr>
 249
 250   <tr>
 251     <td valign="top"><a href="command-line-options.html#help">-help</a></td>
 252     <td valign="top">print program options</td>
 253   </tr>
 254
 255   <tr>
 256     <td valign="top"><a href="command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
 257     <td valign="top">type of image interlacing scheme</td>
 258   </tr>
 259
 260   <tr>
 261     <td valign="top"><a href="command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
 262     <td valign="top">pixel color interpolation method</td>
 263   </tr>
 264
 265   <tr>
 266     <td valign="top"><a href="command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
 267     <td valign="top">pixel cache resource limit</td>
 268   </tr>
 269
 270   <tr>
 271     <td valign="top"><a href="command-line-options.html#list">-list <em class="option">type</em></a></td>
 272     <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
 273   </tr>
 274
 275   <tr>
 276     <td valign="top"><a href="command-line-options.html#log">-log <em class="option">format</em></a></td>
 277     <td valign="top">format of debugging information</td>
 278   </tr>
 279
 280   <tr>
 281     <td valign="top"><a href="command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
 282     <td valign="top">store pixels in this format.</td>
 283   </tr>
 284
 285   <tr>
 286     <td valign="top"><a href="command-line-options.html#monitor">-monitor</a></td>
 287     <td valign="top">monitor progress</td>
 288   </tr>
 289
 290   <tr>
 291     <td valign="top"><a href="command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
 292     <td valign="top">reduce image colors in this colorspace</td>
 293   </tr>
 294
 295   <tr>
 296     <td valign="top"><a href="command-line-options.html#quiet">-quiet</a></td>
 297     <td valign="top">suppress all warning messages</td>
 298   </tr>
 299
 300   <tr>
 301     <td valign="top"><a href="command-line-options.html#regard-warnings">-regard-warnings</a></td>
 302     <td valign="top">pay attention to warning messages.</td>
 303   </tr>
 304
 305   <tr>
 306     <td valign="top"><a href="command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
 307     <td valign="top">settings remain in effect until parenthesis boundary.</td>
 308   </tr>
 309
 310   <tr>
 311     <td valign="top"><a href="command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
 312     <td valign="top">horizontal and vertical sampling factor</td>
 313   </tr>
 314
 315   <tr>
 316     <td valign="top"><a href="command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 317     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 318   </tr>
 319
 320   <tr>
 321     <td valign="top"><a href="command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
 322     <td valign="top">set an image attribute</td>
 323   </tr>
 324
 325   <tr>
 326     <td valign="top"><a href="command-line-options.html#size">-size <em class="option">geometry</em></a></td>
 327     <td valign="top">width and height of image</td>
 328   </tr>
 329
 330   <tr>
 331     <td valign="top"><a href="command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
 332     <td valign="top">store pixels with this storage type.</td>
 333   </tr>
 334
 335   <tr>
 336     <td valign="top"><a href="command-line-options.html#synchronize">-synchronize</a></td>
 337     <td valign="top">synchronize image to storage device</td>
 338   </tr>
 339
 340   <tr>
 341     <td valign="top"><a href="command-line-options.html#taint">-taint</a></td>
 342     <td valign="top">mark the image as modified</td>
 343   </tr>
 344
 345   <tr>
 346     <td valign="top"><a href="command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
 347     <td valign="top">transparent color</td>
 348   </tr>
 349
 350   <tr>
 351     <td valign="top"><a href="command-line-options.html#verbose">-verbose</a></td>
 352     <td valign="top">print detailed information about the image</td>
 353   </tr>
 354
 355   <tr>
 356     <td valign="top"><a href="command-line-options.html#version">-version</a></td>
 357     <td valign="top">print version information</td>
 358   </tr>
 359
 360   <tr>
 361     <td valign="top"><a href="command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
 362     <td valign="top">access method for pixels outside the boundaries of the image</td>
 363   </tr>
 364
 365   </tbody>
 366 </table>
 367
 368 </div>
 369
 370 </div>
 371
 372 <div id="linkbar">
 373     <span id="linkbar-west"> </span>
 374
 375     <span id="linkbar-center">
 376       <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
 377       <a href="../discourse-server">Discourse Server</a> •
 378       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> •
 379       <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
 380     </span>
 381     <span id="linkbar-east"> </span>
 382 </div>
 383 <div class="footer">
 384   <span id="footer-west">©  1999-2014 ImageMagick Studio LLC</span>
 385   <span id="footer-east"> <a href="contact.html">Contact the Wizards</a></span>
 386 </div>
 387 <div style="clear: both; margin: 0; width: 100%; "></div>
 388 </body>
 389 </html>