dice5_collect

;=========================================================
;
; DICE5_COLLECT
;
;=========================================================
;
;   This routine collects a set of data needed to determine the offset
; accuracy of the telescope.  This accuracy depends mainly on the
; accuracy of the AGw transformation from the Telescope's PCS_XY focal plane
; coordinates and the XY coordinates of the AGw guide probe.
;
;   This routine will work for focal stations with either the IRTC or
; MODS camera at the science focus.  Lucifer has not yet been
; installed, and it is not know if command line requests are
; available to acquire a Lucifer image.
;
;   The steps need to collect dice2 offset accuracy data are:
;
; 1) Preset the telescope in ACTIVE mode
; 2) Allow the telescope to collimate
; --- run this dice5_collect routine
; 3) Set all offsets (RADEC, DETXY) to 0,0
; 4) Offset in the desired coordinates 30,0
; 5) Acquire a dark frame
; 6) Loop over the number of iterations
;    7) Loop over the dice5 offset positions
;       a) Start on-axis camera acquisition
;       b) Monitor collimation until rms error is below the specificed value
;       c) Monitor when on-axis camera acquisition has completed.
;    End Loop
; End Loop
; 8) Write out TWiki and dice5_process_set file named set*_"dist"_dice5.log
;
; ** NOTES **
;
; - Usually this routine does not need any interaction to proceed.
;   However, if the collimation is slow, then a message box may pop up
;   and say "Not collimated below...".  Click "Yes" to continue
;   collimating and "No" to proceed to the next off-axis star
;
;---------------------------------------------------------
;
; Example:
;
; % cd /OldRepository/AGW_Data
; % mkdir -p 20101222/dice5/set1
; % cd 20101222/dice5/set1
; % IDL
; IDL> agw_set_station, IRTC
; IDL> dice5_collect, logname, retval, DIST=5.0, ITER=5
;
; To add flags:
;
; IDL> dice5_collect, logname, retval, DIST=5.0, ITER=5, /DETXY, $
;           EXP=1.0, NUM=15
;
;-----------------------------------------------------------
;
; Routine Call:
;      dice5_collect, logname, retval, DIST=dist, ITER=iter, DETXY=detxy, EXP=exp, NUM=num, $
;                   LIMIT=limit, DEBUG=debug, TEST=test, VERBOSE=verbose
;
; Inputs:
;          DIST=dist  Offset distant from the center position in arcsec
;          ITER=iter  Number of dice5 iterations
;
; Optional Inputs:
;             /DETXY  Make offsets in DETXY coordinates.  The default is RADEC.
;        LIMIT=limit  Indicate the collimation limit, in nm, required
;                       before presetting to the next guide star.  If no
;                       value is given, 400 nm is used.
;             /DEBUG  The script writes out extra infomation to the terminal
;              /TEST  Commands are sent neither the TCS nor the
;                       camera.  This allows the script and .list file
;                       to be tested off-line.
;           /VERBOSE  Prints out the full Active Optics collimation
;                       information.  By default the Adaptive Optics
;                       only prints the WaveFront RMS in nm.
;            NUM=num  Number of IRTC images to acquire.  By default,
;                       30 images are acquired.  This is not relavant
;                       for MODS, as only one image is ever acquired.
;            EXP=exp  Exposure time in seconds for the IRTC images.
;                       This is not relavant for MODS, as the exposure
;                       time is set on the MODS user interface.
;
; Return:
;            logname: Name of the file written containing all the
;                       information needed by dice5_process_set to
;                       analyze these transformation data.  This file is
;                       named set*_"dist"_dice5.log.
;             retval: 0/1 for succuess/failure
;
; Return:
;

pro dice5_collect, logname, retval, DIST=dist, ITER=iter, DETXY=detxy, EXP=exp, NUM=num, $
                    LIMIT=limit, DEBUG=debug, TEST=test, VERBOSE=verbose

-- DougMiller - 22 Dec 2010
Topic revision: r3 - 25 Jul 2014, DouglasFisher
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback