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

   1 \r
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   3   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   4 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   5       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   6       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   7       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   8                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   9 <head>\r
  10   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  11   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>\r
  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, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Image, Processing, Automagically"/>
  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-2011 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" />\r
  32   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  33   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  34   <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  35   <style type="text/css" media="all">\r
  36     @import url("../www/magick.css");\r
  37   </style>\r
  38   <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>\r
  39   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>\r
  40   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  41   <script type="text/javascript">\r
  42     $(document).ready(function() {\r
  43       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  44         'transitionIn'  : 'elastic',\r
  45         'transitionOut' : 'elastic',\r
  46         'overlayShow'   : false,\r
  47         'opacity'       : true\r
  48       });\r
  49     });\r
  50   </script>\r
  51 </head>\r
  52 \r
  53 <body id="www-imagemagick-org">\r
  54 <div class="titlebar">\r
  55 <div style="margin: 17px auto; float: left;">\r
  56   <script type="text/javascript">\r
  57   <!--\r
  58     google_ad_client = "pub-3129977114552745";\r
  59     google_ad_slot = "5439289906";\r
  60     google_ad_width = 728;\r
  61     google_ad_height = 90;\r
  62   //-->\r
  63   </script>\r
  64   <script type="text/javascript"\r
  65     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  66   </script>\r
  67 </div>\r
  68 <a href="http://www.imagemagick.org/discourse-server/">\r
  69   <img src="../images/logo.jpg"\r
  70   alt="ImageMagick Logo"\r
  71   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  72 <a href="../index.html">\r
  73   <img src="../images/sprite.jpg"\r
  74   alt="ImageMagick Sprite"\r
  75   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  76 </div>\r
  77 \r
  78 <div class="westbar">\r
  79 \r
  80 <div class="menu">
  81   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  82 </div>
  83 <div class="menu">
  84   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
  88 </div>
  89 <div class="sub">
  90     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
  91 </div>
  92 <div class="sub">
  93     <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
  97 </div>
  98 <div class="sep"></div>\r
  99 <div class="menu">
 100   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
 101 </div>
 102 <div class="sub">
 103     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
 104 </div>
 105 <div class="sub">
 106     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
 107 </div>
 108 <div class="sub">
 109     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 110 </div>
 111 <div class="menu">
 112   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
 116 </div>
 117 <div class="sub">
 118     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
 119 </div>
 120 <div class="sub">
 121     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
 122 </div>
 123 <div class="sub">
 124     <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
 125 </div>
 126 <div class="sep"></div>\r
 127 <div  class="menu">
 128    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
 129 </div>
 130 <div class="sub">
 131     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
 132 </div>
 133 <div class="sub">
 134     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
 135  </div>
 136 <div class="menu">
 137   <a title="Resources" href="../www/resources.html">Resources</a>
 138 </div>
 139 <div class="menu">
 140   <a title="Architecture" href="../www/architecture.html">Architecture</a>
 141 </div>
 142 <div class="menu">
 143   <a title="Download" href="../www/download.html">Download</a>
 144 </div>
 145 <div class="sep"></div>\r
 146 <div class="menu">
 147   <a title="Search" href="../www/search.html">Search</a>
 148 </div>
 149 <div class="sep"></div>\r
 150 <div class="menu">
 151   <a title="Site Map" href="../www/sitemap.html">Site Map</a>
 152 </div>
 153 <div  class="sub">
 154   <a title="Site Map: Links" href="../www/links.html">Links</a>
 155 </div>
 156 <div class="sep"></div>\r
 157 <div  class="menu">
 158   <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 159
 160 <a href="http://www.networkredux.com">
 161   <img src="../images/networkredux.png" width="140" height="31" alt="[sponsor]"
 162   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 163 <div class="sponsbox">
 164 <div  class="sponsor">
 165   <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540s suvalj -->
 166 </div>
 167 <div  class="sponsor">
 168   <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
 169 </div>
 170 <div  class="sponsor">
 171   <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
 172 </div>
 173 <div  class="sponsor">
 174   <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 175 </div>
 176 <div  class="sponsor">
 177   <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
 178 </div>
 179 <div  class="sponsor">
 180   <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
 181 </div>
 182 <div  class="sponsor">
 183   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
 184 </div>
 185 <div  class="sponsor">
 186   <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
 187 </div>
 188 <div  class="sponsor">
 189   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 190 </div>
 191 <div  class="sponsor">
 192   <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
 193 </div>
 194 <div  class="sponsor">
 195   <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 196 </div>
 197 <div  class="sponsor">
 198   <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 199 </div>
 200 <div  class="sponsor">
 201   <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 202 </div>
 203 <div  class="sponsor">
 204   <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 205 </div>
 206 <div  class="sponsor">
 207    <a rel="follow" title="Sponsor: Brand shopping" href="http://brandport.net">Brand shopping</a><!-- 20120201000150 gyaku@gyaku... -->
 208 </div>
 209 </div>
 210 </div>
 211 </div>\r
 212 \r
 213 <div class="eastbar">\r
 214   <div class="g-plusone" data-size="standard" data-count="false"></div>\r
 215 </div>\r
 216 \r
 217 <div class="main">\r
 218 \r
 219 <h1>ImageMagick Stream Command-line Tool</h1>
 220 <p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
 221
 222 <div class="doc-section">
 223 <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>
 224 </div>
 225
 226 <h2><a id="usage"></a>Example Usage</h2>
 227 <div class="doc-section">
 228
 229 <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>
 230
 231 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>stream -map rgb -storage-type char image.jpg pixels.dat</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>display -depth 8 -size 640x480 rgb:pixels.dat</span></p>
 232 <p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
 233
 234 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>stream -map i -storage-type double -extract 100x100+30+40 image.tif gray.raw</span></p>
 235 <p>You can also associate the region to extract with the image filename:</p>
 236
 237 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>stream -map i -storage-type double 'image.tif[100x100+30+40]' gray.raw</span></p>
 238 </div>
 239
 240 <h2><a id="options"></a>Option Summary</h2>
 241 <div class="doc-section">
 242
 243 <p>The <kbd>stream</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 244
 245 <table class="doc">
 246   <tbody>
 247   <tr>
 248     <th align="left">Option</th>
 249     <th align="left">Description</th>
 250   </tr>
 251
 252   <tr>
 253     <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
 254     <td valign="top">decrypt image with this password</td>
 255   </tr>
 256
 257   <tr>
 258     <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
 259     <td valign="top">apply option to select image channels</td>
 260   </tr>
 261
 262   <tr>
 263     <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
 264     <td valign="top">set image colorspace</td>
 265   </tr>
 266
 267   <tr>
 268     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 269     <td valign="top">display copious debugging information</td>
 270   </tr>
 271
 272   <tr>
 273     <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
 274     <td valign="top">define one or more image format options</td>
 275   </tr>
 276
 277   <tr>
 278     <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
 279     <td valign="top">horizontal and vertical density of the image</td>
 280   </tr>
 281
 282   <tr>
 283     <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
 284     <td valign="top">image depth</td>
 285   </tr>
 286
 287   <tr>
 288     <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
 289     <td valign="top">extract area from image</td>
 290   </tr>
 291
 292   <tr>
 293     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
 294     <td valign="top">print program options</td>
 295   </tr>
 296
 297   <tr>
 298     <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
 299     <td valign="top">type of image interlacing scheme</td>
 300   </tr>
 301
 302   <tr>
 303     <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
 304     <td valign="top">pixel color interpolation method</td>
 305   </tr>
 306
 307   <tr>
 308     <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
 309     <td valign="top">pixel cache resource limit</td>
 310   </tr>
 311
 312   <tr>
 313     <td valign="top"><a href="../www/command-line-options.html#list">-list <em class="option">type</em></a></td>
 314     <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
 315   </tr>
 316
 317   <tr>
 318     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
 319     <td valign="top">format of debugging information</td>
 320   </tr>
 321
 322   <tr>
 323     <td valign="top"><a href="../www/command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
 324     <td valign="top">store pixels in this format.</td>
 325   </tr>
 326
 327   <tr>
 328     <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
 329     <td valign="top">monitor progress</td>
 330   </tr>
 331
 332   <tr>
 333     <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
 334     <td valign="top">reduce image colors in this colorspace</td>
 335   </tr>
 336
 337   <tr>
 338     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
 339     <td valign="top">suppress all warning messages</td>
 340   </tr>
 341
 342   <tr>
 343     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
 344     <td valign="top">pay attention to warning messages.</td>
 345   </tr>
 346
 347   <tr>
 348     <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
 349     <td valign="top">settings remain in effect until parenthesis boundary.</td>
 350   </tr>
 351
 352   <tr>
 353     <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
 354     <td valign="top">horizontal and vertical sampling factor</td>
 355   </tr>
 356
 357   <tr>
 358     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 359     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 360   </tr>
 361
 362   <tr>
 363     <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
 364     <td valign="top">set an image attribute</td>
 365   </tr>
 366
 367   <tr>
 368     <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
 369     <td valign="top">width and height of image</td>
 370   </tr>
 371
 372   <tr>
 373     <td valign="top"><a href="../www/command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
 374     <td valign="top">store pixels with this storage type.</td>
 375   </tr>
 376
 377   <tr>
 378     <td valign="top"><a href="../www/command-line-options.html#synchronize">-synchronize</a></td>
 379     <td valign="top">synchronize image to storage device</td>
 380   </tr>
 381
 382   <tr>
 383     <td valign="top"><a href="../www/command-line-options.html#taint">-taint</a></td>
 384     <td valign="top">mark the image as modified</td>
 385   </tr>
 386
 387   <tr>
 388     <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
 389     <td valign="top">transparent color</td>
 390   </tr>
 391
 392   <tr>
 393     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
 394     <td valign="top">print detailed information about the image</td>
 395   </tr>
 396
 397   <tr>
 398     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
 399     <td valign="top">print version information</td>
 400   </tr>
 401
 402   <tr>
 403     <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
 404     <td valign="top">access method for pixels outside the boundaries of the image</td>
 405   </tr>
 406
 407   </tbody>
 408 </table>
 409
 410 </div>
 411 \r
 412 </div>\r
 413 \r
 414 <div id="linkbar">\r
 415     <span id="linkbar-west">&nbsp;</span>\r
 416     <span id="linkbar-center">\r
 417       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 418       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 419     </span>\r
 420     <span id="linkbar-east">&nbsp;</span>\r
 421   </div>\r
 422   <div class="footer">\r
 423     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 424     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 425   </div>\r
 426   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 427   <script type="text/javascript">\r
 428     var _gaq = _gaq || [];\r
 429     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 430     _gaq.push(['_trackPageview']);\r
 431 \r
 432     (function() {\r
 433       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 434       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 435       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 436     })();\r
 437   </script>\r
 438 </body>\r
 439 </html>\r