Initial commit

1 files changed, 86 insertions, 0 deletions

diff --git a/noao/imred/vtel/doc/mscan.hlp b/noao/imred/vtel/doc/mscan.hlp
new file mode 100644
index 00000000..d6b7f46b
--- /dev/null
+++ b/noao/imred/vtel/doc/mscan.hlp
@@ -0,0 +1,86 @@
+.help mscan May88 noao.imred.vtel
+.ih
+NAME
+mscan -- Read sector scans from tape into IRAF images
+.ih
+USAGE
+mscan input
+.ih
+PARAMETERS
+.ls input
+File template or device, e.g. "junk" or "s*" or "mta1600[1]" or "mtb800"
+.le
+.ls files
+List of tape file numbers or ranges delimited by commas, e.g. "1-3,5-8".
+`Files' is requested only if no file number is given in `input' and the
+input is tape.
+Files will be read in ascending order, regardless of the order of the list.
+Reading will terminate if EOT is reached, thus a list such as "1-999"
+may be used to read all the files on the tape.
+.le
+.ls verbose = yes
+Flag to signal program that it should produce verbose output.  This means
+header information.
+.le
+.ls makeimage = yes
+Flag to signal the program that it should make images.  If this parameter
+is set to no, the header will be read and decoded but no data will be read
+and no image will be produced on disk.
+.le
+.ls brief = yes
+Flag to make mscan produce brief filenames for the output images.  These
+filenames have the form [svb]nnn e.g. s034 or b122.  The b is for a brightness
+image, the v is for a velocity image, and the s is for a select image.  The
+'nnn' is the tape sequence number or the filenumber in a template expansion.
+If this flag is set to false the long filenames described below in the 
+"Description" section will be produced.
+.le
+.ls select = yes
+Flag to tell the program to make a select image.
+.le
+.ls bright = yes
+Flag to tell the program to make a brightness image.
+.le
+.ls velocity = yes
+Flag to tell the program to make a velocity image.
+.le
+.ih
+DESCRIPTION
+Mscan reads all or selected area scans from a vacuum telescope tape
+and formats the data into multiple IRAF images.  Type 1, 2, and 3 area
+scans can produce 3 output images and type 4 produces one output image.
+The long image names are assembled in the following way:
+.nf
+
+     The first letter is one of [bsv] for brightness, select, or velocity.
+     The next two digits are the day of the month.
+     Underbar.
+     The next 4 digits are the hour and minute.
+     Underbar.
+     Finally there is a three digit tape sequence number.
+     ie.
+
+		 b13_1709_002
+.fi
+
+.ih
+EXAMPLES
+1. To read files 5-7 from mta at 1600 bpi, the command would be:
+
+.nf
+	vt> mscan mta1600 5-7
+.fi
+
+2. To see the header information only for file 6, one could use the command:
+
+.nf
+	vt> mscan mta1600[6] make-
+.fi
+
+3. To read file 4 from mta and only produce a velocity image:
+
+.nf
+	vt> mscan mta[4] bri- sel-
+.fi
+
+.endhelp