#******************************************************************************
# E.S.O. - VLT project
#
# "@(#) $Id: dicVIRCAM_HOWFS.txt,v 0.7 2004/07/29 12:05:29 vltsccm Exp $"
#
#
# who       when      what
# --------  --------  ----------------------------------------------
# sbeard    09/07/03  Copied to VIRCAM
# sbeard    12/02/03  New dictionary for HOWFS
# sbeard    15/01/04  Renamed from _WFS to _HOWFS
# sbeard    21/07/04  Added HOWFS keywords provided by Nirmal Bissonauth
#                     (with shortened comments)
# sbeard    27/08/04  Added HOWFS.DATE keyword.
#

#******************************************************************************
#******************************************************************************
#
# The VIRCAM_HOWFS dictionary contains all keywords used by VIRCAM WFS at
# runtime to execute and understand commands with -function option,
# such as SETUP and STATUS.
#
# IMPORTANT NOTE: The "Value Format" entry defines the precision of
#                 the keyword value, following the ANSI-C printf
#                 rules. Specially for float or double numbers,
#                 roundings are possible and affects all commands,
#                 in particular SETUP and STATUS.
#                 In order to avoid undesired roundings, the
#                 appropriate precision must be defined in this field.
#
#******************************************************************************

#
# Notes
# 1)The letters within ()indicate the Class that keyword belongs to:
#    c = config
#    h = header
#    l = conf-log
#    p = private
#    s = setup
#    o = ops-log
#

DICTIONARY VIRCAM_HOWFS "VIRCAM" "VISTA IR Camera Wavefront Sensing keywords"
REVISION		"$Revision: 0.7 $"
CONTEXT			"Instrument"


# 2.2 ICS setup and header
#
HOWFS.ID	%30s	Wavefront sensor ID (chl)

#
# HOWFS dictionary provided by Nirmal Bissonauth
#

HOWFS.PUPDIA		%f	Pupil Diameter [m] (c)
HOWFS.DEFOCUS		%f	Image Defocus [mm] (c)
HOWFS.OBSRATIO		%f	Central obscuration ratio (c)
                                Central obscuration ratio with respect
                                to pupil diameter
HOWFS.IMGSIZE		%d	Image size [pixels] (c)
HOWFS.PSCALE		%f	Plate scale [um] (c)
HOWFS.INTRATIO		%f	Intensity ratio (c)
                                Intensity ratio between defocused
                                images due to beam splitter
HOWFS.GRIDSIZE		%d	Ray grid size (c)
                                Grid size of rays used by raytracer
HOWFS.SUBGDSZ		%d	Sub grid size (c)
                                Subdivision of rays
HOWFS.NAMEMODi		%s	Mode to fit (c)
HOWFS.TYPEMODi		%d	Type of mode (c)
                                Zernike or Elastic
HOWFS.SYMMODi		%d	If T, symmetric mode (c)
                                Is this a symmetic mode? i.e. cos and
                                sin terms
HOWFS.ORDMODi		%d	Order of mode (c)
HOWFS.NULLFILE		%s	Null aberration file (c)
                                File containing null values for the
                                aberrations against radius
HOWFS.NULLEN		%c	If T, use null aberrations (c)
HOWFS.NULLSUB		%c	If T, subtract null aberrations (c)
HOWFS.MAXRTOL		%f	Max. Relative Tolerance (s)
HOWFS.MAXITR		%d	Max. Iteration Count (s)
                                Maximum Iteration Count of simplex
                                algorithm
HOWFS.PREBLUR		%c	If T, blur images (s)
                                Flag to indicate whether observed
                                images must be blurred
HOWFS.USEMODi		%c	Use mode i (s)
                                Indicator to fit mode
HOWFS.IMGFILE		%s	Image file (s)
                                File containing defocused images
HOWFS.DARKFILE		%s	Dark file (s)
                                File containing a dark image
HOWFS.FLATFILE		%s	Flat-field file (s)
                                File containing a flat-field image
HOWFS.COFILE		%s	Coefficients file (s)
                                File to store measured coeffs in with
                                additional data
HOWFS.BADMASK		%s	Bad pixel file (s)
                                File containing mask with bad pixels
                                indicated
HOWFS.OBSOFF.X		%f	Obscuration offset in X [mm] (hs)
                                Offset of the central obscuration in X
                                direction
HOWFS.OBSOFF.Y		%f	Obscuration offset in Y [mm] (hs)
                                Offset of the central obscuration in Y
                                direction
HOWFS.STARPOS.X		%f	Star position in X [mm] (hs)
HOWFS.STARPOS.Y		%f	Star position in Y [mm] (hs)

HOWFS.IMGANGLE		%f	Image Axis angle [degrees] (hs)
HOWFS.FRSTIMG.X		%f	First image X [pixels] (hs)
                                Detector X co-ordinate of centre of
                                first defocused Image
HOWFS.FRSTIMG.Y		%f	First image Y [pixels] (hs)
                                Detector Y co-ordinate of centre of
                                first defocused Image
HOWFS.IMGDIST		%f	Distance between images [pixels] (hs)
                                Distance between defocused images on
                                detector
HOWFS.STRTPNT.MODMODEi	%f	Starting modulus [nm] (s)
                                Starting value of the modulus for the
                                simplex algorithm
HOWFS.STRTPNT.ANGMODEi	%f	Starting angle [degrees] (s)
                                Starting value of the angle for the
                                simplex algorithm
HOWFS.BIAS.MODMODEi	%f	Bias modulus [nm] (s)
                                Bias Modulus to apply for this mode
HOWFS.BIAS.ANGMODEi	%f	Bias angle [degrees] (s)
                                Bias angle of this mode

# Additional keyword suggested by Will Sutherland

HOWFS.DATE              %s      Date/Time of new coeffs (h)
                                Date/Time at which the most recent HOWFS
                                measurement was made.

#___oOo___