7 EXAMPLES

This chapter contains examples and manual pages taken from the template instrument XXXX, and in particular from modules xxoseq, xxotsf, xxmseq, xxmtsf.

7.1 Template Signature Files

7.1.1 Example of Acquisition Template

#************************************************************************
# E.S.O. - VLT project
#
# "@(#) $Id: XXXX_optimg_acq.tsfx,v 1.13 2003/03/11 08:54:45 vltsccm Exp $"
#
# XXXX_optimg_acq.tsf
#
# who when what
# ---------- -------- ---------------------------------------------
# alongino 10/10/00 created
#
#************************************************************************
# NAME
# XXXX_optimg_acq - XXXX Acquisition Template signature file
#
# SYNOPSIS
#
#
# DESCRIPTION
#
# Target acquisition : presetting to coordinates
#
# FILES
#
# ENVIRONMENT
#
# RETURN VALUES
#
# CAUTIONS
#
# EXAMPLES
#
# SEE ALSO
#
# BUGS
#
#------------------------------------------------------------------------
#

PAF.HDR.START; # Marks start of header
PAF.TYPE "Template"; # Type of parameter file
PAF.ID "$Id: XXXX_optimg_acq.tsfx,v 1.13 2003/03/11 08:54:45 vltsccm Exp $";
# Parameter file ID
PAF.NAME "XXXX_optimg_acq"; # Parameter file NAME
PAF.DESC "Open loop pointing";
PAF.CRTE.NAME "A.Longinotti"; # Who created par. file
PAF.CRTE.DAYTIM "10/10/2000 12:00"; # Date and time of creation
PAF.LCHG.NAME "A.Longinotti"; # Who did last change
PAF.LCHG.DAYTIM "10/10/2000 12:00"; # Date and time of last change
PAF.CHCK.NAME ""; # Appl. checking par. file
PAF.CHCK.DAYTIM ""; # Date and time of last check
PAF.CHCK.CHECKSUM ""; # Parameter file checksum
PAF.HDR.END

TPL.INSTRUM "XXXX"; # This is a template for TC
TPL.MODE ""; # Valid for all modes
TPL.VERSION "$Revision: 1.13 $"; # (any string)
TPL.REFSUP "XXXX_acq.ref"; # Reference setup file
TPL.PRESEQ "XXXX_acq.seq"; # Sequencer script
TPL.GUI ""; # GUI panel
TPL.TYPE "acquisition"; # science, calib, test, acquisition
TPL.EXECTIME "180"; # can be "computed" or a number
TPL.RESOURCES ""; # List of param. names: req. resources

PAF.INCLUDE "xxotsfINS_MODE.tsfx"; # include INS.MODE
INS.MODE.VALUE "OPT_IMAGING";

PAF.INCLUDE "xxotsfTEL.tsfx"; # include TEL keywords
TEL.PRESET.NEW.VALUE "_tpl_suppress_";

#___oOo___

7.1.2 Example of Observation Template

#************************************************************************
# E.S.O. - VLT project
#
# "@(#) $Id: XXXX_optimg_obs_exp.tsfx,v 1.13 2003/03/11 08:54:44 vltsccm Exp $"
#
# XXXX_optimg_obs_exp.tsf
#
# who when what
# ---------- -------- ---------------------------------------------
# alongino 10/10/00 created
#
#************************************************************************
# NAME
# XXXX_optimg_obs_exp.tsf - XXXX Observation Template signature file
#
# SYNOPSIS
#
#
# DESCRIPTION
#
# normal exposure
#
# FILES
#
# ENVIRONMENT
#
# RETURN VALUES
#
# CAUTIONS
#
# EXAMPLES
#
# SEE ALSO
#
# BUGS
#
#------------------------------------------------------------------------
#

