NAME
positionWFSprobe - To position the WFS probe on a guide star
SYNOPSIS
positionWFSprobe [-i|-h] [-verbose]
-target "<science object position>"
-guidestar "<guide star position>"
DESCRIPTION
positionWFSprobe is a script executed from the command line
which will allow the caller to position the WFS probe over a
guide star which is currently within the limits of the WFS
patrol field.
The caller provides the position in the sky of two objects,
one the science object and the other the guide star. The
script then calculates the offset to be applied to the WFS
probe in order to position the WFS probe over the guide
star. The offset in both the x and y position from the sci-
ence object (which is assumed to be at the centre of the
probe patrol field) must be within the 2.9 arcmin sq patrol
field of the probe otherwise an error will be produced. The
script takes into account the current SkyPA of the telescope
and modifiying the transformation coordinates of the pickoff
probe accordingly.
It should be noted that the WFS probe cannot be moved whilst
the WFS control loop is closed.
After the calculation of the offset, the script in turn
passes a request onto the NAOMI data server which in turn
requests the NAOMI sequencer to offset the probe. See the
ENVIRONMENT section for details on how to specify the name
of the host which has the NAOMI data server running upon it.
OPTIONS
The command line options that the program accepts are
detailed below.
-guidestar
This is a mandatory option and is used to specify the
position of the guide star. The position should be
specified in the following format; "HH MM SS DD MM SS
J2000". Note that the quotes are mandatory and the
script will fail if they are not specified.
-target
This is a mandatory option and is used to specify the
position of the science object. The position is speci-
fied in the following format "HH MM SS DD MM SS J2000".
Note that the quotes are mandatory and the script will
fail if they are not specified.
-h Print usage information about the application.
-i Print usage information about the application.
-verbose
Request that the script produces verbose output
RETURNS
The script returns the following codes after execution.
0 - Command completed successfully
This code is returned when the command is successfully
executed.
1 - Command failed
The command has failed to be executed by the sequencer,
further information will be displayed.
2 - Command timed out
The command has failed to complete in the allocated
time allowed.
3 - The target position has been incorrectly specified
The position of the science object has not been speci-
fied correctly.
4 - The guide star position has been incorrectly specified
The position of the guide star has not been specified
correctly.
5 - The target position has not been specified
The user has not specified a science object on the com-
mand line.
6 - The guide star position has not been specified
The user has not specified a guide star on the command
line.
7 - Unable to calculate offset for these two objects
The internal calculation of the offset has failed.
Unlikely but if it occurs it indicates a serious logic
error.
8 - Unable to execute SetProbe command in NAOMI sequencer
The script was unable to set the probe position. This
may be for a number of reasons such as the EPMDa-
taServer is not running on the host that the script it
is expecting to be running. Alternatively, it may be
due to fact that the NAOMI low level control software
is not actually running.
20 - No command status returned by the NAOMI sequencer
No command status has been returned by the NAOMI
sequencer so it is impossible to deduce the status of
the command.
ENVIRONMENT
The script is aware of the following environment variables.
NAOMIHOST
If the NAOMIHOST environment variable is set, this will
be used by the script to establish the location of the
NAOMI data server. By default, the NAOMI data server is
expected to found on the navis.ing.iac.es.
TCLLIBPATH
This should be set to include the directories which
contain the WHT OCS support classes. This is done by
default from the whtobs account.
SEE ALSO
EPMDataServer(1)
AUTHOR
Craige Bevil (cb@ing.iac.es)
Man(1) output converted with
man2html