diff options
Diffstat (limited to 'rawtopgm.html')
| -rw-r--r-- | rawtopgm.html | 165 |
1 files changed, 81 insertions, 84 deletions
diff --git a/rawtopgm.html b/rawtopgm.html index a083b82d..17175a45 100644 --- a/rawtopgm.html +++ b/rawtopgm.html @@ -1,38 +1,35 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN"> -<HTML><HEAD><TITLE>Rawtopgm User Manual</TITLE></HEAD> -<BODY> -<H1>rawtopgm</H1> +<html><head><title>Rawtopgm User Manual</title></head> +<body> +<h1>rawtopgm</h1> Updated: 14 September 2000 -<BR> -<A HREF="#index">Table Of Contents</A> -<A NAME="lbAB"> </A> -<H2>NAME</H2> +<br> +<a href="#index">Table Of Contents</a> +<h2>NAME</h2> rawtopgm - convert raw grayscale bytes to a PGM image -<A NAME="lbAC"> </A> -<H2>SYNOPSIS</H2> +<h2 id="synopsis">SYNOPSIS</h2> -<B>rawtopgm</B> +<b>rawtopgm</b> -[<B>-bpp</B> [<B>1</B>|<B>2</B>]] +[<b>-bpp</b> [<b>1</b>|<b>2</b>]] -[<B>-littleendian</B>] +[<b>-littleendian</b>] -[<B>-maxval</B> <I>N</I>] +[<b>-maxval</b> <i>N</i>] -[<B>-headerskip</B> <I>N</I>] +[<b>-headerskip</b> <i>N</i>] -[<B>-rowskip</B> <I>N</I>] +[<b>-rowskip</b> <i>N</i>] -[<B>-tb</B>|<B>-topbottom</B>] +[<b>-tb</b>|<b>-topbottom</b>] -[<I>width</I> <I>height</I>] +[<i>width</i> <i>height</i>] -[<I>imagefile</I>] +[<i>imagefile</i>] -<A NAME="lbAD"> </A> -<H2>DESCRIPTION</H2> +<h2 id="description">DESCRIPTION</h2> <p>This program is part of <a href="index.html">Netpbm</a>. @@ -42,129 +39,129 @@ numbers, either one or two bytes each, either bigendian or littleendian, representing gray values. They may be arranged either top to bottom, left to right or bottom to top, left to right. There may be arbitrary header information at the start of the file (to which -<B>rawtopgm</B> pays no attention at all other than the header's +<b>rawtopgm</b> pays no attention at all other than the header's size). -<P>Arguments to <B>rawtopgm</B> tell how to interpret the pixels (a +<p>Arguments to <b>rawtopgm</b> tell how to interpret the pixels (a function that is served by a header in a regular graphics format). -<P>The <I>width</I> and <I>height</I> parameters tell the dimensions -of the image. If you omit these parameters, <B>rawtopgm</B> assumes +<p>The <i>width</i> and <i>height</i> parameters tell the dimensions +of the image. If you omit these parameters, <b>rawtopgm</b> assumes it is a quadratic image and bases the dimensions on the size of the -input stream. If this size is not a perfect square, <B>rawtopgm</B> +input stream. If this size is not a perfect square, <b>rawtopgm</b> fails. -<P>When you don't specify <I>width</I> and <I>height</I>, -<B>rawtopgm</B> reads the entire input stream into storage at once, -which may take a lot of storage. Otherwise, <B>rawtopgm</B> +<p>When you don't specify <i>width</i> and <i>height</i>, +<b>rawtopgm</b> reads the entire input stream into storage at once, +which may take a lot of storage. Otherwise, <b>rawtopgm</b> ordinarily stores only one row at a time. -<P>If you don't specify <I>imagefile</I>, or specify <B>-</B>, the +<p>If you don't specify <i>imagefile</i>, or specify <b>-</b>, the input is from Standard Input. -<P>The PGM output is to Standard Output. +<p>The PGM output is to Standard Output. -<A NAME="lbAE"> </A> -<H2>OPTIONS</H2> +<h2 id="options">OPTIONS</h2> -<DL COMPACT> -<DT><B>-maxval</B> <I>N</I> +<p>In addition to the options common to all programs based on libnetpbm +(most notably <b>-quiet</b>, see <a href="index.html#commonoptions"> +Common Options</a>), <b>rawtopgm</b> recognizes the following +command line options: -<DD><I>N</I> is the maxval for the gray values in the input, and is +<dl compact> +<dt><b>-maxval</b> <i>N</i> + +<dd><i>N</i> is the maxval for the gray values in the input, and is also the maxval of the PGM output image. The default is the maximum value that can be represented in the number of bytes used for each sample (i.e. 255 or 65535). -<DT><B>-bpp</B> [<B>1</B>|<B>2</B>] +<dt><b>-bpp</b> [<b>1</b>|<b>2</b>] -<DD>tells the number of bytes that represent each sample in the input. -If the value is <B>2</B>, The most significant byte is first in the +<dd>tells the number of bytes that represent each sample in the input. +If the value is <b>2</b>, The most significant byte is first in the stream. -<P>The default is 1 byte per sample. +<p>The default is 1 byte per sample. -<DT><B>-littleendian</B> +<dt><b>-littleendian</b> -<DD>says that the bytes of each input sample are ordered with the -least significant byte first. Without this option, <B>rawtopgm</B> +<dd>says that the bytes of each input sample are ordered with the +least significant byte first. Without this option, <b>rawtopgm</b> assumes MSB first. This obviously has no effect when there is only one byte per sample. -<DT><B>-headerskip</B> <I>N</I> +<dt><b>-headerskip</b> <i>N</i> -<DD><B>rawtopgm</B> skips over <I>N</I> bytes at the beginning of the +<dd><b>rawtopgm</b> skips over <i>N</i> bytes at the beginning of the stream and reads the image immediately after. The default is 0. -<P>This is useful when the input is actually some graphics format that +<p>This is useful when the input is actually some graphics format that has a descriptive header followed by an ordinary raster, and you don't have a program that understands the header or you want to ignore the header. -<DT><B>-rowskip</B> <I>N</I> +<dt><b>-rowskip</b> <i>N</i> -<DD>If there is padding at the ends of the rows, you can skip it with +<dd>If there is padding at the ends of the rows, you can skip it with this option. Note that rowskip need not be an integer. Amazingly, I once had an image with 0.376 bytes of padding per row. This turned out to be due to a file-transfer problem, but I was still able to read the image. -<P>Skipping a fractional byte per row means skipping one byte per +<p>Skipping a fractional byte per row means skipping one byte per multiple rows. -<DT><B>-bt -bottomfirst</B> +<dt><b>-bt -bottomfirst</b> -<DD>By default, <B>rawtopgm</B> assumes the pixels in the input go top -to bottom, left to right. If you specify <B>-bt</B> or -<B>-bottomfirst</B>, <B>rawtopgm</B> assumes the pixels go bottom to +<dd>By default, <b>rawtopgm</b> assumes the pixels in the input go top +to bottom, left to right. If you specify <b>-bt</b> or +<b>-bottomfirst</b>, <b>rawtopgm</b> assumes the pixels go bottom to top, left to right. The Molecular Dynamics and Leica confocal format, for example, use the latter arrangement. -<P>If you don't specify <B>-bt</B> when you should or vice versa, the +<p>If you don't specify <b>-bt</b> when you should or vice versa, the resulting image is upside down, which you can correct with -<B>pamflip</B>. +<b>pamflip</b>. -<P>This option causes <B>rawtopgm</B> to read the entire input stream +<p>This option causes <b>rawtopgm</b> to read the entire input stream into storage at once, which may take a lot of storage. Normally, -<B>rawtopgm</B> stores only one row at a time. +<b>rawtopgm</b> stores only one row at a time. -<P>For backwards compatibility, <B>rawtopgm</B> also accepts <B>-tb -</B> and <B>-topbottom</B> to mean exactly the same thing. The +<p>For backwards compatibility, <b>rawtopgm</b> also accepts <b>-tb +</b> and <b>-topbottom</b> to mean exactly the same thing. The reasons these are named backwards is that the original author thought of it as specifying that the wrong results of assuming the data is top to bottom should be corrected by flipping the result top for bottom. Today, we think of it as simply specifying the format of the input data so that there are no wrong results. -</DL> +</dl> -<A NAME="lbAF"> </A> -<H2>SEE ALSO</H2> +<h2 id="seealso">SEE ALSO</h2> -<B><A HREF="pgm.html">pgm</A></B>, +<b><a href="pgm.html">pgm</a></b>, -<B><A HREF="rawtoppm.html">rawtoppm</A></B>, +<b><a href="rawtoppm.html">rawtoppm</a></b>, -<B><A HREF="pamflip.html">pamflip</A></B> +<b><a href="pamflip.html">pamflip</a></b> -<A NAME="lbAG"> </A> -<H2>AUTHORS</H2> +<h2 id="authors">AUTHORS</h2> Copyright (C) 1989 by Jef Poskanzer. -<BR> - -Modified June 1993 by Oliver Trepte, <A -HREF="mailto:oliver@fysik4.kth.se">oliver@fysik4.kth.se</A> - -<HR> -<A NAME="index"> </A> -<H2>Table Of Contents</H2> -<UL> -<LI><A HREF="#lbAB">NAME</A> -<LI><A HREF="#lbAC">SYNOPSIS</A> -<LI><A HREF="#lbAD">DESCRIPTION</A> -<LI><A HREF="#lbAE">OPTIONS</A> -<LI><A HREF="#lbAF">SEE ALSO</A> -<LI><A HREF="#lbAG">AUTHORS</A> -</UL> -</BODY> -</HTML> +<br> + +Modified June 1993 by Oliver Trepte, <a +href="mailto:oliver@fysik4.kth.se">oliver@fysik4.kth.se</a> + +<hr> +<h2 id="index">Table Of Contents</h2> +<ul> +<li><a href="#synopsis">SYNOPSIS</a> +<li><a href="#description">DESCRIPTION</a> +<li><a href="#options">OPTIONS</a> +<li><a href="#seealso">SEE ALSO</a> +<li><a href="#authors">AUTHORS</a> +</ul> +</body> +</html> |