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