commit f22da30b8bb873ce826996fc53648094eb52ebaf
parent 56ed14063c8b2c82d5ea0652028f47f76cb710f0
Author: Mattias Andrée <maandree@kth.se>
Date: Mon, 3 Jul 2017 14:39:57 +0200
Document blind-sinc-wave
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat:
2 files changed, 55 insertions(+), 1 deletion(-)
diff --git a/man/blind-sawtooth-wave.1 b/man/blind-sawtooth-wave.1
@@ -21,7 +21,6 @@ are identical.
.BR blind (7),
.BR blind-double-sine-wave (1),
.BR blind-round-wave (1),
-.BR blind-sawtooth-wave (1),
.BR blind-sinc-wave (1),
.BR blind-sine-wave (1),
.BR blind-triangular-wave (1),
diff --git a/man/blind-sinc-wave.1 b/man/blind-sinc-wave.1
@@ -0,0 +1,55 @@
+.TH BLIND-SINC-WAVE 1 blind
+.SH NAME
+blind-sinc-wave - Apply cardinal sine-wave repetition to gradient
+.SH SYNOPSIS
+.B blind-sinc-wave
+[-e]
+.RI [ theta0-stream ]
+.SH DESCRIPTION
+.B blind-sinc-wave
+reads a video from stdin, applies a filter to
+each channel to it, and prints the result to
+stdout. The filter is designed for applying
+repetition to a gradient, and thus assumes the
+range of visible values is [0, 1]. The applied
+filter creates a cardinal sine-wave.
+.P
+If
+.I theta0-stream
+is specified, it must be a video with only
+one pixel per frame. When applying the sine
+function, it is applied to the sum of the
+pixel it is applied to and the pixel in
+the same frame in
+.IR theta0-stream .
+.SH NOTES
+.BR blind-arithm (1)
+with the
+.B mul
+and
+.B div
+operators can be used to stretch the wave.
+.SH OPTIONS
+.TP
+.B -e
+Apply optimisation that assumes all channels
+are identical. If
+.I theta0-stream
+is specified, the values from its second channel
+(the Y channel) are used for all channels.
+.SH SEE ALSO
+.BR blind (7),
+.BR blind-arithm (1),
+.BR blind-double-sine-wave (1),
+.BR blind-round-wave (1),
+.BR blind-sawtooth-wave (1),
+.BR blind-sine-wave (1),
+.BR blind-triangular-wave (1),
+.BR blind-cone-gradient (1),
+.BR blind-linear-gradient (1),
+.BR blind-radial-gradient (1),
+.BR blind-spiral-gradient (1),
+.BR blind-square-gradient (1)
+.SH AUTHORS
+Mattias Andrée
+.RI < maandree@kth.se >