diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/specgram.1 | 20 | ||||
| -rw-r--r-- | man/specgram.1.html | 35 | ||||
| -rw-r--r-- | man/specgram.1.pdf | bin | 37118 -> 37617 bytes |
3 files changed, 38 insertions, 17 deletions
diff --git a/man/specgram.1 b/man/specgram.1 index 971af9d..6e60aaa 100644 --- a/man/specgram.1 +++ b/man/specgram.1 @@ -1,4 +1,4 @@ -.TH SPECGRAM 1 "2021-07-15" +.TH SPECGRAM 1 "2021-07-16" .SH NAME specgram \- create spectrograms from raw files or standard input @@ -192,13 +192,19 @@ Default is \fIRATE\fR/2. .TP .BR \-s ", " \-\-scale =\fISCALE\fR -Spectrogram scale. -Valid values are: dBFS. +Spectrogram scale, specified with the following format: \fIunit\fR[,\fIlower\fR[,\fIupper\fR]] -Default is dBFS. +\fIunit\fR is an arbitrary string representing the unit of measurement (e.g. \fBV\fR). +\fIlower\fR is an optional numeric value representing the lower bound of the scale. +\fIupper\fR is an optional numeric value representing the upper bound of the scale. -\fB[dBFS] NOTE:\fR By default, the scale has a -120dB lower bound. -You can adjust it by appending the custom lower bound after the scale string (e.g. \fB\-s dBFS-60\fR for a -60dB lower bound). +Valid values for \fISCALE\fR specify either just the unit, the unit and the lower bound, or all three values. + +After normalization and prescaling (see \fB\-p, \-\-prescale\fR), the following transformations are applied to the input: + \(bu if \fIunit\fR starts with "dB", then a logarithmic decibel scale is assumed: Y=20*log10(X) + \(bu the values are clamped between \fIlower\fR and \fIupper\fR: Y=clamp(X, \fIlower\fR, \fIupper\fR) + +Default is dBFS,-120,0. \fB[dBFS] NOTE:\fR The peak amplitude assumed for dBFS, after normalization and prescaling (see \fB\-p, \-\-prescale\fR), is 1.0. Thus, the correct input domains are: @@ -360,4 +366,4 @@ Program icon by Flavia Fabian, released under the CC-BY-SA 4.0 license. Share Tech Mono font by Carrois Type Design, released under Open Font License. -Special thanks to Eugen Stoianovici for code review and various fixes.
\ No newline at end of file +Special thanks to Eugen Stoianovici for code review and various fixes. diff --git a/man/specgram.1.html b/man/specgram.1.html index 41cce87..6cc0a1c 100644 --- a/man/specgram.1.html +++ b/man/specgram.1.html @@ -1,5 +1,5 @@ <!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Thu Jul 15 19:45:50 2021 --> +<!-- CreationDate: Fri Jul 16 11:40:40 2021 --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> @@ -334,17 +334,32 @@ frequency spectrum, in Hz.</p> <p style="margin-left:11%;"><b>−s</b>, <b>−−scale</b>=<i>SCALE</i></p> -<p style="margin-left:22%;">Spectrogram scale. Valid values -are: dBFS.</p> +<p style="margin-left:22%;">Spectrogram scale, specified +with the following format: +<i>unit</i>[,<i>lower</i>[,<i>upper</i>]]</p> -<p style="margin-left:22%; margin-top: 1em">Default is -dBFS.</p> +<p style="margin-left:22%; margin-top: 1em"><i>unit</i> is +an arbitrary string representing the unit of measurement +(e.g. <b>V</b>). <i>lower</i> is an optional numeric value +representing the lower bound of the scale. <i>upper</i> is +an optional numeric value representing the upper bound of +the scale.</p> -<p style="margin-left:22%; margin-top: 1em"><b>[dBFS] -NOTE:</b> By default, the scale has a -120dB lower bound. -You can adjust it by appending the custom lower bound after -the scale string (e.g. <b>−s dBFS-60</b> for a -60dB -lower bound).</p> +<p style="margin-left:22%; margin-top: 1em">Valid values +for <i>SCALE</i> specify either just the unit, the unit and +the lower bound, or all three values.</p> + +<p style="margin-left:22%; margin-top: 1em">After +normalization and prescaling (see <b>−p, +−−prescale</b>), the following transformations +are applied to the input: <br> +• if <i>unit</i> starts with "dB", then a +logarithmic decibel scale is assumed: Y=20*log10(X) <br> +• the values are clamped between <i>lower</i> and +<i>upper</i>: Y=clamp(X, <i>lower</i>, <i>upper</i>)</p> + +<p style="margin-left:22%; margin-top: 1em">Default is +dBFS,-120,0.</p> <p style="margin-left:22%; margin-top: 1em"><b>[dBFS] NOTE:</b> The peak amplitude assumed for dBFS, after diff --git a/man/specgram.1.pdf b/man/specgram.1.pdf Binary files differindex 4b9db2d..f393414 100644 --- a/man/specgram.1.pdf +++ b/man/specgram.1.pdf |