PAF.HDR.START; # Marks start of header
PAF.TYPE "Template"; # Type of parameter file
PAF.ID "\$Id: XXXX_optimg_obs_exp.tsfx,v 1.13 2003/03/11 08:54:44 vltsccm Exp $"; # Parameter file ID
PAF.NAME "XXXX_optimg_obs_exp"; # Parameter file NAME
PAF.DESC "XXXX single exposure";
PAF.CRTE.NAME "A.Longinotti"; # Who created par. file
PAF.CRTE.DAYTIM "10/10/2000 12:00"; # Date and time of creation
PAF.LCHG.NAME "A.Longinotti"; # Who did last change
PAF.LCHG.DAYTIM "10/10/2000 12:00"; # Date and time of last change
PAF.CHCK.NAME ""; # Appl. checking par. file
PAF.CHCK.DAYTIM ""; # Date and time of last check
PAF.CHCK.CHECKSUM ""; # Parameter file checksum
PAF.HDR.END

TPL.INSTRUM "XXXX"; # This is a template for XXXX
TPL.MODE "SKY"; # Observation in the sky
TPL.VERSION "$Revision: 1.13 $"; # (any string)
TPL.REFSUP "XXXX_optimg_obs_exp.ref"; # Reference setup file
TPL.PRESEQ "XXXX_optimg_obs_exp.seq"; # Sequencer script
TPL.GUI ""; # GUI panel
TPL.TYPE "science"; # science, calib, test, acquisition
TPL.EXECTIME "computed"; # can be "computed" or a SEQ.number
TPL.RESOURCES "FILTER"; # List of param. names: req. resources

PAF.INCLUDE "xxotsfSCCD.tsfx";
PAF.INCLUDE "xxotsfINS_FILT.tsfx";

#___oOo___

7.1.3 Example of Calibration Template

#************************************************************************
# E.S.O. - NTT project
#
# "@(#) $Id: XXXX_optimg_cal_bias.tsfx,v 1.13 2003/03/11 08:54:44 vltsccm Exp $"
#
# XXXX_optimg_cal_bias.tsf
#
# who when what
# ---------- -------- ---------------------------------------------
# alongino 23/10/00 created
#
#************************************************************************
# NAME
# XXXX_optimg_cal_bias.tsf - XXXX Calibration Template signature file
#
# SYNOPSIS
#
#
# DESCRIPTION
#
# SEQ.NEXPO XXXX Biases or Darks
#
# FILES
#
# ENVIRONMENT
#
# RETURN VALUES
#
# CAUTIONS
#
# EXAMPLES
#
# SEE ALSO
#
# BUGS
#
#------------------------------------------------------------------------
#

PAF.HDR.START; # Marks start of header
PAF.TYPE "Template"; # Type of parameter file
PAF.ID "$Id: XXXX_optimg_cal_bias.tsfx,v 1.13 2003/03/11 08:54:44 vltsccm Exp $";
# Parameter file ID
PAF.NAME "XXXX_optimg_cal_bias"; # Parameter file NAME
PAF.DESC "XXXX FIERA biases or darks";
PAF.CRTE.NAME "A.Longinotti"; # Who created par. file
PAF.CRTE.DAYTIM "10/10/2000 12:00"; # Date and time of creation
PAF.LCHG.NAME "A.Longinotti"; # Who did last change
PAF.LCHG.DAYTIM "10/10/2000 12:00"; # Date and time of last change
PAF.CHCK.NAME ""; # Appl. checking par. file
PAF.CHCK.DAYTIM ""; # Date and time of last check
PAF.CHCK.CHECKSUM ""; # Parameter file checksum
PAF.HDR.END

TPL.INSTRUM "XXXX"; # This is a template for XXXX
TPL.MODE "CALIB"; # Calibration Template
TPL.VERSION "$Revision: 1.13 $"; # (any string)
TPL.REFSUP "XXXX_optimg_cal_bias.ref"; # Reference setup file
TPL.PRESEQ "XXXX_optimg_cal_bias.seq"; # Sequencer script
TPL.GUI ""; # GUI panel class
TPL.TYPE "calib"; # science, calib, test, acquisition
TPL.EXECTIME "computed"; # can be "computed" or a number
TPL.RESOURCES ""; # List of param. names: req. resources

PAF.INCLUDE "xxotsfSEQ.tsfx";
PAF.INCLUDE "xxotsfSCCD_DIT.tsfx";
DET1.WIN1.UIT1.DEFAULT "0";

#___oOo___

7.2 Template Scripts

