Debian Codegraph @

upstream/debian-unstable/man1/pamfind.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 "Pamfind User Manual" 1 "13 March 2019" "netpbm documentation"
7
8 .SH NAME
9 pamfind - Print the locations of all tuples of a certain value in an image
10
11 .UN synopsis
12 .SH SYNOPSIS
13 \fBpamfind\fP
14 {
15 \fB-target=\fP\fIsample0\fP\fB,\fP\fIsample1\fP\fB,\fP ... |
16 \fB-color=\fP\fIcolor\fP
17 }
18 [\fB-machine\fP]
19 [\fIimagefile\fP]
20 .PP
21 All options can be abbreviated to their shortest unique prefix.
22 You may use two hyphens instead of one. You may separate an option
23 name and its value with white space instead of an equals sign.
24
25 .UN description
26 .SH DESCRIPTION
27 .PP
28 This program is part of
29 .BR "Netpbm" (1)\c
30 \&.
31 .PP
32 \fBpamfind\fP reads a Netpbm image (PNM or PAM) and prints a list of all
33 the locations (row and column) of the tuples that have a value you specify.
34 For example, you can list all the places that a visual image is red.
35 .PP
36 You can specify the value in actual decimal sample values with
37 a \fB-target\fP option or as a color with \fB-color\fP. If you
38 specify \fB-color\fP, the program fails if the input image does not have
39 depth 3. If it has depth 3 but the tuples aren't actually colors, you get
40 results as if they are.
41 .PP
42 To do the opposite, see what tuple is at a given location, use
43 \fBpamcut\fP and \fBpamtable\fP:
44
45 .nf
46
47 $ pamcut -left=5 -top=7 -width=1 -height=1 | pamtable
48
49
50 .fi
51 .PP
52 \fBppmcolormask\fP also finds all the tuples of a certain value, at least
53 in visual images, but instead of printing their coordinates, it generates a
54 mask image, which you can use to visualize where those tuples are or as input
55 to another program.
56
57
58 .UN options
59 .SH OPTIONS
60 .PP
61 In addition to the options common to all programs based on libnetpbm
62 (most notably \fB-quiet\fP, see
63 .UR index.html#commonoptions
64 Common Options
65 .UE
66 \&), \fBpamfind\fP recognizes the following
67 command line options:
68
69
70
71 .TP
72 \fB-target=\fP\fIsample0\fP\fB,\fP\fIsample1\fP\fB,\fP ... |
73 This specifies the tuple value to find. You specify the sample values in
74 order, and must specify the proper number of sample values for the depth of
75 the image (e.g. 3 if it is a color image).
76 .sp
77 You must specify exactly one of \fB-target\fP and \fB-color\fP.
78
79 .TP
80 \fB-color=\fP\fIcolor\fP
81 This is the color to find, assuming the image is a color visual image.
82 .sp
83 \fIcolor\fP is as described for the
84 .UR libnetpbm_image.html#colorname
85 argument of the \fBpnm_parsecolor()\fP library routine
86 .UE
87 \&.
88 .sp
89 You must specify exactly one of \fB-target\fP and \fB-color\fP.
90
91 .TP
92 \fB-machine\fP
93 This makes the output more convenient for a machine to use, while
94 less convenient for a human. \fBpamfind\fP reports the same information
95 as with no options.
96 .sp
97 This option was new in Netpbm 10.87 (March 2020).
98
99
100
101 .UN seealso
102 .SH SEE ALSO
103 .BR "pamdepth" (1)\c
104 \&,
105 .BR "pamgetcolor" (1)\c
106 \&,
107 .BR "ppmhist" (1)\c
108 \&,
109 .BR "ppmcolormask" (1)\c
110 \&,
111 .BR "pamcut" (1)\c
112 \&,
113 .BR "pamtable" (1)\c
114 \&,
115 .BR "pam" (1)\c
116 \&
117
118 .UN history
119 .SH HISTORY
120 .PP
121 \fBpamfind\fP was added to Netpbm in Release 10.86 (March 2019).
122 .SH DOCUMENT SOURCE
123 This manual page was generated by the Netpbm tool 'makeman' from HTML
124 source. The master documentation is at
125 .IP
126 .B http://netpbm.sourceforge.net/doc/pamfind.html
127 .PP