summaryrefslogtreecommitdiffstats
path: root/upstream/debian-bookworm/man1/pamsumm.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-bookworm/man1/pamsumm.1')
-rw-r--r--upstream/debian-bookworm/man1/pamsumm.1146
1 files changed, 146 insertions, 0 deletions
diff --git a/upstream/debian-bookworm/man1/pamsumm.1 b/upstream/debian-bookworm/man1/pamsumm.1
new file mode 100644
index 00000000..b54d729e
--- /dev/null
+++ b/upstream/debian-bookworm/man1/pamsumm.1
@@ -0,0 +1,146 @@
+\
+.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
+.\" Do not hand-hack it! If you have bug fixes or improvements, please find
+.\" the corresponding HTML page on the Netpbm website, generate a patch
+.\" against that, and send it to the Netpbm maintainer.
+.TH "Pamsumm User Manual" 1 "26 October 2012" "netpbm documentation"
+
+.SH NAME
+pamsumm - Summarize the samples in a Netpbm image arithmetically
+
+.UN synopsis
+.SH SYNOPSIS
+\fBpamsumm\fP
+{
+\fB-sum\fP |
+\fB-mean\fP |
+\fB-min\fP |
+\fB-max\fP
+}
+[\fB-normalize\fP]
+[\fB-brief\fP]
+[\fIimagefile\fP]
+.PP
+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.
+
+.UN description
+.SH DESCRIPTION
+.PP
+This program is part of
+.BR "Netpbm" (1)\c
+\&.
+.PP
+\fBpamsumm\fP reads a Netpbm image (PNM or PAM) and performs a
+summary function over all the samples in all the rows, columns, and planes
+and prints the result to Standard Output.
+.PP
+\fBpamsumm\fP performs the operation on the actual sample values. In the
+case of a PGM or PPM or PAM equivalent (i.e. a visual image), this is not the
+same as the light intensities represented by those samples. See the format
+specifications of
+.BR "PGM" (1)\c
+\&,
+.BR "PPM" (1)\c
+\&, and
+.BR "PAM" (1)\c
+\&, for the precise
+meanings of samples in these formats. If you want to do arithmetic on light
+intensities of such a visual image, you can use \fBpnmgamma\fP to convert it
+to one with samples proportional to light intensity, and then
+use \fBpamsumm\fP on the result.
+.PP
+If you want to summarize by column (e.g. add up the columns
+separately), use \fBpamsummcol\fP. If you want to summarize by row,
+use a combination of \fBpamsummcol\fP and \fBpamflip\fP. If you
+want to summarize a particular plane, use \fBpamchannel\fP to
+extract it and then \fBpamsumm\fP.
+
+
+.UN options
+.SH OPTIONS
+.PP
+In addition to the options common to all programs based on libnetpbm
+(most notably \fB-quiet\fP, see
+.UR index.html#commonoptions
+ Common Options
+.UE
+\&), \fBpamsumm\fP recognizes the following
+command line options:
+.PP
+You must specify exactly one of \fB-sum\fP, \fB-mean\fP,
+\fB-min\fP, or \fB-max\fP.
+
+
+.TP
+\fB-sum\fP
+.sp
+This option makes the summary function addition.
+
+.TP
+\fB-mean\fP
+.sp
+This option makes the summary function arithmetic mean.
+
+.TP
+\fB-min\fP
+.sp
+This option makes the summary function arithmetic minimum.
+
+.TP
+\fB-max\fP
+.sp
+This option makes the summary function arithmetic maximum.
+
+.TP
+\fB-normalize\fP
+.sp
+This option causes each sample to be normalized to a fraction
+ (in the range 0..1) so the result is independent of the image's
+ maxval. E.g. if you request the mean of an image which has maxval
+ 200 and all the samples have value 50, \fBpamsumm\fP will give you
+ 50 as an answer. But \fBpamsumm -normalize\fP will give you .25.
+.sp
+If instead you want a result that is independent of maxval but still
+ in integers, you can use \fBpamdepth\fP to convert the input to some
+ standard maxval and not use \fB-normalize\fP. For example, if you want
+ the mean brightness of a PPM image, on a scale of 0 to 99, do
+
+.nf
+\f(CW
+ pamdepth 99 myimage.ppm | pamsumm -mean
+\fP
+
+.fi
+.sp
+This option was new in Netpbm 10.22 (April 2004)
+
+.TP
+\fB-brief\fP
+.sp
+This option causes \fBpamsumm\fP to display the answer as a bare
+ number, rather than in a complete sentence.
+.sp
+This option was new in Netpbm 10.22 (April 2004)
+
+
+
+.UN seealso
+.SH SEE ALSO
+.BR "pamsummcol" (1)\c
+\&,
+.BR "pam" (1)\c
+\&,
+
+.UN history
+.SH HISTORY
+.PP
+\fBpamsumm\fP was added to Netpbm in Release 10.21 (March
+2004).
+.SH DOCUMENT SOURCE
+This manual page was generated by the Netpbm tool 'makeman' from HTML
+source. The master documentation is at
+.IP
+.B http://netpbm.sourceforge.net/doc/pamsumm.html
+.PP \ No newline at end of file