diff man/man1/naptosai.1 @ 0:5242703e91d3 tip

Initial checkin for AIM92 aimR8.2 (last updated May 1997).

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/man/man1/naptosai.1	Fri May 20 15:19:45 2011 +0100
@@ -0,0 +1,116 @@
+.TH NAPTOSAI 1 "14 September 1993"
+
+.SH NAME
+naptosai \-  NAP to SAI format conversion.   
+
+.SH SYNTAX 
+naptosai  [arguments]  [file]
+
+.SH DESCRIPTION
+
+The program expects to read an AIM header, and interprets input as one large
+frame in column-wise format (eg output from genbmm, gennap, etc.), to be
+divided into input frames according to the given options.
+Each frame is output in row-wise format (eg as if output from gensai).
+
+The options "start" and "length" specify the input file.
+The special option value length=max specifies all the input file from
+the given start to its end.
+The options "width" and "frstep"  specify the framing.
+The width option is the width of each frame and the frstep option is the
+frameshift between successive frames in the input file.
+The special option value width=max specifies the input framewidth as equal
+to the given input file length, (and if this is also "max", then the
+input framewidth is the remainder of the input file).
+If frstep=0, then the output is one frame of given width from the given start
+of the input file. For example, use naptosai with width=max and frstep=0
+to produce one SAI frame the same size as the input NAP.
+
+A new header is constructed, and most options in the input header are copied
+to the output header. Some parts of the header are changed for the output
+format: (frames, frameshift, framewidth, frameheight, framebytes).
+
+
+.SH EXAMPLES
+
+.nf
+1. To convert a nap or a bmm output to a single frame of sai output:
+
+gennap length=64 output=stdout file | naptosai width=32ms frstep=0 > file.sai
+gensai top=1000 useprevious=on file
+
+genbmm output=stdout file | naptosai  > file.sai
+gensai bottom=-100 useprevious=on file
+
+
+  This uses special case of zero frstep to generate one frame of output with
+  the given width. The default width is the given length, and the default
+  length is the remainder of the input file. If the width=length, then the
+  frstep is zero by default, and therefore the default process, (ie with no
+  arguments), converts the whole of the input to a single SAI frame.
+
+  Note, certain display parameters have different default values for different
+  applications. The SAI display parameters should be set to the appropriate
+  values, in order to plot the SAI on the same scale. For example:
+
+    When the source application is NAP, set gensai top=1000
+    When the source application is BMM, set gensai bottom=-100
+
+2. To convert a nap output to multiple frames of sai output:
+
+gennap length=40 output=stdout file | naptosai width=32ms frstep=0.2ms > file.sai
+gensai top=1000 useprevious=on file
+
+   The sai output can be plotted as a spiral, but it is best to set the
+   display parameters as follows:
+
+gennap length=40 output=stdout dencf=1 width=500 height=500 file |
+       naptosai width=32ms frstep=0.2ms > file.sai
+genspl useprevious=on pensize=2 file
+
+
+
+3. To convert a nap output to a sai format bitmap, to display an animated
+   stream:
+
+gennap length=40 output=stdout file | naptosai width=32ms frstep=0.2ms > file.sai
+gensai top=1000 useprevious=on bitmap=on file
+review file
+
+  The same can be done for the spiral display:
+
+gennap length=40 output=stdout dencf=1 width=500 height=500 file |
+       naptosai width=32ms frstep=0.2ms > file.sai
+genspl useprevious=on pensize=2 bitmap=on file
+review file
+
+  The plots show the nap moving though 8ms (40-32), in steps of 0.2ms,
+  first in rectangular display, then in spiral-mapped display.
+.fi
+
+.SH BUGS
+None yet.
+.SH COPYRIGHT
+.LP
+Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
+.LP
+Permission to use, copy, modify, and distribute this software without fee 
+is hereby granted for research purposes, provided that this copyright 
+notice appears in all copies and in all supporting documentation, and that 
+the software is not redistributed for any fee (except for a nominal 
+shipping charge). Anyone wanting to incorporate all or part of this 
+software in a commercial product must obtain a license from the Medical 
+Research Council.
+.LP
+The MRC makes no representations about the suitability of this 
+software for any purpose.  It is provided "as is" without express or 
+implied warranty.
+.LP
+THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING 
+ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL 
+THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES 
+OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, 
+WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, 
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 
+SOFTWARE.
+