annotate man/man1/gauss.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 GAUSS 1 "1 September 1993"
tomwalters@0 2
tomwalters@0 3 .SH NAME
tomwalters@0 4 gauss \- generate a Gaussian window.
tomwalters@0 5
tomwalters@0 6 .SH SYNTAX
tomwalters@0 7 gauss [option]
tomwalters@0 8
tomwalters@0 9 .SH DESCRIPTION
tomwalters@0 10 Generate a Gaussian window on the stdout in binary shorts or floats for a
tomwalters@0 11 given variance over a given range of standard deviations.
tomwalters@0 12
tomwalters@0 13 .SH OPTIONS
tomwalters@0 14
tomwalters@0 15 1. variance, range
tomwalters@0 16
tomwalters@0 17 The variance of the Gaussian window and its ordinal range in standard
tomwalters@0 18 deviations either side of the mode.
tomwalters@0 19 The size of the window in samples is given by:
tomwalters@0 20
tomwalters@0 21 .nf
tomwalters@0 22 [ 2 * range * sqrt( variance ) ] samples + 1 sample
tomwalters@0 23 .fi
tomwalters@0 24
tomwalters@0 25 The variance can be given with time units (ms or s) or samples (no
tomwalters@0 26 units). Time units are converted to samples using the given `samplerate'
tomwalters@0 27 option.
tomwalters@0 28
tomwalters@0 29 2. normalize
tomwalters@0 30
tomwalters@0 31 If "normalize=off" then the window has unit amplitude at the mode.
tomwalters@0 32 If "normalize=on" then the window is scaled for unit area.
tomwalters@0 33
tomwalters@0 34 3. scale
tomwalters@0 35
tomwalters@0 36 A scale factor for the output.
tomwalters@0 37
tomwalters@0 38 4. type
tomwalters@0 39
tomwalters@0 40 Output datatype ("type=short" or "type=float").
tomwalters@0 41
tomwalters@0 42 .SH "SEE ALSO"
tomwalters@0 43 options smooth
tomwalters@0 44
tomwalters@0 45 .SH COPYRIGHT
tomwalters@0 46 .LP
tomwalters@0 47 Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
tomwalters@0 48 .LP
tomwalters@0 49 Permission to use, copy, modify, and distribute this software without fee
tomwalters@0 50 is hereby granted for research purposes, provided that this copyright
tomwalters@0 51 notice appears in all copies and in all supporting documentation, and that
tomwalters@0 52 the software is not redistributed for any fee (except for a nominal
tomwalters@0 53 shipping charge). Anyone wanting to incorporate all or part of this
tomwalters@0 54 software in a commercial product must obtain a license from the Medical
tomwalters@0 55 Research Council.
tomwalters@0 56 .LP
tomwalters@0 57 The MRC makes no representations about the suitability of this
tomwalters@0 58 software for any purpose. It is provided "as is" without express or
tomwalters@0 59 implied warranty.
tomwalters@0 60 .LP
tomwalters@0 61 THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
tomwalters@0 62 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
tomwalters@0 63 THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES
tomwalters@0 64 OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
tomwalters@0 65 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
tomwalters@0 66 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
tomwalters@0 67 SOFTWARE.
tomwalters@0 68