Command Line Interface To The Hydra Instrument
Obsolete replaced by User Interfase??
The Command Line Interface to the Hydra CTIO instrument is the whole set of commands available to the user from the Command Line Tool. These commands perform a variety of tasks and together give the user complete control over the intrument and its functionality.
Here is the list of commands with a short description of what they do and their arguments.
1) Initialization Commands
coldstart
Initialize the motors, find the home positions for the X, Y, and Z axes and resets the encoder to correspond to the center of the focal plate.
home axis
This procedure homes the specified axis and reset the zero point. Available axes are xy, x, w, y, z and gripper. Be aware that homing x, y or w individually *doesn't ensures orthogonality*. Also remember that if x and w are not electrically geared then the gantry can run out of the orthogonal limits.
minit axis
This procedure initialize the specified axis. Available axis are xy, x, y, w, z, gripper. Although you can call x, y or w individually there's only one embedded galil function for initializing the x/y gantry system. This means that no matter you specified x, y or w you will also initialize the other two axes too.
2) Go Commands
brakes option
Turn the stage brakes on or off. Multiple ways for giving the same order are allowed. To lock the brakes use lock/on/1 as argument. To unlock the brakes use unlock/off/0.
gox x ?vel? ?accel? ?sys?
Move the gripper to the specified position in x leaving the y position the same. Used defaults for the one's that are not supplied in the command line.
goy y ?vel? ?accel? ?sys?
Move the gripper to the specified position in y leaving the x position the same. Used defaults for the one's that are not supplied in the command line.
goxy x y ?vel? ?accel? ?sys?
Move the gripper to the specified position. Used defaults for the one's that aren't supplied in the command line.
gotag tagid
This procedure move the x/y gantry system to the location recorded in the specified tag.
Move the Z axis to the specified position. Use defaults for missing arguments. The units for position are encoder steps.
Power up and bring in the gripper.
This procedure moves the gripper to its stow position. If running under real mode then check for button presence and warn if a button is in the gripper.
tag id ?x? ?y?
This procedure tag the specified location for future reference. It receives as arguments a tag id and an optional coordinate. If only the id is specified by the user, then the current gripper location is taged. The coordinates are x,y sky coordinates.
view name/number ?type?
This procedure let the user view the specified button/object/slit by moving the x/y gantry system to that position. If no type is specified then it will be assumed that the number correspond to a fiber number. Valid names are characters identifying FOPS. Valid type specifiers are "o" for object, "f" for fiber, "s" for slit and "P" for FOPS.
3) Gripper Commands
Open the gripper to its normal open position.
Open the gripper to its relaxed position.
Close the gripper.
Open the gripper to its wide open position.
Test the gripper functionality and return a report.
4) Offset Commands
abump amount direction
Nudge the gripper by the specified amount of arcseconds in the specified cardinal direction. Valid directions are "w", "e", "n" and "s".
bump amount direction
Nudge the gripper by the specified amount of steps in the specified cardinal direction. Valid directions are "w", "e", "n" and "s".
offset dx dy ?vel? ?accel?
Incrementally offset from the current position. Substitute default values for missing arguments.
5) Button Commands
Put down a button (if there is one...) at the current location. If the fiber in trouble structure is not empty, calculate and record new information for that fiber.
mark button
This procedure let the user view a button an mark it as the button to be remembered when later you decide to correct the button.
move button x y ?deadzone?
Move a button to the specified location.If the difference beetwen the current location of the button and its target position is smaller than the specified deadzone then the button is assumed to be at the target position.
park button
Move a button to its parked position.
Handle failures to grab and drop buttons and it helps to identify unknown buttons in the gripper.
ThisIs button
Bring the specified button to the current gripper location. This routine is used to tweak button positions to corrected coordinates interactively.
unstow button
Move the button specified in the argument from its stow position to its park position. If the specified button happens to be the current button in troubles then its trouble condition is cleared.
6) Field Commands
aload filename
Load a star field. It first looks for it in the directories in environment variables FIBFIELDS and STDFIELDS. If this variables are not defined attempt loading the file using filename as a complete path/filename name.
assign userid button
Attempt to assign the specified object to a button. If the assignment is valid then the button is moved to the object position. The userid corresponds to the id given by the user to each one of the objects of the star field.
configure filename
This procedure configure the star field in file filename.
config1 id x y
This function is much like procedure "configure" except that it takes as an argument a fiber and a coordinate which it passes on to the transition program. This procedure always leave unused fibers alone.
preview first last time
This procedure view the set of objects whoes internal id are beetwen the "first" and "last" specified values. It waits for "time" seconds to get to the next object.
save filename
This procedure save the currently loaded field including tweaks, unassignments, etc been made.
setup field
This command step the astronomet through the field configuration process in order to simplify the instrumental configuration. For a complete description read "The Setup Field Command".
7) Mode Commands
configmode boolean
This procedure turns the configuration flag on or off. correct Bring the "current" button to the current gripper location. The current button is the last one that was moved or viewed. In some cases, there may not be a current button. This routine is used to tweak button positions to corrected coordinates interactively.
concenmode boolean
Turn the button concentricity correction on/off.
flexmode boolean
Turn the gravitational flexure mapping on or off.
thermmode boolean
Turn the thermal expansion correction on or off.
scalemode boolean
Turn the stage characteristic curve mapping on or off.
8) Communication Commands
lit ?arg arg ...?
This procedure sends its argument list directly to the controller and return just the controller first answer.
This procedure performs a simple test to check communcation towards the Galil Box. It sends a TP command and shows the response. This is the procedure suggested by the vendor to test communications. With good communications you would expect to get a bunch of numbers indicating the current motor positions.
9) Set Commands
dangle declination
Set the global variable that holds the declination angle. This value is used in flexure calculations.
hangle hourangle
Set the global variable that holds the hour angle. This value is used in flexure calculations.
setcable cable
Set the current cable to the specified cable.
thermval val
Set the instrument temperature to the specified value.
10) Report Commands
This procedure will open an xterm terminal to show the current session log file.
listdump mode
This procedure when called with argument mode set to "i" dump the iraf file for the currently loaded field and eventually tell the gwc world that it just made it. If called with argument mode set to "c" then dump the currently loaded field to disk and open an xterm running the view program displaying the file contents.
listtag tagid
This procedure will print the coordinates in the tag entry for the specified tag id.
Print a summary of the system status. This summary include the current exposure information and the correction flags that are currently working.
Return a the encoder positions and corrections.
whereis name/number ?type?
This procedure returns the location of the specified fiber, object, slit or FOPS. The first argument for this procedure can be either an alpha character or an integer. If an alpha character (A, B, C ...) the argument is supposed to be a FOP. If an integer the argument is supposed to be a fiber. A second optional argument can be added to specify what is this integer identifying. Type "f" for fiber, "o" for object and "s" for slit.
11) Database Commands
Close, compress, and re-open the position archive.
Restore the internal database of button locations from the disk file.
xparked button
This procedure force the software to update a button location to be the parked position.
xstowed button
This procedure force the software to update a buttons location to be the stowed position. If the specified button happens to be the current button in troubles then its trouble condition is cleared.
zdb option
This procedure will zero the database to either stowed or parked position. Set argument position to "parked" to zero to park position and "stowed" to zero to stowed position.
12) Diagnosis Commands
List the Galil Box Input assignments
Show the current status of Galil Box switches.
Display a window showing the Galil Box inputs.
Display a window showing the Galil Box switches.
13) Miscelaneous Commands
Source the specified script.
complamp off|tha|etalon|pen|qua|hene
Turn the complams system on/off.
led option ?arg?
This command let the user turn the bank of LEDs on/off and set the current intensity for the light of the LEDs. To turn the LEDs on set argument option to "on". To turn the LEDs off set argument option to "off". To set the current intensity set argument option to "illum" and specify the desired intensity with a number from 1 to 3.
help
Dump the current list of commands and a short description.
plate boolean
Flat/warp the focal plate.
This command exits the application cleanly saving all what has to be saved and leaving the system in a known state.
Last Modified: March 23, 1999
Printer-friendly version