.TL
Pamcomp User Manual
.SH 1
pamcomp
.LP
Updated: 17 July 2004
.br
Table Of Contents
.SH 2
NAME
.LP
pamcomp - composite (overlay) two Netpbm images together
.SH 2
SYNOPSIS
.LP
\fBpamcomp\fR
[\fB-align=\fR{\fBleft\fR|\fBcenter\fR|\fBright\fR|
\fBbeyondleft\fR|\fBbeyondright\fR}]
.br
[\fB-valign=\fR{\fBtop\fR|\fBmiddle\fR|\fBbottom\fR|
\fBabove\fR|\fBbelow\fR}]
.br
[\fB-xoff=\fR\fIX\fR]
[\fB-yoff=\fR\fIY\fR]
.br
[\fB-alpha=\fR\fIalpha-pgmfile\fR]
[\fB-invert\fR]
[\fB-opacity=\fIopacity\fB\fR]
[\fB-linear\fR]
.br
\fIoverlay_file\fR
[\fIunderlying_file\fR [\fIoutput_file\fR]]
.LP
Minimum unique abbreviation of option is acceptable.  You may use double
hyphens instead of single hyphen to denote options.  You may use white
space in place of the equals sign to separate an option name from its value.
.SH 2
DESCRIPTION
.LP
.LP
This program is part of Netpbm.
\fBpamcomp\fR reads two images and produces a composite image with
one of the images overlayed on top of the other, possible
translucently.  The images need not be the same size.  The input and
outputs are Netpbm format image files.
.LP
In its simplest use, \fBpamcomp\fR simply places the image in the
file \fIoverlay_file\fR on top of the image in the file
\fIunderlying_file\fR, blocking out the part of \fIunderlying_file\fR
beneath it.
.LP
If you add the \fB-alpha\fR option, then \fBpamcomp\fR uses the
image in file \fIalpha-pgmfile\fR as an alpha mask, which means it
determines the level of transparency of each point in the overlay
image.  The alpha mask must have the same dimensions as the overlay
image.  In places where the alpha mask defines the overlay image to be
opaque, the composite output contains only the contents of the overlay
image; the underlying image is totally blocked out.  In places where
the alpha mask defines the overlay image to be transparent, the
composite output contains none of the overlay image; the underlying
image shows through completely.  In places where the alpha mask shows
a value in between opaque and transparent (translucence), the
composite image contains a mixture of the overlay image and the
underlying image and the level of translucence determines how much of
each.
.LP
The alpha mask is a PGM file in which a white pixel represents
opaqueness and a black pixel transparency.  Anything in between is
translucent.  (Like any Netpbm program, \fBpamcomp\fR will see a PBM
file as if it is PGM).
.LP
If the overlay image is a PAM image of tuple type RGB_ALPHA or
GRAYSCALE_ALPHA, then the overlay image contains transparency
information itself and \fBpamcomp\fR uses it the same way as the
alpha mask described above.  If you supply both an overlay image that
has transparency information and an alpha mask, \fBpamcomp\fR
multiplies the two opacities to get the opacity of the overlay pixel.
.LP
Before Netpbm 10.25 (October 2004), \fBpamcomp\fR did not
recognize the transparency information in a PAM image -- it just
ignored it.  So people had to make appropriate alpha masks in order to
have a non-opaque overlay.  Some Netpbm programs that convert from
image formats such as PNG that contain transparency information are
not able to create RGB_ALPHA or GRAYSCALE_ALPHA PAM output, so you
have to use the old method -- extract the transparency information from
the original into a separate alpha mask and use that as input to
\fBpamcomp\fR.
.LP
The output image is always of the same dimensions as the underlying
image.  \fBpamcomp\fR uses only parts of the overlay image that fit
within the underlying image.
.LP
To specify where on the underlying image to place the overlay
image, use the \fB-align\fR, \fB-valign\fR, \fB-xoff\fR, and
\fB-yoff\fR options.  Without these options, the default horizontal
position is flush left and the default vertical position is flush top.
.LP
The overlay image, in the position you specify, need not fit entirely
within the underlying image.  \fBpamcomp\fR uses only the parts of the
overlay image that appear above the underlying image.  It is possible to
specify positioning such that none of the overlay image is 
over the underlying image -- i.e. the overlay is out of frame.  If you
do that, \fBpamcomp\fR issues a warning.
.LP
 The overlay and underlying images may be of different formats