7.2.1 Example of Acquisition Template Script

# -*- tcl -*-
#************************************************************************
# E.S.O. - VLT project
#
# "@(#) $Id: XXXX_acq.seq,v 1.9 2001/03/15 17:28:14 vltsccm Exp $"
#
# XXXX_acq.seq
#
# who when what
# -------- -------- ---------------------------------------------
# alongino 23/10/00 created
#

#************************************************************************
# NAME
# XXXX_acq.seq - XXXX Acquisition Template script
#
# SYNOPSIS
# XXXX_acq.seq pAr obsInfo
#
# DESCRIPTION
# Moves the telescope to required position.
#
# FILES
# XXXX_acq.ref - list of constant parameters of the template
#
# RETURN VALUES
# Moves telescope to preset position.
#
# CAUTIONS
# Moves telescope: Maximum care is required.
#
# EXAMPLES
#
# SEE ALSO
#
# BUGS
#
#------------------------------------------------------------------------
#
proc XXXX_acq { parArrays obsInfo } {
#
# begin
#
foreach parArray $parArrays {
upvar $parArray $parArray
}
catch { delete object obs }
catch { delete object tcs }
tplOBS obs xxo
tplTCS tcs TCS xxo tcs NA XXXX
tplLog "Starting acquisition."

#
# check that TCS is used
#
if { [tcs IsUsed] == 0 } {
tplLog "Warning: TCS is not available. No commands are sent to TCS."
}

#
# preset telescope and set instrument mode
#
obs Setup "-file $TPL(REFSUP) -function \
INS.MODE $INS(MODE) \
TEL.TARG.ALPHA $TEL(TARG.ALPHA) \
TEL.TARG.DELTA $TEL(TARG.DELTA) \
TEL.TARG.EQUINOX $TEL(TARG.EQUINOX) \
TEL.ROT.OFFANGLE $TEL(ROT.OFFANGLE) \
TEL.TARG.ADDVELDELTA $TEL(TARG.ADDVELDELTA) \
TEL.TARG.ADDVELALPHA $TEL(TARG.ADDVELALPHA) \
TEL.TARG.EPOCH $TEL(TARG.EQUINOX) \
TEL.TARG.TYPE COORDINATE"

#
# preset guide probe
#
checkAbortFlag
if { $TEL(TARG.ADDVELDELTA) == 0 && $TEL(TARG.ADDVELALPHA) == 0 } {
if { $TEL(GS1.ALPHA) != 0 || $TEL(GS1.DELTA) != 0 } {
obs Setup "-function TEL.GS1.ALPHA $TEL(GS1.ALPHA) \
TEL.GS1.DELTA $TEL(GS1.DELTA) \
TEL.TARG.TYPE NO_TARGET"
}
}

#
# wait for AO and autoguiding
#

checkAbortFlag
if { [tcs IsAgActive -wait] == 0 } {
error "Autoguiding not started."
}

checkAbortFlag
if { [tcs IsAoActive -wait] == 0 } {
error "Active optics not started."
}

tplLog "Acquisition template finished."
return {}
}

#___oOo___

7.2.2 Example of Observation Template Script

#************************************************************************
# E.S.O. - VLT project
#
# "@(#) $Id: XXXX_optimg_obs_exp.seq,v 1.25 2003/01/16 11:22:47 vltsccm Exp $"
#
# XXXX_optimg_obs_exp.seq
#
# who when what
# -------- -------- ---------------------------------------------
# alongino 11/10/00 created
#

#************************************************************************
# NAME
# XXXX_optimg_obs_exp - XXXX Observation Template script
#
# SYNOPSIS
# XXXX_optimg_obs_exp pAr obsInfo
#
# DESCRIPTION
# Optical Imaging XXXX observation template.
#
# - setup TEL+INS+DET with XXXX_optimg_obs_exp.ref setup file
# - setup INS+DET according to <pAr> parameter array
# - start and wait exposure
#
# FILES
# XXXX_optimg_obs_exp.ref - list of constant parameters of the template
#
# ENVIRONMENT
#
# RETURN VALUES
# 1 image frame
#
# CAUTIONS
# Exposes CCD: take care with light.
#
# EXAMPLES
#
# SEE ALSO
#
# BUGS
#
#------------------------------------------------------------------------
#

