IR Instrument Control System


User Commands

! [arguments] - This command runs a shell using given arguments as commands to the shell.

?coadds - This command returns the number of coadds to do on the next picture taken.

?filter - This command lists the current positions of all mechanisms in the current instrument. It is used to get the current status of the instrument filters.

?inttime - This command gives the current integration time set into the instrument.

?lnrs - This command returns the number of low noise reads to be taken per coadd on the next observation.

?mode - This command displays the data collection mode of the DSP worker nodes. Several modes are available for diagnostic and data taking purposes. The standard data taking mode is called "stare" mode.

?script - This command lists the available tcl scripts for the current instrument and observer.

?settime - This command gives the current integration time set into the instrument.

?spmode [channel] - This command reads the mode of a spad (Signal Processor/A2D) card and displays it in a human readable format. ?spmode will read out channel 0 and display the current settings. If a channel number or name is given, that channel will be read out instead.

(see spmode.)

?time - This command reports the time settings in the instrument as well as the minimum and curent integration time.

?ucode - This command returns the name of the currently downloaded code. The name returned may be wrong if the code was downloaded using the low level routines or has not been downloaded at all.

abort - This command halts teh current integration/observation and discards the data collected as a result of the observation.

activate - This command activates the detectors. This action takes place immediately. However, certain instruments ( CRSP , and IRIM ) require a button to be pushed befroe the array is activated. (see deactivate.)

ask - ask will ask all of the questions specified to be asked by ped. This command is called when the user types observe, before the observation starts.

The user can use the arrow keys to return to previous questions or move around on the line. Emacs-style cursor movement is also possible. The <TAB> key is used for command completion. If the user types <TAB> twice, then the available completions are displayed. For many of the questions a custom set of completions are installed, so this will list available options.

NOTE: the parameters set are NOT sent to the dspw, inst, b016, sequencer, they are for local use only until a sendParams is executed. Both go and observe execute sendParams .

(see ped, observe, go, sendParams.)

askMode [0|1|on|off] - This command sets the question asking mode. If the askMode is 0 or off, then the original style of questions will be asked, that is, the line buffer will contain the current (and default) value. If askMode is 1 or on then the default value will be placed in square brackets. If the user presses return, the default value will be used, otherwise the value typed in will be the new value. The default value can be inserted with a C-Y.

changes - This command gives a list of recent changes to the system.

checkdisk - This command will check the current header and pixel areas on the disk to determine if there is enough space to fit the images and their headers.

comment [new_comment] - This command resets the header COMMENT field to new_comment or prompts for a comment string if new_comment is empty.

coadds [numberofcoadds] - The coadds command will set the number of coadds to do on the next picture taken. If the command is executed without an argument, it will prompt the user for a new value, using the current value as the default.

dark - This command set the system up to take a dark. It sets the RA, DEC and Epoch to zero, and sets the type header field to "dark".

deactivate -This command deactivates the detectors. This command takes effect immediately.

(see activate.)

delay [seconds] - an alias for set-time.

(see set-time.)

display [channels ] - display controls which channels are displayed as they are saved. If no argument is given, display will prompt the user with the currently displayed channels. If no channels are specified (either by erasing all the channel names at the prompt or executing ' display "" ') then no channels will be displayed. On a system with only one channel, the channel name is " only ".

The display will be auto scaled unless the zs command has been used to set the upper and lower limits of the display values. (see zs )

NOTE: hitting <TAB> will cause " only " to be filled in at the prompt.

dl [ucodename] - This command is an alias for download.

download [ucodename] - Download will first kill off any microcode that is running and then download new microcode and start it running. If no name is given, download will prompt for a microcode filename, giving the current or default value as the default.

NOTE: hitting <TAB> <TAB> will list all microcodes available for the current instrument.

(see dl, luc, dsetup).

dsetup [microcodename] - dsetup will initialize the instrument voltages to their proper values and download the microcode. If no microcode name is given, a default code for the instrument will be used will be used.

(see download.)

eask - eask will iterate through all of the known parameters, allowing the user to specify which questions are asked and which parameters are displayed. For example:

List/Ask params(pics): l

List/Ask params(delaysec): la

List/Ask params(filename): a

The pics parameters will be listed, but not asked. The delaysec parameter will be listed and asked, and the filename parameter will be asked, but not displayed.

(see ped, ask, psave, ppar, lpar.)

filename [fileName] - filename sets the picture filename. The path is not included in the filename. A %d or %03d should be inserted where the picture number should be placed. If no %d is given, one will be appended. If there is more than one channel, a %s should be inserted somewhere AFTER the %d. If there is more than one channel and no %s exists in the filename, one will be appended.

NOTE: this will overwrite existing files if the filenames conflict.

