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

   1 \r
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   3     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
   5 <head>\r
   6   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
   7   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
   8   <title>ImageMagick: Command-line Tools: Stream</title/>
   9   <meta http-equiv="Content-Language" content="en-US"/>
  10   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  11   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  12   <meta name="Application-name" content="ImageMagick"/>
  13   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  14   <meta name="Application-url" content="http://www.imagemagick.org"/>
  15   <meta name="Generator" content="PHP"/>
  16   <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"/>
  17   <meta name="Rating" content="GENERAL"/>
  18   <meta name="Robots" content="INDEX, FOLLOW"/>
  19   <meta name="Generator" content="ImageMagick Studio LLC"/>
  20   <meta name="Author" content="ImageMagick Studio LLC"/>
  21   <meta name="Revisit-after" content="2 DAYS"/>
  22   <meta name="Resource-type" content="document"/>
  23   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  24   <meta name="Distribution" content="Global"/>
  25   <link rel="icon" href="../images/wand.png"  sizes="32x32"/>
  26   <link rel="shortcut icon" href="../images/wand.ico"  type="images/x-icon"/>
  27   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  28   <style type="text/css" media="all">\r
  29     @import url("../www/magick.css");\r
  30   </style>\r
  31 </head>\r
  32 \r
  33 <body id="www-imagemagick-org">\r
  34 <div class="titlebar">\r
  35 <a href="../index.html">\r
  36   <img src="../images/script.png" alt="[ImageMagick]"\r
  37   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  38 <a href="http://www.networkredux.com">\r
  39   <img src="../images/networkredux.png" alt="[sponsor]"\r
  40   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  41 <a href="http://www.imagemagick.org/discourse-server/">\r
  42   <img src="../images/logo.jpg" alt=""\r
  43   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  44 <a href="../index.html">\r
  45   <img src="../images/sprite.jpg" alt=""\r
  46   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  47 </div>\r
  48 \r
  49 <div class="westbar">\r
  50 \r
  51 <div class="menu">
  52   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  53 </div>
  54 <div class="sep"></div>\r
  55 <div class="menu">
  56   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
  57 </div>
  58 <div class="sub">
  59     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
  60 </div>
  61 <div class="sub">
  62     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
  63 </div>
  64 <div class="sub">
  65     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
  66 </div>
  67 <div class="sep"></div>\r
  68 <div class="menu">
  69   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
  70 </div>
  71 <div class="sub">
  72     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
  73 </div>
  74 <div class="sub">
  75     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
  76 </div>
  77 <div class="sub">
  78     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  79 </div>
  80 <div class="menu">
  81   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
  82 </div>
  83 <div class="sub">
  84     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
  88 </div>
  89 <div class="sub">
  90     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
  91 </div>
  92 <div class="sub">
  93     <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
  94 </div>
  95 <div class="sep"></div>\r
  96 <div  class="menu">
  97    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
  98 </div>
  99 <div class="sub">
 100     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
 101 </div>
 102 <div class="sub">
 103     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
 104  </div>
 105 <div class="menu">
 106   <a title="Resources" href="../www/resources.html">Resources</a>
 107 </div>
 108 <div class="menu">
 109   <a title="Architecture" href="../www/architecture.html">Architecture</a>
 110 </div>
 111 <div class="menu">
 112   <a title="Download" href="../www/download.html">Download</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
 117 </div>
 118 <div class="sep"></div>\r
 119 <div class="menu">
 120   <a title="Site Map"href="../www/sitemap.html">Site Map</a>
 121 </div>
 122 <div  class="sub">
 123     <a title="Site Map: Links"href="../www/links.html">Links</a>
 124 </div>
 125 <div class="sep"></div>\r
 126 <div  class="menu">
 127   <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 128
 129 <div class="sponsbox">
 130 <div  class="sponsor">
 131    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 132 </div>
 133 <div  class="sponsor">
 134   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 135 </div>
 136 <div  class="sponsor">
 137   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 138 </div>
 139 <div  class="sponsor">
 140   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 141 </div>
 142 <div  class="sponsor">
 143   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 144 </div>
 145 <div  class="sponsor">
 146   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 147 </div>
 148 <div  class="sponsor">
 149   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 150 </div>
 151 <div  class="sponsor">
 152    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 153 </div>
 154 </div>
 155 </div>
 156 </div>\r
 157 \r
 158 <div class="eastbar">\r
 159   <script type="text/javascript">\r
 160   <!--\r
 161     google_ad_client = "pub-3129977114552745";\r
 162     google_ad_slot = "0574824969";\r
 163     google_ad_width = 160;\r
 164     google_ad_height = 600;\r
 165   //-->\r
 166   </script>\r
 167   <script type="text/javascript"\r
 168     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 169   </script>\r
 170 </div>\r
 171 \r
 172 <div class="main">\r
 173 \r
 174 <p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
 175
 176 <div class="doc-section">
 177 <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>
 178 </div>
 179
 180 <h2><a name="usage"></a>Example Usage</h2>
 181 <div class="doc-section">
 182
 183 <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>
 184
 185 <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>
 186 <p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
 187
 188 <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>
 189 <p>You can also associate the region to extract with the image filename:</p>
 190
 191 <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>
 192 </div>
 193
 194 <h2><a name="options"></a>Option Summary</h2>
 195 <div class="doc-section">
 196
 197 <p>The <kbd>stream</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 198
 199 <table class="doc">
 200   <tbody>
 201   <tr>
 202     <th align="left">Option</th>
 203     <th align="left">Description</th>
 204   </tr>
 205
 206   <tr>
 207     <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
 208     <td valign="top">decrypt image with this password</td>
 209   </tr>
 210
 211   <tr>
 212     <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
 213     <td valign="top">apply option to select image channels</td>
 214   </tr>
 215
 216   <tr>
 217     <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
 218     <td valign="top">set image colorspace</td>
 219   </tr>
 220
 221   <tr>
 222     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 223     <td valign="top">display copious debugging information</td>
 224   </tr>
 225
 226   <tr>
 227     <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
 228     <td valign="top">define one or more image format options</td>
 229   </tr>
 230
 231   <tr>
 232     <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
 233     <td valign="top">horizontal and vertical density of the image</td>
 234   </tr>
 235
 236   <tr>
 237     <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
 238     <td valign="top">image depth</td>
 239   </tr>
 240
 241   <tr>
 242     <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
 243     <td valign="top">extract area from image</td>
 244   </tr>
 245
 246   <tr>
 247     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
 248     <td valign="top">print program options</td>
 249   </tr>
 250
 251   <tr>
 252     <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
 253     <td valign="top">type of image interlacing scheme</td>
 254   </tr>
 255
 256   <tr>
 257     <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
 258     <td valign="top">pixel color interpolation method</td>
 259   </tr>
 260
 261   <tr>
 262     <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
 263     <td valign="top">pixel cache resource limit</td>
 264   </tr>
 265
 266   <tr>
 267     <td valign="top"><a href="../www/command-line-options.html#list">-list <em class="option">type</em></a></td>
 268     <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
 269   </tr>
 270
 271   <tr>
 272     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
 273     <td valign="top">format of debugging information</td>
 274   </tr>
 275
 276   <tr>
 277     <td valign="top"><a href="../www/command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
 278     <td valign="top">store pixels in this format.</td>
 279   </tr>
 280
 281   <tr>
 282     <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
 283     <td valign="top">monitor progress</td>
 284   </tr>
 285
 286   <tr>
 287     <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
 288     <td valign="top">reduce image colors in this colorspace</td>
 289   </tr>
 290
 291   <tr>
 292     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
 293     <td valign="top">suppress all warning messages</td>
 294   </tr>
 295
 296   <tr>
 297     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
 298     <td valign="top">pay attention to warning messages.</td>
 299   </tr>
 300
 301   <tr>
 302     <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
 303     <td valign="top">settings remain in effect until parenthesis boundary.</td>
 304   </tr>
 305
 306   <tr>
 307     <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
 308     <td valign="top">horizontal and vertical sampling factor</td>
 309   </tr>
 310
 311   <tr>
 312     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 313     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 314   </tr>
 315
 316   <tr>
 317     <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
 318     <td valign="top">set an image attribute</td>
 319   </tr>
 320
 321   <tr>
 322     <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
 323     <td valign="top">width and height of image</td>
 324   </tr>
 325
 326   <tr>
 327     <td valign="top"><a href="../www/command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
 328     <td valign="top">store pixels with this storage type.</td>
 329   </tr>
 330
 331   <tr>
 332     <td valign="top"><a href="../www/command-line-options.html#synchronize">-synchronize</a></td>
 333     <td valign="top">synchronize image to storage device</td>
 334   </tr>
 335
 336   <tr>
 337     <td valign="top"><a href="../www/command-line-options.html#taint">-taint</a></td>
 338     <td valign="top">mark the image as modified</td>
 339   </tr>
 340
 341   <tr>
 342     <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
 343     <td valign="top">transparent color</td>
 344   </tr>
 345
 346   <tr>
 347     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
 348     <td valign="top">print detailed information about the image</td>
 349   </tr>
 350
 351   <tr>
 352     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
 353     <td valign="top">print version information</td>
 354   </tr>
 355
 356   <tr>
 357     <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
 358     <td valign="top">access method for pixels outside the boundaries of the image</td>
 359   </tr>
 360
 361   </tbody>
 362 </table>
 363
 364 </div>
 365 \r
 366 </div>\r
 367 \r
 368 <div id="linkbar">\r
 369     <span id="linkbar-west">&nbsp;</span>\r
 370     <span id="linkbar-center">\r
 371       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 372       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 373     </span>\r
 374     <span id="linkbar-east">&nbsp;</span>\r
 375   </div>\r
 376   <div class="footer">\r
 377     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 378     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 379   </div>\r
 380   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 381   <script type="text/javascript">\r
 382     var _gaq = _gaq || [];\r
 383     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 384     _gaq.push(['_trackPageview']);\r
 385 \r
 386     (function() {\r
 387       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 388       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 389       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 390     })();\r
 391   </script>\r
 392 </body>\r
 393 </html>\r