Debian Codegraph @

upstream/debian-unstable/man1/pamshadedrelief.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 "Pamshadedrelief User Manual" 1 "26 July 2014" "netpbm documentation"
7
8 .SH NAME
9
10 pamshadedrelief - generate shaded relief image from an elevation map
11
12 .UN synopsis
13 .SH SYNOPSIS
14
15 \fBpamshadedrelief\fP
16
17 [\fB-gamma\fP \fIg\fP]
18
19
20 .UN description
21 .SH DESCRIPTION
22 .PP
23 This program is part of
24 .BR "Netpbm" (1)\c
25 \&.
26 .PP
27 \fBpamshadedrelief\fP creates a shaded relief image from an elevation map.
28 A shaded relief image is a visual image of terrain, showing the terrain as if
29 illuminated by oblique light and viewed from above, so that the brightess of
30 each spot depends upon its slope. A common example of a shaded relief image
31 is a relief map of the Earth, which shows mountains and valleys.
32 .PP
33 The image \fBpamshadedrelief\fP creates is as if illumated by a light
34 source from the left.
35 .PP
36 The output image is a PAM with tuple type \fBGRAYSCALE\fP.
37 .PP
38 The program \fBpamcrater\fP is a good thing to use to demonstrate the
39 function of \fBpamshadedrelief\fP. It generates a terrain map of a cratered
40 landscape.
41
42 .nf
43 \f(CW
44 $ pamcrater | pamshadedrelief | pamx
45 \fP
46
47 .fi
48
49
50 .UN options
51 .SH OPTIONS
52 .PP
53 In addition to the options common to all programs based on libnetpbm
54 (most notably \fB-quiet\fP, see
55 .UR index.html#commonoptions
56 Common Options
57 .UE
58 \&), \fBpamshadedrelief\fP recognizes the following
59 command line option:
60
61
62 .TP
63 \fB-gamma\fP \fIfactor\fP
64 .TP
65 \fB-g\fP \fIfactor\fP
66 The specified \fIfactor\fP is used to gamma adjust the image in
67 the same manner as performed by \fBpnmgamma\fP. The default value is
68 1.0, which results in a medium contrast image. Values larger than 1
69 lighten the image and reduce contrast, while values less than 1 darken
70 the image, increasing contrast.
71 .sp
72 Note that this is separate from the gamma correction that is part of the
73 definition of the PAM GRAYSCALE format. The image \fBpamshadedrelief\fP
74 generates is a genuine, gamma-corrected PAM GRAYSCALE image in any case. This
75 option simply changes the contrast and may compensate for a display device
76 that does not correctly render PAM GRAYSCALE images.
77
78
79
80 .UN designnotes
81 .SH DESIGN NOTES
82
83 The\fB-gamma\fP option isn't really necessary since you can achieve
84 the same effect by piping the output from \fBpamshadedrelief\fP through
85 \fBpnmgamma\fP. However, \fBpamshadedrelief\fP performs an internal gamma
86 map anyway in the process of rendering the elevation array into the PAM
87 GRAYSCALE format, so there's no additional overhead in allowing an additional
88 gamma adjustment.
89
90
91 .UN seealso
92 .SH SEE ALSO
93 .BR "ppmrelief" (1)\c
94 \&
95 .BR "pnmgamma" (1)\c
96 \&,
97 .BR "pnmsmooth" (1)\c
98 \&
99 .BR "pamcrater" (1)\c
100 \&
101 .BR "pam" (1)\c
102 \&,
103
104
105 .UN author
106 .SH AUTHOR
107 .PP
108 \fBpgmcrater\fP, from which this is derived, was written by John Walker:
109
110 .nf
111 John Walker
112 Autodesk SA
113 Avenue des Champs-Montants 14b
114 CH-2074 MARIN
115 Suisse/Schweiz/Svizzera/Svizra/Switzerland
116 \fBUsenet:\fP\[email protected]\fP
117 \fBFax:\fP038/33 88 15
118 \fBVoice:\fP038/33 76 33
119
120 .fi
121 .PP
122 Permission to use, copy, modify, and distribute this software and
123 its documentation for any purpose and without fee is hereby granted,
124 without any conditions or restrictions. This software is provided
125 "as is" without express or implied warranty.
126
127
128 .UN history
129 .SH HISTORY
130 .PP
131 \fBpgmcrater\fP was split into \fBpamshadedrelief\fP and \fBpamcrater\fP
132 in Netpbm 10.68 (September 2014). See the history section of the
133 \fBpamcrater\fP manual for details.
134 .SH DOCUMENT SOURCE
135 This manual page was generated by the Netpbm tool 'makeman' from HTML
136 source. The master documentation is at
137 .IP
138 .B http://netpbm.sourceforge.net/doc/pamshadedrelief.html
139 .PP