summaryrefslogtreecommitdiffstats
path: root/upstream/fedora-rawhide/man1/pambrighten.1
blob: 5b57e535232171ea35fba9ae5086ea6379006663 (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
\
.\" 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 "Pambrighten User Manual" 0 "18 August 2020" "netpbm documentation"

.SH NAME
pambrighten - change a PPM image's Saturation and Value

.UN synopsis
.SH SYNOPSIS

\fBpambrighten\fP
[\fB-saturation=\fP[\fB+\fP|\fB-\fP]\fIsaturation_percent\fP]
[\fB-value=\fP[\fB+\fP|\fB-\fP]\fIvalue_percent\fP]
[\fInetpbmfile\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
\fBpambrighten\fP increases or decreases the Saturation and Value
(from the HSV color space) of each pixel of a Netpbm image.  You specify
the percentage change for each of those parameters.
.PP
You can also remap the colors of the pixels so their Values cover the full
range of possible Values.
.PP
The input image is from the file named \fInetpbmfile\fP, or Standard
Input if \fInetpbmfile\fP is not specified.
  
.PP
The output format is the same as the input format and any extra channels,
such as transparency, are passed through.
  
.PP
Hue-Saturation-Value, or HSV, is one way to represent a color, like the
more well-known RGB.  Hue, Saturation, and Value are numbers in the range from
0 to 1.  We always capitalize them in this document when we mean the number
from the HSV color space, especially since "value" as a conventional English
word has a much more abstract meaning.
.PP
Value is a measure of how bright the color is, relative to some specified
maximum (the Netpbm formats are also defined in terms of a specified maximum
brightness -- For the purposes of this program, they are the same).  In
particular, it is the brightness of the brightest primary color component of
the color divided by the maximum brightness possible for a component.  Zero
Value means black.  White has full Value.
.PP
Hue is an indication of the secondary color with the same brightness that
most closely approximates the color.  A secondary color is made of a
combination of at most two of the primary colors.
.PP
Saturation is a measure of how close the color is to the color indicated by
the Hue and Value.  A lower number means more light of the third primary color
must be added to get the exact color.  Full Saturation means the color is a
secondary color.  Zero Saturation means the color is gray (or black or white).
Decreasing the saturation of a color tends to make it washed out.
.PP
If it is impossible to increase the Value of a pixel by the amount you
specify (e.g. the Value is .5 and you specify +200%), \fBpambrighten\fP
increases it to full Value instead.
.PP
If it is impossible to increase the Saturation of a pixel by the amount
you specify (e.g. it is already half saturated and you specify +200%),
\fBpambrighten\fP increases it to full Saturation instead.
.PP
For a simpler kind of brightening, you can use \fBpamfunc -multiplier\fP
simply to increase the brightness of each pixel by a specified percentage,
clipping each RGB component where the calculated brightness would exceed full
brightness.  Thus, the brightest colors in the image would change chromaticity
in addition to not getting the specified brightness boost.  For
\fIdecreasing\fP brightness, \fBpamfunc\fP should do the same thing as
\fBpambrighten\fP.
.PP
\fBppmflash\fP does another kind of brightening.  It changes the color of
each pixel to bring it a specified percentage closer to white.  This increases
the value and saturation.
.PP
\fBpambrighten\fP is meant to replace \fBppmbrighten\fP.  It is the same
as \fBppmbrighten\fP, except that it recognizes the various Netpbm image
formats rather than treating them all as PPM.  The output format is the same
as the input format and extra channels in a PAM image (such as a
transparency channel) get passed through.
.PP
If you want to modify the hues in the image, use \fBpamhue\fP.

  
.UN examples
.SH EXAMPLES
.PP
To double the Value of each pixel:
.nf
pambrighten -value=100

.fi
.PP
To double the Saturation and halve the Value of each pixel:
.nf
pambrighten -saturation=+100 -value=-50

.fi

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


.TP
\fB-value=\fP\fIvalue_percent\fP
This option specifies the amount, as a percentage, by which you want to
increase the Value of each pixel.  It may be negative.
.sp
The default is zero.
  
.TP
\fB-saturation=\fP\fIvalue_percent\fP
This option specifies the amount, as a percentage, by which you want to
increase the Saturation of each pixel.  It may be negative.
.sp
The default is zero.

  

.UN seealso
.SH SEE ALSO
.BR "pnmnorm" (1)\c
\&, 
.BR "ppmdim" (1)\c
\&, 
.BR "pamfunc" (1)\c
\&, 
.BR "ppmflash" (1)\c
\&, 
.BR "pamaltsat" (1)\c
\&, 
.BR "pamdepth" (1)\c
\&, 
.BR "pnmgamma" (1)\c
\&, 
.BR "pamhue" (1)\c
\&, 
.BR "ppmhist" (1)\c
\&, 
.BR "ppm" (1)\c
\&

.UN history
.SH HISTORY
.PP
\fBpambrighten\fP was new in Netphm 10.86 (March 2019).  It was a PAM
conversion of the much older \fBppmbrighten\fP.
  

.UN author
.SH AUTHOR
.PP
Copyright (C) 1990 by Brian Moffet.
Copyright (C) 1989 by Jef Poskanzer.
.PP
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted, provided
that the above copyright notice appear in all copies and that both that
copyright notice and this permission notice appear in supporting
documentation.  This software is provided "as is" without express or
implied warranty.
.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/pambrighten.html
.PP