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">\r
   5 <head>\r
   6   <meta http-equiv="Content-Type" value="application/xhtml+xml" />\r
   7   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   8   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   9   <style type="text/css" media="screen,projection"><!--\r
  10     @import url("../www/magick.css");\r
  11   --></style>\r
  12   <link rel="shortcut icon" href="../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  13   <title>ImageMagick: Command-line Tools: Stream</title>
  14   <meta http-equiv="Content-Language" content="en-US"/>
  15   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  16   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  17   <meta name="Generator" content="PHP"/>
  18   <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"/>
  19   <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."/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28 </head>\r
  29 \r
  30 <body id="www-imagemagick-org">\r
  31 <div class="titlebar">\r
  32 <a href="../index.html">\r
  33   <img src="../images/script.png" alt="[ImageMagick]"\r
  34   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  35 <a href="http://www.networkredux.com">\r
  36   <img src="../images/networkredux.png" alt="[sponsor]"\r
  37   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  38 <a href="http://www.imagemagick.org/discourse-server/">\r
  39   <img src="../images/logo.jpg" alt=""\r
  40   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  41 <a href="../index.html">\r
  42   <img src="../images/sprite.jpg" alt=""\r
  43   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  44 </div>\r
  45 \r
  46 <div class="eastbar">\r
  47 \r
  48 <div class="menu">
  49   <a href="../index.html">About ImageMagick</a>
  50 </div>
  51 <div class="sep"></div>\r
  52 <div class="menu">
  53   <a href="../www/command-line-tools.html">Command-line Tools</a>
  54 </div>
  55 <div class="sub">
  56     <a href="../www/command-line-processing.html">Processing</a>
  57 </div>
  58 <div class="sub">
  59     <a href="../www/command-line-options.html">Options</a>
  60 </div>
  61 <div class="sub">
  62     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  63 </div>
  64 <div class="menu">
  65   <a href="../www/api.html">Program Interfaces</a>
  66 </div>
  67 <div class="sub">
  68     <a href="../www/magick-wand.html">MagickWand</a>
  69 </div>
  70 <div class="sub">
  71     <a href="../www/magick-core.html">MagickCore</a>
  72 </div>
  73 <div class="sub">
  74     <a href="../www/perl-magick.html">PerlMagick</a>
  75 </div>
  76 <div class="sub">
  77     <a href="../Magick++/">Magick++</a>
  78 </div>
  79 <div class="menu">
  80   <a href="../www/architecture.html">Architecture</a>
  81 </div>
  82 <div class="sep"></div>\r
  83 <div  class="menu">
  84    <a href="../www/install-source.html">Install from Source</a>
  85 </div>
  86 <div class="sub">
  87     <a href="../www/install-source.html#unix">Unix</a>
  88 </div>
  89 <div class="sub">
  90     <a href="../www/install-source.html#windows">Windows</a>
  91  </div>
  92 <div class="menu">
  93   <a href="../www/binary-releases.html">Binary Releases</a>
  94 </div>
  95 <div class="sub">
  96     <a href="../www/binary-releases.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a href="../www/binary-releases.html#macosx">Mac OS X</a>
 100 </div>
 101 <div class="sub">
 102     <a href="../www/binary-releases.html#windows">Windows</a>
 103 </div>
 104 <div class="menu">
 105   <a href="../www/resources.html">Resources</a>
 106 </div>
 107 <div class="sep"></div>\r
 108 <div class="menu">
 109   <a href="../www/download.html">Download</a>
 110 </div>
 111 <div class="sep"></div>\r
 112 <div class="menu">
 113   <a href="http://www.imagemagick.org/script/search.php">Search</a>
 114 </div>
 115 <div class="sep"></div>\r
 116 <div class="menu">
 117   <a href="../www/sitemap.html">Site Map</a>
 118 </div>
 119 <div  class="sub">
 120     <a href="../www/links.html">Links</a>
 121 </div>
 122 <div class="sep"></div>\r
 123 <div  class="menu">
 124   <a href="../www/sponsors.html">Sponsors:</a>
 125
 126 <div class="sponsbox">
 127 <div  class="sponsor">
 128    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
 129 </div>
 130 <div  class="sponsor">
 131   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 132 </div>
 133 <div  class="sponsor">
 134   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201006010120 Buchhorn -->
 135 </div>
 136 <div  class="sponsor">
 137   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 138 </div>
 139 <div  class="sponsor">
 140   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 141 </div>
 142 <div  class="sponsor">
 143    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 144 </div>
 145 <div  class="sponsor">
 146    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 147 </div>
 148 <div  class="sponsor">
 149   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 150 </div>
 151 </div>
 152 </div>
 153 \r
 154 \r
 155 </div>\r
 156 \r
 157 <div class="main">\r
 158 \r
 159 <p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
 160
 161 <div class="doc-section">
 162 <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>
 163 </div>
 164
 165 <h2><a name="usage"></a>Example Usage</h2>
 166 <div class="doc-section">
 167
 168 <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>
 169
 170 <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>
 171 <p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
 172
 173 <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>
 174 <p>You can also associate the region to extract with the image filename:</p>
 175
 176 <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>
 177 </div>
 178
 179 <h2><a name="options"></a>Option Summary</h2>
 180 <div class="doc-section">
 181
 182 <p>The <kbd>stream</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 183
 184 <table class="doc">
 185   <tbody>
 186   <tr>
 187     <th align="left">Option</th>
 188     <th align="left">Description</th>
 189   </tr>
 190
 191   <tr>
 192     <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
 193     <td valign="top">decrypt image with this password</td>
 194   </tr>
 195
 196   <tr>
 197     <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
 198     <td valign="top">apply option to select image channels</td>
 199   </tr>
 200
 201   <tr>
 202     <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
 203     <td valign="top">set image colorspace</td>
 204   </tr>
 205
 206   <tr>
 207     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 208     <td valign="top">display copious debugging information</td>
 209   </tr>
 210
 211   <tr>
 212     <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
 213     <td valign="top">define one or more image format options</td>
 214   </tr>
 215
 216   <tr>
 217     <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
 218     <td valign="top">horizontal and vertical density of the image</td>
 219   </tr>
 220
 221   <tr>
 222     <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
 223     <td valign="top">image depth</td>
 224   </tr>
 225
 226   <tr>
 227     <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
 228     <td valign="top">extract area from image</td>
 229   </tr>
 230
 231   <tr>
 232     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
 233     <td valign="top">print program options</td>
 234   </tr>
 235
 236   <tr>
 237     <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
 238     <td valign="top">type of image interlacing scheme</td>
 239   </tr>
 240
 241   <tr>
 242     <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
 243     <td valign="top">pixel color interpolation method</td>
 244   </tr>
 245
 246   <tr>
 247     <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
 248     <td valign="top">pixel cache resource limit</td>
 249   </tr>
 250
 251   <tr>
 252     <td valign="top"><a href="../www/command-line-options.html#list">-list <em class="option">type</em></a></td>
 253     <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
 254   </tr>
 255
 256   <tr>
 257     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
 258     <td valign="top">format of debugging information</td>
 259   </tr>
 260
 261   <tr>
 262     <td valign="top"><a href="../www/command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
 263     <td valign="top">store pixels in this format.</td>
 264   </tr>
 265
 266   <tr>
 267     <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
 268     <td valign="top">monitor progress</td>
 269   </tr>
 270
 271   <tr>
 272     <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
 273     <td valign="top">reduce image colors in this colorspace</td>
 274   </tr>
 275
 276   <tr>
 277     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
 278     <td valign="top">suppress all warning messages</td>
 279   </tr>
 280
 281   <tr>
 282     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
 283     <td valign="top">pay attention to warning messages.</td>
 284   </tr>
 285
 286   <tr>
 287     <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
 288     <td valign="top">settings remain in effect until parenthesis boundary.</td>
 289   </tr>
 290
 291   <tr>
 292     <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
 293     <td valign="top">horizontal and vertical sampling factor</td>
 294   </tr>
 295
 296   <tr>
 297     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 298     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 299   </tr>
 300
 301   <tr>
 302     <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
 303     <td valign="top">set an image attribute</td>
 304   </tr>
 305
 306   <tr>
 307     <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
 308     <td valign="top">width and height of image</td>
 309   </tr>
 310
 311   <tr>
 312     <td valign="top"><a href="../www/command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
 313     <td valign="top">store pixels with this storage type.</td>
 314   </tr>
 315
 316   <tr>
 317     <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
 318     <td valign="top">transparent color</td>
 319   </tr>
 320
 321   <tr>
 322     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
 323     <td valign="top">print detailed information about the image</td>
 324   </tr>
 325
 326   <tr>
 327     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
 328     <td valign="top">print version information</td>
 329   </tr>
 330
 331   <tr>
 332     <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
 333     <td valign="top">access method for pixels outside the boundaries of the image</td>
 334   </tr>
 335
 336   </tbody>
 337 </table>
 338
 339 </div>
 340 \r
 341 </div>\r
 342 \r
 343 <div id="linkbar">\r
 344  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 345     <span id="linkbar-center">\r
 346       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 347       <a href="../www/mailing-list.html">Mailing Lists</a> &bull;\r
 348     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 349     </span>\r
 350     <span id="linkbar-east">&nbsp;</span>\r
 351   </div>\r
 352   <div class="footer">\r
 353     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 354     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 355   </div>\r
 356   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 357 </body>\r
 358 </html>\r