proc XXXX_optimg_obs_exp { parArrays obsInfo } {

foreach parArray $parArrays {
upvar $parArray $parArray
}

catch { delete object obs }
catch { delete object dcs }
tplOBS obs xxo
set dcsFullName [namespace current]::[tplFIERA dcs fiera FIERA 3]
set funcSetup "DPR.CATG SCIENCE \
DPR.TECH IMAGE \
DPR.TYPE OBJECT \
[dcs ExpTime] \
DET3.WIN1.ST $DET3(WIN1.ST) \
DET3.WIN1.STRX $DET3(WIN1.STRX) \
DET3.WIN1.STRY $DET3(WIN1.STRY) \
DET3.WIN1.NX $DET3(WIN1.NX) \
DET3.WIN1.NY $DET3(WIN1.NY) \
DET3.WIN1.BINX $DET3(WIN1.BINX) \
DET3.WIN1.BINY $DET3(WIN1.BINY) \
INS.FILT1.NAME $INS(FILT1.NAME)"

obs Expose $TPL(ID) $dcsFullName $funcSetup $TPL(REFSUP)

tplLog "Template $TPL(ID) finished."
return {}
}

#___oOo___

7.2.3 Example of Calibration Template Script

# -*- tcl -*-
#************************************************************************
# E.S.O. - VLT project
#
# "@(#) $Id: XXXX_optimg_cal_bias.seq,v 1.11 2001/07/06 12:26:43 vltsccm Exp $"
#
# XXXX_optimg_cal_bias.seq
#
# who when what
# -------- -------- ---------------------------------------------
# alongino 23/10/00 created
#

#************************************************************************
# NAME
# XXXX_optimg_cal_bias - XXXX Bias and Darks Calibration Template script
#
# SYNOPSIS
# XXXX_optimg_cal_bias pAr obsInfo
#
# DESCRIPTION
# XXXX Calibration Template to produce a series of bias or dark
# frames.
#
# foreach exposure
# setup TEL+INS+DET with tc_img_cal_bias.ref setup file
# setup INS+DET according to <pAr> parameter array
# start and wait exposure
#
# FILES
# XXXX_optimg_cal_bias.ref - list of constant parameters of the template
#
# ENVIRONMENT
#
# RETURN VALUES
# image frames
#
# CAUTIONS
#
# EXAMPLES
#
# SEE ALSO
#
# BUGS
#
#------------------------------------------------------------------------
#
#
proc XXXX_optimg_cal_bias { parArrays obsInfo } {

foreach parArray $parArrays {
upvar $parArray $parArray
}

catch { delete object obs }
catch { delete object dcs }
tplOBS obs xxo
set dcsFullName [namespace current]::[tplFIERA dcs fiera FIERA 3]

set TPL(NEXP) $SEQ(NEXPO)
obs ExposeDark $TPL(ID) $dcsFullName $TPL(REFSUP) $SEQ(NEXPO)

tplLog "Template $TPL(ID) finished."
return {}
}

#___oOo___

7.3 Observation Blocks

7.3.1 Example of Self Test OBD

#*******************************************************************************
# E.S.O. - VLT project
#
# "@(#) $Id$"
#
# who when what
# -------- ---------- ----------------------------------------------
# alongino 2003-03-24 created.
#

PAF.HDR.START;
PAF.TYPE "ObsBlockDescription"; # Type of PAF
PAF.ID ""; # ID of PAF
PAF.NAME ""; # Name of PAF
PAF.DESC ""; # Short description of PAF
PAF.CRTE.NAME "tpltooBuild"; # Name of creator
PAF.CRTE.DAYTIM "2003-03-24T18:10:21.00"; # Civil time for creation
PAF.LCHG.NAME "alongino"; # Name of person/appl. chg.
PAF.LCHG.DAYTIM "2003-03-24T18:10:22.00"; # Timestamp of last change
PAF.CHCK.NAME ""; # Name of appl. checking
PAF.CHCK.DAYTIM ""; # Time for checking
PAF.CHCK.CHECKSUM ""; # Checksum for the PAF
PAF.HDR.END;

