about summary refs log tree commit diff
path: root/pamstack.html
diff options
context:
space:
mode:
Diffstat (limited to 'pamstack.html')
-rw-r--r--pamstack.html102
1 files changed, 102 insertions, 0 deletions
diff --git a/pamstack.html b/pamstack.html
new file mode 100644
index 00000000..295a01fd
--- /dev/null
+++ b/pamstack.html
@@ -0,0 +1,102 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
+<HTML>
+<HEAD><TITLE>Pamstack User Manual</TITLE></HEAD>
+<BODY>
+
+<H1>pamstack</H1>
+Updated: 10 January 2006
+<BR>
+<A HREF="#index">Table Of Contents</A>
+
+<H2 id="name">NAME</H2>
+
+pamstack - stack planes of multiple PAM images into one PAM image
+
+<H2 id="synopsis">SYNOPSIS</H2>
+
+<B>pamstack</B>
+[<B>-tupletype </B><I>tupletype</I>]
+[<I>inputfilespec</I> ...]
+
+<P>All options may be abbreviated to the shortest unique prefix.  You
+may use two hyphens instead of one.  You may separate an option from
+its value with a space instead of <B>=</B>.
+
+<H2 id="description">DESCRIPTION</H2>
+
+<p>This program is part of <a href="index.html">Netpbm</a>.
+
+<P><b>pamstack</b> reads multiple PAM or PNM images as input and
+produces a PAM image as output, consisting of all the planes
+(channels) of the inputs, stacked in the order specified.
+
+<P>The output is the same dimensions as the inputs, except that the
+depth is the sum of the depths of the inputs.  It has the same maxval.
+<B>pamstack</B> fails if the inputs are not all the same width, height,
+and maxval.  The tuple type is a null string unless you specify the
+<B>-tupletype</B> option.
+
+<p><b>pamstack</b> works with multi-image streams.  It stacks the 1st
+image in all the streams into one output image (the first one in the
+output stream), then stacks the 2nd image in all the streams into the
+2nd image in the output stream, and so on, until one of the streams
+runs dry.  It's like a matrix operation.
+
+<p>Before Netpbm 10.32 (February 2006), <b>pamstack</b> ignored all but
+the first image in each input stream.
+
+<P><B>pamchannel</B> does the opposite of <B>pamstack</B>:  It extracts
+individual planes from a single PAM.
+
+<P>Use <a href="pamtopnm.html">pamtopnm</a> to convert a suitable PAM
+image to a more traditional PNM (PBM, PGM, or PPM) image.  (But there's
+no need to do that if you're going to feed it to a modern Netpbm program --
+they all take suitable PAM input directly).
+
+<P>One example of using <B>pamstack</B> is that some Netpbm programs
+accept as input a PAM that represents graphic image with transparency
+information.  Taking a color image for example, this would be a PAM
+with tuple type "RGB_ALPHA".  In Netpbm, such images were
+traditionally represented as two images - a PPM for the color and a
+PGM for the transparency.  To convert a PPM/PGM pair into
+PAM(RGB_ALPHA) input that newer programs require, do something like
+this:
+
+<pre>
+<kbd>
+$ pamstack -tupletype=RGB_ALPHA myimage.ppm myalpha.pgm | \
+      pamtouil &gt;myimage.uil
+</kbd>
+</pre>
+
+<H2 id="options">OPTIONS</H2>
+
+<DL COMPACT>
+
+<DT><B>-tupletype </B><I>tupletype</I>
+<DD>
+This specifies the tuple type name to be recorded in the output.  You may
+use any string up to 255 characters.  Some programs recognize some names.
+If you omit this option, the default tuple type name is null.
+</DL>
+
+<H2 id="seealso">SEE ALSO</H2>
+
+<B><A HREF="pam.html">pam</A></B>
+<B><A HREF="pamchannel.html">pamchannel</A></B>
+
+<h2 id="history">HISTORY</h2>
+
+<p><b>pamstack</b> was new in Netpbm 10.0 (June 2002).
+
+<HR>
+<A NAME="index">&nbsp;</A>
+<H2>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>
+</UL>
+</BODY>
+</HTML>