(e.g.  overlaying a PBM text image over a full color PPM image) and
have different maxvals.  The output image has the more general of the
two input formats and a maxval that is the least common multiple the
two maxvals (or the maximum maxval allowable by the format, if the LCM
is more than that).
.SH 2
OPTIONS
.LP
.RS
.IP "\fB-align=\fR\fIalignment\fR"
This option selects the basic horizontal position of the overlay image
with respect to the underlying image, in syntax reminiscent of HTML.
\fBleft\fR means flush left, \fBcenter\fR means centered, and \fBright\fR
means flush right.
.LP
The \fB-xoff\fR option modifies this position.
\fBbeyondleft\fR means just out of frame to the left -- the right edge of
the overlay is flush with the left edge of the underlying image.  
\fBbeyondright\fR means just out of frame to the right.  These alignments
are useful only if you add a \fB-xoff\fR option.    These two values were
added in Netpbm 10.10 (October 2002).
.LP
The default is \fBleft\fR.
.IP "\fB-valign=\fR\fIalignment\fR"
This option selects the basic vertical position of the overlay image
with respect to the underlying image, in syntax reminiscent of HTML.
\fBtop\fR means flush top, \fBmiddle\fR means centered, and \fBbottom\fR
means flush bottom.
.LP
The \fB-yoff\fR option modifies this position.
\fBabove\fR means just out of frame to the top -- the bottom edge of
the overlay is flush with the top edge of the underlying image.  
\fBbelow\fR means just out of frame to the bottom.  These alignments
are useful only if you add a \fB-yoff\fR option.  These two values were
added in Netpbm 10.10 (October 2002).
.LP
The default is \fBtop\fR.
.IP "\fB-xoff=\fR\fIx\fR"
This option modifies the horizontal positioning of the overlay
image with respect to the underlying image as selected by the
\fB-align\fR option.  \fBpamcomp\fR shifts the overlay image from
that basic position \fIx\fR pixels to the right.  \fIx\fR can be
negative to indicate shifting to the left.
.LP
The overlay need not fit entirely (or at all) on the underlying image.
\fBpamcomp\fR uses only the parts that lie over the underlying image.
.LP
Before Netpbm 10.10 (October 2002), \fB-xoff\fR was mutually 
exclusive with \fB-align\fR and always measured from the left edge.
.IP "\fB-yoff=\fR\fIy\fR"
This option modifies the vertical positioning of the overlay
image with respect to the underlying image as selected by the
\fB-valign\fR option.  \fBpamcomp\fR shifts the overlay image from
that basic position \fIy\fR pixels downward.  \fIy\fR can be
negative to indicate shifting upward.
.LP
The overlay need not fit entirely (or at all) on the underlying image.
\fBpamcomp\fR uses only the parts that lie over the underlying image.
.LP
Before Netpbm 10.10 (October 2002), \fB-xoff\fR was mutually 
exclusive with \fB-valign\fR and always measured from the top edge.
.IP "\fB-alpha=\fR\fIalpha-pgmfile\fR"
This option names a file that contains the alpha mask.  If you don't
specify this option, there is no alpha mask, which is equivalent to 
having an alpha mask specify total opaqueness everywhere.
.LP
You can specify \fB-\fR as the value of this option and the alpha
mask will come from Standard Input.  If you do this, don't specify
Standard Input as the source of any other input image.
.IP "\fB-invert\fR"
This option inverts the sense of the values in the alpha mask, which 
effectively switches the roles of the overlay image and the underlying
image in places where the two intersect.
.IP "\fB-opacity=\fR\fIopacity\fR"
This option tells how opaque the overlay image is to be, i.e. how much
of the composite image should be from the overlay image, as opposed to
the underlying image.  \fIopacity\fR is a floating point number, with
1.0 meaning the overlay image is totally opaque and 0.0 meaning it is
totally transparent.  The default is 1.0.
.LP
If you specify an alpha mask (the \fB-alpha\fR option),
\fBpamcomp\fR uses the product of the opacity indicated by the alpha
mask (as modified by the \fB-invert\fR option, as a fraction, and
this opacity value.  The \fB-invert\fR option does not apply to this
opacity value.
.LP
As a simple opacity value, the value makes sense only if it is
between 0 and 1, inclusive.  However, \fBpamcomp\fR accepts all
values and performs the same arithmetic computation using whatever
value you provide.  An opacity value less than zero means the underlay
image is intensified and then the overlay image is "subtracted" from
it.  An opacity value greater than unity means the overlay image is
intensified and the underlaying image subtracted from it.  In either
case, \fBpamcomp\fR clips the resulting color component intensities
so they are nonnegative and don't exceed the output image's maxval.
.LP
This may seem like a strange thing to do, but it has uses.  You
can use it to brighten or darken or saturate or desaturate areas of the
underlaying image.  See 
this description of the technique.
.LP
This option was added in Netpbm 10.6 (July 2002).  Before Netpbm 10.15
(April 2003), values less than zero or greater than unity were not allowed.
.IP "\fB-linear\fR"
This option indicates that the inputs are not true Netpbm images
but rather a non-gamma-adjusted variation.  This is relevant only when
you mix pixels, using the \fB-opacity\fR option or an alpha mask
(the \fB-alpha\fR option).
.LP
The alpha mask and \fB-opacity\fR values indicate a fraction of
the light intensity of a pixel.  But the PNM and PNM-equivalent PAM
image formats represent intensities with gamma-adjusted numbers that
are not linearly proportional to intensity.  So \fBpamcomp\fR, by
default, performs a calculation on each sample read from its input and
each sample written to its output to convert between these
gamma-adjusted numbers and internal intensity-proportional numbers.
.LP
Sometimes you are not working with true PNM or PAM images, but
rather a variation in which the sample values are in fact directly
proportional to intensity.  If so, use the \fB-linear\fR option to
tell \fBpamcomp\fR this.  \fBpamcomp\fR then will skip the
conversions.
.LP
The conversion takes time.  And the difference between
intensity-proportional values and gamma-adjusted values may be small
enough that you would barely see a difference in the result if you
just pretended that the gamma-adjusted values were in fact
intensity-proportional.  So just to save time, at the expense of some
image quality, you can specify \fB-linear\fR even when you have true
PPM input and expect true PPM output.
.LP
For the first 13 years of Netpbm's life, until Netpbm 10.20
(January 2004), \fBpamcomp\fR's predecessor \fBpnmcomp\fR always
treated the PPM samples as intensity-proportional even though they
were not, and drew few complaints.  So using \fB-linear\fR as a lie
is a reasonable thing to do if speed is important to you.
.LP
Another technique to consider is to convert your PNM image to the
linear variation with \fBpnmgamma\fR, run \fBpamcomp\fR on it and
other transformations that like linear PNM, and then convert it back
to true PNM with \fBpnmgamma -ungamma\fR.  \fBpnmgamma\fR is often
faster than \fBpamcomp\fR in doing the conversion.
.RE
.SH 2
SEE ALSO
.LP
.LP
\fBppmmix\fR and \fBpnmpaste\fR are simpler, less general
versions of the same tool.
.LP
\fBppmcolormask\fR and \fBpbmmask\fR can help with generating an alpha
mask.
.LP
\fBpnmcomp\fR is an older program that
runs faster, but has less function.
.LP
\fBpnm\fR
.SH 2
HISTORY
.LP
.LP
\fBpamcomp\fR was new in Netpbm 10.21 (March 2004).  Its predecessor,
\fBpnmcomp\fR, was one of the first programs added to Netpbm when the
project went global in 1993.
.SH 2
AUTHOR
.LP
Copyright (C) 1992 by David Koblas (koblas@mips.com).
.br
\l'5i'
.SH 2
Table Of Contents
.LP
.IP \(bu
SYNOPSIS
.IP \(bu
DESCRIPTION
.IP \(bu
OPTIONS
.IP \(bu
SEE ALSO
.IP \(bu
HISTORY
.IP \(bu
AUTHOR
.LP