\
.\" 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 "Pnmhistmap User Manual" 1 "13 July 2009" "netpbm documentation"

.SH NAME
pnmhistmap - draw a histogram for a PGM or PPM file

.UN synopsis
.SH SYNOPSIS

\fBpnmhistmap\fP

[\fB-red\fP] [\fB-green\fP] [\fB-blue\fP]

[\fB-black\fP] [\fB-white\fP]

[\fB-max\fP \fIN\fP]

[\fB-lval\fP] [\fB-rval\fP]

[\fB-height\fP] [\fB-width\fP]

[\fB-dots\fP]

[\fB-verbose\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
\fBpnmhistmap\fP reads a PNM image as input and produces an image
showing a histogram of the color (or gray) values in the input.  A PGM
input results in a PBM output.  A PPM input results in a PPM output
with three overlaid histograms: a red one for the red input, a green
one for the green input, and a blue one for the blue input.
.PP
For example, from the following image produces the following histogram:
.PP
.B image
.IMG -C testimg.png
.B histogram from image
.IMG -C testimg_histbar.png
.PP
If the input is PBM, \fBpnmhistmap\fP produces an error message
and no output image.

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



.TP
\fB-red\fP
.TP
\fB-green\fP
.TP
\fB-blue\fP
Include the indicated color component in the output.  If you
specify none of these, \fBpnmhistmap\fP include all three.
.sp
These options are meaningless if the input is PGM.
.sp
These options were new in Netpbm 10.26 (January 2005).  Before
that, \fBpnmhistmap\fP always included all three color components.

.TP
\fB-dots\fP
Plot the histogram as dots.  By default, \fBpnmhistmap\fP plots
bars.
.sp
Example of dots:.B -dots example
.IMG -C testimg_histdot.png
.sp
This option was new in Netpbm 10.26 (January 2005).  Before that,
\fBpnmhistmap\fP always plotted bars.

.TP
\fB-lval\fP \fIminpixval\fP
.TP
\fB-rval\fP \fImaxpixval\fP
These options specify the range of intensity values to include.
\fBpnmhistmap\fP ignores intensities less than \fIminpixval\fP and
greater than \fImaxpixval\fP.  So the left side of the histogram
corresponds to \fIminpixval\fP and the right side corresponds to
\fImaxpixval\fP.
.sp
By default, \fBpnmhistmap\fP plots the entire possible range: zero
to the maxval.
.sp
These options were new in Netpbm 10.26 (January 2005).  Before that,
\fBpnmhistmap\fP always plotted from zero to the maxval.

.TP
-height
.TP
-width
These options specify the dimensions, in pixels of the histogram image.
.sp
The default height is 200 pixels.
.sp
The default width is one pixel for each plotted intensity value (so it's 
controlled by the maxval of the image and the \fB-lval\fP and \fB-rval\fP
options).  The "count buckets" in the histogram are always
one pixel wide.  If you specify a width less than the number of plotted
intensity values, a bucket represents more than one intensity value.
If you specify a width greater that the number of plotted intensity values,
some buckets represent no color (the count is zero).
.sp
This option was new in Netpbm 10.26 (January 2005).  Before that,
the dimensions were always what the default is today.

.TP
\fB-black \fP
Ignore the count of black pixels when scaling the histogram.

.TP
\fB-white\fP
Ignore the count of white pixels when scaling the histogram.
.sp
The -black and -white options, which can be used separately or
together, are useful for images with a large percentage of pixels
whose value is zero or 255, which can cause the remaining histogram
data to become unreadably small.  Note that, for color inputs, these
options apply to all colors; if, for example, the input has a large
number of bright-red areas, you will probably want to use the -white
option.

.TP
\fB-max N\fP
Force the scaling of the histogram to use N as the largest-count value.
This is useful for inputs with a large percentage of single-color pixels
which are not black or white.

.TP
\fB-verbose\fP
Report the progress of making the histogram, including the largest-count
value used to scale the output.




.UN limitations
.SH LIMITATIONS
.PP
\fBpnmhistmap\fP assumes maxval is always 255.  Images with a
smaller maxval will only use the lower-value side of the histogram.
You can overcome this either by piping the input through
\fBpamdepth\fP or by cutting and scaling the lower-value side of the
histogram.  Neither is a particularly elegant solution to the problem.

.UN seealso
.SH SEE ALSO
.BR "pgmhist" (1)\c
\&,
.BR "ppmhist" (1)\c
\&,
.BR "pgm" (1)\c
\&,
.BR "ppm" (1)\c
\&

.UN author
.SH AUTHOR
.PP
Wilson H. Bent. Jr. (\fIwhb@usc.edu\fP).
.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/pnmhistmap.html
.PP