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