DRS USER MANUAL v1.1 June 2005

Didier.queloz@obs.unige.ch

 

Environment variables:

 

A set of global variables controls the behaviors of the DRS

DRS_LOG:   [0/1]

Level of talking   of the DRS:

LOG=0 to have the online DRS talking,

LOG=1 to have a full talking (corresponding to the DRS log file)

DRS_INTERACTIF: [set/unset]

Enhance the interactive prompt at the end of the recipe. Setting this variable is useful to have a graphic display when the trigger is not used.

DRS_PLOT: [0/1/trigger]

Controls the plot device. If DRS_PLOT=0  plots are not  displayed, If DRS_PLLOT=1 plot are displayed and when use in combination with DRS_INTERACTIF plotting may be seen when line commands are used. If DRS_PLOT=ÕtriggerÕ the plotting facility of the trigger is used.

 

The file structure of the DRS is controlled by a set of variable that may be display by setting DRS_LOG 1 and then by executing the test function  ske_recipe_coralie.py:

 

>ske_recipe_coralie.py

 

||PythonDRS v 1.1   (interactive mode)

01:46:04.4 -   || *****************************************

01:46:04.5 -   || * CORALIE DRS @(#)Geneva Observatory v1.1

01:46:04.5 -   || *****************************************

01:46:04.5 -   ||(dir_drs_config)    DRS_CONFIG=/opt/coralie/CDRS/config/

01:46:04.6 -   ||(dir_drs_man)       DRS_MAN=/opt/coralie/CDRS/man/

01:46:04.6 -   ||(dir_data_raw)      DRS_DATA_RAW=/gls/data/raw/

01:46:04.6 -   ||(dir_data_reduc)    DRS_DATA_REDUC=/gls/data/reduced/

01:46:04.7 -   ||(dir_calib_db)      DRS_CALIB_DB=/gls/data/calibDB/

01:46:04.7 -   ||(dir_data_msg)      DRS_DATA_MSG=/gls/data/msg/

01:46:04.8 -   ||(print_log)         DRS_LOG=1          %(0/1)

01:46:04.8 -   ||(plot_graph)        DRS_PLOT=1         %(unset/set/trigger)

01:46:04.8 -   ||(used_date)         DRS_USED_DATE=undefined

01:46:04.9 -   ||(working_dir)       DRS_DATA_WORKING is not set, running on-line mode

01:46:04.9 -   ||                    DRS_INTERACTIF is  set

01:46:04.9 -   |ske_recipe_coralie|Now running : ske_recipe_coralie on file(s):

01:46:05.0 -   |ske_recipe_coralie|On directory /gls/data/raw/

01:46:05.0 -   |ske_recipe_coralie|ICDP loaded from: /opt/coralie/CDRS/config/hadmrICDP.py

01:46:05.1 - * |ske_recipe_coralie|Void recipe for test

 

 

Function list:

Each function have an on-line help function that may be displayed by typing:

                                             <function> HELP,

(e.g.: list_ccf_coralie HELP). Running the HELP on all functions has produced the following documentation:

list_ccf_coralie

USAGE:

     list_ccf_coralie  night_directory

TASK:

    list following parameters of ccf file in the <night_directory>.

    Outpus is rdb format compatible for further piping.

      

    target    name of the target     

    noprog    prog ID number

    root      file root name (CORALIE.XXXX-XX-XXTXX:XX:XX.000.fits)                      

    fiber     fiber name (A/B)

    snV       s/N of spectra in #49 (565nm)

    rvdrift   drift of the spectrograph (m/s)

    mask      template key name

    rvc       RV computed (in km/s baryc frame) corrected from instrum. drift    

    dvrms     error estimates on RVc (m/s)

    contrast  CCF contrast (%) 

    fwhm      CCF FWHM (km/s)

    tccf      (ccf or newccf)

DEFAULT:

    none

EXAMPLES:

    list_ccf_coralie 2000-07-01

 

DQ@CDRS (06/2005).

 

list_raw_coralie

USAGE:

     list_raw_coralie  night_directory

TASK:

    list following parameters of raw file in the <night_directory>

   

    FILE               filename

    TPL.TYPE           type of exposure

    OBS.TARG.CODE      target code name

    OBS.NOPROG         prog ID number

    OBS.TEXP           exposure time (s)

    CORA.PM.COUNT      PM total count

    CORA.CCD.ROTYPE    Detector ROS

 

DEFAULT:

    none

EXAMPLES:

    list_raw_coralie 2000-07-01

 

DQ@CDRS (06/2005).

 

list_reduced_coralie

USAGE:

     list_reduced_coralie  night_directory

TASK:

    list following parameters of all reduced files in the <night_directory>

   

    FILE               filename

    TPL.TYPE           type of exposure

    OBS.TARG.CODE      target code name

    OBS.NOPROG         prog ID number

    DRS.CAL.QC         Quality Control status

    DRS.CCD.SIGDET     Detector computed RON (e-)

 

 

DEFAULT:

    none

EXAMPLES:

    list_reduced_coralie 2000-07-01

 

DQ@CDRS (06/2005).

 

list_spectra_coralie

USAGE:

     list_spectra_coralie  night_directory

TASK:

    list following parameters of (science) spectra in the <night_directory>

 

    FILE               filename

    TPL.TYPE           type of exposure

    OBS.TARG.CODE      target code name

    OBS.NOPROG         prog ID number

    DRS.CAL.EXT.SN49   S/N per pixel  in order #49 (560nm)

    OBS.TARG.MV        magnitude of the target

    OBS.TEXP           exposure time (s)

    DRS.DRIFT.RV.USED  spectrograph drift

 

DEFAULT:

    none

EXAMPLES:

    list_spectra_coralie 2000-07-01

 

DQ@CDRS (06/2005).

 

cal_loc_ONE_coralie.py

 

USAGE:

  cal_loc_ONE_coralie  night_directory fitsfilename

TASK:

  process a tungstene localisation (LOC[O/C]) exposure.

  CDRS online recipe for computation of the geometry of the order (localization)

PARAMETERS:

  night_directory  night name          (2000-07-01)

  fitsfilename     file name (raw)     (CORALIE.2000-07-01T20:09:01.000.fits)

EXAMPLES:

  cal_loc_ONE_coralie 2000-07-01  CORALIE.2000-07-01T17:16:20.000.fits

 

DQ@CDRS (06/2005).

 

cal_FF_coralie.py

 

USAGE:

  cal_FF_coralie  night_directory fitsfilename1  [fitsfilename2 ..fitsfilenameN]

TASK:

  process a flat-field (FF) exposure sequence.

  CDRS online recipe for computation of the  flat-field  spectrum

PARAMETERS:

  night_directory    night name          (2000-07-01)

  fitsfilename's     file name (raw)     (CORALIE.2000-07-01T20:09:01.000.fits)

EXAMPLES:

  cal_FF_coralie 2000-07-01  CORALIE.2000-07-01T17:16:20.000.fits

                             CORALIE.2000-07-01T17:20:20.000.fits

 

DQ@CDRS (06/2005).

 

cal_TH_coralie.py

 

USAGE:

  cal_TH_coralie  night_directory fitsfilename

TASK:

  process a thorium  (THA2) exposure .

  CDRS online recipe for  wavelength calibration

PARAMETERS:

  night_directory  night name          (2000-07-01)

  fitsfilename     file name (raw)     (CORALIE.2000-07-01T20:09:01.000.fits)

EXAMPLES:

  cal_TH_coralie 2000-07-01  CORALIE.2000-07-01T17:16:20.000.fits

 

DQ@CDRS (06/2005).

 

cal_DARK_coralie.py

 

USAGE:
  cal_DARK_coralie  night_directory fitsfilename
TASK:
  process a DARK exposure.
  CDRS online recipe for computation of the mean dark (localization)
PARAMETERS:
  night_directory  night name       (2000-07-01)
  fitsfilename     file name (raw)  (CORALIE.2000-07-01T20:09:01.000.fits)
EXAMPLES:
  cal_DARK_coralie 2000-07-01  CORALIE.2000-07-01T17:16:20.000.fits
 
DQ@CDRS (06/2005).
 

obj_ONE_coralie.py

 

USAGE:

  obj_ONE_coralie  night_directory fitsfilename

TASK:

  process a science OBJO  exposure

  CDRS online recipe for reduction of objo exposure

PARAMETERS:

  night_directory    night name          (2000-07-01)

  fitsfilename       file name (raw)     (CORALIE.2000-07-01T20:09:01.000.fits)

EXAMPLES:

  obj_ONE_coralie 2000-07-01  CORALIE.2000-07-01T17:16:20.000.fits

 

DQ@CDRS (06/2005).

 

obj_TH_coralie.py

 

USAGE:

  obj_TH_coralie  night_directory fitsfilename

TASK:

  process a science OBTH  exposure

  CDRS online recipe for reduction of obth exposure

PARAMETERS:

  night_directory    night name          (2000-07-01)

  fitsfilename       file name (raw)     (CORALIE.2000-07-01T20:09:01.000.fits)

EXAMPLES:

  obj_TH_coralie 2000-07-01  CORALIE.2000-07-01T17:16:20.000.fits

 

DQ@CDRS (06/2005).

 

obj_TWO_coralie.py

 

USAGE:

  obj_TWO_coralie  night_directory fitsfilename

TASK:

  process a science OBJ2  exposure

  CDRS online recipe for reduction of obj2 exposure

PARAMETERS:

  night_directory    night name          (2000-07-01)

  fitsfilename       file name (raw)     (CORALIE.2000-07-01T20:09:01.000.fits)

EXAMPLES:

  obj_TWO_coralie 2000-07-01  CORALIE.2000-07-01T17:16:20.000.fits

 

DQ@CDRS (06/2005).

 

off_make_exec_coralie.py

 

USAGE:

  off_make_exec_coralie.py night_directory

TASK:

  Build an execution sequence to reprocess the night <night_directory>

  For "old" data without FF exposures use instead off_make_exec_OLDcoralie.py

  otherwise flat-field calibrations shall be missing

  Output of this recipe is REDUC_[night_directory] file on current directory.

 

  To execute the  night sequence do then:

      source REDUC_[night_directory]

PARAMETERS:

  night_directory    night name         (2005-07-01)

EXAMPLES:

  off_make_exec_coralie.py 2005-07-01

 

DQ@CDRS (06/2005).

 

off_newccf_coralie.py

 

USAGE:

  off_newccf.py night_directory fitsfilename(raw name) [targetRV] [maskfilename]  [fiber] [widthccf] [stepccf]

TASK:

  build a new Cross Correlation Function (newccf)

PARAMETERS:

  night_directory    night name        (2000-07-01)

  fitsfilename       file root name    (CORALIE.2000-07-01T20:09:01.000.fits)

  targetRV      expected RV of the star (if -99999 search for it)  (30)

  maskfilename  template for CCF computation            (G2)

  fiber         fiber name                              (A)

  widthccf      computed window of the CCF              (100)           

  stepccf       computed steps of the CCF               (1)

DEFAULT:

  [targetRV]      read on fitsfile kw (OBS TARG RADVEL) 

  [maskfilename]  read on fitsfile kw (DRS CCF MASK)

  [fiber]         A

  [widthccf]      online DRS  value

  [stepccf]       online DRS  value

OTHERS: 

  set DRS_DATA_WORKING for a different outputs directory than standard online DRS

  eg: setenv DRS_DATA_WORKING . would redirect all the outputs of the recipe to the current directory (.)

EXAMPLES:

  off_newccf_coralie.py 2000-07-01

                 CORALIE.2000-07-01T20:09:01.000_32ds_A.fits  -10  K5 A  100 1

 

off_visu_ccf_coralie.py

 

USAGE:

  off_visu_ccf_coralie.py night_directory cff.fitsfilename

TASK:

  display a CCF fits file

  if PS=1 make a postscript file:  plot.ps

PARAMETERS:

  night_directory    night name        (2000-07-01)

  ccf.fitsfilename   CCF file name   

                          (CORALIE.2000-07-01T20:09:01.000_ccf_G2_A.fits)

  PS         option to make a postscript file  (0)

DEFAULT:

  [PS]     0

EXAMPLES:

 off_visu_ccf_coralie.py 

                  2000-07-01 CORALIE.2000-07-01T20:09:01.000_ccf_G2_A.fits

 

DQ (06/2005).

 

off_visu_e2ds_coralie.py

 

USAGE:

  off_visu_e2ds.py night_directory e2dsfitsfilename [#order] [PS]

TASK:

  display an e2ds spectrum

  if PS=1 make a postscript file:  plot.ps

PARAMETERS:

  night_directory    night name                (2000-07-01)

  e2dsfitsfilename  e2ds file name            

                            (CORALIE.2000-07-01T20:09:01.000_e2ds_A.fits)

  #order     order displayed (internal num)    (13)

  PS         option to make a postscript file  (0)

DEFAULT:

  [#order] 49

  [PS]     0

EXAMPLES:

 off_visu_e2ds.py  2000-07-01 CORALIE.2000-07-01T20:09:01.000_e2ds_A.fits 20

 

DQ (06/2005).

 

off_visu_fpo_coralie.py

 

USAGE:

  off_visu_fpo_coralie.py night_directory e2dsfitsfilename

TASK:

  display the average flux at blaze max per order in  (erg/A/cm2/s)

  (write as well a two columns  ascii file)

PARAMETERS:

  night_directory  night name       (2000-07-01)

  e2dsfitsfilename  s2d file name  

                                 (CORALIE.2000-07-01T20:09:01.000_e2ds_A.fits)

EXAMPLES:

 off_visu_fpo_coralie.py 2000-07-01 CORALIE.2000-07-01T20:09:01.000_e2ds_A.fits

 

DQ@CDRS (06/2005).

 

off_visu_s1d_coralie.py

 

USAGE:

  off_visu_s1d_coralie.py night_directory s1dfitsfilename [ll inf] [ll sup] [PS]

TASK:

  display an s1d spectrum

  if PS=1 make a postscript file:  plot.ps

PARAMETERS:

  night_directory  night name    (2000-07-01)

  s1dfitsfilename  s1d file name (CORALIE.2000-07-01T20:09:01.000_s1d_A.fits)

  ll inf    min. wavelength displayed     (4000)

  ll sup    max. wavelength displayed     (4300)

  PS option to make a postscript file (0)

DEFAULT:

  [ll inf]  ll min of the spectrum

  [ll sup]  ll max of the spectrum

  [PS]      0

EXAMPLES:

 off_visu_s1d_coralie.py 2000-07-01

                         CORALIE.2000-07-01T20:09:01.000_s1d_A.fits 5000 5050

 

DQ@CDRS (06/2005).