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><!-- 201007010120 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>
 149 </div>
 150 \r
 151 \r
 152 </div>\r
 153 \r
 154 <div class="main">\r
 155 \r
 156 <p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
 157
 158 <div class="doc-section">
 159 <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>
 160 </div>
 161
 162 <h2><a name="usage"></a>Example Usage</h2>
 163 <div class="doc-section">
 164
 165 <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>
 166
 167 <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>
 168 <p>Here we extract a 100x100 region from a TIFF image in the grayscale format as doubles:</p>
 169
 170 <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>
 171 <p>You can also associate the region to extract with the image filename:</p>
 172
 173 <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>
 174 </div>
 175
 176 <h2><a name="options"></a>Option Summary</h2>
 177 <div class="doc-section">
 178
 179 <p>The <kbd>stream</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 180
 181 <table class="doc">
 182   <tbody>
 183   <tr>
 184     <th align="left">Option</th>
 185     <th align="left">Description</th>
 186   </tr>
 187
 188   <tr>
 189     <td valign="top"><a href="../www/command-line-options.html#authenticate">-authenticate <em class="option">value</em></a></td>
 190     <td valign="top">decrypt image with this password</td>
 191   </tr>
 192
 193   <tr>
 194     <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
 195     <td valign="top">apply option to select image channels</td>
 196   </tr>
 197
 198   <tr>
 199     <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
 200     <td valign="top">set image colorspace</td>
 201   </tr>
 202
 203   <tr>
 204     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 205     <td valign="top">display copious debugging information</td>
 206   </tr>
 207
 208   <tr>
 209     <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
 210     <td valign="top">define one or more image format options</td>
 211   </tr>
 212
 213   <tr>
 214     <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
 215     <td valign="top">horizontal and vertical density of the image</td>
 216   </tr>
 217
 218   <tr>
 219     <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
 220     <td valign="top">image depth</td>
 221   </tr>
 222
 223   <tr>
 224     <td valign="top"><a href="../www/command-line-options.html#extract">-extract <em class="option">geometry</em></a></td>
 225     <td valign="top">extract area from image</td>
 226   </tr>
 227
 228   <tr>
 229     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
 230     <td valign="top">print program options</td>
 231   </tr>
 232
 233   <tr>
 234     <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
 235     <td valign="top">type of image interlacing scheme</td>
 236   </tr>
 237
 238   <tr>
 239     <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
 240     <td valign="top">pixel color interpolation method</td>
 241   </tr>
 242
 243   <tr>
 244     <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
 245     <td valign="top">pixel cache resource limit</td>
 246   </tr>
 247
 248   <tr>
 249     <td valign="top"><a href="../www/command-line-options.html#list">-list <em class="option">type</em></a></td>
 250     <td valign="top">Color, Configure, Delegate, Format, Magic, Module, Resource, or Type</td>
 251   </tr>
 252
 253   <tr>
 254     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
 255     <td valign="top">format of debugging information</td>
 256   </tr>
 257
 258   <tr>
 259     <td valign="top"><a href="../www/command-line-options.html#stream-map">-map <em class="option">components</em></a></td>
 260     <td valign="top">store pixels in this format.</td>
 261   </tr>
 262
 263   <tr>
 264     <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
 265     <td valign="top">monitor progress</td>
 266   </tr>
 267
 268   <tr>
 269     <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
 270     <td valign="top">reduce image colors in this colorspace</td>
 271   </tr>
 272
 273   <tr>
 274     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
 275     <td valign="top">suppress all warning messages</td>
 276   </tr>
 277
 278   <tr>
 279     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
 280     <td valign="top">pay attention to warning messages.</td>
 281   </tr>
 282
 283   <tr>
 284     <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
 285     <td valign="top">settings remain in effect until parenthesis boundary.</td>
 286   </tr>
 287
 288   <tr>
 289     <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
 290     <td valign="top">horizontal and vertical sampling factor</td>
 291   </tr>
 292
 293   <tr>
 294     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 295     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 296   </tr>
 297
 298   <tr>
 299     <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
 300     <td valign="top">set an image attribute</td>
 301   </tr>
 302
 303   <tr>
 304     <td valign="top"><a href="../www/command-line-options.html#size">-size <em class="option">geometry</em></a></td>
 305     <td valign="top">width and height of image</td>
 306   </tr>
 307
 308   <tr>
 309     <td valign="top"><a href="../www/command-line-options.html#storage-type">-storage-type <em class="option">type</em></a></td>
 310     <td valign="top">store pixels with this storage type.</td>
 311   </tr>
 312
 313   <tr>
 314     <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
 315     <td valign="top">transparent color</td>
 316   </tr>
 317
 318   <tr>
 319     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
 320     <td valign="top">print detailed information about the image</td>
 321   </tr>
 322
 323   <tr>
 324     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
 325     <td valign="top">print version information</td>
 326   </tr>
 327
 328   <tr>
 329     <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
 330     <td valign="top">access method for pixels outside the boundaries of the image</td>
 331   </tr>
 332
 333   </tbody>
 334 </table>
 335
 336 </div>
 337 \r
 338 </div>\r
 339 \r
 340 <div id="linkbar">\r
 341  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 342     <span id="linkbar-center">\r
 343       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 344     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 345     </span>\r
 346     <span id="linkbar-east">&nbsp;</span>\r
 347   </div>\r
 348   <div class="footer">\r
 349     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 350     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 351   </div>\r
 352   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 353 </body>\r
 354 </html>\r