(see headerdir, pixeldir, picNum, newImdir.

freeze [state] - freeze controls the activities of the instrument controller in regard to reading out the housekeeping data and allowing changes to operating voltages. freeze with no arguments will turn off the reading of housekeeping data and the setting of voltages. A freeze 0 will turn it back on. readhk , dsetup and setup will re-enable the reading of housekeeping data before they run.

(see unfreeze.)

go - go will perform an observation using the current setup. This command simply repeats the last observation or initiates a new observation based on the current parameter settings.

(see ask, observe)

headerdir [dirname] - headerdir sets the directory for IRAF image header files. If no directory is given, the current header directory will be used as a default. If an invalid directory is given, and error message will be displayed and the old setting will be used.

(see pixeldir, newImdir.)

help [topic] - The help command is used to get cross linked help on the IR user interface. All of the user commands are documented in the on-line help, and you can obtain information about them by typing:

help filename

If cross reference information is present, you will get a display like this at the bottom of the screen:

Cross Reference: headerdir newImdir picNum pixeldir


At this point, you can type in a related topic (the cross references are available for completion with <TAB> ). If no topic is given, help will terminate. help with no topic will give an interactive general overview. A keyword based index is available with the command:

help index

You will be prompted for a keyword (regular expressions are ok, and it is case insensitive).

Keyword: file

Cross reference: download eask ed editor filename headerdir headerhk help


helpw - activates a motif-like help interface.

hkscreen [screenname] - hkscreen controls which housekeeping screen is displayed when a readhk is executed. The screenname can be a number 0 - 4, or one of the following:

stat s volt v temp t filters f tlist

If no screenname is given, the user will be prompted for a new one with the current screen name as a default. This command performs a readhk to fetch the most recent data.

(see status, readhk.)

inttime [time] - inttime is the same as set-time.

(see set-time.)

lnrs [num] - lnrs sets the number of low noise reads per coadd. If no number is given, the user will be prompted for one and the current value will be used as the default.

loghkdata [on|off] - hksave enables or disables the logging of housekeeping data. By default, the data is not logged, and by default this command will save them. If the data is logged, then the time and date will be written to the log file, along with whatever is displayed on the screen.

longheaders on|off - longheaders enables or disables the saving of housekeeping voltage data in the IRAF header file. The saving is off by default.

lpar - lpar will list all of the available parameter files.

(see puse. ppar. psave.)

luc - luc will list all of the available microcode files.

(see download.)

microcode - download microcode. The user can download new "microcode" at runtime. To see a list of the available microcodes use the luc command. To download a new microcode simply type download microcodename .

(see luc, download.)

mode [channelmode]|[mode] - mode will change the processing mode for the given channel. Available modes are:

stare sep chop chop2

A specific channel name and mode can be given, or if there is only one channel, just a mode can be given. If no arguments are present, the user will be prompted for a mode, with the current mode as the default.

"chop" mode causes every other picture to be subtracted from the current one. Only a single image will result. " chop2 ", on the other hand will create three images, object, sky, and difference.

motor control - motors in each instrument are controlled by a set of commands all of which have the same general structure.

" Devicename" [to | for | whereis | ?pos | alloff | allon | reset]

[destination | duration ]

The device names are defined in the sections for each instrument some example commands are given below:

fpw to fpw1, fpw to fpwdark@r, fpw to 256 - these commands all have the same effect the COB focal plane wheel is moved to position 1, called the fpwdark@r, at position 256. As far as is possible all positions on wheels have a wheel position number i.e. fpw1 , a name i.e. fpwdark@r or k, and a position encoder value like 256. However in the case of lvf`'s, cvf's and similar continuous objects the encoder number or a wave length may be all there is to designate a position.

dso for 500 - energizes the Guider darkslide open solenoid for 500 ms.

lws whereis or lws ?pos - prints the current position of the COB lower slider.

crtl alloff | allon | reset - turns all motor controllers off, on or causes a software reset of the motor controller hardware. These commands are not generally needed in normal use. An observer may be asked to type one of these commands if a problem occurs and one of the engineers is debugging over the phone.

movie [channel] [numframes] - The "movie" command will take pictures continuously, displaying the given channel or channels listed in the display parameter to the screen. "movie" will not prompt for parameters, the user must have already set them using the various commands or ask. The picture number will not be incremented while running movie, only one file will be generated. The pictures taken in movie will not be archived in any way.

If no channel is specified, the user will be prompted for one. The user can also specify a number of frames to run, or forever (100000) if none is given. To stop the movie, type "end<return>", and it will end after the current picture has been taken.

(see ask, display.)

newImdir [dir] - newImdir will create the given directory if it does not already exist, and make a dir/pixels directory if that does not exist. Then it will change the headerdir to dir, and pixeldir to dir/pixels. Finally, it will cd to the given directory.

If no directory name is given, the user will be prompted for one, with the current headerdir as the default.

(see pixeldir, headerdir.)

nextpic [number] - nextpic will set the picture index number. If no argument is given, the user will be prompted for a new value and the current value will be used as the default.

observe - observe will first run ask to prompt the user for the various picture parameters, then it will take a picture. observe differs from go only in the fact that it prompts the user for the parameters before taking a picture.

(see ask, go.)

ped - ped will ask all of the parameter questions without regard to the askability of the question (see ask, eask, psave.)

pics [number] - pics sets the number of pictures to be taken at each observe/go. If no argument is given, the user will be prompted for a new value with the current value as the default.

pixeldir [dirname ] - pixeldir sets the directory for IRAF image pixel files. If no directory is given, the current pixel directory will be used as a default. If an invalid directory is given, and error message will be displayed and the old setting will be used.

(set headerdir, newImdir.)

plist - plist will list the current parameters. Same as ppar.

(see ppar.)

ppar [showNames] - ppar will list the current parameters that should be listed (see eask). If an argument (any value other than 0) is given, ppar will show the parameter name associated with the parameter.

(see eask.)

psave [parameterfile] - psave will save the current parameter set (values and ask/display flags for questions) into a file that can be loaded at a later date using puse. If no filename is given, the current parameter file will be used.

(see puse, lpar.)

puse [parameterfile] - puse will load the given parameter file. If nor parameter file is given, the user will be prompted for one, with the current file as the default.

(see lpar.)

raster9 - this command takes 18 pictures (9 on object, 9 on sky) in a three by three grid. The size of the pattern, the distance to the sky are requested from the user before the pattern starts.

readhk - readhk will read out the current housekeeping data from the instrument and display the current screen.

(see status hkscreen.)

resetoffset - This command resets the telescope offset value in the IRAF picture header to 0, 0.

run - run will take the detector out of sdt mode.

NOTE: the user should wait as long as the integration time before attempting to take a picture. Bogus data may result from the next go/observe otherwise.

script [scriptName] - script will run a given script file. If no script file is specified the user will be prompted for one.

(see lsc.)

sdt - sdt will put the detector in sdt (simulated data take) mode.

(see run.)

sendParams - sendParams will send the current parameters to the b011, inst, and dspws.

seqStat - read out the number of coadds and lnrs information from the sequencer.

seqTime - list the time values from the sequencer.

set-time [integration_time] - set-time will set the integration time in seconds. Fractional seconds will be honored down to the millisecond. If the command has no argument the user will be prompted for a new integration time and the current time will be used as a default.

(see delay inttime.)

setparams parametername [value] - setparams is a wrapper for all of the parameter setting commands. The following parameters may be set through this procedure:

airmass, coadds, comment, dec, delaysec, display, epoch, filename, headerdir, lnrs, mode, offset, picnum, pics, pixeldir, ra, type, ucode.

(see pics lnrs coadds delay filename headerdir pixeldir mode picnum.)

setdoff spadnumber value - setdoff sets the data offset voltage for a single spad card given by spadnumber. The values can range from -5.0 to 5.0 volts. These values remove column chop due to array and electronics differences. The default values in setup are carefully chosen to give the best observing results.

(see setup dsetup setvoff.)

setup parameterset - this command sets up the system with the values in the named parameter set. In addition it loads the default microcode, sets the appropriate default voltages and asks if the user would like to activate the array.

(see dsetup, ucode, parameters.)

sky - This command will set the type to sky and ra, dec, and epoch to 0.

spmode card type value -- set the operation mode for the Signal Processor/A2D (spad) cards. " spmode " will set the mode for a given card. The allowable modes and corresponding values are: mode - efilt, values - f1, f7; 15, mode - gain, values - k1, k2; mode - mref, values - on, off; mode - lights, values - on, off.

standard - sets up the instrument system headers to take a standard.

status [screenname] - status is the same as hkscreen.

(see hkscreen.)

tcl - overview of tcl. not yet included

tcpon - This command turns on the requesting and saving of tcp header information. The following values are saved in each image header:


tcpoff - this command disables the requesting and saving of tcp header information.

title [image title] -- This command changes the title field for new images. If using iraf "imhead" command the title parameter will appear as:

test000h[256,256][real]: title parameter

If no title is given then the user is prompted for a new title.

unfreeze - an alias for freeze 0

zs z1 z2 - set zscale values for IRAF display. zs will set the zs values that the instrument controller display uses when displaying an image. If the values are 0 and 0 (the default) autoscaling is enabled.

[Return to main page ] [ Go to previous page ] [ Go to next page ]

National Optical Astronomy Observatories, 950 N. Cherry, PO Box 26732, Tucson, AZ 85726, Phone: 520-318-8000, FAX: 520-318-8360

Posted: 23Mar98