apero_leak_ref_spirou

Contents

• 1. Description

• 2. Schematic

• 3. Usage

• 4. Optional Arguments

• 5. Special Arguments

• 6. Output directory

• 7. Output files

• 8. Debug plots

• 9. Summary plots

1. Description

SHORTNAME: LEAKREF

Leak reference calibration

For PRV observations, the observational setup is most often one with a science object in the A and B fibers and an FP illumination in the C fiber (i.e., OBJ_FP or POLAR_FP). Considering that the SPIRou slicer has sharp edges in its pupil, there is a diffraction pattern that leads to a spike in the cross-fiber direction and a modest cross-fiber component in the leakage. The leakage of the FP spectrum onto the science spectrum is constant through time as it is solely due to pupil geometry, and can therefore be calibrated and subtracted. The reference leak recipe finds all DARK_FP files in the raw directory (from the reference night). Each DARK_FP file is then extracted. Once all DARK_FP files are extracted they are combined for each fiber: AB, A, B, and C (via a median across all extracted ETDS files) creating one image (\(49\times4088\)) per fiber. Conceptually, the leak correction is straightforward: take the combined DARK_FP, normalize each C fiber FP to unity (using the 5th percentile of FP flux within the order) and measure the recovered spectrum in the A and B fibers. For any given OBJ_FP or POLAR_FP observation, one simply measures the C fiber FP flux and scales the leakage in A and B accordingly.

The method has been tested over the lifetime of SPIRou and subtracts the high-frequency component of the leakage at a level better than 1 in 100 in the most contaminated orders. The reference leak calibration file (REFLEAK) is then saved to the calibration database for use throughout APERO.

2. Schematic

No schematic set

3. Usage

apero_leak_ref_spirou.py {obs_dir}[STRING] {options}

{obs_dir}[STRING] // [STRING] The directory to find the data files in. Most of the time this is organised by nightly observation directory

4. Optional Arguments

--filetype[STRING] // [STRING] Specify the DPRTYPE for DARK_FP files
--database[True/False] // [BOOLEAN] Whether to add outputs to calibration database
--plot[0>INT>4] // [INTEGER] Plot level. 0 = off, 1 = interactively, 2 = save to file
--no_in_qc // Disable checking the quality control of input files

5. Special Arguments

--xhelp[STRING] // Extended help menu (with all advanced arguments)
--debug[STRING] // Activates debug mode (Advanced mode [INTEGER] value must be an integer greater than 0, setting the debug level)
--listing[STRING] // Lists the night name directories in the input directory if used without a 'directory' argument or lists the files in the given 'directory' (if defined). Only lists up to 15 files/directories
--listingall[STRING] // Lists ALL the night name directories in the input directory if used without a 'directory' argument or lists the files in the given 'directory' (if defined)
--version[STRING] // Displays the current version of this recipe.
--info[STRING] // Displays the short version of the help menu
--program[STRING] // [STRING] The name of the program to display and use (mostly for logging purpose) log becomes date | {THIS STRING} | Message
--recipe_kind[STRING] // [STRING] The recipe kind for this recipe run (normally only used in apero_processing.py)
--parallel[STRING] // [BOOL] If True this is a run in parellel - disable some features (normally only used in apero_processing.py)
--shortname[STRING] // [STRING] Set a shortname for a recipe to distinguish it from other runs - this is mainly for use with apero processing but will appear in the log database
--idebug[STRING] // [BOOLEAN] If True always returns to ipython (or python) at end (via ipdb or pdb)
--ref[STRING] // If set then recipe is a reference recipe (e.g. reference recipes write to calibration database as reference calibrations)
--crunfile[STRING] // Set a run file to override default arguments
--quiet[STRING] // Run recipe without start up text
--nosave // Do not save any outputs (debug/information run). Note some recipes require other recipesto be run. Only use --nosave after previous recipe runs have been run successfully at least once.
--force_indir[STRING] // [STRING] Force the default input directory (Normally set by recipe)
--force_outdir[STRING] // [STRING] Force the default output directory (Normally set by recipe)

6. Output directory

DRS_DATA_REDUC // Default: "red" directory

7. Output files

Outputs

name	description	HDR[DRSOUTID]	file type	suffix	fibers	dbname	dbkey	input file
EXT_E2DS	Extracted 2D spectrum	EXT_E2DS	.fits	_e2ds	AB, A, B, C	–	–	DRS_PP
LEAKREF_E2DS	Reference leak correction calibration file	LEAKREF_E2DS	.fits	_leak_ref	AB, A, B, C	calibration	LEAKREF	EXT_E2DS, EXT_E2DS_FF

8. Debug plots

No debug plots.

9. Summary plots

No summary plots.