Debian Codegraph @

upstream/debian-unstable/man1/pamsummcol.1

raw
1 \
2 .\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
3 .\" Do not hand-hack it! If you have bug fixes or improvements, please find
4 .\" the corresponding HTML page on the Netpbm website, generate a patch
5 .\" against that, and send it to the Netpbm maintainer.
6 .TH "Pamsummcol User Manual" 1 "25 January 2009" "netpbm documentation"
7
8 .SH NAME
9 pamsummcol - summarize (sum, average, etc) a Netpbm image by column
10
11 .UN synopsis
12 .SH SYNOPSIS
13 \fBpamsummcol\fP
14 {
15 \fB-sum\fP |
16 \fB-mean\fP |
17 \fB-min\fP |
18 \fB-max\fP
19 }
20 [\fIimagefile\fP]
21 .PP
22 All options can be abbreviated to their shortest unique prefix.
23 You may use two hyphens instead of one. You may separate an option
24 name and its value with white space instead of an equals sign.
25
26 .UN description
27 .SH DESCRIPTION
28 .PP
29 This program is part of
30 .BR "Netpbm" (1)\c
31 \&.
32 .PP
33 \fBpamsummcol\fP reads a Netpbm image (PNM or PAM) and performs a
34 summary function over all the rows in each column (sum, mean, etc.).
35 It produces an image of the same kind that the same width and depth as
36 the input, and one row high. Its sample values are the result of the
37 summary.
38 .PP
39 \fBpamsummcol\fP performs the summary operation on each plane
40 independently.
41 .PP
42 \fBpamsummcol\fP performs the operation on the actual sample values,
43 not on the light intensities represented by them in the case that the
44 image is a PGM or PPM image.
45 .PP
46 If you want to summarize by row instead of by column, run the input
47 through \fBpamflip\fP first (and if you want the output to be a single
48 column instead of a single row, use \fBpamflip\fP again).
49 .PP
50 If you want to summarize over the entire image (getting a one-tuple
51 output image), use \fBpamsumm\fP to get a summary row, \fBpamflip\fP
52 to turn that into a column, the \fBpamsumm\fP again to summarize the
53 column.
54 .PP
55 If you want to summarize the individual samples in an entire image,
56 instead of by tuple, use \fBpamsumm\fP.
57 .PP
58 \fBpamsummcol\fP performs the operation on the actual sample values,
59 not on the light intensities represented by them in the case that the
60 image is a PGM or PPM image or PAM equivalent. You can use
61 \fBpnmgamma\fP to convert such an image to one with samples proportional
62 to light intensity, and then use \fBpamsummcol\fP on the result.
63 .PP
64 You can achieve the same thing as \fBpamsummcol -mean\fP with
65 \fBpamscale\fP. Just scale vertically to a single row, without scaling
66 horizontally at all. Use the pixel mixing method.
67
68 .UN options
69 .SH OPTIONS
70 .PP
71 In addition to the options common to all programs based on libnetpbm
72 (most notably \fB-quiet\fP, see
73 .UR index.html#commonoptions
74 Common Options
75 .UE
76 \&), \fBpamsummcol\fP recognizes the following
77 command line options:
78 .PP
79 You must specify exactly one of \fB-sum\fP, \fB-mean\fP,
80 \fB-min\fP, or \fB-max\fP.
81
82
83 .TP
84 \fB-sum\fP
85 .sp
86 This option makes the summary function addition.
87 In each column and plane of the output row, the sample value is the
88 sum of all the samples values in the same column and plane of the input.
89 If a result is greater than the image maxval, it is clipped to
90 the maxval.
91
92 .TP
93 \fB-mean\fP
94 .sp
95 This option makes the summary function arithmetic mean.
96 In each column and plane of the output row, the sample value is the
97 mean of all the samples values in the same column and plane of the input.
98
99 .TP
100 \fB-min\fP
101 .sp
102 This option makes the summary function arithmetic minimum.
103 In each column and plane of the output row, the sample value is the
104 minimum of all the samples values in the same column and plane of
105 the input.
106
107 .TP
108 \fB-max\fP
109 .sp
110 This option makes the summary function arithmetic maximum.
111 In each column and plane of the output row, the sample value is
112 the maximum of all the samples values in the same column and
113 plane of the input.
114
115
116
117 .UN seealso
118 .SH SEE ALSO
119 .BR "pamsumm" (1)\c
120 \&,
121 .BR "pamflip" (1)\c
122 \&,
123 .BR "pamfunc" (1)\c
124 \&,
125 .BR "pamarith" (1)\c
126 \&,
127 .BR "pamscale" (1)\c
128 \&,
129 .BR "pam" (1)\c
130 \&,
131
132 .UN history
133 .SH HISTORY
134 .PP
135 \fBpamsummcol\fP was added to Netpbm in Release 10.21 (March
136 2004).
137 .SH DOCUMENT SOURCE
138 This manual page was generated by the Netpbm tool 'makeman' from HTML
139 source. The master documentation is at
140 .IP
141 .B http://netpbm.sourceforge.net/doc/pamsummcol.html
142 .PP