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