summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/pamtopnm.1
blob: 037addc534bfc937b0fd525bbe70c8d205b66b2d (plain)
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
\
.\" 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 "Pamtopnm User Manual" 1 "02 February 2018" "netpbm documentation"

.SH NAME
pamtopnm - convert PAM image to PBM, PGM, or PPM

.UN synopsis
.SH SYNOPSIS

\fBpamtopnm\fP

[\fB-assume\fP]

[\fIpnmfile\fP]
.PP
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.

.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBpamtopnm\fP reads a PAM image as input and produces an
equivalent PBM, PGM, or PPM (i.e. PNM) image, whichever is most
appropriate, as output.
.PP
\fBpamtopnm\fP assumes the PAM image represents the information
required for a PBM, PGM, or PPM image if its tuple type is
"BLACKANDWHITE", "GRAYSCALE", or "RGB"
and its depth and maxval are appropriate.  If this is not the case,
\fBpamtopnm\fP fails.
.PP
However, you can override the tuple type requirement with the
\fB-assume\fP option.
.PP
\fBpamtopnm\fP produces a PPM image if the input PAM has depth 3 or 4; it
produces PGM or PBM if the input PAM has depth 1 or 2.  Whether it produced
PGM or PBM depends upon the maxval: PBM for 1, PGM for anything higher.  The
tuple type does not play a role in determining the output type.  You can
use Netpbm programs such as \fBpgmtopgm\fP to generate a different PNM
output, but remember that Netpbm program that expects PGM input will take
PBM and so on.
.PP
Note that it's possible for an image which is formally color to in fact
contain only shades of gray and for an image which is formally grayscale to
contain only black and white.  This program pays no attention to that; an RGB
input image produces a PPM output image even if all the pixels are gray.  But
you can use \fBppmtopgm\fP to convert a PPM that you know is grayscale to the
equivalent PGM, and you can use \fBpamthreshold\fP to convert a PGM image you
know is black and white to a black and white PAM image and then
use \fBpamtopnm\fP to convert that to PBM.
  
.PP
As with any Netpbm program that reads PAM images, \fBpamtopnm\fP
also reads PNM images as if they were PAM.  In that case,
\fBpamtopnm\fP's functions reduces to simply copying the input to the
output.  But this can be useful in a program that doesn't know whether
its input is PAM or PNM but needs to feed it to a program that only
recognizes PNM.

.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
\&), \fBpamtopnm\fP recognizes the following
command line option:


.TP
\fB-assume\fP
When you specify \fB-assume\fP, you tell \fBpamtopnm\fP that you
personally vouch for the fact that the tuples contain the same data as
belongs in the channels of a PBM, PGM, or PPM file.  The depth must
still conform, though, so to truly force a conversion, you may have to
run the input through \fBpamchannel\fP first.  But be careful with
\fB-assume\fP.  When you -assume, you make an -ass of u and me.



.UN seealso
.SH SEE ALSO
.BR "pbmtopgm" (1)\c
\&,
.BR "pamditherbw" (1)\c
\&,
.BR "pgmtoppm" (1)\c
\&,
.BR "ppmtopgm" (1)\c
\&,
.BR "pamthreshold" (1)\c
\&,
.BR "pam" (1)\c
\&,
.BR "pnm" (1)\c
\&,
.BR "pbm" (1)\c
\&,
.BR "pgm" (1)\c
\&,
.BR "ppm" (1)\c
\&


.UN history
.SH HISTORY
.PP
\fBpamtopnm\fP was new, along with the PAM format, in Netpbm
9.7 (August 2000).
.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/pamtopnm.html
.PP