summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man1/pamaddnoise.1
blob: 32d10fb23411fd56ffbb3272e07f8ae9198f1a5b (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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
\
.\" 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 "Pamaddnoise User Manual" 0 "21 August 2023" "netpbm documentation"

.SH NAME

pamaddnoise - add noise to a Netpbm image

.UN synopsis
.SH SYNOPSIS

\fBpamaddnoise\fP
{
[\fB-type\fP \fBgaussian\fP]

[\fB-sigma1\fP \fIvalue\fP]

[\fB-sigma2\fP \fIvalue\fP]
|
\fB-type \fP \fBmultiplicative_gaussian\fP

[\fB-mgsigma\fP \fIvalue\fP]
|
\fB-type\fP \fBimpulse\fP

[\fB-tolerance\fP \fIratio\fP]
|
\fB-type \fP \fBlaplacian\fP

[\fB-lsigma\fP \fIvalue\fP]
|
\fB-type \fP \fBpoisson\fP

[\fB-lambda\fP \fIvalue\fP]
}
[\fB-seed\fP \fIint\fP]

[\fInetpbmfile\fP]

.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBpamaddnoise\fP adds the specified noise type to a Netpbm image.
\fBpamaddnoise\fP treats a PPM image as 3 independent planes, not as
a plane of colors in a color space.

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


.TP
\fB-type\fP \fInoise_type\fP
Select type of noise by name.  The following noise types are
available: gaussian, multiplicative_gaussian, impulse, laplacian,
poisson.  Only enough letters to be unique are required for the noise
type option.  The default noise type is \fBgaussian\fP.


.TP
\fBgaussian\fP
  
To each sample value is added the value of a two Gaussian random variables.
    The variance of one is independent of the sample value, while the variance
    of the other is proportional to the sample value.  You control these
    variances with options \fB-sigma1\fP and \fB-sigma2\fP (and can eliminate
    either by setting the variance to 0).  The mean of the Gaussian
    distributions is 0.

.TP
\fBmultiplicative_gaussian\fP
.TP
\fBimpulse\fP
  
This is 'salt and pepper' noise.  Samples are changed randomly
    to zero or full brightness or left alone.  This is also know as salt and
    pepper noise, as in a grayscale picture, it adds white pixels and black
    pixels, which look like salt and pepper, respectively.  Control this with
    options \fB-tolerance\fP and \fB-salt\fP.

.TP
\fBlaplacian\fP

.TP
\fBpoisson\fP


.TP
\fB-lambda\fP \fIvalue\fP
This is valid only with \fB-type=poisson\fP.  It is the expected value
of the Poisson distribution for a sample value of maximum intensity.  The
expected value for other intensities is proportional; e.g. for half intensity,
it is half this value.
.sp
The default value is 12.

.TP
\fB-lsigma\fP \fIvalue\fP
This is meaningful only for laplacian noise.
.sp
The default value is 10.0.

.TP
\fB-mgsigma\fP \fIvalue\fP
This is valid only for multiplicative gaussian noise.
.sp
The default value is 0.5.

.TP
\fB-seed\fP \fIint\fP
This is the random number generator seed value.  Use this to get
  repeatable results.

.TP
\fB-sigma1\fP \fIvalue\fP
This is valid only for gaussian noise.  It is the standard deviation
  of the Gaussian random variable that is multiplied by the square root of
  each sample value and added to that sample value.
.sp
    The default value is 4.0.

.TP
\fB-sigma2\fP \fIvalue\fP
This is valid only for gaussian noise.
  It is the standard deviation of the Gaussian random variable that is
  added directly to each sample value.
.sp
The default value is 20.0.

.TP
\fB-tolerance\fP \fIfraction\fP
This is valid only for impulse noise.
  \fIfraction\fP is the fraction of samples that are changed
  in the output.  Whether each is changed to salt or pepper is controlled by
  \fB-salt\fP.
.sp
The default value is 0.10.

.TP
\fB-salt=\fIfraction\fP\fP
  
This is valid only for impulse noise.  \fIfraction\fP is the
    fraction of the pixels that are changed that are changed to salt (maxval);
    the rest are changed to pepper (0).
.sp
The default is 0.5 (half salt, half pepper).
.sp
This option was new in Netpbm 11.04 (September 2023).  Before that, the
  noise is always half salt and half pepper.



.UN references
.SH REFERENCES


.IP \(bu
"Adaptive Image Restoration in Signal-Dependent Noise"
by R. Kasturi Institute for Electronic Science, Texas Tech University,
1982

.IP \(bu
"Digital Image Processing Algorithms" by Ioannis Pitas,
Prentice Hall, 1993 ISBN 0-13-145814-0



.UN seealso
.SH SEE ALSO
.BR "pgmnoise" (1)\c
\&,
.BR "pgmmedian" (1)\c
\&,
.BR "pnm" (5)\c
\&,
.BR "pam" (5)\c
\&,

.UN history
.SH HISTORY
.PP
\fBpamaddnoise\fP was added to Netpbm in Version 10.29 (August 2005).
It had been distributed by Mike Burns via his own web site before that
(and continued to be so).
.PP
Burns' version, and the one in Netpbm 10.29, was called \fBpnmaddnoise\fP
and worked only on PNM images.  In Netpbm 10.30, it was converted to handle
PAM images and renamed to \fBpamaddnoise\fP.

.UN author
.SH AUTHOR

Copyright (C) 1995 by Mike Burns <\fIburns@cac.psu.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/pamaddnoise.html
.PP