annotate man/man1/edwave.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 EDWAVE 1 "1 September 1993"
tomwalters@0 2
tomwalters@0 3 .SH NAME
tomwalters@0 4 edwave \- Edit a given range of a wave.
tomwalters@0 5
tomwalters@0 6 .SH SYNTAX
tomwalters@0 7 edwave [options] [filename]
tomwalters@0 8
tomwalters@0 9 .SH DESCRIPTION
tomwalters@0 10 Editing operations extract or delete a given time range of a given wave,
tomwalters@0 11 and the results are written on the stdout.
tomwalters@0 12
tomwalters@0 13 .SH OPTIONS
tomwalters@0 14
tomwalters@0 15 1. range.
tomwalters@0 16
tomwalters@0 17 The range option specifies the stretch of the wave for the editing operation
tomwalters@0 18 by:
tomwalters@0 19
tomwalters@0 20 .nf
tomwalters@0 21 range=a[-b]
tomwalters@0 22 .fi
tomwalters@0 23
tomwalters@0 24 The upper limit `b' is optional, and when it is missing then the range
tomwalters@0 25 is a single sample of the given type, otherwise `a' and `b' are inclusive range limits.
tomwalters@0 26 The strings "min" and "max" are recognised as extreme limits
tomwalters@0 27 ("min" = start of file, "max" = end of file),
tomwalters@0 28 otherwise the values of `a' and `b' are sample numbers: 0,1,2,...
tomwalters@0 29 Values given with time units (ms or s) are converted to samples using
tomwalters@0 30 the given samplerate option.
tomwalters@0 31
tomwalters@0 32 2. operation.
tomwalters@0 33
tomwalters@0 34 The `operation' option sets the edit operation to either:
tomwalters@0 35
tomwalters@0 36 .nf
tomwalters@0 37 operation=extract
tomwalters@0 38 or
tomwalters@0 39 operation=delete
tomwalters@0 40 .fi
tomwalters@0 41
tomwalters@0 42 The extract operation outputs the part of the input which is inclusively
tomwalters@0 43 within the given range.
tomwalters@0 44 The delete operation outputs the part of the input which is NOT inclusively
tomwalters@0 45 within the given range.
tomwalters@0 46
tomwalters@0 47 3. type.
tomwalters@0 48
tomwalters@0 49 The datatype of input and output. Known types are in the list:
tomwalters@0 50 char, short, int, float, double, ascii. The ascii type is interpreted as one
tomwalters@0 51 sample per line.
tomwalters@0 52
tomwalters@0 53 4. size.
tomwalters@0 54
tomwalters@0 55 Print the size of the wave on the stdout in given units.
tomwalters@0 56 Units are seconds ("size=s"), milliseconds ("size=ms"), or samples ("size=on").
tomwalters@0 57 Sizes in time units are calculated using the given `samplerate' option.
tomwalters@0 58
tomwalters@0 59 .SH "SEE ALSO"
tomwalters@0 60 options bufwave
tomwalters@0 61
tomwalters@0 62 .SH COPYRIGHT
tomwalters@0 63 .LP
tomwalters@0 64 Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
tomwalters@0 65 .LP
tomwalters@0 66 Permission to use, copy, modify, and distribute this software without fee
tomwalters@0 67 is hereby granted for research purposes, provided that this copyright
tomwalters@0 68 notice appears in all copies and in all supporting documentation, and that
tomwalters@0 69 the software is not redistributed for any fee (except for a nominal
tomwalters@0 70 shipping charge). Anyone wanting to incorporate all or part of this
tomwalters@0 71 software in a commercial product must obtain a license from the Medical
tomwalters@0 72 Research Council.
tomwalters@0 73 .LP
tomwalters@0 74 The MRC makes no representations about the suitability of this
tomwalters@0 75 software for any purpose. It is provided "as is" without express or
tomwalters@0 76 implied warranty.
tomwalters@0 77 .LP
tomwalters@0 78 THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
tomwalters@0 79 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
tomwalters@0 80 THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES
tomwalters@0 81 OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
tomwalters@0 82 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
tomwalters@0 83 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
tomwalters@0 84 SOFTWARE.
tomwalters@0 85