about summary refs log tree commit diff
path: root/pamsummcol.html
blob: b20e226b0b977536ef6d5f72c56f358e5685fc10 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML><HEAD><TITLE>Pamsummcol User Manual</TITLE></HEAD>
<BODY>
<H1>pamsummcol</H1>
Updated: 25 January 2009
<BR>

<A HREF="#index">Table Of Contents</A>

<H2>NAME</H2>
pamsummcol - summarize (sum, average, etc) a Netpbm image by column

<H2 id="synopsis">SYNOPSIS</H2>
<B>pamsummcol</B>
{
<b>-sum</b> |
<b>-mean</b> |
<b>-min</b> |
<b>-max</b>
}
[<I>imagefile</I>]

<P>All options can be abbreviated to their shortest unique prefix.
You may use two hyphens instead of one.  You may separate an option
name and its value with white space instead of an equals sign.

<H2 id="description">DESCRIPTION</H2>

<p>This program is part of <a href="index.html">Netpbm</a>.

<p><b>pamsummcol</b> reads a Netpbm image (PNM or PAM) and performs a
summary function over all the rows in each column (sum, mean, etc.).
It produces an image of the same kind that the same width and depth as
the input, and one row high.  Its sample values are the result of the
summary.

<p><b>pamsummcol</b> performs the summary operation on each plane
independently.

<p><b>pamsummcol</b> performs the operation on the actual sample values,
not on the light intensities represented by them in the case that the
image is a PGM or PPM image.

<p>If you want to summarize by row instead of by column, run the input
through <b>pamflip</b> first (and if you want the output to be a single
column instead of a single row, use <b>pamflip</b> again).

<p>If you want to summarize over the entire image (getting a one-tuple
output image), use <b>pamsumm</b> to get a summary row, <b>pamflip</b>
to turn that into a column, the <b>pamsumm</b> again to summarize the
column.

<p>If you want to summarize the individual samples in an entire image,
instead of by tuple, use <b>pamsumm</b>.

<p><b>pamsummcol</b> performs the operation on the actual sample values,
not on the light intensities represented by them in the case that the
image is a PGM or PPM image or PAM equivalent.  You can use
<b>pnmgamma</b> to convert such an image to one with samples proportional
to light intensity, and then use <b>pamsummcol</b> on the result.

<p>You can achieve the same thing as <b>pamsummcol -mean</b> with
<b>pamscale</b>.  Just scale vertically to a single row, without scaling
horizontally at all.  Use the pixel mixing method.


<H2 id="options">OPTIONS</H2>

<p>You must specify exactly one of <b>-sum</b>, <b>-mean</b>,
<b>-min</b>, or <b>-max</b>.

<DL COMPACT>
<DT><B>-sum</b>

<DD>
     <P>This option makes the summary function addition.
     In each column and plane of the output row, the sample value is the
     sum of all the samples values in the same column and plane of the input.
     If a result is greater than the image maxval, it is clipped to
     the maxval.

<DT><B>-mean</b>

<DD>
     <P>This option makes the summary function arithmetic mean.
     In each column and plane of the output row, the sample value is the
     mean of all the samples values in the same column and plane of the input.

<DT><B>-min</b>

<DD>
     <P>This option makes the summary function arithmetic minimum.
     In each column and plane of the output row, the sample value is the
     minimum of all the samples values in the same column and plane of
     the input.

<DT><B>-max</b>

<DD>
     <P>This option makes the summary function arithmetic maximum.
     In each column and plane of the output row, the sample value is
     the maximum of all the samples values in the same column and
     plane of the input.

</DL>

<H2 id="seealso">SEE ALSO</H2>

<B><A HREF="pamsumm.html">pamsumm</A></B>,
<B><A HREF="pamflip.html">pamscale</A></B>,
<B><A HREF="pamfunc.html">pamfunc</A></B>,
<B><A HREF="pamarith.html">pamarith</A></B>,
<B><A HREF="pamscale.html">pamscale</A></B>,
<B><A HREF="pam.html">pam</A></B>,

<h2 id="history">HISTORY</h2>

<p><b>pamsummcol</b> was added to Netpbm in Release 10.21 (March
2004).


<HR>
<H2 id="index">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="#options">OPTIONS</A>
<LI><A HREF="#lbAE">SEE ALSO</A>
<LI><A HREF=#history>HISTORY</A>
</UL>
</BODY>
</HTML>