annotate man/man1/ptrain.1 @ 0:5242703e91d3 tip

Initial checkin for AIM92 aimR8.2 (last updated May 1997).
author tomwalters
date Fri, 20 May 2011 15:19:45 +0100
parents
children
rev   line source
tomwalters@0 1 .TH PTRAIN 1 "14 September 1993"
tomwalters@0 2
tomwalters@0 3 .SH NAME
tomwalters@0 4 ptrain \- generate a pulse train of binary shorts.
tomwalters@0 5
tomwalters@0 6 .SH SYNTAX
tomwalters@0 7 ptrain [arguments] [file]
tomwalters@0 8
tomwalters@0 9
tomwalters@0 10 .SH DESCRIPTION
tomwalters@0 11 Generate periods of a pulse train in binary 2-byte numbers to the given
tomwalters@0 12 waveform duration.
tomwalters@0 13 A period in samples is computed (using the "period" option in samples or in
tomwalters@0 14 time units, in which case the period also depends upon the given samplerate),
tomwalters@0 15 and "width" samples at the start of every period are output with the given
tomwalters@0 16 "amplitude", the remaining samples in the period having zero amplitude.
tomwalters@0 17 The pulse amplitude is the pulse height above the zero level, which is
tomwalters@0 18 set by the offset option. The offset is "0" by default so that pulses
tomwalters@0 19 of any given amplitude are non-negative by default.
tomwalters@0 20
tomwalters@0 21 The default output is 12 periods of an 8ms pulse train at 20KHz (ie with 160
tomwalters@0 22 samples per period), with pulse width 4 samples and pulse amplitude 1024.
tomwalters@0 23
tomwalters@0 24 If a filename argument is given, then the period of the output pulse train
tomwalters@0 25 is taken from the file. Binary shorts read from the file are successive
tomwalters@0 26 periods in samples, and periods are output until the file is empty.
tomwalters@0 27 This enables pulse trains with modulated periods.
tomwalters@0 28
tomwalters@0 29 .SH EXAMPLES
tomwalters@0 30
tomwalters@0 31
tomwalters@0 32 1. A pulse train with period 100 samples and pulse width 1 sample:
tomwalters@0 33
tomwalters@0 34 ptrain period=100p width=1p
tomwalters@0 35
tomwalters@0 36 2. A pulse train with period 8ms at 20KHz and pulse width 4 samples
tomwalters@0 37
tomwalters@0 38 ptrain period=8ms samplerate=20000Hz width=4p
tomwalters@0 39
tomwalters@0 40 .SH COPYRIGHT
tomwalters@0 41 .LP
tomwalters@0 42 Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
tomwalters@0 43 .LP
tomwalters@0 44 Permission to use, copy, modify, and distribute this software without fee
tomwalters@0 45 is hereby granted for research purposes, provided that this copyright
tomwalters@0 46 notice appears in all copies and in all supporting documentation, and that
tomwalters@0 47 the software is not redistributed for any fee (except for a nominal
tomwalters@0 48 shipping charge). Anyone wanting to incorporate all or part of this
tomwalters@0 49 software in a commercial product must obtain a license from the Medical
tomwalters@0 50 Research Council.
tomwalters@0 51 .LP
tomwalters@0 52 The MRC makes no representations about the suitability of this
tomwalters@0 53 software for any purpose. It is provided "as is" without express or
tomwalters@0 54 implied warranty.
tomwalters@0 55 .LP
tomwalters@0 56 THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
tomwalters@0 57 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
tomwalters@0 58 THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES
tomwalters@0 59 OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
tomwalters@0 60 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
tomwalters@0 61 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
tomwalters@0 62 SOFTWARE.
tomwalters@0 63