aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-07-03 14:39:57 +0200
committerMattias Andrée <maandree@kth.se>2017-07-03 14:39:57 +0200
commitf22da30b8bb873ce826996fc53648094eb52ebaf (patch)
tree621a33dea8f498b4672bb00bfb96c9b3fb4523d1
parentDocument blind-coordinate-field, blind-*-gradient, and blind-*-wave (sinc still pending), and sinus => sine (diff)
downloadblind-f22da30b8bb873ce826996fc53648094eb52ebaf.tar.gz
blind-f22da30b8bb873ce826996fc53648094eb52ebaf.tar.bz2
blind-f22da30b8bb873ce826996fc53648094eb52ebaf.tar.xz
Document blind-sinc-wave
Signed-off-by: Mattias Andrée <maandree@kth.se>
-rw-r--r--man/blind-sawtooth-wave.11
-rw-r--r--man/blind-sinc-wave.155
2 files changed, 55 insertions, 1 deletions
diff --git a/man/blind-sawtooth-wave.1 b/man/blind-sawtooth-wave.1
index 7d5bc3c..7958b0e 100644
--- 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
new file mode 100644
index 0000000..6aa3489
--- /dev/null
+++ 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 >