AUTOSLIT 3.0 : README ===================== Autoslit is used to create slit-masks for the LRIS instrument from a list of object positions. Given an input file of object positions and a parameter file to control the operation of the program, Autoslit may be used to automatically and/or interactively match slits of various shapes to a selection of the objects. Autoslit will produce output files for the LRIS slitmask mill machine and the slitmask alignment program. Autoslit and a number of support files are available via the URLs: http://astro.caltech.edu/~pls/autoslit/ http://www2.keck.hawaii.edu/inst/lris/autoslit.html Compilation: ------------ Pre-compiled binaries of Autoslit are available for a few platforms, including Linux (RedHat Enterprise 5), Mac OS X 10.6 Snow Leopard, and Oracle/Sun Solaris 10. These may be obtained from the binaries/ subdirectory at the above URLs. Alternatively, the source may be retrieved and compiled locally. A Makefile is including for compiling Autoslit. The code should compile on most Unix systems, although it is currently developed on Mac OS X and RedHat Enterprise Linux hardware. 1) Retrieve and unpack distribution The most recent source distribution for Autoslit may be retrieved via anonymous FTP: http://astro.caltech.edu/~pls/autoslit/autoslit.tar.gz Autoslit is distributed as a gzipped tar file, that should be unpacked using the 'gunzip' utility from GNU and the Unix 'tar' utility: > gunzip autoslit.tar.gz > tar xvf autoslit.tar Alternatively, the version of 'tar' from GNU includes an option to use 'gunzip' directly: > tar zxvf autoslit.tar.gz This process will create a directory, autoslit-3.x, which contains the source code and example input files for Autoslit. 2) Edit Makefile A few compile options may need to be adjusted in the Makefile. These are listed at the top as bullets (1) and (2). The essential choices include: a) PGPLOT - The PGPLOT line graphics library is required; its location on your system should be noted in LIBPGPLOT. Autoslit 3.0 has been tested with PGPLOT 5.3, although other versions may work as well. If you do not have PGPLOT, it may be retrieved from: http://astro.caltech.edu/~tjp/pgplot/ b) Compilers - Both C and FORTRAN compilers are required. Autoslit 3.0 has been tested with versions 3 and 4 of the Gnu compilers, as well as the SunPro compilers from Sun/Oracle. To avoid complications, you should probably use the same FORTRAN compiler that was used to compile the PGPLOT library. 3) Type 'make'. This will build the 'autoslit3' executable program. You may then install 'autoslit3' in the location of your choice. If it will be used by more than one person, this location on a Unix machine is often /usr/local/bin. The executable is the only file that is needed to run Autoslit. There are no support files, although you may want to keep this README file, as well as the user manual (autoslit3.doc) and the sample input files in the subdirectory Examples/, for later reference. Usage: ------ Autoslit 3.0 is entirely terminal-based, although a device capable of line graphics (e.g., Tek 4010 emulator, X Window System) is needed for interactive slit assignment. A PostScript printer is needed for printing the hardcopy plots of the final slit setup. Two files are required as input to Autoslit: 1) parameter file This file contains parameters settings which control the behavior of Autoslit and define addition slit types. Autoslit will prompt the user for the name of this file. The parameter file consists of two sections, with a structure as follows: ... END ... END All words are case-insensitive, and spacing is not important. a) keyword section The keyword-value pairs may be given in any order. The seventeen possible keywords are as follows: FILENAME - name of input object file FILEOUT - root file name for output files PRIORITY - object priority to divide objects RANK_TOP [1|2] - number of slit ranks in top half RANK_BOT [1|2] - number of slit ranks in bottom half SLIT_WID - width of slits in arc-sec SLIT_LEN - minimum length of slits in arc-sec SLIT_SEP - separation of slits in arc-sec EPOCH - epoch for slitmask use TEMP - temperature for refraction calc in Celsius PRESS - pressure for refraction calc in mm of Hg WAVE - wavelength for refraction calc in Angstroms LAT - latitude of observatory in decimal degrees POS_ANGL - position angle in decimal degrees HOUR_ANG - hour angle in decimal degrees MIRROR - use guide star [DEPRECATED in v3.20] ENG_TEST - engineering test? ADC - atmospheric dispersion corrector in use? INTERACT - interactive slit assignment? VERBOSE - verbose output? For the values of the boolean keywords, any string beginning with one of the letters [tyTY] denotes true/yes, while any string beginning with one of the letters [fnFN] denotes false/no. B) slit definition section Autoslit 3.0 enables the use of four non-standard slit types: tilted slits, arc slits, line segment slits, and boxes. These slits are defined in the second section of the input parameter file. Definition blocks are structured as follows: (1) tilted slits TILTS ... The first line specifies the number of tilted slits to be defined. Each subsequent line defines one tilted slit. Each slit is defined by the name of the object on which the slit will be placed (from the input object file), the position angle of the slit, and the minimum extent of the slit in arc-seconds, above and below the position of the object. (2) arc slits ARCS ... The first line specifies the number of arc slits to be defined. Each subsequent line defines one arc slit. Each slit is defined by a name (arc slits need not be placed on objects), the position of the center of curvature of the arc, the epoch of the center position coordinates, the radius of curvature, and the position angles of the ends of the slit. The RA and Dec of the center should each be defined by three numbers (hours|degrees, minutes, seconds), separated by whitespace. The radius should be positive for arcs to the right of the center, and negative for arcs to the left of the center. The slit will extend along the smallest arc between the specified position angles. (3) line segment slits SEGMENTS ... The first line specifies the number of points to be defined for line segment slits. Each subsequent line defines one point in a line segment slit. Each point is defined by the name of the line segment slit (line segment slits are not placed on objects), the position of the point, and the epoch of the position coordinates. All consecutive line segment points which share the same slit name will be connected to form a single slit. For example, the above declaration would create two slits, one with 3 points (name1), and another with 4 points (name2). See the file Examples/test.in for more examples. Note that the value on the first line of the block indicates the number of points in the line segment slits, not the number of slits. (4) box slits BOXES ... The first line specifies the number of box slits to be defined. Each subsequent line defines one box slit. Each slit is defined by the name of the object on which the slit will be placed (from the input object file), and the size of the box, in arc-seconds. The order of the slit definition blocks does not matter. Multiple definition blocks are also allowed, i.e., two sets of arc slits. The only requirement is that the number of slit definition lines in any given block must match the number given on the declaration line, i.e., 'ARCS 4' must be followed by 4 arc slit definitions. 2) object list This file must contain one-line descriptions of each object of interest in the field, in a format identical to that used for Palomar Observatory's Norris spectrograph. This format is described in more detail in the file GET_OBJ.C, but is summarized as follows: Each object description line consists of: where = object identifier (or name) = object priority as assigned by the observer = object magnitude = object right ascension: = object declination: = epoch of the object's coordinates = object equinox = object proper motion in right ascension in arcsec/yr = object proper motion in declination in arcsec/yr Although the order of the fields is important, spacing between the fields does not matter. The lines may be given in any order, *except* the first line, which should have a priority of '9999' and should provide the coordinates of the center of the field of interest. Comments: --------- Comments, suggestions, reports of bugs, etc. should be directed to one of the authors: Judith Cohen Patrick Shopbell jlc@astro.caltech.edu pls@astro.caltech.edu