Skip to content

Rough guide to recipes

Neil Cook edited this page Oct 7, 2020 · 3 revisions

APERO Recipes

Contents


Notes

  1. Note These are not in the required run order. Please do not run them in this order.
  2. Note this document should be consistent with the main README.md please report any differences (or update)
  3. Note this document should be consistent with the documentation please report any differences

1 Preprocessing Recipe

Cleans file of detector effects.

Run:
cal_preprocess_spirou.py [DIRECTORY] [RAW_FILES]
Optional Arguments:
    --skip, --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_WORKING   \\ default: "tmp" directory
Output files:
{ODOMETER_CODE}_pp.fits  \\ preprocessed files (4096x4096)
Plots:

None

Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


2 Dark Master Recipe

Collects all dark files and creates a master dark image to use for correction.

Run:
cal_dark_master_spirou.py
Optional Arguments:
    --filetype, --database, --plot,
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Calibration database entry:
DARKM {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
Output files:
{ODOMETER_CODE}_pp_dark_master.fits  \\ dark master file (4096x4096) + FITS-TABLE
Plots:

None

Notes:

Does not require a master night choice - finds darks from all preprocessed nights.

Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


3 Bad Pixel Correction Recipe

Creates a bad pixel mask for identifying and deal with bad pixels.

Run:
cal_badpix_spirou.py [DIRECTORY] -flatfiles [FLAT_FLAT] -darkfiles [DARK_DARK_TEL]
cal_badpix_spirou.py [DIRECTORY] -flatfiles [FLAT_FLAT] -darkfiles [DARK_DARK_INT]
Optional Arguments:
    --database, --combine, --flipimage, --fluxunits, --plot, --resize,
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Calibration database entry:
BADPIX {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
BKGRDMAP {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
Output files:
{ODOMETER_CODE}_pp_badpixel.fits  \\ bad pixel map file (3100x4088)
{ODOMETER_CODE}_pp_bmap.fits      \\ background mask file (3100x4088)
DEBUG_{ODOMETER_CODE}_pp_background.fits \\ debug background file (7x3100x4088)
Plots:
BADPIX_MAP
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


4 Localisation Recipe

Finds the orders on the image.

Run:
cal_loc_spirou.py [DIRECTORY] [FLAT_DARK]
cal_loc_spirou.py [DIRECTORY] [DARK_FLAT]
Optional Arguments:
    --database, --badpixfile, --badcorr, --backsub, --combine, 
    --darkfile, --darkcorr,  --flipimage, --fluxunits, --plot, --resize,
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Calibration database entry:
ORDER_PROFILE_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
LOC_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
Output files:
{ODOMETER_CODE}_pp_order_profile_C.fits  \\ order profile file (3100x4088)
{ODOMETER_CODE}_pp_loco_C.fits           \\ localisation centers map file (49x4088)
{ODOMETER_CODE}_pp_fwhm-order_C.fits     \\ localisation widths map file (49x4088)
{ODOMETER_CODE}_pp_with-order_C.fits     \\ localisation superposition file (3100x4088)
DEBUG_{ODOMETER_CODE}_pp_background.fits \\ debug background file (7x3100x4088)
Plots:
LOC_MINMAX_CENTS, LOC_MIN_CENTS_THRES, LOC_FINDING_ORDERS, LOC_IM_SAT_THRES,
LOC_ORD_VS_RMS, LOC_CHECK_COEFFS, LOC_FIT_RESIDUALS
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


5 Shape Master Recipe

Creates a master FP image from all FPs processed. Uses this to work out the required shifts due to the FP master image, slicer pupil geometry and the bending of the orders (found in localisation).

Run:
cal_shape_master_spirou.py [DIRECTORY] -hcfiles [HCONE_HCONE] -fpfiles [FP_FP]
Optional Arguments:
    --database, --badpixfile, --badcorr, --backsub, --combine, 
    --darkfile, --darkcorr,  --flipimage, --fluxunits, --locofile,
    --plot, --resize,
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Calibration database entry:
SHAPEX {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
SHAPEY {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
FPMASTER {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
Output files:
{ODOMETER_CODE}_pp_shapex.fits            \\ dx shape map (3100x4088)
{ODOMETER_CODE}_pp_shapey.fits            \\ dy shape map (3100x4088)
{ODOMETER_CODE}_pp_fpmaster.fits          \\ fp master file (3100x4088) + FITS-TABLE
DEBUG_{ODOMETER_CODE}_shape_out_bdx.fits  \\ dx map before dy map (3100x4088)
DEBUG_{ODOMETER_CODE}_shape_in_fp.fits    \\ input fp before shape corr (3100x4088)
DEBUG_{ODOMETER_CODE}_shape_out_fp.fits   \\ input fp after shape corr (3100x4088)
DEBUG_{ODOMETER_CODE}_shape_in_hc.fits    \\ input hc before shape corr (3100x4088)
DEBUG_{ODOMETER_CODE}_shape_out_hc.fits   \\ input hc after shape corr (3100x4088)
DEBUG_{ODOMETER_CODE}_pp_background.fits \\ debug background file (7x3100x4088)
Plots:
SHAPE_DX, SHAPE_ANGLE_OFFSET_ALL, SHAPE_ANGLE_OFFSET, SHAPE_LINEAR_TPARAMS
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


6 Shape (per night) Recipe

Takes the shape master outputs (shapex, shapey and fpmaster) and applies these transformations to shift the image to the master fp frame, unbend images and shift to correct for slicer pupil geometry.

Run:
cal_shape_spirou.py [DIRECTORY] [FP_FP]
Optional Arguments:
    --database, --badpixfile, --badcorr, --backsub, --combine, 
    --darkfile, --darkcorr,  --flipimage, --fluxunits, --fpmaster,
    --plot, --resize, --shapex, --shapey, 
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Calibration database entry:
SHAPEL {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
Output files:
{ODOMETER_CODE}_pp_shapel.fits            \\ local shape map (3100x4088)
DEBUG_{ODOMETER_CODE}_shape_in_fp.fits    \\ input fp before shape corr (3100x4088)
DEBUG_{ODOMETER_CODE}_shape_out_fp.fits   \\ input fp after shape corr (3100x4088)
DEBUG_{ODOMETER_CODE}_pp_background.fits \\ debug background file (7x3100x4088)
Plots:
SHAPE_DX, SHAPE_ANGLE_OFFSET_ALL, SHAPE_ANGLE_OFFSET, SHAPE_LINEAR_TPARAMS
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


7 Flat/Blaze Correction Recipe

Extracts out flat images in order to measure the blaze and produced blaze correction and flat correction images.

Run:
cal_flat_spirou.py [DIRECTORY] [FLAT_FLAT]
Optional Arguments:
    --database, --badpixfile, --badcorr, --backsub, --combine, 
    --darkfile, --darkcorr,  --fiber, --flipimage, --fluxunits, 
    --locofile, --orderpfile, --plot, --resize,
    --shapex, --shapey, --shapel,
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Calibration database entry:
FLAT_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
BLAZE_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
Output files:
{ODOMETER_CODE}_pp_blaze_{FIBER}.fits          \\ blaze correction file (49x4088)
{ODOMETER_CODE}_pp_flat_{FIBER}.fits           \\ blaze correction file (49x4088)
DEBUG_{ODOMETER_CODE}_pp_e2dsll_{FIBER}.fits   \\ debug pre extract file (7x3100x4088)
DEBUG_{ODOMETER_CODE}_pp_background.fits       \\ debug background file (7x3100x4088)
Plots:
FLAT_ORDER_FIT_EDGES1, FLAT_ORDER_FIT_EDGES2, FLAT_BLAZE_ORDER1,
FLAT_BLAZE_ORDER2
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


8 Thermal Correction Recipe

Extracts dark frames in order to provide correction for the thermal background after extraction of science / calibration frames.

Run:
cal_thermal_spirou.py [DIRECTORY] [DARK_DARK_INT]
cal_thermal_spirou.py [DIRECTORY] [DARK_DARK_TEL]
Optional Arguments:
    --database, --badpixfile, --badcorr, --backsub, --combine, 
    --darkfile, --darkcorr,  --fiber, --flipimage, --fluxunits, 
    --locofile, --orderpfile, --plot, --resize,
    --shapex, --shapey, --shapel, --wavefile,
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Calibration database entry:
THERMALT_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
THERMALI_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
Output files:
{ODOMETER_CODE}_pp_e2ds_{FIBER}.fits              \\ extracted + flat field file (49x4088)
{ODOMETER_CODE}_pp_e2dsff_{FIBER}.fits            \\ extracted + flat field file (49x4088)
{ODOMETER_CODE}_pp_s1d_w_{FIBER}.fits             \\ s1d constant in pixel space (FITS-TABLE)
{ODOMETER_CODE}_pp_s1d_v_{FIBER}.fits             \\ s1d constant in velocity space (FITS-TABLE)
DEBUG_{ODOMETER_CODE}_pp_e2dsll_{FIBER}.fits      \\ debug pre extract file (7x3100x4088)
DEBUG_{ODOMETER_CODE}_pp_background.fits       \\ debug background file (7x3100x4088)
{ODOMETER_CODE}_pp_thermal_e2ds_int_{FIBER}.fits  \\ extracted thermal for dark_dark_int (49x4088)
{ODOMETER_CODE}_pp_thermal_e2ds_tel_{FIBER}.fits  \\ extracted thermal for dark_dark_tel (49x4088)
Plots:

None

Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


9 Master leak correction recipe

Extracts all DARK_FP files and creates a model for later leak correction.

Run:
cal_leak_master.py [DIRECTORY]
Optional Arguments:
    --filetype, --database, --plot
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Calibration database entry:
WAVE_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
Output files:
{ODOMETER_CODE}_pp_e2dsff_{FIBER}.fits            \\ extracted + flat field file (49x4088)
{ODOMETER_CODE}_pp_leak_master_{FIBER}.fits        \\ leak correction maste rfile (49x4088)
Plots:

None

Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


10 Master wavelength solution Recipe

Creates a wavelength solution and measures drifts (via CCF) of the FP relative to the FP master

Run:
cal_wave_master_spirou.py [DIRECTORY] -hcfiles [HCONE_HCONE] -fpfiles [FP_FP]
Optional Arguments:
    --database, --badpixfile, --badcorr, --backsub, --blazefile, 
    --combine, --darkfile, --darkcorr,  --fiber, --flipimage, 
    --fluxunits,  --locofile, --orderpfile, --plot, --resize,
    --shapex, --shapey, --shapel, --wavefile, -hcmode, -fpmode,
    --forceext,
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Calibration database entry:
WAVEM_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
WAVEHCL_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
WAVEFPL_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
Output files:
{ODOMETER_CODE}_pp_e2ds_{FIBER}.fits              \\ extracted + flat field file (49x4088)
{ODOMETER_CODE}_pp_e2dsff_{FIBER}.fits            \\ extracted + flat field file (49x4088)
{ODOMETER_CODE}_pp_s1d_w_{FIBER}.fits             \\ s1d constant in pixel space (FITS-TABLE)
{ODOMETER_CODE}_pp_s1d_v_{FIBER}.fits             \\ s1d constant in velocity space (FITS-TABLE)
DEBUG_{ODOMETER_CODE}_pp_e2dsll_{FIBER}.fits      \\ debug pre extract file (7x3100x4088)
DEBUG_{ODOMETER_CODE}_pp_background.fits          \\ debug background file (7x3100x4088)

{ODOMETER_CODE}_pp_e2dsff_linelist_{FIBER}.dat      \\ wave stats hc line list
{ODOMETER_CODE}_pp_e2dsff_wavemres_{FIBER}.fits     \\ wave res table (multi extension fits)
{ODOMETER_CODE}_pp_e2dsff_wavem_hc_{FIBER}.fits     \\ wave solution from hc only (49x4088)
{ODOMETER_CODE}_pp_e2dsff_wavem_fp_{FIBER}.fits     \\ wave solution from hc + fp (49x4088)
cal_wave_results.tbl                                \\ wave res table (ASCII-table)
{ODOMETER_CODE}_pp_e2dsff_mhc_lines_{FIBER}.tbl     \\ wave hc lines (ASCII-table)
{ODOMETER_CODE}_pp_wavem_hclines_{FIBER}.fits       \\ wave hc ref/measured lines table (FITS-TABLE)
{ODOMETER_CODE}_pp_wavem_fplines_{FIBER}.fits      \\ wave fp ref/measured lines table (FITS-TABLE)
{ODOMETER_CODE}_pp_e2dsff_ccf_{FIBER}.fits          \\ ccf code [FITS-TABLE]
Plots:
WAVE_HC_GUESS, WAVE_HC_BRIGHTEST_LINES, WAVE_HC_TFIT_GRID, WAVE_HC_RESMAP, WAVE_LITTROW_CHECK1, 
WAVE_LITTROW_EXTRAP1, WAVE_LITTROW_CHECK2, WAVE_LITTROW_EXTRAP2, WAVE_FP_FINAL_ORDER, 
WAVE_FP_LWID_OFFSET, WAVE_FP_WAVE_RES, WAVE_FP_M_X_RES, WAVE_FP_IPT_CWID_1MHC, WAVE_FP_IPT_CWID_LLHC, 
WAVE_FP_LL_DIFF, WAVE_FP_MULTI_ORDER, WAVE_FP_SINGLE_ORDER, CCF_RV_FIT, CCF_RV_FIT_LOOP, WAVEREF_EXPECTED, 
EXTRACT_S1D, EXTRACT_S1D_WEIGHT, WAVE_FIBER_COMPARISON, WAVE_FIBER_COMP, WAVENIGHT_ITERPLOT, WAVENIGHT_HISTPLOT
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


11 Nightly wavelength solution Recipe

Calculates corrections to the master wavelength solution as a nightly wavelength solution and measures drifts (via CCF) of the FP relative to the FP master

Run:
cal_wave_night_spirou.py [DIRECTORY] -hcfiles [HCONE_HCONE] -fpfiles [FP_FP]
Optional Arguments:
    --database, --badpixfile, --badcorr, --backsub, --blazefile, 
    --combine, --darkfile, --darkcorr,  --fiber, --flipimage, 
    --fluxunits,  --locofile, --orderpfile, --plot, --resize,
    --shapex, --shapey, --shapel, --wavefile, -hcmode, -fpmode,
    --forceext
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Calibration database entry:
WAVE_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
Output files:
{ODOMETER_CODE}_pp_e2ds_{FIBER}.fits              \\ extracted + flat field file (49x4088)
{ODOMETER_CODE}_pp_e2dsff_{FIBER}.fits            \\ extracted + flat field file (49x4088)
{ODOMETER_CODE}_pp_s1d_w_{FIBER}.fits             \\ s1d constant in pixel space (FITS-TABLE)
{ODOMETER_CODE}_pp_s1d_v_{FIBER}.fits             \\ s1d constant in velocity space (FITS-TABLE)
DEBUG_{ODOMETER_CODE}_pp_e2dsll_{FIBER}.fits      \\ debug pre extract file (7x3100x4088)
DEBUG_{ODOMETER_CODE}_pp_background.fits          \\ debug background file (7x3100x4088)

{ODOMETER_CODE}_pp_e2dsff__wave_night_{FIBER}.fits     \\ wave night solution (49x4088)
{ODOMETER_CODE}_pp_wavem_hclines_{FIBER}.fits       \\ wave hc ref/measured lines table (FITS-TABLE)
{ODOMETER_CODE}_pp_wavem_fplines_{FIBER}.fits      \\ wave fp ref/measured lines table (FITS-TABLE)
{ODOMETER_CODE}_pp_e2dsff_ccf_{FIBER}.fits          \\ ccf code [FITS-TABLE]
Plots:
WAVENIGHT_ITERPLOT WAVENIGHT_HISTPLOT WAVEREF_EXPECTED 
CCF_RV_FIT CCF_RV_FIT_LOOP EXTRACT_S1D EXTRACT_S1D_WEIGHT
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


12 Extraction Recipe

Extracts any preprocessed image using all the calibrations required.

Run:
cal_extract_spirou.py [DIRECTORY] [PP_FILE]

Optional Arguments:
    --badpixfile, --badcorr, --backsub, --blazefile, 
    --combine, --objname, --dprtype, --darkfile, --darkcorr,  
    --fiber, --flipimage, --fluxunits, --flatfile, 
    --locofile, --orderpfile, --plot, --resize,
    --shapex, --shapey, --shapel, --thermal, --thermalfile, --wavefile,
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Output files:
{ODOMETER_CODE}_pp_e2ds_{FIBER}.fits              \\ extracted + flat field file (49x4088)
{ODOMETER_CODE}_pp_e2dsff_{FIBER}.fits            \\ extracted + flat field file (49x4088)
{ODOMETER_CODE}_pp_s1d_w_{FIBER}.fits             \\ s1d constant in pixel space (FITS-TABLE)
{ODOMETER_CODE}_pp_s1d_v_{FIBER}.fits             \\ s1d constant in velocity space (FITS-TABLE)
DEBUG_{ODOMETER_CODE}_pp_e2dsll_{FIBER}.fits      \\ debug pre extract file (7x3100x4088)
DEBUG_{ODOMETER_CODE}_pp_background.fits          \\ debug background file (7x3100x4088)
{ODOMETER_CODE}_pp_ext_fplines_{FIBER} .fits      \\ the FP ref/measured lines (FOR OBJ_FP only)
Plots:
FLAT_ORDER_FIT_EDGES1, FLAT_ORDER_FIT_EDGES2, FLAT_BLAZE_ORDER1,
FLAT_BLAZE_ORDER2, THERMAL_BACKGROUND, EXTRACT_SPECTRAL_ORDER1, 
EXTRACT_SPECTRAL_ORDER2, EXTRACT_S1D, EXTRACT_S1D_WEIGHT
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


13 Leak correction Recipe

Corrects extracted files for leakage coming from a FP (for OBJ_FP files only)

Run:
cal_leak_spirou.py [DIRECTORY] [PP_FILE]

Optional Arguments:
    --database, --plot, --leakfile
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Output files:
{ODOMETER_CODE}_pp_e2ds_{FIBER}.fits              \\ extracted + flat field file (49x4088)
{ODOMETER_CODE}_pp_e2dsff_{FIBER}.fits            \\ extracted + flat field file (49x4088)
{ODOMETER_CODE}_pp_s1d_w_{FIBER}.fits             \\ s1d constant in pixel space (FITS-TABLE)
{ODOMETER_CODE}_pp_s1d_v_{FIBER}.fits             \\ s1d constant in velocity space (FITS-TABLE)
DEBUG_{ODOMETER_CODE}_pp_e2dsll_{FIBER}.fits      \\ debug pre extract file (7x3100x4088)
DEBUG_{ODOMETER_CODE}_pp_background.fits          \\ debug background file (7x3100x4088)
Plots:

None

Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


14 Make Telluric Recipe

Takes a hot star and calculates telluric transmission

Run:
obj_mk_tellu_spirou.py [DIRECTORY] [E2DS & OBJ_DARK]
obj_mk_tellu_spirou.py [DIRECTORY] [E2DSFF & OBJ_DARK]
obj_mk_tellu_spirou.py [DIRECTORY] [E2DS & OBJ_FP]
obj_mk_tellu_spirou.py [DIRECTORY] [E2DSFF & OBJ_FP]
Optional Arguments:
    --database, --blazefile, --plot, --wavefile
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Telluric database entry:
TELLU_CONV_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
TELLU_TRANS_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
Output files:
{ODOMETER_CODE}_pp_tellu_trans_{FIBER}.fits    \\ telluric transmission file (49x4088)
{WAVEFILE}_tellu_conv_{FIBER}.npy              \\ tapas convolved with wave file (49x4088)
Plots:
MKTELLU_WAVE_FLUX1, MKTELLU_WAVE_FLUX2
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


15 Fit Telluric Recipe

Using the telluric tramission calculates principle components (PCA) to correct input images of atmospheric absorption.

Run:

obj_fit_tellu_spirou.py [DIRECTORY] [E2DS & OBJ_DARK]
obj_fit_tellu_spirou.py [DIRECTORY] [E2DSFF & OBJ_DARK]
obj_fit_tellu_spirou.py [DIRECTORY] [E2DS & OBJ_FP]
obj_fit_tellu_spirou.py [DIRECTORY] [E2DSFF & OBJ_FP]

Optional Arguments:

    --database, --blazefile, --plot, --wavefile
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 

Output Dir:

DRS_DATA_REDUC   \\ default: "reduced" directory

Telluric database entry:

TELLU_CONV_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
TELLU_TRANS_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}

Output files:

{ODOMETER_CODE}_pp_e2dsff_tcorr_{FIBER}.fits    \\ telluric corrected e2dsff file (49x4088)
{ODOMETER_CODE}_pp_s1d_w_tcorr_{FIBER}.fits     \\ telluric corrected s1d constant in pixel space (FITS-TABLE)
{ODOMETER_CODE}_pp_s1d_v_tcorr_{FIBER}.fits     \\ telluric corrected s1d constant in velocity space (FITS-TABLE)
{ODOMETER_CODE}_pp_e2dsff_recon_{FIBER}.fits    \\ reconstructed transmission e2dsff file (49x4088)
{ODOMETER_CODE}_pp_s1d_w_recon_{FIBER}.fits     \\ reconstructed transmission s1d constant in pixel space (FITS-TABLE)
{ODOMETER_CODE}_pp_s1d_v_recon_{FIBER}.fits     \\ reconstructed transmission s1d constant in velocity space (FITS-TABLE)

Plots:

EXTRACT_S1D, EXTRACT_S1D_WEIGHT, FTELLU_PCA_COMP1, FTELLU_PCA_COMP2,
FTELLU_RECON_SPLINE1, FTELLU_RECON_SPLINE2, FTELLU_WAVE_SHIFT1,
FTELLU_WAVE_SHIFT2, FTELLU_RECON_ABSO1, FTELLU_RECON_ABSO2
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


16 Make Template Recipe

Uses all telluric corrected images of a certain object name to create and BERV and wavelength corrected template in order to server as a better model SED for telluric correction.

obj_mk_tellu_spirou.py and obj_fit_tellu_spirou.py need to be rerun after template generation.

Run:

obj_mk_template_spirou.py [OBJNAME]

Optional Arguments:

    --filetype, -fiber,
    --database, --blazefile, --plot, --wavefile
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 

Output Dir:

DRS_DATA_REDUC   \\ default: "reduced" directory

Telluric database entry:

TELLU_CONV_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}
TELLU_TRANS_{FIBER} {NIGHT_NAME} {FILENAME} {HUMAN DATE} {UNIX DATE}

Output files:

Template_{OBJNAME}_{filetype}_{FIBER}.fits  \\ Template for object (3100x4088) + FITS TABLE
Template_s1d_{OBJNAME}_sc1d_w_{FIBER}.fits  \\ Template s1d constant in pixel space for object FITS TABLE + FITS TABLE
Template_s1d_{OBJNAME}_sc1d_v_{FIBER}.fits  \\ Template s1d constant in velocity space for object FITS TABLE + FITS TABLE
BigCube0_{OBJNAME}_{filetype}_{FIBER}.fits  \\ Cube of obs making template earth reference (49 x N x 4088)
BigCube_{OBJNAME}_{filetype}_{FIBER}.fits   \\ Cube of obs making template star reference (49 x N x 4088)

Plots:

EXTRACT_S1D
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


17 CCF Recipe

Cross correlates the input image against a mask and measures a radial velocity per order, and combines to give an over all radial velocity measurement. Also (where possible) takes into account the FP drift measured by a CCF in the wave solution (when wave solution used a FP)

Run:
cal_ccf_spirou.py [DIRECTORY] [E2DS & OBJ_FP]
cal_ccf_spirou.py [DIRECTORY] [E2DSFF & OBJ_FP]
cal_ccf_spirou.py [DIRECTORY] [E2DS_CORR & OBJ_FP]
cal_ccf_spirou.py [DIRECTORY] [E2DSFF_CORR & OBJ_FP]
cal_ccf_spirou.py [DIRECTORY] [E2DS & OBJ_DARK]
cal_ccf_spirou.py [DIRECTORY] [E2DSFF & OBJ_DARK]
cal_ccf_spirou.py [DIRECTORY] [E2DS_CORR & OBJ_DARK]
cal_ccf_spirou.py [DIRECTORY] [E2DSFF_CORR & OBJ_DARK]
Optional Arguments:
    --mask, --rv, --width, --step
    --database, --blazefile, --plot
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Output files:
{ODOMETER_CODE}_pp_{INTYPE}_{FIBER}_ccf_{mask}_{FIBER}.fits  \\ CCF for science channel file (FITS-TABLE)
{ODOMETER_CODE}_pp_{INTYPE}_{FIBER}_ccf_fp_{FIBER}.fits      \\ CCF for reference channel file (FITS-TABLE)

Plots:
CCF_RV_FIT, CCF_RV_FIT_LOOP, CCF_SWAVE_REF, CCF_PHOTON_UNCERT
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top


18 Polarimetry Recipe

Produces all polarimetry outputs.

Run:
pol_spirou.py [DIRECTORY] [E2DSFF]
pol_spirou.py [DIRECTORY] [E2DSFF_CORR]
Optional Arguments:
    --blazefile, --plot, --wavefile,
    --debug, --listing, --listingall, --version, --info, 
    --program, --idebug, --breakpoints, --quiet, --help 
Output Dir:
DRS_DATA_REDUC   \\ default: "reduced" directory
Output files:
{ODOMETER_CODE}_pp_{INTYPE}_pol.fits               // polar file 
{ODOMETER_CODE}_pp_{INTYPE}_StokesI.fits           // stokes file
{ODOMETER_CODE}_pp_{INTYPE}_null1_pol.fits         // null 1 file
{ODOMETER_CODE}_pp_{INTYPE}_null2_pol.fits         // null 2 file
{ODOMETER_CODE}_pp_{INTYPE}_lsd_pol.fits           // lsd file
{ODOMETER_CODE}_pp_{INTYPE}_s1d_w_pol.fits         // s1d polar file constant in pixel space for object 
{ODOMETER_CODE}_pp_{INTYPE}_s1d_v_pol.fits         // s1d polar file constant in velocity space
{ODOMETER_CODE}_pp_{INTYPE}_s1d_w_null1.fits       // s1d null 1 file constant in pixel space for object 
{ODOMETER_CODE}_pp_{INTYPE}_s1d_v_null1.fits       // s1d null 1 file constant in velocity space
{ODOMETER_CODE}_pp_{INTYPE}_s1d_w_null2.fits       // s1d null 2 file constant in pixel space for object 
{ODOMETER_CODE}_pp_{INTYPE}_s1d_v_null2.fits       // s1d null 2 file constant in velocity space
{ODOMETER_CODE}_pp_{INTYPE}_s1d_w_stokesi.fits     // s1d stokes file constant in pixel space for object 
{ODOMETER_CODE}_pp_{INTYPE}_s1d_v_stokesi.fits     // s1d stokes file constant in velocity space
Plots:
POLAR_CONTINUUM, POLAR_RESULTS, POLAR_STOKES_I, POLAR_LSD,
EXTRACT_S1D, EXTRACT_S1D_WEIGHT
Questions:
  • have a question? write it here
Comments:
  • have a comment? write it here

Back to top

Clone this wiki locally