# --------------------------------------------------------------------
OBS.ID "-1"; # Observation block ID
OBS.NAME "Maintenance"; # OB name
OBS.GRP "0"; # linked blocks
OBS.PROG.ID "Maintenance"; # ESO program identification
OBS.PI-COI.ID "0"; # ESO internal PI-COI ID
OBS.PI-COI.NAME "Condor"; # PI-COI name

TPL.ID "XXXX_irimg_acq";
TPL.NAME "Open loop pointing";
TEL.TARG.ALPHA "000000";
TEL.TARG.DELTA "-850000";
TEL.TARG.EQUINOX "2000";
TEL.ROT.OFFANGLE "0";
TEL.TARG.ADDVELALPHA "0";
TEL.TARG.ADDVELDELTA "0";
TEL.TARG.PMA "0";
TEL.TARG.PMD "0";
TEL.GS1.ALPHA "0.";
TEL.GS1.DELTA "0.";
TEL.GS1.MAG "12.";
INS.MODE "IR_IMAGING";

TPL.ID "XXXX_irimg_obs_exp";
TPL.NAME "XXXX single exposure";
DET1.DIT "10";
DET1.NDIT "1";
INS.FILT1.NAME "FREE";

TPL.ID "XXXX_irspec_acq";
TPL.NAME "Interactive pointing : move object at Target pixel";
DET2.WIN1.UIT1 "5";
TEL.TARG.ALPHA "000000";
TEL.TARG.DELTA "-850000";
TEL.TARG.EQUINOX "2000";
TEL.ROT.OFFANGLE "0";
TEL.PRESET.NEW "T";

TPL.ID "XXXX_irspec_obs_exp";
TPL.NAME "XXXX single exposure";
DET1.DIT "10";
DET1.NDIT "1";
INS.FILT1.NAME "FREE";
INS.SLIT1.LEN "0.50";
INS.GRAT1.NAME "CD#1";
INS.GRAT1.WLEN "1280.0";

TPL.ID "XXXX_optimg_acq";
TPL.NAME "Open loop pointing";
TEL.TARG.ALPHA "000000";
TEL.TARG.DELTA "-850000";
TEL.TARG.EQUINOX "2000";
TEL.ROT.OFFANGLE "0";
TEL.TARG.ADDVELALPHA "0";
TEL.TARG.ADDVELDELTA "0";
TEL.TARG.PMA "0";
TEL.TARG.PMD "0";
TEL.GS1.ALPHA "0.";
TEL.GS1.DELTA "0.";
TEL.GS1.MAG "12.";
INS.MODE "OPT_IMAGING";

TPL.ID "XXXX_optimg_obs_exp";
TPL.NAME "XXXX single exposure";
DET3.WIN1.UIT1 "5";
DET3.WIN1.ST "F";
DET3.WIN1.STRX "1";
DET3.WIN1.STRY "1";
DET3.WIN1.NX "2080";
DET3.WIN1.NY "2048";
DET3.WIN1.BINX "1";
DET3.WIN1.BINY "1";
INS.FILT1.NAME "FREE";

TPL.ID "XXXX_optimg_cal_bias";
TPL.NAME "XXXX FIERA biases or darks";
DET3.WIN1.UIT1 "0";
SEQ.NEXPO "3";

TPL.ID "XXXX_optimg_cal_calunitflat";
TPL.NAME "Flat fields";
DET.EXPLEVEL "20000";
SEQ.NEXPO "3";

TPL.ID "XXXX_optimg_cal_linearity";
TPL.NAME "Shutter and CCD linearity frames";
DET3.WIN1.UIT1 "1 2 1 3 1 4 1";
SEQ.NEXPO "7";

TPL.ID "XXXX_optimg_cal_focus";
TPL.NAME "Thru Focus Sequence";
DET3.WIN1.UIT1 "5";
SEQ.NEXPO "7";
TEL.FOCUSSTEP "0.03";
TEL.OFFSET "10";
TEL.OFFSETDIR "DELTA";

#___oOo___

___oOo___