diff options
author | Joe Hunkeler <jhunkeler@gmail.com> | 2015-08-11 16:51:37 -0400 |
---|---|---|
committer | Joe Hunkeler <jhunkeler@gmail.com> | 2015-08-11 16:51:37 -0400 |
commit | 40e5a5811c6ffce9b0974e93cdd927cbcf60c157 (patch) | |
tree | 4464880c571602d54f6ae114729bf62a89518057 /noao/mtlocal/doc | |
download | iraf-osx-40e5a5811c6ffce9b0974e93cdd927cbcf60c157.tar.gz |
Repatch (from linux) of OSX IRAF
Diffstat (limited to 'noao/mtlocal/doc')
-rw-r--r-- | noao/mtlocal/doc/Mtio_notes | 12 | ||||
-rw-r--r-- | noao/mtlocal/doc/Rpds_notes | 84 | ||||
-rw-r--r-- | noao/mtlocal/doc/ldumpf.hlp | 45 | ||||
-rw-r--r-- | noao/mtlocal/doc/r2df.hlp | 88 | ||||
-rw-r--r-- | noao/mtlocal/doc/rcamera.hlp | 109 | ||||
-rw-r--r-- | noao/mtlocal/doc/rdumpf.hlp | 89 | ||||
-rw-r--r-- | noao/mtlocal/doc/ridsfile.hlp | 102 | ||||
-rw-r--r-- | noao/mtlocal/doc/ridsmtn.hlp | 133 | ||||
-rw-r--r-- | noao/mtlocal/doc/ridsout.hlp | 97 | ||||
-rw-r--r-- | noao/mtlocal/doc/rpds.hlp | 93 | ||||
-rw-r--r-- | noao/mtlocal/doc/rrcopy.hlp | 65 | ||||
-rw-r--r-- | noao/mtlocal/doc/widsout.hlp | 113 | ||||
-rw-r--r-- | noao/mtlocal/doc/widstape.hlp | 90 |
13 files changed, 1120 insertions, 0 deletions
diff --git a/noao/mtlocal/doc/Mtio_notes b/noao/mtlocal/doc/Mtio_notes new file mode 100644 index 00000000..c5fb2fe5 --- /dev/null +++ b/noao/mtlocal/doc/Mtio_notes @@ -0,0 +1,12 @@ + +MTIO mods: + + (1) Install error checking in MTOPEN ("errchk open"). + + (2) Attempt to position to a file beyond EOT for reading should not + cause an error, rather EOF should be returned at the first read, + indicating a zero length file (i.e., EOT). + + (3) ZARDMT should zero-fill to an integral number of chars, provided + space is available at end of buffer (see ZARDBF, which I had to + modify to provide zero-fill). diff --git a/noao/mtlocal/doc/Rpds_notes b/noao/mtlocal/doc/Rpds_notes new file mode 100644 index 00000000..dbd03326 --- /dev/null +++ b/noao/mtlocal/doc/Rpds_notes @@ -0,0 +1,84 @@ +.help pdsread 2 "Program Structure" +.sh +PDSREAD Structure Chart + +.nf +t_pdsread() +# Returns when file list is satified or if EOT is encountered. + + read_pds (pdsfile, iraffile) + # Returns OK or EOF + + read_header (pds_fd, im, parameters) + # Returns OK or EOF + + read_image (pds_fd, im, parameters) + + set_image_header (im) + + init_read_scan (parameters) + # Returns OK + + read_scan (fd, scanbuf) + # Returns EOF or number of points in a scan +.fi + +.sh +PDSREAD Structure Summary + +.ls t_pdsread +The main procedure reads the control parameters. +The files to be read and converted are calculated from the specified source +and file list. +A loop through the files determines the specific input source names and +output file names and calls READ_PDS for each conversion. +.ls read_pds +The input source is opened and the output image header file is created. +If only the PDS header is to be listed then a temporary image header +file is created. The PDS header is read and decoded into the IRAF +image header bye READ_HEADER. If the image is to be read then +READ_IMAGE is called. Finally all files are closed. If a temporary +image file was created it is deleted. +.ls read_header +The 120 byte PDS header is read into an integer array. The ID string +in the first 80 bytes is unpacked into a text string using the MIIUP routine +and stored in the IRAF image header. The 12 bit PDP values are converted to +SPP short data valuese using the routine APDP8S. +The PDP 059 text code is converted to ASCII using the routine APDP059. +The remaining header quantities are unpacked into short +or long SPP integers using the MIIUP, APDP8S, UNPACKS and UNPACKL and +the image dimensions are stored in the IRAF image header. +Finally the PRINT_HEADER is called to print a long or short version of the +header. +.le +.le +.le +.ls read_image +The PDS image pixels are converted to an IRAF image file. +The image file header is set. +The lines of the image are converted one at a time. +.ls set_image_header +The pixel type for the IRAF image is set to the user specified type. +If no type has been specified then the type is determined from the +number of bits per pixel given in pds.h. +.le +.ls init_read_scan +Initializes the scan parameters. Input is a long integer array containing +the decoded header parameters. The procedure uses the number of data points +per scan, the number of records per scan and the number of points per full +records, calculates and allocates the buffer space required and determines +the size of each record in chars. If the tape is an old 7 track tape the +size of the record must be rounded up till it holds an integral number +of Cyber words in length. For example a record containing 1001 real data +points will actually be 1005 data points long with junk in the last 4 spaces. +.le +.ls read_scan +Reads an entire PDS scan a record at a time looping over the number of +records per scan. The procedure uses the MIIUP +routine which is machine dependent. The bitpix must correspond to +an MII type. READ_SCAN returns the number of data points per scan or EOF. +READ_SCAN calls APDP8S to convert the 10 or 12 bit data values to short +integers and calls AFLIPS to flip every other scan if the PDS scan +is a raster scan. +.le +.endhelp diff --git a/noao/mtlocal/doc/ldumpf.hlp b/noao/mtlocal/doc/ldumpf.hlp new file mode 100644 index 00000000..bfd584ff --- /dev/null +++ b/noao/mtlocal/doc/ldumpf.hlp @@ -0,0 +1,45 @@ +.help ldumpf Jun87 noao.mtlocal +.ih +NAME +ldumpf -- list the permanent files on a Cyber DUMPF tape. +.ih +USAGE +ldumpf dumpf_file file_list +.ih +PARAMETERS +.ls dumpf_file +The DUMPF data source, i.e., the name of a magtape device or a DUMPF +format disk file. If reading from tape, the files to be listed are +specified by the \fIfile_list\fR parameter. +.le +.ls file_list +A string listing the DUMPF files to be listed from \fIdumpf_file\fR. +.le +.ih +DESCRIPTION +Cyber permanent files stored on DUMPF tapes are listed. The permanent file +name, cycle number, owner id, dates of last attach, last alteration and +the creation date are printed. Task \fBldumpf\fR lists the contents of a +DUMPF tape; +to convert IPPS rasters stored on DUMPF tapes to IRAF images, use task +\fBrdumpf\fR. +.ih +EXAMPLES +List all permanent files on a DUMPF tape: + + cl> ldumpf mta 1-999 + +List information for the 4th permanent file on the tape: + + cl> ldumpf mta 4 +.ih +BUGS +The Cyber format readers, including task \fIldumpf\fR, have not been +implemented on SUN/IRAF and AOS/IRAF. + +The current version of IRAF magtape I/O does not read beyond the first +volume of a multivolume tape. +.ih +SEE ALSO +rdumpf +.endhelp diff --git a/noao/mtlocal/doc/r2df.hlp b/noao/mtlocal/doc/r2df.hlp new file mode 100644 index 00000000..38054ad3 --- /dev/null +++ b/noao/mtlocal/doc/r2df.hlp @@ -0,0 +1,88 @@ +.help r2df Jun86 noao.mtlocal +.ih +NAME +r2df -- convert CTIO 2D-Frutti image files to IRAF image files +.ih +USAGE +r2df r2df_file file_list iraf_file +.ih +PARAMETERS +.ls 4 r2df_file +The 2D-Frutti data source. If the data source is a disk file or an explicit +tape file +specification of the form mt*[n] where n is a file number then only that file +is converted. If the general tape device name is given, i.e. mta, mtb800, etc, +then the files specified by the files parameter will be read from the tape. +.le +.ls file_list +The files to be read from a tape are specified by the file_list string. The +string can consist of any sequence of file numbers separated by +at least one of comma, or dash. +A dash specifies a range of files. For example the string + + "1,2,3-5,8-6" + +will convert the files 1 through 8. +.le +.ls iraf_file +The IRAF image file which will receive the 2D-Frutti data if the make_image +parameter switch is set. For tape files specified by the file_list parameter +the filename will be used as a prefix and the file number will be appended. +Otherwise, the file will be named as specified. Thus, +reading files 1 and 3 from a 2D-Frutti tape with a filename of data will produce +the files data1 and data3. It is legal to use a null filename. +.le +.ls make_image = yes +This switch determines if 2D-Frutti image data is converted to an IRAF image +file. This switch is set to no to obtain just header information with the +long_header or short_header switches. +.le +.ls long_header = no +If this switch is set the full 2D-Frutti header is printed on standard output. +.le +.ls short_header = yes +If this switch is set only the output filename, +the title string, and the image dimensions are printed. +.le +.ls standard_format = yes +The 2D-Frutti standard format has least significant byte first. Some 2D-Frutti +data, however, does not follow this byte order convention. Thus, to read +the non-standard 2D-Frutti data this parameter is set to no. +.le +.ls datatype = "s" +The IRAF image file may be of a different data type than 2D-Frutti image data. +The data type may be specified as s for short, l for long, r for real, and +d for double. The user must beware of truncation problems if an +inappropriate data type is specified. If an incorrect data_type or a +null string is given for this parameter then a default data type is used +which is the appropriate minimum size for the input pixel values. +.le +.ls offset = 0 +Offset is an integer parameter specifying the offset to the tape file number +appended to iraf_file. For example if the user specifies offset = 100, +iraf_file = "r2d" and file_list = "1-3", the output file names produced +will be "r2d101", "r2d102" and "r2d103" respectively, instead of "r2d001", +"r2d002" and "r2d003". +.le +.ih +DESCRIPTION +Cerro Tololo 2D-Frutti format image data is read from the specified source; +either a disk file or magnetic tape. +The 2D-Frutti header may optionally be printed on the standard +output as either a full listing or a short description. Image data may +optionally be converted to an IRAF image of specified data type. +.ih +EXAMPLES + +1. Convert a 2D-Frutti image tape to a set of IRAF images. + + da> r2df mtb1600 1-999 r2dfile + +2. List the contents of a 2D-Frutti tape on the standard output without +creating an image file. + + da> r2df mtb1600 1-999 r2dfile ma- +.ih +SEE ALSO +t2d, mtexamine, rewind +.endhelp diff --git a/noao/mtlocal/doc/rcamera.hlp b/noao/mtlocal/doc/rcamera.hlp new file mode 100644 index 00000000..491edc71 --- /dev/null +++ b/noao/mtlocal/doc/rcamera.hlp @@ -0,0 +1,109 @@ +.help rcamera Jan87 noao.mtlocal +.ih +NAME +rcamera -- Convert Kitt Peak CAMERA image files to IRAF image files +.ih +USAGE +rcamera camera_file file_list iraf_file +.ih +PARAMETERS +.ls 4 camera_file +The CAMERA data source. If the data source is a list of disk files or an +explicit tape file +specification of the form mt*[n] where n is a file number. If the file +number is specified then only that file +is converted. If the general tape device name is given, i.e. mta, mtb800, etc, +then the files specified by the file_list parameter will be read from the tape. +.le +.ls file_list +The files to be read from a tape are specified by the file_list string. The +string can consist of any sequence of file numbers separated by +at least one of comma, or dash. +A dash specifies a range of files. For example the string + + "1,2,3-5,8-6" + +will convert the files 1 through 8. +.le +.ls iraf_file +The IRAF file which will receive the CAMERA data if the make_image parameter +switch is set. For multiple disk or tape files the filename +will be used as a prefix and the tape file number or disk sequence number +will be appended. Otherwise, +the file will be named as specified. Thus, +reading files 1 and 3 from a CAMERA tape with a iraf_file set to data will +produce the files data001 and data003. +.le +.ls image_list = "1" +The list of CAMERA images to extract from a single tape file. For all recent +tapes image_list = "1". Old tapes were however contained multiple images +per file. +.le +.ls make_image = yes +This switch determines whether CAMERA image data is converted to an IRAF image +file. This switch is set to no to obtain just header information with the +long_header or short_header switches. +.le +.ls long_header = no +If this switch is set the full CAMERA header is printed on the standard output. +.le +.ls short_header = yes +If this switch is set only the output filename, +the title string, and the image dimensions are printed. +.le +.ls standard_format = yes +The CAMERA standard format has the least significant byte first. Some CAMERA +data, however, does not follow this byte order convention. Thus, to read +the non-standard CAMERA data this parameter is set to no. +.le +.ls datatype = "s" +The IRAF image file may be of a different data type than the CAMERA image data. +The data type may be specified as s for short, l for long, r for real, and +d for double. The user must beware of truncation problems if an +inappropriate data type is specified. If an incorrect data_type or a +null string is given for this parameter then a default data type is used +which is the appropriate minimum size for the input pixel values. +.le +.ls offset = 0 +Offset is an integer parameter specifying the offset to the tape file number +appended to iraf_file. For example if the user specifies offset = 100, +iraf_file = "cam" and file_list = "1-3", the output file names produced +will be "cam101", "cam102" and "cam103" respectively, instead of "cam001", +"cam002" and "cam003". +.le +.ih +DESCRIPTION + +Kitt Peak CAMERA format image data is read from the specified source; +either a disk or magnetic tape. +The CAMERA header may optionally be printed on the standard +output as either a full listing or a short description. Image data may +optionally be converted to an IRAF image of specified data type. +.ih +EXAMPLES + +Convert a camera image tape to a set of IRAF images. + +.nf + cl> rcamera mtb1600 1-999 images +.fi + +Convert a list of camera disk files to IRAF images. + +.nf + cl> rcamera cam* 1 images +.fi + +List the contents of a camera tape on the standard output without +creating an image file. + +.nf + cl> rcamera mtb1600 1-999 images ma- +.fi + +Read images 1-3 and 6-8 from an old CAMERA tape with many images per file. + +.nf + cl> rcam mtb1600[1] image image_list=1-3,6-8 +.fi +.endhelp diff --git a/noao/mtlocal/doc/rdumpf.hlp b/noao/mtlocal/doc/rdumpf.hlp new file mode 100644 index 00000000..d995774e --- /dev/null +++ b/noao/mtlocal/doc/rdumpf.hlp @@ -0,0 +1,89 @@ +.help rdumpf Jul87 noao.mtlocal +.ih +NAME +rdumpf -- convert IPPS rasters from DUMPF tapes to IRAF images +.ih +USAGE +rdumpf dumpf_file file_list iraf_file +.ih +PARAMETERS +.ls dumpf_file +The dumpf data source, i.e., the name of a magtape device. +.le +.ls file_list +A string listing the permanent files to be read from the DUMPF tape. +.le +.ls iraf_file +The IRAF file which will receive the image data if the \fImake_image\fR +parameter +is set. If more then one raster is being read, the output +filename is concatenated from the \fIiraf_file\fR parameter, the tape +file number and the raster sequence number. That is, reading rasters 1 - 3 +from files 3 and 4 with iraf_file = \fIpic\fR would generate a sequence of +files: +pic3.001, pic3.002, pic3.003, pic4.001, pic4.002, pic4.003. +.le +.ls raster_list = "1-999" +A string listing the IPPS rasters to be read from each file specified by +the \fIfile_list\fR parameter. +.le +.ls make_image = yes +This switch determines whether the IPPS rasters are converted to IRAF images. +When this switch is set to \fIno\fR, only a listing of the IPPS rasters is +produced, no output image is written. +.le +.ls print_header = yes +This switch determines if the IPPS header information will be listed for those +rasters being read. +.le +.ls data_type = "" +The data type of the output IRAF image. If an incorrect data_type or null +string is entered, the default data type used is determined by the number +of bits per pixel in the IPPS raster. +.le +.ih +DESCRIPTION +IPPS rasters stored in DUMPF format are read and optionally converted to +IRAF images. The IPPS ID and other header information is printed. +The rasters to be converted are specified by both a file +number and then a raster number within that file. It may be helpful to +first run task \fBldumpf\fR to list the contents of the DUMPF tape; only +IPPS rasters can be converted. +.sp +Some dumpf volumes are written on more than one tape. +Task \fIrdumpf\fR cannot recover a file that is split across two tapes on +a "multi-volume-set" dumpf tape. It is, however, possible to read the files +beyond the leading partial file; this is done by incrementing the +\fBfile_list\fR parameter by 1. For example, the first complete file +on the second tape of a multi-volume-set is indicated by \fBfile_list\fR = 2. +.ih +EXAMPLES +[1] Convert all rasters in the 3rd permanent file on tape: + + cl> rdumpf mta 3 ipps + +[2] Convert all rasters in all permanent files: + + cl> rdumpf mta 1-999 ipps + +[3] List the first 10 IPPS rasters of the first permanent file: + + cl> rdumpf mta 1 raster_list=1-10 make_image=no + +.ih +BUGS +The Cyber format readers, including \fIrdumpf\fR, have not been implemented +on SUN/IRAF and AOS/IRAF. + +The current version of IRAF magtape I/O does not read beyond the first +volume of a multivolume tape. As described above, \fIrdumpf\fR cannot +read a file split across two tapes. +.sp +The record structure of a DUMPF tape is used to +filter out noise records and extraneous bits that fill out a tape byte; +this tape structure information is lost when the tape is copied to disk, +and so \fBrdumpf\fR may not be able to convert some DUMPF format disk files. +.ih +SEE ALSO +ldumpf +.endhelp diff --git a/noao/mtlocal/doc/ridsfile.hlp b/noao/mtlocal/doc/ridsfile.hlp new file mode 100644 index 00000000..42f98884 --- /dev/null +++ b/noao/mtlocal/doc/ridsfile.hlp @@ -0,0 +1,102 @@ +.help ridsfile Jun87 noao.mtlocal +.ih +NAME +ridsfile -- convert DUMPF format IDSFILE to IRAF images +.ih +USAGE +ridsfile dumpf_file file_number iraf_file +.ih +PARAMETERS +.ls dumpf_file +The dumpf data source, i.e., the name of a magtape device. +.le +.ls file_number +The ordinal of the DUMPF permanent file containing the IDSFILE to +be read. A listing of permanent files on the DUMPF tape can be +obtained with the \fBldumpf\fR task. +.le +.ls iraf_file +The IRAF file which will receive the data if the \fImake_image\fR parameter +is set. If multiple records are being read, the output +filename is concatenated from this parameter and the IDS record number. +That is, images with these names would be created if \fIiraf_file\fR = "ids": +ids.1001, ids.1002, ids.1003, ..., ids.2001, ids.2002, ..., ids.3001 .... +.le +.ls record_numbers = "1001-9999" +A string listing the IDS records to be read from the IDSFILE. +.le +.ls make_image = yes +This switch determines whether the IDS records are converted to IRAF images. +When \fImake_image\fR = no, only a listing of the headers is produced, +no output image is written. +.le +.ls print_pixels = no +When this parameter is set to yes, the values of the ids pixels are printed. +.le +.ls long_header = no +This parameter determines whether a long or short header is printed. When +\fIlong_header\fR = no, a short header is printed. The +short header contains only the record number and ID string; the long header +contains all information available +including the RA, Dec, HA, ST, UT, reduction flags, airmass, integration time, +starting wavelength and wavelength per channel information. +.le +.ls data_type = "r" +The data type of the output IRAF image. If an incorrect data_type or null +string is entered, the default data type \fIreal\fR is used. +.le +.ih +DESCRIPTION +The IDS records in an IDSFILE are read from a Cyber DUMPF tape and optionally +converted to a sequence of one dimensional IRAF images. The records to be +read from the IDSFILE can be +specified. The IDS header information is printed in either a short or long +form. The pixels values can be listed as well. +.ih +EXAMPLES +[1] Convert all records in the IDSFILE to IRAF images, with the root image name +being "aug83". From running task LDUMPF, it is known that the IDSFILE is the +fourth permanent file on the DUMPF tape. The DUMPF tape is mounted on mtb. + + cl> ridsfile mtb 4 aug83 + +[2] List the headers from the same IDSFILE read in example 1, but don't make +output images. A \fBlong_header\fR will be listed; sample output is shown. + + cl> ridsfile mtb 4 make_image=no long_header=yes + +.nf +RECORD = 2317, label = "CALLISTO 2297/2298 CLEAR/2.5ND", +oflag = OBJECT, beam_number = 0, alpha_ID = NEW, companion = 2318, +airmass = 1.524, W0 = 3430.735, WPC = 1.032, ITM = 960, +NP1 = 0, NP2 = 1024, UT = 3:36:20.0, ST = 15:36:43.0, +HA = 1:39:48.5, RA = 13:56:55.5, DEC = -10:42:37.1, +df = -1, sm = -1, qf = -1, dc = 0, qd = 0, ex = 0, bs = 1, ca = 0, co = -1 +.fi + +[3] Print the pixel values for records 5086 and 5087. No output image will +be written, and only the short header listed. Again, the IDSFILE is the +fourth permanent file on the DUMPF tape, which is mounted on mtb. + + cl> ridsfile mtb 4 make_im- rec=5086,5087 print+ +.ih +BUGS +The current version of IRAF magtape I/O does not read beyond the first +volume of a multivolume tape. +.sp +The record structure of a DUMPF tape is used to +filter out noise records and extraneous bits that fill out a tape byte; +this tape structure information is lost when the tape is copied to disk, +and so \fBridsfile\fR may not be able to convert some DUMPF format disk files. +.sp +Task \fBridsfile\fR allows for converting only one IDSFILE per execution. +If you wish to read more than one IDSFILE +from a DUMPF tape, \fBridsfile\fR must be executed more than once. +.ih +BUGS +The Cyber format readers, including \fIridsfile\fR, have not been implemented +on SUN/IRAF and AOS/IRAF. +.ih +SEE ALSO +ldumpf, ridsout, ridsmtn +.endhelp diff --git a/noao/mtlocal/doc/ridsmtn.hlp b/noao/mtlocal/doc/ridsmtn.hlp new file mode 100644 index 00000000..48ec58aa --- /dev/null +++ b/noao/mtlocal/doc/ridsmtn.hlp @@ -0,0 +1,133 @@ +.help ridsmtn Jun86 noao.mtlocal +.ih +NAME +ridsmtn -- convert mountain format IDS data to IRAF images +.ih +USAGE +ridsmtn ids_file iraf_file +.ih +PARAMETERS +.ls ids_file +The IDS data source. +.le +.ls iraf_file +The IRAF file which will receive the data if the \fImake_image\fR parameter +is set. If multiple records are being read, the output +filename is concatenated from this parameter and the IDS record number. +IRAF images with these names would be created from IDS records 1, 2 and 3 if +\fIiraf_file\fR = "ids" (and offset = 0; see below): ids.0001, ids.0002, +ids.0003. +.le +.ls file_number = 1 +If \fIids_file\fR is a tape device, this parameter tells which tape file +will be read. In almost all cases, the IDS data will occupy the first +and only file on the tape. +.le +.ls record_numbers = "1-9999" +A string listing the IDS records to be read. +.le +.ls reduced_data = yes +A boolean parameter which indicates the data is mountain reduced if set +to yes, and that the data is raw (unreduced) if set to no. +.le +.ls np1 = 0 +The starting pixel to extract in the image. If set to 0, the +record header parameter NP1 will be used to determine the +starting pixel. +This and the following parameter are in effect only when reduced_data +is set to no. If reduced_data=yes, then the entire spectrum (1024 points) +is copied. +.le +.ls np2 = 0 +The ending pixel to extract. If set to 0, the record +header parameter NP2 will be used to determine the +starting pixel. +.le +.ls make_image = yes +This switch determines whether the IDS records are converted to IRAF images. +When \fImake_image\fR = no, only a listing of the headers is produced, +no output image is written. +.le +.ls print_pixels = no +When this parameter is set to yes, the values of the ids pixels are printed. +.le +.ls long_header = no +This parameter determines whether a long or short header is printed. The +short header contains only the record number and ID string; the long header +contains all information available +including the RA, Dec, HA, ST, UT, reduction flags, airmass, integration time, +starting wavelength and wavelength per channel information. +.le +.ls data_type = "r" +The data type of the output IRAF image. If an incorrect data_type or null +string is entered, the default data type \fIreal\fR is used. +.le +.ls offset = 0 +The integer value of this parameter is added to each IDS record number when +generating output filenames. Filenames are of the form +.nf + \fIiraf_file\fR.record_number+\fIoffset\fR + +.fi +The offset parameter can be used to create a sequence of output IRAF +filenames with continuous, sequential suffixes over more than one night's data. +.le +.ih +DESCRIPTION +The IDS records from either a raw or reduced IDS mountain tape are read and +optionally converted to a sequence of one dimensional IRAF images. The records +to be read can be specified. The IDS header information is printed in either +a short or long form. The pixel values can be listed as well. + +The entire image may be extracted (default for reduced data) by specifying +the parameters np1=1 and np2=1024 (IIDS and IRS). Otherwise, the +header parameters NP1 and NP2 will be used to indicate the useful +portion of the spectrum. For raw data these values are 6 and 1024 for the +IIDS and 68 and 888 for the IRS (your IRS values may vary). + +On the mountain, the NEW-TAPE command writes a dummy record on tape with a +record number equal to the starting record number minus 1. If this dummy +record number is included in the \fIrecord_numbers\fR range, a meaningless +IRAF image will be written. In most cases, the dummy record number = 0. +.ih +EXAMPLES +[1] Convert all records on the IDS tape to IRAF images, with the root image name +being "aug83". The data is mountain reduced, and all records will be +converted. The IDS tape is mounted on mtb. + + cl> ridsmtn mtb aug83 + +[2] List the headers from the same mountain tape read in example 1 but don't +make output images. A \fIlong_header\fR will be listed; sample output is shown. + + cl> ridsmtn mtb make_image=no long_header=yes + +.nf + +RECORD = 79, label = "NGC 7662 7.4E 10S AUG 23/24 84 CLOUDS", +oflag = OBJECT, beam_number = 0, W0 = 4588.503, WPC = 2.598, ITM = 120, +NP1 = 0, NP2 = 1024, UT = 7:37:04.0, ST = 22:21:46.0, HA = -1:03:25.7, +RA = 23:25:12.6, DEC = 42:26:37.0, DRA = 7.4, DDEC = -10., +df =-1, sm =-1, qf =-1, dc = 0, qd = 0, ex =-1, bs = -1, ca = -1, co = 0 + + +RECORD = 238, label = "HENEAR AUG 23/24 84 END 8.4" ENT", +oflag = SKY, beam_number = 1, W0 = 4585.501, WPC = 2.602, ITM = 400, +NP1 = 8, NP2 = 1019, UT = 12:31:01.0, ST = 3:16:33.0, HA = 0:17:16.3, +RA = 2:59:16.7, DEC = 31:57:30.0 +df = 6, sm = -1, qf = -1, dc = -1, qd =-1, ex =-1, bs =-1, ca =-1, co = -1, +df[1] = 5889.2139, df[2] = 1355.6821, df[3] = 23.1303, df[4] = -2.85366, +df[5] = 3.0472932, df[6] = -4.541831 +.fi + +[3] Print the pixel values for records 5086 and 5087. No output image will +be written, and only the short header listed. This time, the IDS tape +contains raw data, not reduced. + +.nf + cl> ridsmtn mtb red- make_im- rec=5086,5087 print_pix- +.fi +.ih +SEE ALSO +ridsout, ridsfile +.endhelp diff --git a/noao/mtlocal/doc/ridsout.hlp b/noao/mtlocal/doc/ridsout.hlp new file mode 100644 index 00000000..03f1cf75 --- /dev/null +++ b/noao/mtlocal/doc/ridsout.hlp @@ -0,0 +1,97 @@ +.help ridsout Sep84 noao.mtlocal +.ih +NAME +ridsout -- convert IDSOUT format text file to IRAF images +.ih +USAGE +ridsout idsout_file iraf_file +.ih +PARAMETERS +.ls idsout_file +The text file or files containing the IDSOUT format data. This will most likely +be the redirected output from task \fBrcardimage\fR. +.le +.ls iraf_file +The IRAF file which will receive the data if the \fImake_image\fR parameter +is set. If multiple records are being converted, the output +filename is concatenated from this parameter and the IDS record number. +That is, images with these names would be created if \fIiraf_file\fR = "ids": +ids.1001, ids.1002, ids.1003, ..., ids.2001, ids.2002, ..., ids.3001 .... +.le +.ls record_numbers = "1001-9999" +A string listing the IDS records to be read. +.le +.ls make_image = yes +This switch determines whether the IDS records are converted to IRAF images. +When \fImake_image\fR = no, only a listing of the headers is produced, +no output image is written. +.le +.ls print_pixels = no +When this parameter is set to yes, the values of the ids pixels are printed. +.le +.ls long_header = yes +This parameter determines whether a long or short header is printed. When +\fIlong_header\fR = no, a short header is printed. The +short header contains only the record number and ID string; the long header +contains all information available +including the RA, Dec, HA, ST, UT, reduction flags, airmass, integration time, +starting wavelength and wavelength per channel information. +.le +.ls data_type = "r" +The data type of the output IRAF image. If an incorrect data_type or null +string is entered, the default data type \fIreal\fR is used. +.le +.ih +DESCRIPTION +IDSOUT format IDS records are read from a text file and optionally +converted to a sequence of one dimensional IRAF images. The text file will +most likely have been created by reading an IDSOUT tape with \fBrcardimage\fR. +The IDS records to be read from the file can be specified. +The IDS header information is printed in either a short or long +form. The pixels values can be listed as well. +.ih +EXAMPLES +[1] Convert all records in the IDSOUT file to IRAF images, with the root image +name being "aug83". The IDSOUT file is the first file on the tape, which is +mounted on mtb. + + cl> rcardimage mtb[1] | ridsout aug83 + +[2] List the headers from the same IDSOUT file read in example 1, but don't make +output images. A \fBlong_header\fR will be listed; sample output is shown. + + cl> rcardimage mtb[1] | ridsout make_image=no + +.nf + +RECORD = 2317, label = "CALLISTO 2297/2298 CLEAR/2.5ND", +oflag = OBJECT, beam_number = 0, alpha_ID = NEW, companion = 2318, +airmass = 1.524, W0 = 3430.735, WPC = 1.032, ITM = 960, +NP1 = 0, NP2 = 1024, UT = 3:36:20.0, ST = 15:36:43.0, +HA = 1:39:48.5, RA = 13:56:55.5, DEC = -10:42:37.1, +df = -1, sm = -1, qf = -1, dc = 0, qd = 0, ex = 0, bs = 1, ca = 0, co = -1 +.fi + +[3] Print the pixel values for records 5086 and 5087. No output image will +be written, and only the short header listed. Again, the IDSOUT file is the +first file on the tape, which is mounted on mtb. + +.nf + cl> rcard mtb[1] | ridsout make- long- print+ rec = 5086,5087 +.fi +.ih +BUGS +The current version of IRAF magtape I/O does not read beyond the first +volume of a multivolume tape. +.sp +Task \fBridsout\fR allows for converting more than one IDSOUT file per +execution. In cases where a given record number occurs in more than one +IDSOUT file being read and \fImake_image = yes\fR, this creates a problem, as +the images being written will have the same name for the duplicate record +numbers ("iraf_name.record_number"). The action taken in this situation depends +on the value of "noclobber"; the user should be aware of the potential +problem. +.ih +SEE ALSO +ridsfile, ridsmtn +.endhelp diff --git a/noao/mtlocal/doc/rpds.hlp b/noao/mtlocal/doc/rpds.hlp new file mode 100644 index 00000000..57c7c83d --- /dev/null +++ b/noao/mtlocal/doc/rpds.hlp @@ -0,0 +1,93 @@ +.help rpds Jan87 noao.mtlocal +.ih +NAME +rpds -- Convert Kitt Peak PDS image files to IRAF image files +.ih +USAGE +rpds pds_file file_list iraf_file +.ih +PARAMETERS +.ls pds_file +The PDS data source. The data source may be a template specifying +a list of disk files, e.g. pds* or a mag tape file specification of +the form mtl*[n], e.g. "mta1600" or "mtb800[1]". The mt specifies magtape, +l specifies the drive, a,b,c etc, * specifies the density and [n] +the tape file number. If no tape file number is specified rpds reads +the tape files specified by file_list. +.le +.ls file_list +A string parameter containing the list of tape files to be processed. +File_list is only requested if no tape file number is specified in pds_file. +For example the string + + "1,2,3-5,8-6" + +will convert files 1 through 8. +.le +.ls iraf_file +The IRAF file which will receive the PDS data if the make_image +switch is set. If multiple files are input from tape or disk, the tape file +number or disk sequence number will be appended to the output file name. +.le +.ls make_image = yes +If make_image is not set, the PDS image headers are listed on the standard +output and no image file is created. +.le +.ls long_header = no +If this switch is set the full PDS header is printed on the standard output. +.le +.ls short_header = yes +If this switch is set only the output filename, +the title string, and the image dimensions for each image are printed +on the standard output. +.le +.ls datatype = "s" +The IRAF image data type, s (short integer), i (integer), l (long integer), + r (real) or d (double). +.le +.ls tenbit = no +Old ten bit format? +.le +.ls ninetrack = yes +Ninetrack or old seven track tapes? +.le +.ls offset = 0 +Offset is an integer parameter which is added to the tape file number +or disk sequence number and +appended to the parameter iraf_file. For example if offset = 100, +iraf_file = "pds" and file_list = "1-3" the output file names will be +"pds101", "pds102" and "pds103" respectively, instead of "pds001", "pds002" +and "pds003". +.le +.ih +DESCRIPTION + +Kitt Peak PDS data is read into IRAF from either a +list of disk files or magnetic tape. +The PDS header may optionally be printed on the standard output as either a +full listing or a short description. +.ih +EXAMPLES + +Convert a ninetrack PDS image tape to a set of IRAF images. + +.nf + cl> pdsread mtb1600 1-999 images +.fi + +List the contents of a nintrack PDS tape on the standard output. + +.nf + cl> pdsread mtb1600 1-999 images ma- +.fi + +Convert a list of pds file on disk to IRAF images. + +.nf + cl> pdsread pds* 1 images +.fi + +.ih +BUGS + +.endhelp diff --git a/noao/mtlocal/doc/rrcopy.hlp b/noao/mtlocal/doc/rrcopy.hlp new file mode 100644 index 00000000..09d02486 --- /dev/null +++ b/noao/mtlocal/doc/rrcopy.hlp @@ -0,0 +1,65 @@ +.help rrcopy Jun87 noao.mtlocal +.ih +NAME +rrcopy -- Convert IPPS rasters from RCOPY tapes to IRAF images +.ih +USAGE +rrcopy rcopy_file raster_list iraf_file +.ih +PARAMETERS +.ls rcopy_file +The RCOPY data source, i.e., the name of a magtape device or a RCOPY +format disk file. +.le +.ls raster_list +A string listing the IPPS rasters to be read from the rcopy file. +.le +.ls iraf_file +The IRAF file which will receive the RCOPY data if the make_image parameter +is set. If more than one raster is being read, the output filenames +will be concatenated from this +parameter and the raster sequence number on the RCOPY tape. That +is, reading rasters 1 thru 8 from tape into iraf_file 'pic' +would generate a sequence of files: pic001, pic002, ..., pic008. +.le +.ls make_image = yes +This switch determines whether RCOPY image data is converted to an IRAF image +file. When this switch it set to no, only a listing is produced, no output +image is written. +.le +.ls print_header = yes +This switch determines if the header information will be printed for those +rasters in "raster_list". (It might be appropriate to set print_header=no, or +redirect the output, if RRCOPY is being run as a background task.) +.le +.ls data_type = "" +The data type of the output IRAF image. If an incorrect data_type or null +string is entered, the default data type used is +determined by the number of bits per pixel in the IPPS raster. +.le +.ih +DESCRIPTION +IPPS rasters stored on RCOPY tapes are read from the specified source. +IPPS raster header information is listed. The image data may optionally +be converted to an IRAF image file. It takes RRCOPY about 16 cpu seconds +to read a 256 x 256 30-bit IPPS raster; 42 cpu seconds for a 320 x 512 +30-bit raster; 34 cpu seconds for a 320 x 512 20-bit raster. +.ih +EXAMPLES + +[1] List all IPPS headers from an RCOPY tape: + + cl> rrcopy mtb 1-999 make_image=no + +[2] Read the first 5 rasters from tape into IRAF images ipps001 +through ipps005 with default data types: + + cl> rrcopy mtb 1-5 ipps +.ih +BUGS +The Cyber format readers, including \fIrrcopy\fR, have not been implemented +on SUN/IRAF and AOS/IRAF. + +The current version of IRAF magtape I/O does not read beyond the first +volume of a multivolume tape. +.endhelp diff --git a/noao/mtlocal/doc/widsout.hlp b/noao/mtlocal/doc/widsout.hlp new file mode 100644 index 00000000..b868a5f7 --- /dev/null +++ b/noao/mtlocal/doc/widsout.hlp @@ -0,0 +1,113 @@ +.help widsout Oct84 noao.mtlocal +.ih +NAME +widsout -- Convert an IRAF image to IDSOUT text format +.ih +USAGE +widsout image idsout +.ih +PARAMETERS +.ls image +Image to be converted to IDSOUT text format. +.le +.ls idsout +IDSOUT filename for single file output and IDSOUT root name for multiple +file output. +.le +.ls type_output = "multiple" +Type of output to be created. The options are "single" and "multiple". +In type "single" the IDSOUT records, one for each image line, are +appended to the file given by the parameter \fIidsout\fR. +In type "multiple" the IDSOUT record for each line is appended to a different +file. The files have names formed from the root name, given by \fIidsout\fR, +with the extensions .001, .002, etc, where the extension is the image line. +.001, .002, etc. +.le +.ls label = +List structured string parameter for the record labels. +.le +.ls uttime = 0 +Universal time in integer seconds. +.le +.ls utdate = 0 +Universal date given in the integer format yymmdd. +.le +.ls siderial = 0. +Siderial time in hours. +.le +.ls ra = 0. +Right Ascension in hours. +.le +.ls dec = 0. +Declination in degrees. +.le +.ls ha = 0. +Hour angle in hours. +.le +.ls airmass = 1. +Air mass. +.le +.ls integration = 0 +Integration time in integer seconds. +.le +.ls wavelen1 = 4000. +Wavelength of the first bin. +.le +.ls dispersion = 1. +Dispersion per pixel. +.le +.ih +DESCRIPTION +The \fIimage\fR containing one spectrum per image line is converted to the +IDSOUT card format described below. There are two types of output selected by +the parameter \fItype_output\fR. The options for this parameter are "single" +and "multiple". In type "single" the IDSOUT records, one for each image line, +are appended to the file given by the parameter \fIidsout\fR. +In type "multiple" the IDSOUT record for each line is appended to a different +file. The files have names formed from the root name, given by \fIidsout\fR, +with the extensions .001, .002, etc, where the extension is the image line. +Each record contains a record label which is read from the list structured +parameter \fIlabel\fR. If \fIlabel\fR is not specified the user is prompted +for the label for each image line. Otherwise the file specified is read +for the labels. The remaining parameters are general record header information +whose meanings are apparent. + +The IDSOUT text format consists of 133 80 character lines. The format of these +lines is: + +.nf + Line Column Type + 1 1-5 Integer Record number within IDSOUT text file + 6-10 Integer Integration time + 11-25 Real Wavelength of first bin + 26-40 Real Dispersion + 41-45 Integer 0 (Index of first pixel) + 46-50 Integer Line length - 1 (Index of last pixel) + 71-80 Integer UT time + 2 1-10 Real Siderial time + 11-25 Real Right Ascension + 26-40 Real Declination + 3 21-35 Real Hour Angle + 36-50 Real Air mass + 51-58 Integer UT date + 60-76 String Image title + 78-80 String END + 4 1-64 String Record label + 78-80 String END +5-132 Real 1024 pixel values, 8 per line + 133 Blank line +.fi + +The data of type real are in exponent format; i.e FORTRAN 'E' format (1.234e3). +.ih +EXAMPLES +To convert an two dimensional image containing three spectra to the +output file "idsout": + + cl> widsout image idsout type_output=single label=file + +where file contains three strings to be used for the record labels. +.ih +SEE ALSO +ridsout +.endhelp diff --git a/noao/mtlocal/doc/widstape.hlp b/noao/mtlocal/doc/widstape.hlp new file mode 100644 index 00000000..518a1013 --- /dev/null +++ b/noao/mtlocal/doc/widstape.hlp @@ -0,0 +1,90 @@ +.help widstape Mar85 noao.mtlocal +.ih +NAME +widstape -- Write a Cyber style IDSOUT tape +.ih +USAGE +widstape idsout input records +.ih +PARAMETERS +.ls idsout +The output file name to receive the card-image data. This may be a +magtape specification (e.g. mta, mtb) or disk file name. +.le +.ls input +The input root file name for the spectra to be written +.le +.ls records +The record string to be appended to the root name to create the image +names of the spectra to be written. +.le +.ls new_tape = no +If set to yes, the tape is rewound and output begins at BOT. If no, +output begins at EOT unless an explicit file specification is given +as part of the magtape file name for parameter "idsout" (e.g. mta[2]). +If idsout contains a file specification of [1], then writing begins +at BOT regardless of the value for new_tape. +.le +.ls block_size = 3200 +The tape block size in bytes. This must be an integral factor of 80. +.le +.ls ebcdic = no +The default character code is ASCII, but if this parameter is set to yes, +the output character will be in EBCDIC. +.le +.ih +DESCRIPTION +The specified spectra are copied to the output file in a card-image format +defined in the IPPS-IIDS/IRS Reduction Manual. Values from the extended +image header are used to fill in the observational parameters. + +The basic format consists of 4 - 80 byte header cards, 128 data cards +having 8 data elements per card in 1PE10.3 FORTRAN equivalent format, +and a trailing blank card for a total of 133 cards. +Thus spectra up to 1024 points may be contained in the IDSOUT format. +The format is outlined below: + +.nf + Line Column Type + 1 1-5 Integer Record number within IDSOUT text file + 6-10 Integer Integration time + 11-25 Real Wavelength of first bin + 26-40 Real Dispersion + 41-45 Integer 0 (Index of first pixel) + 46-50 Integer Line length - 1 (Index of last pixel) + 71-80 Integer UT time + 2 1-10 Real Siderial time + 11-25 Real Right Ascension + 26-40 Real Declination + 3 21-35 Real Hour Angle + 36-50 Real Air mass + 51-58 Integer UT date + 60-76 String Image title + 78-80 String END + 4 1-64 String Record label + 78-80 String END +5-132 Real 1024 pixel values, 8 per line + 133 Blank line +.fi + +The data of type real are in exponent format; i.e FORTRAN 'E' format (1.234e3). + +There are no special marks between spectral images, +and when multiple spectra are written with a single command, the first card +of a subsequent spectrum may be within the same physical tape block +as the last card of the previous spectrum. This assures that all tape +blocks (except the very last one in the tape file) are all the same +length. A double end-of-mark is written after the last spectrum. +.ih +EXAMPLES +The following example writes an IDSOUT format tape starting at the +beginning of the tape. + + cl> widstape mta nite1 1001-1200 new_tape+ +.ih +TIME REQUIREMENTS: UNIX/VAX 11/750 +Each spectrum of 1024 points requires about 2 second. +.ih +SEE ALSO +rcardimage, ridsout +.endhelp |